@jellyfin/sdk/lib/generated-client/api/item-refresh-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 { MetadataRefreshMode } from '../models';
/**
 * ItemRefreshApi - axios parameter creator
 * @export
 */
export declare const ItemRefreshApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Refreshes metadata for an item.
     * @param {string} itemId Item id.
     * @param {MetadataRefreshMode} [metadataRefreshMode] (Optional) Specifies the metadata refresh mode.
     * @param {MetadataRefreshMode} [imageRefreshMode] (Optional) Specifies the image refresh mode.
     * @param {boolean} [replaceAllMetadata] (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
     * @param {boolean} [replaceAllImages] (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    refreshItem: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ItemRefreshApi - functional programming interface
 * @export
 */
export declare const ItemRefreshApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Refreshes metadata for an item.
     * @param {string} itemId Item id.
     * @param {MetadataRefreshMode} [metadataRefreshMode] (Optional) Specifies the metadata refresh mode.
     * @param {MetadataRefreshMode} [imageRefreshMode] (Optional) Specifies the image refresh mode.
     * @param {boolean} [replaceAllMetadata] (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
     * @param {boolean} [replaceAllImages] (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    refreshItem(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * ItemRefreshApi - factory interface
 * @export
 */
export declare const ItemRefreshApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Refreshes metadata for an item.
     * @param {ItemRefreshApiRefreshItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    refreshItem(requestParameters: ItemRefreshApiRefreshItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for refreshItem operation in ItemRefreshApi.
 * @export
 * @interface ItemRefreshApiRefreshItemRequest
 */
export interface ItemRefreshApiRefreshItemRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof ItemRefreshApiRefreshItem
     */
    readonly itemId: string;
    /**
     * (Optional) Specifies the metadata refresh mode.
     * @type {MetadataRefreshMode}
     * @memberof ItemRefreshApiRefreshItem
     */
    readonly metadataRefreshMode?: MetadataRefreshMode;
    /**
     * (Optional) Specifies the image refresh mode.
     * @type {MetadataRefreshMode}
     * @memberof ItemRefreshApiRefreshItem
     */
    readonly imageRefreshMode?: MetadataRefreshMode;
    /**
     * (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
     * @type {boolean}
     * @memberof ItemRefreshApiRefreshItem
     */
    readonly replaceAllMetadata?: boolean;
    /**
     * (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
     * @type {boolean}
     * @memberof ItemRefreshApiRefreshItem
     */
    readonly replaceAllImages?: boolean;
}
/**
 * ItemRefreshApi - object-oriented interface
 * @export
 * @class ItemRefreshApi
 * @extends {BaseAPI}
 */
export declare class ItemRefreshApi extends BaseAPI {
    /**
     *
     * @summary Refreshes metadata for an item.
     * @param {ItemRefreshApiRefreshItemRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ItemRefreshApi
     */
    refreshItem(requestParameters: ItemRefreshApiRefreshItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}