@jellyfin/sdk 0.12.0 → 1.0.0

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

@@ -0,0 +1,517 @@
+/**
+ * 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 { AuthenticateUserByName } from '../models';
+import type { AuthenticationInfoQueryResult } from '../models';
+import type { AuthenticationResult } from '../models';
+import type { ForgotPasswordDto } from '../models';
+import type { ForgotPasswordPinDto } from '../models';
+import type { ForgotPasswordResult } from '../models';
+import type { NameIdPair } from '../models';
+import type { PinRedeemResult } from '../models';
+import type { QuickConnectDto } from '../models';
+import type { QuickConnectResult } from '../models';
+/**
+ * AuthenticationApi - axios parameter creator
+ */
+export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Authenticates a user by name.
+     * @param {AuthenticateUserByName} authenticateUserByName The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Authenticates a user with quick connect.
+     * @param {QuickConnectDto} quickConnectDto The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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 Create a new api key.
+     * @param {string} app Name of the app using the authentication key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createKey: (app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Initiates the forgot password process for a local user.
+     * @param {ForgotPasswordDto} forgotPasswordDto The forgot password request containing the entered username.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Redeems a forgot password pin.
+     * @param {ForgotPasswordPinDto} forgotPasswordPinDto The forgot password pin request containing the entered pin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all auth providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuthProviders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all keys.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all password reset providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPasswordResetProviders: (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>;
+    /**
+     *
+     * @summary Remove an api key.
+     * @param {string} key The access token to delete.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeKey: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AuthenticationApi - functional programming interface
+ */
+export declare const AuthenticationApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Authenticates a user by name.
+     * @param {AuthenticateUserByName} authenticateUserByName The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateUserByName(authenticateUserByName: AuthenticateUserByName, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>;
+    /**
+     *
+     * @summary Authenticates a user with quick connect.
+     * @param {QuickConnectDto} quickConnectDto The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateWithQuickConnect(quickConnectDto: QuickConnectDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>;
+    /**
+     *
+     * @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 Create a new api key.
+     * @param {string} app Name of the app using the authentication key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createKey(app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Initiates the forgot password process for a local user.
+     * @param {ForgotPasswordDto} forgotPasswordDto The forgot password request containing the entered username.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPassword(forgotPasswordDto: ForgotPasswordDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForgotPasswordResult>>;
+    /**
+     *
+     * @summary Redeems a forgot password pin.
+     * @param {ForgotPasswordPinDto} forgotPasswordPinDto The forgot password pin request containing the entered pin.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPasswordPin(forgotPasswordPinDto: ForgotPasswordPinDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinRedeemResult>>;
+    /**
+     *
+     * @summary Get all auth providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuthProviders(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NameIdPair>>>;
+    /**
+     *
+     * @summary Get all keys.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationInfoQueryResult>>;
+    /**
+     *
+     * @summary Get all password reset providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPasswordResetProviders(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NameIdPair>>>;
+    /**
+     *
+     * @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>>;
+    /**
+     *
+     * @summary Remove an api key.
+     * @param {string} key The access token to delete.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeKey(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * AuthenticationApi - factory interface
+ */
+export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Authenticates a user by name.
+     * @param {AuthenticationApiAuthenticateUserByNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateUserByName(requestParameters: AuthenticationApiAuthenticateUserByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResult>;
+    /**
+     *
+     * @summary Authenticates a user with quick connect.
+     * @param {AuthenticationApiAuthenticateWithQuickConnectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateWithQuickConnect(requestParameters: AuthenticationApiAuthenticateWithQuickConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResult>;
+    /**
+     *
+     * @summary Authorizes a pending quick connect request.
+     * @param {AuthenticationApiAuthorizeQuickConnectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeQuickConnect(requestParameters: AuthenticationApiAuthorizeQuickConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
+    /**
+     *
+     * @summary Create a new api key.
+     * @param {AuthenticationApiCreateKeyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createKey(requestParameters: AuthenticationApiCreateKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Initiates the forgot password process for a local user.
+     * @param {AuthenticationApiForgotPasswordRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPassword(requestParameters: AuthenticationApiForgotPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForgotPasswordResult>;
+    /**
+     *
+     * @summary Redeems a forgot password pin.
+     * @param {AuthenticationApiForgotPasswordPinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPasswordPin(requestParameters: AuthenticationApiForgotPasswordPinRequest, options?: RawAxiosRequestConfig): AxiosPromise<PinRedeemResult>;
+    /**
+     *
+     * @summary Get all auth providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuthProviders(options?: RawAxiosRequestConfig): AxiosPromise<Array<NameIdPair>>;
+    /**
+     *
+     * @summary Get all keys.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getKeys(options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationInfoQueryResult>;
+    /**
+     *
+     * @summary Get all password reset providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPasswordResetProviders(options?: RawAxiosRequestConfig): AxiosPromise<Array<NameIdPair>>;
+    /**
+     *
+     * @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 {AuthenticationApiGetQuickConnectStateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuickConnectState(requestParameters: AuthenticationApiGetQuickConnectStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
+    /**
+     *
+     * @summary Initiate a new quick connect request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    initiateQuickConnect(options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
+    /**
+     *
+     * @summary Remove an api key.
+     * @param {AuthenticationApiRevokeKeyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeKey(requestParameters: AuthenticationApiRevokeKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for authenticateUserByName operation in AuthenticationApi.
+ */
+export interface AuthenticationApiAuthenticateUserByNameRequest {
+    /**
+     * The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
+     */
+    readonly authenticateUserByName: AuthenticateUserByName;
+}
+/**
+ * Request parameters for authenticateWithQuickConnect operation in AuthenticationApi.
+ */
+export interface AuthenticationApiAuthenticateWithQuickConnectRequest {
+    /**
+     * The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
+     */
+    readonly quickConnectDto: QuickConnectDto;
+}
+/**
+ * Request parameters for authorizeQuickConnect operation in AuthenticationApi.
+ */
+export interface AuthenticationApiAuthorizeQuickConnectRequest {
+    /**
+     * Quick connect code to authorize.
+     */
+    readonly code: string;
+    /**
+     * The user the authorize. Access to the requested user is required.
+     */
+    readonly userId?: string;
+}
+/**
+ * Request parameters for createKey operation in AuthenticationApi.
+ */
+export interface AuthenticationApiCreateKeyRequest {
+    /**
+     * Name of the app using the authentication key.
+     */
+    readonly app: string;
+}
+/**
+ * Request parameters for forgotPassword operation in AuthenticationApi.
+ */
+export interface AuthenticationApiForgotPasswordRequest {
+    /**
+     * The forgot password request containing the entered username.
+     */
+    readonly forgotPasswordDto: ForgotPasswordDto;
+}
+/**
+ * Request parameters for forgotPasswordPin operation in AuthenticationApi.
+ */
+export interface AuthenticationApiForgotPasswordPinRequest {
+    /**
+     * The forgot password pin request containing the entered pin.
+     */
+    readonly forgotPasswordPinDto: ForgotPasswordPinDto;
+}
+/**
+ * Request parameters for getQuickConnectState operation in AuthenticationApi.
+ */
+export interface AuthenticationApiGetQuickConnectStateRequest {
+    /**
+     * Secret previously returned from the Initiate endpoint.
+     */
+    readonly secret: string;
+}
+/**
+ * Request parameters for revokeKey operation in AuthenticationApi.
+ */
+export interface AuthenticationApiRevokeKeyRequest {
+    /**
+     * The access token to delete.
+     */
+    readonly key: string;
+}
+/**
+ * AuthenticationApi - object-oriented interface
+ */
+export declare class AuthenticationApi extends BaseAPI {
+    /**
+     *
+     * @summary Authenticates a user by name.
+     * @param {AuthenticationApiAuthenticateUserByNameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateUserByName(requestParameters: AuthenticationApiAuthenticateUserByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResult, any, {}>>;
+    /**
+     *
+     * @summary Authenticates a user with quick connect.
+     * @param {AuthenticationApiAuthenticateWithQuickConnectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authenticateWithQuickConnect(requestParameters: AuthenticationApiAuthenticateWithQuickConnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResult, any, {}>>;
+    /**
+     *
+     * @summary Authorizes a pending quick connect request.
+     * @param {AuthenticationApiAuthorizeQuickConnectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    authorizeQuickConnect(requestParameters: AuthenticationApiAuthorizeQuickConnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any, {}>>;
+    /**
+     *
+     * @summary Create a new api key.
+     * @param {AuthenticationApiCreateKeyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createKey(requestParameters: AuthenticationApiCreateKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Initiates the forgot password process for a local user.
+     * @param {AuthenticationApiForgotPasswordRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPassword(requestParameters: AuthenticationApiForgotPasswordRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForgotPasswordResult, any, {}>>;
+    /**
+     *
+     * @summary Redeems a forgot password pin.
+     * @param {AuthenticationApiForgotPasswordPinRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    forgotPasswordPin(requestParameters: AuthenticationApiForgotPasswordPinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PinRedeemResult, any, {}>>;
+    /**
+     *
+     * @summary Get all auth providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuthProviders(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NameIdPair[], any, {}>>;
+    /**
+     *
+     * @summary Get all keys.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationInfoQueryResult, any, {}>>;
+    /**
+     *
+     * @summary Get all password reset providers.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPasswordResetProviders(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NameIdPair[], any, {}>>;
+    /**
+     *
+     * @summary Gets the current quick connect state.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuickConnectEnabled(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any, {}>>;
+    /**
+     *
+     * @summary Attempts to retrieve authentication information.
+     * @param {AuthenticationApiGetQuickConnectStateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getQuickConnectState(requestParameters: AuthenticationApiGetQuickConnectStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuickConnectResult, any, {}>>;
+    /**
+     *
+     * @summary Initiate a new quick connect request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    initiateQuickConnect(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuickConnectResult, any, {}>>;
+    /**
+     *
+     * @summary Remove an api key.
+     * @param {AuthenticationApiRevokeKeyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeKey(requestParameters: AuthenticationApiRevokeKeyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}