cloudflare 7.2.0 → 7.3.0

package/src/resources/ssl/certificate-packs/certificate-packs.ts

@@ -83,7 +83,7 @@ export class BaseCertificatePacks extends APIResource {
    * ```ts
    * const certificatePack =
    *   await client.ssl.certificatePacks.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '3822ff90-ea29-44df-9e55-21300bb9419b',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -110,7 +110,7 @@ export class BaseCertificatePacks extends APIResource {
    * @example
    * ```ts
    * const response = await client.ssl.certificatePacks.edit(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '3822ff90-ea29-44df-9e55-21300bb9419b',
    *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -136,7 +136,7 @@ export class BaseCertificatePacks extends APIResource {
    * ```ts
    * const certificatePack =
    *   await client.ssl.certificatePacks.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '3822ff90-ea29-44df-9e55-21300bb9419b',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -212,7 +212,7 @@ export type ValidationMethod = 'http' | 'cname' | 'txt';
  */
 export interface CertificatePackCreateResponse {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id: string;
 
@@ -476,7 +476,7 @@ export namespace CertificatePackCreateResponse {
  */
 export interface CertificatePackListResponse {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id: string;
 
@@ -737,7 +737,7 @@ export namespace CertificatePackListResponse {
 
 export interface CertificatePackDeleteResponse {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id?: string;
 }
@@ -747,7 +747,7 @@ export interface CertificatePackDeleteResponse {
  */
 export interface CertificatePackEditResponse {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id: string;
 
@@ -1011,7 +1011,7 @@ export namespace CertificatePackEditResponse {
  */
 export interface CertificatePackGetResponse {
   /**
-   * Identifier.
+   * The unique identifier for a certificate_pack.
    */
   id: string;
 

package/src/resources/tenants/account-types.ts

@@ -12,7 +12,7 @@ export class BaseAccountTypes extends APIResource {
   ] as const);
 
   /**
-   * List of account types available for the Tenant to provision accounts.
+   * Lists the account types this tenant is allowed to provision.
    */
   list(
     tenantID: string,

package/src/resources/tenants/accounts.ts

@@ -12,7 +12,7 @@ export class BaseAccounts extends APIResource {
   ] as const);
 
   /**
-   * List of accounts for the Tenant.
+   * Lists the Cloudflare accounts associated with this tenant.
    */
   list(tenantID: string, options?: RequestOptions): PagePromise<TenantAccountsSinglePage, TenantAccount> {
     return this._client.getAPIList(path`/tenants/${tenantID}/accounts`, SinglePage<TenantAccount>, options);

package/src/resources/tenants/entitlements.ts

@@ -12,7 +12,8 @@ export class BaseEntitlements extends APIResource {
   ] as const);
 
   /**
-   * List of innate entitlements available for the Tenant.
+   * Retrieves the innate and custom entitlement allocations available to this
+   * tenant.
    */
   get(tenantID: string, options?: RequestOptions): APIPromise<TenantEntitlements> {
     return (

package/src/resources/tenants/memberships.ts

@@ -12,7 +12,7 @@ export class BaseMemberships extends APIResource {
   ] as const);
 
   /**
-   * List of active members (Cloudflare users) for the Tenant.
+   * Lists active Cloudflare users with memberships in this tenant.
    */
   list(
     tenantID: string,

package/src/resources/tenants/tenants.ts

@@ -22,7 +22,8 @@ export class BaseTenants extends APIResource {
   static override readonly _key: readonly ['tenants'] = Object.freeze(['tenants'] as const);
 
   /**
-   * Retrieves a Tenant by Tenant ID.
+   * Retrieves a tenant's identity, status, metadata, contacts, and organizational
+   * units.
    */
   get(tenantID: string, options?: RequestOptions): APIPromise<Tenant> {
     return (

package/src/resources/turnstile/widgets.ts

@@ -13,7 +13,7 @@ export class BaseWidgets extends APIResource {
   ] as const);
 
   /**
-   * Lists challenge widgets.
+   * Creates a Turnstile widget for an account.
    *
    * @example
    * ```ts
@@ -41,7 +41,7 @@ export class BaseWidgets extends APIResource {
   }
 
   /**
-   * Update the configuration of a widget.
+   * Updates the configuration of a Turnstile widget.
    *
    * @example
    * ```ts
@@ -71,7 +71,7 @@ export class BaseWidgets extends APIResource {
   }
 
   /**
-   * Lists all turnstile widgets of an account.
+   * Lists Turnstile widgets for an account.
    *
    * @example
    * ```ts
@@ -96,7 +96,7 @@ export class BaseWidgets extends APIResource {
   }
 
   /**
-   * Destroy a Turnstile Widget.
+   * Deletes a Turnstile widget from an account.
    *
    * @example
    * ```ts
@@ -117,7 +117,7 @@ export class BaseWidgets extends APIResource {
   }
 
   /**
-   * Show a single challenge widget configuration.
+   * Returns the configuration of a Turnstile widget.
    *
    * @example
    * ```ts
@@ -137,8 +137,8 @@ export class BaseWidgets extends APIResource {
   }
 
   /**
-   * Generate a new secret key for this widget. If `invalidate_immediately` is set to
-   * `false`, the previous secret remains valid for 2 hours.
+   * Generates a new secret key for this widget. If `invalidate_immediately` is set
+   * to `false`, the previous secret remains valid for 2 hours.
    *
    * Note that secrets cannot be rotated again during the grace period.
    *
@@ -229,7 +229,7 @@ export interface Widget {
   secret: string;
 
   /**
-   * Widget item identifier tag.
+   * Unique identifier for a Turnstile widget.
    */
   sitekey: string;
 
@@ -316,7 +316,7 @@ export interface WidgetListResponse {
   region: 'world' | 'china';
 
   /**
-   * Widget item identifier tag.
+   * Unique identifier for a Turnstile widget.
    */
   sitekey: string;
 
@@ -364,8 +364,8 @@ export interface WidgetCreateParams {
   direction?: 'asc' | 'desc';
 
   /**
-   * Query param: Filter widgets by field using case-insensitive substring matching.
-   * Format: `field:value`
+   * Query param: Filter widgets by field. The `name` field uses case-insensitive
+   * substring matching; `sitekey` uses exact matching. Format: `field:value`
    *
    * Supported fields:
    *
@@ -487,8 +487,8 @@ export interface WidgetListParams extends V4PagePaginationArrayParams {
   direction?: 'asc' | 'desc';
 
   /**
-   * Query param: Filter widgets by field using case-insensitive substring matching.
-   * Format: `field:value`
+   * Query param: Filter widgets by field. The `name` field uses case-insensitive
+   * substring matching; `sitekey` uses exact matching. Format: `field:value`
    *
    * Supported fields:
    *

package/src/resources/user/tokens/permission-groups.ts

@@ -61,6 +61,11 @@ export interface PermissionGroupListResponse {
     | 'account_and_billing'
     | 'other';
 
+  /**
+   * Whether the caller can select this permission group when creating a token.
+   */
+  is_selectable?: boolean;
+
   /**
    * Permission Group Name
    */

package/src/resources/user/tokens/tokens.ts

@@ -39,7 +39,10 @@ export class BaseTokens extends APIResource {
    *         { id: 'c8fed203ed3043cba015a93ad1616f1f' },
    *         { id: '82e64a83756745bbbb1c9c2701bf816b' },
    *       ],
-   *       resources: { foo: 'string' },
+   *       resources: {
+   *         'com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43':
+   *           '*',
+   *       },
    *     },
    *   ],
    * });
@@ -67,7 +70,10 @@ export class BaseTokens extends APIResource {
    *           { id: 'c8fed203ed3043cba015a93ad1616f1f' },
    *           { id: '82e64a83756745bbbb1c9c2701bf816b' },
    *         ],
-   *         resources: { foo: 'string' },
+   *         resources: {
+   *           'com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43':
+   *             '*',
+   *         },
    *       },
    *     ],
    *   },
