cloudflare 7.1.0 → 7.3.0

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

@@ -262,7 +262,8 @@ export namespace TelemetryQueryResponse {
     status: 'STARTED' | 'COMPLETED';
 
     /**
-     * Time range for the query execution
+     * Time range for the query execution. 'from' must be earlier than 'to'. No
+     * fractional milliseconds.
      */
     timeframe: Run.Timeframe;
 
@@ -301,7 +302,7 @@ export namespace TelemetryQueryResponse {
        */
       adhoc: boolean;
 
-      created: string;
+      created: string | (string & {});
 
       createdBy: string;
 
@@ -314,7 +315,7 @@ export namespace TelemetryQueryResponse {
 
       parameters: Query.Parameters;
 
-      updated: string;
+      updated: string | (string & {});
 
       updatedBy: string;
     }
@@ -550,16 +551,17 @@ export namespace TelemetryQueryResponse {
     }
 
     /**
-     * Time range for the query execution
+     * Time range for the query execution. 'from' must be earlier than 'to'. No
+     * fractional milliseconds.
      */
     export interface Timeframe {
       /**
-       * Start timestamp for the query timeframe (Unix timestamp in milliseconds)
+       * Start timestamp for the query timeframe. Unix timestamp in milliseconds
        */
       from: number;
 
       /**
-       * End timestamp for the query timeframe (Unix timestamp in milliseconds)
+       * End timestamp for the query timeframe. Unix timestamp in milliseconds
        */
       to: number;
     }
@@ -621,7 +623,7 @@ export namespace TelemetryQueryResponse {
 
   export interface Agent {
     /**
-     * Pagination cursor derived from the first agent invocation in the run.
+     * Stable pagination cursor for this agent run.
      */
     id: string;
 
@@ -715,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>;
@@ -742,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;
@@ -779,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>;
@@ -806,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;
@@ -1114,8 +1196,6 @@ export namespace TelemetryQueryResponse {
           | 'workflow'
           | 'unknown';
 
-        requestId: string;
-
         scriptName: string;
 
         durableObjectId?: string;
@@ -1130,6 +1210,8 @@ export namespace TelemetryQueryResponse {
 
         preview?: UnionMember0.Preview;
 
+        requestId?: string;
+
         scriptVersion?: UnionMember0.ScriptVersion;
 
         spanId?: string;
@@ -1176,8 +1258,6 @@ export namespace TelemetryQueryResponse {
 
         outcome: string;
 
-        requestId: string;
-
         scriptName: string;
 
         wallTimeMs: number;
@@ -1196,6 +1276,8 @@ export namespace TelemetryQueryResponse {
 
         preview?: UnionMember1.Preview;
 
+        requestId?: string;
+
         scriptVersion?: UnionMember1.ScriptVersion;
 
         spanId?: string;
@@ -1254,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;
@@ -1519,8 +1617,6 @@ export namespace TelemetryQueryResponse {
         | 'workflow'
         | 'unknown';
 
-      requestId: string;
-
       scriptName: string;
 
       durableObjectId?: string;
@@ -1535,6 +1631,8 @@ export namespace TelemetryQueryResponse {
 
       preview?: UnionMember0.Preview;
 
+      requestId?: string;
+
       scriptVersion?: UnionMember0.ScriptVersion;
 
       spanId?: string;
@@ -1581,8 +1679,6 @@ export namespace TelemetryQueryResponse {
 
       outcome: string;
 
-      requestId: string;
-
       scriptName: string;
 
       wallTimeMs: number;
@@ -1601,6 +1697,8 @@ export namespace TelemetryQueryResponse {
 
       preview?: UnionMember1.Preview;
 
+      requestId?: string;
+
       scriptVersion?: UnionMember1.ScriptVersion;
 
       spanId?: string;
@@ -2153,7 +2251,8 @@ export interface TelemetryQueryParams {
 
   /**
    * Body param: Timeframe for the query using Unix timestamps in milliseconds.
-   * Narrower timeframes produce faster responses and more specific results.
+   * 'from' must be earlier than 'to'. Narrower timeframes produce faster responses
+   * and more specific results.
    */
   timeframe: TelemetryQueryParams.Timeframe;
 
@@ -2178,6 +2277,14 @@ export interface TelemetryQueryParams {
    */
   compare?: boolean;
 
+  /**
+   * Body param: Value-axis bucketing for chartType 'distribution'. Omitted or 'log':
+   * geometric buckets, best for heavy-tailed latency. 'linear': fixed-width buckets,
+   * clearer for narrow or additive ranges. Ignored for other chartTypes. The
+   * response echoes the scheme used in distribution.bucketMode.
+   */
+  distributionScale?: 'log' | 'linear';
+
   /**
    * Body param: When true, executes the query without persisting the results. Useful
    * for validation or previewing.
@@ -2241,17 +2348,18 @@ export interface TelemetryQueryParams {
 
 export namespace TelemetryQueryParams {
   /**
-   * Timeframe for the query using Unix timestamps in milliseconds. Narrower
-   * timeframes produce faster responses and more specific results.
+   * Timeframe for the query using Unix timestamps in milliseconds. 'from' must be
+   * earlier than 'to'. Narrower timeframes produce faster responses and more
+   * specific results.
    */
   export interface Timeframe {
     /**
-     * Start timestamp for the query timeframe (Unix timestamp in milliseconds)
+     * Start timestamp for the query timeframe. Unix timestamp in milliseconds
      */
     from: number;
 
     /**
-     * End timestamp for the query timeframe (Unix timestamp in milliseconds)
+     * End timestamp for the query timeframe. Unix timestamp in milliseconds
      */
     to: number;
   }
@@ -2333,7 +2441,7 @@ export namespace TelemetryQueryParams {
       alias?: string;
 
       /**
-       * Field name to calculate over. Must exist in the data — verify with the keys
+       * Field name to calculate over. Must exist in the data. Verify with the keys
        * endpoint. Required for every operator except `count`, which aggregates whole
        * rows and may omit it.
        */
@@ -2348,7 +2456,7 @@ export namespace TelemetryQueryParams {
 
     export interface KeyedCalculation {
       /**
-       * Field name to calculate over. Must exist in the data — verify with the keys
+       * Field name to calculate over. Must exist in the data. Verify with the keys
        * endpoint. Required for every operator except `count`, which aggregates whole
        * rows and may omit it.
        */

package/src/resources/workers/routes.ts

@@ -33,7 +33,7 @@ export class BaseRoutes extends APIResource {
   }
 
   /**
-   * Updates the URL pattern or Worker associated with a route.
+   * Replaces the URL pattern or Worker associated with a Worker route.
    *
    * @example
    * ```ts
@@ -61,7 +61,7 @@ export class BaseRoutes extends APIResource {
   }
 
   /**
-   * Returns routes for a zone.
+   * Returns Worker routes for a zone.
    *
    * @example
    * ```ts
@@ -86,7 +86,7 @@ export class BaseRoutes extends APIResource {
   }
 
   /**
-   * Deletes a route.
+   * Deletes a Worker route.
    *
    * @example
    * ```ts
@@ -110,7 +110,7 @@ export class BaseRoutes extends APIResource {
   }
 
   /**
-   * Returns information about a route, including URL pattern and Worker.
+   * Returns information about a Worker route, including URL pattern and Worker.
    *
    * @example
    * ```ts

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

@@ -17,7 +17,7 @@ export class BaseContent extends APIResource {
   ] as const);
 
   /**
-   * Put script content without touching config or metadata.
+   * Replace Worker script content without touching config or metadata.
    *
    * @example
    * ```ts
@@ -65,7 +65,7 @@ export class BaseContent extends APIResource {
   }
 
   /**
-   * Fetch script content only.
+   * Fetch Worker script content only.
    *
    * @example
    * ```ts

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { PagePromise, V4PagePagination, type V4PagePaginationParams } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -15,7 +16,7 @@ export class BaseDeployments extends APIResource {
   /**
    * Deployments configure how
    * [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions)
-   * are deployed to traffic. A deployment can consist of one or two versions of a
+   * are deployed to traffic. A deployment can consist of multiple versions of a
    * Worker.
    *
    * @example
@@ -30,7 +31,7 @@ export class BaseDeployments extends APIResource {
    *         {
    *           percentage: 100,
    *           version_id:
-   *             '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *             '023e105f-2a42-4f8b-a1c1-73f6a2a30c0f',
    *         },
    *       ],
    *     },
@@ -53,30 +54,31 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * List of Worker Deployments. The first deployment in the list is the latest
+   * List Worker deployments. The first deployment in the list is the latest
    * deployment actively serving traffic.
    *
    * @example
    * ```ts
-   * const deployments =
-   *   await client.workers.scripts.deployments.list(
-   *     'this-is_my_script-01',
-   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const deploymentListResponse of client.workers.scripts.deployments.list(
+   *   'this-is_my_script-01',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     scriptName: string,
     params: DeploymentListParams,
     options?: RequestOptions,
-  ): APIPromise<DeploymentListResponse> {
-    const { account_id } = params;
-    return (
-      this._client.get(
-        path`/accounts/${account_id}/workers/scripts/${scriptName}/deployments`,
-        options,
-      ) as APIPromise<{ result: DeploymentListResponse }>
-    )._thenUnwrap((obj) => obj.result);
+  ): PagePromise<DeploymentListResponsesV4PagePagination, DeploymentListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      path`/accounts/${account_id}/workers/scripts/${scriptName}/deployments`,
+      V4PagePagination<DeploymentListResponse>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -134,6 +136,8 @@ export class BaseDeployments extends APIResource {
 }
 export class Deployments extends BaseDeployments {}
 
+export type DeploymentListResponsesV4PagePagination = V4PagePagination<DeploymentListResponse>;
+
 export interface Deployment {
   id: string;
 
@@ -143,6 +147,14 @@ export interface Deployment {
 
   strategy: 'percentage';
 
+  /**
+   * Worker versions included in this deployment. Each object must contain a
+   * `version_id` UUID and a `percentage`; percentages across all objects must
+   * total 100. In the `cf` CLI, pass the entire array as one JSON value to
+   * `--versions`, either inline, for example
+   * `--versions '[{"version_id":"023e105f-2a42-4f8b-a1c1-73f6a2a30c0f","percentage":100}]'`,
+   * or from a JSON file with `--versions @versions.json`.
+   */
   versions: Array<Deployment.Version>;
 
   annotations?: Deployment.Annotations;
@@ -152,8 +164,14 @@ export interface Deployment {
 
 export namespace Deployment {
   export interface Version {
+    /**
+     * Percentage of traffic served by this version.
+     */
     percentage: number;
 
+    /**
+     * Identifier of the Worker Version.
+     */
     version_id: string;
   }
 
@@ -231,7 +249,12 @@ export interface DeploymentCreateParams {
   strategy: 'percentage';
 
   /**
-   * Body param
+   * Body param: Worker versions included in this deployment. Each object must
+   * contain a `version_id` UUID and a `percentage`; percentages across all objects
+   * must total 100. In the `cf` CLI, pass the entire array as one JSON value to
+   * `--versions`, either inline, for example
+   * `--versions '[{"version_id":"023e105f-2a42-4f8b-a1c1-73f6a2a30c0f","percentage":100}]'`,
+   * or from a JSON file with `--versions @versions.json`.
    */
   versions: Array<DeploymentCreateParams.Version>;
 
@@ -250,8 +273,14 @@ export interface DeploymentCreateParams {
 
 export namespace DeploymentCreateParams {
   export interface Version {
+    /**
+     * Percentage of traffic served by this version.
+     */
     percentage: number;
 
+    /**
+     * Identifier of the Worker Version.
+     */
     version_id: string;
   }
 
@@ -263,11 +292,21 @@ export namespace DeploymentCreateParams {
   }
 }
 
-export interface DeploymentListParams {
+export interface DeploymentListParams extends V4PagePaginationParams {
   /**
-   * Identifier.
+   * Path param: Identifier.
    */
   account_id: string;
+
+  /**
+   * Query param: Start of the deployment creation time range, inclusive.
+   */
+  since?: string;
+
+  /**
+   * Query param: End of the deployment creation time range, inclusive.
+   */
+  until?: string;
 }
 
 export interface DeploymentDeleteParams {
@@ -277,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;
 }
@@ -289,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;
 }
@@ -299,6 +338,7 @@ export declare namespace Deployments {
     type Deployment as Deployment,
     type DeploymentListResponse as DeploymentListResponse,
     type DeploymentDeleteResponse as DeploymentDeleteResponse,
+    type DeploymentListResponsesV4PagePagination as DeploymentListResponsesV4PagePagination,
     type DeploymentCreateParams as DeploymentCreateParams,
     type DeploymentListParams as DeploymentListParams,
     type DeploymentDeleteParams as DeploymentDeleteParams,

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

@@ -12,6 +12,7 @@ export {
   type DeploymentListParams,
   type DeploymentDeleteParams,
   type DeploymentGetParams,
+  type DeploymentListResponsesV4PagePagination,
 } from './deployments';
 export {
   Schedules,

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

@@ -13,7 +13,7 @@ export class BaseSchedules extends APIResource {
   ] as const);
 
   /**
-   * Updates Cron Triggers for a Worker.
+   * Update the schedules (Cron Triggers) for a Worker script.
    *
    * @example
    * ```ts
@@ -42,7 +42,7 @@ export class BaseSchedules extends APIResource {
   }
 
   /**
-   * Fetches Cron Triggers for a Worker.
+   * Get the schedules (Cron Triggers) for a Worker script.
    *
    * @example
    * ```ts