cloudflare 6.3.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,6 +148,15 @@ 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).
@@ -1776,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.
@@ -2474,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/workflows/api.md

@@ -22,6 +22,7 @@ Types:
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceListResponse</a></code>
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceBulkResponse</a></code>
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceGetResponse</a></code>
+- <code><a href="./src/resources/workflows/instances/instances.ts">InstanceStepResponse</a></code>
 
 Methods:
 
@@ -29,6 +30,7 @@ Methods:
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/instances">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">list</a>(workflowName, { ...params }) -> InstanceListResponsesV4PagePaginationArray</code>
 - <code title="post /accounts/{account_id}/workflows/{workflow_name}/instances/batch">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">bulk</a>(workflowName, [ ...body ]) -> InstanceBulkResponsesSinglePage</code>
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">get</a>(workflowName, instanceId, { ...params }) -> InstanceGetResponse</code>
+- <code title="get /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">step</a>(workflowName, instanceId, { ...params }) -> InstanceStepResponse</code>
 
 ### Status
 
@@ -56,8 +58,10 @@ Types:
 
 - <code><a href="./src/resources/workflows/versions.ts">VersionListResponse</a></code>
 - <code><a href="./src/resources/workflows/versions.ts">VersionGetResponse</a></code>
+- <code><a href="./src/resources/workflows/versions.ts">VersionGraphResponse</a></code>
 
 Methods:
 
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/versions">client.workflows.versions.<a href="./src/resources/workflows/versions.ts">list</a>(workflowName, { ...params }) -> VersionListResponsesV4PagePaginationArray</code>
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}">client.workflows.versions.<a href="./src/resources/workflows/versions.ts">get</a>(workflowName, versionId, { ...params }) -> VersionGetResponse</code>
+- <code title="get /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph">client.workflows.versions.<a href="./src/resources/workflows/versions.ts">graph</a>(workflowName, versionId, { ...params }) -> VersionGraphResponse</code>

package/src/resources/workflows/index.ts

@@ -8,17 +8,21 @@ export {
   type InstanceListResponse,
   type InstanceBulkResponse,
   type InstanceGetResponse,
+  type InstanceStepResponse,
   type InstanceCreateParams,
   type InstanceListParams,
   type InstanceBulkParams,
   type InstanceGetParams,
+  type InstanceStepParams,
 } from './instances/index';
 export {
   VersionListResponsesV4PagePaginationArray,
   Versions,
   type VersionListResponse,
   type VersionGetResponse,
+  type VersionGraphResponse,
   type VersionListParams,
   type VersionGetParams,
+  type VersionGraphParams,
 } from './versions';
 export { Workflows } from './workflows';

package/src/resources/workflows/instances/index.ts

@@ -9,9 +9,11 @@ export {
   type InstanceListResponse,
   type InstanceBulkResponse,
   type InstanceGetResponse,
+  type InstanceStepResponse,
   type InstanceCreateParams,
   type InstanceListParams,
   type InstanceBulkParams,
   type InstanceGetParams,
+  type InstanceStepParams,
 } from './instances';
 export { Status, type StatusEditResponse, type StatusEditParams } from './status';

package/src/resources/workflows/instances/instances.ts

