WebsitesClientAccessApi
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:26
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebsitesClientAccessApi(
opts):WebsitesClientAccessApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebsitesClientAccessApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”add(
websiteId,input):Promise<AddClientResult>
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:42
Add a client to a website. If the email matches an existing
Client, the link is written instantly (kind: "linked").
Otherwise an email invitation is issued (kind: "invited") —
the link materializes when the recipient claims.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string
WebsiteClientLinkRole
Returns
Section titled “Returns”Promise<AddClientResult>
list()
Section titled “list()”list(
websiteId):Promise<{clients:WebsiteClientLinkSummary[]; }>
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:32
List clients with access to a website. Includes active link rows AND still-pending client_access invitations so the admin sees the complete “who has access” picture.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ clients: WebsiteClientLinkSummary[]; }>
remove()
Section titled “remove()”remove(
websiteId,clientId):Promise<void>
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:61
Revoke an active link. Idempotent.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
clientId
Section titled “clientId”string
Returns
Section titled “Returns”Promise<void>
revokeInvitation()
Section titled “revokeInvitation()”revokeInvitation(
websiteId,invitationId):Promise<void>
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:66
Revoke a pending client_access invitation before it’s claimed.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
invitationId
Section titled “invitationId”string
Returns
Section titled “Returns”Promise<void>
setRole()
Section titled “setRole()”setRole(
websiteId,clientId,role):Promise<{link:WebsiteClientLink; }>
Defined in: packages/sdk/src/resources/WebsitesClientAccessApi.ts:50
Change an existing linked client’s role.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
clientId
Section titled “clientId”string
WebsiteClientLinkRole
Returns
Section titled “Returns”Promise<{ link: WebsiteClientLink; }>