cloudflare 7.2.0 → 7.3.0

package/src/resources/workers/observability/telemetry.ts

@@ -717,12 +717,32 @@ export namespace TelemetryQueryResponse {
 
   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>;
@@ -744,12 +764,32 @@ export namespace TelemetryQueryResponse {
 
     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;
@@ -781,12 +821,32 @@ export namespace TelemetryQueryResponse {
 
   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>;
@@ -808,12 +868,32 @@ export namespace TelemetryQueryResponse {
 
     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;
@@ -1256,10 +1336,26 @@ export namespace TelemetryQueryResponse {
       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;

package/src/resources/workers/scripts/deployments.ts

@@ -316,7 +316,7 @@ export interface DeploymentDeleteParams {
   account_id: string;
 
   /**
-   * Name of the script, used in URLs and route configuration.
+   * Name of the script.
    */
   script_name: string;
 }
@@ -328,7 +328,7 @@ export interface DeploymentGetParams {
   account_id: string;
 
   /**
-   * Name of the script, used in URLs and route configuration.
+   * Name of the script.
    */
   script_name: string;
 }

package/src/resources/workers/scripts/script-and-version-settings.ts

@@ -88,6 +88,7 @@ export interface ScriptAndVersionSettingEditResponse {
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindAISearchNamespace
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindMessaging
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindAnalyticsEngine
+    | ScriptAndVersionSettingEditResponse.WorkersBindingKindArtifacts
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindAssets
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindBrowser
     | ScriptAndVersionSettingEditResponse.WorkersBindingKindD1
@@ -310,6 +311,26 @@ export namespace ScriptAndVersionSettingEditResponse {
     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.
@@ -1525,6 +1546,7 @@ export interface ScriptAndVersionSettingGetResponse {
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindAISearchNamespace
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindMessaging
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindAnalyticsEngine
+    | ScriptAndVersionSettingGetResponse.WorkersBindingKindArtifacts
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindAssets
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindBrowser
     | ScriptAndVersionSettingGetResponse.WorkersBindingKindD1
@@ -1747,6 +1769,26 @@ export namespace ScriptAndVersionSettingGetResponse {
     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.
@@ -2975,6 +3017,7 @@ export namespace ScriptAndVersionSettingEditParams {
       | Settings.WorkersBindingKindAISearchNamespace
       | Settings.WorkersBindingKindMessaging
       | Settings.WorkersBindingKindAnalyticsEngine
+      | Settings.WorkersBindingKindArtifacts
       | Settings.WorkersBindingKindAssets
       | Settings.WorkersBindingKindBrowser
       | Settings.WorkersBindingKindD1
@@ -3202,6 +3245,26 @@ export namespace ScriptAndVersionSettingEditParams {
       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/scripts/scripts.ts

@@ -2411,7 +2411,7 @@ export namespace ScriptSearchResponse {
     modified_on: string;
 
     /**
-     * Name of the script, used in URLs and route configuration.
+     * Name of the script.
      */
     script_name: string;
 
@@ -2489,6 +2489,7 @@ export namespace ScriptUpdateParams {
       | Metadata.WorkersBindingKindAISearchNamespace
       | Metadata.WorkersBindingKindMessaging
       | Metadata.WorkersBindingKindAnalyticsEngine
+      | Metadata.WorkersBindingKindArtifacts
       | Metadata.WorkersBindingKindAssets
       | Metadata.WorkersBindingKindBrowser
       | Metadata.WorkersBindingKindD1
@@ -2812,6 +2813,26 @@ export namespace ScriptUpdateParams {
       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/scripts/secrets.ts

@@ -476,7 +476,7 @@ export interface SecretDeleteParams {
   account_id: string;
 
   /**
-   * Path param: Name of the script, used in URLs and route configuration.
+   * Path param: Name of the script.
    */
   script_name: string;
 
@@ -582,7 +582,7 @@ export interface SecretGetParams {
   account_id: string;
 
   /**
-   * Path param: Name of the script, used in URLs and route configuration.
+   * Path param: Name of the script.
    */
   script_name: string;
 

package/src/resources/workers/scripts/tail.ts

@@ -203,7 +203,7 @@ export interface TailDeleteParams {
   account_id: string;
 
   /**
-   * Name of the script, used in URLs and route configuration.
+   * Name of the script.
    */
   script_name: string;
 }

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

@@ -1172,6 +1172,7 @@ export namespace VersionCreateParams {
       | Metadata.WorkersBindingKindAISearchNamespace
       | Metadata.WorkersBindingKindMessaging
       | Metadata.WorkersBindingKindAnalyticsEngine
+      | Metadata.WorkersBindingKindArtifacts
       | Metadata.WorkersBindingKindAssets
       | Metadata.WorkersBindingKindBrowser
       | Metadata.WorkersBindingKindD1
@@ -1395,6 +1396,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-for-platforms/dispatch/namespaces/scripts/bindings.ts

@@ -58,6 +58,7 @@ export type BindingGetResponse =
   | BindingGetResponse.WorkersBindingKindAISearchNamespace
   | BindingGetResponse.WorkersBindingKindMessaging
   | BindingGetResponse.WorkersBindingKindAnalyticsEngine
+  | BindingGetResponse.WorkersBindingKindArtifacts
   | BindingGetResponse.WorkersBindingKindAssets
   | BindingGetResponse.WorkersBindingKindBrowser
   | BindingGetResponse.WorkersBindingKindD1
@@ -182,6 +183,26 @@ export namespace BindingGetResponse {
     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-for-platforms/dispatch/namespaces/scripts/scripts.ts

@@ -919,6 +919,7 @@ export namespace ScriptUpdateParams {
       | Metadata.WorkersBindingKindAISearchNamespace
       | Metadata.WorkersBindingKindMessaging
       | Metadata.WorkersBindingKindAnalyticsEngine
+      | Metadata.WorkersBindingKindArtifacts
       | Metadata.WorkersBindingKindAssets
       | Metadata.WorkersBindingKindBrowser
       | Metadata.WorkersBindingKindD1
@@ -1227,6 +1228,26 @@ export namespace ScriptUpdateParams {
       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-for-platforms/dispatch/namespaces/scripts/secrets.ts

@@ -513,7 +513,7 @@ export interface SecretDeleteParams {
   dispatch_namespace: string;
 
   /**
-   * Path param: Name of the script, used in URLs and route configuration.
+   * Path param: Name of the script.
    */
   script_name: string;
 
@@ -629,7 +629,7 @@ export interface SecretGetParams {
   dispatch_namespace: string;
 
   /**
-   * Path param: Name of the script, used in URLs and route configuration.
+   * Path param: Name of the script.
    */
   script_name: string;
 

package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts

@@ -96,6 +96,7 @@ export interface SettingEditResponse {
     | SettingEditResponse.WorkersBindingKindAISearchNamespace
     | SettingEditResponse.WorkersBindingKindMessaging
     | SettingEditResponse.WorkersBindingKindAnalyticsEngine
+    | SettingEditResponse.WorkersBindingKindArtifacts
     | SettingEditResponse.WorkersBindingKindAssets
     | SettingEditResponse.WorkersBindingKindBrowser
     | SettingEditResponse.WorkersBindingKindD1
@@ -295,6 +296,26 @@ export namespace SettingEditResponse {
     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.
@@ -1508,6 +1529,7 @@ export interface SettingGetResponse {
     | SettingGetResponse.WorkersBindingKindAISearchNamespace
     | SettingGetResponse.WorkersBindingKindMessaging
     | SettingGetResponse.WorkersBindingKindAnalyticsEngine
+    | SettingGetResponse.WorkersBindingKindArtifacts
     | SettingGetResponse.WorkersBindingKindAssets
     | SettingGetResponse.WorkersBindingKindBrowser
     | SettingGetResponse.WorkersBindingKindD1
@@ -1707,6 +1729,26 @@ export namespace SettingGetResponse {
     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.
@@ -2940,6 +2982,7 @@ export namespace SettingEditParams {
       | Settings.WorkersBindingKindAISearchNamespace
       | Settings.WorkersBindingKindMessaging
       | Settings.WorkersBindingKindAnalyticsEngine
+      | Settings.WorkersBindingKindArtifacts
       | Settings.WorkersBindingKindAssets
       | Settings.WorkersBindingKindBrowser
       | Settings.WorkersBindingKindD1
@@ -3150,6 +3193,26 @@ export namespace SettingEditParams {
       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-for-platforms/dispatch/namespaces/scripts/tags.ts

@@ -161,7 +161,7 @@ export interface TagDeleteParams {
   dispatch_namespace: string;
 
   /**
-   * Name of the script, used in URLs and route configuration.
+   * Name of the script.
    */
   script_name: string;
 }

package/src/resources/zero-trust/casb/posture/findings/instances.ts

@@ -76,9 +76,9 @@ export class BaseInstances extends APIResource {
    * Creates a CSV export for Finding instances and accepts optional filters in the
    * payload.
    *
-   * The `storage_namespace_id` path parameter is derived from the finding ID by
-   * base64-decoding it (which yields `integration_id:finding_type_id`) and replacing
-   * the colon with a hyphen.
+   * Identify the finding as `<integration_id>-<finding_type_id>`: join the
+   * `integration.id` and `finding.id` of the finding (from the List posture findings
+   * response) with a hyphen.
    *
    * @example
    * ```ts
@@ -1408,7 +1408,8 @@ export interface InstanceGetParams {
   account_id: string;
 
   /**
-   * A base64-encoded ID identifying this Finding.
+   * The `id` of a finding, as returned in each item of the List posture findings
+   * response. It is a base64-encoded identifier.
    */
   finding_id: string;
 }

package/src/resources/zero-trust/dlp/payload-logs.ts

@@ -16,13 +16,7 @@ export class BasePayloadLogs extends APIResource {
    * Enables or disables payload logging for DLP matches. When enabled, matched
    * content is stored for review.
    *
-   * @example
-   * ```ts
-   * const payloadLog =
-   *   await client.zeroTrust.dlp.payloadLogs.update({
-   *     account_id: 'account_id',
-   *   });
-   * ```
+   * @deprecated
    */
   update(params: PayloadLogUpdateParams, options?: RequestOptions): APIPromise<PayloadLogUpdateResponse> {
     const { account_id, ...body } = params;
@@ -37,13 +31,7 @@ export class BasePayloadLogs extends APIResource {
    * Gets the current payload logging configuration for DLP, showing whether matched
    * content is being logged.
    *
-   * @example
-   * ```ts
-   * const payloadLog =
-   *   await client.zeroTrust.dlp.payloadLogs.get({
-   *     account_id: 'account_id',
-   *   });
-   * ```
+   * @deprecated
    */
   get(params: PayloadLogGetParams, options?: RequestOptions): APIPromise<PayloadLogGetResponse> {
     const { account_id } = params;