cloudflare 7.0.0 → 7.1.0

package/resources/registrar-sandbox/registrar-sandbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registrar-sandbox.d.ts","sourceRoot":"","sources":["../../src/resources/registrar-sandbox/registrar-sandbox.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,sCAAsC,EACtC,UAAU,EACX,wBAAqB;AACtB,OAAO,KAAK,qBAAqB,iCAA8B;AAC/D,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,2BAA2B,EAC3B,6BAA6B,EAC9B,iCAA8B;AAC/B,OAAO,KAAK,gBAAgB,2BAAwB;AACpD,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,yCAAyC,EACzC,aAAa,EACd,2BAAwB;AACzB,OAAO,KAAK,eAAe,2BAAwB;AACnD,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,EACxB,2BAAwB;AACzB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,gBAAyB,IAAI,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAgD;IAE5G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,KAAK,CACH,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAU5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,MAAM,CACJ,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAS9C;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,qBAAa,gBAAiB,SAAQ,oBAAoB;IACxD,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAE1D;IACF,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAC5F,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;CACnF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;;;;;;;;OASG;IACH,MAAM,EACF,QAAQ,GACR,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,mBAAmB,GACnB,gBAAgB,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,EAAE,SAAS,GAAG,aAAa,GAAG,iBAAiB,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE1F,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC;CACrC;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;;;;;OAMG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;CACtD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;;;OAIG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;;;;WAQG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;WAYG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;QAEzB;;;;;;;;;;;;;;;;;WAiBG;QACH,MAAM,CAAC,EACH,iCAAiC,GACjC,yBAAyB,GACzB,kCAAkC,GAClC,gBAAgB,GAChB,oBAAoB,CAAC;QAEzB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KAC/B;IAED,UAAiB,MAAM,CAAC;QACtB;;;;;;;;;;;;WAYG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;;;;eAKG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;CACvD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;;;OAIG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;;WAMG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;WAYG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;QAEzB;;;;;;;;;;;;;;;WAeG;QACH,MAAM,CAAC,EACH,iCAAiC,GACjC,yBAAyB,GACzB,kCAAkC,GAClC,gBAAgB,GAChB,oBAAoB,CAAC;QAEzB;;;;;;;WAOG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KAC/B;IAED,UAAiB,MAAM,CAAC;QACtB;;;;;;;;;;;;WAYG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;;;;eAKG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;;;;eAKG;YACH,YAAY,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;OAUG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAWD,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,iBAAiB,IAAI,iBAAiB,EACtC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,kBAAkB,IAAI,kBAAkB,EACxC,sBAAsB,IAAI,sBAAsB,EAChD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,cAAc,IAAI,cAAc,EAChC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/registrar-sandbox/registrar-sandbox.js

