@jellyfin/sdk 0.9.0 → 0.11.0

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

@@ -8,10 +8,10 @@
  * 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 { PluginInfo } from '../models';
+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
@@ -25,7 +25,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    disablePlugin: (pluginId: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    disablePlugin: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Enables a disabled plugin.
@@ -34,7 +34,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    enablePlugin: (pluginId: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    enablePlugin: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets plugin configuration.
@@ -42,7 +42,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginConfiguration: (pluginId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPluginConfiguration: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a plugin\'s image.
@@ -51,7 +51,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginImage: (pluginId: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPluginImage: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a plugin\'s manifest.
@@ -59,14 +59,14 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginManifest: (pluginId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPlugins: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Uninstalls a plugin.
@@ -75,7 +75,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @deprecated
      * @throws {RequiredError}
      */
-    uninstallPlugin: (pluginId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    uninstallPlugin: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Uninstalls a plugin by version.
@@ -84,7 +84,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uninstallPluginByVersion: (pluginId: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    uninstallPluginByVersion: (pluginId: string, version: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Accepts plugin configuration as JSON body.
      * @summary Updates plugin configuration.
@@ -92,7 +92,7 @@ export declare const PluginsApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updatePluginConfiguration: (pluginId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    updatePluginConfiguration: (pluginId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PluginsApi - functional programming interface
@@ -107,7 +107,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    disablePlugin(pluginId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    disablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Enables a disabled plugin.
@@ -116,7 +116,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    enablePlugin(pluginId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    enablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Gets plugin configuration.
@@ -124,7 +124,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginConfiguration(pluginId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    getPluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
     /**
      *
      * @summary Gets a plugin\'s image.
@@ -133,7 +133,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginImage(pluginId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    getPluginImage(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Gets a plugin\'s manifest.
@@ -141,14 +141,14 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginManifest(pluginId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PluginInfo>>>;
+    getPlugins(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PluginInfo>>>;
     /**
      *
      * @summary Uninstalls a plugin.
@@ -157,7 +157,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @deprecated
      * @throws {RequiredError}
      */
-    uninstallPlugin(pluginId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    uninstallPlugin(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Uninstalls a plugin by version.
@@ -166,7 +166,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uninstallPluginByVersion(pluginId: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    uninstallPluginByVersion(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Accepts plugin configuration as JSON body.
      * @summary Updates plugin configuration.
@@ -174,7 +174,7 @@ export declare const PluginsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updatePluginConfiguration(pluginId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    updatePluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * PluginsApi - factory interface
@@ -184,79 +184,75 @@ export declare const PluginsApiFactory: (configuration?: Configuration, basePath
     /**
      *
      * @summary Disable a plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
+     * @param {PluginsApiDisablePluginRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    disablePlugin(pluginId: string, version: string, options?: any): AxiosPromise<void>;
+    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Enables a disabled plugin.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
+     * @param {PluginsApiEnablePluginRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    enablePlugin(pluginId: string, version: string, options?: any): AxiosPromise<void>;
+    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Gets plugin configuration.
-     * @param {string} pluginId Plugin id.
+     * @param {PluginsApiGetPluginConfigurationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginConfiguration(pluginId: string, options?: any): AxiosPromise<object>;
+    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
     /**
      *
      * @summary Gets a plugin\'s image.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
+     * @param {PluginsApiGetPluginImageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginImage(pluginId: string, version: string, options?: any): AxiosPromise<any>;
+    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Gets a plugin\'s manifest.
-     * @param {string} pluginId Plugin id.
+     * @param {PluginsApiGetPluginManifestRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPluginManifest(pluginId: string, options?: any): AxiosPromise<void>;
+    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?: any): AxiosPromise<Array<PluginInfo>>;
+    getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<Array<PluginInfo>>;
     /**
      *
      * @summary Uninstalls a plugin.
-     * @param {string} pluginId Plugin id.
+     * @param {PluginsApiUninstallPluginRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @deprecated
      * @throws {RequiredError}
      */
-    uninstallPlugin(pluginId: string, options?: any): AxiosPromise<void>;
+    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Uninstalls a plugin by version.
-     * @param {string} pluginId Plugin id.
-     * @param {string} version Plugin version.
+     * @param {PluginsApiUninstallPluginByVersionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uninstallPluginByVersion(pluginId: string, version: string, options?: any): AxiosPromise<void>;
+    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Accepts plugin configuration as JSON body.
      * @summary Updates plugin configuration.
-     * @param {string} pluginId Plugin id.
+     * @param {PluginsApiUpdatePluginConfigurationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updatePluginConfiguration(pluginId: string, options?: any): AxiosPromise<void>;
+    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
 /**
  * Request parameters for disablePlugin operation in PluginsApi.
@@ -401,7 +397,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Enables a disabled plugin.
@@ -410,7 +406,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Gets plugin configuration.
@@ -419,7 +415,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
     /**
      *
      * @summary Gets a plugin\'s image.
@@ -428,7 +424,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
+    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Gets a plugin\'s manifest.
@@ -437,7 +433,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    getPluginManifest(requestParameters: PluginsApiGetPluginManifestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    getPluginManifest(requestParameters: PluginsApiGetPluginManifestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Gets a list of currently installed plugins.
@@ -445,7 +441,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    getPlugins(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PluginInfo[], any>>;
+    getPlugins(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PluginInfo[], any>>;
     /**
      *
      * @summary Uninstalls a plugin.
@@ -455,7 +451,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Uninstalls a plugin by version.
@@ -464,7 +460,7 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Accepts plugin configuration as JSON body.
      * @summary Updates plugin configuration.
@@ -473,5 +469,5 @@ export declare class PluginsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PluginsApi
      */
-    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }