@jellyfin/sdk/lib/generated-client/api/item-update-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 *
 * Jellyfin API
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { BaseItemDto } from '../models';
import type { MetadataEditorInfo } from '../models';
/**
 * ItemUpdateApi - axios parameter creator
 * @export
 */
export declare const ItemUpdateApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets metadata editor info for an item.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMetadataEditorInfo: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates an item.
     * @param {string} itemId The item id.
     * @param {BaseItemDto} baseItemDto The new item properties.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates an item\'s content type.
     * @param {string} itemId The item id.
     * @param {string} [contentType] The content type of the item.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItemContentType: (itemId: string, contentType?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ItemUpdateApi - functional programming interface
 * @export
 */
export declare const ItemUpdateApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets metadata editor info for an item.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMetadataEditorInfo(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataEditorInfo>>;
    /**
     *
     * @summary Updates an item.
     * @param {string} itemId The item id.
     * @param {BaseItemDto} baseItemDto The new item properties.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItem(itemId: string, baseItemDto: BaseItemDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Updates an item\'s content type.
     * @param {string} itemId The item id.
     * @param {string} [contentType] The content type of the item.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItemContentType(itemId: string, contentType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * ItemUpdateApi - factory interface
 * @export
 */
export declare const ItemUpdateApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets metadata editor info for an item.
     * @param {ItemUpdateApiGetMetadataEditorInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMetadataEditorInfo(requestParameters: ItemUpdateApiGetMetadataEditorInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<MetadataEditorInfo>;
    /**
     *
     * @summary Updates an item.
     * @param {ItemUpdateApiUpdateItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItem(requestParameters: ItemUpdateApiUpdateItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Updates an item\'s content type.
     * @param {ItemUpdateApiUpdateItemContentTypeRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateItemContentType(requestParameters: ItemUpdateApiUpdateItemContentTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for getMetadataEditorInfo operation in ItemUpdateApi.
 * @export
 * @interface ItemUpdateApiGetMetadataEditorInfoRequest
 */
export interface ItemUpdateApiGetMetadataEditorInfoRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof ItemUpdateApiGetMetadataEditorInfo
     */
    readonly itemId: string;
}
/**
 * Request parameters for updateItem operation in ItemUpdateApi.
 * @export
 * @interface ItemUpdateApiUpdateItemRequest
 */
export interface ItemUpdateApiUpdateItemRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof ItemUpdateApiUpdateItem
     */
    readonly itemId: string;
    /**
     * The new item properties.
     * @type {BaseItemDto}
     * @memberof ItemUpdateApiUpdateItem
     */
    readonly baseItemDto: BaseItemDto;
}
/**
 * Request parameters for updateItemContentType operation in ItemUpdateApi.
 * @export
 * @interface ItemUpdateApiUpdateItemContentTypeRequest
 */
export interface ItemUpdateApiUpdateItemContentTypeRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof ItemUpdateApiUpdateItemContentType
     */
    readonly itemId: string;
    /**
     * The content type of the item.
     * @type {string}
     * @memberof ItemUpdateApiUpdateItemContentType
     */
    readonly contentType?: string;
}
/**
 * ItemUpdateApi - object-oriented interface
 * @export
 * @class ItemUpdateApi
 * @extends {BaseAPI}
 */
export declare class ItemUpdateApi extends BaseAPI {
    /**
     *
     * @summary Gets metadata editor info for an item.
     * @param {ItemUpdateApiGetMetadataEditorInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ItemUpdateApi
     */
    getMetadataEditorInfo(requestParameters: ItemUpdateApiGetMetadataEditorInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataEditorInfo, any>>;
    /**
     *
     * @summary Updates an item.
     * @param {ItemUpdateApiUpdateItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ItemUpdateApi
     */
    updateItem(requestParameters: ItemUpdateApiUpdateItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Updates an item\'s content type.
     * @param {ItemUpdateApiUpdateItemContentTypeRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ItemUpdateApi
     */
    updateItemContentType(requestParameters: ItemUpdateApiUpdateItemContentTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}