@jellyfin/sdk/lib/generated-client/api/remote-image-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 { ImageProviderInfo } from '../models';
import type { ImageType } from '../models';
import type { RemoteImageResult } from '../models';
/**
 * RemoteImageApi - axios parameter creator
 * @export
 */
export declare const RemoteImageApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Downloads a remote image for an item.
     * @param {string} itemId Item Id.
     * @param {ImageType} type The image type.
     * @param {string} [imageUrl] The image url.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets available remote image providers for an item.
     * @param {string} itemId Item Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImageProviders: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets available remote images for an item.
     * @param {string} itemId Item Id.
     * @param {ImageType} [type] The image type.
     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
     * @param {number} [limit] Optional. The maximum number of records to return.
     * @param {string} [providerName] Optional. The image provider to use.
     * @param {boolean} [includeAllLanguages] Optional. Include all languages.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * RemoteImageApi - functional programming interface
 * @export
 */
export declare const RemoteImageApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Downloads a remote image for an item.
     * @param {string} itemId Item Id.
     * @param {ImageType} type The image type.
     * @param {string} [imageUrl] The image url.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Gets available remote image providers for an item.
     * @param {string} itemId Item Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImageProviders(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImageProviderInfo>>>;
    /**
     *
     * @summary Gets available remote images for an item.
     * @param {string} itemId Item Id.
     * @param {ImageType} [type] The image type.
     * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
     * @param {number} [limit] Optional. The maximum number of records to return.
     * @param {string} [providerName] Optional. The image provider to use.
     * @param {boolean} [includeAllLanguages] Optional. Include all languages.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>;
};
/**
 * RemoteImageApi - factory interface
 * @export
 */
export declare const RemoteImageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Downloads a remote image for an item.
     * @param {RemoteImageApiDownloadRemoteImageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteImage(requestParameters: RemoteImageApiDownloadRemoteImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Gets available remote image providers for an item.
     * @param {RemoteImageApiGetRemoteImageProvidersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImageProviders(requestParameters: RemoteImageApiGetRemoteImageProvidersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImageProviderInfo>>;
    /**
     *
     * @summary Gets available remote images for an item.
     * @param {RemoteImageApiGetRemoteImagesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteImages(requestParameters: RemoteImageApiGetRemoteImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<RemoteImageResult>;
};
/**
 * Request parameters for downloadRemoteImage operation in RemoteImageApi.
 * @export
 * @interface RemoteImageApiDownloadRemoteImageRequest
 */
export interface RemoteImageApiDownloadRemoteImageRequest {
    /**
     * Item Id.
     * @type {string}
     * @memberof RemoteImageApiDownloadRemoteImage
     */
    readonly itemId: string;
    /**
     * The image type.
     * @type {ImageType}
     * @memberof RemoteImageApiDownloadRemoteImage
     */
    readonly type: ImageType;
    /**
     * The image url.
     * @type {string}
     * @memberof RemoteImageApiDownloadRemoteImage
     */
    readonly imageUrl?: string;
}
/**
 * Request parameters for getRemoteImageProviders operation in RemoteImageApi.
 * @export
 * @interface RemoteImageApiGetRemoteImageProvidersRequest
 */
export interface RemoteImageApiGetRemoteImageProvidersRequest {
    /**
     * Item Id.
     * @type {string}
     * @memberof RemoteImageApiGetRemoteImageProviders
     */
    readonly itemId: string;
}
/**
 * Request parameters for getRemoteImages operation in RemoteImageApi.
 * @export
 * @interface RemoteImageApiGetRemoteImagesRequest
 */
export interface RemoteImageApiGetRemoteImagesRequest {
    /**
     * Item Id.
     * @type {string}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly itemId: string;
    /**
     * The image type.
     * @type {ImageType}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly type?: ImageType;
    /**
     * Optional. The record index to start at. All items with a lower index will be dropped from the results.
     * @type {number}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly startIndex?: number;
    /**
     * Optional. The maximum number of records to return.
     * @type {number}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly limit?: number;
    /**
     * Optional. The image provider to use.
     * @type {string}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly providerName?: string;
    /**
     * Optional. Include all languages.
     * @type {boolean}
     * @memberof RemoteImageApiGetRemoteImages
     */
    readonly includeAllLanguages?: boolean;
}
/**
 * RemoteImageApi - object-oriented interface
 * @export
 * @class RemoteImageApi
 * @extends {BaseAPI}
 */
export declare class RemoteImageApi extends BaseAPI {
    /**
     *
     * @summary Downloads a remote image for an item.
     * @param {RemoteImageApiDownloadRemoteImageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RemoteImageApi
     */
    downloadRemoteImage(requestParameters: RemoteImageApiDownloadRemoteImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Gets available remote image providers for an item.
     * @param {RemoteImageApiGetRemoteImageProvidersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RemoteImageApi
     */
    getRemoteImageProviders(requestParameters: RemoteImageApiGetRemoteImageProvidersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageProviderInfo[], any>>;
    /**
     *
     * @summary Gets available remote images for an item.
     * @param {RemoteImageApiGetRemoteImagesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RemoteImageApi
     */
    getRemoteImages(requestParameters: RemoteImageApiGetRemoteImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoteImageResult, any>>;
}