JobsApi
Defined in: packages/sdk/src/resources/JobsApi.ts:12
Provisioning jobs — the per-website work queue that runs after
websites.create or websites.setFeatures flips a flag on.
vc.websites.jobs(websiteId) is the canonical call site; this
resource exposes the same data under a job-centric prefix for
callers that have a jobId in hand or already think in jobs.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JobsApi(
opts):JobsApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”JobsApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”getJob()
Section titled “getJob()”getJob(
jobId):Promise<ProvisioningJob>
Defined in: packages/sdk/src/resources/JobsApi.ts:18
Fetch one provisioning job by id. The api returns the row
directly (no wrapper). 404 if no such job. Use this to poll
status after setFeatures or create enqueues a fresh run.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ProvisioningJob>
listJobs()
Section titled “listJobs()”listJobs(
websiteId):Promise<{jobs:ProvisioningJob[]; }>
Defined in: packages/sdk/src/resources/JobsApi.ts:26
List provisioning jobs for a website, newest first. Same data
as websites.jobs(websiteId) — exposed here so job-centric
callers don’t have to reach through the websites resource.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ jobs: ProvisioningJob[]; }>