Function UserApiFp

UserApi - functional programming interface

Export

  • UserApiFp(
        configuration?: Configuration,
    ): {
        authenticateUserByName(
            authenticateUserByName: AuthenticateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >;
        authenticateWithQuickConnect(
            quickConnectDto: QuickConnectDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >;
        createUserByName(
            createUserByName: CreateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        deleteUser(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        forgotPassword(
            forgotPasswordDto: ForgotPasswordDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ForgotPasswordResult>,
        >;
        forgotPasswordPin(
            forgotPasswordPinDto: ForgotPasswordPinDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PinRedeemResult>,
        >;
        getCurrentUser(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        getPublicUsers(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >;
        getUserById(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        getUsers(
            isHidden?: boolean,
            isDisabled?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >;
        updateUser(
            userDto: UserDto,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserConfiguration(
            userConfiguration: UserConfiguration,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserPassword(
            updateUserPassword: UpdateUserPassword,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserPolicy(
            userId: string,
            userPolicy: UserPolicy,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
    }

  • Parameters

    Returns {
        authenticateUserByName(
            authenticateUserByName: AuthenticateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >;
        authenticateWithQuickConnect(
            quickConnectDto: QuickConnectDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >;
        createUserByName(
            createUserByName: CreateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        deleteUser(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        forgotPassword(
            forgotPasswordDto: ForgotPasswordDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ForgotPasswordResult>,
        >;
        forgotPasswordPin(
            forgotPasswordPinDto: ForgotPasswordPinDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PinRedeemResult>,
        >;
        getCurrentUser(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        getPublicUsers(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >;
        getUserById(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >;
        getUsers(
            isHidden?: boolean,
            isDisabled?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >;
        updateUser(
            userDto: UserDto,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserConfiguration(
            userConfiguration: UserConfiguration,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserPassword(
            updateUserPassword: UpdateUserPassword,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateUserPolicy(
            userId: string,
            userPolicy: UserPolicy,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
    }

    • authenticateUserByName:function
      • authenticateUserByName(
            authenticateUserByName: AuthenticateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >

      • Parameters

        • authenticateUserByName: AuthenticateUserByName

          The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >

        Throws

    • authenticateWithQuickConnect:function
      • authenticateWithQuickConnect(
            quickConnectDto: QuickConnectDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >

      • Parameters

        • quickConnectDto: QuickConnectDto

          The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AuthenticationResult>,
        >

        Throws

    • createUserByName:function
      • createUserByName(
            createUserByName: CreateUserByName,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >

      • Parameters

        • createUserByName: CreateUserByName

          The create user by name request body.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>

        Throws

    • deleteUser:function
      • deleteUser(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • userId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • forgotPassword:function
      • forgotPassword(
            forgotPasswordDto: ForgotPasswordDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ForgotPasswordResult>,
        >

      • Parameters

        • forgotPasswordDto: ForgotPasswordDto

          The forgot password request containing the entered username.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ForgotPasswordResult>,
        >

        Throws

    • forgotPasswordPin:function
      • forgotPasswordPin(
            forgotPasswordPinDto: ForgotPasswordPinDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PinRedeemResult>,
        >

      • Parameters

        • forgotPasswordPinDto: ForgotPasswordPinDto

          The forgot password pin request containing the entered pin.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PinRedeemResult>,
        >

        Throws

    • getCurrentUser:function
      • getCurrentUser(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>

        Throws

    • getPublicUsers:function
      • getPublicUsers(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>

        Throws

    • getUserById:function
      • getUserById(
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>,
        >

      • Parameters

        • userId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>

        Throws

    • getUsers:function
      • getUsers(
            isHidden?: boolean,
            isDisabled?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>,
        >

      • Parameters

        • OptionalisHidden: boolean

          Optional filter by IsHidden=true or false.

        • OptionalisDisabled: boolean

          Optional filter by IsDisabled=true or false.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>

        Throws

    • updateUser:function
      • updateUser(
            userDto: UserDto,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • userDto: UserDto

          The updated user model.

        • OptionaluserId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • updateUserConfiguration:function
      • updateUserConfiguration(
            userConfiguration: UserConfiguration,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • userConfiguration: UserConfiguration

          The new user configuration.

        • OptionaluserId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • updateUserPassword:function
      • updateUserPassword(
            updateUserPassword: UpdateUserPassword,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • updateUserPassword: UpdateUserPassword

          The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.

        • OptionaluserId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • updateUserPolicy:function
      • updateUserPolicy(
            userId: string,
            userPolicy: UserPolicy,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • userId: string

          The user id.

        • userPolicy: UserPolicy

          The new user policy.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

Settings

Member Visibility