cloudflare 7.2.0 → 7.3.0

package/src/resources/registrar/registrar.ts

@@ -269,6 +269,60 @@ export class BaseRegistrar extends APIResource {
       }) as APIPromise<{ result: RegistrarSearchResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Performs real-time, authoritative eligibility checks directly against needed
+   * requirements. Use this endpoint to verify a domain is available before
+   * attempting a transfer via `POST /registrations/:domain_name/transfer-in`.
+   *
+   * **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.
+   *
+   * ### Behavior
+   *
+   * - Maximum 10 domains per request
+   * - Pricing is only returned for domains where `transferable: true`
+   * - Results are not cached; each request queries the registry & other needed
+   *   upstreams
+   *
+   * ## Extension Support
+   *
+   * All `.uk` extensions (`.uk`, `.co.uk`, etc) do not support auth codes. As such,
+   * Cloudflare will ignore the `auth_code` section of this request for `.uk`
+   * domains.
+   *
+   * This means that a `.uk` domain depends on public data to obtain domain
+   * information, so it might be a few minutes outdated.
+   *
+   * ### Workflow
+   *
+   * 1. Call this endpoint with domains the user wants to transfer.
+   * 2. For each domain where `transferable: true`, present pricing to the user.
+   * 3. For each domain where `transferable: false`, present reasons to the user
+   * 4. Proceed to `POST /registrations/:domain_name/transfer-in` only for the
+   *    `transferable: true` domains.
+   *
+   * @example
+   * ```ts
+   * const response = await client.registrar.transferCheck({
+   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   domains: [{ domain_name: 'example.co.uk' }],
+   * });
+   * ```
+   */
+  transferCheck(
+    params: RegistrarTransferCheckParams,
+    options?: RequestOptions,
+  ): APIPromise<RegistrarTransferCheckResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(path`/accounts/${account_id}/registrar/domain-transfer-check`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: RegistrarTransferCheckResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 /**
  * Registrar API for searching, checking, registering, and managing domains through Cloudflare Registrar.
@@ -763,6 +817,231 @@ export namespace RegistrarSearchResponse {
   }
 }
 
+/**
+ * Contains the transfer eligibility results.
+ */
+export interface RegistrarTransferCheckResponse {
+  /**
+   * Maps domain names to transfer eligibility results. Each value contains `name`,
+   * `transferable`, and `reasons`.
+   */
+  domains: {
+    [key: string]:
+      | RegistrarTransferCheckResponse.TransferableResult
+      | RegistrarTransferCheckResponse.NonTransferableResult;
+  };
+}
+
+export namespace RegistrarTransferCheckResponse {
+  export interface TransferableResult {
+    /**
+     * Provides annual pricing information for a given domain. The API returns all
+     * per-year prices as strings to preserve decimal precision.
+     *
+     * `renewal_cost` and `registration_cost` or `transfer_cost` are frequently the
+     * same value, but may differ due to premium rates for certain domains.
+     *
+     * For a multi-year operations, the operation's cost applies to the first year and
+     * `renewal_cost` applies to each subsequent year. The values reflect the current
+     * registry rate, which can change over time.
+     */
+    pricing: TransferableResult.Pricing;
+
+    transferable: true;
+
+    /**
+     * The check evaluates this domain name.
+     */
+    name?: string;
+
+    reasons?: Array<TransferableResult.Reason>;
+  }
+
+  export namespace TransferableResult {
+    /**
+     * Provides annual pricing information for a given domain. The API returns all
+     * per-year prices as strings to preserve decimal precision.
+     *
+     * `renewal_cost` and `registration_cost` or `transfer_cost` are frequently the
+     * same value, but may differ due to premium rates for certain domains.
+     *
+     * For a multi-year operations, the operation's cost applies to the first year and
+     * `renewal_cost` applies to each subsequent year. The values reflect the current
+     * registry rate, which can change over time.
+     */
+    export interface Pricing {
+      /**
+       * ISO-4217 currency code for the prices (e.g., "USD", "EUR", "GBP").
+       */
+      currency: string;
+
+      /**
+       * Per-year renewal cost for this domain. Applied to each year beyond the first
+       * year of a multi-year registration, and to each annual auto-renewal thereafter.
+       * May differ from `registration_cost`, especially for premium domains where
+       * initial registration often costs more than renewals.
+       */
+      renewal_cost: string;
+
+      /**
+       * The first-year cost to transfer this domain.
+       */
+      transfer_cost: string;
+    }
+
+    export interface Reason {
+      /**
+       * Transfer eligibility reason code.
+       *
+       * - `extension_not_supported_via_api`: This API excludes the extension; dashboard
+       *   flows support it.
+       * - `extension_not_supported`: Cloudflare Registrar excludes the extension.
+       * - `domain_premium`: This API currently excludes premium transfers.
+       * - `extension_disallows_transfer`: Extension currently blocks transfer
+       *   operations.
+       * - `domain_not_exists`: No registration record exists for the domain.
+       * - `domain_on_cloudflare`: Cloudflare already serves as the domain's registrar.
+       * - `domain_locked`: Losing registrar reports transfer-prohibited lock status.
+       * - `registry_status`: Registry status currently blocks transfer (for example,
+       *   pending transfer or deletion state).
+       * - `domain_outside_transfer_window`: Domain is within a transfer wait window (for
+       *   example, recently registered).
+       * - `domain_max_term`: Completing transfer would exceed the registry maximum term.
+       * - `invalid_auth_code`: The provided auth code is incorrect.
+       * - `invalid_auth_code_format`: Auth code fails Base64 validation.
+       * - `dnssec_enabled`: DNSSEC is enabled. It must be disabled before transfer.
+       * - `zone_not_found`: The target account lacks a Cloudflare zone for the domain.
+       * - `zone_status_invalid`: The Cloudflare zone cannot transfer in its current
+       *   state.
+       * - `invalid_zone_plan`: The zone plan fails transfer requirements.
+       * - `domain_unsupported`: This endpoint rejects the domain name format.
+       */
+      code:
+        | 'extension_not_supported_via_api'
+        | 'extension_not_supported'
+        | 'domain_premium'
+        | 'extension_disallows_transfer'
+        | 'domain_not_exists'
+        | 'domain_on_cloudflare'
+        | 'domain_locked'
+        | 'registry_status'
+        | 'domain_outside_transfer_window'
+        | 'domain_max_term'
+        | 'invalid_auth_code'
+        | 'invalid_auth_code_format'
+        | 'dnssec_enabled'
+        | 'zone_not_found'
+        | 'zone_status_invalid'
+        | 'invalid_zone_plan'
+        | 'domain_unsupported';
+    }
+  }
+
+  export interface NonTransferableResult {
+    transferable: false;
+
+    /**
+     * The check evaluates this domain name.
+     */
+    name?: string;
+
+    /**
+     * Provides annual pricing information for a given domain. The API returns all
+     * per-year prices as strings to preserve decimal precision.
+     *
+     * `renewal_cost` and `registration_cost` or `transfer_cost` are frequently the
+     * same value, but may differ due to premium rates for certain domains.
+     *
+     * For a multi-year operations, the operation's cost applies to the first year and
+     * `renewal_cost` applies to each subsequent year. The values reflect the current
+     * registry rate, which can change over time.
+     */
+    pricing?: NonTransferableResult.Pricing;
+
+    reasons?: Array<NonTransferableResult.Reason>;
+  }
+
+  export namespace NonTransferableResult {
+    /**
+     * Provides annual pricing information for a given domain. The API returns all
+     * per-year prices as strings to preserve decimal precision.
+     *
+     * `renewal_cost` and `registration_cost` or `transfer_cost` are frequently the
+     * same value, but may differ due to premium rates for certain domains.
+     *
+     * For a multi-year operations, the operation's cost applies to the first year and
+     * `renewal_cost` applies to each subsequent year. The values reflect the current
+     * registry rate, which can change over time.
+     */
+    export interface Pricing {
+      /**
+       * ISO-4217 currency code for the prices (e.g., "USD", "EUR", "GBP").
+       */
+      currency: string;
+
+      /**
+       * Per-year renewal cost for this domain. Applied to each year beyond the first
+       * year of a multi-year registration, and to each annual auto-renewal thereafter.
+       * May differ from `registration_cost`, especially for premium domains where
+       * initial registration often costs more than renewals.
+       */
+      renewal_cost: string;
+
+      /**
+       * The first-year cost to transfer this domain.
+       */
+      transfer_cost: string;
+    }
+
+    export interface Reason {
+      /**
+       * Transfer eligibility reason code.
+       *
+       * - `extension_not_supported_via_api`: This API excludes the extension; dashboard
+       *   flows support it.
+       * - `extension_not_supported`: Cloudflare Registrar excludes the extension.
+       * - `domain_premium`: This API currently excludes premium transfers.
+       * - `extension_disallows_transfer`: Extension currently blocks transfer
+       *   operations.
+       * - `domain_not_exists`: No registration record exists for the domain.
+       * - `domain_on_cloudflare`: Cloudflare already serves as the domain's registrar.
+       * - `domain_locked`: Losing registrar reports transfer-prohibited lock status.
+       * - `registry_status`: Registry status currently blocks transfer (for example,
+       *   pending transfer or deletion state).
+       * - `domain_outside_transfer_window`: Domain is within a transfer wait window (for
+       *   example, recently registered).
+       * - `domain_max_term`: Completing transfer would exceed the registry maximum term.
+       * - `invalid_auth_code`: The provided auth code is incorrect.
+       * - `invalid_auth_code_format`: Auth code fails Base64 validation.
+       * - `dnssec_enabled`: DNSSEC is enabled. It must be disabled before transfer.
+       * - `zone_not_found`: The target account lacks a Cloudflare zone for the domain.
+       * - `zone_status_invalid`: The Cloudflare zone cannot transfer in its current
+       *   state.
+       * - `invalid_zone_plan`: The zone plan fails transfer requirements.
+       * - `domain_unsupported`: This endpoint rejects the domain name format.
+       */
+      code:
+        | 'extension_not_supported_via_api'
+        | 'extension_not_supported'
+        | 'domain_premium'
+        | 'extension_disallows_transfer'
+        | 'domain_not_exists'
+        | 'domain_on_cloudflare'
+        | 'domain_locked'
+        | 'registry_status'
+        | 'domain_outside_transfer_window'
+        | 'domain_max_term'
+        | 'invalid_auth_code'
+        | 'invalid_auth_code_format'
+        | 'dnssec_enabled'
+        | 'zone_not_found'
+        | 'zone_status_invalid'
+        | 'invalid_zone_plan'
+        | 'domain_unsupported';
+    }
+  }
+}
+
 export interface RegistrarCheckParams {
   /**
    * Path param: Cloudflare account ID. Required for all Registrar API operations.
@@ -813,6 +1092,33 @@ export interface RegistrarSearchParams {
   limit?: number;
 }
 
+export interface RegistrarTransferCheckParams {
+  /**
+   * Path param: Cloudflare account ID. Required for all Registrar API operations.
+   */
+  account_id: string;
+
+  /**
+   * Body param: List of domain objects to evaluate for transfer eligibility.
+   */
+  domains: Array<RegistrarTransferCheckParams.Domain>;
+}
+
+export namespace RegistrarTransferCheckParams {
+  export interface Domain {
+    /**
+     * Fully qualified domain name (FQDN) to check for transfer eligibility.
+     */
+    domain_name: string;
+
+    /**
+     * Base64-encoded auth/EPP code from the current registrar. Required for most TLDs.
+     * `.uk` namespaces do not use auth codes.
+     */
+    auth_code?: string;
+  }
+}
+
 Registrar.Domains = Domains;
 Registrar.BaseDomains = BaseDomains;
 Registrar.Registrations = Registrations;
@@ -834,8 +1140,10 @@ export declare namespace Registrar {
     type WorkflowStatus as WorkflowStatus,
     type RegistrarCheckResponse as RegistrarCheckResponse,
     type RegistrarSearchResponse as RegistrarSearchResponse,
+    type RegistrarTransferCheckResponse as RegistrarTransferCheckResponse,
     type RegistrarCheckParams as RegistrarCheckParams,
     type RegistrarSearchParams as RegistrarSearchParams,
+    type RegistrarTransferCheckParams as RegistrarTransferCheckParams,
   };
 
   export {

package/src/resources/resource-tagging/account-tags.ts

@@ -13,7 +13,8 @@ export class BaseAccountTags extends APIResource {
   ] as const);
 
   /**
-   * Creates or updates tags for a specific account-level resource.
+   * Creates or updates tags for a specific account-level resource. Replaces all
+   * existing tags for the resource.
    *
    * @example
    * ```ts
@@ -21,7 +22,7 @@ export class BaseAccountTags extends APIResource {
    *   await client.resourceTagging.accountTags.update({
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     resource_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     resource_type: 'worker',
+   *     resource_type: 'worker_version',
    *     worker_id: '3f72a691-44b3-4c11-8642-c18a88ddaa5e',
    *   });
    * ```
@@ -3837,40 +3838,9 @@ export declare namespace AccountTagUpdateParams {
     resource_id: string;
 
     /**
-     * Body param: Enum for base account-level resource types (those with no extra
-     * required fields).
+     * Body param: Enum for worker_version resource type.
      */
-    resource_type:
-      | 'access_application'
-      | 'access_group'
-      | 'account'
-      | 'account_ruleset'
-      | 'ai_gateway'
-      | 'alerting_policy'
-      | 'alerting_webhook'
-      | 'cloudflared_tunnel'
-      | 'cws_deployment'
-      | 'cws_policy'
-      | 'cws_policy_set'
-      | 'cws_workload'
-      | 'd1_database'
-      | 'durable_object_namespace'
-      | 'gateway_list'
-      | 'gateway_rule'
-      | 'image'
-      | 'infrastructure_target'
-      | 'kv_namespace'
-      | 'load_balancer_monitor'
-      | 'load_balancer_pool'
-      | 'pages_project'
-      | 'queue'
-      | 'r2_bucket'
-      | 'resource_share'
-      | 'stream_live_input'
-      | 'stream_video'
-      | 'vectorize_index'
-      | 'worker'
-      | 'worker_version';
+    resource_type: 'worker_version';
 
     /**
      * Body param: Worker ID is required only for worker_version resources

package/src/resources/resource-tagging/zone-tags.ts

@@ -3886,21 +3886,9 @@ export declare namespace ZoneTagUpdateParams {
     resource_id: string;
 
     /**
-     * Body param: Enum for base zone-level resource types (those with no extra
-     * required fields).
+     * Body param: Enum for access_application_policy resource type.
      */
-    resource_type:
-      | 'api_gateway_operation'
-      | 'custom_certificate'
-      | 'custom_hostname'
-      | 'dns_record'
-      | 'healthcheck'
-      | 'load_balancer'
-      | 'managed_client_certificate'
-      | 'worker_route'
-      | 'zone'
-      | 'zone_ruleset'
-      | 'access_application_policy';
+    resource_type: 'access_application_policy';
 
     /**
      * Body param: Contains key-value pairs of tags. Keys may contain at most 256

package/src/resources/rules/lists/items.ts

@@ -21,7 +21,7 @@ export class BaseItems extends APIResource {
   /**
    * Appends new items to the list.
    *
-   * This operation is asynchronous. To get current the operation status, invoke the
+   * This operation is asynchronous. To get the current operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
@@ -52,7 +52,7 @@ export class BaseItems extends APIResource {
    * Removes all existing items from the list and adds the provided items to the
    * list.
    *
-   * This operation is asynchronous. To get current the operation status, invoke the
+   * This operation is asynchronous. To get the current operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
@@ -109,7 +109,7 @@ export class BaseItems extends APIResource {
   /**
    * Removes one or more items from a list.
    *
-   * This operation is asynchronous. To get current the operation status, invoke the
+   * This operation is asynchronous. To get the current operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
    * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
@@ -598,7 +598,7 @@ export interface ItemDeleteParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: The list items to delete, identified by their unique IDs.
    */
   items?: Array<ItemDeleteParams.Item>;
 }

package/src/resources/rulesets/rulesets.ts

@@ -67,9 +67,6 @@ export class BaseRulesets extends APIResource {
    * @example
    * ```ts
    * const ruleset = await client.rulesets.create({
-   *   kind: 'root',
-   *   name: 'My ruleset',
-   *   phase: 'http_request_firewall_custom',
    *   account_id: 'account_id',
    * });
    * ```
@@ -5025,21 +5022,6 @@ export namespace RulesetGetResponse {
 }
 
 export interface RulesetCreateParams {
-  /**
-   * Body param: The kind of the ruleset.
-   */
-  kind: KindParam;
-
-  /**
-   * Body param: The human-readable name of the ruleset.
-   */
-  name: string;
-
-  /**
-   * Body param: The phase of the ruleset.
-   */
-  phase: PhaseParam;
-
   /**
    * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
    * Zone ID.
@@ -5064,6 +5046,21 @@ export interface RulesetCreateParams {
    */
   description?: string;
 
+  /**
+   * Body param: The kind of the ruleset.
+   */
+  kind?: KindParam;
+
+  /**
+   * Body param: The human-readable name of the ruleset.
+   */
+  name?: string;
+
+  /**
+   * Body param: The phase of the ruleset.
+   */
+  phase?: PhaseParam;
+
   /**
    * Body param: The list of rules in the ruleset.
    */

package/src/resources/shared.ts

@@ -269,7 +269,7 @@ export namespace ErrorData {
 
 export interface Identifier {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id?: string;
 }
@@ -365,9 +365,45 @@ export namespace Member {
        * Attributes associated to the permission group.
        */
       export interface Meta {
-        key?: string;
+        /**
+         * A category used to group permission groups.
+         */
+        category?: string;
 
-        value?: string;
+        /**
+         * Indicates whether the permission group is deprecated.
+         */
+        deprecated?: string;
+
+        /**
+         * Additional information about the permission group.
+         */
+        description?: string;
+
+        /**
+         * Indicates whether the permission group can be edited.
+         */
+        editable?: string;
+
+        /**
+         * The planned end-of-life date and time, when provided.
+         */
+        eol_at?: string;
+
+        /**
+         * A label identifying the permission group.
+         */
+        label?: string;
+
+        /**
+         * The scope associated with the permission group.
+         */
+        scopes?: string;
+
+        /**
+         * Indicates the permission group's availability or visibility.
+         */
+        visibility?: string;
       }
     }
 
@@ -826,6 +862,12 @@ export interface Token {
 
   condition?: Token.Condition;
 
+  /**
+   * The email address of the user who created the token at the time of creation.
+   * Only present for Account Owned API Tokens when a creator email was available.
+   */
+  creator_email_at_creation?: string;
+
   /**
    * The expiration time on or after which the JWT MUST NOT be accepted for
    * processing.
@@ -862,6 +904,19 @@ export interface Token {
    */
   policies?: Array<TokenPolicy>;
 
+  /**
+   * The identifier of the service that provisioned the token. For an
+   * OAuth-provisioned token, this is the OAuth client identifier. Present when
+   * `provisioner_type` is present and null when the identifier is unavailable.
+   */
+  provisioner_id?: string | null;
+
+  /**
+   * The type of service that provisioned the token. Only present for provisioned
+   * Account Owned API Tokens.
+   */
+  provisioner_type?: string;
+
   /**
    * Status of the token.
    */
@@ -953,9 +1008,45 @@ export namespace TokenPolicy {
      * Attributes associated to the permission group.
      */
     export interface Meta {
-      key?: string;
+      /**
+       * A category used to group permission groups.
+       */
+      category?: string;
 
-      value?: string;
+      /**
+       * Indicates whether the permission group is deprecated.
+       */
+      deprecated?: string;
+
+      /**
+       * Additional information about the permission group.
+       */
+      description?: string;
+
+      /**
+       * Indicates whether the permission group can be edited.
+       */
+      editable?: string;
+
+      /**
+       * The planned end-of-life date and time, when provided.
+       */
+      eol_at?: string;
+
+      /**
+       * A label identifying the permission group.
+       */
+      label?: string;
+
+      /**
+       * The scope associated with the permission group.
+       */
+      scopes?: string;
+
+      /**
+       * Indicates the permission group's availability or visibility.
+       */
+      visibility?: string;
     }
   }
 }
@@ -999,9 +1090,45 @@ export namespace TokenPolicyParam {
      * Attributes associated to the permission group.
      */
     export interface Meta {
-      key?: string;
+      /**
+       * A category used to group permission groups.
+       */
+      category?: string;
+
+      /**
+       * Indicates whether the permission group is deprecated.
+       */
+      deprecated?: string;
+
+      /**
+       * Additional information about the permission group.
+       */
+      description?: string;
 
-      value?: string;
+      /**
+       * Indicates whether the permission group can be edited.
+       */
+      editable?: string;
+
+      /**
+       * The planned end-of-life date and time, when provided.
+       */
+      eol_at?: string;
+
+      /**
+       * A label identifying the permission group.
+       */
+      label?: string;
+
+      /**
+       * The scope associated with the permission group.
+       */
+      scopes?: string;
+
+      /**
+       * Indicates the permission group's availability or visibility.
+       */
+      visibility?: string;
     }
   }
 }