@@ -0,0 +1,374 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegistrarSandbox = exports.BaseRegistrarSandbox = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+const resource_1 = require("../../core/resource.js");
+const ExtensionsAPI = tslib_1.__importStar(require("./extensions.js"));
+const extensions_1 = require("./extensions.js");
+const RegistrationStatusAPI = tslib_1.__importStar(require("./registration-status.js"));
+const registration_status_1 = require("./registration-status.js");
+const RegistrationsAPI = tslib_1.__importStar(require("./registrations.js"));
+const registrations_1 = require("./registrations.js");
+const UpdateStatusAPI = tslib_1.__importStar(require("./update-status.js"));
+const update_status_1 = require("./update-status.js");
+const path_1 = require("../../internal/utils/path.js");
+var BaseRegistrarSandbox = /* @__PURE__ */ (() => {
+    /**
+     * Use the Registrar Sandbox API to test domain search, availability checks,
+     * registration, and domain management flows without buying real domains.
+     *
+     * **This API is a test environment for the production Registrar API.**
+     *
+     * ## Prerequisites
+     *
+     * Before using this API, make sure you have:
+     *
+     * 1. **Cloudflare account** — the caller must have a valid Cloudflare account.
+     * 2. **API authentication** — create an API token with Registrar Sandbox permissions.
+     *
+     * ## How the Sandbox API differs from the production Registrar API
+     *
+     * Because the Sandbox API is intended for testing, it behaves differently from
+     * the production Registrar API in a few important ways:
+     *
+     * 1. **No billing** — you will not be charged real money for purchasing a domain.
+     * 2. **No real domains** — purchased domains are test records and will not be
+     *   reachable on the Internet.
+     * 3. **No DNS zones** — purchasing a domain does not create a zone resource.
+     * 4. **No Registration Express Mode** — you must provide full contact data.
+     *
+     * Sandbox purchases are still persisted. If you purchase a domain in the sandbox,
+     * that domain will not be available for others to purchase in the sandbox.
+     *
+     * ## Terminology: domain extension
+     *
+     * Throughout this API, "extension" refers to the domain extension part of a fully
+     * qualified domain name — the portion after the registrable label. For example,
+     * in `example.co.uk`, the extension is `co.uk` (not just `uk`). This covers both
+     * top-level domains like `com` and multi-level extensions like `co.uk`. This is
+     * distinct from other uses of the word "extension" (e.g., EPP extensions).
+     *
+     * ## Supported extensions
+     *
+     * The Sandbox API currently supports programmatic registration for these
+     * extensions:
+     *
+     * `com`, `net`
+     *
+     * The production Registrar API supports 40+ extensions.
+     *
+     * Cloudflare Registrar supports 400+ extensions in the dashboard. Extensions
+     * not listed above can be registered at `https://dash.cloudflare.com/{account_id}/domains/registrations`.
+     *
+     * ## Typical workflow
+     *
+     * 1. **Search** — call `GET /domain-search?q={keyword}` to discover available domains.
+     * 2. **Check** — call `POST /domain-check` with candidate domains to verify real-time
+     *   availability and pricing.
+     * 3. **Review the response** — if `registrable: false`, inspect `reason` to
+     *   understand whether the domain is unavailable, the extension is not supported
+     *   by this API, the extension is not supported by Cloudflare Registrar at all,
+     *   or the extension's registry has frozen new registrations.
+     * 4. **Handle premium domains** — if `tier: premium`, premium registration is
+     *   not currently supported by this API. The Sandbox API currently supports
+     *   only `com` and `net`, which do not have premium registrations, but clients
+     *   should still handle this response for consistency with the production
+     *   Registrar API. Surface the premium pricing to the user, but do not proceed
+     *   to `POST /registrations` for that domain.
+     * 5. **Observe the registration schema** — call `GET /extensions/:extension_name`
+     *   to discover the required values for registering this extension.
+     * 6. **Register** — call `POST /registrations` with the chosen domain name for
+     *   supported non-premium registrations.
+     * 7. **Confirm completion** — if the response is `201 Created`, registration
+     *   completed within the default timeout and no polling is needed.
+     * 8. **Poll when needed** — if the response is `202 Accepted`, poll
+     *   `links.self` from the workflow response.
+     * 9. **Stop for user action** — if `state: action_required`, stop polling and
+     *   surface `context.action` to the user.
+     *   The workflow will not resolve on its own.
+     * 10. **Continue when blocked** — if `state: blocked`, continue polling and
+     *   inform the user that a third party, such as the extension registry or losing
+     *   registrar, is delaying progress.
+     * 11. **Review failures before retrying** — if `state: failed`, review
+     *   `error.code` and `error.message`, then decide whether user action or a new
+     *   Check call is needed.
+     *
+     * ## Default behavior for mutating operations
+     *
+     * By default, mutating operations such as create and update hold the connection
+     * for a bounded, server-defined amount of time while the operation completes.
+     * In most cases, the response contains a completed workflow status and no
+     * polling is required.
+     *
+     * - **Completed within the synchronous wait window:** Returns `201` (create)
+     * or `200` (update) with a `workflow_status` where `state: succeeded` and
+     * `completed: true`.
+     * - **Still processing after the synchronous wait window:** Returns
+     * `202 Accepted` with a `workflow_status` where `completed: false`. Use
+     * the `links.self` URL to poll for completion.
+     *
+     * ## Non-blocking mode
+     *
+     * To receive an immediate `202 Accepted` response without waiting, send the
+     * `Prefer: respond-async` request header (RFC 7240). The server will acknowledge
+     * it with a `Preference-Applied: respond-async` response header.
+     *
+     * ## Polling
+     *
+     * When the response is `202`, poll the workflow status endpoint indicated by
+     * `links.self` in the response body until the workflow reaches a terminal
+     * state or requires user action.
+     */
+    class BaseRegistrarSandbox extends resource_1.APIResource {
+        /**
+         * Performs real-time, authoritative availability checks directly against domain
+         * registries. Use this endpoint to verify a domain is available before attempting
+         * registration via `POST /registrations`.
+         *
+         * **Important:** Unlike the Search endpoint, these results are authoritative and
+         * reflect current registry status. Always check availability immediately before
+         * registration as domain status can change rapidly.
+         *
+         * **Note:** This endpoint uses POST to accept a list of domains in the request
+         * body. It is a read-only operation — it does not create, modify, or reserve any
+         * domains.
+         *
+         * ### Extension support
+         *
+         * Only domains on extensions supported for programmatic registration by this API
+         * can be registered. If you check a domain on an unsupported extension, the
+         * response will include `registrable: false` with a `reason` field explaining why:
+         *
+         * - `extension_not_supported_via_api` — Cloudflare Registrar supports this
+         *   extension in the dashboard, but it is not yet available for programmatic
+         *   registration via this API. Register via
+         *   `https://dash.cloudflare.com/{account_id}/domains/registrations` instead.
+         * - `extension_not_supported` — This extension is not supported by Cloudflare
+         *   Registrar.
+         * - `extension_disallows_registration` — The extension's registry has temporarily
+         *   or permanently frozen new registrations. No registrar can register domains on
+         *   this extension at this time.
+         * - `domain_premium` — The domain is premium priced. Premium registration is not
+         *   currently supported by this API.
+         * - `domain_unavailable` — The domain is already registered, reserved, or
+         *   otherwise not available for registration on a supported extension.
+         *
+         * The `reason` field is only present when `registrable` is `false`.
+         *
+         * ### Behavior
+         *
+         * - Maximum 20 domains per request
+         * - Pricing is only returned for domains where `registrable: true`
+         * - Results are not cached; each request queries the registry
+         *
+         * ### Workflow
+         *
+         * 1. Call this endpoint with domains the user wants to register.
+         * 2. For each domain where `registrable: true`, present pricing to the user.
+         * 3. If `tier: premium`, note that premium registration is not currently supported
+         *    by this API and do not proceed to `POST /registrations`.
+         * 4. Proceed to `POST /registrations` only for supported non-premium domains.
+         *
+         * @example
+         * ```ts
+         * const response = await client.registrarSandbox.check({
+         *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+         *   domains: [
+         *     'myawesomebrand.com',
+         *     'myawesomebrand.net',
+         *     'myawesomebrand.org',
+         *     'myawesomebrand.app',
+         *     'myawesomebrand.dev',
+         *   ],
+         * });
+         * ```
+         */
+        check(params, options) {
+            const { account_id, ...body } = params;
+            return this._client.post((0, path_1.path) `/accounts/${account_id}/registrar-sandbox/domain-check`, {
+                body,
+                ...options,
+            })._thenUnwrap((obj) => obj.result);
+        }
+        /**
+         * Searches for domain name suggestions based on a keyword, phrase, or partial
+         * domain name. Returns a list of potentially available domains with pricing
+         * information.
+         *
+         * **Important:** Results are non-authoritative and based on cached data. Always
+         * use the `/domain-check` endpoint to verify real-time availability before
+         * attempting registration.
+         *
+         * Suggestions are scoped to extensions supported for programmatic registration via
+         * this API (`POST /registrations`). Domains on unsupported extensions will not
+         * appear in results, even if they are available at the registry level.
+         *
+         * ### Use cases
+         *
+         * - Brand name discovery (e.g., "acme corp" → acmecorp.com, acmecorp.dev)
+         * - Keyword-based suggestions (e.g., "coffee shop" → coffeeshop.com,
+         *   mycoffeeshop.net)
+         * - Alternative extension discovery (e.g., "example.com" → example.com,
+         *   example.app, example.xyz)
+         *
+         * ### Workflow
+         *
+         * 1. Call this endpoint with a keyword or domain name.
+         * 2. Present suggestions to the user.
+         * 3. Call `/domain-check` with the user's chosen domains to confirm real-time
+         *    availability and pricing.
+         * 4. Proceed to `POST /registrations` only for supported non-premium domains where
+         *    the Check response returns `registrable: true`.
+         *
+         * **Note:** Searching with just a domain extension (e.g., "com" or ".app") is not
+         * supported. Provide a keyword or domain name.
+         *
+         * @example
+         * ```ts
+         * const response = await client.registrarSandbox.search({
+         *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+         *   q: 'x',
+         * });
+         * ```
+         */
+        search(params, options) {
+            const { account_id, ...query } = params;
+            return this._client.get((0, path_1.path) `/accounts/${account_id}/registrar-sandbox/domain-search`, {
+                query,
+                ...options,
+            })._thenUnwrap((obj) => obj.result);
+        }
+    }
+    BaseRegistrarSandbox._key = Object.freeze(['registrarSandbox']);
+    return BaseRegistrarSandbox;
+})();
+exports.BaseRegistrarSandbox = BaseRegistrarSandbox;
+var RegistrarSandbox = /* @__PURE__ */ (() => {
+    /**
+     * Use the Registrar Sandbox API to test domain search, availability checks,
+     * registration, and domain management flows without buying real domains.
+     *
+     * **This API is a test environment for the production Registrar API.**
+     *
+     * ## Prerequisites
+     *
+     * Before using this API, make sure you have:
+     *
+     * 1. **Cloudflare account** — the caller must have a valid Cloudflare account.
+     * 2. **API authentication** — create an API token with Registrar Sandbox permissions.
+     *
+     * ## How the Sandbox API differs from the production Registrar API
+     *
+     * Because the Sandbox API is intended for testing, it behaves differently from
+     * the production Registrar API in a few important ways:
+     *
+     * 1. **No billing** — you will not be charged real money for purchasing a domain.
+     * 2. **No real domains** — purchased domains are test records and will not be
+     *   reachable on the Internet.
+     * 3. **No DNS zones** — purchasing a domain does not create a zone resource.
+     * 4. **No Registration Express Mode** — you must provide full contact data.
+     *
+     * Sandbox purchases are still persisted. If you purchase a domain in the sandbox,
+     * that domain will not be available for others to purchase in the sandbox.
+     *
+     * ## Terminology: domain extension
+     *
+     * Throughout this API, "extension" refers to the domain extension part of a fully
+     * qualified domain name — the portion after the registrable label. For example,
+     * in `example.co.uk`, the extension is `co.uk` (not just `uk`). This covers both
+     * top-level domains like `com` and multi-level extensions like `co.uk`. This is
+     * distinct from other uses of the word "extension" (e.g., EPP extensions).
+     *
+     * ## Supported extensions
+     *
+     * The Sandbox API currently supports programmatic registration for these
+     * extensions:
+     *
+     * `com`, `net`
+     *
+     * The production Registrar API supports 40+ extensions.
+     *
+     * Cloudflare Registrar supports 400+ extensions in the dashboard. Extensions
+     * not listed above can be registered at `https://dash.cloudflare.com/{account_id}/domains/registrations`.
+     *
+     * ## Typical workflow
+     *
+     * 1. **Search** — call `GET /domain-search?q={keyword}` to discover available domains.
+     * 2. **Check** — call `POST /domain-check` with candidate domains to verify real-time
+     *   availability and pricing.
+     * 3. **Review the response** — if `registrable: false`, inspect `reason` to
+     *   understand whether the domain is unavailable, the extension is not supported
+     *   by this API, the extension is not supported by Cloudflare Registrar at all,
+     *   or the extension's registry has frozen new registrations.
+     * 4. **Handle premium domains** — if `tier: premium`, premium registration is
+     *   not currently supported by this API. The Sandbox API currently supports
+     *   only `com` and `net`, which do not have premium registrations, but clients
+     *   should still handle this response for consistency with the production
+     *   Registrar API. Surface the premium pricing to the user, but do not proceed
+     *   to `POST /registrations` for that domain.
+     * 5. **Observe the registration schema** — call `GET /extensions/:extension_name`
+     *   to discover the required values for registering this extension.
+     * 6. **Register** — call `POST /registrations` with the chosen domain name for
+     *   supported non-premium registrations.
+     * 7. **Confirm completion** — if the response is `201 Created`, registration
+     *   completed within the default timeout and no polling is needed.
+     * 8. **Poll when needed** — if the response is `202 Accepted`, poll
+     *   `links.self` from the workflow response.
+     * 9. **Stop for user action** — if `state: action_required`, stop polling and
+     *   surface `context.action` to the user.
+     *   The workflow will not resolve on its own.
+     * 10. **Continue when blocked** — if `state: blocked`, continue polling and
+     *   inform the user that a third party, such as the extension registry or losing
+     *   registrar, is delaying progress.
+     * 11. **Review failures before retrying** — if `state: failed`, review
+     *   `error.code` and `error.message`, then decide whether user action or a new
+     *   Check call is needed.
+     *
+     * ## Default behavior for mutating operations
+     *
+     * By default, mutating operations such as create and update hold the connection
+     * for a bounded, server-defined amount of time while the operation completes.
+     * In most cases, the response contains a completed workflow status and no
+     * polling is required.
+     *
+     * - **Completed within the synchronous wait window:** Returns `201` (create)
+     * or `200` (update) with a `workflow_status` where `state: succeeded` and
+     * `completed: true`.
+     * - **Still processing after the synchronous wait window:** Returns
+     * `202 Accepted` with a `workflow_status` where `completed: false`. Use
+     * the `links.self` URL to poll for completion.
+     *
+     * ## Non-blocking mode
+     *
+     * To receive an immediate `202 Accepted` response without waiting, send the
+     * `Prefer: respond-async` request header (RFC 7240). The server will acknowledge
+     * it with a `Preference-Applied: respond-async` response header.
+     *
+     * ## Polling
+     *
+     * When the response is `202`, poll the workflow status endpoint indicated by
+     * `links.self` in the response body until the workflow reaches a terminal
+     * state or requires user action.
+     */
+    class RegistrarSandbox extends BaseRegistrarSandbox {
+        constructor() {
+            super(...arguments);
+            this.registrations = new RegistrationsAPI.Registrations(this._client);
+            this.registrationStatus = new RegistrationStatusAPI.RegistrationStatus(this._client);
+            this.updateStatus = new UpdateStatusAPI.UpdateStatus(this._client);
+            this.extensions = new ExtensionsAPI.Extensions(this._client);
+        }
+    }
+    RegistrarSandbox.Registrations = registrations_1.Registrations;
+    RegistrarSandbox.BaseRegistrations = registrations_1.BaseRegistrations;
+    RegistrarSandbox.RegistrationStatus = registration_status_1.RegistrationStatus;
+    RegistrarSandbox.BaseRegistrationStatus = registration_status_1.BaseRegistrationStatus;
+    RegistrarSandbox.UpdateStatus = update_status_1.UpdateStatus;
+    RegistrarSandbox.BaseUpdateStatus = update_status_1.BaseUpdateStatus;
+    RegistrarSandbox.Extensions = extensions_1.Extensions;
+    RegistrarSandbox.BaseExtensions = extensions_1.BaseExtensions;
+    return RegistrarSandbox;
+})();
+exports.RegistrarSandbox = RegistrarSandbox;
+//# sourceMappingURL=registrar-sandbox.js.map

