@jellyfin/sdk/lib/generated-client/api/system-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 { 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
 */
export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets information about the request endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEndpointInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets a log file.
     * @param {string} name The name of the log file to get.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLogFile: (name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPingSystem: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets public information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPublicSystemInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets a list of available server log files.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getServerLogs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSystemInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets wake on lan information.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    getWakeOnLanInfo: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postPingSystem: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Restarts the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restartApplication: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Shuts down the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shutdownApplication: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SystemApi - functional programming interface
 * @export
 */
export declare const SystemApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets information about the request endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEndpointInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>;
    /**
     *
     * @summary Gets a log file.
     * @param {string} name The name of the log file to get.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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?: 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?: 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?: 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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>;
    /**
     *
     * @summary Gets wake on lan information.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @summary Restarts the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * SystemApi - factory interface
 * @export
 */
export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets information about the request endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getEndpointInfo(options?: RawAxiosRequestConfig): AxiosPromise<EndPointInfo>;
    /**
     *
     * @summary Gets a log file.
     * @param {SystemApiGetLogFileRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     *
     * @summary Gets public information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPublicSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<PublicSystemInfo>;
    /**
     *
     * @summary Gets a list of available server log files.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getServerLogs(options?: RawAxiosRequestConfig): AxiosPromise<Array<LogFile>>;
    /**
     *
     * @summary Gets information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSystemInfo(options?: RawAxiosRequestConfig): AxiosPromise<SystemInfo>;
    /**
     *
     * @summary Gets wake on lan information.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    getWakeOnLanInfo(options?: RawAxiosRequestConfig): AxiosPromise<Array<WakeOnLanInfo>>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postPingSystem(options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     *
     * @summary Restarts the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restartApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Shuts down the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shutdownApplication(options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for getLogFile operation in SystemApi.
 * @export
 * @interface SystemApiGetLogFileRequest
 */
export interface SystemApiGetLogFileRequest {
    /**
     * The name of the log file to get.
     * @type {string}
     * @memberof SystemApiGetLogFile
     */
    readonly name: string;
}
/**
 * SystemApi - object-oriented interface
 * @export
 * @class SystemApi
 * @extends {BaseAPI}
 */
export declare class SystemApi extends BaseAPI {
    /**
     *
     * @summary Gets information about the request endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getEndpointInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EndPointInfo, any>>;
    /**
     *
     * @summary Gets a log file.
     * @param {SystemApiGetLogFileRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getLogFile(requestParameters: SystemApiGetLogFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getPingSystem(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Gets public information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getPublicSystemInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSystemInfo, any>>;
    /**
     *
     * @summary Gets a list of available server log files.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getServerLogs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LogFile[], any>>;
    /**
     *
     * @summary Gets information about the server.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getSystemInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SystemInfo, any>>;
    /**
     *
     * @summary Gets wake on lan information.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    getWakeOnLanInfo(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WakeOnLanInfo[], any>>;
    /**
     *
     * @summary Pings the system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    postPingSystem(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Restarts the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    restartApplication(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Shuts down the application.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SystemApi
     */
    shutdownApplication(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}