cloudflare
Version:
The official TypeScript library for the Cloudflare API
40 lines • 1.67 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../core/resource.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BaseUpdateStatus = /* @__PURE__ */ (() => {
class BaseUpdateStatus extends APIResource {
/**
* Returns the current status of a domain update workflow.
*
* Use this endpoint to poll for completion when the PATCH response returned
* `202 Accepted`. The URL is provided in the `links.self` field of the workflow
* status response.
*
* Poll this endpoint until the workflow reaches a terminal state or a state that
* requires user attention.
*
* Use increasing backoff between polls. When the workflow remains blocked on a
* third party, use a longer polling interval and do not poll indefinitely.
*
* @example
* ```ts
* const workflowStatus =
* await client.registrar.updateStatus.get('example.com', {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
get(domainName, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/registrar/registrations/${domainName}/update-status`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseUpdateStatus._key = Object.freeze([
'registrar',
'updateStatus',
]);
return BaseUpdateStatus;
})();
export class UpdateStatus extends BaseUpdateStatus {
}
//# sourceMappingURL=update-status.mjs.map