@jellyfin/sdk/lib/generated-client/api/lyrics-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 { LyricDto } from '../models';
import type { RemoteLyricInfoDto } from '../models';
/**
 * LyricsApi - axios parameter creator
 * @export
 */
export declare const LyricsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Deletes an external lyric file.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteLyrics: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Downloads a remote lyric.
     * @param {string} itemId The item id.
     * @param {string} lyricId The lyric id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteLyrics: (itemId: string, lyricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets an item\'s lyrics.
     * @param {string} itemId Item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLyrics: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the remote lyrics.
     * @param {string} lyricId The remote provider item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteLyrics: (lyricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Search remote lyrics.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchRemoteLyrics: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Upload an external lyric file.
     * @param {string} itemId The item the lyric belongs to.
     * @param {string} fileName Name of the file being uploaded.
     * @param {File} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLyrics: (itemId: string, fileName: string, body?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * LyricsApi - functional programming interface
 * @export
 */
export declare const LyricsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Deletes an external lyric file.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteLyrics(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Downloads a remote lyric.
     * @param {string} itemId The item id.
     * @param {string} lyricId The lyric id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteLyrics(itemId: string, lyricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>;
    /**
     *
     * @summary Gets an item\'s lyrics.
     * @param {string} itemId Item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLyrics(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>;
    /**
     *
     * @summary Gets the remote lyrics.
     * @param {string} lyricId The remote provider item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteLyrics(lyricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>;
    /**
     *
     * @summary Search remote lyrics.
     * @param {string} itemId The item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchRemoteLyrics(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RemoteLyricInfoDto>>>;
    /**
     *
     * @summary Upload an external lyric file.
     * @param {string} itemId The item the lyric belongs to.
     * @param {string} fileName Name of the file being uploaded.
     * @param {File} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLyrics(itemId: string, fileName: string, body?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LyricDto>>;
};
/**
 * LyricsApi - factory interface
 * @export
 */
export declare const LyricsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Deletes an external lyric file.
     * @param {LyricsApiDeleteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteLyrics(requestParameters: LyricsApiDeleteLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Downloads a remote lyric.
     * @param {LyricsApiDownloadRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadRemoteLyrics(requestParameters: LyricsApiDownloadRemoteLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LyricDto>;
    /**
     *
     * @summary Gets an item\'s lyrics.
     * @param {LyricsApiGetLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLyrics(requestParameters: LyricsApiGetLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LyricDto>;
    /**
     *
     * @summary Gets the remote lyrics.
     * @param {LyricsApiGetRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRemoteLyrics(requestParameters: LyricsApiGetRemoteLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LyricDto>;
    /**
     *
     * @summary Search remote lyrics.
     * @param {LyricsApiSearchRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchRemoteLyrics(requestParameters: LyricsApiSearchRemoteLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RemoteLyricInfoDto>>;
    /**
     *
     * @summary Upload an external lyric file.
     * @param {LyricsApiUploadLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLyrics(requestParameters: LyricsApiUploadLyricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LyricDto>;
};
/**
 * Request parameters for deleteLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiDeleteLyricsRequest
 */
export interface LyricsApiDeleteLyricsRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof LyricsApiDeleteLyrics
     */
    readonly itemId: string;
}
/**
 * Request parameters for downloadRemoteLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiDownloadRemoteLyricsRequest
 */
export interface LyricsApiDownloadRemoteLyricsRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof LyricsApiDownloadRemoteLyrics
     */
    readonly itemId: string;
    /**
     * The lyric id.
     * @type {string}
     * @memberof LyricsApiDownloadRemoteLyrics
     */
    readonly lyricId: string;
}
/**
 * Request parameters for getLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiGetLyricsRequest
 */
export interface LyricsApiGetLyricsRequest {
    /**
     * Item id.
     * @type {string}
     * @memberof LyricsApiGetLyrics
     */
    readonly itemId: string;
}
/**
 * Request parameters for getRemoteLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiGetRemoteLyricsRequest
 */
export interface LyricsApiGetRemoteLyricsRequest {
    /**
     * The remote provider item id.
     * @type {string}
     * @memberof LyricsApiGetRemoteLyrics
     */
    readonly lyricId: string;
}
/**
 * Request parameters for searchRemoteLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiSearchRemoteLyricsRequest
 */
export interface LyricsApiSearchRemoteLyricsRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof LyricsApiSearchRemoteLyrics
     */
    readonly itemId: string;
}
/**
 * Request parameters for uploadLyrics operation in LyricsApi.
 * @export
 * @interface LyricsApiUploadLyricsRequest
 */
export interface LyricsApiUploadLyricsRequest {
    /**
     * The item the lyric belongs to.
     * @type {string}
     * @memberof LyricsApiUploadLyrics
     */
    readonly itemId: string;
    /**
     * Name of the file being uploaded.
     * @type {string}
     * @memberof LyricsApiUploadLyrics
     */
    readonly fileName: string;
    /**
     *
     * @type {File}
     * @memberof LyricsApiUploadLyrics
     */
    readonly body?: File;
}
/**
 * LyricsApi - object-oriented interface
 * @export
 * @class LyricsApi
 * @extends {BaseAPI}
 */
export declare class LyricsApi extends BaseAPI {
    /**
     *
     * @summary Deletes an external lyric file.
     * @param {LyricsApiDeleteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    deleteLyrics(requestParameters: LyricsApiDeleteLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Downloads a remote lyric.
     * @param {LyricsApiDownloadRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    downloadRemoteLyrics(requestParameters: LyricsApiDownloadRemoteLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LyricDto, any>>;
    /**
     *
     * @summary Gets an item\'s lyrics.
     * @param {LyricsApiGetLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    getLyrics(requestParameters: LyricsApiGetLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LyricDto, any>>;
    /**
     *
     * @summary Gets the remote lyrics.
     * @param {LyricsApiGetRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    getRemoteLyrics(requestParameters: LyricsApiGetRemoteLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LyricDto, any>>;
    /**
     *
     * @summary Search remote lyrics.
     * @param {LyricsApiSearchRemoteLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    searchRemoteLyrics(requestParameters: LyricsApiSearchRemoteLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoteLyricInfoDto[], any>>;
    /**
     *
     * @summary Upload an external lyric file.
     * @param {LyricsApiUploadLyricsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof LyricsApi
     */
    uploadLyrics(requestParameters: LyricsApiUploadLyricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LyricDto, any>>;
}