@mobilerun/sdk 5.3.0 → 5.5.0

package/src/resources/workflows/events.ts

@@ -49,10 +49,14 @@ export namespace EventDryRunResponse {
       export interface Action {
         continueOnError: boolean;
 
+        flowActionId: string;
+
         method: string;
 
         name: string;
 
+        recordingEnabled: boolean;
+
         service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
 
         /**
@@ -67,6 +71,8 @@ export namespace EventDryRunResponse {
       export interface Flow {
         id: string;
 
+        archivedAt: string | null;
+
         blockedAt: string | null;
 
         consecutiveFailures: number;
@@ -83,6 +89,10 @@ export namespace EventDryRunResponse {
 
         deviceIds: Array<string>;
 
+        /**
+         * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+         * enabled.
+         */
         enabled: boolean;
 
         healthMonitoringEnabled: boolean;
@@ -100,6 +110,8 @@ export namespace EventDryRunResponse {
 
         lastTriggeredAt: string | null;
 
+        lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
         name: string;
 
         notifyOnFailure: boolean;
@@ -110,8 +122,14 @@ export namespace EventDryRunResponse {
 
         ownerId: string;
 
+        /**
+         * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+         * recordingEnabled=true, "off" = recordingEnabled=false).
+         */
         recordingEnabled: boolean;
 
+        recordingPolicy: Flow.RecordingPolicy;
+
         selfHealingEnabled: boolean;
 
         selfHealingMaxAttempts: number;
@@ -136,6 +154,12 @@ export namespace EventDryRunResponse {
         userId: string;
       }
 
+      export namespace Flow {
+        export interface RecordingPolicy {
+          mode: 'off' | 'flow' | 'selected_steps';
+        }
+      }
+
       export interface Gates {
         blocked: boolean;
 

package/src/resources/workflows/executions.ts

@@ -17,8 +17,9 @@ export class Executions extends APIResource {
 
   /**
    * Return a paginated history of flow executions. Supports filtering by `flowId`,
-   * `triggerId`, `status`, and a `from`/`to` time range, plus free-text `search` and
-   * ordering by startedAt, finishedAt, or status.
+   * `triggerId`, `invocationId` (the client/verify key), `status`, and a `from`/`to`
+   * time range, plus free-text `search` and ordering by startedAt, finishedAt, or
+   * status.
    */
   list(
     query: ExecutionListParams | null | undefined = {},
@@ -58,6 +59,12 @@ export namespace ExecutionRetrieveResponse {
 
     createdBy: string | null;
 
+    /**
+     * Device this execution targets (the job's deviceId). Null for device-less
+     * (event-only) runs.
+     */
+    deviceId: string | null;
+
     error: string | null;
 
     eventId: string | null;
@@ -75,7 +82,14 @@ export namespace ExecutionRetrieveResponse {
 
     flowName: string | null;
 
-    kind: 'live' | 'dry_run';
+    /**
+     * Client/verify invocation key this row belongs to. Set on live custom fires (one
+     * row per device fan-out) and on verification runs; null for event/schedule live
+     * rows.
+     */
+    invocationId: string | null;
+
+    kind: 'live' | 'dry_run' | 'verification';
 
     recordingDeviceId: string | null;
 
@@ -86,6 +100,12 @@ export namespace ExecutionRetrieveResponse {
      */
     recordingId: string | null;
 
+    /**
+     * Durable recording segments ordered by step/loop coordinate and retry attempt.
+     * Whole-flow recordings use -1 for every coordinate.
+     */
+    recordings: Array<Data.Recording>;
+
     startedAt: string | null;
 
     status: 'pending' | 'running' | 'success' | 'failed' | 'cancelled' | 'skipped' | 'invalid' | null;
@@ -115,6 +135,36 @@ export namespace ExecutionRetrieveResponse {
 
       sizeBytes: number;
     }
+
+    export interface Recording {
+      id: string;
+
+      attempt: number;
+
+      childIndex: number;
+
+      flowActionId: string | null;
+
+      iterationIndex: number;
+
+      lastError: string | null;
+
+      parentIndex: number;
+
+      recordingDeviceId: string | null;
+
+      recordingId: string | null;
+
+      scope: 'flow' | 'step';
+
+      startedAt: string | null;
+
+      status: 'starting' | 'recording' | 'stopping' | 'stopped' | 'failed';
+
+      stepIndex: number;
+
+      stoppedAt: string | null;
+    }
   }
 }
 
@@ -130,6 +180,12 @@ export namespace ExecutionListResponse {
 
     createdBy: string | null;
 
+    /**
+     * Device this execution targets (the job's deviceId). Null for device-less
+     * (event-only) runs.
+     */
+    deviceId: string | null;
+
     error: string | null;
 
     eventId: string | null;
@@ -140,7 +196,14 @@ export namespace ExecutionListResponse {
 
     flowName: string | null;
 
-    kind: 'live' | 'dry_run';
+    /**
+     * Client/verify invocation key this row belongs to. Set on live custom fires (one
+     * row per device fan-out) and on verification runs; null for event/schedule live
+     * rows.
+     */
+    invocationId: string | null;
+
+    kind: 'live' | 'dry_run' | 'verification';
 
     recordingDeviceId: string | null;
 
@@ -151,6 +214,12 @@ export namespace ExecutionListResponse {
      */
     recordingId: string | null;
 
+    /**
+     * Durable recording segments ordered by step/loop coordinate and retry attempt.
+     * Whole-flow recordings use -1 for every coordinate.
+     */
+    recordings: Array<Item.Recording>;
+
     startedAt: string | null;
 
     status: 'pending' | 'running' | 'success' | 'failed' | 'cancelled' | 'skipped' | 'invalid' | null;
@@ -169,6 +238,38 @@ export namespace ExecutionListResponse {
      */
     result?: unknown;
   }
+
+  export namespace Item {
+    export interface Recording {
+      id: string;
+
+      attempt: number;
+
+      childIndex: number;
+
+      flowActionId: string | null;
+
+      iterationIndex: number;
+
+      lastError: string | null;
+
+      parentIndex: number;
+
+      recordingDeviceId: string | null;
+
+      recordingId: string | null;
+
+      scope: 'flow' | 'step';
+
+      startedAt: string | null;
+
+      status: 'starting' | 'recording' | 'stopping' | 'stopped' | 'failed';
+
+      stepIndex: number;
+
+      stoppedAt: string | null;
+    }
+  }
 }
 
 export interface ExecutionAbortResponse {
@@ -179,6 +280,12 @@ export namespace ExecutionAbortResponse {
   export interface Data {
     id: string;
 
+    /**
+     * Device this execution targets (the job's deviceId). Null for device-less
+     * (event-only) runs.
+     */
+    deviceId: string | null;
+
     error: string | null;
 
     eventId: string | null;
@@ -189,7 +296,14 @@ export namespace ExecutionAbortResponse {
 
     flowName: string | null;
 
-    kind: 'live' | 'dry_run';
+    /**
+     * Client/verify invocation key this row belongs to. Set on live custom fires (one
+     * row per device fan-out) and on verification runs; null for event/schedule live
+     * rows.
+     */
+    invocationId: string | null;
+
+    kind: 'live' | 'dry_run' | 'verification';
 
     recordingDeviceId: string | null;
 
@@ -259,6 +373,8 @@ export interface ExecutionListParams {
 
   from?: string | null;
 
+  invocationId?: string;
+
   orderBy?: 'startedAt' | 'finishedAt' | 'status';
 
   orderByDirection?: 'asc' | 'desc';

package/src/resources/workflows/flows/actions.ts

@@ -75,6 +75,12 @@ export namespace ActionListResponse {
     parentFlowActionId: string | null;
 
     position: number;
+
+    /**
+     * Selected for per-step recording under the flow's "selected_steps" recording
+     * policy.
+     */
+    recordingEnabled: boolean;
   }
 
   export namespace Data {
@@ -107,6 +113,12 @@ export namespace ActionAddResponse {
     parentFlowActionId: string | null;
 
     position: number;
+
+    /**
+     * Selected for per-step recording under the flow's "selected_steps" recording
+     * policy.
+     */
+    recordingEnabled: boolean;
   }
 
   export namespace Data {
@@ -143,6 +155,12 @@ export namespace ActionReplaceResponse {
     parentFlowActionId: string | null;
 
     position: number;
+
+    /**
+     * Selected for per-step recording under the flow's "selected_steps" recording
+     * policy.
+     */
+    recordingEnabled: boolean;
   }
 
   export namespace Data {
@@ -166,6 +184,8 @@ export interface ActionAddParams {
   overrides?: ActionAddParams.Overrides | null;
 
   parentFlowActionId?: string | null;
+
+  recordingEnabled?: boolean;
 }
 
 export namespace ActionAddParams {
@@ -179,6 +199,8 @@ export namespace ActionAddParams {
     nameOverride?: string;
 
     overrides?: Child.Overrides | null;
+
+    recordingEnabled?: boolean;
   }
 
   export namespace Child {
@@ -213,6 +235,8 @@ export namespace ActionReplaceParams {
     nameOverride?: string;
 
     overrides?: Action.Overrides | null;
+
+    recordingEnabled?: boolean;
   }
 
   export namespace Action {
@@ -226,6 +250,8 @@ export namespace ActionReplaceParams {
       nameOverride?: string;
 
       overrides?: Child.Overrides | null;
+
+      recordingEnabled?: boolean;
     }
 
     export namespace Child {