WebsitesTransferApi
Defined in: packages/sdk/src/resources/WebsitesApi.ts:695
Ownership-transfer surface — assign a website to an existing client, cancel a pending transfer, resend the claim email, invite the owning client as a GitHub collaborator, and release ownership (unassign).
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebsitesTransferApi(
opts):WebsitesTransferApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebsitesTransferApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”cancelTransfer()
Section titled “cancelTransfer()”cancelTransfer(
websiteId):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:708
Revoke a pending transfer before the client pays.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<Website>
inviteCollaborator()
Section titled “inviteCollaborator()”inviteCollaborator(
websiteId):Promise<{invited:string;repo:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:727
Invite the website’s owning client (must have a GitHub username on file) as a collaborator on the GitHub repo. The platform repo is created under the Vantage GitHub org; this is what gives the client direct git access.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ invited: string; repo: string; }>
resendTransfer()
Section titled “resendTransfer()”resendTransfer(
websiteId):Promise<{resent:true;sentTo:string; }>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:716
Re-send the transfer claim email. Use when the original got missed, filtered to spam, or expired (the magic link is valid for 7 days).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ resent: true; sentTo: string; }>
transfer()
Section titled “transfer()”transfer(
websiteId,input):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:701
Hand a website over to an existing client. Sets pendingClientId; the client then pays via Stripe Checkout (their portal will show a pending-transfer banner) to finalize ownership.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
clientId
Section titled “clientId”string
Returns
Section titled “Returns”Promise<Website>
unassign()
Section titled “unassign()”unassign(
websiteId):Promise<Website>
Defined in: packages/sdk/src/resources/WebsitesApi.ts:737
Release a website from its current owner. Cancels the Stripe subscription + clears clientId. Use when a client churns or you want to re-park a site under house ownership.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<Website>