@mobilerun/sdk 5.6.0 → 6.0.0

package/src/resources/devices/devices.ts

@@ -77,6 +77,8 @@ import {
   RecordingDeleteParams,
   RecordingListParams,
   RecordingListResponse,
+  RecordingScreenshotsParams,
+  RecordingScreenshotsResponse,
   RecordingStartParams,
   RecordingStartResponse,
   RecordingStatusParams,
@@ -87,6 +89,16 @@ import {
   RecordingVideoParams,
   Recordings,
 } from './recordings';
+import * as ScreenshotsAPI from './screenshots';
+import {
+  ScreenshotCaptureParams,
+  ScreenshotCaptureResponse,
+  ScreenshotDeleteParams,
+  ScreenshotImageParams,
+  ScreenshotListParams,
+  ScreenshotListResponse,
+  Screenshots,
+} from './screenshots';
 import * as StateAPI from './state';
 import {
   A11YNode,
@@ -142,6 +154,7 @@ export class Devices extends APIResource {
   packages: PackagesAPI.Packages = new PackagesAPI.Packages(this._client);
   profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
   proxy: ProxyAPI.Proxy = new ProxyAPI.Proxy(this._client);
+  screenshots: ScreenshotsAPI.Screenshots = new ScreenshotsAPI.Screenshots(this._client);
   state: StateAPI.State = new StateAPI.State(this._client);
   tasks: TasksAPI.Tasks = new TasksAPI.Tasks(this._client);
   clipboard: ClipboardAPI.Clipboard = new ClipboardAPI.Clipboard(this._client);
@@ -180,6 +193,10 @@ export class Devices extends APIResource {
 
   /**
    * Returns a paginated list of the user's devices along with pagination metadata.
+   * By default every device except terminated and unknown-state ones is listed,
+   * including stopped and maintenance devices; narrow with e.g. `state=ready` or
+   * `state=stopped,maintenance`, and pass `state=terminated` or `state=unknown` to
+   * see those.
    */
   list(
     query: DeviceListParams | null | undefined = {},
@@ -259,11 +276,8 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Returns the set of capabilities supported by this device. For a legacy device
-   * this reflects the live instance's actual tools rather than its static type; for
-   * a core-managed device it is resolved from provider/pool configuration without
-   * guaranteeing a live instance. Used to determine which tools and features are
-   * available for the device.
+   * Returns the set of capabilities supported by this device. Used to determine
+   * which tools and features are available for the device.
    */
   retrieveCapabilities(
     deviceID: string,
@@ -308,9 +322,9 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Terminates the device and releases its resources. Termination can be scheduled
-   * for a future time or chained from a previous device via the request body, in
-   * which case a service key is required.
+   * Terminates the device and releases its resources. The optional `terminateAt` and
+   * `previousDeviceId` body fields are not available to API-key callers; requests
+   * that set them are rejected with 401.
    */
   terminate(
     deviceID: string,
@@ -848,23 +862,39 @@ export namespace DeviceCreateParams {
 export interface DeviceListParams {
   country?: string;
 
+  /**
+   * Include devices created at or after this RFC3339 timestamp.
+   */
+  createdAfter?: string;
+
+  /**
+   * Include devices created before this RFC3339 timestamp (exclusive). Must be later
+   * than createdAfter when both are set.
+   */
+  createdBefore?: string;
+
   /**
    * Filter to devices created by this user id. Mutually exclusive with mine.
    */
   createdBy?: string;
 
   /**
-   * When true, only return devices created by the calling user (resolved from
-   * X-User-ID, never a client-supplied id).
+   * When true, only return devices created by the authenticated caller.
    */
   mine?: boolean;
 
   name?: string;
 
-  orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt';
+  orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt' | 'gridPosition';
 
   orderByDirection?: 'asc' | 'desc';
 
+  /**
+   * Filter by owner IDs. Comma-separated or repeated parameters. Restricted to
+   * platform administrators.
+   */
+  ownerId?: Array<string> | null;
+
   page?: number;
 
   pageSize?: number;
@@ -877,6 +907,11 @@ export interface DeviceListParams {
 
   providerId?: string;
 
+  /**
+   * Filter by current device state. Comma-separated (state=ready,stopped). Defaults
+   * to every state except terminated and unknown, so stopped and maintenance devices
+   * are listed; pass state=terminated or state=unknown to see those.
+   */
   state?: Array<
     | 'creating'
     | 'assigned'
@@ -941,6 +976,7 @@ Devices.Location = Location;
 Devices.Packages = Packages;
 Devices.Profile = Profile;
 Devices.Proxy = ProxyAPIProxy;
+Devices.Screenshots = Screenshots;
 Devices.State = State;
 Devices.Tasks = Tasks;
 Devices.Clipboard = Clipboard;
@@ -1049,6 +1085,16 @@ export declare namespace Devices {
     type ProxyStatusParams as ProxyStatusParams,
   };
 
+  export {
+    Screenshots as Screenshots,
+    type ScreenshotListResponse as ScreenshotListResponse,
+    type ScreenshotCaptureResponse as ScreenshotCaptureResponse,
+    type ScreenshotListParams as ScreenshotListParams,
+    type ScreenshotDeleteParams as ScreenshotDeleteParams,
+    type ScreenshotCaptureParams as ScreenshotCaptureParams,
+    type ScreenshotImageParams as ScreenshotImageParams,
+  };
+
   export {
     State as State,
     type A11YNode as A11YNode,
@@ -1110,11 +1156,13 @@ export declare namespace Devices {
   export {
     Recordings as Recordings,
     type RecordingListResponse as RecordingListResponse,
+    type RecordingScreenshotsResponse as RecordingScreenshotsResponse,
     type RecordingStartResponse as RecordingStartResponse,
     type RecordingStatusResponse as RecordingStatusResponse,
     type RecordingStopResponse as RecordingStopResponse,
     type RecordingListParams as RecordingListParams,
     type RecordingDeleteParams as RecordingDeleteParams,
+    type RecordingScreenshotsParams as RecordingScreenshotsParams,
     type RecordingStartParams as RecordingStartParams,
     type RecordingStatusParams as RecordingStatusParams,
     type RecordingStopParams as RecordingStopParams,

package/src/resources/devices/index.ts

@@ -109,17 +109,28 @@ export {
 export {
   Recordings,
   type RecordingListResponse,
+  type RecordingScreenshotsResponse,
   type RecordingStartResponse,
   type RecordingStatusResponse,
   type RecordingStopResponse,
   type RecordingListParams,
   type RecordingDeleteParams,
+  type RecordingScreenshotsParams,
   type RecordingStartParams,
   type RecordingStatusParams,
   type RecordingStopParams,
   type RecordingTrajectoryParams,
   type RecordingVideoParams,
 } from './recordings';
+export {
+  Screenshots,
+  type ScreenshotListResponse,
+  type ScreenshotCaptureResponse,
+  type ScreenshotListParams,
+  type ScreenshotDeleteParams,
+  type ScreenshotCaptureParams,
+  type ScreenshotImageParams,
+} from './screenshots';
 export {
   State,
   type A11YNode,

package/src/resources/devices/keyboard.ts

@@ -114,12 +114,19 @@ export interface KeyboardWriteParams {
   errorRate?: number;
 
   /**
-   * Body param
+   * Body param: Request human-like input where supported by the device. Defaults to
+   * false.
+   */
+  humanize?: boolean;
+
+  /**
+   * @deprecated Body param: Deprecated: use humanize. Both names must agree when
+   * supplied together.
    */
   stealth?: boolean;
 
   /**
-   * Body param: Words per minute for stealth typing. 0 uses portal default.
+   * Body param: Words per minute for humanized typing. 0 uses the device default.
    */
   wpm?: number;
 

package/src/resources/devices/recordings.ts

@@ -29,6 +29,20 @@ export class Recordings extends APIResource {
     });
   }
 
+  /**
+   * Screenshots saved into the recording with
+   * `GET /devices/{deviceId}/screenshot?save=true`, oldest first, each with a
+   * presigned download URL.
+   */
+  screenshots(
+    recordingID: string,
+    params: RecordingScreenshotsParams,
+    options?: RequestOptions,
+  ): APIPromise<RecordingScreenshotsResponse | null> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/recordings/${recordingID}/screenshots`, options);
+  }
+
   /**
    * Start a device recording
    */
@@ -148,6 +162,24 @@ export namespace RecordingListResponse {
   }
 }
 
+export type RecordingScreenshotsResponse =
+  Array<RecordingScreenshotsResponse.RecordingScreenshotsResponseItem>;
+
+export namespace RecordingScreenshotsResponse {
+  export interface RecordingScreenshotsResponseItem {
+    id: string;
+
+    capturedAt: string;
+
+    sizeBytes: number;
+
+    /**
+     * Presigned download URL, valid for 15 minutes.
+     */
+    url: string;
+  }
+}
+
 export interface RecordingStartResponse {
   id: string;
 
@@ -317,23 +349,27 @@ export interface RecordingDeleteParams {
   deviceId: string;
 }
 
+export interface RecordingScreenshotsParams {
+  deviceId: string;
+}
+
 export interface RecordingStartParams {
   name?: string;
 
   /**
    * Capture quality from 1 (lowest) to 10 (full stream quality). Defaults to the
-   * device's full quality. Honored by devices recording through the portal stream
-   * bridge.
+   * device's full quality. Honored only by devices that support adjustable capture
+   * quality.
    */
   quality?: number;
 
   retentionDays?: number;
 
   /**
-   * Artifacts to capture: trajectory (input actions; on portal stream-bridge devices
-   * only when the handset announces trajectory capture), video, and audio (captured
-   * into the video artifact, so it requires video; honored by portal stream-bridge
-   * recorders). Defaults to trajectory and video, narrowed to what the device
+   * Artifacts to capture: trajectory (input actions; on some devices only when the
+   * device announces trajectory capture), video, and audio (captured into the video
+   * artifact, so it requires video; honored only by devices that support audio
+   * capture). Defaults to trajectory and video, narrowed to what the device
    * produces.
    */
   types?: Array<string> | null;
@@ -358,11 +394,13 @@ export interface RecordingVideoParams {
 export declare namespace Recordings {
   export {
     type RecordingListResponse as RecordingListResponse,
+    type RecordingScreenshotsResponse as RecordingScreenshotsResponse,
     type RecordingStartResponse as RecordingStartResponse,
     type RecordingStatusResponse as RecordingStatusResponse,
     type RecordingStopResponse as RecordingStopResponse,
     type RecordingListParams as RecordingListParams,
     type RecordingDeleteParams as RecordingDeleteParams,
+    type RecordingScreenshotsParams as RecordingScreenshotsParams,
     type RecordingStartParams as RecordingStartParams,
     type RecordingStatusParams as RecordingStatusParams,
     type RecordingStopParams as RecordingStopParams,

package/src/resources/devices/screenshots.ts

@@ -0,0 +1,140 @@
+// 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 Screenshots extends APIResource {
+  /**
+   * Saved screenshots, newest first. Pass nextCursor as cursor to retrieve the next
+   * page.
+   */
+  list(
+    deviceID: string,
+    query: ScreenshotListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ScreenshotListResponse> {
+    return this._client.get(path`/devices/${deviceID}/screenshots`, { query, ...options });
+  }
+
+  /**
+   * Delete a device screenshot
+   */
+  delete(screenshotID: string, params: ScreenshotDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId } = params;
+    return this._client.delete(path`/devices/${deviceId}/screenshots/${screenshotID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Captures the device screen and returns it as a PNG image. Pass save=true to
+   * store it as device media.
+   */
+  capture(
+    deviceID: string,
+    params: ScreenshotCaptureParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { hideOverlay, save, 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.post(path`/devices/${deviceID}/screenshots`, {
+      query: { hideOverlay, save },
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Redirects to a presigned PNG URL valid for 15 minutes.
+   */
+  image(screenshotID: string, params: ScreenshotImageParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/screenshots/${screenshotID}/image`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface ScreenshotListResponse {
+  items: Array<ScreenshotListResponse.Item> | null;
+
+  nextCursor: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace ScreenshotListResponse {
+  export interface Item {
+    id: string;
+
+    capturedAt: string;
+
+    deviceId: string;
+
+    expiresAt: string;
+
+    recordingId: string | null;
+
+    sizeBytes: number;
+  }
+}
+
+export type ScreenshotCaptureResponse = string;
+
+export interface ScreenshotListParams {
+  cursor?: string;
+
+  limit?: number;
+}
+
+export interface ScreenshotDeleteParams {
+  deviceId: string;
+}
+
+export interface ScreenshotCaptureParams {
+  /**
+   * Query param
+   */
+  hideOverlay?: boolean;
+
+  /**
+   * Query param: Store the screenshot as device media: in the owner's active
+   * recording, or standalone for 7 days. Without save=true nothing is stored. The
+   * PNG response is unchanged; X-Screenshot-Saved reports whether it was stored.
+   */
+  save?: boolean;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface ScreenshotImageParams {
+  deviceId: string;
+}
+
+export declare namespace Screenshots {
+  export {
+    type ScreenshotListResponse as ScreenshotListResponse,
+    type ScreenshotCaptureResponse as ScreenshotCaptureResponse,
+    type ScreenshotListParams as ScreenshotListParams,
+    type ScreenshotDeleteParams as ScreenshotDeleteParams,
+    type ScreenshotCaptureParams as ScreenshotCaptureParams,
+    type ScreenshotImageParams as ScreenshotImageParams,
+  };
+}

package/src/resources/devices/state.ts

@@ -8,8 +8,11 @@ import { path } from '../../internal/utils/path';
 
 export class State extends APIResource {
   /**
-   * Captures the device screen and returns it as a PNG image. An optional
-   * hideOverlay query parameter excludes the accessibility overlay from the capture.
+   * Deprecated: use POST /devices/{deviceId}/screenshots. Captures the device screen
+   * and returns it as a PNG image. An optional hideOverlay query parameter excludes
+   * the accessibility overlay from the capture.
+   *
+   * @deprecated
    */
   screenshot(
     deviceID: string,
@@ -214,6 +217,13 @@ export interface StateScreenshotParams {
    */
   hideOverlay?: boolean;
 
+  /**
+   * Query param: Store the screenshot as device media: in the owner's active
+   * recording, or standalone for 7 days. Without save=true nothing is stored. The
+   * PNG response is unchanged; X-Screenshot-Saved reports whether it was stored.
+   */
+  save?: boolean;
+
   /**
    * Header param
    */

package/src/resources/files.ts

@@ -37,9 +37,9 @@ export class Files extends APIResource {
   }
 
   /**
-   * Soft-cancels an in-flight upload before confirm. Only acts on `pending` rows —
-   * refuses to touch `ready` to avoid wiping confirmed files. Idempotent:
-   * `{ cancelled: false }` if the row exists but is no longer pending.
+   * 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.
    */
   cancelPending(fileID: string, options?: RequestOptions): APIPromise<FileCancelPendingResponse> {
     return this._client.delete(path`/agents/files/${fileID}/pending`, options);

package/src/resources/index.ts

@@ -1,12 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
-export {
-  AppEvents,
-  type AppEventRetrieveResponse,
-  type AppEventListResponse,
-  type AppEventListParams,
-} from './app-events/app-events';
 export {
   Apps,
   type AppRetrieveResponse,
@@ -21,19 +15,6 @@ export {
   type AppCreateSignedUploadURLParams,
 } from './apps';
 export { Assistant } from './assistant/assistant';
-export {
-  Carriers,
-  type CarrierCreateResponse,
-  type CarrierRetrieveResponse,
-  type CarrierUpdateResponse,
-  type CarrierListResponse,
-  type CarrierDeleteResponse,
-  type CarrierLookupResponse,
-  type CarrierCreateParams,
-  type CarrierUpdateParams,
-  type CarrierListParams,
-  type CarrierLookupParams,
-} from './carriers';
 export { Connect } from './connect/connect';
 export {
   Credentials,
@@ -95,15 +76,6 @@ export {
   type MessageListParams,
 } from './messages/messages';
 export { Models, type ModelListResponse } from './models';
-export {
-  Notifications,
-  type NotificationApplyPreferencesPresetResponse,
-  type NotificationCatalogResponse,
-  type NotificationGetPreferencesResponse,
-  type NotificationUpdatePreferencesResponse,
-  type NotificationApplyPreferencesPresetParams,
-  type NotificationUpdatePreferencesParams,
-} from './notifications';
 export {
   Numbers,
   type NumberCreateResponse,
@@ -113,23 +85,11 @@ export {
   type NumberDeleteResponse,
   type NumberCapacityResponse,
   type NumberCountriesResponse,
-  type NumberPurposesResponse,
   type NumberCreateParams,
   type NumberUpdateParams,
   type NumberListParams,
   type NumberCapacityParams,
 } from './numbers/numbers';
-export {
-  Profiles,
-  type ProfileCreateResponse,
-  type ProfileRetrieveResponse,
-  type ProfileUpdateResponse,
-  type ProfileListResponse,
-  type ProfileDeleteResponse,
-  type ProfileCreateParams,
-  type ProfileUpdateParams,
-  type ProfileListParams,
-} from './profiles';
 export {
   Proxies,
   type ProxyCreateResponse,
@@ -137,13 +97,10 @@ export {
   type ProxyUpdateResponse,
   type ProxyListResponse,
   type ProxyDeleteResponse,
-  type ProxyLookupResponse,
   type ProxyCreateParams,
   type ProxyUpdateParams,
   type ProxyListParams,
-  type ProxyLookupParams,
 } from './proxies';
-export { Store, type StoreCategoriesResponse } from './store/store';
 export {
   Tasks,
   type TaskRetrieveResponse,
@@ -165,7 +122,6 @@ export {
   type WebhookRetrieveResponse,
   type WebhookUpdateResponse,
   type WebhookListResponse,
-  type WebhookEventTypesResponse,
   type WebhookRotateSecretResponse,
   type WebhookTestDeliveryResponse,
   type WebhookCreateParams,

package/src/resources/mailboxes/connections.ts

@@ -7,10 +7,9 @@ import { path } from '../../internal/utils/path';
 
 export class Connections extends APIResource {
   /**
-   * Links the caller’s Gmail account through the shared integrations connect.
-   * Replaying the same Idempotency-Key (or, during migration, the deprecated
-   * `clientRequestId` body field) returns the same mailbox. When Gmail is already
-   * active, redirectUrl is null and the mailbox is usable immediately.
+   * Links the caller’s Gmail account. Replaying the same Idempotency-Key returns the
+   * same mailbox. When Gmail is already active, redirectUrl is null and the mailbox
+   * is usable immediately.
    *
    * @example
    * ```ts
@@ -69,16 +68,10 @@ export interface ConnectionCreateParams {
   provider: 'gmail';
 
   /**
-   * sha256 hex of the browser-held connect binding secret; forwarded to integrations
-   * connect
+   * sha256 hex of the browser-held connect binding secret.
    */
   bindingHash?: string;
 
-  /**
-   * @deprecated Use the Idempotency-Key header.
-   */
-  clientRequestId?: string;
-
   label?: string;
 }
 

package/src/resources/mailboxes/mailboxes.ts

@@ -27,9 +27,9 @@ export class Mailboxes extends APIResource {
 
   /**
    * Creates a mailbox on the default domain or a connected custom domain. An
-   * optional `localPart` selects the address. Replaying the same Idempotency-Key
-   * (or, during migration, the deprecated `clientRequestId` body field) and payload
-   * returns the original mailbox. Poll the mailbox when a 202 response does not yet
+   * optional `localPart` selects the address. Replaying the same Idempotency-Key and
+   * payload returns the original mailbox. Fresh requests and replays return 202 with
+   * the current mailbox state. Poll the mailbox when the response does not yet
    * include a checkout URL.
    *
    * @example
@@ -121,7 +121,8 @@ export class Mailboxes extends APIResource {
   }
 
   /**
-   * Removes only this mailbox link. The agent Composio connection stays in place.
+   * Removes only this mailbox link. The Gmail connection used by your agents stays
+   * in place.
    *
    * @example
    * ```ts