@jellyfin/sdk 0.13.0 → 1.0.0

package/lib/generated-client/api/plugins-api.d.ts

@@ -1,473 +0,0 @@
-/**
- * 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 { PluginInfo } from '../models';
-/**
- * PluginsApi - axios parameter creator
- * @export
- */
-export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Disable a plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    disablePlugin: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Enables a disabled plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    enablePlugin: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Gets plugin configuration.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginConfiguration: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Gets a plugin\'s image.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginImage: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Gets a plugin\'s manifest.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginManifest: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Gets a list of currently installed plugins.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPlugins: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Uninstalls a plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    uninstallPlugin: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Uninstalls a plugin by version.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    uninstallPluginByVersion: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Accepts plugin configuration as JSON body.
-     * @summary Updates plugin configuration.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updatePluginConfiguration: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * PluginsApi - functional programming interface
- * @export
- */
-export declare const PluginsApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Disable a plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    disablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary Enables a disabled plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    enablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary Gets plugin configuration.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
-    /**
-     *
-     * @summary Gets a plugin\'s image.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginImage(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
-    /**
-     *
-     * @summary Gets a plugin\'s manifest.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginManifest(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary Gets a list of currently installed plugins.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPlugins(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PluginInfo>>>;
-    /**
-     *
-     * @summary Uninstalls a plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    uninstallPlugin(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     *
-     * @summary Uninstalls a plugin by version.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    uninstallPluginByVersion(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Accepts plugin configuration as JSON body.
-     * @summary Updates plugin configuration.
-     * @param {string} pluginId Plugin id.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updatePluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-};
-/**
- * PluginsApi - factory interface
- * @export
- */
-export declare const PluginsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Disable a plugin.
-     * @param {PluginsApiDisablePluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Enables a disabled plugin.
-     * @param {PluginsApiEnablePluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Gets plugin configuration.
-     * @param {PluginsApiGetPluginConfigurationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
-    /**
-     *
-     * @summary Gets a plugin\'s image.
-     * @param {PluginsApiGetPluginImageRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
-    /**
-     *
-     * @summary Gets a plugin\'s manifest.
-     * @param {PluginsApiGetPluginManifestRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPluginManifest(requestParameters: PluginsApiGetPluginManifestRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Gets a list of currently installed plugins.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<Array<PluginInfo>>;
-    /**
-     *
-     * @summary Uninstalls a plugin.
-     * @param {PluginsApiUninstallPluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     */
-    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Uninstalls a plugin by version.
-     * @param {PluginsApiUninstallPluginByVersionRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Accepts plugin configuration as JSON body.
-     * @summary Updates plugin configuration.
-     * @param {PluginsApiUpdatePluginConfigurationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-};
-/**
- * Request parameters for disablePlugin operation in PluginsApi.
- * @export
- * @interface PluginsApiDisablePluginRequest
- */
-export interface PluginsApiDisablePluginRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiDisablePlugin
-     */
-    readonly pluginId: string;
-    /**
-     * Plugin version.
-     * @type {string}
-     * @memberof PluginsApiDisablePlugin
-     */
-    readonly version: string;
-}
-/**
- * Request parameters for enablePlugin operation in PluginsApi.
- * @export
- * @interface PluginsApiEnablePluginRequest
- */
-export interface PluginsApiEnablePluginRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiEnablePlugin
-     */
-    readonly pluginId: string;
-    /**
-     * Plugin version.
-     * @type {string}
-     * @memberof PluginsApiEnablePlugin
-     */
-    readonly version: string;
-}
-/**
- * Request parameters for getPluginConfiguration operation in PluginsApi.
- * @export
- * @interface PluginsApiGetPluginConfigurationRequest
- */
-export interface PluginsApiGetPluginConfigurationRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiGetPluginConfiguration
-     */
-    readonly pluginId: string;
-}
-/**
- * Request parameters for getPluginImage operation in PluginsApi.
- * @export
- * @interface PluginsApiGetPluginImageRequest
- */
-export interface PluginsApiGetPluginImageRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiGetPluginImage
-     */
-    readonly pluginId: string;
-    /**
-     * Plugin version.
-     * @type {string}
-     * @memberof PluginsApiGetPluginImage
-     */
-    readonly version: string;
-}
-/**
- * Request parameters for getPluginManifest operation in PluginsApi.
- * @export
- * @interface PluginsApiGetPluginManifestRequest
- */
-export interface PluginsApiGetPluginManifestRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiGetPluginManifest
-     */
-    readonly pluginId: string;
-}
-/**
- * Request parameters for uninstallPlugin operation in PluginsApi.
- * @export
- * @interface PluginsApiUninstallPluginRequest
- */
-export interface PluginsApiUninstallPluginRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiUninstallPlugin
-     */
-    readonly pluginId: string;
-}
-/**
- * Request parameters for uninstallPluginByVersion operation in PluginsApi.
- * @export
- * @interface PluginsApiUninstallPluginByVersionRequest
- */
-export interface PluginsApiUninstallPluginByVersionRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiUninstallPluginByVersion
-     */
-    readonly pluginId: string;
-    /**
-     * Plugin version.
-     * @type {string}
-     * @memberof PluginsApiUninstallPluginByVersion
-     */
-    readonly version: string;
-}
-/**
- * Request parameters for updatePluginConfiguration operation in PluginsApi.
- * @export
- * @interface PluginsApiUpdatePluginConfigurationRequest
- */
-export interface PluginsApiUpdatePluginConfigurationRequest {
-    /**
-     * Plugin id.
-     * @type {string}
-     * @memberof PluginsApiUpdatePluginConfiguration
-     */
-    readonly pluginId: string;
-}
-/**
- * PluginsApi - object-oriented interface
- * @export
- * @class PluginsApi
- * @extends {BaseAPI}
- */
-export declare class PluginsApi extends BaseAPI {
-    /**
-     *
-     * @summary Disable a plugin.
-     * @param {PluginsApiDisablePluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Enables a disabled plugin.
-     * @param {PluginsApiEnablePluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Gets plugin configuration.
-     * @param {PluginsApiGetPluginConfigurationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
-    /**
-     *
-     * @summary Gets a plugin\'s image.
-     * @param {PluginsApiGetPluginImageRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
-    /**
-     *
-     * @summary Gets a plugin\'s manifest.
-     * @param {PluginsApiGetPluginManifestRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    getPluginManifest(requestParameters: PluginsApiGetPluginManifestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Gets a list of currently installed plugins.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    getPlugins(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PluginInfo[], any, {}>>;
-    /**
-     *
-     * @summary Uninstalls a plugin.
-     * @param {PluginsApiUninstallPluginRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Uninstalls a plugin by version.
-     * @param {PluginsApiUninstallPluginByVersionRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Accepts plugin configuration as JSON body.
-     * @summary Updates plugin configuration.
-     * @param {PluginsApiUpdatePluginConfigurationRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PluginsApi
-     */
-    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-}