Methods
(async, inner) acceptInvite(inviteId) → {Promise.<void>}
- Description:
- Accepts an invitation to join a multi-user account.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
inviteId |
number | The ID of the invitation to accept. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the invite is accepted.
- Type
- Promise.<void>
(async, inner) createAccount(params) → {Promise.<MultiUserAccountResponse>}
- Description:
- Creates a new multi-user account with optional invites and seat count.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
CreateAccountParams | The parameters for creating the account. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the created account.
- Type
- Promise.<MultiUserAccountResponse>
(async, inner) createInvites(params) → {Promise.<MultiUserAccountResponse>}
- Description:
- Creates invitations for an existing multi-user account.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
CreateInvitesParams | The parameters for creating invites. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the updated account.
- Type
- Promise.<MultiUserAccountResponse>
(async, inner) fetchUsersMultiAccountDetails(userId) → {Promise.<UsersMultiAccountResponse>}
- Description:
- Fetches multi-user account details for a specific user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
number | The ID of the user to fetch account details for. |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the account details.
- Type
- Promise.<UsersMultiAccountResponse>
(async, inner) removeUserFromActiveMultiUserAccount(userId) → {Promise.<(void|MultiUserAccountResponse)>}
- Description:
- Removes a member from a multi-user account. authorized user must be the primary account owner, or the user passed
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
number | Id of the user to remove |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- Updated MultiUserAccountResponse if account owner, void if active user
- Type
- Promise.<(void|MultiUserAccountResponse)>
(async, inner) rescindInvite(inviteId) → {Promise.<void>}
- Description:
- Rescinds/cancels an invitation to join a multi-user account.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
inviteId |
number | The ID of the invitation to rescind. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the invite is rescinded.
- Type
- Promise.<void>