@mobilerun/sdk 6.0.1 → 6.1.1

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

@@ -23,6 +23,7 @@ export {
   type FlowDeliveryOptionsResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,
+  type FlowRetrieveRepairResponse,
   type FlowRunResponse,
   type FlowTemplateContextResponse,
   type FlowUnblockResponse,
@@ -35,8 +36,17 @@ export {
   type FlowCapacityParams,
   type FlowCloneParams,
   type FlowDryRunParams,
+  type FlowRetrieveRepairParams,
   type FlowRunParams,
   type FlowTemplateContextParams,
   type FlowValidateParams,
   type FlowVerifyParams,
 } from './flows';
+export {
+  State,
+  type StateListResponse,
+  type StateDeleteResponse,
+  type StateListVersionsResponse,
+  type StateDeleteParams,
+  type StateListVersionsParams,
+} from './state';

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

@@ -0,0 +1,103 @@
+// 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 { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class State extends APIResource {
+  /**
+   * List the keys a routine has saved with `state.save`, with the metadata of each
+   * key's newest version.
+   */
+  list(flowID: string, options?: RequestOptions): APIPromise<StateListResponse> {
+    return this._client.get(path`/flows/${flowID}/state`, options);
+  }
+
+  /**
+   * Delete every version of one state key. The next `state.load` of the key reports
+   * `found: false`. Deleting an unknown key succeeds.
+   */
+  delete(key: string, params: StateDeleteParams, options?: RequestOptions): APIPromise<StateDeleteResponse> {
+    const { flowId } = params;
+    return this._client.delete(path`/flows/${flowId}/state/${key}`, options);
+  }
+
+  /**
+   * Return the retained versions of one state key, newest first, including each
+   * saved value. An unknown key returns an empty list.
+   */
+  listVersions(
+    key: string,
+    params: StateListVersionsParams,
+    options?: RequestOptions,
+  ): APIPromise<StateListVersionsResponse> {
+    const { flowId } = params;
+    return this._client.get(path`/flows/${flowId}/state/${key}/versions`, options);
+  }
+}
+
+export interface StateListResponse {
+  data: Array<StateListResponse.Data>;
+}
+
+export namespace StateListResponse {
+  export interface Data {
+    key: string;
+
+    savedAt: string;
+
+    sizeBytes: number;
+
+    /**
+     * Newest saved version of this key
+     */
+    version: number;
+  }
+}
+
+export interface StateDeleteResponse {
+  message: string;
+}
+
+export interface StateListVersionsResponse {
+  data: Array<StateListVersionsResponse.Data>;
+}
+
+export namespace StateListVersionsResponse {
+  export interface Data {
+    /**
+     * Execution that saved this version
+     */
+    executionId: string;
+
+    savedAt: string;
+
+    sizeBytes: number;
+
+    version: number;
+
+    /**
+     * The saved JSON value
+     */
+    value?: unknown;
+  }
+}
+
+export interface StateDeleteParams {
+  flowId: string;
+}
+
+export interface StateListVersionsParams {
+  flowId: string;
+}
+
+export declare namespace State {
+  export {
+    type StateListResponse as StateListResponse,
+    type StateDeleteResponse as StateDeleteResponse,
+    type StateListVersionsResponse as StateListVersionsResponse,
+    type StateDeleteParams as StateDeleteParams,
+    type StateListVersionsParams as StateListVersionsParams,
+  };
+}

package/src/resources/workflows/index.ts

