cloudflare
Version:
The official TypeScript library for the Cloudflare API
71 lines • 3.09 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 BaseRegistrationStatus = /* @__PURE__ */ (() => {
class BaseRegistrationStatus extends APIResource {
/**
* Returns the current status of a domain registration workflow.
*
* Use this endpoint to poll for completion when the POST 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.
*
* **Terminal states:** `succeeded` and `failed` are terminal and always have
* `completed: true`.
*
* **Non-terminal states:**
*
* - `action_required` has `completed: false` and will not resolve on its own. The
* workflow is paused pending user intervention.
* - `blocked` has `completed: false` and indicates the workflow is waiting on a
* third party such as the extension registry or losing registrar. Continue
* polling while informing the user of the delay.
*
* Use increasing backoff between polls. When `state: blocked`, use a longer
* polling interval and do not poll indefinitely.
*
* A naive polling loop that only checks `completed` can run indefinitely when
* `state: action_required`. Break explicitly on `action_required`:
*
* ```js
* let status;
* do {
* await new Promise((r) => setTimeout(r, 2000));
* status = await cloudflare.request({
* method: "GET",
* path: reg.result.links.self,
* });
* } while (!status.result.completed && status.result.state !== "action_required");
*
* if (status.result.state === "action_required") {
* // Surface context.action and context.confirmation_sent_to to the user.
* // Do not re-submit the registration request.
* }
* ```
*
* @example
* ```ts
* const registrationStatus =
* await client.registrarSandbox.registrationStatus.get(
* 'example.com',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(domainName, params, options) {
const { account_id } = params;
return this._client.get(path `/accounts/${account_id}/registrar-sandbox/registrations/${domainName}/registration-status`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseRegistrationStatus._key = Object.freeze([
'registrarSandbox',
'registrationStatus',
]);
return BaseRegistrationStatus;
})();
export class RegistrationStatus extends BaseRegistrationStatus {
}
//# sourceMappingURL=registration-status.mjs.map