@jellyfin/sdk/lib/generated-client/api/devices-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 { DeviceInfoDto } from '../models';
import type { DeviceInfoDtoQueryResult } from '../models';
import type { DeviceOptionsDto } from '../models';
/**
 * DevicesApi - axios parameter creator
 * @export
 */
export declare const DevicesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Deletes a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDevice: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get info for a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceInfo: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get options for a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceOptions: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get Devices.
     * @param {string} [userId] Gets or sets the user identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDevices: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update device options.
     * @param {string} id Device Id.
     * @param {DeviceOptionsDto} deviceOptionsDto Device Options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateDeviceOptions: (id: string, deviceOptionsDto: DeviceOptionsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DevicesApi - functional programming interface
 * @export
 */
export declare const DevicesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Deletes a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDevice(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Get info for a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceInfo(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDto>>;
    /**
     *
     * @summary Get options for a device.
     * @param {string} id Device Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceOptions(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptionsDto>>;
    /**
     *
     * @summary Get Devices.
     * @param {string} [userId] Gets or sets the user identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDevices(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoDtoQueryResult>>;
    /**
     *
     * @summary Update device options.
     * @param {string} id Device Id.
     * @param {DeviceOptionsDto} deviceOptionsDto Device Options.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateDeviceOptions(id: string, deviceOptionsDto: DeviceOptionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * DevicesApi - factory interface
 * @export
 */
export declare const DevicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Deletes a device.
     * @param {DevicesApiDeleteDeviceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteDevice(requestParameters: DevicesApiDeleteDeviceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Get info for a device.
     * @param {DevicesApiGetDeviceInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceInfo(requestParameters: DevicesApiGetDeviceInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeviceInfoDto>;
    /**
     *
     * @summary Get options for a device.
     * @param {DevicesApiGetDeviceOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeviceOptions(requestParameters: DevicesApiGetDeviceOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeviceOptionsDto>;
    /**
     *
     * @summary Get Devices.
     * @param {DevicesApiGetDevicesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDevices(requestParameters?: DevicesApiGetDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeviceInfoDtoQueryResult>;
    /**
     *
     * @summary Update device options.
     * @param {DevicesApiUpdateDeviceOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateDeviceOptions(requestParameters: DevicesApiUpdateDeviceOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for deleteDevice operation in DevicesApi.
 * @export
 * @interface DevicesApiDeleteDeviceRequest
 */
export interface DevicesApiDeleteDeviceRequest {
    /**
     * Device Id.
     * @type {string}
     * @memberof DevicesApiDeleteDevice
     */
    readonly id: string;
}
/**
 * Request parameters for getDeviceInfo operation in DevicesApi.
 * @export
 * @interface DevicesApiGetDeviceInfoRequest
 */
export interface DevicesApiGetDeviceInfoRequest {
    /**
     * Device Id.
     * @type {string}
     * @memberof DevicesApiGetDeviceInfo
     */
    readonly id: string;
}
/**
 * Request parameters for getDeviceOptions operation in DevicesApi.
 * @export
 * @interface DevicesApiGetDeviceOptionsRequest
 */
export interface DevicesApiGetDeviceOptionsRequest {
    /**
     * Device Id.
     * @type {string}
     * @memberof DevicesApiGetDeviceOptions
     */
    readonly id: string;
}
/**
 * Request parameters for getDevices operation in DevicesApi.
 * @export
 * @interface DevicesApiGetDevicesRequest
 */
export interface DevicesApiGetDevicesRequest {
    /**
     * Gets or sets the user identifier.
     * @type {string}
     * @memberof DevicesApiGetDevices
     */
    readonly userId?: string;
}
/**
 * Request parameters for updateDeviceOptions operation in DevicesApi.
 * @export
 * @interface DevicesApiUpdateDeviceOptionsRequest
 */
export interface DevicesApiUpdateDeviceOptionsRequest {
    /**
     * Device Id.
     * @type {string}
     * @memberof DevicesApiUpdateDeviceOptions
     */
    readonly id: string;
    /**
     * Device Options.
     * @type {DeviceOptionsDto}
     * @memberof DevicesApiUpdateDeviceOptions
     */
    readonly deviceOptionsDto: DeviceOptionsDto;
}
/**
 * DevicesApi - object-oriented interface
 * @export
 * @class DevicesApi
 * @extends {BaseAPI}
 */
export declare class DevicesApi extends BaseAPI {
    /**
     *
     * @summary Deletes a device.
     * @param {DevicesApiDeleteDeviceRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    deleteDevice(requestParameters: DevicesApiDeleteDeviceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Get info for a device.
     * @param {DevicesApiGetDeviceInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    getDeviceInfo(requestParameters: DevicesApiGetDeviceInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceInfoDto, any>>;
    /**
     *
     * @summary Get options for a device.
     * @param {DevicesApiGetDeviceOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    getDeviceOptions(requestParameters: DevicesApiGetDeviceOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceOptionsDto, any>>;
    /**
     *
     * @summary Get Devices.
     * @param {DevicesApiGetDevicesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    getDevices(requestParameters?: DevicesApiGetDevicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceInfoDtoQueryResult, any>>;
    /**
     *
     * @summary Update device options.
     * @param {DevicesApiUpdateDeviceOptionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    updateDeviceOptions(requestParameters: DevicesApiUpdateDeviceOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}