@mobilerun/sdk 5.5.0 → 5.6.0

package/src/resources/devices/devices.ts

@@ -155,11 +155,10 @@ export class Devices extends APIResource {
   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;
@@ -190,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);
@@ -293,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,
@@ -639,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;
 
@@ -692,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';
 
@@ -706,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
@@ -841,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<
@@ -857,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 {
@@ -878,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;
 
@@ -914,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,
   };
 

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 {

package/src/resources/devices/recordings.ts

@@ -330,9 +330,11 @@ export interface RecordingStartParams {
   retentionDays?: number;
 
   /**
-   * Artifacts to capture: trajectory (input actions), video, and audio (captured
+   * 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.
+   * recorders). Defaults to trajectory and video, narrowed to what the device
+   * produces.
    */
   types?: Array<string> | null;
 }

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

@@ -3,7 +3,6 @@
 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';
 
@@ -14,15 +13,10 @@ export class TrafficSessions extends APIResource {
    */
   create(
     deviceID: string,
-    params: TrafficSessionCreateParams,
+    body: 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]),
-    });
+    return this._client.post(path`/devices/${deviceID}/traffic/sessions`, { body, ...options });
   }
 
   /**
@@ -255,19 +249,8 @@ export namespace TrafficSessionDeleteResponse {
 }
 
 export interface TrafficSessionCreateParams {
-  /**
-   * Header param
-   */
-  'Idempotency-Key': string;
-
-  /**
-   * Body param
-   */
   expiresInSeconds?: number;
 
-  /**
-   * Body param
-   */
   maxBodyBytes?: number;
 }
 

package/src/resources/files.ts

@@ -66,16 +66,8 @@ export class Files extends APIResource {
   /**
    * Mint a presigned PUT URL for a user file upload
    */
-  uploadURL(params: FileUploadURLParams, options?: RequestOptions): APIPromise<FileUploadURLResponse> {
-    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
-    return this._client.post('/agents/files/upload-url', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
-        options?.headers,
-      ]),
-    });
+  uploadURL(body: FileUploadURLParams, options?: RequestOptions): APIPromise<FileUploadURLResponse> {
+    return this._client.post('/agents/files/upload-url', { body, ...options });
   }
 }
 
@@ -203,9 +195,13 @@ export namespace FileListResponse {
   }
 
   export interface Quota {
-    currentBytes: number;
+    includedBytes: number | null;
+
+    maxBytes: number | null;
+
+    overageAllowed: boolean;
 
-    quotaBytes: number;
+    usedBytes: number;
   }
 }
 
@@ -298,30 +294,13 @@ export interface FileListParams {
 }
 
 export interface FileUploadURLParams {
-  /**
-   * Body param
-   */
   filename: string;
 
-  /**
-   * Body param
-   */
   mimeType: string;
 
-  /**
-   * Body param
-   */
   sizeBytes: number;
 
-  /**
-   * Body param
-   */
   zone?: 'user' | 'skills';
-
-  /**
-   * Header param
-   */
-  'Idempotency-Key'?: string;
 }
 
 export declare namespace Files {

package/src/resources/index.ts

@@ -49,11 +49,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/devices';
 export {
@@ -76,6 +78,7 @@ export {
   type MailboxListResponse,
   type MailboxDeleteResponse,
   type MailboxCapacityResponse,
+  type MailboxDisconnectResponse,
   type MailboxOtpResponse,
   type MailboxRestartResponse,
   type MailboxUncancelResponse,
@@ -85,13 +88,20 @@ export {
   type MailboxOtpParams,
   type MailboxRestartParams,
 } from './mailboxes/mailboxes';
-export { Messages, type MessageListResponse, type MessageListParams } from './messages/messages';
+export {
+  Messages,
+  type MessageRetrieveResponse,
+  type MessageListResponse,
+  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 {

package/src/resources/mailboxes/connections.ts

@@ -0,0 +1,91 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+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.
+   *
+   * @example
+   * ```ts
+   * const connection =
+   *   await client.mailboxes.connections.create({
+   *     provider: 'gmail',
+   *   });
+   * ```
+   */
+  create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise<ConnectionCreateResponse> {
+    return this._client.post('/mailboxes/connections', { body, ...options });
+  }
+
+  /**
+   * Reports pending, active (with the Gmail address), expired, or removed.
+   * connectionId is the mailbox id.
+   *
+   * @example
+   * ```ts
+   * const connection =
+   *   await client.mailboxes.connections.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  retrieve(connectionID: string, options?: RequestOptions): APIPromise<ConnectionRetrieveResponse> {
+    return this._client.get(path`/mailboxes/connections/${connectionID}`, options);
+  }
+}
+
+export interface ConnectionCreateResponse {
+  address: string | null;
+
+  connectionId: string;
+
+  mailboxId: string;
+
+  redirectUrl: string | null;
+
+  status: 'pending' | 'active' | 'expired' | 'removed';
+}
+
+export interface ConnectionRetrieveResponse {
+  address: string | null;
+
+  connectionId: string;
+
+  mailboxId: string;
+
+  redirectUrl: string | null;
+
+  status: 'pending' | 'active' | 'expired' | 'removed';
+}
+
+export interface ConnectionCreateParams {
+  provider: 'gmail';
+
+  /**
+   * sha256 hex of the browser-held connect binding secret; forwarded to integrations
+   * connect
+   */
+  bindingHash?: string;
+
+  /**
+   * @deprecated Use the Idempotency-Key header.
+   */
+  clientRequestId?: string;
+
+  label?: string;
+}
+
+export declare namespace Connections {
+  export {
+    type ConnectionCreateResponse as ConnectionCreateResponse,
+    type ConnectionRetrieveResponse as ConnectionRetrieveResponse,
+    type ConnectionCreateParams as ConnectionCreateParams,
+  };
+}

package/src/resources/mailboxes/index.ts

@@ -1,5 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Connections,
+  type ConnectionCreateResponse,
+  type ConnectionRetrieveResponse,
+  type ConnectionCreateParams,
+} from './connections';
 export {
   Mailboxes,
   type MailboxCreateResponse,
@@ -8,6 +14,7 @@ export {
   type MailboxListResponse,
   type MailboxDeleteResponse,
   type MailboxCapacityResponse,
+  type MailboxDisconnectResponse,
   type MailboxOtpResponse,
   type MailboxRestartResponse,
   type MailboxUncancelResponse,