@mobilerun/sdk 6.1.0 → 6.1.1

package/src/resources/devices/number.ts

@@ -0,0 +1,261 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Number extends APIResource {
+  /**
+   * Returns the cloud number bound to the device and the SIM line the device
+   * presents (carrier, number).
+   */
+  retrieve(
+    deviceID: string,
+    params: NumberRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberRetrieveResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/number`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Binds one of your cloud numbers to the device. The device's SIM shows the number
+   * and every SMS it receives is delivered into the device's messages app. Available
+   * on devices whose capabilities report telephony. A number can be bound to one
+   * device, and a device holds one number; unbind first to move it.
+   */
+  bind(deviceID: string, params: NumberBindParams, options?: RequestOptions): APIPromise<NumberBindResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/number`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Releases the number bound to the device. The device returns to its own default
+   * line; SMS to the number stop reaching the device.
+   */
+  unbind(
+    deviceID: string,
+    params: NumberUnbindParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberUnbindResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.delete(path`/devices/${deviceID}/number`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface NumberRetrieveResponse {
+  binding: NumberRetrieveResponse.Binding;
+
+  line: NumberRetrieveResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberRetrieveResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberBindResponse {
+  binding: NumberBindResponse.Binding;
+
+  line: NumberBindResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberBindResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberUnbindResponse {
+  binding: NumberUnbindResponse.Binding;
+
+  line: NumberUnbindResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberUnbindResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberRetrieveParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface NumberBindParams {
+  /**
+   * Body param: The cloud number's id.
+   */
+  numberId: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface NumberUnbindParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Number {
+  export {
+    type NumberRetrieveResponse as NumberRetrieveResponse,
+    type NumberBindResponse as NumberBindResponse,
+    type NumberUnbindResponse as NumberUnbindResponse,
+    type NumberRetrieveParams as NumberRetrieveParams,
+    type NumberBindParams as NumberBindParams,
+    type NumberUnbindParams as NumberUnbindParams,
+  };
+}

package/src/resources/files.ts

@@ -20,7 +20,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * List the user's ready files, optionally filtered by zone
+   * List the user's ready files, optionally filtered by zone.
    */
   list(
     query: FileListParams | null | undefined = {},
@@ -30,23 +30,25 @@ export class Files extends APIResource {
   }
 
   /**
-   * Hard-delete a file
+   * Hard-delete a file.
    */
   delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
     return this._client.delete(path`/agents/files/${fileID}`, options);
   }
 
   /**
-   * Soft-cancels an in-flight upload before confirm. Only acts on `pending` uploads
-   * — refuses to touch `ready` files, so confirmed files are never removed.
-   * Idempotent: `{ cancelled: false }` if the file exists but is no longer pending.
+   * Soft-cancels an in-flight upload before confirm, transitioning it to expired and
+   * deleting the underlying object. Only acts on `pending` uploads — refuses to
+   * touch `ready` files, so confirmed files are never removed. Idempotent:
+   * `{ cancelled: false }` if the file exists but is no longer pending.
    */
   cancelPending(fileID: string, options?: RequestOptions): APIPromise<FileCancelPendingResponse> {
     return this._client.delete(path`/agents/files/${fileID}/pending`, options);
   }
 
   /**
-   * Confirm a file upload by server-side HEAD validation
+   * Confirm a file upload after validating the stored object with a server-side HEAD
+   * request.
    */
   confirm(fileID: string, options?: RequestOptions): APIPromise<FileConfirmResponse> {
     return this._client.post(path`/agents/files/${fileID}/confirm`, options);
@@ -64,7 +66,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Mint a presigned PUT URL for a user file upload
+   * Mint a presigned PUT URL and a fileId for uploading a user file.
    */
   uploadURL(body: FileUploadURLParams, options?: RequestOptions): APIPromise<FileUploadURLResponse> {
     return this._client.post('/agents/files/upload-url', { body, ...options });
@@ -90,6 +92,8 @@ export interface FileUpdateResponse {
 
   zone: 'user' | 'agent' | 'workflow' | 'skills';
 
+  agentId?: string;
+
   collectionStatus?: FileUpdateResponse.UnionMember0 | FileUpdateResponse.UnionMember1;
 }
 
@@ -155,6 +159,8 @@ export namespace FileListResponse {
 
     zone: 'user' | 'agent' | 'workflow' | 'skills';
 
+    agentId?: string;
+
     collectionStatus?: File.UnionMember0 | File.UnionMember1;
   }
 
@@ -236,6 +242,8 @@ export interface FileConfirmResponse {
 
   zone: 'user' | 'agent' | 'workflow' | 'skills';
 
+  agentId?: string;
+
   collectionStatus?: FileConfirmResponse.UnionMember0 | FileConfirmResponse.UnionMember1;
 }
 
@@ -300,6 +308,8 @@ export interface FileUploadURLParams {
 
   sizeBytes: number;
 
+  chatSessionId?: string;
+
   zone?: 'user' | 'skills';
 }
 

package/src/resources/index.ts

@@ -1,6 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export {
+  Agents,
+  type AgentCreateResponse,
+  type AgentListResponse,
+  type AgentModelProfilesResponse,
+  type AgentCreateParams,
+} from './agents/agents';
 export {
   Apps,
   type AppRetrieveResponse,

package/src/resources/numbers/messages.ts

@@ -37,7 +37,8 @@ export class Messages extends APIResource {
    * rate_limited: too many sends by the owner in a short window; 429
    * number_rate_limited: too many outbound sends from this number in the configured
    * window (all sends from this number count, including those made on your behalf).
-   * 403 send_disabled: self-service SMS send is switched off.
+   * 403 send_disabled: self-service SMS send is switched off;
+   * outbound_sms_not_granted: outbound SMS requires an admin grant.
    *
    * @example
    * ```ts

package/src/resources/numbers/numbers.ts

@@ -177,6 +177,11 @@ export namespace NumberRetrieveResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    deviceBinding: Data.DeviceBinding | null;
+
     /**
      * Why setup failed. Null unless state is failed, and null when the failure has no
      * classified reason. out_of_stock: no number is currently available for the
@@ -220,6 +225,17 @@ export namespace NumberRetrieveResponse {
       send: boolean;
     }
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    export interface DeviceBinding {
+      boundAt: string;
+
+      deviceId: string;
+
+      deviceType: string | null;
+    }
+
     /**
      * What this line supports in principle, per channel. Use `actions` for what you
      * can do right now.
@@ -282,6 +298,11 @@ export namespace NumberUpdateResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    deviceBinding: Data.DeviceBinding | null;
+
     /**
      * Why setup failed. Null unless state is failed, and null when the failure has no
      * classified reason. out_of_stock: no number is currently available for the
@@ -325,6 +346,17 @@ export namespace NumberUpdateResponse {
       send: boolean;
     }
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    export interface DeviceBinding {
+      boundAt: string;
+
+      deviceId: string;
+
+      deviceType: string | null;
+    }
+
     /**
      * What this line supports in principle, per channel. Use `actions` for what you
      * can do right now.
@@ -389,6 +421,11 @@ export namespace NumberListResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    deviceBinding: Item.DeviceBinding | null;
+
     /**
      * Why setup failed. Null unless state is failed, and null when the failure has no
      * classified reason. out_of_stock: no number is currently available for the
@@ -432,6 +469,17 @@ export namespace NumberListResponse {
       send: boolean;
     }
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    export interface DeviceBinding {
+      boundAt: string;
+
+      deviceId: string;
+
+      deviceType: string | null;
+    }
+
     /**
      * What this line supports in principle, per channel. Use `actions` for what you
      * can do right now.
@@ -494,6 +542,11 @@ export namespace NumberDeleteResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    deviceBinding: Data.DeviceBinding | null;
+
     /**
      * Why setup failed. Null unless state is failed, and null when the failure has no
      * classified reason. out_of_stock: no number is currently available for the
@@ -537,6 +590,17 @@ export namespace NumberDeleteResponse {
       send: boolean;
     }
 
+    /**
+     * The device this number is bound to, or null.
+     */
+    export interface DeviceBinding {
+      boundAt: string;
+
+      deviceId: string;
+
+      deviceType: string | null;
+    }
+
     /**
      * What this line supports in principle, per channel. Use `actions` for what you
      * can do right now.

package/src/resources/tasks/tasks.ts

@@ -198,8 +198,10 @@ export namespace TaskRetrieveResponse {
 
     /**
      * Where the task came from: 'api' for tasks created via POST /tasks, 'agent' for
-     * tasks spawned by an agent step. Agent tasks are readable (status, trajectory,
-     * media) but not controllable via this API.
+     * tasks spawned by an agent step or created with internal=true. 'source'
+     * classifies visibility only: tasks created with internal=true stay controllable
+     * via this API, while tasks spawned by an agent step are readable (status,
+     * trajectory, media) but not controllable.
      */
     source?: 'api' | 'agent';
 
@@ -344,8 +346,10 @@ export namespace TaskListResponse {
 
     /**
      * Where the task came from: 'api' for tasks created via POST /tasks, 'agent' for
-     * tasks spawned by an agent step. Agent tasks are readable (status, trajectory,
-     * media) but not controllable via this API.
+     * tasks spawned by an agent step or created with internal=true. 'source'
+     * classifies visibility only: tasks created with internal=true stay controllable
+     * via this API, while tasks spawned by an agent step are readable (status,
+     * trajectory, media) but not controllable.
      */
     source?: 'api' | 'agent';
 
@@ -1044,7 +1048,8 @@ export interface TaskListParams {
   query?: string | null;
 
   /**
-   * Only tasks created via the API ('api') or spawned by an agent step ('agent').
+   * Only tasks created via the API ('api') or tasks spawned by an agent step or
+   * created with internal=true ('agent').
    */
   source?: 'api' | 'agent' | null;
 
@@ -1094,6 +1099,14 @@ export interface TaskRunParams {
    */
   humanize?: boolean;
 
+  /**
+   * Mark a task started by an agent or worker on the user's behalf. It is listed as
+   * source='agent' (excluded from source='api' lists) and its events carry
+   * internal=true so user-facing notifications and webhooks skip it. It is still
+   * billed, controllable and retrievable by id.
+   */
+  internal?: boolean;
+
   /**
    * The LLM model identifier to use for the task (e.g.
    * 'mobilerun/mobile-agent-fast'). When omitted with reasoning=false, the fast-mode
@@ -1182,6 +1195,14 @@ export interface TaskRunStreamedParams {
    */
   humanize?: boolean;
 
+  /**
+   * Mark a task started by an agent or worker on the user's behalf. It is listed as
+   * source='agent' (excluded from source='api' lists) and its events carry
+   * internal=true so user-facing notifications and webhooks skip it. It is still
+   * billed, controllable and retrievable by id.
+   */
+  internal?: boolean;
+
   /**
    * The LLM model identifier to use for the task (e.g.
    * 'mobilerun/mobile-agent-fast'). When omitted with reasoning=false, the fast-mode

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

@@ -9,16 +9,22 @@ import { path } from '../../internal/utils/path';
 export class ActionCatalog extends APIResource {
   /**
    * Fetch a single action catalog entry by its ID, including its service, method,
-   * and parameter schema. Returns 404 if no entry matches.
+   * parameter schema, and `deviceFree` eligibility. Supports
+   * `profile=agent_routine`; returns 404 if no entry matches or the entry is outside
+   * that profile.
    */
-  retrieve(catalogEntryID: string, options?: RequestOptions): APIPromise<ActionCatalogRetrieveResponse> {
-    return this._client.get(path`/action-catalog/${catalogEntryID}`, options);
+  retrieve(
+    catalogEntryID: string,
+    query: ActionCatalogRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ActionCatalogRetrieveResponse> {
+    return this._client.get(path`/action-catalog/${catalogEntryID}`, { query, ...options });
   }
 
   /**
    * 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`.
+   * actions are created from, each carrying its parameter schema and `deviceFree`
+   * eligibility. Supports filtering by `service` and `profile=agent_routine`.
    */
   list(
     query: ActionCatalogListParams | null | undefined = {},
@@ -40,16 +46,37 @@ export namespace ActionCatalogRetrieveResponse {
 
     description: string | null;
 
+    /**
+     * True when this step itself runs without a device; only such steps may appear in
+     * a device-free flow. Not the same as cloudRoutine: a device-free step can still
+     * be device-routine-only (see cloudRoutineReason).
+     */
+    deviceFree: boolean;
+
     method: string;
 
     name: string;
 
     provider: 'mobilerun' | 'oneDrive' | 'googleDrive';
 
-    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api';
+    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api' | 'triggers_api';
 
     updatedAt: string | null;
 
+    /**
+     * True when this step is allowed in a cloud agent routine. Present only for
+     * profile=agent_routine. False does not mean the step needs a device; read
+     * cloudRoutineReason.
+     */
+    cloudRoutine?: boolean;
+
+    /**
+     * Why cloudRoutine is false: needs_device (the step needs a device),
+     * device_routine_only (allowed only in device routines; the step itself does not
+     * need a device). Present only when cloudRoutine is false.
+     */
+    cloudRoutineReason?: 'needs_device' | 'device_routine_only';
+
     outputSchema?: unknown;
 
     paramsSchema?: unknown;
@@ -70,34 +97,68 @@ export namespace ActionCatalogListResponse {
 
     description: string | null;
 
+    /**
+     * True when this step itself runs without a device; only such steps may appear in
+     * a device-free flow. Not the same as cloudRoutine: a device-free step can still
+     * be device-routine-only (see cloudRoutineReason).
+     */
+    deviceFree: boolean;
+
     method: string;
 
     name: string;
 
     provider: 'mobilerun' | 'oneDrive' | 'googleDrive';
 
-    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api';
+    service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api' | 'triggers_api';
 
     updatedAt: string | null;
 
+    /**
+     * True when this step is allowed in a cloud agent routine. Present only for
+     * profile=agent_routine. False does not mean the step needs a device; read
+     * cloudRoutineReason.
+     */
+    cloudRoutine?: boolean;
+
+    /**
+     * Why cloudRoutine is false: needs_device (the step needs a device),
+     * device_routine_only (allowed only in device routines; the step itself does not
+     * need a device). Present only when cloudRoutine is false.
+     */
+    cloudRoutineReason?: 'needs_device' | 'device_routine_only';
+
     outputSchema?: unknown;
 
     paramsSchema?: unknown;
   }
 }
 
+export interface ActionCatalogRetrieveParams {
+  /**
+   * Restrict reads to the agent routine step surface.
+   */
+  profile?: 'agent_routine';
+}
+
 export interface ActionCatalogListParams {
   page?: number;
 
   pageSize?: number;
 
-  service?: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api';
+  /**
+   * Restrict reads to the agent routine step surface.
+   */
+  profile?: 'agent_routine';
+
+  service?: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks' | 'integrations_api' | 'triggers_api';
 }
 
 export declare namespace ActionCatalog {
   export {
     type ActionCatalogRetrieveResponse as ActionCatalogRetrieveResponse,
     type ActionCatalogListResponse as ActionCatalogListResponse,
+    type ActionCatalogRetrieveParams as ActionCatalogRetrieveParams,
     type ActionCatalogListParams as ActionCatalogListParams,
   };
 }