api.md

Accounts

Types:

• Account
• AccountDeleteResponse

Methods:

• client.accounts.create({ ...params }) -> Account
• client.accounts.update({ ...params }) -> Account
• client.accounts.list({ ...params }) -> AccountsV4PagePaginationArray
• client.accounts.delete({ ...params }) -> AccountDeleteResponse | null
• client.accounts.get({ ...params }) -> Account

Members

Types:

• Status
• MemberDeleteResponse

Methods:

• client.accounts.members.create({ ...params }) -> Member
• client.accounts.members.update(memberId, { ...params }) -> Member
• client.accounts.members.list({ ...params }) -> MembersV4PagePaginationArray
• client.accounts.members.delete(memberId, { ...params }) -> MemberDeleteResponse | null
• client.accounts.members.get(memberId, { ...params }) -> Member

Roles

Methods:

• client.accounts.roles.list({ ...params }) -> RolesV4PagePaginationArray
• client.accounts.roles.get(roleId, { ...params }) -> Role

Subscriptions

Types:

• SubscriptionDeleteResponse

Methods:

• client.accounts.subscriptions.create({ ...params }) -> Subscription
• client.accounts.subscriptions.update(subscriptionIdentifier, { ...params }) -> Subscription
• client.accounts.subscriptions.delete(subscriptionIdentifier, { ...params }) -> SubscriptionDeleteResponse
• client.accounts.subscriptions.get({ ...params }) -> SubscriptionsSinglePage

Tokens

Types:

• TokenCreateResponse
• TokenDeleteResponse
• TokenVerifyResponse

Methods:

• client.accounts.tokens.create({ ...params }) -> TokenCreateResponse
• client.accounts.tokens.update(tokenId, { ...params }) -> Token
• client.accounts.tokens.list({ ...params }) -> TokensV4PagePaginationArray
• client.accounts.tokens.delete(tokenId, { ...params }) -> TokenDeleteResponse | null
• client.accounts.tokens.get(tokenId, { ...params }) -> Token
• client.accounts.tokens.verify({ ...params }) -> TokenVerifyResponse

PermissionGroups

Types:

• PermissionGroupListResponse
• PermissionGroupGetResponse

Methods:

• client.accounts.tokens.permissionGroups.list({ ...params }) -> PermissionGroupListResponsesSinglePage
• client.accounts.tokens.permissionGroups.get({ ...params }) -> PermissionGroupGetResponse

Value

Methods:

• client.accounts.tokens.value.update(tokenId, { ...params }) -> TokenValue

Logs

Audit

Types:

• AuditListResponse

Methods:

• client.accounts.logs.audit.list({ ...params }) -> AuditListResponsesCursorPaginationAfter