cloudflare 7.2.0 → 7.3.0

package/src/resources/r2/buckets/event-notifications.ts

@@ -14,7 +14,10 @@ export class BaseEventNotifications extends APIResource {
   ] as const);
 
   /**
-   * Create event notification rule.
+   * Creates rules that send notifications for matching R2 object events to the
+   * specified Cloudflare Queue. Rules can filter objects by key prefix and suffix.
+   * New rules are added to any existing rules for the queue; a rule that overlaps an
+   * existing rule is rejected.
    *
    * @example
    * ```ts
@@ -55,7 +58,8 @@ export class BaseEventNotifications extends APIResource {
   }
 
   /**
-   * List all event notification rules for a bucket.
+   * Lists event notification rules for an R2 bucket, grouped by the Cloudflare Queue
+   * that receives matching object events.
    *
    * @example
    * ```ts
@@ -88,8 +92,9 @@ export class BaseEventNotifications extends APIResource {
   }
 
   /**
-   * Delete an event notification rule. **If no body is provided, all rules for
-   * specified queue will be deleted**.
+   * Deletes the specified event notification rules for an R2 bucket and Cloudflare
+   * Queue. Provide ruleIds in the request body to select rules. If no body is
+   * provided, all rules for that bucket and queue are deleted.
    *
    * @example
    * ```ts
@@ -128,7 +133,8 @@ export class BaseEventNotifications extends APIResource {
   }
 
   /**
-   * Get a single event notification rule.
+   * Gets the event notification rules for the specified R2 bucket and Cloudflare
+   * Queue. The response includes the queue's configuration and its array of rules.
    *
    * @example
    * ```ts
@@ -290,7 +296,7 @@ export namespace EventNotificationGetResponse {
 
 export interface EventNotificationUpdateParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -340,7 +346,7 @@ export namespace EventNotificationUpdateParams {
 
 export interface EventNotificationListParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -353,7 +359,7 @@ export interface EventNotificationListParams {
 
 export interface EventNotificationDeleteParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -371,7 +377,7 @@ export interface EventNotificationDeleteParams {
 
 export interface EventNotificationGetParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 

package/src/resources/r2/buckets/lifecycle.ts

@@ -14,7 +14,9 @@ export class BaseLifecycle extends APIResource {
   ] as const);
 
   /**
-   * Set the object lifecycle rules for a bucket.
+   * Replaces the object lifecycle rules for an R2 bucket. Rules match object-key
+   * prefixes and can expire objects, abort incomplete multipart uploads, or
+   * transition objects to Infrequent Access storage.
    *
    * @example
    * ```ts
@@ -226,7 +228,7 @@ export namespace LifecycleGetResponse {
 
 export interface LifecycleUpdateParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -382,7 +384,7 @@ export namespace LifecycleUpdateParams {
 
 export interface LifecycleGetParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 

package/src/resources/r2/buckets/locks.ts

@@ -14,7 +14,9 @@ export class BaseLocks extends APIResource {
   ] as const);
 
   /**
-   * Set lock rules for a bucket.
+   * Replaces the lock rules for an R2 bucket. Enabled rules prevent matching objects
+   * from being overwritten or deleted for a duration, until a date, or indefinitely.
+   * Rules apply to existing and newly uploaded objects.
    *
    * @example
    * ```ts
@@ -139,7 +141,7 @@ export namespace LockGetResponse {
 
 export interface LockUpdateParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -212,7 +214,7 @@ export namespace LockUpdateParams {
 
 export interface LockGetParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 

package/src/resources/r2/buckets/metrics.ts

@@ -167,7 +167,7 @@ export namespace MetricListResponse {
 
 export interface MetricListParams {
   /**
-   * Account ID.
+   * Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 }

package/src/resources/r2/buckets/objects.ts

@@ -335,7 +335,7 @@ export interface ObjectUploadResponse {
 
 export interface ObjectListParams extends CursorPaginationParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -367,7 +367,7 @@ export interface ObjectListParams extends CursorPaginationParams {
 
 export interface ObjectDeleteParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -385,7 +385,7 @@ export interface ObjectDeleteParams {
 
 export interface ObjectGetParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -416,7 +416,7 @@ export interface ObjectGetParams {
 
 export interface ObjectUploadParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 

package/src/resources/r2/buckets/sippy.ts

@@ -15,7 +15,9 @@ export class BaseSippyResource extends APIResource {
   ] as const);
 
   /**
-   * Sets configuration for Sippy for an existing R2 bucket.
+   * Configures and enables Sippy on-demand migration for an R2 bucket. When a
+   * requested object is missing from R2, Sippy serves it from the configured source
+   * storage provider and copies it to R2.
    *
    * @example
    * ```ts
@@ -44,7 +46,9 @@ export class BaseSippyResource extends APIResource {
   }
 
   /**
-   * Disables Sippy on this bucket.
+   * Disables Sippy on-demand migration for an R2 bucket. Requests no longer fetch
+   * missing objects from the source storage provider. Objects already copied to R2
+   * remain in the bucket.
    *
    * @example
    * ```ts
@@ -187,7 +191,7 @@ export type SippyUpdateParams =
 export declare namespace SippyUpdateParams {
   export interface R2EnableSippyAws {
     /**
-     * Path param: Account ID.
+     * Path param: Cloudflare account ID that owns the R2 resource.
      */
     account_id: string;
 
