@mobilerun/sdk 5.1.0 → 5.2.0

package/src/resources/webhooks/webhooks.ts

@@ -23,7 +23,10 @@ export class Webhooks extends APIResource {
   deliveries: DeliveriesAPI.Deliveries = new DeliveriesAPI.Deliveries(this._client);
 
   /**
-   * Register a webhook subscription
+   * Creates a webhook subscription with a delivery URL and an optional list of event
+   * types to subscribe to (defaults to all when omitted). The response includes the
+   * generated signing secret, which is returned only once at creation time and
+   * cannot be retrieved later.
    *
    * @example
    * ```ts
@@ -37,7 +40,9 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Get a webhook subscription
+   * Returns a single webhook subscription by id, including its URL, subscribed event
+   * types, state, and system-observed delivery health. The signing secret is never
+   * included.
    *
    * @example
    * ```ts
@@ -51,7 +56,10 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Update a webhook subscription
+   * Updates a webhook subscription. Any combination of the subscribed event types,
+   * state (ACTIVE or DISABLED), and description may be changed, and at least one
+   * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+   * was auto-blocked after sustained delivery failures.
    *
    * @example
    * ```ts
@@ -69,7 +77,10 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * List your webhook subscriptions
+   * Returns a paginated list of your webhook subscriptions, optionally filtered by
+   * status (active, failing, blocked, or disabled) and/or by `search` (a
+   * case-insensitive substring match against the URL or description). The response
+   * also includes per-status counts across all of your subscriptions.
    *
    * @example
    * ```ts
@@ -84,7 +95,8 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Delete a webhook subscription
+   * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+   * Content on success.
    *
    * @example
    * ```ts
@@ -101,7 +113,9 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * List subscribable event types per source
+   * Returns the catalog of event types that webhook subscriptions can subscribe to,
+   * grouped by source. Use the returned type identifiers as the `eventTypes` values
+   * when creating or updating a webhook.
    *
    * @example
    * ```ts
@@ -113,7 +127,9 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Rotate the signing secret (returned once)
+   * Generates a new signing secret for the webhook subscription and returns it once
+   * in the response. The previous secret is replaced immediately, so any signature
+   * verification on your endpoint must be updated to use the new value.
    *
    * @example
    * ```ts
@@ -127,7 +143,9 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Send a one-shot test delivery
+   * Sends a single test payload to the webhook subscription URL to verify
+   * connectivity. The response reports whether the attempt succeeded along with the
+   * returned HTTP status code or error, if any.
    *
    * @example
    * ```ts
@@ -155,6 +173,11 @@ export namespace WebhookCreateResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
     description: string | null;
 
     eventTypes: Array<string>;
@@ -194,6 +217,11 @@ export namespace WebhookRetrieveResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
     description: string | null;
 
     eventTypes: Array<string>;
@@ -228,6 +256,11 @@ export namespace WebhookUpdateResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
     description: string | null;
 
     eventTypes: Array<string>;
@@ -278,6 +311,11 @@ export namespace WebhookListResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
     description: string | null;
 
     eventTypes: Array<string>;
@@ -304,7 +342,7 @@ export interface WebhookEventTypesResponse {
 
 export namespace WebhookEventTypesResponse {
   export interface Data {
-    schemaVersion: number;
+    schemaVersion: 1;
 
     sources: Array<Data.Source>;
   }
@@ -320,8 +358,20 @@ export namespace WebhookEventTypesResponse {
       export interface Event {
         description: string;
 
+        surfaces: Event.Surfaces;
+
         type: string;
       }
+
+      export namespace Event {
+        export interface Surfaces {
+          feed: boolean;
+
+          toast: boolean;
+
+          webhook: boolean;
+        }
+      }
     }
   }
 }
@@ -340,6 +390,11 @@ export namespace WebhookRotateSecretResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
     description: string | null;
 
     eventTypes: Array<string>;
@@ -396,10 +451,25 @@ export interface WebhookUpdateParams {
 }
 
 export interface WebhookListParams {
+  /**
+   * Only include webhooks created by this actor id. Mutually exclusive with `mine`.
+   */
+  createdBy?: string;
+
+  /**
+   * When true, only include webhooks created by you (not just owned by your org).
+   */
+  mine?: 'true' | 'false';
+
   page?: number;
 
   pageSize?: number;
 
+  /**
+   * Case-insensitive substring match against the URL or description.
+   */
+  search?: string;
+
   status?: 'active' | 'failing' | 'blocked' | 'disabled';
 }
 

