cloudflare 6.2.0 → 6.4.0

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

@@ -30,6 +30,54 @@ export class Telemetry extends APIResource {
     );
   }
 
+  /**
+   * Prepare websocket server for live tail.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.workers.observability.telemetry.liveTail({
+   *     account_id: 'account_id',
+   *   });
+   * ```
+   */
+  liveTail(
+    params: TelemetryLiveTailParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TelemetryLiveTailResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/workers/observability/telemetry/live-tail`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: TelemetryLiveTailResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Notify live tail that user is still eligible to receive live events.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.workers.observability.telemetry.liveTailHeartbeat(
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  liveTailHeartbeat(
+    params: TelemetryLiveTailHeartbeatParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TelemetryLiveTailHeartbeatResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/workers/observability/telemetry/live-tail/heartbeat`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: TelemetryLiveTailHeartbeatResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Run a temporary or saved query.
    *
@@ -100,14 +148,23 @@ export interface TelemetryKeysResponse {
   type: 'string' | 'boolean' | 'number';
 }
 
+export interface TelemetryLiveTailResponse {
+  /**
+   * WebSocket URL clients connect to in order to stream live tail events.
+   */
+  wsUrl: string;
+}
+
+export type TelemetryLiveTailHeartbeatResponse = unknown;
+
 /**
  * Complete results of a query run. The populated fields depend on the requested
  * view type (events, calculations, invocations, traces, or agents).
  */
 export interface TelemetryQueryResponse {
   /**
-   * The query run metadata including the query definition, execution status, and
-   * timeframe.
+   * Represents a single execution of a query against Workers Observability data,
+   * including the query definition, execution status, and performance statistics.
    */
   run: TelemetryQueryResponse.Run;
 
@@ -159,8 +216,8 @@ export interface TelemetryQueryResponse {
 
 export namespace TelemetryQueryResponse {
   /**
-   * The query run metadata including the query definition, execution status, and
-   * timeframe.
+   * Represents a single execution of a query against Workers Observability data,
+   * including the query definition, execution status, and performance statistics.
    */
   export interface Run {
     /**
@@ -373,13 +430,14 @@ export namespace TelemetryQueryResponse {
 
           /**
            * Comparison operator. String operators: includes, not_includes, starts_with,
-           * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-           * values). Numeric: eq, neq, gt, gte, lt, lte.
+           * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+           * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
            */
           operation:
             | 'includes'
             | 'not_includes'
             | 'starts_with'
+            | 'ends_with'
             | 'regex'
             | 'exists'
             | 'is_null'
@@ -404,7 +462,8 @@ export namespace TelemetryQueryResponse {
             | 'DOES_NOT_EXIST'
             | 'IN'
             | 'NOT_IN'
-            | 'STARTS_WITH';
+            | 'STARTS_WITH'
+            | 'ENDS_WITH';
 
           /**
            * Data type of the filter field. Must match the actual type of the key being
@@ -763,7 +822,7 @@ export namespace TelemetryQueryResponse {
        * Raw log payload. May be a string or a structured object depending on how the log
        * was emitted.
        */
-      source: string | unknown;
+      source: string | { [key: string]: unknown };
 
       /**
        * Event timestamp as a Unix epoch in milliseconds.
@@ -774,7 +833,7 @@ export namespace TelemetryQueryResponse {
        * Cloudflare Containers event information that enriches your logs for identifying
        * and debugging issues.
        */
-      $containers?: unknown;
+      $containers?: { [key: string]: unknown };
 
       /**
        * Cloudflare Workers event information that enriches your logs for identifying and
@@ -804,9 +863,6 @@ export namespace TelemetryQueryResponse {
          */
         cloudService?: string;
 
-        /**
-         * Whether this was a cold start (1) or warm invocation (0).
-         */
         coldStart?: number;
 
         /**
@@ -973,6 +1029,8 @@ export namespace TelemetryQueryResponse {
 
         outcome?: string;
 
+        preview?: UnionMember0.Preview;
+
         scriptVersion?: UnionMember0.ScriptVersion;
 
         spanId?: string;
@@ -983,6 +1041,14 @@ export namespace TelemetryQueryResponse {
       }
 
       export namespace UnionMember0 {
+        export interface Preview {
+          id?: string;
+
+          name?: string;
+
+          slug?: string;
+        }
+
         export interface ScriptVersion {
           id?: string;
 
@@ -1028,6 +1094,8 @@ export namespace TelemetryQueryResponse {
 
         executionModel?: 'durableObject' | 'stateless';
 
+        preview?: UnionMember1.Preview;
+
         scriptVersion?: UnionMember1.ScriptVersion;
 
         spanId?: string;
@@ -1046,6 +1114,14 @@ export namespace TelemetryQueryResponse {
           timestamp: number;
         }
 
+        export interface Preview {
+          id?: string;
+
+          name?: string;
+
+          slug?: string;
+        }
+
         export interface ScriptVersion {
           id?: string;
 
@@ -1143,7 +1219,7 @@ export namespace TelemetryQueryResponse {
      * Raw log payload. May be a string or a structured object depending on how the log
      * was emitted.
      */
-    source: string | unknown;
+    source: string | { [key: string]: unknown };
 
     /**
      * Event timestamp as a Unix epoch in milliseconds.
@@ -1154,7 +1230,7 @@ export namespace TelemetryQueryResponse {
      * Cloudflare Containers event information that enriches your logs for identifying
      * and debugging issues.
      */
-    $containers?: unknown;
+    $containers?: { [key: string]: unknown };
 
     /**
      * Cloudflare Workers event information that enriches your logs for identifying and
@@ -1184,9 +1260,6 @@ export namespace TelemetryQueryResponse {
        */
       cloudService?: string;
 
-      /**
-       * Whether this was a cold start (1) or warm invocation (0).
-       */
       coldStart?: number;
 
       /**
@@ -1353,6 +1426,8 @@ export namespace TelemetryQueryResponse {
 
       outcome?: string;
 
+      preview?: UnionMember0.Preview;
+
       scriptVersion?: UnionMember0.ScriptVersion;
 
       spanId?: string;
@@ -1363,6 +1438,14 @@ export namespace TelemetryQueryResponse {
     }
 
     export namespace UnionMember0 {
+      export interface Preview {
+        id?: string;
+
+        name?: string;
+
+        slug?: string;
+      }
+
       export interface ScriptVersion {
         id?: string;
 
@@ -1408,6 +1491,8 @@ export namespace TelemetryQueryResponse {
 
       executionModel?: 'durableObject' | 'stateless';
 
+      preview?: UnionMember1.Preview;
+
       scriptVersion?: UnionMember1.ScriptVersion;
 
       spanId?: string;
@@ -1426,6 +1511,14 @@ export namespace TelemetryQueryResponse {
         timestamp: number;
       }
 
+      export interface Preview {
+        id?: string;
+
+        name?: string;
+
+        slug?: string;
+      }
+
       export interface ScriptVersion {
         id?: string;
 
@@ -1571,13 +1664,14 @@ export namespace TelemetryKeysParams {
 
       /**
        * Comparison operator. String operators: includes, not_includes, starts_with,
-       * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-       * values). Numeric: eq, neq, gt, gte, lt, lte.
+       * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+       * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
        */
       operation:
         | 'includes'
         | 'not_includes'
         | 'starts_with'
+        | 'ends_with'
         | 'regex'
         | 'exists'
         | 'is_null'
@@ -1602,7 +1696,8 @@ export namespace TelemetryKeysParams {
         | 'DOES_NOT_EXIST'
         | 'IN'
         | 'NOT_IN'
-        | 'STARTS_WITH';
+        | 'STARTS_WITH'
+        | 'ENDS_WITH';
 
       /**
        * Data type of the filter field. Must match the actual type of the key being
@@ -1640,13 +1735,14 @@ export namespace TelemetryKeysParams {
 
     /**
      * Comparison operator. String operators: includes, not_includes, starts_with,
-     * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-     * values). Numeric: eq, neq, gt, gte, lt, lte.
+     * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+     * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
      */
     operation:
       | 'includes'
       | 'not_includes'
       | 'starts_with'
+      | 'ends_with'
       | 'regex'
       | 'exists'
       | 'is_null'
@@ -1671,7 +1767,8 @@ export namespace TelemetryKeysParams {
       | 'DOES_NOT_EXIST'
       | 'IN'
       | 'NOT_IN'
-      | 'STARTS_WITH';
+      | 'STARTS_WITH'
+      | 'ENDS_WITH';
 
     /**
      * Data type of the filter field. Must match the actual type of the key being
@@ -1736,6 +1833,203 @@ export namespace TelemetryKeysParams {
   }
 }
 
+export interface TelemetryLiveTailParams {
+  /**
+   * Path param: Your Cloudflare account ID.
+   */
+  account_id: string;
+
+  /**
+   * Body param: Set a flag to describe how to combine the filters on the query.
+   */
+  filterCombination?: 'and' | 'or' | 'AND' | 'OR';
+
+  /**
+   * Body param: Apply filters to the query. Supports nested groups via kind:
+   * 'group'.
+   */
+  filters?: Array<
+    TelemetryLiveTailParams.UnionMember0 | TelemetryLiveTailParams.WorkersObservabilityFilterLeaf
+  >;
+
+  /**
+   * Body param
+   */
+  scriptId?: string;
+}
+
+export namespace TelemetryLiveTailParams {
+  export interface UnionMember0 {
+    filterCombination: 'and' | 'or' | 'AND' | 'OR';
+
+    filters: Array<UnionMember0.UnionMember0 | UnionMember0.WorkersObservabilityFilterLeaf>;
+
+    kind: 'group';
+  }
+
+  export namespace UnionMember0 {
+    export interface UnionMember0 {
+      filterCombination: 'and' | 'or' | 'AND' | 'OR';
+
+      filters: Array<unknown>;
+
+      kind: 'group';
+    }
+
+    /**
+     * A filter condition applied to query results. Use the keys and values endpoints
+     * to discover available fields and their values before constructing filters.
+     */
+    export interface WorkersObservabilityFilterLeaf {
+      /**
+       * Filter field name. Use verified keys from previous query results or the keys
+       * endpoint. Common keys include $metadata.service, $metadata.origin,
+       * $metadata.trigger, $metadata.message, and $metadata.error.
+       */
+      key: string;
+
+      /**
+       * Comparison operator. String operators: includes, not_includes, starts_with,
+       * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+       * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
+       */
+      operation:
+        | 'includes'
+        | 'not_includes'
+        | 'starts_with'
+        | 'ends_with'
+        | 'regex'
+        | 'exists'
+        | 'is_null'
+        | 'in'
+        | 'not_in'
+        | 'eq'
+        | 'neq'
+        | 'gt'
+        | 'gte'
+        | 'lt'
+        | 'lte'
+        | '='
+        | '!='
+        | '>'
+        | '>='
+        | '<'
+        | '<='
+        | 'INCLUDES'
+        | 'DOES_NOT_INCLUDE'
+        | 'MATCH_REGEX'
+        | 'EXISTS'
+        | 'DOES_NOT_EXIST'
+        | 'IN'
+        | 'NOT_IN'
+        | 'STARTS_WITH'
+        | 'ENDS_WITH';
+
+      /**
+       * Data type of the filter field. Must match the actual type of the key being
+       * filtered.
+       */
+      type: 'string' | 'number' | 'boolean';
+
+      /**
+       * Discriminator for leaf filter nodes. Always 'filter' when present; may be
+       * omitted.
+       */
+      kind?: 'filter';
+
+      /**
+       * Comparison value. Must match actual values in your data — verify with the values
+       * endpoint. Ensure the value type (string/number/boolean) matches the field type.
+       * String comparisons are case-sensitive. Regex uses RE2 syntax (no
+       * lookaheads/lookbehinds).
+       */
+      value?: string | number | boolean;
+    }
+  }
+
+  /**
+   * A filter condition applied to query results. Use the keys and values endpoints
+   * to discover available fields and their values before constructing filters.
+   */
+  export interface WorkersObservabilityFilterLeaf {
+    /**
+     * Filter field name. Use verified keys from previous query results or the keys
+     * endpoint. Common keys include $metadata.service, $metadata.origin,
+     * $metadata.trigger, $metadata.message, and $metadata.error.
+     */
+    key: string;
+
+    /**
+     * Comparison operator. String operators: includes, not_includes, starts_with,
+     * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+     * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
+     */
+    operation:
+      | 'includes'
+      | 'not_includes'
+      | 'starts_with'
+      | 'ends_with'
+      | 'regex'
+      | 'exists'
+      | 'is_null'
+      | 'in'
+      | 'not_in'
+      | 'eq'
+      | 'neq'
+      | 'gt'
+      | 'gte'
+      | 'lt'
+      | 'lte'
+      | '='
+      | '!='
+      | '>'
+      | '>='
+      | '<'
+      | '<='
+      | 'INCLUDES'
+      | 'DOES_NOT_INCLUDE'
+      | 'MATCH_REGEX'
+      | 'EXISTS'
+      | 'DOES_NOT_EXIST'
+      | 'IN'
+      | 'NOT_IN'
+      | 'STARTS_WITH'
+      | 'ENDS_WITH';
+
+    /**
+     * Data type of the filter field. Must match the actual type of the key being
+     * filtered.
+     */
+    type: 'string' | 'number' | 'boolean';
+
+    /**
+     * Discriminator for leaf filter nodes. Always 'filter' when present; may be
+     * omitted.
+     */
+    kind?: 'filter';
+
+    /**
+     * Comparison value. Must match actual values in your data — verify with the values
+     * endpoint. Ensure the value type (string/number/boolean) matches the field type.
+     * String comparisons are case-sensitive. Regex uses RE2 syntax (no
+     * lookaheads/lookbehinds).
+     */
+    value?: string | number | boolean;
+  }
+}
+
+export interface TelemetryLiveTailHeartbeatParams {
+  /**
+   * Path param: Your Cloudflare account ID.
+   */
+  account_id: string;
+
+  /**
+   * Body param
+   */
+  scriptId?: string;
+}
+
 export interface TelemetryQueryParams {
   /**
    * Path param: Your Cloudflare account ID.
@@ -1908,7 +2202,7 @@ export namespace TelemetryQueryParams {
   export namespace Parameters {
     export interface Calculation {
       /**
-       * Aggregation operator to apply. Examples: count, avg, sum, min, max, p50, p90,
+       * Aggregation operator to apply. Examples: count, avg, sum, min, max, median, p90,
        * p95, p99, uniq, stddev, variance.
        */
       operator:
@@ -2001,13 +2295,14 @@ export namespace TelemetryQueryParams {
 
         /**
          * Comparison operator. String operators: includes, not_includes, starts_with,
-         * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-         * values). Numeric: eq, neq, gt, gte, lt, lte.
+         * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+         * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
          */
         operation:
           | 'includes'
           | 'not_includes'
           | 'starts_with'
+          | 'ends_with'
           | 'regex'
           | 'exists'
           | 'is_null'
@@ -2032,7 +2327,8 @@ export namespace TelemetryQueryParams {
           | 'DOES_NOT_EXIST'
           | 'IN'
           | 'NOT_IN'
-          | 'STARTS_WITH';
+          | 'STARTS_WITH'
+          | 'ENDS_WITH';
 
         /**
          * Data type of the filter field. Must match the actual type of the key being
@@ -2070,13 +2366,14 @@ export namespace TelemetryQueryParams {
 
       /**
        * Comparison operator. String operators: includes, not_includes, starts_with,
-       * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-       * values). Numeric: eq, neq, gt, gte, lt, lte.
+       * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+       * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
        */
       operation:
         | 'includes'
         | 'not_includes'
         | 'starts_with'
+        | 'ends_with'
         | 'regex'
         | 'exists'
         | 'is_null'
@@ -2101,7 +2398,8 @@ export namespace TelemetryQueryParams {
         | 'DOES_NOT_EXIST'
         | 'IN'
         | 'NOT_IN'
-        | 'STARTS_WITH';
+        | 'STARTS_WITH'
+        | 'ENDS_WITH';
 
       /**
        * Data type of the filter field. Must match the actual type of the key being
@@ -2275,13 +2573,14 @@ export namespace TelemetryValuesParams {
 
       /**
        * Comparison operator. String operators: includes, not_includes, starts_with,
-       * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-       * values). Numeric: eq, neq, gt, gte, lt, lte.
+       * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+       * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
        */
       operation:
         | 'includes'
         | 'not_includes'
         | 'starts_with'
+        | 'ends_with'
         | 'regex'
         | 'exists'
         | 'is_null'
@@ -2306,7 +2605,8 @@ export namespace TelemetryValuesParams {
         | 'DOES_NOT_EXIST'
         | 'IN'
         | 'NOT_IN'
-        | 'STARTS_WITH';
+        | 'STARTS_WITH'
+        | 'ENDS_WITH';
 
       /**
        * Data type of the filter field. Must match the actual type of the key being
@@ -2344,13 +2644,14 @@ export namespace TelemetryValuesParams {
 
     /**
      * Comparison operator. String operators: includes, not_includes, starts_with,
-     * regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated
-     * values). Numeric: eq, neq, gt, gte, lt, lte.
+     * ends_with, regex. Existence: exists, is_null. Set membership: in, not_in
+     * (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.
      */
     operation:
       | 'includes'
       | 'not_includes'
       | 'starts_with'
+      | 'ends_with'
       | 'regex'
       | 'exists'
       | 'is_null'
@@ -2375,7 +2676,8 @@ export namespace TelemetryValuesParams {
       | 'DOES_NOT_EXIST'
       | 'IN'
       | 'NOT_IN'
-      | 'STARTS_WITH';
+      | 'STARTS_WITH'
+      | 'ENDS_WITH';
 
     /**
      * Data type of the filter field. Must match the actual type of the key being
@@ -2426,11 +2728,15 @@ Telemetry.TelemetryValuesResponsesSinglePage = TelemetryValuesResponsesSinglePag
 export declare namespace Telemetry {
   export {
     type TelemetryKeysResponse as TelemetryKeysResponse,
+    type TelemetryLiveTailResponse as TelemetryLiveTailResponse,
+    type TelemetryLiveTailHeartbeatResponse as TelemetryLiveTailHeartbeatResponse,
     type TelemetryQueryResponse as TelemetryQueryResponse,
     type TelemetryValuesResponse as TelemetryValuesResponse,
     TelemetryKeysResponsesSinglePage as TelemetryKeysResponsesSinglePage,
     TelemetryValuesResponsesSinglePage as TelemetryValuesResponsesSinglePage,
     type TelemetryKeysParams as TelemetryKeysParams,
+    type TelemetryLiveTailParams as TelemetryLiveTailParams,
+    type TelemetryLiveTailHeartbeatParams as TelemetryLiveTailHeartbeatParams,
     type TelemetryQueryParams as TelemetryQueryParams,
     type TelemetryValuesParams as TelemetryValuesParams,
   };

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

@@ -48,10 +48,12 @@ export {
   type SecretUpdateResponse,
   type SecretListResponse,
   type SecretDeleteResponse,
+  type SecretBulkUpdateResponse,
   type SecretGetResponse,
   type SecretUpdateParams,
   type SecretListParams,
   type SecretDeleteParams,
+  type SecretBulkUpdateParams,
   type SecretGetParams,
 } from './secrets';
 export { Settings, type SettingEditParams, type SettingGetParams } from './settings';