@mobilerun/sdk 5.1.0 → 5.2.1

package/src/resources/tasks/ui-states.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ScreenshotsAPI from './screenshots';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -17,7 +16,7 @@ export class UiStates extends APIResource {
     index: number,
     params: UiStateRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ScreenshotsAPI.MediaResponse> {
+  ): APIPromise<UiStateRetrieveResponse> {
     const { task_id } = params;
     return this._client.get(path`/tasks/${task_id}/ui_states/${index}`, options);
   }
@@ -30,6 +29,13 @@ export class UiStates extends APIResource {
   }
 }
 
+export interface UiStateRetrieveResponse {
+  /**
+   * The URL of the media
+   */
+  url: string;
+}
+
 export interface UiStateListResponse {
   /**
    * The list of media URLs
@@ -43,6 +49,7 @@ export interface UiStateRetrieveParams {
 
 export declare namespace UiStates {
   export {
+    type UiStateRetrieveResponse as UiStateRetrieveResponse,
     type UiStateListResponse as UiStateListResponse,
     type UiStateRetrieveParams as UiStateRetrieveParams,
   };

package/src/resources/webhooks/deliveries.ts

@@ -8,7 +8,10 @@ import { path } from '../../internal/utils/path';
 
 export class Deliveries extends APIResource {
   /**
-   * List deliveries across all your webhooks
+   * Returns a paginated feed of webhook deliveries across all of your subscriptions,
+   * with the originating endpoint URL included on each record. Results can be
+   * filtered by delivery status (pending, success, skipped, or dead), by a `since`
+   * timestamp, and by `eventId` (exact match against the originating event id).
    *
    * @example
    * ```ts
@@ -23,7 +26,10 @@ export class Deliveries extends APIResource {
   }
 
   /**
-   * List deliveries for a webhook
+   * Returns a paginated list of deliveries for a single webhook subscription,
+   * identified by its id. Each record reports the event, delivery status, attempt
+   * count, and the last response code or error. Results can be filtered by `eventId`
+   * (exact match against the originating event id).
    *
    * @example
    * ```ts
@@ -42,7 +48,9 @@ export class Deliveries extends APIResource {
   }
 
   /**
-   * Get a delivery with its attempts
+   * Returns a single delivery for a webhook subscription along with the full list of
+   * captured attempt records. Each attempt includes the request URL, method, headers
+   * and body, whether it was signed, and the response status, headers, and snippet.
    *
    * @example
    * ```ts
@@ -63,7 +71,10 @@ export class Deliveries extends APIResource {
   }
 
   /**
-   * Aggregate delivery statistics (excludes test sends)
+   * Returns aggregate delivery statistics across all of your webhooks, including the
+   * total count, a breakdown by status (pending, success, skipped, dead), and the
+   * overall success rate. An optional `since` timestamp narrows the reporting
+   * window.
    *
    * @example
    * ```ts
@@ -94,6 +105,12 @@ export namespace DeliveryListResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the parent endpoint's creator. Null when the endpoint row is gone or its
+     * creator was never recorded.
+     */
+    createdBy: string | null;
+
     durationMs: number | null;
 
     endpointId: string;
@@ -134,6 +151,12 @@ export namespace DeliveryListForWebhookResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the parent endpoint's creator. Null when the endpoint row is gone or its
+     * creator was never recorded.
+     */
+    createdBy: string | null;
+
     durationMs: number | null;
 
     endpointId: string;
@@ -170,6 +193,12 @@ export namespace DeliveryRetrieveAttemptsResponse {
 
     createdAt: string;
 
+    /**
+     * Id of the parent endpoint's creator. Null when the endpoint row is gone or its
+     * creator was never recorded.
+     */
+    createdBy: string | null;
+
     durationMs: number | null;
 
     endpointId: string;
@@ -247,6 +276,11 @@ export namespace DeliveryStatsResponse {
 }
 
 export interface DeliveryListParams {
+  /**
+   * Exact text match against the originating event id.
+   */
+  eventId?: string;
+
   page?: number;
 
   pageSize?: number;
@@ -257,6 +291,11 @@ export interface DeliveryListParams {
 }
 
 export interface DeliveryListForWebhookParams {
+  /**
+   * Exact text match against the originating event id.
+   */
+  eventId?: string;
+
   page?: number;
 
   pageSize?: number;

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 = {},
@@ -25,34 +28,56 @@ export class ActionCatalog extends APIResource {
   }
 }
 
-export interface ActionCatalogEntry {
-  id: string;
+export interface ActionCatalogRetrieveResponse {
+  data: ActionCatalogRetrieveResponse.Data;
+}
 
-  createdAt: string | null;
+export namespace ActionCatalogRetrieveResponse {
+  export interface Data {
+    id: string;
 
-  description: string | null;
+    createdAt: string | null;
 
-  method: string;
+    description: string | null;
 
-  name: string;
+    method: string;
 
-  service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
+    name: string;
 
-  updatedAt: string | null;
+    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
 
-  paramsSchema?: unknown;
-}
+    updatedAt: string | null;
 
-export interface ActionCatalogRetrieveResponse {
-  data: ActionCatalogEntry;
+    paramsSchema?: unknown;
+  }
 }
 
 export interface ActionCatalogListResponse {
-  items: Array<ActionCatalogEntry>;
+  items: Array<ActionCatalogListResponse.Item>;
 
   pagination: Shared.Pagination;
 }
 
+export namespace ActionCatalogListResponse {
+  export interface Item {
+    id: string;
+
+    createdAt: string | null;
+
+    description: string | null;
+
+    method: string;
+
+    name: string;
+
+    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
+
+    updatedAt: string | null;
+
+    paramsSchema?: unknown;
+  }
+}
+
 export interface ActionCatalogListParams {
   page?: number;
 
@@ -63,7 +88,6 @@ export interface ActionCatalogListParams {
 
 export declare namespace ActionCatalog {
   export {
-    type ActionCatalogEntry as ActionCatalogEntry,
     type ActionCatalogRetrieveResponse as ActionCatalogRetrieveResponse,
     type ActionCatalogListResponse as ActionCatalogListResponse,
     type ActionCatalogListParams as ActionCatalogListParams,

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,55 +52,163 @@ 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);
   }
 }
 
-export interface Action {
-  id: string;
+export interface ActionCreateResponse {
+  data: ActionCreateResponse.Data;
+}
 
-  catalogEntryId: string;
+export namespace ActionCreateResponse {
+  export interface Data {
+    id: string;
 
-  createdAt: string | null;
+    catalogEntryId: string;
 
-  description: string | null;
+    createdAt: string | null;
 
-  method: string;
+    createdBy: string | null;
 
-  name: string;
+    description: string | null;
 
-  service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
+    method: string;
 
-  updatedAt: string | null;
+    name: string;
 
-  userId: string;
+    ownerId: string;
 
-  params?: unknown;
+    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
 
-  paramsSchema?: unknown;
-}
+    updatedAt: string | null;
 
-export interface ActionCreateResponse {
-  data: Action;
+    /**
+     * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+     */
+    userId: string;
+
+    params?: unknown;
+
+    paramsSchema?: unknown;
+  }
 }
 
 export interface ActionRetrieveResponse {
-  data: Action;
+  data: ActionRetrieveResponse.Data;
+}
+
+export namespace ActionRetrieveResponse {
+  export interface Data {
+    id: string;
+
+    catalogEntryId: string;
+
+    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;
+
+    paramsSchema?: unknown;
+  }
 }
 
 export interface ActionUpdateResponse {
-  data: Action;
+  data: ActionUpdateResponse.Data;
+}
+
+export namespace ActionUpdateResponse {
+  export interface Data {
+    id: string;
+
+    catalogEntryId: string;
+
+    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;
+
+    paramsSchema?: unknown;
+  }
 }
 
 export interface ActionListResponse {
-  items: Array<Action>;
+  items: Array<ActionListResponse.Item>;
 
   pagination: Shared.Pagination;
 }
 
+export namespace ActionListResponse {
+  export interface Item {
+    id: string;
+
+    catalogEntryId: string;
+
+    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;
+
+    paramsSchema?: unknown;
+  }
+}
+
 export interface ActionDeleteResponse {
   message: string;
 }
@@ -136,7 +249,6 @@ Actions.Services = Services;
 
 export declare namespace Actions {
   export {
-    type Action as Action,
     type ActionCreateResponse as ActionCreateResponse,
     type ActionRetrieveResponse as ActionRetrieveResponse,
     type ActionUpdateResponse as ActionUpdateResponse,

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

@@ -2,7 +2,6 @@
 
 export {
   Actions,
-  type Action,
   type ActionCreateResponse,
   type ActionRetrieveResponse,
   type ActionUpdateResponse,

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);