@jellyfin/sdk/lib/generated-client/api/configuration-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 { MetadataOptions } from '../models';
import type { ServerConfiguration } from '../models';
/**
 * ConfigurationApi - axios parameter creator
 * @export
 */
export declare const ConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets application configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfiguration: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets a default MetadataOptions object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultMetadataOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets a named configuration.
     * @param {string} key Configuration key.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNamedConfiguration: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates application configuration.
     * @param {ServerConfiguration} serverConfiguration Configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateConfiguration: (serverConfiguration: ServerConfiguration, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Updates named configuration.
     * @param {string} key Configuration key.
     * @param {any} body Configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNamedConfiguration: (key: string, body: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ConfigurationApi - functional programming interface
 * @export
 */
export declare const ConfigurationApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets application configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfiguration(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>>;
    /**
     *
     * @summary Gets a default MetadataOptions object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultMetadataOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>>;
    /**
     *
     * @summary Gets a named configuration.
     * @param {string} key Configuration key.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNamedConfiguration(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
    /**
     *
     * @summary Updates application configuration.
     * @param {ServerConfiguration} serverConfiguration Configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateConfiguration(serverConfiguration: ServerConfiguration, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Updates named configuration.
     * @param {string} key Configuration key.
     * @param {any} body Configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNamedConfiguration(key: string, body: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * ConfigurationApi - factory interface
 * @export
 */
export declare const ConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets application configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfiguration(options?: RawAxiosRequestConfig): AxiosPromise<ServerConfiguration>;
    /**
     *
     * @summary Gets a default MetadataOptions object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultMetadataOptions(options?: RawAxiosRequestConfig): AxiosPromise<MetadataOptions>;
    /**
     *
     * @summary Gets a named configuration.
     * @param {ConfigurationApiGetNamedConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNamedConfiguration(requestParameters: ConfigurationApiGetNamedConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    /**
     *
     * @summary Updates application configuration.
     * @param {ConfigurationApiUpdateConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateConfiguration(requestParameters: ConfigurationApiUpdateConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Updates named configuration.
     * @param {ConfigurationApiUpdateNamedConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNamedConfiguration(requestParameters: ConfigurationApiUpdateNamedConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for getNamedConfiguration operation in ConfigurationApi.
 * @export
 * @interface ConfigurationApiGetNamedConfigurationRequest
 */
export interface ConfigurationApiGetNamedConfigurationRequest {
    /**
     * Configuration key.
     * @type {string}
     * @memberof ConfigurationApiGetNamedConfiguration
     */
    readonly key: string;
}
/**
 * Request parameters for updateConfiguration operation in ConfigurationApi.
 * @export
 * @interface ConfigurationApiUpdateConfigurationRequest
 */
export interface ConfigurationApiUpdateConfigurationRequest {
    /**
     * Configuration.
     * @type {ServerConfiguration}
     * @memberof ConfigurationApiUpdateConfiguration
     */
    readonly serverConfiguration: ServerConfiguration;
}
/**
 * Request parameters for updateNamedConfiguration operation in ConfigurationApi.
 * @export
 * @interface ConfigurationApiUpdateNamedConfigurationRequest
 */
export interface ConfigurationApiUpdateNamedConfigurationRequest {
    /**
     * Configuration key.
     * @type {string}
     * @memberof ConfigurationApiUpdateNamedConfiguration
     */
    readonly key: string;
    /**
     * Configuration.
     * @type {any}
     * @memberof ConfigurationApiUpdateNamedConfiguration
     */
    readonly body: any;
}
/**
 * ConfigurationApi - object-oriented interface
 * @export
 * @class ConfigurationApi
 * @extends {BaseAPI}
 */
export declare class ConfigurationApi extends BaseAPI {
    /**
     *
     * @summary Gets application configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ConfigurationApi
     */
    getConfiguration(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerConfiguration, any>>;
    /**
     *
     * @summary Gets a default MetadataOptions object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ConfigurationApi
     */
    getDefaultMetadataOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataOptions, any>>;
    /**
     *
     * @summary Gets a named configuration.
     * @param {ConfigurationApiGetNamedConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ConfigurationApi
     */
    getNamedConfiguration(requestParameters: ConfigurationApiGetNamedConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
    /**
     *
     * @summary Updates application configuration.
     * @param {ConfigurationApiUpdateConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ConfigurationApi
     */
    updateConfiguration(requestParameters: ConfigurationApiUpdateConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Updates named configuration.
     * @param {ConfigurationApiUpdateNamedConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ConfigurationApi
     */
    updateNamedConfiguration(requestParameters: ConfigurationApiUpdateNamedConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}