@mobilerun/sdk 3.0.0 → 5.1.0

package/src/resources/devices/devices.ts

@@ -19,9 +19,19 @@ import {
   AppListParams,
   AppListResponse,
   AppStartParams,
-  AppUpdateParams,
+  AppStopParams,
   Apps,
 } from './apps';
+import * as EsimAPI from './esim';
+import {
+  Esim,
+  EsimActivateParams,
+  EsimActivateResponse,
+  EsimEnableParams,
+  EsimListParams,
+  EsimListResponse,
+  EsimRemoveParams,
+} from './esim';
 import * as FilesAPI from './files';
 import {
   FileDeleteParams,
@@ -35,59 +45,68 @@ import {
 } from './files';
 import * as KeyboardAPI from './keyboard';
 import { Keyboard, KeyboardClearParams, KeyboardKeyParams, KeyboardWriteParams } from './keyboard';
+import * as LanguageAPI from './language';
+import { Language, LanguageGetParams, LanguageGetResponse, LanguageSetParams } from './language';
 import * as LocationAPI from './location';
-import { Location, LocationGetParams, LocationGetResponse, LocationSetParams } from './location';
+import { Location, LocationGetParams, LocationSetParams } from './location';
 import * as PackagesAPI from './packages';
 import { PackageListParams, PackageListResponse, Packages } from './packages';
 import * as ProfileAPI from './profile';
 import { Profile, ProfileUpdateParams } from './profile';
 import * as ProxyAPI from './proxy';
-import { Proxy, ProxyConnectParams, ProxyDisconnectParams } from './proxy';
+import {
+  Proxy as ProxyAPIProxy,
+  ProxyConnectParams,
+  ProxyDisconnectParams,
+  ProxyStatusParams,
+  ProxyStatusResponse,
+} from './proxy';
 import * as StateAPI from './state';
 import {
+  A11YNode,
   Rect,
   State,
   StateScreenshotParams,
   StateScreenshotResponse,
+  StateTimeParams,
+  StateTimeResponse,
   StateUiParams,
   StateUiResponse,
 } from './state';
 import * as TasksAPI from './tasks';
 import { TaskListParams, TaskListResponse, Tasks } from './tasks';
-import * as TimeAPI from './time';
-import {
-  Time,
-  TimeSetTimeParams,
-  TimeSetTimezoneParams,
-  TimeTimeParams,
-  TimeTimeResponse,
-  TimeTimezoneParams,
-  TimeTimezoneResponse,
-} from './time';
+import * as TimezoneAPI from './timezone';
+import { Timezone, TimezoneGetParams, TimezoneGetResponse, TimezoneSetParams } from './timezone';
 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 Devices extends APIResource {
-  time: TimeAPI.Time = new TimeAPI.Time(this._client);
-  profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
-  files: FilesAPI.Files = new FilesAPI.Files(this._client);
-  proxy: ProxyAPI.Proxy = new ProxyAPI.Proxy(this._client);
-  location: LocationAPI.Location = new LocationAPI.Location(this._client);
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
-  state: StateAPI.State = new StateAPI.State(this._client);
   apps: AppsAPI.Apps = new AppsAPI.Apps(this._client);
-  packages: PackagesAPI.Packages = new PackagesAPI.Packages(this._client);
+  esim: EsimAPI.Esim = new EsimAPI.Esim(this._client);
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
   keyboard: KeyboardAPI.Keyboard = new KeyboardAPI.Keyboard(this._client);
+  location: LocationAPI.Location = new LocationAPI.Location(this._client);
+  packages: PackagesAPI.Packages = new PackagesAPI.Packages(this._client);
+  profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
+  proxy: ProxyAPI.Proxy = new ProxyAPI.Proxy(this._client);
+  state: StateAPI.State = new StateAPI.State(this._client);
   tasks: TasksAPI.Tasks = new TasksAPI.Tasks(this._client);
+  timezone: TimezoneAPI.Timezone = new TimezoneAPI.Timezone(this._client);
+  language: LanguageAPI.Language = new LanguageAPI.Language(this._client);
 
   /**
    * Provision a new device
    */
   create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<Device> {
-    const { deviceType, ...body } = params;
-    return this._client.post('/devices', { query: { deviceType }, body, ...options });
+    const { query_country, deviceType, profileId, ...body } = params;
+    return this._client.post('/devices', {
+      query: { country: query_country, deviceType, profileId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -114,6 +133,55 @@ export class Devices extends APIResource {
     return this._client.get('/devices/count', options);
   }
 
+  /**
+   * Device fingerprint snapshot
+   */
+  fingerprint(
+    deviceID: string,
+    params: DeviceFingerprintParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviceFingerprintResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/fingerprint`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Reboot a device
+   */
+  reboot(deviceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/devices/${deviceID}/reboot`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Reset a device to a fresh state
+   */
+  reset(deviceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/devices/${deviceID}/reset`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Update device name
+   */
+  setName(deviceID: string, body: DeviceSetNameParams, options?: RequestOptions): APIPromise<Device> {
+    return this._client.put(path`/devices/${deviceID}/name`, { body, ...options });
+  }
+
   /**
    * Terminate a device
    */
@@ -136,6 +204,8 @@ export class Devices extends APIResource {
 export interface Device {
   id: string;
 
+  activeTaskId: string;
+
   assignedAt: string | null;
 
   createdAt: string;
@@ -161,6 +231,8 @@ export interface Device {
    */
   $schema?: string;
 
+  providerId?: string;
+
   streamToken?: string;
 
   userId?: string;
@@ -179,11 +251,68 @@ export interface DeviceListResponse {
 
 export type DeviceCountResponse = { [key: string]: number };
 
+export interface DeviceFingerprintResponse {
+  carrier: Shared.DeviceCarrier;
+
+  display: DeviceFingerprintResponse.Display;
+
+  identifiers: Shared.DeviceIdentifiers;
+
+  model: DeviceFingerprintResponse.Model;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace DeviceFingerprintResponse {
+  export interface Display {
+    densityDpi?: number;
+
+    height?: number;
+
+    width?: number;
+  }
+
+  export interface Model {
+    aospVersion?: string;
+
+    brand?: string;
+
+    device?: string;
+
+    hardware?: string;
+
+    imageRepository?: string;
+
+    manufacturer?: string;
+
+    model?: string;
+  }
+}
+
 export interface DeviceCreateParams {
+  /**
+   * Query param: ISO 3166-1 alpha-2 country code. If omitted the system picks the
+   * country with the most availability.
+   */
+  query_country?: string;
+
   /**
    * Query param
    */
-  deviceType?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_emulated_device';
+  deviceType?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device';
+
+  /**
+   * Query param: Profile ID to use as device spec
+   */
+  profileId?: string;
+
+  /**
+   * Body param
+   */
+  androidVersion?: number;
 
   /**
    * Body param
@@ -195,6 +324,11 @@ export interface DeviceCreateParams {
    */
   carrier?: Shared.DeviceCarrier;
 
+  /**
+   * Body param
+   */
+  body_country?: string;
+
   /**
    * Body param
    */
@@ -205,6 +339,16 @@ export interface DeviceCreateParams {
    */
   identifiers?: Shared.DeviceIdentifiers;
 
+  /**
+   * Body param
+   */
+  locale?: string;
+
+  /**
+   * Body param
+   */
+  location?: Shared.Location;
+
   /**
    * Body param
    */
@@ -213,12 +357,22 @@ export interface DeviceCreateParams {
   /**
    * Body param
    */
-  proxy?: Shared.Config;
+  proxy?: DeviceCreateParams.Proxy;
 
   /**
    * Body param
    */
-  smartIp?: boolean;
+  timezone?: string;
+}
+
+export namespace DeviceCreateParams {
+  export interface Proxy {
+    name?: string;
+
+    smartIp?: boolean;
+
+    socks5?: Shared.Socks5;
+  }
 }
 
 export interface DeviceListParams {
@@ -234,9 +388,29 @@ export interface DeviceListParams {
 
   pageSize?: number;
 
-  state?: Array<'creating' | 'assigned' | 'ready' | 'disconnected' | 'terminated' | 'unknown'> | null;
+  providerId?: string;
+
+  state?: Array<
+    | 'creating'
+    | 'assigned'
+    | 'ready'
+    | 'rebooting'
+    | 'migrating'
+    | 'resetting'
+    | 'terminated'
+    | 'maintenance'
+    | 'unknown'
+  > | null;
+
+  type?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_ios_device';
+}
 
-  type?: 'dedicated_physical_device' | 'dedicated_premium_device' | 'dedicated_emulated_device';
+export interface DeviceFingerprintParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface DeviceSetNameParams {
+  name: string;
 }
 
 export interface DeviceTerminateParams {
@@ -245,39 +419,62 @@ export interface DeviceTerminateParams {
   terminateAt?: string;
 }
 
-Devices.Time = Time;
-Devices.Profile = Profile;
-Devices.Files = Files;
-Devices.Proxy = Proxy;
-Devices.Location = Location;
 Devices.Actions = Actions;
-Devices.State = State;
 Devices.Apps = Apps;
-Devices.Packages = Packages;
+Devices.Esim = Esim;
+Devices.Files = Files;
 Devices.Keyboard = Keyboard;
+Devices.Location = Location;
+Devices.Packages = Packages;
+Devices.Profile = Profile;
+Devices.Proxy = ProxyAPIProxy;
+Devices.State = State;
 Devices.Tasks = Tasks;
+Devices.Timezone = Timezone;
+Devices.Language = Language;
 
 export declare namespace Devices {
   export {
     type Device as Device,
     type DeviceListResponse as DeviceListResponse,
     type DeviceCountResponse as DeviceCountResponse,
+    type DeviceFingerprintResponse as DeviceFingerprintResponse,
     type DeviceCreateParams as DeviceCreateParams,
     type DeviceListParams as DeviceListParams,
+    type DeviceFingerprintParams as DeviceFingerprintParams,
+    type DeviceSetNameParams as DeviceSetNameParams,
     type DeviceTerminateParams as DeviceTerminateParams,
   };
 
   export {
-    Time as Time,
-    type TimeTimeResponse as TimeTimeResponse,
-    type TimeTimezoneResponse as TimeTimezoneResponse,
-    type TimeSetTimeParams as TimeSetTimeParams,
-    type TimeSetTimezoneParams as TimeSetTimezoneParams,
-    type TimeTimeParams as TimeTimeParams,
-    type TimeTimezoneParams as TimeTimezoneParams,
+    Actions as Actions,
+    type ActionOverlayVisibleResponse as ActionOverlayVisibleResponse,
+    type ActionGlobalParams as ActionGlobalParams,
+    type ActionOverlayVisibleParams as ActionOverlayVisibleParams,
+    type ActionSetOverlayVisibleParams as ActionSetOverlayVisibleParams,
+    type ActionSwipeParams as ActionSwipeParams,
+    type ActionTapParams as ActionTapParams,
   };
 
-  export { Profile as Profile, type ProfileUpdateParams as ProfileUpdateParams };
+  export {
+    Apps as Apps,
+    type AppListResponse as AppListResponse,
+    type AppListParams as AppListParams,
+    type AppDeleteParams as AppDeleteParams,
+    type AppInstallParams as AppInstallParams,
+    type AppStartParams as AppStartParams,
+    type AppStopParams as AppStopParams,
+  };
+
+  export {
+    Esim as Esim,
+    type EsimListResponse as EsimListResponse,
+    type EsimActivateResponse as EsimActivateResponse,
+    type EsimListParams as EsimListParams,
+    type EsimActivateParams as EsimActivateParams,
+    type EsimEnableParams as EsimEnableParams,
+    type EsimRemoveParams as EsimRemoveParams,
+  };
 
   export {
     Files as Files,
@@ -291,59 +488,59 @@ export declare namespace Devices {
   };
 
   export {
-    Proxy as Proxy,
-    type ProxyConnectParams as ProxyConnectParams,
-    type ProxyDisconnectParams as ProxyDisconnectParams,
+    Keyboard as Keyboard,
+    type KeyboardClearParams as KeyboardClearParams,
+    type KeyboardKeyParams as KeyboardKeyParams,
+    type KeyboardWriteParams as KeyboardWriteParams,
   };
 
   export {
     Location as Location,
-    type LocationGetResponse as LocationGetResponse,
     type LocationGetParams as LocationGetParams,
     type LocationSetParams as LocationSetParams,
   };
 
   export {
-    Actions as Actions,
-    type ActionOverlayVisibleResponse as ActionOverlayVisibleResponse,
-    type ActionGlobalParams as ActionGlobalParams,
-    type ActionOverlayVisibleParams as ActionOverlayVisibleParams,
-    type ActionSetOverlayVisibleParams as ActionSetOverlayVisibleParams,
-    type ActionSwipeParams as ActionSwipeParams,
-    type ActionTapParams as ActionTapParams,
+    Packages as Packages,
+    type PackageListResponse as PackageListResponse,
+    type PackageListParams as PackageListParams,
+  };
+
+  export { Profile as Profile, type ProfileUpdateParams as ProfileUpdateParams };
+
+  export {
+    ProxyAPIProxy as Proxy,
+    type ProxyStatusResponse as ProxyStatusResponse,
+    type ProxyConnectParams as ProxyConnectParams,
+    type ProxyDisconnectParams as ProxyDisconnectParams,
+    type ProxyStatusParams as ProxyStatusParams,
   };
 
   export {
     State as State,
+    type A11YNode as A11YNode,
     type Rect as Rect,
     type StateScreenshotResponse as StateScreenshotResponse,
+    type StateTimeResponse as StateTimeResponse,
     type StateUiResponse as StateUiResponse,
     type StateScreenshotParams as StateScreenshotParams,
+    type StateTimeParams as StateTimeParams,
     type StateUiParams as StateUiParams,
   };
 
-  export {
-    Apps as Apps,
-    type AppListResponse as AppListResponse,
-    type AppUpdateParams as AppUpdateParams,
-    type AppListParams as AppListParams,
-    type AppDeleteParams as AppDeleteParams,
-    type AppInstallParams as AppInstallParams,
-    type AppStartParams as AppStartParams,
-  };
+  export { Tasks as Tasks, type TaskListResponse as TaskListResponse, type TaskListParams as TaskListParams };
 
   export {
-    Packages as Packages,
-    type PackageListResponse as PackageListResponse,
-    type PackageListParams as PackageListParams,
+    Timezone as Timezone,
+    type TimezoneGetResponse as TimezoneGetResponse,
+    type TimezoneGetParams as TimezoneGetParams,
+    type TimezoneSetParams as TimezoneSetParams,
   };
 
   export {
-    Keyboard as Keyboard,
-    type KeyboardClearParams as KeyboardClearParams,
-    type KeyboardKeyParams as KeyboardKeyParams,
-    type KeyboardWriteParams as KeyboardWriteParams,
+    Language as Language,
+    type LanguageGetResponse as LanguageGetResponse,
+    type LanguageGetParams as LanguageGetParams,
+    type LanguageSetParams as LanguageSetParams,
   };
-
-  export { Tasks as Tasks, type TaskListResponse as TaskListResponse, type TaskListParams as TaskListParams };
 }

package/src/resources/devices/esim.ts

@@ -0,0 +1,208 @@
+// 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 Esim extends APIResource {
+  /**
+   * List eSIM subscriptions
+   */
+  list(
+    deviceID: string,
+    params: EsimListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EsimListResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/esim`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Configure eSIM (download profile and/or enable subscription)
+   */
+  activate(
+    deviceID: string,
+    params: EsimActivateParams,
+    options?: RequestOptions,
+  ): APIPromise<EsimActivateResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/esim`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Enable an eSIM subscription
+   */
+  enable(deviceID: string, params: EsimEnableParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/esim`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Delete eSIM subscription
+   */
+  remove(deviceID: string, params: EsimRemoveParams, options?: RequestOptions): APIPromise<void> {
+    const { subId, 'X-Device-Display-ID': xDeviceDisplayID } = params;
+    return this._client.delete(path`/devices/${deviceID}/esim`, {
+      query: { subId },
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type EsimListResponse = Array<EsimListResponse.EsimListResponseItem>;
+
+export namespace EsimListResponse {
+  export interface EsimListResponseItem {
+    carrier: string;
+
+    displayName: string;
+
+    iccid: string;
+
+    isEmbedded: boolean;
+
+    slot: number;
+
+    subId: number;
+
+    type: string;
+
+    /**
+     * A URL to the JSON Schema for this object.
+     */
+    $schema?: string;
+  }
+}
+
+export interface EsimActivateResponse {
+  carrier: string;
+
+  displayName: string;
+
+  iccid: string;
+
+  isEmbedded: boolean;
+
+  slot: number;
+
+  subId: number;
+
+  type: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export interface EsimListParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimActivateParams {
+  /**
+   * Body param
+   */
+  enable: boolean;
+
+  /**
+   * Body param
+   */
+  smDpAddr: string;
+
+  /**
+   * Body param: Optional carrier-issued confirmation code (the 4th LPA segment).
+   * Required only for plans whose SM-DP+ challenges the device for one. Requires
+   * matchingId — the LPA spec only interprets segment 4 when segment 3 is present.
+   */
+  confirmationCode?: string;
+
+  /**
+   * Body param
+   */
+  matchingId?: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimEnableParams {
+  /**
+   * Body param
+   */
+  subId: number;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface EsimRemoveParams {
+  /**
+   * Query param
+   */
+  subId: number;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Esim {
+  export {
+    type EsimListResponse as EsimListResponse,
+    type EsimActivateResponse as EsimActivateResponse,
+    type EsimListParams as EsimListParams,
+    type EsimActivateParams as EsimActivateParams,
+    type EsimEnableParams as EsimEnableParams,
+    type EsimRemoveParams as EsimRemoveParams,
+  };
+}