@mobilerun/sdk 6.0.1 → 6.1.1

package/src/resources/devices/devices.ts

@@ -50,6 +50,22 @@ 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 NumberAPI from './number';
+import {
+  Number,
+  NumberBindParams,
+  NumberBindResponse,
+  NumberRetrieveParams,
+  NumberRetrieveResponse,
+  NumberUnbindParams,
+  NumberUnbindResponse,
+} from './number';
+import * as NumberBindingsAPI from './number-bindings';
+import {
+  NumberBindingListCandidatesResponse,
+  NumberBindingListResponse,
+  NumberBindings,
+} from './number-bindings';
 import * as PackagesAPI from './packages';
 import { PackageListParams, PackageListResponse, Packages } from './packages';
 import * as ProfileAPI from './profile';
@@ -155,6 +171,8 @@ export class Devices extends APIResource {
   kiosk: KioskAPI.Kiosk = new KioskAPI.Kiosk(this._client);
   recordings: RecordingsAPI.Recordings = new RecordingsAPI.Recordings(this._client);
   trafficSessions: TrafficSessionsAPI.TrafficSessions = new TrafficSessionsAPI.TrafficSessions(this._client);
+  number: NumberAPI.Number = new NumberAPI.Number(this._client);
+  numberBindings: NumberBindingsAPI.NumberBindings = new NumberBindingsAPI.NumberBindings(this._client);
 
   /**
    * Requests a new device from the specification in the request body. Optional query
@@ -163,9 +181,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,
     });
@@ -231,7 +249,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`, {
@@ -241,16 +262,13 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Resets the device. The optional body `mode` selects what is erased: `full` is a
-   * factory reset that erases installed apps, accounts and storage and gives the
-   * device a new identity; `identity` gives the device a new fingerprint and keeps
-   * its apps and data. When `mode` is omitted the reset is `full`, or `identity` on
-   * devices whose capabilities report `factoryReset=false`. A mode the device does
-   * not support (see `factoryReset` / `identityReset` in the device capabilities) is
-   * refused with 400 `DEVICE_TOOL_UNSUPPORTED`; legacy devices accept an explicit
-   * mode only when it is the one their capabilities advertise, and always accept a
-   * reset without a mode. 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,
@@ -265,9 +283,9 @@ export class Devices extends APIResource {
   }
 
   /**
-   * 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`, {
@@ -323,9 +341,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,
@@ -550,8 +572,6 @@ export namespace DeviceFingerprintResponse {
 
     hardware?: string;
 
-    imageRepository?: string;
-
     manufacturer?: string;
 
     model?: string;
@@ -607,6 +627,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     proxy: boolean;
 
+    reboot: boolean;
+
     recording: boolean;
 
     reset: boolean;
@@ -619,6 +641,8 @@ export namespace DeviceRetrieveCapabilitiesResponse {
 
     stream: boolean;
 
+    telephony: boolean;
+
     time: boolean;
 
     trafficInspection: boolean;
@@ -761,18 +785,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
    */
@@ -901,8 +934,7 @@ export interface DeviceListParams {
   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';
 
@@ -933,16 +965,9 @@ 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 {
@@ -957,6 +982,12 @@ export interface DeviceResetParams {
    * 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 {
@@ -1004,6 +1035,8 @@ Devices.Browser = Browser;
 Devices.Kiosk = Kiosk;
 Devices.Recordings = Recordings;
 Devices.TrafficSessions = TrafficSessions;
+Devices.Number = Number;
+Devices.NumberBindings = NumberBindings;
 
 export declare namespace Devices {
   export {
@@ -1188,4 +1221,20 @@ export declare namespace Devices {
     type TrafficSessionListParams as TrafficSessionListParams,
     type TrafficSessionDeleteParams as TrafficSessionDeleteParams,
   };
+
+  export {
+    Number as Number,
+    type NumberRetrieveResponse as NumberRetrieveResponse,
+    type NumberBindResponse as NumberBindResponse,
+    type NumberUnbindResponse as NumberUnbindResponse,
+    type NumberRetrieveParams as NumberRetrieveParams,
+    type NumberBindParams as NumberBindParams,
+    type NumberUnbindParams as NumberUnbindParams,
+  };
+
+  export {
+    NumberBindings as NumberBindings,
+    type NumberBindingListResponse as NumberBindingListResponse,
+    type NumberBindingListCandidatesResponse as NumberBindingListCandidatesResponse,
+  };
 }

package/src/resources/devices/index.ts

@@ -89,6 +89,20 @@ export {
   type LocationResetParams,
   type LocationSetParams,
 } from './location';
+export {
+  Number,
+  type NumberRetrieveResponse,
+  type NumberBindResponse,
+  type NumberUnbindResponse,
+  type NumberRetrieveParams,
+  type NumberBindParams,
+  type NumberUnbindParams,
+} from './number';
+export {
+  NumberBindings,
+  type NumberBindingListResponse,
+  type NumberBindingListCandidatesResponse,
+} from './number-bindings';
 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/number-bindings.ts

@@ -0,0 +1,62 @@
+// 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';
+
+export class NumberBindings extends APIResource {
+  list(options?: RequestOptions): APIPromise<NumberBindingListResponse> {
+    return this._client.get('/devices/number-bindings', options);
+  }
+
+  listCandidates(options?: RequestOptions): APIPromise<NumberBindingListCandidatesResponse> {
+    return this._client.get('/devices/number-bindings/candidates', options);
+  }
+}
+
+export interface NumberBindingListResponse {
+  items: Array<NumberBindingListResponse.Item> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberBindingListResponse {
+  export interface Item {
+    boundAt: string;
+
+    deviceId: string;
+
+    deviceName: string;
+
+    numberId: string;
+  }
+}
+
+export interface NumberBindingListCandidatesResponse {
+  items: Array<NumberBindingListCandidatesResponse.Item> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberBindingListCandidatesResponse {
+  export interface Item {
+    id: string;
+
+    name: string;
+
+    state: 'ready';
+  }
+}
+
+export declare namespace NumberBindings {
+  export {
+    type NumberBindingListResponse as NumberBindingListResponse,
+    type NumberBindingListCandidatesResponse as NumberBindingListCandidatesResponse,
+  };
+}

package/src/resources/devices/number.ts

@@ -0,0 +1,261 @@
+// 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 Number extends APIResource {
+  /**
+   * Returns the cloud number bound to the device and the SIM line the device
+   * presents (carrier, number).
+   */
+  retrieve(
+    deviceID: string,
+    params: NumberRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberRetrieveResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/number`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Binds one of your cloud numbers to the device. The device's SIM shows the number
+   * and every SMS it receives is delivered into the device's messages app. Available
+   * on devices whose capabilities report telephony. A number can be bound to one
+   * device, and a device holds one number; unbind first to move it.
+   */
+  bind(deviceID: string, params: NumberBindParams, options?: RequestOptions): APIPromise<NumberBindResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/number`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Releases the number bound to the device. The device returns to its own default
+   * line; SMS to the number stop reaching the device.
+   */
+  unbind(
+    deviceID: string,
+    params: NumberUnbindParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberUnbindResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.delete(path`/devices/${deviceID}/number`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface NumberRetrieveResponse {
+  binding: NumberRetrieveResponse.Binding;
+
+  line: NumberRetrieveResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberRetrieveResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberBindResponse {
+  binding: NumberBindResponse.Binding;
+
+  line: NumberBindResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberBindResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberUnbindResponse {
+  binding: NumberUnbindResponse.Binding;
+
+  line: NumberUnbindResponse.Line;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace NumberUnbindResponse {
+  export interface Binding {
+    boundAt: string;
+
+    numberId: string;
+
+    phoneNumber: string;
+  }
+
+  export interface Line {
+    carrier: Line.Carrier;
+
+    defaultNumber: boolean;
+
+    kind: 'simulated' | 'uicc' | 'esim' | 'unknown';
+
+    lineId: string;
+
+    numberSource: 'backend_default' | 'caller' | 'unknown';
+
+    state: 'pending' | 'active' | 'inactive' | 'failed' | 'unknown';
+
+    iccid?: string;
+
+    phoneNumber?: string;
+  }
+
+  export namespace Line {
+    export interface Carrier {
+      countryIso: string;
+
+      mcc: string;
+
+      mnc: string;
+
+      name: string;
+    }
+  }
+}
+
+export interface NumberRetrieveParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface NumberBindParams {
+  /**
+   * Body param: The cloud number's id.
+   */
+  numberId: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface NumberUnbindParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Number {
+  export {
+    type NumberRetrieveResponse as NumberRetrieveResponse,
+    type NumberBindResponse as NumberBindResponse,
+    type NumberUnbindResponse as NumberUnbindResponse,
+    type NumberRetrieveParams as NumberRetrieveParams,
+    type NumberBindParams as NumberBindParams,
+    type NumberUnbindParams as NumberUnbindParams,
+  };
+}

package/src/resources/devices/state.ts

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