Function UsersApiAxiosParamCreator

Returns {
    checkUserInvitation: ((id, options?) => Promise<RequestArgs>);
    createUser: ((tilled_account, UserCreateParams, options?) => Promise<RequestArgs>);
    createUserInvitation: ((tilled_account, UserInvitationCreateParams, options?) => Promise<RequestArgs>);
    deleteUser: ((tilled_account, id, options?) => Promise<RequestArgs>);
    deleteUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>);
    forgotPassword: ((ForgotPasswordParams, options?) => Promise<RequestArgs>);
    getUser: ((tilled_account, id, options?) => Promise<RequestArgs>);
    getUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>);
    listUserInvitations: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>);
    listUsers: ((tilled_account, offset?, limit?, include_connected_accounts?, options?) => Promise<RequestArgs>);
    login: ((LoginParams, options?) => Promise<RequestArgs>);
    logout: ((options?) => Promise<RequestArgs>);
    refreshAccessToken: ((AccessTokenRefreshParams, options?) => Promise<RequestArgs>);
    register: ((RegisterParams, options?) => Promise<RequestArgs>);
    resendUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>);
    resetPassword: ((UserResetPasswordParams, options?) => Promise<RequestArgs>);
    updateUser: ((tilled_account, id, UserUpdateParams, options?) => Promise<RequestArgs>);
}

• checkUserInvitation: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• createUser: ((tilled_account, UserCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, UserCreateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• createUserInvitation: ((tilled_account, UserInvitationCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, UserInvitationCreateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• deleteUser: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• deleteUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>)

  • • (id, tilled_account, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• forgotPassword: ((ForgotPasswordParams, options?) => Promise<RequestArgs>)

  • • (ForgotPasswordParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getUser: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>)

  • • (id, tilled_account, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listUserInvitations: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, offset?, limit?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listUsers: ((tilled_account, offset?, limit?, include_connected_accounts?, options?) => Promise<RequestArgs>)

  • • (tilled_account, offset?, limit?, include_connected_accounts?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• login: ((LoginParams, options?) => Promise<RequestArgs>)

  • • (LoginParams, options?): Promise<RequestArgs>

    • Creates a JSON Web Token.

      Summary

      Login

      Throws

      Parameters

      • LoginParams: LoginParams

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• logout: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Invalidates a User’s refresh token.

      Summary

      Logout

      Throws

      Parameters

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• refreshAccessToken: ((AccessTokenRefreshParams, options?) => Promise<RequestArgs>)

  • • (AccessTokenRefreshParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• register: ((RegisterParams, options?) => Promise<RequestArgs>)

  • • (RegisterParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• resendUserInvitation: ((id, tilled_account, options?) => Promise<RequestArgs>)

  • • (id, tilled_account, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• resetPassword: ((UserResetPasswordParams, options?) => Promise<RequestArgs>)

  • • (UserResetPasswordParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• updateUser: ((tilled_account, id, UserUpdateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, UserUpdateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>