@mobilerun/sdk 6.0.0 → 6.1.0

package/src/resources/devices/devices.ts

@@ -50,16 +50,6 @@ import * as LanguageAPI from './language';
 import { Language, LanguageGetParams, LanguageGetResponse, LanguageSetParams } from './language';
 import * as LocationAPI from './location';
 import { Location, LocationGetParams, LocationResetParams, LocationSetParams } from './location';
-import * as MediaSessionsAPI from './media-sessions';
-import {
-  MediaSessionActivateParams,
-  MediaSessionActivateResponse,
-  MediaSessionCreateParams,
-  MediaSessionCreateResponse,
-  MediaSessionDeleteParams,
-  MediaSessionRetrieveCurrentResponse,
-  MediaSessions,
-} from './media-sessions';
 import * as PackagesAPI from './packages';
 import { PackageListParams, PackageListResponse, Packages } from './packages';
 import * as ProfileAPI from './profile';
@@ -163,7 +153,6 @@ export class Devices extends APIResource {
   deepLink: DeepLinkAPI.DeepLink = new DeepLinkAPI.DeepLink(this._client);
   browser: BrowserAPI.Browser = new BrowserAPI.Browser(this._client);
   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);
 
@@ -174,9 +163,9 @@ export class Devices extends APIResource {
    * token.
    */
   create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<DeviceCreateResponse> {
-    const { billing, query_country, deviceType, profileId, ...body } = params;
+    const { billing, query_country, deviceType, profileId, template, ...body } = params;
     return this._client.post('/devices', {
-      query: { billing, country: query_country, deviceType, profileId },
+      query: { billing, country: query_country, deviceType, profileId, template },
       body,
       ...options,
     });
@@ -242,7 +231,10 @@ export class Devices extends APIResource {
 
   /**
    * Triggers a reboot of the device. The device transitions through its reboot
-   * lifecycle and becomes ready again once the restart completes.
+   * lifecycle and becomes ready again once the restart completes. Only devices whose
+   * capabilities report `reboot=true` can be rebooted. Personal (BYOD) devices
+   * cannot be rebooted remotely: the request is refused with 400
+   * `DEVICE_TOOL_UNSUPPORTED` and nothing happens on the device.
    */
   reboot(deviceID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/reboot`, {
@@ -252,21 +244,30 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Resets the device back to a clean state, clearing installed apps and user data
-   * accumulated during the session. The device transitions through its reset
-   * lifecycle before becoming ready again.
+   * Resets the device. `mode` selects what is erased: `full` (factory reset: apps,
+   * accounts, storage, new identity) or `identity` (new fingerprint, apps and data
+   * kept). Without `mode` the reset is `full`, or `identity` on devices with
+   * `factoryReset=false`. A mode or `preserve` value the device does not support is
+   * refused with 400 `DEVICE_TOOL_UNSUPPORTED`. `preserve` restores the latest
+   * proxy, location, locale or timezone set through the API after the reset; omitted
+   * or empty preserves nothing. The device becomes ready again after the reset.
    */
-  reset(deviceID: string, options?: RequestOptions): APIPromise<void> {
+  reset(
+    deviceID: string,
+    body: DeviceResetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/reset`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * 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.
+   * Wakes a parked device: it first checks that the device can run again, then the
+   * same device starts and per-minute billing resumes. On a device that is not
+   * parked, the request does nothing.
    */
   resume(deviceID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/devices/${deviceID}/resume`, {
@@ -322,9 +323,13 @@ export class Devices extends APIResource {
   }
 
   /**
-   * 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.
+   * Terminates the device and releases its resources. For a personal (BYOD) device
+   * the owner (API key or user) can instead remove the phone from the account so
+   * anyone can pair it again; the phone must be disconnected first, otherwise the
+   * request is rejected with 409 BYOD_DEVICE_CONNECTED. Other subscription-billed
+   * devices cannot be terminated with this request; it is rejected with 401. The
+   * `terminateAt` and `previousDeviceId` body fields are reserved for internal use;
+   * requests that set them are rejected with 401.
    */
   terminate(
     deviceID: string,
@@ -549,8 +554,6 @@ export namespace DeviceFingerprintResponse {
 
     hardware?: string;
 
-    imageRepository?: string;
-
     manufacturer?: string;
 
     model?: string;
@@ -584,6 +587,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     esim: boolean;
 
+    factoryReset: boolean;
+
     files: boolean;
 
     fingerprint: boolean;
@@ -594,6 +599,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     humanTouch: boolean;
 
+    identityReset: boolean;
+
     language: boolean;
 
     logcat: boolean;
@@ -602,6 +609,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     proxy: boolean;
 
+    reboot: boolean;
+
     recording: boolean;
 
     reset: boolean;
@@ -617,6 +626,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
     time: boolean;
 
     trafficInspection: boolean;
+
+    mediaInjectionTransport?: 'direct';
   }
 }
 
@@ -754,18 +765,27 @@ export interface DeviceCreateParams {
   query_country?: string;
 
   /**
-   * 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.
+   * Query param: Device type: android_cloud_phone (cloud Android phone), ios_phone
+   * or device_slot. Any other value is rejected with 422. Not every device type is
+   * available for creation; an unavailable type returns DEVICE_TYPE_UNAVAILABLE
+   * (422).
    */
-  deviceType?: string;
+  deviceType?: 'android_cloud_phone' | 'ios_phone' | 'device_slot';
 
   /**
    * Query param: Profile ID to use as device spec
    */
   profileId?: string;
 
+  /**
+   * Query param: Optional device template, e.g. onboarding. The device gets the
+   * template's Android version and preinstalled apps and is ready in seconds when a
+   * prepared phone is available; otherwise it boots with the same setup. Country,
+   * name and proxy still come from this request. Cannot be combined with profileId,
+   * apps or androidVersion. Omit it to create from the request alone.
+   */
+  template?: string;
+
   /**
    * Body param
    */
@@ -889,24 +909,23 @@ export interface DeviceListParams {
 
   orderByDirection?: 'asc' | 'desc';
 
-  /**
-   * Filter by owner IDs. Comma-separated or repeated parameters. Restricted to
-   * platform administrators.
-   */
-  ownerId?: Array<string> | null;
-
   page?: number;
 
   pageSize?: number;
 
   /**
-   * Filter by the device's platform as served in the platform field (runtime,
-   * announced, else type-derived).
+   * Filter by the device's platform as served in the platform field.
    */
   platform?: 'android' | 'ios';
 
   providerId?: string;
 
+  /**
+   * Case-insensitive search: matches devices whose name contains the term or whose
+   * ID starts with it. Combined with all other filters.
+   */
+  search?: string;
+
   /**
    * Filter by current device state. Comma-separated (state=ready,stopped). Defaults
    * to every state except terminated and unknown, so stopped and maintenance devices
@@ -926,22 +945,31 @@ export interface DeviceListParams {
   > | null;
 
   /**
-   * Canonical device type. Retired dedicated\_\* aliases are no longer accepted.
-   * Availability depends on the deployment.
+   * Filter by device type.
    */
-  type?:
-    | 'android_cloud_phone'
-    | 'android_physical_phone'
-    | 'ios_stealth_phone'
-    | 'android_emulator'
-    | 'ios_simulator'
-    | 'device_slot';
+  type?: 'android_cloud_phone' | 'ios_phone' | 'device_slot';
 }
 
 export interface DeviceFingerprintParams {
   'X-Device-Display-ID'?: number;
 }
 
+export interface DeviceResetParams {
+  /**
+   * What to erase. full: factory reset — erases the user data (apps, accounts,
+   * storage) and gives the device a new identity. identity: new device fingerprint,
+   * apps and data are kept. When omitted: full, or identity on devices whose
+   * capabilities report factoryReset=false.
+   */
+  mode?: 'full' | 'identity';
+
+  /**
+   * Device configuration to restore after the reset: the latest value set through
+   * the API. Omitted, null or empty preserves nothing.
+   */
+  preserve?: Array<'proxy' | 'location' | 'locale' | 'timezone'> | null;
+}
+
 export interface DeviceSetNameParams {
   name: string;
 }
@@ -985,7 +1013,6 @@ Devices.Language = Language;
 Devices.DeepLink = DeepLink;
 Devices.Browser = Browser;
 Devices.Kiosk = Kiosk;
-Devices.MediaSessions = MediaSessions;
 Devices.Recordings = Recordings;
 Devices.TrafficSessions = TrafficSessions;
 
@@ -1003,6 +1030,7 @@ export declare namespace Devices {
     type DeviceCreateParams as DeviceCreateParams,
     type DeviceListParams as DeviceListParams,
     type DeviceFingerprintParams as DeviceFingerprintParams,
+    type DeviceResetParams as DeviceResetParams,
     type DeviceSetNameParams as DeviceSetNameParams,
     type DeviceSummaryParams as DeviceSummaryParams,
     type DeviceTerminateParams as DeviceTerminateParams,
@@ -1143,16 +1171,6 @@ export declare namespace Devices {
     type KioskEnableParams as KioskEnableParams,
   };
 
-  export {
-    MediaSessions as MediaSessions,
-    type MediaSessionCreateResponse as MediaSessionCreateResponse,
-    type MediaSessionActivateResponse as MediaSessionActivateResponse,
-    type MediaSessionRetrieveCurrentResponse as MediaSessionRetrieveCurrentResponse,
-    type MediaSessionCreateParams as MediaSessionCreateParams,
-    type MediaSessionDeleteParams as MediaSessionDeleteParams,
-    type MediaSessionActivateParams as MediaSessionActivateParams,
-  };
-
   export {
     Recordings as Recordings,
     type RecordingListResponse as RecordingListResponse,

package/src/resources/devices/index.ts

@@ -44,6 +44,7 @@ export {
   type DeviceCreateParams,
   type DeviceListParams,
   type DeviceFingerprintParams,
+  type DeviceResetParams,
   type DeviceSetNameParams,
   type DeviceSummaryParams,
   type DeviceTerminateParams,
@@ -88,15 +89,6 @@ export {
   type LocationResetParams,
   type LocationSetParams,
 } from './location';
-export {
-  MediaSessions,
-  type MediaSessionCreateResponse,
-  type MediaSessionActivateResponse,
-  type MediaSessionRetrieveCurrentResponse,
-  type MediaSessionCreateParams,
-  type MediaSessionDeleteParams,
-  type MediaSessionActivateParams,
-} from './media-sessions';
 export { Packages, type PackageListResponse, type PackageListParams } from './packages';
 export { Profile, type ProfileUpdateParams } from './profile';
 export {

package/src/resources/devices/keyboard.ts

@@ -108,7 +108,7 @@ export interface KeyboardWriteParams {
   completionMode?: 'accepted' | 'committed';
 
   /**
-   * Body param: Per-character mistake rate for humantouch typing. -1 uses server
+   * Body param: Per-character mistake rate for humanized typing. -1 uses server
    * default.
    */
   errorRate?: number;

package/src/resources/devices/language.ts

@@ -31,8 +31,9 @@ export class Language extends APIResource {
 
   /**
    * Sets the device language/locale to the BCP-47 locale in the request body. An
-   * optional restart flag applies the change immediately by restarting the zygote
-   * instead of waiting for the next reboot.
+   * optional restart flag applies the change immediately by restarting the Android
+   * system framework (open apps are closed) instead of waiting for the next reboot;
+   * some devices ignore it.
    */
   set(deviceID: string, params: LanguageSetParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -73,8 +74,9 @@ export interface LanguageSetParams {
   locale: string;
 
   /**
-   * Body param: Restart zygote so the locale change takes full effect immediately.
-   * Without it, the locale is written but won't fully apply until the next reboot.
+   * Body param: Restart the Android system framework so the locale change takes full
+   * effect immediately; open apps are closed. Without it, the change may not fully
+   * apply until the next reboot. Some devices ignore this flag.
    */
   restart?: boolean;
 

package/src/resources/devices/state.ts

@@ -117,6 +117,8 @@ export interface A11YNode {
 
   text: string;
 
+  hint?: string;
+
   isVisibleToUser?: boolean;
 }
 

package/src/resources/index.ts

@@ -35,6 +35,7 @@ export {
   type DeviceCreateParams,
   type DeviceListParams,
   type DeviceFingerprintParams,
+  type DeviceResetParams,
   type DeviceSetNameParams,
   type DeviceSummaryParams,
   type DeviceTerminateParams,

package/src/resources/mailboxes/messages.ts

@@ -22,8 +22,8 @@ export class Messages extends APIResource {
     params: MessageRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<MessageRetrieveResponse> {
-    const { mailboxId } = params;
-    return this._client.get(path`/mailboxes/${mailboxId}/messages/${messageID}`, options);
+    const { mailboxId, ...query } = params;
+    return this._client.get(path`/mailboxes/${mailboxId}/messages/${messageID}`, { query, ...options });
   }
 
   /**
@@ -71,6 +71,13 @@ export namespace MessageRetrieveResponse {
     subject: string | null;
 
     textBody: string | null;
+
+    /**
+     * Raw HTML part as received. Present only with includeHtml=true; null when the
+     * mail has no HTML part or it exceeds 1 MiB (UTF-8 bytes). Untrusted content:
+     * render only in an isolated sandboxed frame, never inline.
+     */
+    htmlBody?: string | null;
   }
 
   export namespace Data {
@@ -109,7 +116,15 @@ export namespace MessageListResponse {
 }
 
 export interface MessageRetrieveParams {
+  /**
+   * Path param
+   */
   mailboxId: string;
+
+  /**
+   * Query param: Return the raw HTML part as htmlBody (untrusted; render isolated).
+   */
+  includeHtml?: 'true' | 'false';
 }
 
 export interface MessageListParams {

package/src/resources/messages/conversations.ts

@@ -55,6 +55,12 @@ export namespace ConversationListResponse {
 
       occurredAt: string;
 
+      /**
+       * Message status. Outbound messages move queued → sending → sent, or end at
+       * failed. `sent` means the mobile network accepted the message and is the final
+       * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+       * current lines return no carrier delivery report, so neither is emitted.
+       */
       status:
         | 'received'
         | 'queued'

package/src/resources/messages/messages.ts

@@ -48,6 +48,8 @@ export namespace MessageRetrieveResponse {
 
     body: string | null;
 
+    classification: Data.Classification | null;
+
     createdAt: string;
 
     deliveryStatus: string | null;
@@ -66,6 +68,12 @@ export namespace MessageRetrieveResponse {
 
     providerCode: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -76,6 +84,12 @@ export namespace MessageRetrieveResponse {
       | 'delivered'
       | 'failed';
   }
+
+  export namespace Data {
+    export interface Classification {
+      spam: boolean;
+    }
+  }
 }
 
 export interface MessageListResponse {
@@ -90,6 +104,8 @@ export namespace MessageListResponse {
 
     body: string | null;
 
+    classification: Item.Classification | null;
+
     createdAt: string;
 
     deliveryStatus: string | null;
@@ -108,6 +124,12 @@ export namespace MessageListResponse {
 
     providerCode: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -118,6 +140,12 @@ export namespace MessageListResponse {
       | 'delivered'
       | 'failed';
   }
+
+  export namespace Item {
+    export interface Classification {
+      spam: boolean;
+    }
+  }
 }
 
 export interface MessageListParams {
@@ -135,6 +163,10 @@ export interface MessageListParams {
 
   peerNumber?: string;
 
+  /**
+   * Filter by message status. `delivered` and `sent_unconfirmed` are kept for
+   * compatibility and are not emitted on current lines.
+   */
   status?:
     | 'all'
     | 'received'

package/src/resources/numbers/messages.ts

@@ -64,6 +64,8 @@ export namespace MessageListResponse {
 
     body: string | null;
 
+    classification: Item.Classification | null;
+
     createdAt: string;
 
     deliveryStatus: string | null;
@@ -80,6 +82,12 @@ export namespace MessageListResponse {
 
     peerNumber: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -90,6 +98,12 @@ export namespace MessageListResponse {
       | 'delivered'
       | 'failed';
   }
+
+  export namespace Item {
+    export interface Classification {
+      spam: boolean;
+    }
+  }
 }
 
 export interface MessageSendResponse {
@@ -102,6 +116,8 @@ export namespace MessageSendResponse {
 
     body: string | null;
 
+    classification: Data.Classification | null;
+
     createdAt: string;
 
     deliveryStatus: string | null;
@@ -118,6 +134,12 @@ export namespace MessageSendResponse {
 
     peerNumber: string | null;
 
+    /**
+     * Message status. Outbound messages move queued → sending → sent, or end at
+     * failed. `sent` means the mobile network accepted the message and is the final
+     * success status. `delivered` and `sent_unconfirmed` are kept for compatibility;
+     * current lines return no carrier delivery report, so neither is emitted.
+     */
     status:
       | 'received'
       | 'queued'
@@ -128,6 +150,12 @@ export namespace MessageSendResponse {
       | 'delivered'
       | 'failed';
   }
+
+  export namespace Data {
+    export interface Classification {
+      spam: boolean;
+    }
+  }
 }
 
 export interface MessageListParams {
@@ -155,7 +183,9 @@ export interface MessageSendParams {
   to: string;
 
   /**
-   * Request a delivery report. Defaults to false.
+   * @deprecated Deprecated: best effort and ignored on most lines. Hosted SIM
+   * numbers return no carrier delivery report, so their messages end at `sent` and
+   * no `sms.send.delivered` event follows. Defaults to false.
    */
   deliveryReport?: boolean;
 }