@jellyfin/sdk 0.13.0 → 1.0.0

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

@@ -11,39 +11,15 @@
 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 { AuthenticationResult } from '../models';
 import type { CreateUserByName } from '../models';
-import type { ForgotPasswordDto } from '../models';
-import type { ForgotPasswordPinDto } from '../models';
-import type { ForgotPasswordResult } from '../models';
-import type { PinRedeemResult } from '../models';
-import type { QuickConnectDto } from '../models';
 import type { UpdateUserPassword } from '../models';
 import type { UserConfiguration } from '../models';
 import type { UserDto } from '../models';
 import type { UserPolicy } from '../models';
 /**
  * UserApi - axios parameter creator
- * @export
  */
 export declare const UserApiAxiosParamCreator: (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 Creates a user.
@@ -60,22 +36,6 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     deleteUser: (userId: 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 Gets the user based on auth token.
@@ -146,25 +106,8 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
 };
 /**
  * UserApi - functional programming interface
- * @export
  */
 export declare const UserApiFp: (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 Creates a user.
@@ -181,22 +124,6 @@ export declare const UserApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteUser(userId: 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 Gets the user based on auth token.
@@ -267,25 +194,8 @@ export declare const UserApiFp: (configuration?: Configuration) => {
 };
 /**
  * UserApi - factory interface
- * @export
  */
 export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Authenticates a user by name.
-     * @param {UserApiAuthenticateUserByNameRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    authenticateUserByName(requestParameters: UserApiAuthenticateUserByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResult>;
-    /**
-     *
-     * @summary Authenticates a user with quick connect.
-     * @param {UserApiAuthenticateWithQuickConnectRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    authenticateWithQuickConnect(requestParameters: UserApiAuthenticateWithQuickConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticationResult>;
     /**
      *
      * @summary Creates a user.
@@ -302,22 +212,6 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteUser(requestParameters: UserApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     *
-     * @summary Initiates the forgot password process for a local user.
-     * @param {UserApiForgotPasswordRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    forgotPassword(requestParameters: UserApiForgotPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForgotPasswordResult>;
-    /**
-     *
-     * @summary Redeems a forgot password pin.
-     * @param {UserApiForgotPasswordPinRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    forgotPasswordPin(requestParameters: UserApiForgotPasswordPinRequest, options?: RawAxiosRequestConfig): AxiosPromise<PinRedeemResult>;
     /**
      *
      * @summary Gets the user based on auth token.
@@ -381,224 +275,108 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
      */
     updateUserPolicy(requestParameters: UserApiUpdateUserPolicyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 };
-/**
- * Request parameters for authenticateUserByName operation in UserApi.
- * @export
- * @interface UserApiAuthenticateUserByNameRequest
- */
-export interface UserApiAuthenticateUserByNameRequest {
-    /**
-     * The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
-     * @type {AuthenticateUserByName}
-     * @memberof UserApiAuthenticateUserByName
-     */
-    readonly authenticateUserByName: AuthenticateUserByName;
-}
-/**
- * Request parameters for authenticateWithQuickConnect operation in UserApi.
- * @export
- * @interface UserApiAuthenticateWithQuickConnectRequest
- */
-export interface UserApiAuthenticateWithQuickConnectRequest {
-    /**
-     * The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
-     * @type {QuickConnectDto}
-     * @memberof UserApiAuthenticateWithQuickConnect
-     */
-    readonly quickConnectDto: QuickConnectDto;
-}
 /**
  * Request parameters for createUserByName operation in UserApi.
- * @export
- * @interface UserApiCreateUserByNameRequest
  */
 export interface UserApiCreateUserByNameRequest {
     /**
      * The create user by name request body.
-     * @type {CreateUserByName}
-     * @memberof UserApiCreateUserByName
      */
     readonly createUserByName: CreateUserByName;
 }
 /**
  * Request parameters for deleteUser operation in UserApi.
- * @export
- * @interface UserApiDeleteUserRequest
  */
 export interface UserApiDeleteUserRequest {
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiDeleteUser
      */
     readonly userId: string;
 }
-/**
- * Request parameters for forgotPassword operation in UserApi.
- * @export
- * @interface UserApiForgotPasswordRequest
- */
-export interface UserApiForgotPasswordRequest {
-    /**
-     * The forgot password request containing the entered username.
-     * @type {ForgotPasswordDto}
-     * @memberof UserApiForgotPassword
-     */
-    readonly forgotPasswordDto: ForgotPasswordDto;
-}
-/**
- * Request parameters for forgotPasswordPin operation in UserApi.
- * @export
- * @interface UserApiForgotPasswordPinRequest
- */
-export interface UserApiForgotPasswordPinRequest {
-    /**
-     * The forgot password pin request containing the entered pin.
-     * @type {ForgotPasswordPinDto}
-     * @memberof UserApiForgotPasswordPin
-     */
-    readonly forgotPasswordPinDto: ForgotPasswordPinDto;
-}
 /**
  * Request parameters for getUserById operation in UserApi.
- * @export
- * @interface UserApiGetUserByIdRequest
  */
 export interface UserApiGetUserByIdRequest {
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiGetUserById
      */
     readonly userId: string;
 }
 /**
  * Request parameters for getUsers operation in UserApi.
- * @export
- * @interface UserApiGetUsersRequest
  */
 export interface UserApiGetUsersRequest {
     /**
      * Optional filter by IsHidden&#x3D;true or false.
-     * @type {boolean}
-     * @memberof UserApiGetUsers
      */
     readonly isHidden?: boolean;
     /**
      * Optional filter by IsDisabled&#x3D;true or false.
-     * @type {boolean}
-     * @memberof UserApiGetUsers
      */
     readonly isDisabled?: boolean;
 }
 /**
  * Request parameters for updateUser operation in UserApi.
- * @export
- * @interface UserApiUpdateUserRequest
  */
 export interface UserApiUpdateUserRequest {
     /**
      * The updated user model.
-     * @type {UserDto}
-     * @memberof UserApiUpdateUser
      */
     readonly userDto: UserDto;
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiUpdateUser
      */
     readonly userId?: string;
 }
 /**
  * Request parameters for updateUserConfiguration operation in UserApi.
- * @export
- * @interface UserApiUpdateUserConfigurationRequest
  */
 export interface UserApiUpdateUserConfigurationRequest {
     /**
      * The new user configuration.
-     * @type {UserConfiguration}
-     * @memberof UserApiUpdateUserConfiguration
      */
     readonly userConfiguration: UserConfiguration;
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiUpdateUserConfiguration
      */
     readonly userId?: string;
 }
 /**
  * Request parameters for updateUserPassword operation in UserApi.
- * @export
- * @interface UserApiUpdateUserPasswordRequest
  */
 export interface UserApiUpdateUserPasswordRequest {
     /**
      * The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.
-     * @type {UpdateUserPassword}
-     * @memberof UserApiUpdateUserPassword
      */
     readonly updateUserPassword: UpdateUserPassword;
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiUpdateUserPassword
      */
     readonly userId?: string;
 }
 /**
  * Request parameters for updateUserPolicy operation in UserApi.
- * @export
- * @interface UserApiUpdateUserPolicyRequest
  */
 export interface UserApiUpdateUserPolicyRequest {
     /**
      * The user id.
-     * @type {string}
-     * @memberof UserApiUpdateUserPolicy
      */
     readonly userId: string;
     /**
      * The new user policy.
-     * @type {UserPolicy}
-     * @memberof UserApiUpdateUserPolicy
      */
     readonly userPolicy: UserPolicy;
 }
 /**
  * UserApi - object-oriented interface
- * @export
- * @class UserApi
- * @extends {BaseAPI}
  */
 export declare class UserApi extends BaseAPI {
-    /**
-     *
-     * @summary Authenticates a user by name.
-     * @param {UserApiAuthenticateUserByNameRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    authenticateUserByName(requestParameters: UserApiAuthenticateUserByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResult, any, {}>>;
-    /**
-     *
-     * @summary Authenticates a user with quick connect.
-     * @param {UserApiAuthenticateWithQuickConnectRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    authenticateWithQuickConnect(requestParameters: UserApiAuthenticateWithQuickConnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationResult, any, {}>>;
     /**
      *
      * @summary Creates a user.
      * @param {UserApiCreateUserByNameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     createUserByName(requestParameters: UserApiCreateUserByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto, any, {}>>;
     /**
@@ -607,33 +385,13 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiDeleteUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     deleteUser(requestParameters: UserApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     *
-     * @summary Initiates the forgot password process for a local user.
-     * @param {UserApiForgotPasswordRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    forgotPassword(requestParameters: UserApiForgotPasswordRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ForgotPasswordResult, any, {}>>;
-    /**
-     *
-     * @summary Redeems a forgot password pin.
-     * @param {UserApiForgotPasswordPinRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UserApi
-     */
-    forgotPasswordPin(requestParameters: UserApiForgotPasswordPinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PinRedeemResult, any, {}>>;
     /**
      *
      * @summary Gets the user based on auth token.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     getCurrentUser(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto, any, {}>>;
     /**
@@ -641,7 +399,6 @@ export declare class UserApi extends BaseAPI {
      * @summary Gets a list of publicly visible users for display on a login screen.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     getPublicUsers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto[], any, {}>>;
     /**
@@ -650,7 +407,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiGetUserByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     getUserById(requestParameters: UserApiGetUserByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto, any, {}>>;
     /**
@@ -659,7 +415,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiGetUsersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     getUsers(requestParameters?: UserApiGetUsersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto[], any, {}>>;
     /**
@@ -668,7 +423,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiUpdateUserRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
@@ -677,7 +431,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiUpdateUserConfigurationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     updateUserConfiguration(requestParameters: UserApiUpdateUserConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
@@ -686,7 +439,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiUpdateUserPasswordRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     updateUserPassword(requestParameters: UserApiUpdateUserPasswordRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
@@ -695,7 +447,6 @@ export declare class UserApi extends BaseAPI {
      * @param {UserApiUpdateUserPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof UserApi
      */
     updateUserPolicy(requestParameters: UserApiUpdateUserPolicyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }