@jellyfin/sdk/lib/generated-client/api/image-by-name-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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { ImageByNameInfo } from '../models';
/**
 * ImageByNameApi - axios parameter creator
 * @export
 */
export declare const ImageByNameApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get General Image.
     * @param {string} name The name of the image.
     * @param {string} type Image Type (primary, backdrop, logo, etc).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImage: (name: string, type: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get media info image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImage: (theme: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all media info images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get rating image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImage: (theme: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ImageByNameApi - functional programming interface
 * @export
 */
export declare const ImageByNameApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get General Image.
     * @param {string} name The name of the image.
     * @param {string} type Image Type (primary, backdrop, logo, etc).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImage(name: string, type: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImageByNameInfo>>>;
    /**
     *
     * @summary Get media info image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImage(theme: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    /**
     *
     * @summary Get all media info images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImageByNameInfo>>>;
    /**
     *
     * @summary Get rating image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImage(theme: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImageByNameInfo>>>;
};
/**
 * ImageByNameApi - factory interface
 * @export
 */
export declare const ImageByNameApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get General Image.
     * @param {string} name The name of the image.
     * @param {string} type Image Type (primary, backdrop, logo, etc).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImage(name: string, type: string, options?: any): AxiosPromise<any>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGeneralImages(options?: any): AxiosPromise<Array<ImageByNameInfo>>;
    /**
     *
     * @summary Get media info image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImage(theme: string, name: string, options?: any): AxiosPromise<any>;
    /**
     *
     * @summary Get all media info images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMediaInfoImages(options?: any): AxiosPromise<Array<ImageByNameInfo>>;
    /**
     *
     * @summary Get rating image.
     * @param {string} theme The theme to get the image from.
     * @param {string} name The name of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImage(theme: string, name: string, options?: any): AxiosPromise<any>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRatingImages(options?: any): AxiosPromise<Array<ImageByNameInfo>>;
};
/**
 * Request parameters for getGeneralImage operation in ImageByNameApi.
 * @export
 * @interface ImageByNameApiGetGeneralImageRequest
 */
export interface ImageByNameApiGetGeneralImageRequest {
    /**
     * The name of the image.
     * @type {string}
     * @memberof ImageByNameApiGetGeneralImage
     */
    readonly name: string;
    /**
     * Image Type (primary, backdrop, logo, etc).
     * @type {string}
     * @memberof ImageByNameApiGetGeneralImage
     */
    readonly type: string;
}
/**
 * Request parameters for getMediaInfoImage operation in ImageByNameApi.
 * @export
 * @interface ImageByNameApiGetMediaInfoImageRequest
 */
export interface ImageByNameApiGetMediaInfoImageRequest {
    /**
     * The theme to get the image from.
     * @type {string}
     * @memberof ImageByNameApiGetMediaInfoImage
     */
    readonly theme: string;
    /**
     * The name of the image.
     * @type {string}
     * @memberof ImageByNameApiGetMediaInfoImage
     */
    readonly name: string;
}
/**
 * Request parameters for getRatingImage operation in ImageByNameApi.
 * @export
 * @interface ImageByNameApiGetRatingImageRequest
 */
export interface ImageByNameApiGetRatingImageRequest {
    /**
     * The theme to get the image from.
     * @type {string}
     * @memberof ImageByNameApiGetRatingImage
     */
    readonly theme: string;
    /**
     * The name of the image.
     * @type {string}
     * @memberof ImageByNameApiGetRatingImage
     */
    readonly name: string;
}
/**
 * ImageByNameApi - object-oriented interface
 * @export
 * @class ImageByNameApi
 * @extends {BaseAPI}
 */
export declare class ImageByNameApi extends BaseAPI {
    /**
     *
     * @summary Get General Image.
     * @param {ImageByNameApiGetGeneralImageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getGeneralImage(requestParameters: ImageByNameApiGetGeneralImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getGeneralImages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageByNameInfo[], any>>;
    /**
     *
     * @summary Get media info image.
     * @param {ImageByNameApiGetMediaInfoImageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getMediaInfoImage(requestParameters: ImageByNameApiGetMediaInfoImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
    /**
     *
     * @summary Get all media info images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getMediaInfoImages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageByNameInfo[], any>>;
    /**
     *
     * @summary Get rating image.
     * @param {ImageByNameApiGetRatingImageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getRatingImage(requestParameters: ImageByNameApiGetRatingImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
    /**
     *
     * @summary Get all general images.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ImageByNameApi
     */
    getRatingImages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImageByNameInfo[], any>>;
}