@mobilerun/sdk 5.5.0 → 6.0.0

package/src/resources/workflows/executions/screenshots.ts

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Screenshots extends APIResource {
+  /**
+   * Redirects (302) to a freshly signed, time-limited image URL for a screenshot
+   * captured during this execution. Owner-gated: 404 if the execution or the
+   * screenshot does not belong to the caller.
+   */
+  retrieve(
+    screenshotID: string,
+    params: ScreenshotRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { executionId } = params;
+    return this._client.get(path`/executions/${executionId}/screenshots/${screenshotID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface ScreenshotRetrieveParams {
+  executionId: string;
+}
+
+export declare namespace Screenshots {
+  export { type ScreenshotRetrieveParams as ScreenshotRetrieveParams };
+}

package/src/resources/workflows/executions.ts

@@ -1,414 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as Shared from '../shared';
-import { APIPromise } from '../../core/api-promise';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
-
-export class Executions extends APIResource {
-  /**
-   * Fetch a single flow execution by its ID, including its status, kind, result or
-   * error, and start/finish timestamps. Returns 404 if no execution matches.
-   */
-  retrieve(executionID: string, options?: RequestOptions): APIPromise<ExecutionRetrieveResponse> {
-    return this._client.get(path`/executions/${executionID}`, options);
-  }
-
-  /**
-   * Return a paginated history of flow executions. Supports filtering by `flowId`,
-   * `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 = {},
-    options?: RequestOptions,
-  ): APIPromise<ExecutionListResponse> {
-    return this._client.get('/executions', { query, ...options });
-  }
-
-  /**
-   * Signals the worker to stop the execution between steps and marks it cancelled.
-   * Idempotent-ish: already-terminal executions return 409.
-   */
-  abort(executionID: string, options?: RequestOptions): APIPromise<ExecutionAbortResponse> {
-    return this._client.post(path`/executions/${executionID}/abort`, options);
-  }
-
-  /**
-   * Return aggregate execution metrics — total count, counts by status, average
-   * duration, and the last execution time. Can be scoped by `flowId`, `triggerId`,
-   * and a `from`/`to` time range.
-   */
-  getMetrics(
-    query: ExecutionGetMetricsParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ExecutionGetMetricsResponse> {
-    return this._client.get('/executions/metrics', { query, ...options });
-  }
-}
-
-export interface ExecutionRetrieveResponse {
-  data: ExecutionRetrieveResponse.Data;
-}
-
-export namespace ExecutionRetrieveResponse {
-  export interface Data {
-    id: string;
-
-    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;
-
-    /**
-     * Files produced by files.upload steps, plus files an agent.run step reported on
-     * its terminal response (agent-created output or a workflow upload minted during
-     * the turn); derived server-side at read time.
-     */
-    files: Array<Data.File>;
-
-    finishedAt: string | null;
-
-    flowId: string;
-
-    flowName: string | null;
-
-    /**
-     * 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;
-
-    /**
-     * Device-recording id (devices-api) for this execution, set once the worker starts
-     * a recording. Null when the flow has recording disabled, no device is bound, or
-     * the recording failed to start.
-     */
-    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;
-
-    triggerId: string;
-
-    triggerName: string | null;
-
-    /**
-     * Opaque per-step result blob ({ steps: [...] }). Each step additionally carries a
-     * `verdict` field ({ outcome, summary, reason? } | null) when it is an agent.run
-     * step that opted into a verdict — null otherwise. Table-backed steps (current
-     * executions) also carry a `status` string (e.g. success/failed/stopped, see
-     * deriveStepStatus); it is optional and absent on legacy blob-only executions, so
-     * clients must not assume its presence.
-     */
-    result?: unknown;
-  }
-
-  export namespace Data {
-    export interface File {
-      fileId: string;
-
-      filename: string;
-
-      mimeType: string;
-
-      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;
-    }
-  }
-}
-
-export interface ExecutionListResponse {
-  items: Array<ExecutionListResponse.Item>;
-
-  pagination: Shared.Pagination;
-}
-
-export namespace ExecutionListResponse {
-  export interface Item {
-    id: string;
-
-    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;
-
-    finishedAt: string | null;
-
-    flowId: string;
-
-    flowName: string | null;
-
-    /**
-     * 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;
-
-    /**
-     * Device-recording id (devices-api) for this execution, set once the worker starts
-     * a recording. Null when the flow has recording disabled, no device is bound, or
-     * the recording failed to start.
-     */
-    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;
-
-    triggerId: string;
-
-    triggerName: string | null;
-
-    /**
-     * Opaque per-step result blob ({ steps: [...] }). Each step additionally carries a
-     * `verdict` field ({ outcome, summary, reason? } | null) when it is an agent.run
-     * step that opted into a verdict — null otherwise. Table-backed steps (current
-     * executions) also carry a `status` string (e.g. success/failed/stopped, see
-     * deriveStepStatus); it is optional and absent on legacy blob-only executions, so
-     * clients must not assume its presence.
-     */
-    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 {
-  data: ExecutionAbortResponse.Data;
-}
-
-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;
-
-    finishedAt: string | null;
-
-    flowId: string;
-
-    flowName: string | null;
-
-    /**
-     * 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;
-
-    /**
-     * Device-recording id (devices-api) for this execution, set once the worker starts
-     * a recording. Null when the flow has recording disabled, no device is bound, or
-     * the recording failed to start.
-     */
-    recordingId: string | null;
-
-    startedAt: string | null;
-
-    status: 'pending' | 'running' | 'success' | 'failed' | 'cancelled' | 'skipped' | 'invalid' | null;
-
-    triggerId: string;
-
-    triggerName: string | null;
-
-    /**
-     * Opaque per-step result blob ({ steps: [...] }). Each step additionally carries a
-     * `verdict` field ({ outcome, summary, reason? } | null) when it is an agent.run
-     * step that opted into a verdict — null otherwise. Table-backed steps (current
-     * executions) also carry a `status` string (e.g. success/failed/stopped, see
-     * deriveStepStatus); it is optional and absent on legacy blob-only executions, so
-     * clients must not assume its presence.
-     */
-    result?: unknown;
-  }
-}
-
-export interface ExecutionGetMetricsResponse {
-  data: ExecutionGetMetricsResponse.Data;
-}
-
-export namespace ExecutionGetMetricsResponse {
-  export interface Data {
-    avgDurationMs: number | null;
-
-    byStatus: Data.ByStatus;
-
-    lastExecutionAt: string | null;
-
-    total: number;
-  }
-
-  export namespace Data {
-    export interface ByStatus {
-      cancelled: number;
-
-      failed: number;
-
-      invalid: number;
-
-      pending: number;
-
-      running: number;
-
-      skipped: number;
-
-      success: number;
-    }
-  }
-}
-
-export interface ExecutionListParams {
-  flowId?: string;
-
-  from?: string | null;
-
-  invocationId?: string;
-
-  orderBy?: 'startedAt' | 'finishedAt' | 'status';
-
-  orderByDirection?: 'asc' | 'desc';
-
-  page?: number;
-
-  pageSize?: number;
-
-  search?: string;
-
-  status?: 'pending' | 'running' | 'success' | 'failed' | 'cancelled' | 'skipped' | 'invalid';
-
-  to?: string | null;
-
-  triggerId?: string;
-}
-
-export interface ExecutionGetMetricsParams {
-  flowId?: string;
-
-  from?: string | null;
-
-  to?: string | null;
-
-  triggerId?: string;
-}
-
-export declare namespace Executions {
-  export {
-    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
-    type ExecutionListResponse as ExecutionListResponse,
-    type ExecutionAbortResponse as ExecutionAbortResponse,
-    type ExecutionGetMetricsResponse as ExecutionGetMetricsResponse,
-    type ExecutionListParams as ExecutionListParams,
-    type ExecutionGetMetricsParams as ExecutionGetMetricsParams,
-  };
-}
+export * from './executions/index';

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

@@ -19,6 +19,10 @@ export class Actions extends APIResource {
    * under a `parentFlowActionId` or supplying its own `children`. Supports a
    * `nameOverride`, param `overrides`, and `continueOnError`. Returns 404 if the
    * flow does not exist.
+   *
+   * Supports an optional `Idempotency-Key` header (1-255 printable ASCII
+   * characters). Replays with the same key and an identical body return the original
+   * 201; a changed body under the same key returns 422 `idempotency_key_reused`.
    */
   add(flowID: string, body: ActionAddParams, options?: RequestOptions): APIPromise<ActionAddResponse> {
     return this._client.post(path`/flows/${flowID}/actions`, { body, ...options });
@@ -68,6 +72,8 @@ export namespace ActionListResponse {
 
     flowId: string;
 
+    key: string;
+
     nameOverride: string | null;
 
     overrides: Data.Overrides | null;
@@ -106,6 +112,8 @@ export namespace ActionAddResponse {
 
     flowId: string;
 
+    key: string;
+
     nameOverride: string | null;
 
     overrides: Data.Overrides | null;
@@ -148,6 +156,8 @@ export namespace ActionReplaceResponse {
 
     flowId: string;
 
+    key: string;
+
     nameOverride: string | null;
 
     overrides: Data.Overrides | null;
@@ -179,6 +189,15 @@ export interface ActionAddParams {
 
   continueOnError?: boolean;
 
+  /**
+   * Stable identifier used by template resolution v2+ to address this step as
+   * {{key.field}}. Omitted keys are derived from the step name whenever a flow is
+   * created. For template resolution v3, replacing an existing flow's full action
+   * tree requires every step to carry an explicit key — a missing key is rejected
+   * there, not derived, so a name change can never silently move a step's key.
+   */
+  key?: string;
+
   nameOverride?: string;
 
   overrides?: ActionAddParams.Overrides | null;
@@ -196,6 +215,15 @@ export namespace ActionAddParams {
 
     continueOnError?: boolean;
 
+    /**
+     * Stable identifier used by template resolution v2+ to address this step as
+     * {{key.field}}. Omitted keys are derived from the step name whenever a flow is
+     * created. For template resolution v3, replacing an existing flow's full action
+     * tree requires every step to carry an explicit key — a missing key is rejected
+     * there, not derived, so a name change can never silently move a step's key.
+     */
+    key?: string;
+
     nameOverride?: string;
 
     overrides?: Child.Overrides | null;
@@ -232,6 +260,15 @@ export namespace ActionReplaceParams {
 
     continueOnError?: boolean;
 
+    /**
+     * Stable identifier used by template resolution v2+ to address this step as
+     * {{key.field}}. Omitted keys are derived from the step name whenever a flow is
+     * created. For template resolution v3, replacing an existing flow's full action
+     * tree requires every step to carry an explicit key — a missing key is rejected
+     * there, not derived, so a name change can never silently move a step's key.
+     */
+    key?: string;
+
     nameOverride?: string;
 
     overrides?: Action.Overrides | null;
@@ -247,6 +284,15 @@ export namespace ActionReplaceParams {
 
       continueOnError?: boolean;
 
+      /**
+       * Stable identifier used by template resolution v2+ to address this step as
+       * {{key.field}}. Omitted keys are derived from the step name whenever a flow is
+       * created. For template resolution v3, replacing an existing flow's full action
+       * tree requires every step to carry an explicit key — a missing key is rejected
+       * there, not derived, so a name change can never silently move a step's key.
+       */
+      key?: string;
+
       nameOverride?: string;
 
       overrides?: Child.Overrides | null;