@mobilerun/sdk 5.4.0 → 5.5.0

package/src/resources/devices/apps.ts

@@ -79,15 +79,16 @@ export class Apps extends APIResource {
 
   /**
    * Requests an app install on the device. The request body must supply exactly one
-   * of an Android packageName or an iOS bundleId; protected packages are rejected.
-   * background (default false) selects the response contract: false installs inline
-   * and returns the outcome directly (200 on success, an error status on failure);
-   * true accepts the request and runs the download + install in the background,
-   * returning 202 immediately — poll list-app-installs for the backend's view of
-   * that attempt's status. Refuses with 409 once 2 other installs are already
-   * running on the device, in either mode; a repeat request for an app that already
-   * has an install running is also refused with 409 rather than superseding it —
-   * retry once that attempt reaches a terminal state.
+   * of an Android packageName or an iOS bundleId; optional country and versionCode
+   * select an exact regional uploaded Android version, and protected packages are
+   * rejected. background (default false) selects the response contract: false
+   * installs inline and returns the outcome directly (200 on success, an error
+   * status on failure); true accepts the request and runs the download + install in
+   * the background, returning 202 immediately — poll list-app-installs for the
+   * backend's view of that attempt's status. Refuses with 409 once 2 other installs
+   * are already running on the device, in either mode; a repeat request for an app
+   * that already has an install running is also refused with 409 rather than
+   * superseding it — retry once that attempt reaches a terminal state.
    */
   install(deviceID: string, params: AppInstallParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -107,11 +108,11 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Reports the backend's view of background app-install attempts on this device —
-   * status reflects the install ATTEMPT, not device ground truth; list-apps remains
-   * authoritative for what is actually installed. Records are in-memory and lost on
-   * service restart; terminal records are kept ~15 minutes. Not gated on device
-   * readiness, so it also answers while the device is offline or crashed.
+   * Reports the backend's durable view of background app-install attempts on this
+   * device — status reflects the install ATTEMPT, not device ground truth; list-apps
+   * remains authoritative for what is actually installed. Terminal and projected
+   * timeout records are kept ~15 minutes. Not gated on device readiness, so it also
+   * answers while the device is offline or crashed.
    */
   listInstalls(
     deviceID: string,
@@ -249,10 +250,9 @@ export namespace AppListInstallsResponse {
     updatedAt: string;
 
     /**
-     * Closed set: download_failed, adb_install_failed, panic, timeout, failed. Only
-     * present when status is failed.
+     * Only present when status is failed.
      */
-    errorClass?: string;
+    errorClass?: 'download_failed' | 'adb_install_failed' | 'panic' | 'timeout' | 'failed';
   }
 }
 
@@ -318,11 +318,23 @@ export declare namespace AppInstallParams {
      */
     background?: boolean;
 
+    /**
+     * Body param: Optional ISO 3166-1 alpha-2 country of the uploaded app version
+     * (e.g. MY or SG).
+     */
+    country?: string;
+
     /**
      * Body param: Android package name (e.g. com.example.app)
      */
     packageName?: string;
 
+    /**
+     * Body param: Optional exact app-library version code. Use with country when
+     * multiple regional versions share an identifier.
+     */
+    versionCode?: number;
+
     /**
      * Header param
      */
@@ -347,6 +359,18 @@ export declare namespace AppInstallParams {
      */
     bundleId?: string;
 
+    /**
+     * Body param: Optional ISO 3166-1 alpha-2 country of the uploaded app version
+     * (e.g. MY or SG).
+     */
+    country?: string;
+
+    /**
+     * Body param: Optional exact app-library version code. Use with country when
+     * multiple regional versions share an identifier.
+     */
+    versionCode?: number;
+
     /**
      * Header param
      */

package/src/resources/devices/devices.ts

@@ -102,6 +102,18 @@ import * as TasksAPI from './tasks';
 import { TaskListParams, TaskListResponse, Tasks } from './tasks';
 import * as TimezoneAPI from './timezone';
 import { Timezone, TimezoneGetParams, TimezoneGetResponse, TimezoneSetParams } from './timezone';
+import * as TrafficSessionsAPI from './traffic-sessions';
+import {
+  TrafficSessionCreateParams,
+  TrafficSessionCreateResponse,
+  TrafficSessionDeleteParams,
+  TrafficSessionDeleteResponse,
+  TrafficSessionListParams,
+  TrafficSessionListResponse,
+  TrafficSessionRetrieveParams,
+  TrafficSessionRetrieveResponse,
+  TrafficSessions,
+} from './traffic-sessions';
 import * as EsimAPI from './esim/esim';
 import {
   Esim,
@@ -140,6 +152,7 @@ export class Devices extends APIResource {
   kiosk: KioskAPI.Kiosk = new KioskAPI.Kiosk(this._client);
   mediaSessions: MediaSessionsAPI.MediaSessions = new MediaSessionsAPI.MediaSessions(this._client);
   recordings: RecordingsAPI.Recordings = new RecordingsAPI.Recordings(this._client);
+  trafficSessions: TrafficSessionsAPI.TrafficSessions = new TrafficSessionsAPI.TrafficSessions(this._client);
 
   /**
    * Requests a new device for the authenticated user from the device spec in the
@@ -231,10 +244,9 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Wakes a parked device: capacity is preflighted (the device's data may be
-   * replicated to another node if its home is full), the device starts running
-   * again, and per-minute billing resumes. On a device that is not parked this is a
-   * no-op ready transition.
+   * Wakes a parked device: backend readiness and any required capacity are
+   * preflighted, the same device starts running again, and per-minute billing
+   * resumes. On a device that is not parked this is a no-op ready transition.
    */
   resume(deviceID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/resume`, {
@@ -315,6 +327,11 @@ export interface DeviceCreateResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -361,6 +378,11 @@ export interface DeviceRetrieveResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -419,6 +441,11 @@ export namespace DeviceListResponse {
 
     name: string;
 
+    /**
+     * Operating system the device runs.
+     */
+    platform: 'android' | 'ios';
+
     state: string;
 
     stateMessage: string;
@@ -543,6 +570,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     proxy: boolean;
 
+    recording: boolean;
+
     reset: boolean;
 
     shell: boolean;
@@ -554,6 +583,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
     stream: boolean;
 
     time: boolean;
+
+    trafficInspection: boolean;
   }
 }
 
@@ -568,6 +599,11 @@ export interface DeviceSetNameResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -614,6 +650,11 @@ export interface DeviceWaitReadyResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -862,6 +903,7 @@ Devices.Browser = Browser;
 Devices.Kiosk = Kiosk;
 Devices.MediaSessions = MediaSessions;
 Devices.Recordings = Recordings;
+Devices.TrafficSessions = TrafficSessions;
 
 export declare namespace Devices {
   export {
@@ -1029,4 +1071,16 @@ export declare namespace Devices {
     type RecordingTrajectoryParams as RecordingTrajectoryParams,
     type RecordingVideoParams as RecordingVideoParams,
   };
+
+  export {
+    TrafficSessions as TrafficSessions,
+    type TrafficSessionCreateResponse as TrafficSessionCreateResponse,
+    type TrafficSessionRetrieveResponse as TrafficSessionRetrieveResponse,
+    type TrafficSessionListResponse as TrafficSessionListResponse,
+    type TrafficSessionDeleteResponse as TrafficSessionDeleteResponse,
+    type TrafficSessionCreateParams as TrafficSessionCreateParams,
+    type TrafficSessionRetrieveParams as TrafficSessionRetrieveParams,
+    type TrafficSessionListParams as TrafficSessionListParams,
+    type TrafficSessionDeleteParams as TrafficSessionDeleteParams,
+  };
 }

package/src/resources/devices/index.ts

@@ -135,3 +135,14 @@ export {
   type TimezoneGetParams,
   type TimezoneSetParams,
 } from './timezone';
+export {
+  TrafficSessions,
+  type TrafficSessionCreateResponse,
+  type TrafficSessionRetrieveResponse,
+  type TrafficSessionListResponse,
+  type TrafficSessionDeleteResponse,
+  type TrafficSessionCreateParams,
+  type TrafficSessionRetrieveParams,
+  type TrafficSessionListParams,
+  type TrafficSessionDeleteParams,
+} from './traffic-sessions';

package/src/resources/devices/keyboard.ts

@@ -51,9 +51,9 @@ export class Keyboard extends APIResource {
   }
 
   /**
-   * Types the given text into the focused input field. Supports optionally clearing
-   * the field first and a stealth mode that emulates human typing speed and error
-   * rate on supported devices.
+   * Types text into the focused input field. The optional completionMode defaults to
+   * accepted for backwards-compatible low latency; committed additionally waits for
+   * the complete text or a quiescent UI state.
    */
   write(deviceID: string, params: KeyboardWriteParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -100,6 +100,13 @@ export interface KeyboardWriteParams {
    */
   clear?: boolean;
 
+  /**
+   * Body param: Completion guarantee. accepted returns after the input provider
+   * accepts the operation; committed additionally waits for the focused UI state to
+   * contain the complete text or become quiescent.
+   */
+  completionMode?: 'accepted' | 'committed';
+
   /**
    * Body param: Per-character mistake rate for humantouch typing. -1 uses server
    * default.

package/src/resources/devices/recordings.ts

@@ -320,8 +320,20 @@ export interface RecordingDeleteParams {
 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.
+   */
+  quality?: number;
+
   retentionDays?: number;
 
+  /**
+   * Artifacts to capture: trajectory (input actions), video, and audio (captured
+   * into the video artifact, so it requires video; honored by portal stream-bridge
+   * recorders). Defaults to trajectory and video.
+   */
   types?: Array<string> | null;
 }
 

package/src/resources/devices/traffic-sessions.ts

@@ -0,0 +1,299 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class TrafficSessions extends APIResource {
+  /**
+   * Starts one live-only decoded HTTP/1.1, HTTP/2, HTTP/3 and WebSocket traffic
+   * session.
+   */
+  create(
+    deviceID: string,
+    params: TrafficSessionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<TrafficSessionCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/traffic/sessions`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'Idempotency-Key': idempotencyKey }, options?.headers]),
+    });
+  }
+
+  /**
+   * Returns status and the device stream credential for a live session.
+   */
+  retrieve(
+    sessionID: string,
+    params: TrafficSessionRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TrafficSessionRetrieveResponse> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/traffic/sessions/${sessionID}`, options);
+  }
+
+  /**
+   * List device traffic sessions
+   */
+  list(
+    deviceID: string,
+    query: TrafficSessionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TrafficSessionListResponse> {
+    return this._client.get(path`/devices/${deviceID}/traffic/sessions`, { query, ...options });
+  }
+
+  /**
+   * Stop device traffic inspection
+   */
+  delete(
+    sessionID: string,
+    params: TrafficSessionDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<TrafficSessionDeleteResponse> {
+    const { deviceId } = params;
+    return this._client.delete(path`/devices/${deviceId}/traffic/sessions/${sessionID}`, options);
+  }
+}
+
+export interface TrafficSessionCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  deviceId: string;
+
+  expiresAt: string;
+
+  maxBodyBytes: number;
+
+  retention: 'none';
+
+  state: 'starting' | 'active' | 'stopping' | 'stopped' | 'failed' | 'expired';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  error?: TrafficSessionCreateResponse.Error;
+
+  startedAt?: string;
+
+  stoppedAt?: string;
+
+  stream?: TrafficSessionCreateResponse.Stream;
+}
+
+export namespace TrafficSessionCreateResponse {
+  export interface Error {
+    code: string;
+
+    message: string;
+  }
+
+  export interface Stream {
+    token: string;
+
+    protocol: string;
+
+    url: string;
+  }
+}
+
+export interface TrafficSessionRetrieveResponse {
+  id: string;
+
+  createdAt: string;
+
+  deviceId: string;
+
+  expiresAt: string;
+
+  maxBodyBytes: number;
+
+  retention: 'none';
+
+  state: 'starting' | 'active' | 'stopping' | 'stopped' | 'failed' | 'expired';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  error?: TrafficSessionRetrieveResponse.Error;
+
+  startedAt?: string;
+
+  stoppedAt?: string;
+
+  stream?: TrafficSessionRetrieveResponse.Stream;
+}
+
+export namespace TrafficSessionRetrieveResponse {
+  export interface Error {
+    code: string;
+
+    message: string;
+  }
+
+  export interface Stream {
+    token: string;
+
+    protocol: string;
+
+    url: string;
+  }
+}
+
+export interface TrafficSessionListResponse {
+  items: Array<TrafficSessionListResponse.Item> | null;
+
+  pagination: Shared.Meta;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace TrafficSessionListResponse {
+  export interface Item {
+    id: string;
+
+    createdAt: string;
+
+    deviceId: string;
+
+    expiresAt: string;
+
+    maxBodyBytes: number;
+
+    retention: 'none';
+
+    state: 'starting' | 'active' | 'stopping' | 'stopped' | 'failed' | 'expired';
+
+    /**
+     * A URL to the JSON Schema for this object.
+     */
+    $schema?: string;
+
+    error?: Item.Error;
+
+    startedAt?: string;
+
+    stoppedAt?: string;
+
+    stream?: Item.Stream;
+  }
+
+  export namespace Item {
+    export interface Error {
+      code: string;
+
+      message: string;
+    }
+
+    export interface Stream {
+      token: string;
+
+      protocol: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface TrafficSessionDeleteResponse {
+  id: string;
+
+  createdAt: string;
+
+  deviceId: string;
+
+  expiresAt: string;
+
+  maxBodyBytes: number;
+
+  retention: 'none';
+
+  state: 'starting' | 'active' | 'stopping' | 'stopped' | 'failed' | 'expired';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  error?: TrafficSessionDeleteResponse.Error;
+
+  startedAt?: string;
+
+  stoppedAt?: string;
+
+  stream?: TrafficSessionDeleteResponse.Stream;
+}
+
+export namespace TrafficSessionDeleteResponse {
+  export interface Error {
+    code: string;
+
+    message: string;
+  }
+
+  export interface Stream {
+    token: string;
+
+    protocol: string;
+
+    url: string;
+  }
+}
+
+export interface TrafficSessionCreateParams {
+  /**
+   * Header param
+   */
+  'Idempotency-Key': string;
+
+  /**
+   * Body param
+   */
+  expiresInSeconds?: number;
+
+  /**
+   * Body param
+   */
+  maxBodyBytes?: number;
+}
+
+export interface TrafficSessionRetrieveParams {
+  deviceId: string;
+}
+
+export interface TrafficSessionListParams {
+  page?: number;
+
+  pageSize?: number;
+}
+
+export interface TrafficSessionDeleteParams {
+  deviceId: string;
+}
+
+export declare namespace TrafficSessions {
+  export {
+    type TrafficSessionCreateResponse as TrafficSessionCreateResponse,
+    type TrafficSessionRetrieveResponse as TrafficSessionRetrieveResponse,
+    type TrafficSessionListResponse as TrafficSessionListResponse,
+    type TrafficSessionDeleteResponse as TrafficSessionDeleteResponse,
+    type TrafficSessionCreateParams as TrafficSessionCreateParams,
+    type TrafficSessionRetrieveParams as TrafficSessionRetrieveParams,
+    type TrafficSessionListParams as TrafficSessionListParams,
+    type TrafficSessionDeleteParams as TrafficSessionDeleteParams,
+  };
+}