@jellyfin/sdk/lib/generated-client/api/quick-connect-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 { QuickConnectResult } from '../models';
/**
 * QuickConnectApi - axios parameter creator
 * @export
 */
export declare const QuickConnectApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Authorizes a pending quick connect request.
     * @param {string} code Quick connect code to authorize.
     * @param {string} [userId] The user the authorize. Access to the requested user is required.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeQuickConnect: (code: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the current quick connect state.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectEnabled: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Attempts to retrieve authentication information.
     * @param {string} secret Secret previously returned from the Initiate endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectState: (secret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Initiate a new quick connect request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    initiateQuickConnect: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * QuickConnectApi - functional programming interface
 * @export
 */
export declare const QuickConnectApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Authorizes a pending quick connect request.
     * @param {string} code Quick connect code to authorize.
     * @param {string} [userId] The user the authorize. Access to the requested user is required.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeQuickConnect(code: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Gets the current quick connect state.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectEnabled(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Attempts to retrieve authentication information.
     * @param {string} secret Secret previously returned from the Initiate endpoint.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectState(secret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>;
    /**
     *
     * @summary Initiate a new quick connect request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    initiateQuickConnect(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>;
};
/**
 * QuickConnectApi - factory interface
 * @export
 */
export declare const QuickConnectApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Authorizes a pending quick connect request.
     * @param {QuickConnectApiAuthorizeQuickConnectRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeQuickConnect(requestParameters: QuickConnectApiAuthorizeQuickConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
    /**
     *
     * @summary Gets the current quick connect state.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectEnabled(options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
    /**
     *
     * @summary Attempts to retrieve authentication information.
     * @param {QuickConnectApiGetQuickConnectStateRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQuickConnectState(requestParameters: QuickConnectApiGetQuickConnectStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
    /**
     *
     * @summary Initiate a new quick connect request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    initiateQuickConnect(options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
};
/**
 * Request parameters for authorizeQuickConnect operation in QuickConnectApi.
 * @export
 * @interface QuickConnectApiAuthorizeQuickConnectRequest
 */
export interface QuickConnectApiAuthorizeQuickConnectRequest {
    /**
     * Quick connect code to authorize.
     * @type {string}
     * @memberof QuickConnectApiAuthorizeQuickConnect
     */
    readonly code: string;
    /**
     * The user the authorize. Access to the requested user is required.
     * @type {string}
     * @memberof QuickConnectApiAuthorizeQuickConnect
     */
    readonly userId?: string;
}
/**
 * Request parameters for getQuickConnectState operation in QuickConnectApi.
 * @export
 * @interface QuickConnectApiGetQuickConnectStateRequest
 */
export interface QuickConnectApiGetQuickConnectStateRequest {
    /**
     * Secret previously returned from the Initiate endpoint.
     * @type {string}
     * @memberof QuickConnectApiGetQuickConnectState
     */
    readonly secret: string;
}
/**
 * QuickConnectApi - object-oriented interface
 * @export
 * @class QuickConnectApi
 * @extends {BaseAPI}
 */
export declare class QuickConnectApi extends BaseAPI {
    /**
     *
     * @summary Authorizes a pending quick connect request.
     * @param {QuickConnectApiAuthorizeQuickConnectRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof QuickConnectApi
     */
    authorizeQuickConnect(requestParameters: QuickConnectApiAuthorizeQuickConnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Gets the current quick connect state.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof QuickConnectApi
     */
    getQuickConnectEnabled(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Attempts to retrieve authentication information.
     * @param {QuickConnectApiGetQuickConnectStateRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof QuickConnectApi
     */
    getQuickConnectState(requestParameters: QuickConnectApiGetQuickConnectStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuickConnectResult, any>>;
    /**
     *
     * @summary Initiate a new quick connect request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof QuickConnectApi
     */
    initiateQuickConnect(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuickConnectResult, any>>;
}