Class UsersApi

UsersApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • UsersApi

Constructors

constructor

Properties

axios basePath configuration

Methods

checkUserInvitation createUser createUserInvitation deleteUser deleteUserInvitation forgotPassword getUser getUserInvitation listUserInvitations listUsers login logout refreshAccessToken register resendUserInvitation resetPassword updateUser

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns UsersApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

checkUserInvitation

createUser

  • Creates a User.

    Summary

    Create a User

    Deprecated

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiCreateUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<User, any>>

createUserInvitation

  • Creates a User invitation. Upon creation, an invitation email is sent to the User’s email address. Once the User registers for an Account, the invitation is deleted.

    Summary

    Create a User Invitation

    Throws

    Memberof

    UsersApi

    Parameters

    Returns Promise<AxiosResponse<UserInvitation, any>>

deleteUser

  • Deletes a User from a specific Account. If this is the User's only Account, the User is permanently deleted. This cannot be undone.

    Summary

    Delete a User

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiDeleteUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<object, any>>

deleteUserInvitation

  • Deletes a User invitation. This cannot be undone.

    Summary

    Delete a User Invitation

    Throws

    Memberof

    UsersApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

forgotPassword

  • Requests a temporary link be sent to the provided email address, allowing the User to reset their password.

    Summary

    Forgot Password

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiForgotPasswordRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

getUser

  • Retrieves the details of an existing User.

    Summary

    Get a User

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiGetUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<User, any>>

getUserInvitation

  • Retrieves the details of an existing User invitation.

    Summary

    Get a User Invitation

    Throws

    Memberof

    UsersApi

    Parameters

    Returns Promise<AxiosResponse<UserInvitation, any>>

listUserInvitations

listUsers

  • Returns a list of Users. The Users are sorted with the most recently created appearing first.

    Summary

    List all Users

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiListUsersRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListUsers200Response, any>>

login

  • Creates a JSON Web Token.

    Summary

    Login

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiLoginRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<LoginDto, any>>

logout

  • Invalidates a User’s refresh token.

    Summary

    Logout

    Throws

    Memberof

    UsersApi

    Parameters

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

refreshAccessToken

  • Generates a new access token with a User's refresh token.

    Summary

    Refresh an Access Token

    Throws

    Memberof

    UsersApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>

register

  • Creates a User and simultaneously creates a partner Account. Note: This endpoint should only be used in the Sandbox environment.

    Summary

    Register

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiRegisterRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RegisterDto, any>>

resendUserInvitation

  • Resends an existing User invitation.

    Summary

    Resend a User Invitation

    Throws

    Memberof

    UsersApi

    Parameters

    Returns Promise<AxiosResponse<UserInvitation, any>>

resetPassword

  • Resets a User's password. Resetting the password will also invalidate the User's refresh token.

    Summary

    Reset Password

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiResetPasswordRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

updateUser

  • Updates a User by setting the values of the provided parameters. Any parameters not provided remain unchanged.

    Summary

    Update a User

    Throws

    Memberof

    UsersApi

    Parameters

    • requestParameters: UsersApiUpdateUserRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<User, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc