@mobilerun/sdk 5.3.0 → 5.5.0

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

@@ -66,12 +66,23 @@ export class Flows extends APIResource {
   }
 
   /**
-   * Delete a flow by its ID. Returns 404 if no flow matches.
+   * Terminally archive a flow by its ID. Archived flows cannot be restored and are
+   * hidden from customer reads. Repeating the request is idempotent for the owner.
    */
   delete(flowID: string, options?: RequestOptions): APIPromise<FlowDeleteResponse> {
     return this._client.delete(path`/flows/${flowID}`, options);
   }
 
+  /**
+   * Returns an owner-scoped snapshot of finite included workflow-agent capacity
+   * after locally stored enabled and disabled agents. Available only while slot
+   * enforcement is enabled; otherwise returns 503. This is advisory; create and
+   * clone perform authoritative admission under an owner lock.
+   */
+  capacity(options?: RequestOptions): APIPromise<FlowCapacityResponse> {
+    return this._client.get('/flows/capacity', options);
+  }
+
   /**
    * Create a copy of an existing flow, including its actions and settings. The
    * optional body can override the new flow's `name` and target `deviceIds`. Returns
@@ -133,6 +144,8 @@ export namespace FlowCreateResponse {
   export interface Data {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -149,6 +162,10 @@ export namespace FlowCreateResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -166,6 +183,8 @@ export namespace FlowCreateResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -176,8 +195,14 @@ export namespace FlowCreateResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Data.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -201,6 +226,12 @@ export namespace FlowCreateResponse {
      */
     userId: string;
   }
