@jellyfin/sdk 0.9.0 → 0.11.0

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

@@ -8,14 +8,14 @@
  * 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 { EndPointInfo } from '../models';
-import { LogFile } from '../models';
-import { PublicSystemInfo } from '../models';
-import { SystemInfo } from '../models';
-import { WakeOnLanInfo } from '../models';
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { EndPointInfo } from '../models';
+import type { LogFile } from '../models';
+import type { PublicSystemInfo } from '../models';
+import type { SystemInfo } from '../models';
+import type { WakeOnLanInfo } from '../models';
 /**
  * SystemApi - axios parameter creator
  * @export
@@ -27,7 +27,7 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEndpointInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getEndpointInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a log file.
@@ -35,35 +35,35 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLogFile: (name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getLogFile: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPingSystem: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPingSystem: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets public information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPublicSystemInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPublicSystemInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a list of available server log files.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getServerLogs: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getServerLogs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSystemInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSystemInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets wake on lan information.
@@ -71,28 +71,28 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
      * @deprecated
      * @throws {RequiredError}
      */
-    getWakeOnLanInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getWakeOnLanInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postPingSystem: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    postPingSystem: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Restarts the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    restartApplication: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    restartApplication: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Shuts down the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    shutdownApplication: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    shutdownApplication: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * SystemApi - functional programming interface
@@ -105,7 +105,7 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEndpointInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>;
+    getEndpointInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>;
     /**
      *
      * @summary Gets a log file.
@@ -113,35 +113,35 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLogFile(name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    getLogFile(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPingSystem(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    getPingSystem(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      *
      * @summary Gets public information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPublicSystemInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>;
+    getPublicSystemInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>;
     /**
      *
      * @summary Gets a list of available server log files.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getServerLogs(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LogFile>>>;
+    getServerLogs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LogFile>>>;
     /**
      *
      * @summary Gets information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSystemInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>;
+    getSystemInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>;
     /**
      *
      * @summary Gets wake on lan information.
@@ -149,28 +149,28 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
      * @deprecated
      * @throws {RequiredError}
      */
-    getWakeOnLanInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WakeOnLanInfo>>>;
+    getWakeOnLanInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WakeOnLanInfo>>>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postPingSystem(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    postPingSystem(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      *
      * @summary Restarts the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    restartApplication(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    restartApplication(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Shuts down the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    shutdownApplication(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    shutdownApplication(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * SystemApi - factory interface
@@ -183,43 +183,43 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEndpointInfo(options?: any): AxiosPromise<EndPointInfo>;
+    getEndpointInfo(options?: RawAxiosRequestConfig): AxiosPromise<EndPointInfo>;
     /**
      *
      * @summary Gets a log file.
-     * @param {string} name The name of the log file to get.
+     * @param {SystemApiGetLogFileRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getLogFile(name: string, options?: any): AxiosPromise<any>;
+    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPingSystem(options?: any): AxiosPromise<string>;
+    getPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
      *
      * @summary Gets public information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPublicSystemInfo(options?: any): AxiosPromise<PublicSystemInfo>;
+    getPublicSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<PublicSystemInfo>;
     /**
      *
      * @summary Gets a list of available server log files.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getServerLogs(options?: any): AxiosPromise<Array<LogFile>>;
+    getServerLogs(options?: RawAxiosRequestConfig): AxiosPromise<Array<LogFile>>;
     /**
      *
      * @summary Gets information about the server.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSystemInfo(options?: any): AxiosPromise<SystemInfo>;
+    getSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<SystemInfo>;
     /**
      *
      * @summary Gets wake on lan information.
@@ -227,28 +227,28 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
      * @deprecated
      * @throws {RequiredError}
      */
-    getWakeOnLanInfo(options?: any): AxiosPromise<Array<WakeOnLanInfo>>;
+    getWakeOnLanInfo(options?: RawAxiosRequestConfig): AxiosPromise<Array<WakeOnLanInfo>>;
     /**
      *
      * @summary Pings the system.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postPingSystem(options?: any): AxiosPromise<string>;
+    postPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
      *
      * @summary Restarts the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    restartApplication(options?: any): AxiosPromise<void>;
+    restartApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Shuts down the application.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    shutdownApplication(options?: any): AxiosPromise<void>;
+    shutdownApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
 /**
  * Request parameters for getLogFile operation in SystemApi.
@@ -277,7 +277,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getEndpointInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndPointInfo, any>>;
+    getEndpointInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EndPointInfo, any>>;
     /**
      *
      * @summary Gets a log file.
@@ -286,7 +286,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
+    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Pings the system.
@@ -294,7 +294,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getPingSystem(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+    getPingSystem(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
      *
      * @summary Gets public information about the server.
@@ -302,7 +302,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getPublicSystemInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSystemInfo, any>>;
+    getPublicSystemInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSystemInfo, any>>;
     /**
      *
      * @summary Gets a list of available server log files.
@@ -310,7 +310,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getServerLogs(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LogFile[], any>>;
+    getServerLogs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LogFile[], any>>;
     /**
      *
      * @summary Gets information about the server.
@@ -318,7 +318,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getSystemInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SystemInfo, any>>;
+    getSystemInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SystemInfo, any>>;
     /**
      *
      * @summary Gets wake on lan information.
@@ -327,7 +327,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    getWakeOnLanInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WakeOnLanInfo[], any>>;
+    getWakeOnLanInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WakeOnLanInfo[], any>>;
     /**
      *
      * @summary Pings the system.
@@ -335,7 +335,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    postPingSystem(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+    postPingSystem(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
      *
      * @summary Restarts the application.
@@ -343,7 +343,7 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    restartApplication(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    restartApplication(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Shuts down the application.
@@ -351,5 +351,5 @@ export declare class SystemApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof SystemApi
      */
-    shutdownApplication(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    shutdownApplication(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }