@mobilerun/sdk 5.4.0 → 5.6.0

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,13 +152,13 @@ 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
-   * request body. Optional query parameters select the canonical device type, target
-   * country, billing mode, and a profile to use as the base spec; deprecated
-   * device-type aliases remain accepted only during the documented compatibility
-   * grace period. The response returns the device and its stream token.
+   * Requests a new device from the specification in the request body. Optional query
+   * parameters select the canonical device type, country, billing mode, and base
+   * profile. Returns the device, its resolved billing strategy, and its stream
+   * token.
    */
   create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<DeviceCreateResponse> {
     const { billing, query_country, deviceType, profileId, ...body } = params;
@@ -177,7 +189,11 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Returns the number of claimed devices for the user, broken down by device type.
+   * Deprecated: use GET /devices/summary instead. Returns the number of active
+   * claimed devices for the user, broken down by device type, in the legacy response
+   * shape.
+   *
+   * @deprecated
    */
   count(options?: RequestOptions): APIPromise<DeviceCountResponse> {
     return this._client.get('/devices/count', options);
@@ -231,10 +247,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`, {
@@ -281,12 +296,27 @@ export class Devices extends APIResource {
     });
   }
 
+  /**
+   * Returns the total number of the user's devices and counts grouped by current
+   * state and device type.
+   */
+  summary(
+    query: DeviceSummaryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviceSummaryResponse> {
+    return this._client.get('/devices/summary', { query, ...options });
+  }
+
   /**
    * 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.
    */
-  terminate(deviceID: string, body: DeviceTerminateParams, options?: RequestOptions): APIPromise<void> {
+  terminate(
+    deviceID: string,
+    body: DeviceTerminateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
     return this._client.delete(path`/devices/${deviceID}`, {
       body,
       ...options,
@@ -315,6 +345,11 @@ export interface DeviceCreateResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -361,6 +396,11 @@ export interface DeviceRetrieveResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -419,6 +459,11 @@ export namespace DeviceListResponse {
 
     name: string;
 
+    /**
+     * Operating system the device runs.
+     */
+    platform: 'android' | 'ios';
+
     state: string;
 
     stateMessage: string;
@@ -543,6 +588,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     proxy: boolean;
 
+    recording: boolean;
+
     reset: boolean;
 
     shell: boolean;
@@ -554,6 +601,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
     stream: boolean;
 
     time: boolean;
+
+    trafficInspection: boolean;
   }
 }
 
@@ -568,6 +617,11 @@ export interface DeviceSetNameResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -603,6 +657,19 @@ export interface DeviceSetNameResponse {
   userId?: string;
 }
 
+export interface DeviceSummaryResponse {
+  byState: { [key: string]: number };
+
+  byType: { [key: string]: number };
+
+  total: number;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
 export interface DeviceWaitReadyResponse {
   id: string;
 
@@ -614,6 +681,11 @@ export interface DeviceWaitReadyResponse {
 
   name: string;
 
+  /**
+   * Operating system the device runs.
+   */
+  platform: 'android' | 'ios';
+
   state: string;
 
   stateMessage: string;
@@ -651,10 +723,13 @@ export interface DeviceWaitReadyResponse {
 
 export interface DeviceCreateParams {
   /**
-   * Query param: Billing mode. 'auto' uses a subscription slot when available and
-   * otherwise bills per minute; 'subscription' requires an available subscription
-   * slot; 'minute' bills per minute. Only cloud phone and cloud emulator devices
-   * support per-minute billing.
+   * Query param: Billing mode. 'auto' tries subscription first, then minute billing
+   * if no subscription entitlement exists or all subscription slots are in use,
+   * provided minute billing is enabled. When subscription billing is disabled, auto
+   * uses minutes directly. Billing-service failures never trigger fallback.
+   * 'subscription' requires an available subscription slot and never falls back.
+   * 'minute' uses minute billing only, subject to balance and concurrency checks.
+   * Modes depend on the device type's billing configuration.
    */
   billing?: 'auto' | 'subscription' | 'minute';
 
@@ -665,18 +740,12 @@ export interface DeviceCreateParams {
   query_country?: string;
 
   /**
-   * Query param: Deprecated device type aliases are accepted during a compatibility
-   * grace period: dedicated_premium_device maps to android_cloud_phone,
-   * dedicated_physical_device maps to android_physical_phone, dedicated_ios_device
-   * maps to ios_stealth_phone, and dedicated_emulated_device maps to
-   * android_emulator.
+   * Query param: Use android*cloud_phone for a cloud Android phone. Only canonical
+   * identifiers are accepted. Other backends are deployment-specific; recognized but
+   * unavailable types return DEVICE_TYPE_UNAVAILABLE (422). Retired dedicated*\*
+   * aliases are rejected with a canonical replacement.
    */
-  deviceType?:
-    | 'android_cloud_phone'
-    | 'dedicated_premium_device'
-    | 'dedicated_physical_device'
-    | 'dedicated_ios_device'
-    | 'dedicated_emulated_device';
+  deviceType?: string;
 
   /**
    * Query param: Profile ID to use as device spec
@@ -800,6 +869,12 @@ export interface DeviceListParams {
 
   pageSize?: number;
 
+  /**
+   * Filter by the device's platform as served in the platform field (runtime,
+   * announced, else type-derived).
+   */
+  platform?: 'android' | 'ios';
+
   providerId?: string;
 
   state?: Array<
@@ -816,17 +891,16 @@ export interface DeviceListParams {
   > | null;
 
   /**
-   * Deprecated device type aliases are accepted during a compatibility grace period:
-   * dedicated_premium_device maps to android_cloud_phone, dedicated_physical_device
-   * maps to android_physical_phone, dedicated_ios_device maps to ios_stealth_phone,
-   * and dedicated_emulated_device maps to android_emulator.
+   * Canonical device type. Retired dedicated\_\* aliases are no longer accepted.
+   * Availability depends on the deployment.
    */
   type?:
     | 'android_cloud_phone'
-    | 'dedicated_premium_device'
-    | 'dedicated_physical_device'
-    | 'dedicated_ios_device'
-    | 'dedicated_emulated_device';
+    | 'android_physical_phone'
+    | 'ios_stealth_phone'
+    | 'android_emulator'
+    | 'ios_simulator'
+    | 'device_slot';
 }
 
 export interface DeviceFingerprintParams {
@@ -837,6 +911,21 @@ export interface DeviceSetNameParams {
   name: string;
 }
 
+export interface DeviceSummaryParams {
+  state?: Array<
+    | 'creating'
+    | 'assigned'
+    | 'ready'
+    | 'rebooting'
+    | 'migrating'
+    | 'resetting'
+    | 'terminated'
+    | 'maintenance'
+    | 'stopped'
+    | 'unknown'
+  > | null;
+}
+
 export interface DeviceTerminateParams {
   previousDeviceId?: string;
 
@@ -862,6 +951,7 @@ Devices.Browser = Browser;
 Devices.Kiosk = Kiosk;
 Devices.MediaSessions = MediaSessions;
 Devices.Recordings = Recordings;
+Devices.TrafficSessions = TrafficSessions;
 
 export declare namespace Devices {
   export {
@@ -872,11 +962,13 @@ export declare namespace Devices {
     type DeviceFingerprintResponse as DeviceFingerprintResponse,
     type DeviceRetrieveCapabilitiesResponse as DeviceRetrieveCapabilitiesResponse,
     type DeviceSetNameResponse as DeviceSetNameResponse,
+    type DeviceSummaryResponse as DeviceSummaryResponse,
     type DeviceWaitReadyResponse as DeviceWaitReadyResponse,
     type DeviceCreateParams as DeviceCreateParams,
     type DeviceListParams as DeviceListParams,
     type DeviceFingerprintParams as DeviceFingerprintParams,
     type DeviceSetNameParams as DeviceSetNameParams,
+    type DeviceSummaryParams as DeviceSummaryParams,
     type DeviceTerminateParams as DeviceTerminateParams,
   };
 
@@ -1029,4 +1121,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

@@ -39,11 +39,13 @@ export {
   type DeviceFingerprintResponse,
   type DeviceRetrieveCapabilitiesResponse,
   type DeviceSetNameResponse,
+  type DeviceSummaryResponse,
   type DeviceWaitReadyResponse,
   type DeviceCreateParams,
   type DeviceListParams,
   type DeviceFingerprintParams,
   type DeviceSetNameParams,
+  type DeviceSummaryParams,
   type DeviceTerminateParams,
 } from './devices';
 export {
@@ -135,3 +137,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,22 @@ 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; 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
+   * produces.
+   */
   types?: Array<string> | null;
 }
 

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

@@ -0,0 +1,282 @@
+// 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';
+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,
+    body: TrafficSessionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<TrafficSessionCreateResponse> {
+    return this._client.post(path`/devices/${deviceID}/traffic/sessions`, { body, ...options });
+  }
+
+  /**
+   * 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 {
+  expiresInSeconds?: number;
+
+  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,
+  };
+}