+
+  export namespace Data {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowRetrieveResponse {
@@ -211,6 +242,8 @@ export namespace FlowRetrieveResponse {
   export interface Data {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -227,6 +260,10 @@ export namespace FlowRetrieveResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -244,6 +281,8 @@ export namespace FlowRetrieveResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -254,8 +293,14 @@ export namespace FlowRetrieveResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Data.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -279,6 +324,12 @@ export namespace FlowRetrieveResponse {
      */
     userId: string;
   }
+
+  export namespace Data {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowUpdateResponse {
@@ -289,6 +340,8 @@ export namespace FlowUpdateResponse {
   export interface Data {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -305,6 +358,10 @@ export namespace FlowUpdateResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -322,6 +379,8 @@ export namespace FlowUpdateResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -332,8 +391,14 @@ export namespace FlowUpdateResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Data.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -357,6 +422,12 @@ export namespace FlowUpdateResponse {
      */
     userId: string;
   }
+
+  export namespace Data {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowListResponse {
@@ -369,6 +440,8 @@ export namespace FlowListResponse {
   export interface Item {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -385,6 +458,10 @@ export namespace FlowListResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -402,6 +479,8 @@ export namespace FlowListResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -412,8 +491,14 @@ export namespace FlowListResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Item.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -437,12 +522,32 @@ export namespace FlowListResponse {
      */
     userId: string;
   }
+
+  export namespace Item {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowDeleteResponse {
   message: string;
 }
 
+export interface FlowCapacityResponse {
+  data: FlowCapacityResponse.Data;
+}
+
+export namespace FlowCapacityResponse {
+  export interface Data {
+    included: number;
+
+    remaining: number;
+
+    status: 'available' | 'exhausted' | 'not_included';
+  }
+}
+
 export interface FlowCloneResponse {
   data: FlowCloneResponse.Data;
 }
@@ -451,6 +556,8 @@ export namespace FlowCloneResponse {
   export interface Data {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -467,6 +574,10 @@ export namespace FlowCloneResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -484,6 +595,8 @@ export namespace FlowCloneResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -494,8 +607,14 @@ export namespace FlowCloneResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Data.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -519,6 +638,12 @@ export namespace FlowCloneResponse {
      */
     userId: string;
   }
+
+  export namespace Data {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowDryRunResponse {
@@ -548,10 +673,14 @@ export namespace FlowDryRunResponse {
     export interface Action {
       continueOnError: boolean;
 
+      flowActionId: string;
+
       method: string;
 
       name: string;
 
+      recordingEnabled: boolean;
+
       service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
 
       /**
@@ -655,6 +784,8 @@ export namespace FlowUnblockResponse {
   export interface Data {
     id: string;
 
+    archivedAt: string | null;
+
     blockedAt: string | null;
 
     consecutiveFailures: number;
@@ -671,6 +802,10 @@ export namespace FlowUnblockResponse {
 
     deviceIds: Array<string>;
 
+    /**
+     * Compatibility projection of lifecycleStatus; true only when lifecycleStatus is
+     * enabled.
+     */
     enabled: boolean;
 
     healthMonitoringEnabled: boolean;
@@ -688,6 +823,8 @@ export namespace FlowUnblockResponse {
 
     lastTriggeredAt: string | null;
 
+    lifecycleStatus: 'enabled' | 'disabled' | 'archived';
+
     name: string;
 
     notifyOnFailure: boolean;
@@ -698,8 +835,14 @@ export namespace FlowUnblockResponse {
 
     ownerId: string;
 
+    /**
+     * @deprecated Deprecated: use recordingPolicy.mode ("flow" =
+     * recordingEnabled=true, "off" = recordingEnabled=false).
+     */
     recordingEnabled: boolean;
 
+    recordingPolicy: Data.RecordingPolicy;
+
     selfHealingEnabled: boolean;
 
     selfHealingMaxAttempts: number;
@@ -723,6 +866,12 @@ export namespace FlowUnblockResponse {
      */
     userId: string;
   }
+
+  export namespace Data {
+    export interface RecordingPolicy {
+      mode: 'off' | 'flow' | 'selected_steps';
+    }
+  }
 }
 
 export interface FlowCreateParams {
@@ -750,8 +899,14 @@ export interface FlowCreateParams {
 
   notifyWebhookId?: string | null;
 
+  /**
+   * @deprecated Deprecated compatibility field. true maps to
+   * recordingPolicy.mode="flow"; false maps to "off".
+   */
   recordingEnabled?: boolean;
 
+  recordingPolicy?: FlowCreateParams.RecordingPolicy;
+
   selfHealingEnabled?: boolean;
 
   selfHealingMaxAttempts?: number;
@@ -770,6 +925,8 @@ export namespace FlowCreateParams {
     nameOverride?: string;
 
     overrides?: Action.Overrides | null;
+
+    recordingEnabled?: boolean;
   }
 
   export namespace Action {
@@ -783,6 +940,8 @@ export namespace FlowCreateParams {
       nameOverride?: string;
 
       overrides?: Child.Overrides | null;
+
+      recordingEnabled?: boolean;
     }
 
     export namespace Child {
@@ -795,6 +954,10 @@ export namespace FlowCreateParams {
       params?: { [key: string]: unknown };
     }
   }
+
+  export interface RecordingPolicy {
+    mode: 'off' | 'flow' | 'selected_steps';
+  }
 }
 
 export interface FlowUpdateParams {
@@ -810,6 +973,11 @@ export interface FlowUpdateParams {
 
   healthMonitoringEnabled?: boolean;
 
+  /**
+   * Set the visible agent lifecycle. Archive remains available only through DELETE.
+   */
+  lifecycleStatus?: 'enabled' | 'disabled';
+
   name?: string;
 
   notifyOnFailure?: boolean;
@@ -818,8 +986,14 @@ export interface FlowUpdateParams {
 
   notifyWebhookId?: string | null;
 
+  /**
+   * @deprecated Deprecated compatibility field. true maps to
+   * recordingPolicy.mode="flow"; false maps to "off".
+   */
   recordingEnabled?: boolean;
 
+  recordingPolicy?: FlowUpdateParams.RecordingPolicy;
+
   selfHealingEnabled?: boolean;
 
   selfHealingMaxAttempts?: number;
@@ -827,6 +1001,12 @@ export interface FlowUpdateParams {
   triggerId?: string;
 }
 
+export namespace FlowUpdateParams {
+  export interface RecordingPolicy {
+    mode: 'off' | 'flow' | 'selected_steps';
+  }
+}
+
 export interface FlowListParams {
   createdBy?: string;
 
@@ -874,6 +1054,7 @@ export declare namespace Flows {
     type FlowUpdateResponse as FlowUpdateResponse,
     type FlowListResponse as FlowListResponse,
     type FlowDeleteResponse as FlowDeleteResponse,
+    type FlowCapacityResponse as FlowCapacityResponse,
     type FlowCloneResponse as FlowCloneResponse,
     type FlowDryRunResponse as FlowDryRunResponse,
     type FlowListRepairsResponse as FlowListRepairsResponse,

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

@@ -17,6 +17,7 @@ export {
   type FlowUpdateResponse,
   type FlowListResponse,
   type FlowDeleteResponse,
+  type FlowCapacityResponse,
   type FlowCloneResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,

package/src/resources/workflows/index.ts

@@ -40,6 +40,7 @@ export {
   type FlowUpdateResponse,
   type FlowListResponse,
   type FlowDeleteResponse,
+  type FlowCapacityResponse,
   type FlowCloneResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,

package/src/resources/workflows/triggers.ts

@@ -292,15 +292,24 @@ export interface TriggerDeleteResponse {
 }
 
 export interface TriggerFireResponse {
+  /**
+   * True when at least one attached flow was skipped because it already had an
+   * execution for this (flow, invocationId). Only ever true when the client supplied
+   * invocationId.
+   */
+  deduplicated: boolean;
+
   /**
    * Number of flow executions enqueued. May be 0 if no flows are attached to this
-   * trigger, or if all attached flows are currently in cooldown.
+   * trigger, if all attached flows are currently in cooldown, or if every attached
+   * flow was deduplicated.
    */
   enqueuedCount: number;
 
   /**
-   * Unique ID for this fire invocation. Job IDs in the execution queue are derived
-   * from it (one per enqueued flow).
+   * Unique ID for this fire invocation (echoes the client-supplied invocationId, or
+   * a generated one). Job IDs in the execution queue are derived from it (one per
+   * enqueued flow).
    */
   invocationId: string;
 }
@@ -456,6 +465,13 @@ export interface TriggerFireParams {
    * otherwise only "must be a JSON object" is enforced.
    */
   payload: { [key: string]: unknown };
+
+  /**
+   * Optional client-supplied idempotency key. When provided, a flow that already has
+   * an execution for this (flow, invocationId) is skipped and `deduplicated` is
+   * true. When omitted a fresh server-side id is generated (no dedup).
+   */
+  invocationId?: string;
 }
 
 export declare namespace Triggers {

package/src/resources/workflows/workflows.ts

@@ -56,6 +56,7 @@ import {
 } from './actions/actions';
 import * as FlowsAPI from './flows/flows';
 import {
+  FlowCapacityResponse,
   FlowCloneParams,
   FlowCloneResponse,
   FlowCreateParams,
@@ -132,6 +133,7 @@ export declare namespace Workflows {
     type FlowUpdateResponse as FlowUpdateResponse,
     type FlowListResponse as FlowListResponse,
     type FlowDeleteResponse as FlowDeleteResponse,
+    type FlowCapacityResponse as FlowCapacityResponse,
     type FlowCloneResponse as FlowCloneResponse,
     type FlowDryRunResponse as FlowDryRunResponse,
     type FlowListRepairsResponse as FlowListRepairsResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.3.0'; // x-release-please-version
+export const VERSION = '5.5.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.3.0";
+export declare const VERSION = "5.5.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.3.0";
+export declare const VERSION = "5.5.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.3.0'; // x-release-please-version
+exports.VERSION = '5.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.3.0'; // x-release-please-version
+export const VERSION = '5.5.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map