package/resources/registrar-sandbox/registrar-sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registrar-sandbox.js","sourceRoot":"","sources":["../../src/resources/registrar-sandbox/registrar-sandbox.ts"],"names":[],"mappings":";;;;AAAA,sFAAsF;AAEtF,qDAAkD;AAClD,uEAA8C;AAC9C,gDAQsB;AACtB,wFAA+D;AAC/D,kEAK+B;AAC/B,6EAAoD;AACpD,sDAYyB;AACzB,4EAAmD;AACnD,sDAKyB;AAGzB,uDAAiD;;IAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyGG;IACH,MAAa,oBAAqB,SAAQ,sBAAW;QAGnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA8DG;QACH,KAAK,CACH,MAAmC,EACnC,OAAwB;YAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;YACvC,OACE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,iCAAiC,EAAE;gBAC9E,IAAI;gBACJ,GAAG,OAAO;aACX,CACF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;QACH,MAAM,CACJ,MAAoC,EACpC,OAAwB;YAExB,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;YACxC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,kCAAkC,EAAE;gBAC9E,KAAK;gBACL,GAAG,OAAO;aACX,CACF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;;IAlIwB,yBAAI,GAAkC,MAAM,CAAC,MAAM,CAAC,CAAC,kBAAkB,CAAU,CAAC,CAAC;;;AAD9G,oDAoIC;;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyGG;IACH,MAAa,gBAAiB,SAAQ,oBAAoB;QAA1D;;YACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjG,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;YACF,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5F,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpF,CAAC;KAAA;IAgcD,gBAAgB,CAAC,aAAa,GAAG,6BAAa,CAAC;IAC/C,gBAAgB,CAAC,iBAAiB,GAAG,iCAAiB,CAAC;IACvD,gBAAgB,CAAC,kBAAkB,GAAG,wCAAkB,CAAC;IACzD,gBAAgB,CAAC,sBAAsB,GAAG,4CAAsB,CAAC;IACjE,gBAAgB,CAAC,YAAY,GAAG,4BAAY,CAAC;IAC7C,gBAAgB,CAAC,gBAAgB,GAAG,gCAAgB,CAAC;IACrD,gBAAgB,CAAC,UAAU,GAAG,uBAAU,CAAC;IACzC,gBAAgB,CAAC,cAAc,GAAG,2BAAc,CAAC;;;AA9cjD,4CAOC"}