@@ -78,6 +78,31 @@ export class Instances extends APIResource {
       }) as Core.APIPromise<{ result: InstanceGetResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Retrieves the full, untruncated output for a specific step on a workflow
+   * instance. Returns a flat status-shaped JSON body with step `status` ('running' |
+   * 'waiting' | 'complete' | 'errored'), `error` (nullable), and `output` (the step
+   * value, or null while running/waiting/errored). When the step returned a
+   * ReadableStream from step.do, the response is served as
+   * 'application/octet-stream' with the raw bytes as the body instead of JSON. A
+   * `status='running'` response with non-null `error` indicates the step is
+   * currently retrying after a prior attempt failed.
+   */
+  step(
+    workflowName: string,
+    instanceId: string,
+    params: InstanceStepParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InstanceStepResponse> {
+    const { account_id, ...query } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/workflows/${workflowName}/instances/${instanceId}/step`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: InstanceStepResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
 export class InstanceListResponsesV4PagePaginationArray extends V4PagePaginationArray<InstanceListResponse> {}
@@ -95,11 +120,14 @@ export interface InstanceCreateResponse {
     | 'terminated'
     | 'complete'
     | 'waitingForPause'
-    | 'waiting';
+    | 'waiting'
+    | 'rollingBack';
 
   version_id: string;
 
   workflow_id: string;
+
+  trigger_source?: 'unknown' | 'api' | 'binding' | 'event' | 'cron';
 }
 
 export interface InstanceListResponse {
@@ -121,11 +149,14 @@ export interface InstanceListResponse {
     | 'terminated'
     | 'complete'
     | 'waitingForPause'
-    | 'waiting';
+    | 'waiting'
+    | 'rollingBack';
 
   version_id: string;
 
   workflow_id: string;
+
+  trigger_source?: 'unknown' | 'api' | 'binding' | 'event' | 'cron';
 }
 
 export interface InstanceBulkResponse {
@@ -139,11 +170,14 @@ export interface InstanceBulkResponse {
     | 'terminated'
     | 'complete'
     | 'waitingForPause'
-    | 'waiting';
+    | 'waiting'
+    | 'rollingBack';
 
   version_id: string;
 
   workflow_id: string;
+
+  trigger_source?: 'unknown' | 'api' | 'binding' | 'event' | 'cron';
 }
 
 export interface InstanceGetResponse {
@@ -157,6 +191,8 @@ export interface InstanceGetResponse {
 
   queued: string;
 
+  rollback: InstanceGetResponse.Rollback | null;
+
   start: string | null;
 
   status:
@@ -167,7 +203,8 @@ export interface InstanceGetResponse {
     | 'terminated'
     | 'complete'
     | 'waitingForPause'
-    | 'waiting';
+    | 'waiting'
+    | 'rollingBack';
 
   step_count: number;
 
@@ -183,6 +220,8 @@ export interface InstanceGetResponse {
   trigger: InstanceGetResponse.Trigger;
 
   versionId: string;
+
+  schedule?: InstanceGetResponse.Schedule;
 }
 
 export namespace InstanceGetResponse {
@@ -192,6 +231,20 @@ export namespace InstanceGetResponse {
     name: string;
   }
 
+  export interface Rollback {
+    error: Rollback.Error | null;
+
+    outcome: 'complete' | 'failed';
+  }
+
+  export namespace Rollback {
+    export interface Error {
+      message: string;
+
+      name: string;
+    }
+  }
+
   export interface UnionMember0 {
     attempts: Array<UnionMember0.Attempt>;
 
@@ -207,7 +260,7 @@ export namespace InstanceGetResponse {
 
     success: boolean | null;
 
-    type: 'step';
+    type: 'step' | 'rollback';
   }
 
   export namespace UnionMember0 {
@@ -319,6 +372,49 @@ export namespace InstanceGetResponse {
   export interface Trigger {
     source: 'unknown' | 'api' | 'binding' | 'event' | 'cron';
   }
+
+  export interface Schedule {
+    cron: string;
+
+    scheduledTime: number;
+  }
+}
+
+export interface InstanceStepResponse {
+  /**
+   * Error details when status='errored'; null otherwise.
+   */
+  error: InstanceStepResponse.Error | null;
+
+  status:
+    | 'queued'
+    | 'running'
+    | 'paused'
+    | 'errored'
+    | 'terminated'
+    | 'complete'
+    | 'waitingForPause'
+    | 'waiting'
+    | 'rollingBack';
+
+  /**
+   * Full step output or waitForEvent payload without truncation. Sensitive outputs
+   * are returned as '[REDACTED]'. Populated when status='complete'. May be a
+   * ReadableStream when the step returned one from step.do; stream outputs are
+   * served as application/octet-stream rather than JSON.
+   */
+  output?: unknown;
+}
+
+export namespace InstanceStepResponse {
+  /**
+   * Error details when status='errored'; null otherwise.
+   */
+  export interface Error {
+    message: string;
+
+    name: string;
+  }
 }
 
 export interface InstanceCreateParams {
@@ -395,7 +491,8 @@ export interface InstanceListParams extends V4PagePaginationArrayParams {
     | 'terminated'
     | 'complete'
     | 'waitingForPause'
-    | 'waiting';
+    | 'waiting'
+    | 'rollingBack';
 }
 
 export interface InstanceBulkParams {
@@ -453,6 +550,30 @@ export interface InstanceGetParams {
   simple?: 'true' | 'false';
 }
 
+export interface InstanceStepParams {
+  /**
+   * Path param
+   */
+  account_id: string;
+
+  /**
+   * Query param: Exact step name from the instance logs response, including the
+   * generated counter suffix.
+   */
+  name: string;
+
+  /**
+   * Query param: Step type to disambiguate step.do and waitForEvent entries that
+   * share the same name.
+   */
+  type: 'step' | 'waitForEvent';
+
+  /**
+   * Query param: Specific attempt number to retrieve output or error for.
+   */
+  attempt?: number;
+}
+
 Instances.InstanceListResponsesV4PagePaginationArray = InstanceListResponsesV4PagePaginationArray;
 Instances.InstanceBulkResponsesSinglePage = InstanceBulkResponsesSinglePage;
 Instances.Status = Status;
@@ -464,12 +585,14 @@ export declare namespace Instances {
     type InstanceListResponse as InstanceListResponse,
     type InstanceBulkResponse as InstanceBulkResponse,
     type InstanceGetResponse as InstanceGetResponse,
+    type InstanceStepResponse as InstanceStepResponse,
     InstanceListResponsesV4PagePaginationArray as InstanceListResponsesV4PagePaginationArray,
     InstanceBulkResponsesSinglePage as InstanceBulkResponsesSinglePage,
     type InstanceCreateParams as InstanceCreateParams,
     type InstanceListParams as InstanceListParams,
     type InstanceBulkParams as InstanceBulkParams,
     type InstanceGetParams as InstanceGetParams,
+    type InstanceStepParams as InstanceStepParams,
   };
 
   export {