Function UsersApiFp

Returns {
    checkUserInvitation(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<UserInvitationCheck>)>;
    createUser(tilled_account, UserCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<User>)>;
    createUserInvitation(tilled_account, UserInvitationCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>;
    deleteUser(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
    deleteUserInvitation(id, tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    forgotPassword(ForgotPasswordParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getUser(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<User>)>;
    getUserInvitation(id, tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>;
    listUserInvitations(tilled_account, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListUserInvitations200Response>)>;
    listUsers(tilled_account, offset?, limit?, include_connected_accounts?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListUsers200Response>)>;
    login(LoginParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<LoginDto>)>;
    logout(options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    refreshAccessToken(AccessTokenRefreshParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    register(RegisterParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<RegisterDto>)>;
    resendUserInvitation(id, tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>;
    resetPassword(UserResetPasswordParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    updateUser(tilled_account, id, UserUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<User>)>;
}

• checkUserInvitation:function

  • checkUserInvitation(id, options?): Promise<((axios?, basePath?) => AxiosPromise<UserInvitationCheck>)>

  • Checks for an existing User invitation.

    Summary

    Check a User Invitation

    Throws

    Parameters

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<UserInvitationCheck>)>

• createUser:function

  • createUser(tilled_account, UserCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<User>)>

  • Creates a User.

    Summary

    Create a User

    Deprecated

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • UserCreateParams: UserCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<User>)>

• createUserInvitation:function

  • createUserInvitation(tilled_account, UserInvitationCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

  • 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

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • UserInvitationCreateParams: UserInvitationCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

• deleteUser:function

  • deleteUser(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<object>)>

  • 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

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<object>)>

• deleteUserInvitation:function

  • deleteUserInvitation(id, tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Deletes a User invitation. This cannot be undone.

    Summary

    Delete a User Invitation

    Throws

    Parameters

    • id: string

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

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

• forgotPassword:function

  • forgotPassword(ForgotPasswordParams, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

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

    Summary

    Forgot Password

    Throws

    Parameters

    • ForgotPasswordParams: ForgotPasswordParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

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

• getUser:function

  • getUser(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<User>)>

  • Retrieves the details of an existing User.

    Summary

    Get a User

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<User>)>

• getUserInvitation:function

  • getUserInvitation(id, tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

  • Retrieves the details of an existing User invitation.

    Summary

    Get a User Invitation

    Throws

    Parameters

    • id: string

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

• listUserInvitations:function

  • listUserInvitations(tilled_account, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListUserInvitations200Response>)>

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

    Summary

    List all User Invitations

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListUserInvitations200Response>)>

• listUsers:function

  • listUsers(tilled_account, offset?, limit?, include_connected_accounts?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListUsers200Response>)>

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

    Summary

    List all Users

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional include_connected_accounts: boolean

      Whether or not to include the results from any connected accounts.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListUsers200Response>)>

• login:function

  • login(LoginParams, options?): Promise<((axios?, basePath?) => AxiosPromise<LoginDto>)>

  • Creates a JSON Web Token.

    Summary

    Login

    Throws

    Parameters

    • LoginParams: LoginParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<LoginDto>)>

• logout:function

  • logout(options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Invalidates a User’s refresh token.

    Summary

    Logout

    Throws

    Parameters

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

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

• refreshAccessToken:function

  • refreshAccessToken(AccessTokenRefreshParams, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

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

    Summary

    Refresh an Access Token

    Throws

    Parameters

    • AccessTokenRefreshParams: AccessTokenRefreshParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

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

• register:function

  • register(RegisterParams, options?): Promise<((axios?, basePath?) => AxiosPromise<RegisterDto>)>

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

    Summary

    Register

    Throws

    Parameters

    • RegisterParams: RegisterParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RegisterDto>)>

• resendUserInvitation:function

  • resendUserInvitation(id, tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

  • Resends an existing User invitation.

    Summary

    Resend a User Invitation

    Throws

    Parameters

    • id: string

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<UserInvitation>)>

• resetPassword:function

  • resetPassword(UserResetPasswordParams, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

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

    Summary

    Reset Password

    Throws

    Parameters

    • UserResetPasswordParams: UserResetPasswordParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

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

• updateUser:function

  • updateUser(tilled_account, id, UserUpdateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<User>)>

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

    Summary

    Update a User

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • UserUpdateParams: UserUpdateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<User>)>