WebsitesDeliveryApi
Defined in: packages/sdk/src/resources/WebsitesDeliveryApi.ts:15
vc.websites.delivery.* — project delivery tracking. The GET
response is role-aware on the server side: client callers only
see previewUrl if the admin has flipped showPreviewUrl=true.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebsitesDeliveryApi(
opts):WebsitesDeliveryApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”WebsitesDeliveryApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”get(
websiteId):Promise<DeliveryResponse>
Defined in: packages/sdk/src/resources/WebsitesDeliveryApi.ts:20
Read the delivery block + resolved preview URL. Returns
delivery: null if the admin hasn’t set up tracking yet.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<DeliveryResponse>
setCheckpointStatus()
Section titled “setCheckpointStatus()”setCheckpointStatus(
websiteId,checkpointId,status):Promise<{delivery:WebsiteDelivery; }>
Defined in: packages/sdk/src/resources/WebsitesDeliveryApi.ts:37
Flip a single checkpoint’s status. Admin only.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
checkpointId
Section titled “checkpointId”string
status
Section titled “status”DeliveryCheckpointStatus
Returns
Section titled “Returns”Promise<{ delivery: WebsiteDelivery; }>
update()
Section titled “update()”update(
websiteId,input):Promise<{delivery:WebsiteDelivery; }>
Defined in: packages/sdk/src/resources/WebsitesDeliveryApi.ts:28
Replace the delivery block. Admin only. Omit checkpoints to
seed the default template on first call.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Partial<UpdateDeliveryInput> & Pick<UpdateDeliveryInput, "estimatedCompletionAt" | "showPreviewUrl">
Returns
Section titled “Returns”Promise<{ delivery: WebsiteDelivery; }>