@@ -4,6 +4,7 @@ export {
   ActionCatalog,
   type ActionCatalogRetrieveResponse,
   type ActionCatalogListResponse,
+  type ActionCatalogRetrieveParams,
   type ActionCatalogListParams,
 } from './action-catalog';
 export {
@@ -14,6 +15,7 @@ export {
   type ActionListResponse,
   type ActionDeleteResponse,
   type ActionCreateParams,
+  type ActionRetrieveParams,
   type ActionUpdateParams,
   type ActionListParams,
 } from './actions/index';
@@ -46,6 +48,7 @@ export {
   type FlowDeliveryOptionsResponse,
   type FlowDryRunResponse,
   type FlowListRepairsResponse,
+  type FlowRetrieveRepairResponse,
   type FlowRunResponse,
   type FlowTemplateContextResponse,
   type FlowUnblockResponse,
@@ -58,6 +61,7 @@ export {
   type FlowCapacityParams,
   type FlowCloneParams,
   type FlowDryRunParams,
+  type FlowRetrieveRepairParams,
   type FlowRunParams,
   type FlowTemplateContextParams,
   type FlowValidateParams,

package/src/resources/workflows/triggers.ts

@@ -11,7 +11,12 @@ export class Triggers extends APIResource {
    * Create a trigger with an activation type of `event`, `schedule`, or `custom`.
    * 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.
+   * for custom or schedule triggers); mismatched fields are rejected. Schedule
+   * triggers may store an optional JSON object `payload` (at most 1 MiB); it
+   * requires `customPayloadSchema`, is validated against it (422 on mismatch), and
+   * is available as `event.payload` on every scheduled, manual, or verification run.
+   * When a schema is configured, omitted payload values are validated as an empty
+   * object.
    *
    * Supports an optional `Idempotency-Key` header (1-255 printable ASCII
    * characters). Replays with the same key and an identical body return the original
@@ -31,8 +36,12 @@ export class Triggers extends APIResource {
 
   /**
    * Partially update a trigger; all fields are optional. When `activation` is
-   * changed, the type-specific field rules are re-validated. Returns 404 if the
-   * trigger does not exist.
+   * changed, the type-specific field rules are re-validated. Schedule triggers
+   * accept stored `payload` values (at most 1 MiB); null clears them. The resulting
+   * payload must match customPayloadSchema (422 on mismatch, including schema
+   * changes that invalidate stored values). Absent or null values are validated as
+   * an empty object when a schema is configured. Changes apply from the next run.
+   * Returns 404 if the trigger does not exist.
    */
   update(
     triggerID: string,
@@ -120,6 +129,8 @@ export namespace TriggerCreateResponse {
 
     ownerId: string;
 
+    payload: { [key: string]: unknown } | null;
+
     scheduleRule: Data.ScheduleRule;
 
     timezone: string | null;
@@ -198,6 +209,8 @@ export namespace TriggerRetrieveResponse {
 
     ownerId: string;
 
+    payload: { [key: string]: unknown } | null;
+
     scheduleRule: Data.ScheduleRule;
 
     timezone: string | null;
@@ -276,6 +289,8 @@ export namespace TriggerUpdateResponse {
 
     ownerId: string;
 
+    payload: { [key: string]: unknown } | null;
+
     scheduleRule: Data.ScheduleRule;
 
     timezone: string | null;
@@ -356,6 +371,8 @@ export namespace TriggerListResponse {
 
     ownerId: string;
 
+    payload: { [key: string]: unknown } | null;
+
     scheduleRule: Item.ScheduleRule;
 
     timezone: string | null;
@@ -444,7 +461,7 @@ export interface TriggerCreateParams {
   conditions?: TriggerCreateParams.Conditions;
 
   /**
-   * Optional JSON Schema for validating payloads sent to this custom trigger
+   * Optional JSON Schema for validating payloads for custom or schedule triggers
    */
   customPayloadSchema?: { [key: string]: unknown };
 
@@ -452,6 +469,12 @@ export interface TriggerCreateParams {
 
   eventType?: string;
 
+  /**
+   * Stored input values for schedule triggers (maximum 1 MiB of JSON). Requires
+   * customPayloadSchema; available as event.payload on every run.
+   */
+  payload?: { [key: string]: unknown };
+
   scheduleRule?: TriggerCreateParams.ScheduleRule;
 
   timezone?: string;
@@ -506,7 +529,7 @@ export interface TriggerUpdateParams {
   conditions?: TriggerUpdateParams.Conditions | null;
 
   /**
-   * Optional JSON Schema for validating payloads sent to this custom trigger
+   * Optional JSON Schema for validating payloads for custom or schedule triggers
    */
   customPayloadSchema?: { [key: string]: unknown } | null;
 
@@ -516,6 +539,12 @@ export interface TriggerUpdateParams {
 
   name?: string;
 
+  /**
+   * Stored schedule input values (maximum 1 MiB of JSON); null clears them. Requires
+   * customPayloadSchema.
+   */
+  payload?: { [key: string]: unknown } | null;
+
   scheduleRule?: TriggerUpdateParams.ScheduleRule | null;
 
   timezone?: string | null;

package/src/resources/workflows/workflows.ts

@@ -6,6 +6,7 @@ import {
   ActionCatalog,
   ActionCatalogListParams,
   ActionCatalogListResponse,
+  ActionCatalogRetrieveParams,
   ActionCatalogRetrieveResponse,
 } from './action-catalog';
 import * as EventsAPI from './events';
@@ -39,6 +40,7 @@ import {
   ActionDeleteResponse,
   ActionListParams,
   ActionListResponse,
+  ActionRetrieveParams,
   ActionRetrieveResponse,
   ActionUpdateParams,
   ActionUpdateResponse,
@@ -71,6 +73,8 @@ import {
   FlowListParams,
   FlowListRepairsResponse,
   FlowListResponse,
+  FlowRetrieveRepairParams,
+  FlowRetrieveRepairResponse,
   FlowRetrieveResponse,
   FlowRunParams,
   FlowRunResponse,
@@ -123,6 +127,7 @@ export declare namespace Workflows {
     ActionCatalog as ActionCatalog,
     type ActionCatalogRetrieveResponse as ActionCatalogRetrieveResponse,
     type ActionCatalogListResponse as ActionCatalogListResponse,
+    type ActionCatalogRetrieveParams as ActionCatalogRetrieveParams,
     type ActionCatalogListParams as ActionCatalogListParams,
   };
 
@@ -134,6 +139,7 @@ export declare namespace Workflows {
     type ActionListResponse as ActionListResponse,
     type ActionDeleteResponse as ActionDeleteResponse,
     type ActionCreateParams as ActionCreateParams,
+    type ActionRetrieveParams as ActionRetrieveParams,
     type ActionUpdateParams as ActionUpdateParams,
     type ActionListParams as ActionListParams,
   };
@@ -151,6 +157,7 @@ export declare namespace Workflows {
     type FlowDeliveryOptionsResponse as FlowDeliveryOptionsResponse,
     type FlowDryRunResponse as FlowDryRunResponse,
     type FlowListRepairsResponse as FlowListRepairsResponse,
+    type FlowRetrieveRepairResponse as FlowRetrieveRepairResponse,
     type FlowRunResponse as FlowRunResponse,
     type FlowTemplateContextResponse as FlowTemplateContextResponse,
     type FlowUnblockResponse as FlowUnblockResponse,
@@ -163,6 +170,7 @@ export declare namespace Workflows {
     type FlowCapacityParams as FlowCapacityParams,
     type FlowCloneParams as FlowCloneParams,
     type FlowDryRunParams as FlowDryRunParams,
+    type FlowRetrieveRepairParams as FlowRetrieveRepairParams,
     type FlowRunParams as FlowRunParams,
     type FlowTemplateContextParams as FlowTemplateContextParams,
     type FlowValidateParams as FlowValidateParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.0.1'; // x-release-please-version
+export const VERSION = '6.1.1'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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