@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
160 lines (159 loc) • 5.72 kB
TypeScript
/**
* 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 { CountryInfo } from '../models';
import type { CultureDto } from '../models';
import type { LocalizationOption } from '../models';
import type { ParentalRating } from '../models';
/**
* LocalizationApi - axios parameter creator
* @export
*/
export declare const LocalizationApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Gets known countries.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCountries: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets known cultures.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCultures: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets localization options.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLocalizationOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets known parental ratings.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getParentalRatings: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* LocalizationApi - functional programming interface
* @export
*/
export declare const LocalizationApiFp: (configuration?: Configuration) => {
/**
*
* @summary Gets known countries.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCountries(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CountryInfo>>>;
/**
*
* @summary Gets known cultures.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCultures(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CultureDto>>>;
/**
*
* @summary Gets localization options.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLocalizationOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LocalizationOption>>>;
/**
*
* @summary Gets known parental ratings.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getParentalRatings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ParentalRating>>>;
};
/**
* LocalizationApi - factory interface
* @export
*/
export declare const LocalizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Gets known countries.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCountries(options?: RawAxiosRequestConfig): AxiosPromise<Array<CountryInfo>>;
/**
*
* @summary Gets known cultures.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCultures(options?: RawAxiosRequestConfig): AxiosPromise<Array<CultureDto>>;
/**
*
* @summary Gets localization options.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLocalizationOptions(options?: RawAxiosRequestConfig): AxiosPromise<Array<LocalizationOption>>;
/**
*
* @summary Gets known parental ratings.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getParentalRatings(options?: RawAxiosRequestConfig): AxiosPromise<Array<ParentalRating>>;
};
/**
* LocalizationApi - object-oriented interface
* @export
* @class LocalizationApi
* @extends {BaseAPI}
*/
export declare class LocalizationApi extends BaseAPI {
/**
*
* @summary Gets known countries.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LocalizationApi
*/
getCountries(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CountryInfo[], any>>;
/**
*
* @summary Gets known cultures.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LocalizationApi
*/
getCultures(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CultureDto[], any>>;
/**
*
* @summary Gets localization options.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LocalizationApi
*/
getLocalizationOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LocalizationOption[], any>>;
/**
*
* @summary Gets known parental ratings.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LocalizationApi
*/
getParentalRatings(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParentalRating[], any>>;
}