package/src/resources/workflows/action-catalog.ts

@@ -8,14 +8,17 @@ import { path } from '../../internal/utils/path';
 
 export class ActionCatalog extends APIResource {
   /**
-   * Get a catalog entry
+   * Fetch a single action catalog entry by its ID, including its service, method,
+   * and parameter schema. Returns 404 if no entry matches.
    */
   retrieve(catalogEntryID: string, options?: RequestOptions): APIPromise<ActionCatalogRetrieveResponse> {
     return this._client.get(path`/action-catalog/${catalogEntryID}`, options);
   }
 
   /**
-   * List action catalog entries
+   * Return a paginated list of catalog entries — the service/method templates that
+   * actions are created from, each carrying its parameter schema. Supports filtering
+   * by `service`.
    */
   list(
     query: ActionCatalogListParams | null | undefined = {},

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

@@ -12,21 +12,25 @@ export class Actions extends APIResource {
   services: ServicesAPI.Services = new ServicesAPI.Services(this._client);
 
   /**
-   * Create an action
+   * Create a reusable action from a catalog entry (`catalogEntryId`), with an
+   * optional `params` object supplying the values for that entry's service method.
+   * Returns 400 if the params are invalid for the chosen catalog entry.
    */
   create(body: ActionCreateParams, options?: RequestOptions): APIPromise<ActionCreateResponse> {
     return this._client.post('/actions', { body, ...options });
   }
 
   /**
-   * Get an action
+   * Fetch a single action by its ID, including its configured service, method, and
+   * params. Returns 404 if no action matches.
    */
   retrieve(actionID: string, options?: RequestOptions): APIPromise<ActionRetrieveResponse> {
     return this._client.get(path`/actions/${actionID}`, options);
   }
 
   /**
-   * Update an action
+   * Partially update an action's name, description, or params; all fields are
+   * optional. Returns 404 if the action does not exist.
    */
   update(
     actionID: string,
@@ -37,7 +41,8 @@ export class Actions extends APIResource {
   }
 
   /**
-   * List actions
+   * Return a paginated list of actions. Supports filtering by `service`, free-text
+   * `search`, and ordering by name, createdAt, or updatedAt.
    */
   list(
     query: ActionListParams | null | undefined = {},
@@ -47,7 +52,7 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Delete an action
+   * Delete an action by its ID. Returns 404 if no action matches.
    */
   delete(actionID: string, options?: RequestOptions): APIPromise<ActionDeleteResponse> {
     return this._client.delete(path`/actions/${actionID}`, options);
@@ -61,16 +66,23 @@ export interface Action {
 
   createdAt: string | null;
 
+  createdBy: string | null;
+
   description: string | null;
 
   method: string;
 
   name: string;
 
+  ownerId: string;
+
   service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
 
   updatedAt: string | null;
 
+  /**
+   * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+   */
   userId: string;
 
   params?: unknown;

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

@@ -7,14 +7,17 @@ import { path } from '../../../internal/utils/path';
 
 export class Services extends APIResource {
   /**
-   * List available services
+   * Return the names of the services that actions can be built against. Use these
+   * values to look up each service's allowed methods.
    */
   list(options?: RequestOptions): APIPromise<ServiceListResponse> {
     return this._client.get('/actions/services', options);
   }
 
   /**
-   * List allowed methods for a service
+   * Return the methods allowed for the given service, each with its parameter
+   * definitions (name, type, whether required, description, and optional
+   * default/example). Returns 404 if the service is unknown.
    */
   listMethods(service: string, options?: RequestOptions): APIPromise<ServiceListMethodsResponse> {
     return this._client.get(path`/actions/services/${service}/methods`, options);

package/src/resources/workflows/events/catalog.ts

@@ -1,88 +1,5 @@
 // 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';
 
-export class Catalog extends APIResource {
-  /**
-   * List event catalog
-   */
-  list(
-    query: CatalogListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CatalogListResponse> {
-    return this._client.get('/events/catalog', { query, ...options });
-  }
-
-  /**
-   * Register event types in the catalog
-   */
-  register(body: CatalogRegisterParams, options?: RequestOptions): APIPromise<CatalogRegisterResponse> {
-    return this._client.post('/events/catalog/register', { body, ...options });
-  }
-}
-
-export interface CatalogListResponse {
-  items: Array<CatalogListResponse.Item>;
-
-  pagination: Shared.Pagination;
-}
-
-export namespace CatalogListResponse {
-  export interface Item {
-    createdAt: string | null;
-
-    description: string | null;
-
-    eventType: string;
-
-    label: string;
-
-    source: string | null;
-
-    updatedAt: string | null;
-
-    payloadSchema?: unknown;
-  }
-}
-
-export interface CatalogRegisterResponse {
-  message: string;
-}
-
-export interface CatalogListParams {
-  page?: number;
-
-  pageSize?: number;
-
-  source?: 'device' | 'system' | 'webhook';
-}
-
-export interface CatalogRegisterParams {
-  events: Array<CatalogRegisterParams.Event>;
-}
-
-export namespace CatalogRegisterParams {
-  export interface Event {
-    eventType: string;
-
-    label: string;
-
-    description?: string;
-
-    payloadSchema?: { [key: string]: unknown };
-
-    source?: 'device' | 'system' | 'webhook';
-  }
-}
-
-export declare namespace Catalog {
-  export {
-    type CatalogListResponse as CatalogListResponse,
-    type CatalogRegisterResponse as CatalogRegisterResponse,
-    type CatalogListParams as CatalogListParams,
-    type CatalogRegisterParams as CatalogRegisterParams,
-  };
-}
+export class Catalog extends APIResource {}

package/src/resources/workflows/events/events.ts

@@ -3,13 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as WorkflowsAPI from '../workflows';
 import * as CatalogAPI from './catalog';
-import {
-  Catalog,
-  CatalogListParams,
-  CatalogListResponse,
-  CatalogRegisterParams,
-  CatalogRegisterResponse,
-} from './catalog';
+import { Catalog } from './catalog';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
@@ -94,6 +88,8 @@ export namespace EventDryRunResponse {
 
         createdAt: string | null;
 
+        createdBy: string | null;
+
         customPayloadSchema: { [key: string]: unknown } | null;
 
         description: string | null;
@@ -102,39 +98,23 @@ export namespace EventDryRunResponse {
 
         name: string;
 
-        scheduleRule: Trigger.ScheduleRule | null;
+        ownerId: string;
+
+        scheduleRule: unknown;
 
         timezone: string | null;
 
         updatedAt: string | null;
 
+        /**
+         * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+         */
         userId: string;
 
         conditions?: unknown;
 
         nextFireTime?: string | null;
       }
-
-      export namespace Trigger {
-        export interface ScheduleRule {
-          type: 'once' | 'cron' | 'recurring';
-
-          /**
-           * ISO 8601 datetime (for type=once)
-           */
-          dateTime?: string;
-
-          /**
-           * Cron expression (for type=cron)
-           */
-          expression?: string;
-
-          /**
-           * RRULE string (for type=recurring)
-           */
-          rrule?: string;
-        }
-      }
     }
 
     export interface Validation {
@@ -160,12 +140,16 @@ export interface EventIngestResponse {
 export interface EventDryRunParams {
   eventType: string;
 
+  deviceId?: string;
+
   payload?: { [key: string]: unknown };
 }
 
 export interface EventIngestParams {
   eventType: string;
 
+  deviceId?: string;
+
   payload?: { [key: string]: unknown };
 }
 
@@ -179,11 +163,5 @@ export declare namespace Events {
     type EventIngestParams as EventIngestParams,
   };
 
-  export {
-    Catalog as Catalog,
-    type CatalogListResponse as CatalogListResponse,
-    type CatalogRegisterResponse as CatalogRegisterResponse,
-    type CatalogListParams as CatalogListParams,
-    type CatalogRegisterParams as CatalogRegisterParams,
-  };
+  export { Catalog as Catalog };
 }

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

@@ -1,12 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Catalog,
-  type CatalogListResponse,
-  type CatalogRegisterResponse,
-  type CatalogListParams,
-  type CatalogRegisterParams,
-} from './catalog';
+export { Catalog } from './catalog';
 export {
   Events,
   type EventDryRunResponse,

package/src/resources/workflows/executions.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as ExecutionsAPI from './executions';
 import * as Shared from '../shared';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
@@ -8,14 +9,17 @@ import { path } from '../../internal/utils/path';
 
 export class Executions extends APIResource {
   /**
-   * Get execution details
+   * 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);
   }
 
   /**
-   * List flow executions
+   * 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.
    */
   list(
     query: ExecutionListParams | null | undefined = {},
@@ -25,7 +29,9 @@ export class Executions extends APIResource {
   }
 
   /**
-   * Get execution metrics
+   * 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 = {},
@@ -58,19 +64,58 @@ export interface FlowExecution {
 
   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 ExecutionRetrieveResponse {
-  data: FlowExecution;
+  data: ExecutionRetrieveResponse.Data;
+}
+
+export namespace ExecutionRetrieveResponse {
+  export interface Data extends ExecutionsAPI.FlowExecution {
+    createdBy: 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>;
+  }
+
+  export namespace Data {
+    export interface File {
+      fileId: string;
+
+      filename: string;
+
+      mimeType: string;
+
+      sizeBytes: number;
+    }
+  }
 }
 
 export interface ExecutionListResponse {
-  items: Array<FlowExecution>;
+  items: Array<ExecutionListResponse.Item>;
 
   pagination: Shared.Pagination;
 }
 
+export namespace ExecutionListResponse {
+  export interface Item extends ExecutionsAPI.FlowExecution {
+    createdBy: string | null;
+  }
+}
+
 export interface ExecutionGetMetricsResponse {
   data: ExecutionGetMetricsResponse.Data;
 }

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

@@ -8,21 +8,26 @@ import { path } from '../../../internal/utils/path';
 
 export class Actions extends APIResource {
   /**
-   * List actions for a flow
+   * Return the ordered list of actions attached to a flow, including any nested
+   * child actions. Returns 404 if the flow does not exist.
    */
   list(flowID: string, options?: RequestOptions): APIPromise<ActionListResponse> {
     return this._client.get(path`/flows/${flowID}/actions`, options);
   }
 
   /**
-   * Add an action to a flow
+   * Append a single action to a flow at the given `position`, optionally nesting it
+   * under a `parentFlowActionId` or supplying its own `children`. Supports a
+   * `nameOverride`, param `overrides`, and `continueOnError`. Returns 404 if the
+   * flow does not exist.
    */
   add(flowID: string, body: ActionAddParams, options?: RequestOptions): APIPromise<ActionAddResponse> {
     return this._client.post(path`/flows/${flowID}/actions`, { body, ...options });
   }
 
   /**
-   * Remove an action from a flow
+   * Remove a single action from a flow by its `flowActionId`. Returns 404 if the
+   * flow or flow action does not exist.
    */
   remove(
     flowActionID: string,
@@ -34,7 +39,10 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Replace all actions for a flow
+   * Replace a flow's entire action list with the supplied set (at least one
+   * required). Each action references an `actionId` and a unique `position`, and may
+   * include nested `children`, a `nameOverride`, param `overrides`, and a
+   * `continueOnError` flag. Returns 404 if the flow does not exist.
    */
   replace(
     flowID: string,