@mobilerun/sdk 5.4.0 → 5.6.0

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

@@ -17,13 +17,25 @@ export {
   type FlowUpdateResponse,
   type FlowListResponse,
   type FlowDeleteResponse,
+  type FlowActivateResponse,
+  type FlowCapacityResponse,
   type FlowCloneResponse,
+  type FlowDeliveryOptionsResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,
+  type FlowRunResponse,
+  type FlowTemplateContextResponse,
   type FlowUnblockResponse,
+  type FlowValidateResponse,
+  type FlowVerifyResponse,
   type FlowCreateParams,
   type FlowUpdateParams,
   type FlowListParams,
+  type FlowActivateParams,
   type FlowCloneParams,
   type FlowDryRunParams,
+  type FlowRunParams,
+  type FlowTemplateContextParams,
+  type FlowValidateParams,
+  type FlowVerifyParams,
 } from './flows';

package/src/resources/workflows/index.ts

@@ -32,7 +32,7 @@ export {
   type ExecutionGetMetricsResponse,
   type ExecutionListParams,
   type ExecutionGetMetricsParams,
-} from './executions';
+} from './executions/index';
 export {
   Flows,
   type FlowCreateResponse,
@@ -40,15 +40,27 @@ export {
   type FlowUpdateResponse,
   type FlowListResponse,
   type FlowDeleteResponse,
+  type FlowActivateResponse,
+  type FlowCapacityResponse,
   type FlowCloneResponse,
+  type FlowDeliveryOptionsResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,
+  type FlowRunResponse,
+  type FlowTemplateContextResponse,
   type FlowUnblockResponse,
+  type FlowValidateResponse,
+  type FlowVerifyResponse,
   type FlowCreateParams,
   type FlowUpdateParams,
   type FlowListParams,
+  type FlowActivateParams,
   type FlowCloneParams,
   type FlowDryRunParams,
+  type FlowRunParams,
+  type FlowTemplateContextParams,
+  type FlowValidateParams,
+  type FlowVerifyParams,
 } from './flows/index';
 export { Timezones, type TimezoneListResponse } from './timezones';
 export {

package/src/resources/workflows/triggers.ts

@@ -12,6 +12,10 @@ export class Triggers extends APIResource {
    * Each type requires its own fields (e.g. `eventType` and optional `conditions`
    * for events, `scheduleRule` and `timezone` for schedules, `customPayloadSchema`
    * for custom triggers); mismatched fields are rejected.
+   *
+   * 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`.
    */
   create(body: TriggerCreateParams, options?: RequestOptions): APIPromise<TriggerCreateResponse> {
     return this._client.post('/triggers', { body, ...options });
@@ -74,6 +78,16 @@ export class Triggers extends APIResource {
    *
    * Only triggers with `activation = "custom"` can be fired through this endpoint;
    * event and schedule triggers return 409.
+   *
+   * Supports an optional `Idempotency-Key` header (1-255 printable ASCII
+   * characters), which maps to the derived `invocationId` used for fan-out
+   * deduplication (the deprecated `invocationId` body field wins when both are
+   * supplied, and a mismatch between them is logged). The payload is bound to the
+   * key on the first accepted fire, before fan-out. A repeat with the same key and
+   * an identical payload returns 202 with `Idempotent-Replayed: true`
+   * (`deduplicated: true` when flows were skipped; `enqueuedCount` counts only
+   * executions enqueued by that call); a changed payload under the same key returns
+   * 422 `idempotency_key_reused`.
    */
   fire(
     triggerID: string,
@@ -186,7 +200,7 @@ export namespace TriggerRetrieveResponse {
 
     ownerId: string;
 
-    scheduleRule: unknown;
+    scheduleRule: Data.ScheduleRule;
 
     timezone: string | null;
 
@@ -201,6 +215,43 @@ export namespace TriggerRetrieveResponse {
 
     nextFireTime?: string | null;
   }
+
+  export namespace Data {
+    export interface ScheduleRule {
+      type: 'once' | 'cron' | 'recurring';
+
+      /**
+       * ISO 8601 datetime (for type=once)
+       */
+      dateTime?: string;
+
+      /**
+       * Cron expression (for type=cron)
+       */
+      expression?: string;
+
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      jitter?: ScheduleRule.Jitter;
+
+      /**
+       * RRULE string (for type=recurring)
+       */
+      rrule?: string;
+    }
+
+    export namespace ScheduleRule {
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      export interface Jitter {
+        afterMinutes?: number;
+
+        beforeMinutes?: number;
+      }
+    }
+  }
 }
 
 export interface TriggerUpdateResponse {
@@ -227,7 +278,7 @@ export namespace TriggerUpdateResponse {
 
     ownerId: string;
 
-    scheduleRule: unknown;
+    scheduleRule: Data.ScheduleRule;
 
     timezone: string | null;
 
@@ -242,6 +293,43 @@ export namespace TriggerUpdateResponse {
 
     nextFireTime?: string | null;
   }
+
+  export namespace Data {
+    export interface ScheduleRule {
+      type: 'once' | 'cron' | 'recurring';
+
+      /**
+       * ISO 8601 datetime (for type=once)
+       */
+      dateTime?: string;
+
+      /**
+       * Cron expression (for type=cron)
+       */
+      expression?: string;
+
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      jitter?: ScheduleRule.Jitter;
+
+      /**
+       * RRULE string (for type=recurring)
+       */
+      rrule?: string;
+    }
+
+    export namespace ScheduleRule {
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      export interface Jitter {
+        afterMinutes?: number;
+
+        beforeMinutes?: number;
+      }
+    }
+  }
 }
 
 export interface TriggerListResponse {
@@ -270,7 +358,7 @@ export namespace TriggerListResponse {
 
     ownerId: string;
 
-    scheduleRule: unknown;
+    scheduleRule: Item.ScheduleRule;
 
     timezone: string | null;
 
@@ -285,6 +373,43 @@ export namespace TriggerListResponse {
 
     nextFireTime?: string | null;
   }
+
+  export namespace Item {
+    export interface ScheduleRule {
+      type: 'once' | 'cron' | 'recurring';
+
+      /**
+       * ISO 8601 datetime (for type=once)
+       */
+      dateTime?: string;
+
+      /**
+       * Cron expression (for type=cron)
+       */
+      expression?: string;
+
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      jitter?: ScheduleRule.Jitter;
+
+      /**
+       * RRULE string (for type=recurring)
+       */
+      rrule?: string;
+    }
+
+    export namespace ScheduleRule {
+      /**
+       * Optional per-occurrence random window around the nominal schedule time
+       */
+      export interface Jitter {
+        afterMinutes?: number;
+
+        beforeMinutes?: number;
+      }
+    }
+  }
 }
 
 export interface TriggerDeleteResponse {
@@ -292,15 +417,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;
 }

package/src/resources/workflows/workflows.ts

@@ -16,16 +16,6 @@ import {
   EventIngestResponse,
   Events,
 } from './events';
-import * as ExecutionsAPI from './executions';
-import {
-  ExecutionAbortResponse,
-  ExecutionGetMetricsParams,
-  ExecutionGetMetricsResponse,
-  ExecutionListParams,
-  ExecutionListResponse,
-  ExecutionRetrieveResponse,
-  Executions,
-} from './executions';
 import * as TimezonesAPI from './timezones';
 import { TimezoneListResponse, Timezones } from './timezones';
 import * as TriggersAPI from './triggers';
@@ -54,22 +44,44 @@ import {
   ActionUpdateResponse,
   Actions,
 } from './actions/actions';
+import * as ExecutionsAPI from './executions/executions';
+import {
+  ExecutionAbortResponse,
+  ExecutionGetMetricsParams,
+  ExecutionGetMetricsResponse,
+  ExecutionListParams,
+  ExecutionListResponse,
+  ExecutionRetrieveResponse,
+  Executions,
+} from './executions/executions';
 import * as FlowsAPI from './flows/flows';
 import {
+  FlowActivateParams,
+  FlowActivateResponse,
+  FlowCapacityResponse,
   FlowCloneParams,
   FlowCloneResponse,
   FlowCreateParams,
   FlowCreateResponse,
   FlowDeleteResponse,
+  FlowDeliveryOptionsResponse,
   FlowDryRunParams,
   FlowDryRunResponse,
   FlowListParams,
   FlowListRepairsResponse,
   FlowListResponse,
   FlowRetrieveResponse,
+  FlowRunParams,
+  FlowRunResponse,
+  FlowTemplateContextParams,
+  FlowTemplateContextResponse,
   FlowUnblockResponse,
   FlowUpdateParams,
   FlowUpdateResponse,
+  FlowValidateParams,
+  FlowValidateResponse,
+  FlowVerifyParams,
+  FlowVerifyResponse,
   Flows,
 } from './flows/flows';
 
@@ -132,15 +144,27 @@ export declare namespace Workflows {
     type FlowUpdateResponse as FlowUpdateResponse,
     type FlowListResponse as FlowListResponse,
     type FlowDeleteResponse as FlowDeleteResponse,
+    type FlowActivateResponse as FlowActivateResponse,
+    type FlowCapacityResponse as FlowCapacityResponse,
     type FlowCloneResponse as FlowCloneResponse,
+    type FlowDeliveryOptionsResponse as FlowDeliveryOptionsResponse,
     type FlowDryRunResponse as FlowDryRunResponse,
     type FlowListRepairsResponse as FlowListRepairsResponse,
+    type FlowRunResponse as FlowRunResponse,
+    type FlowTemplateContextResponse as FlowTemplateContextResponse,
     type FlowUnblockResponse as FlowUnblockResponse,
+    type FlowValidateResponse as FlowValidateResponse,
+    type FlowVerifyResponse as FlowVerifyResponse,
     type FlowCreateParams as FlowCreateParams,
     type FlowUpdateParams as FlowUpdateParams,
     type FlowListParams as FlowListParams,
+    type FlowActivateParams as FlowActivateParams,
     type FlowCloneParams as FlowCloneParams,
     type FlowDryRunParams as FlowDryRunParams,
+    type FlowRunParams as FlowRunParams,
+    type FlowTemplateContextParams as FlowTemplateContextParams,
+    type FlowValidateParams as FlowValidateParams,
+    type FlowVerifyParams as FlowVerifyParams,
   };
 
   export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.4.0'; // x-release-please-version
+export const VERSION = '5.6.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.4.0";
+export declare const VERSION = "5.6.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.4.0'; // x-release-please-version
+exports.VERSION = '5.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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