@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/devices/files.ts

@@ -11,7 +11,8 @@ import { path } from '../../internal/utils/path';
 
 export class Files extends APIResource {
   /**
-   * List files
+   * Lists the files at the directory path given in the path query parameter,
+   * returning each entry's metadata along with the path and total count.
    */
   list(deviceID: string, params: FileListParams, options?: RequestOptions): APIPromise<FileListResponse> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params;
@@ -30,7 +31,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Delete file
+   * Deletes the file at the path given in the path query parameter from the device.
    */
   delete(deviceID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { path: path_, 'X-Device-Display-ID': xDeviceDisplayID } = params;
@@ -50,7 +51,8 @@ export class Files extends APIResource {
   }
 
   /**
-   * Download file
+   * Pulls the file at the given path query parameter from the device and returns its
+   * raw bytes as an octet-stream.
    */
   download(deviceID: string, params: FileDownloadParams, options?: RequestOptions): APIPromise<string> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params;
@@ -69,7 +71,8 @@ export class Files extends APIResource {
   }
 
   /**
-   * Upload file
+   * Uploads a file to the device via multipart form data, writing it into the
+   * directory given by the path query parameter using the uploaded file's name.
    */
   upload(deviceID: string, params: FileUploadParams, options?: RequestOptions): APIPromise<void> {
     const { path: path_, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;

package/src/resources/devices/index.ts

@@ -12,19 +12,21 @@ export {
 export {
   Apps,
   type AppListResponse,
-  type AppUpdateParams,
   type AppListParams,
   type AppDeleteParams,
   type AppInstallParams,
   type AppStartParams,
+  type AppStopParams,
 } from './apps';
 export {
   Devices,
   type Device,
   type DeviceListResponse,
   type DeviceCountResponse,
+  type DeviceFingerprintResponse,
   type DeviceCreateParams,
   type DeviceListParams,
+  type DeviceFingerprintParams,
   type DeviceSetNameParams,
   type DeviceTerminateParams,
 } from './devices';
@@ -54,11 +56,12 @@ export {
   type KeyboardWriteParams,
 } from './keyboard';
 export {
-  Location,
-  type LocationGetResponse,
-  type LocationGetParams,
-  type LocationSetParams,
-} from './location';
+  Language,
+  type LanguageGetResponse,
+  type LanguageGetParams,
+  type LanguageSetParams,
+} from './language';
+export { Location, type LocationGetParams, type LocationSetParams } from './location';
 export { Packages, type PackageListResponse, type PackageListParams } from './packages';
 export { Profile, type ProfileUpdateParams } from './profile';
 export {
@@ -70,18 +73,19 @@ export {
 } from './proxy';
 export {
   State,
+  type A11YNode,
   type Rect,
   type StateScreenshotResponse,
+  type StateTimeResponse,
   type StateUiResponse,
   type StateScreenshotParams,
+  type StateTimeParams,
   type StateUiParams,
 } from './state';
 export { Tasks, type TaskListResponse, type TaskListParams } from './tasks';
 export {
-  Time,
-  type TimeTimeResponse,
-  type TimeTimezoneResponse,
-  type TimeSetTimezoneParams,
-  type TimeTimeParams,
-  type TimeTimezoneParams,
-} from './time';
+  Timezone,
+  type TimezoneGetResponse,
+  type TimezoneGetParams,
+  type TimezoneSetParams,
+} from './timezone';

package/src/resources/devices/keyboard.ts

@@ -8,7 +8,7 @@ import { path } from '../../internal/utils/path';
 
 export class Keyboard extends APIResource {
   /**
-   * Clear input
+   * Clears the contents of the currently focused text input field.
    */
   clear(
     deviceID: string,
@@ -31,7 +31,7 @@ export class Keyboard extends APIResource {
   }
 
   /**
-   * Input key
+   * Sends a single Android key event to the device, identified by its key code.
    */
   key(deviceID: string, params: KeyboardKeyParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -51,7 +51,9 @@ export class Keyboard extends APIResource {
   }
 
   /**
-   * Input text
+   * 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.
    */
   write(deviceID: string, params: KeyboardWriteParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -98,6 +100,12 @@ export interface KeyboardWriteParams {
    */
   clear?: boolean;
 
+  /**
+   * Body param: Per-character mistake rate for humantouch typing. -1 uses server
+   * default.
+   */
+  errorRate?: number;
+
   /**
    * Body param
    */

package/src/resources/devices/language.ts

@@ -0,0 +1,93 @@
+// 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 Language extends APIResource {
+  /**
+   * Returns the device's current language/locale as a BCP-47 locale string.
+   */
+  get(
+    deviceID: string,
+    params: LanguageGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LanguageGetResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/language`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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.
+   */
+  set(deviceID: string, params: LanguageSetParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/language`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface LanguageGetResponse {
+  locale: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export interface LanguageGetParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface LanguageSetParams {
+  /**
+   * Body param: BCP-47 locale: a 2–3 letter language tag, optionally followed by a
+   * 4-letter script and/or a 2-letter region (e.g. en-US, de-DE, ja-JP, zh-Hans-CN).
+   */
+  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.
+   */
+  restart?: boolean;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Language {
+  export {
+    type LanguageGetResponse as LanguageGetResponse,
+    type LanguageGetParams as LanguageGetParams,
+    type LanguageSetParams as LanguageSetParams,
+  };
+}

package/src/resources/devices/location.ts

@@ -1,6 +1,7 @@
 // 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 { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -8,13 +9,14 @@ import { path } from '../../internal/utils/path';
 
 export class Location extends APIResource {
   /**
-   * Get device location
+   * Returns the device's current simulated GPS location as latitude and longitude.
+   * Devices without geo support return an unsupported-feature error.
    */
   get(
     deviceID: string,
     params: LocationGetParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LocationGetResponse> {
+  ): APIPromise<Shared.Location> {
     const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
     return this._client.get(path`/devices/${deviceID}/location`, {
       ...options,
@@ -30,7 +32,8 @@ export class Location extends APIResource {
   }
 
   /**
-   * Set device location
+   * Sets the device's simulated GPS location to the latitude and longitude in the
+   * request body. Devices without geo support return an unsupported-feature error.
    */
   set(deviceID: string, params: LocationSetParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -50,17 +53,6 @@ export class Location extends APIResource {
   }
 }
 
-export interface LocationGetResponse {
-  latitude: number;
-
-  longitude: number;
-
-  /**
-   * A URL to the JSON Schema for this object.
-   */
-  $schema?: string;
-}
-
 export interface LocationGetParams {
   'X-Device-Display-ID'?: number;
 }
@@ -83,9 +75,5 @@ export interface LocationSetParams {
 }
 
 export declare namespace Location {
-  export {
-    type LocationGetResponse as LocationGetResponse,
-    type LocationGetParams as LocationGetParams,
-    type LocationSetParams as LocationSetParams,
-  };
+  export { type LocationGetParams as LocationGetParams, type LocationSetParams as LocationSetParams };
 }

package/src/resources/devices/packages.ts

@@ -8,7 +8,8 @@ import { path } from '../../internal/utils/path';
 
 export class Packages extends APIResource {
   /**
-   * List packages
+   * Returns the package names of apps installed on the device. System and protected
+   * packages are excluded unless the corresponding query parameters are set.
    */
   list(
     deviceID: string,

package/src/resources/devices/proxy.ts

@@ -8,7 +8,9 @@ import { path } from '../../internal/utils/path';
 
 export class Proxy extends APIResource {
   /**
-   * Connect proxy
+   * Routes the device's traffic through a SOCKS5 proxy supplied in the request body,
+   * replacing any existing connection. A smartIp option can be used to select an IP
+   * automatically; the legacy flat host/port/user/password fields remain supported.
    */
   connect(deviceID: string, params: ProxyConnectParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -28,7 +30,8 @@ export class Proxy extends APIResource {
   }
 
   /**
-   * Disconnect proxy
+   * Disconnects the device's active proxy connection and clears its stored proxy
+   * state. Returns successfully if no proxy is connected.
    */
   disconnect(
     deviceID: string,
@@ -51,7 +54,8 @@ export class Proxy extends APIResource {
   }
 
   /**
-   * Get proxy connection state
+   * Returns the device's current proxy connection state, including whether a proxy
+   * is connected and its protocol and name.
    */
   status(
     deviceID: string,
@@ -82,7 +86,7 @@ export interface ProxyStatusResponse {
   name: string | null;
 
   /**
-   * Active proxy protocol (socks5 or wireguard).
+   * Active proxy protocol (socks5).
    */
   protocol: string | null;
 
@@ -93,13 +97,20 @@ export interface ProxyStatusResponse {
 }
 
 export interface ProxyConnectParams {
+  /**
+   * Body param: Mobilerun Connect proxy — pass exactly one of id (use an existing
+   * proxy's credentials) or country (provision or reuse a rotating residential proxy
+   * for the device).
+   */
+  connect?: ProxyConnectParams.Connect;
+
   /**
    * @deprecated Body param
    */
   host?: string;
 
   /**
-   * Body param: Proxy name (used for wireguard tunnel name)
+   * Body param: Proxy name
    */
   name?: string;
 
@@ -128,12 +139,6 @@ export interface ProxyConnectParams {
    */
   user?: string;
 
-  /**
-   * Body param: WireGuard tunnel configuration file content (required for
-   * wireguard).
-   */
-  wireguard?: string;
-
   /**
    * Header param
    */
@@ -141,6 +146,24 @@ export interface ProxyConnectParams {
 }
 
 export namespace ProxyConnectParams {
+  /**
+   * Mobilerun Connect proxy — pass exactly one of id (use an existing proxy's
+   * credentials) or country (provision or reuse a rotating residential proxy for the
+   * device).
+   */
+  export interface Connect {
+    /**
+     * Existing Mobilerun Connect proxy id; its credentials are fetched server-side.
+     */
+    id?: string;
+
+    /**
+     * ISO 3166-1 alpha-2 country code; provisions (or reuses) a rotating residential
+     * Mobilerun Connect proxy for the device.
+     */
+    country?: string;
+  }
+
   /**
    * SOCKS5 proxy configuration (required for socks5).
    */

package/src/resources/devices/state.ts

@@ -9,7 +9,8 @@ import { path } from '../../internal/utils/path';
 
 export class State extends APIResource {
   /**
-   * Take screenshot
+   * Captures the device screen and returns it as a PNG image. An optional
+   * hideOverlay query parameter excludes the accessibility overlay from the capture.
    */
   screenshot(
     deviceID: string,
@@ -32,7 +33,31 @@ export class State extends APIResource {
   }
 
   /**
-   * UI state
+   * Returns the device's current wall-clock time as an RFC 3339 timestamp.
+   */
+  time(
+    deviceID: string,
+    params: StateTimeParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/time`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Returns the current accessibility UI state of the device as a structured tree of
+   * on-screen elements. An optional filter query reduces the result to interactive
+   * elements.
    */
   ui(
     deviceID: string,
@@ -55,6 +80,56 @@ export class State extends APIResource {
   }
 }
 
+export interface A11YNode {
+  boundsInScreen: A11YNode.BoundsInScreen;
+
+  children: Array<A11YNode> | null;
+
+  className: string;
+
+  contentDescription: string;
+
+  isCheckable: boolean;
+
+  isChecked: boolean;
+
+  isClickable: boolean;
+
+  isEnabled: boolean;
+
+  isFocusable: boolean;
+
+  isFocused: boolean;
+
+  isLongClickable: boolean;
+
+  isPassword: boolean;
+
+  isScrollable: boolean;
+
+  isSelected: boolean;
+
+  packageName: string;
+
+  resourceId: string;
+
+  text: string;
+
+  isVisibleToUser?: boolean;
+}
+
+export namespace A11YNode {
+  export interface BoundsInScreen {
+    bottom: number;
+
+    left: number;
+
+    right: number;
+
+    top: number;
+  }
+}
+
 export interface Rect {
   height: number;
 
@@ -63,11 +138,15 @@ export interface Rect {
 
 export type StateScreenshotResponse = string;
 
+export type StateTimeResponse = string;
+
 export interface StateUiResponse {
-  a11y_tree: unknown;
+  a11y_tree: A11YNode;
 
   device_context: StateUiResponse.DeviceContext;
 
+  ime_tree: A11YNode;
+
   phone_state: StateUiResponse.PhoneState;
 
   /**
@@ -83,8 +162,6 @@ export namespace StateUiResponse {
     filtering_params: DeviceContext.FilteringParams;
 
     screen_bounds: StateAPI.Rect;
-
-    screenSize: StateAPI.Rect;
   }
 
   export namespace DeviceContext {
@@ -144,6 +221,10 @@ export interface StateScreenshotParams {
   'X-Device-Display-ID'?: number;
 }
 
+export interface StateTimeParams {
+  'X-Device-Display-ID'?: number;
+}
+
 export interface StateUiParams {
   /**
    * Query param
@@ -158,10 +239,13 @@ export interface StateUiParams {
 
 export declare namespace State {
   export {
+    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,
   };
 }

package/src/resources/devices/tasks.ts

@@ -2,13 +2,15 @@
 
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import * as ResourcesTasksAPI from '../tasks/tasks';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Tasks extends APIResource {
   /**
-   * List tasks for a device
+   * Returns a paginated list of tasks that have run on the device, along with
+   * pagination metadata.
    */
   list(
     deviceID: string,
@@ -20,7 +22,7 @@ export class Tasks extends APIResource {
 }
 
 export interface TaskListResponse {
-  items: Array<TaskListResponse.Item> | null;
+  items: Array<ResourcesTasksAPI.Task> | null;
 
   pagination: Shared.Meta;
 
@@ -30,16 +32,6 @@ export interface TaskListResponse {
   $schema?: string;
 }
 
-export namespace TaskListResponse {
-  export interface Item {
-    createdAt: string;
-
-    taskId: string;
-
-    updatedAt: string;
-  }
-}
-
 export interface TaskListParams {
   orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt';