WebsitesInvitationsApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:829
Brand-new-client invitation flow — invite by email, cancel pending, read invitation history.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebsitesInvitationsApi(
opts):WebsitesInvitationsApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebsitesInvitationsApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”cancelInvite()
Section titled “cancelInvite()”cancelInvite(
websiteId):Promise<{website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:843
Revoke an open or accepted invitation.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ website: Website; }>
invitations()
Section titled “invitations()”invitations(
websiteId):Promise<{invitations:WebsiteInvitation[]; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:847
Invitation history for a website, newest first.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ invitations: WebsiteInvitation[]; }>
inviteClient()
Section titled “inviteClient()”inviteClient(
websiteId,input):Promise<{invitation:WebsiteInvitation;website:Website; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:836
Invite a brand-new client (no Vantage account yet) by email. Sends a magic link, sets pendingInvitationId on the website. When the recipient signs up + claims, ownership transfer kicks off the Stripe Checkout flow automatically.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string
Returns
Section titled “Returns”Promise<{ invitation: WebsiteInvitation; website: Website; }>