@@ -253,7 +257,7 @@ export declare namespace SippyUpdateParams {
       provider?: 'aws';
 
       /**
-       * Name of the AWS availability zone.
+       * AWS region containing the source S3 bucket.
        */
       region?: string;
 
@@ -266,7 +270,7 @@ export declare namespace SippyUpdateParams {
 
   export interface R2EnableSippyGcs {
     /**
-     * Path param: Account ID.
+     * Path param: Cloudflare account ID that owns the R2 resource.
      */
     account_id: string;
 
@@ -340,7 +344,7 @@ export declare namespace SippyUpdateParams {
 
   export interface R2EnableSippyS3 {
     /**
-     * Path param: Account ID.
+     * Path param: Cloudflare account ID that owns the R2 resource.
      */
     account_id: string;
 
@@ -414,7 +418,7 @@ export declare namespace SippyUpdateParams {
 
   export interface R2EnableSippyAzure {
     /**
-     * Path param: Account ID.
+     * Path param: Cloudflare account ID that owns the R2 resource.
      */
     account_id: string;
 
@@ -495,7 +499,7 @@ export declare namespace SippyUpdateParams {
 
 export interface SippyDeleteParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -508,7 +512,7 @@ export interface SippyDeleteParams {
 
 export interface SippyGetParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 

package/src/resources/r2/temporary-credentials.ts

@@ -49,7 +49,8 @@ export interface TemporaryCredential {
   bucket: string;
 
   /**
-   * The parent access key id to use for signing.
+   * Access key ID of the parent R2 API token. The temporary credentials cannot
+   * exceed this token's permissions.
    */
   parentAccessKeyId: string;
 
@@ -59,7 +60,7 @@ export interface TemporaryCredential {
   permission: 'admin-read-write' | 'admin-read-only' | 'object-read-write' | 'object-read-only';
 
   /**
-   * How long the credentials will live for in seconds.
+   * Lifetime of the temporary credentials in seconds, up to 604800 seconds (7 days).
    */
   ttlSeconds: number;
 
@@ -93,7 +94,7 @@ export interface TemporaryCredentialCreateResponse {
 
 export interface TemporaryCredentialCreateParams {
   /**
-   * Path param: Account ID.
+   * Path param: Cloudflare account ID that owns the R2 resource.
    */
   account_id: string;
 
@@ -103,7 +104,8 @@ export interface TemporaryCredentialCreateParams {
   bucket: string;
 
   /**
-   * Body param: The parent access key id to use for signing.
+   * Body param: Access key ID of the parent R2 API token. The temporary credentials
+   * cannot exceed this token's permissions.
    */
   parentAccessKeyId: string;
 
@@ -113,7 +115,8 @@ export interface TemporaryCredentialCreateParams {
   permission: 'admin-read-write' | 'admin-read-only' | 'object-read-write' | 'object-read-only';
 
   /**
-   * Body param: How long the credentials will live for in seconds.
+   * Body param: Lifetime of the temporary credentials in seconds, up to 604800
+   * seconds (7 days).
    */
   ttlSeconds: number;
 

package/src/resources/r2-data-catalog/credentials.ts

@@ -15,17 +15,7 @@ export class BaseCredentials extends APIResource {
    * Store authentication credentials for a catalog. These credentials are used to
    * authenticate with R2 storage when performing catalog operations.
    *
-   * @example
-   * ```ts
-   * const credential =
-   *   await client.r2DataCatalog.credentials.create(
-   *     'my-data-bucket',
-   *     {
-   *       account_id: '0123456789abcdef0123456789abcdef',
-   *       token: 'your-cloudflare-api-token-here',
-   *     },
-   *   );
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/credential` instead.
    */
   create(
     bucketName: string,

package/src/resources/r2-data-catalog/maintenance-configs.ts

@@ -15,25 +15,7 @@ export class BaseMaintenanceConfigs extends APIResource {
    * Update the maintenance configuration for a catalog. This allows you to enable or
    * disable compaction and adjust target file sizes for optimization.
    *
-   * @example
-   * ```ts
-   * const maintenanceConfig =
-   *   await client.r2DataCatalog.maintenanceConfigs.update(
-   *     'my-data-bucket',
-   *     {
-   *       account_id: '0123456789abcdef0123456789abcdef',
-   *       compaction: {
-   *         state: 'enabled',
-   *         target_size_mb: '256',
-   *       },
-   *       snapshot_expiration: {
-   *         max_snapshot_age: '14d',
-   *         min_snapshots_to_keep: 5,
-   *         state: 'enabled',
-   *       },
-   *     },
-   *   );
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/maintenance-configs` instead.
    */
   update(
     bucketName: string,
@@ -53,14 +35,7 @@ export class BaseMaintenanceConfigs extends APIResource {
    * Retrieve the maintenance configuration for a specific catalog, including
    * compaction settings and credential status.
    *
-   * @example
-   * ```ts
-   * const maintenanceConfig =
-   *   await client.r2DataCatalog.maintenanceConfigs.get(
-   *     'my-data-bucket',
-   *     { account_id: '0123456789abcdef0123456789abcdef' },
-   *   );
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog/{bucket_name}/maintenance-configs` instead.
    */
   get(
     bucketName: string,
@@ -238,12 +213,12 @@ export namespace MaintenanceConfigUpdateParams {
    */
   export interface Compaction {
     /**
-     * Updates the state optionally.
+     * Specifies the state of maintenance operations.
      */
     state?: 'enabled' | 'disabled';
 
     /**
-     * Updates the target file size optionally.
+     * Sets the target file size for compaction in megabytes. Defaults to "128".
      */
     target_size_mb?: '64' | '128' | '256' | '512';
   }
@@ -263,7 +238,7 @@ export namespace MaintenanceConfigUpdateParams {
     min_snapshots_to_keep?: number;
 
     /**
-     * Updates the state optionally.
+     * Specifies the state of maintenance operations.
      */
     state?: 'enabled' | 'disabled';
   }

package/src/resources/r2-data-catalog/namespaces/namespaces.ts

@@ -17,14 +17,7 @@ export class BaseNamespaces extends APIResource {
    * Returns a list of namespaces in the specified R2 catalog. Supports hierarchical
    * filtering and pagination for efficient traversal of large namespace hierarchies.
    *
-   * @example
-   * ```ts
-   * const namespaces =
-   *   await client.r2DataCatalog.namespaces.list(
-   *     'my-data-bucket',
-   *     { account_id: '0123456789abcdef0123456789abcdef' },
-   *   );
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces` instead.
    */
   list(
     bucketName: string,

package/src/resources/r2-data-catalog/namespaces/tables/maintenance-configs.ts

@@ -13,27 +13,7 @@ export class BaseMaintenanceConfigs extends APIResource {
    * Update the maintenance configuration for a specific table. This allows you to
    * enable or disable compaction and adjust target file sizes for optimization.
    *
-   * @example
-   * ```ts
-   * const maintenanceConfig =
-   *   await client.r2DataCatalog.namespaces.tables.maintenanceConfigs.update(
-   *     'my_table',
-   *     {
-   *       account_id: '0123456789abcdef0123456789abcdef',
-   *       bucket_name: 'my-data-bucket',
-   *       namespace: 'my_namespace%1Fsub_namespace',
-   *       compaction: {
-   *         state: 'enabled',
-   *         target_size_mb: '256',
-   *       },
-   *       snapshot_expiration: {
-   *         max_snapshot_age: '14d',
-   *         min_snapshots_to_keep: 5,
-   *         state: 'enabled',
-   *       },
-   *     },
-   *   );
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs` instead.
    */
   update(
     tableName: string,
@@ -53,18 +33,7 @@ export class BaseMaintenanceConfigs extends APIResource {
    * Retrieve the maintenance configuration for a specific table, including
    * compaction settings.
    *
-   * @example
-   * ```ts
-   * const maintenanceConfig =
-   *   await client.r2DataCatalog.namespaces.tables.maintenanceConfigs.get(
-   *     'my_table',
-   *     {
-   *       account_id: '0123456789abcdef0123456789abcdef',
-   *       bucket_name: 'my-data-bucket',
-   *       namespace: 'my_namespace%1Fsub_namespace',
-   *     },
-   *   );
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs` instead.
    */
   get(
     tableName: string,
@@ -275,7 +244,7 @@ export namespace MaintenanceConfigUpdateParams {
     min_snapshots_to_keep?: number;
 
     /**
-     * Updates the state optionally.
+     * Specifies the state of maintenance operations.
      */
     state?: 'enabled' | 'disabled';
   }

package/src/resources/r2-data-catalog/namespaces/tables/tables.ts

@@ -25,17 +25,7 @@ export class BaseTables extends APIResource {
    * Returns a list of tables in the specified namespace within an R2 catalog.
    * Supports pagination for efficient traversal of large table collections.
    *
-   * @example
-   * ```ts
-   * const tables =
-   *   await client.r2DataCatalog.namespaces.tables.list(
-   *     'bronze',
-   *     {
-   *       account_id: '0123456789abcdef0123456789abcdef',
-   *       bucket_name: 'my-data-bucket',
-   *     },
-   *   );
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog/{bucket_name}/namespaces/{namespace}/tables` instead.
    */
   list(namespace: string, params: TableListParams, options?: RequestOptions): APIPromise<TableListResponse> {
     const { account_id, bucket_name, ...query } = params;

package/src/resources/r2-data-catalog/r2-data-catalog.ts

@@ -37,12 +37,7 @@ export class BaseR2DataCatalog extends APIResource {
    * for the specified account. Each catalog represents an R2 bucket configured to
    * store Iceberg metadata and data files.
    *
-   * @example
-   * ```ts
-   * const r2DataCatalogs = await client.r2DataCatalog.list({
-   *   account_id: '0123456789abcdef0123456789abcdef',
-   * });
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog` instead.
    */
   list(params: R2DataCatalogListParams, options?: RequestOptions): APIPromise<R2DataCatalogListResponse> {
     const { account_id } = params;
@@ -58,12 +53,7 @@ export class BaseR2DataCatalog extends APIResource {
    * Set force=true to remove catalog namespaces, tables, views, and maintenance
    * metadata. Force deletion is limited to a configured catalog object count.
    *
-   * @example
-   * ```ts
-   * await client.r2DataCatalog.delete('my-data-bucket', {
-   *   account_id: '0123456789abcdef0123456789abcdef',
-   * });
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/delete` instead.
    */
   delete(bucketName: string, params: R2DataCatalogDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { account_id, force } = params;
@@ -78,12 +68,7 @@ export class BaseR2DataCatalog extends APIResource {
    * Disable an R2 bucket as a catalog. This operation deactivates the catalog but
    * preserves existing metadata and data files. The catalog can be re-enabled later.
    *
-   * @example
-   * ```ts
-   * await client.r2DataCatalog.disable('my-data-bucket', {
-   *   account_id: '0123456789abcdef0123456789abcdef',
-   * });
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/disable` instead.
    */
   disable(
     bucketName: string,
@@ -102,13 +87,7 @@ export class BaseR2DataCatalog extends APIResource {
    * necessary catalog infrastructure and activates the bucket for storing Iceberg
    * metadata and data files.
    *
-   * @example
-   * ```ts
-   * const response = await client.r2DataCatalog.enable(
-   *   'my-data-bucket',
-   *   { account_id: '0123456789abcdef0123456789abcdef' },
-   * );
-   * ```
+   * @deprecated Use `POST /accounts/{account_id}/basin-catalog/{bucket_name}/enable` instead.
    */
   enable(
     bucketName: string,
@@ -128,13 +107,7 @@ export class BaseR2DataCatalog extends APIResource {
    * Retrieve detailed information about a specific R2 catalog by bucket name.
    * Returns catalog status, maintenance configuration, and credential status.
    *
-   * @example
-   * ```ts
-   * const r2DataCatalog = await client.r2DataCatalog.get(
-   *   'my-data-bucket',
-   *   { account_id: '0123456789abcdef0123456789abcdef' },
-   * );
-   * ```
+   * @deprecated Use `GET /accounts/{account_id}/basin-catalog/{bucket_name}` instead.
    */
   get(
     bucketName: string,

package/src/resources/radar/ai/to-markdown.ts

@@ -15,7 +15,9 @@ export class BaseToMarkdown extends APIResource {
   ] as const);
 
   /**
-   * Converts uploaded files into Markdown format using Workers AI.
+   * Converts files uploaded as multipart form data into Markdown using Workers AI.
+   * Returns a conversion result for each file. Use the supported-formats endpoint to
+   * check accepted file types.
    *
    * @deprecated Use [AI > To Markdown](https://developers.cloudflare.com/api/resources/ai/subresources/to_markdown/) instead.
    */
@@ -49,12 +51,12 @@ export interface ToMarkdownCreateResponse {
 
 export interface ToMarkdownCreateParams {
   /**
-   * Path param
+   * Path param: Cloudflare account ID used for this AI model request.
    */
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Files to convert, supplied as multipart file uploads.
    */
   files: Array<Uploadable>;
 }

package/src/resources/registrar/api.md

@@ -6,11 +6,13 @@ Types:
 - <code><a href="./src/resources/registrar/registrar.ts">WorkflowStatus</a></code>
 - <code><a href="./src/resources/registrar/registrar.ts">RegistrarCheckResponse</a></code>
 - <code><a href="./src/resources/registrar/registrar.ts">RegistrarSearchResponse</a></code>
+- <code><a href="./src/resources/registrar/registrar.ts">RegistrarTransferCheckResponse</a></code>
 
 Methods:
 
 - <code title="post /accounts/{account_id}/registrar/domain-check">client.registrar.<a href="./src/resources/registrar/registrar.ts">check</a>({ ...params }) -> RegistrarCheckResponse</code>
 - <code title="get /accounts/{account_id}/registrar/domain-search">client.registrar.<a href="./src/resources/registrar/registrar.ts">search</a>({ ...params }) -> RegistrarSearchResponse</code>
+- <code title="post /accounts/{account_id}/registrar/domain-transfer-check">client.registrar.<a href="./src/resources/registrar/registrar.ts">transferCheck</a>({ ...params }) -> RegistrarTransferCheckResponse</code>
 
 ## Domains