Skip to content

api.md

Latest commit

 

History

History
111 lines (65 loc) · 5.09 KB

api.md

File metadata and controls

111 lines (65 loc) · 5.09 KB

User

Types:

Methods:

  • client.user.edit({ ...params }) -> UserEditResponse
  • client.user.get() -> UserGetResponse

AuditLogs

Methods:

  • client.user.auditLogs.list({ ...params }) -> AuditLogsV4PagePaginationArray

Billing

History

Types:

Methods:

  • client.user.billing.history.list({ ...params }) -> BillingHistoriesV4PagePaginationArray

Profile

Types:

Methods:

  • client.user.billing.profile.get() -> ProfileGetResponse

Invites

Types:

Methods:

  • client.user.invites.list() -> InvitesSinglePage
  • client.user.invites.edit(inviteId, { ...params }) -> Invite
  • client.user.invites.get(inviteId) -> Invite

Organizations

Types:

Methods:

  • client.user.organizations.list({ ...params }) -> OrganizationsV4PagePaginationArray
  • client.user.organizations.delete(organizationId) -> OrganizationDeleteResponse
  • client.user.organizations.get(organizationId) -> OrganizationGetResponse

Subscriptions

Types:

Methods:

  • client.user.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse
  • client.user.subscriptions.delete(identifier) -> SubscriptionDeleteResponse
  • client.user.subscriptions.get() -> SubscriptionsSinglePage

Tokens

Types:

Methods:

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

PermissionGroups

Types:

Methods:

  • client.user.tokens.permissionGroups.list({ ...params }) -> PermissionGroupListResponsesSinglePage

Value

Methods:

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