@@ -167,6 +173,12 @@ export interface TokenCreateResponse {
 
   condition?: TokenCreateResponse.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.
@@ -203,6 +215,19 @@ export interface TokenCreateResponse {
    */
   policies?: Array<Shared.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.
    */

package/src/resources/vectorize/indexes/indexes.ts

@@ -312,7 +312,7 @@ export class Indexes extends BaseIndexes {
 export type CreateIndicesSinglePage = SinglePage<CreateIndex>;
 
 export interface CreateIndex {
-  config?: IndexDimensionConfiguration;
+  config?: CreateIndex.Config;
 
   /**
    * Specifies the timestamp the resource was created as an ISO8601 string.
@@ -332,6 +332,30 @@ export interface CreateIndex {
   name?: string;
 }
 
+export namespace CreateIndex {
+  export interface Config {
+    /**
+     * Specifies the number of dimensions for the index
+     */
+    dimensions: number;
+
+    /**
+     * Specifies the type of metric to use calculating distance.
+     */
+    metric: 'cosine' | 'euclidean' | 'dot-product';
+
+    /**
+     * Specifies the preset to use for the index.
+     */
+    preset?:
+      | '@cf/baai/bge-small-en-v1.5'
+      | '@cf/baai/bge-base-en-v1.5'
+      | '@cf/baai/bge-large-en-v1.5'
+      | 'openai/text-embedding-ada-002'
+      | 'cohere/embed-multilingual-v2.0';
+  }
+}
+
 export interface IndexDeleteVectorsByID {
   /**
    * The count of the vectors successfully deleted.

package/src/resources/workers/beta/workers/versions.ts

@@ -184,6 +184,7 @@ export interface Version {
     | Version.WorkersBindingKindAISearchNamespace
     | Version.WorkersBindingKindMessaging
     | Version.WorkersBindingKindAnalyticsEngine
+    | Version.WorkersBindingKindArtifacts
     | Version.WorkersBindingKindAssets
     | Version.WorkersBindingKindBrowser
     | Version.WorkersBindingKindD1
@@ -510,6 +511,26 @@ export namespace Version {
     type: 'analytics_engine';
   }
 
+  export interface WorkersBindingKindArtifacts {
+    /**
+     * A JavaScript variable name for the binding.
+     */
+    name: string;
+
+    /**
+     * The Artifacts namespace exposed to the Worker in the Worker's account. Must be
+     * 2-63 characters, start with an ASCII alphanumeric character, contain only ASCII
+     * alphanumeric characters, dots, underscores, and hyphens, and must not end with a
+     * hyphen. The namespace does not need to be created before binding it.
+     */
+    namespace: string;
+
+    /**
+     * The kind of resource that the binding provides.
+     */
+    type: 'artifacts';
+  }
+
   export interface WorkersBindingKindAssets {
     /**
      * A JavaScript variable name for the binding.
@@ -1890,6 +1911,7 @@ export interface VersionCreateParams {
     | VersionCreateParams.WorkersBindingKindAISearchNamespace
     | VersionCreateParams.WorkersBindingKindMessaging
     | VersionCreateParams.WorkersBindingKindAnalyticsEngine
+    | VersionCreateParams.WorkersBindingKindArtifacts
     | VersionCreateParams.WorkersBindingKindAssets
     | VersionCreateParams.WorkersBindingKindBrowser
     | VersionCreateParams.WorkersBindingKindD1
@@ -2187,6 +2209,26 @@ export namespace VersionCreateParams {
     type: 'analytics_engine';
   }
 
+  export interface WorkersBindingKindArtifacts {
+    /**
+     * A JavaScript variable name for the binding.
+     */
+    name: string;
+
+    /**
+     * The Artifacts namespace exposed to the Worker in the Worker's account. Must be
+     * 2-63 characters, start with an ASCII alphanumeric character, contain only ASCII
+     * alphanumeric characters, dots, underscores, and hyphens, and must not end with a
+     * hyphen. The namespace does not need to be created before binding it.
+     */
+    namespace: string;
+
+    /**
+     * The kind of resource that the binding provides.
+     */
+    type: 'artifacts';
+  }
+
   export interface WorkersBindingKindAssets {
     /**
      * A JavaScript variable name for the binding.

package/src/resources/workers/observability/shared-queries.ts

@@ -629,12 +629,32 @@ export namespace SharedQueryGetResponse {
 
   export namespace Calculation {
     export interface Aggregate {
+      /**
+       * Estimated number of matching events: the sum of the sample intervals of the
+       * stored events. It equals the number of stored events when sampleInterval is 1.
+       */
       count: number;
 
+      /**
+       * @deprecated Deprecated alias of sampleInterval. Always has the same value; use
+       * sampleInterval instead.
+       */
       interval: number;
 
+      /**
+       * Average sample interval of the matched events. Each stored event has a sample
+       * interval of 1 / (the sampling rate applied when it was ingested): the Worker's
+       * head_sampling_rate multiplied by any platform sampling applied to the account or
+       * script. A value of 1 means none of the matched events were sampled. A value
+       * above 1 means count and value are estimated from sampled data, not exact. This
+       * is independent of statistics.abr_level.
+       */
       sampleInterval: number;
 
+      /**
+       * Result of the calculation. count, sum, avg, median, and percentiles are weighted
+       * by each event's sample interval
+       */
       value: number;
 
       groups?: Array<Aggregate.Group>;
@@ -656,12 +676,32 @@ export namespace SharedQueryGetResponse {
 
     export namespace Series {
       export interface Data {
+        /**
+         * Estimated number of matching events: the sum of the sample intervals of the
+         * stored events. It equals the number of stored events when sampleInterval is 1.
+         */
         count: number;
 
+        /**
+         * @deprecated Deprecated alias of sampleInterval. Always has the same value; use
+         * sampleInterval instead.
+         */
         interval: number;
 
+        /**
+         * Average sample interval of the matched events. Each stored event has a sample
+         * interval of 1 / (the sampling rate applied when it was ingested): the Worker's
+         * head_sampling_rate multiplied by any platform sampling applied to the account or
+         * script. A value of 1 means none of the matched events were sampled. A value
+         * above 1 means count and value are estimated from sampled data, not exact. This
+         * is independent of statistics.abr_level.
+         */
         sampleInterval: number;
 
+        /**
+         * Result of the calculation. count, sum, avg, median, and percentiles are weighted
+         * by each event's sample interval
+         */
         value: number;
 
         firstSeen?: string;
@@ -693,12 +733,32 @@ export namespace SharedQueryGetResponse {
 
   export namespace Compare {
     export interface Aggregate {
+      /**
+       * Estimated number of matching events: the sum of the sample intervals of the
+       * stored events. It equals the number of stored events when sampleInterval is 1.
+       */
       count: number;
 
+      /**
+       * @deprecated Deprecated alias of sampleInterval. Always has the same value; use
+       * sampleInterval instead.
+       */
       interval: number;
 
+      /**
+       * Average sample interval of the matched events. Each stored event has a sample
+       * interval of 1 / (the sampling rate applied when it was ingested): the Worker's
+       * head_sampling_rate multiplied by any platform sampling applied to the account or
+       * script. A value of 1 means none of the matched events were sampled. A value
+       * above 1 means count and value are estimated from sampled data, not exact. This
+       * is independent of statistics.abr_level.
+       */
       sampleInterval: number;
 
+      /**
+       * Result of the calculation. count, sum, avg, median, and percentiles are weighted
+       * by each event's sample interval
+       */
       value: number;
 
       groups?: Array<Aggregate.Group>;
@@ -720,12 +780,32 @@ export namespace SharedQueryGetResponse {
 
     export namespace Series {
       export interface Data {
+        /**
+         * Estimated number of matching events: the sum of the sample intervals of the
+         * stored events. It equals the number of stored events when sampleInterval is 1.
+         */
         count: number;
 
+        /**
+         * @deprecated Deprecated alias of sampleInterval. Always has the same value; use
+         * sampleInterval instead.
+         */
         interval: number;
 
+        /**
+         * Average sample interval of the matched events. Each stored event has a sample
+         * interval of 1 / (the sampling rate applied when it was ingested): the Worker's
+         * head_sampling_rate multiplied by any platform sampling applied to the account or
+         * script. A value of 1 means none of the matched events were sampled. A value
+         * above 1 means count and value are estimated from sampled data, not exact. This
+         * is independent of statistics.abr_level.
+         */
         sampleInterval: number;
 
+        /**
+         * Result of the calculation. count, sum, avg, median, and percentiles are weighted
+         * by each event's sample interval
+         */
         value: number;
 
         firstSeen?: string;
@@ -1168,10 +1248,26 @@ export namespace SharedQueryGetResponse {
       export interface Data {
         aggregates: Data.Aggregates;
 
+        /**
+         * Estimated number of matching events: the sum of the sample intervals of the
+         * stored events. It equals the number of stored events when sampleInterval is 1.
+         */
         count: number;
 
+        /**
+         * @deprecated Deprecated alias of sampleInterval. Always has the same value; use
+         * sampleInterval instead.
+         */
         interval: number;
 
+        /**
+         * Average sample interval of the matched events. Each stored event has a sample
+         * interval of 1 / (the sampling rate applied when it was ingested): the Worker's
+         * head_sampling_rate multiplied by any platform sampling applied to the account or
+         * script. A value of 1 means none of the matched events were sampled. A value
+         * above 1 means count and value are estimated from sampled data, not exact. This
+         * is independent of statistics.abr_level.
+         */
         sampleInterval: number;
 
         errors?: number;