@mobilerun/sdk 5.1.0 → 5.2.1

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;
@@ -96,61 +99,63 @@ export class Files extends APIResource {
   }
 }
 
-export interface FileInfo {
-  extendedAttributes: boolean;
+export interface FileListResponse {
+  files: Array<FileListResponse.File> | null;
 
-  group: string;
+  path: string;
 
-  hardLinks: number;
+  total: number;
 
-  modifiedAt: string;
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
 
-  name: string;
+export namespace FileListResponse {
+  export interface File {
+    extendedAttributes: boolean;
 
-  owner: string;
+    group: string;
 
-  permissions: FileInfo.Permissions;
+    hardLinks: number;
 
-  size: number;
+    modifiedAt: string;
 
-  type: string;
+    name: string;
 
-  symlinkTarget?: string;
-}
+    owner: string;
 
-export namespace FileInfo {
-  export interface Permissions {
-    group: Shared.PermissionSet;
+    permissions: File.Permissions;
 
-    others: Shared.PermissionSet;
+    size: number;
 
-    owner: Shared.PermissionSet;
+    type: string;
 
-    special: Permissions.Special;
+    symlinkTarget?: string;
   }
 
-  export namespace Permissions {
-    export interface Special {
-      setGid: boolean;
+  export namespace File {
+    export interface Permissions {
+      group: Shared.PermissionSet;
 
-      setUid: boolean;
+      others: Shared.PermissionSet;
 
-      sticky: boolean;
-    }
-  }
-}
+      owner: Shared.PermissionSet;
 
-export interface FileListResponse {
-  files: Array<FileInfo> | null;
+      special: Permissions.Special;
+    }
 
-  path: string;
+    export namespace Permissions {
+      export interface Special {
+        setGid: boolean;
 
-  total: number;
+        setUid: boolean;
 
-  /**
-   * A URL to the JSON Schema for this object.
-   */
-  $schema?: string;
+        sticky: boolean;
+      }
+    }
+  }
 }
 
 export type FileDownloadResponse = string;
@@ -210,7 +215,6 @@ export interface FileUploadParams {
 
 export declare namespace Files {
   export {
-    type FileInfo as FileInfo,
     type FileListResponse as FileListResponse,
     type FileDownloadResponse as FileDownloadResponse,
     type FileListParams as FileListParams,

package/src/resources/devices/index.ts

@@ -12,18 +12,28 @@ export {
 export {
   Apps,
   type AppListResponse,
+  type AppListInstallsResponse,
   type AppListParams,
   type AppDeleteParams,
+  type AppGrantPermissionParams,
   type AppInstallParams,
+  type AppListInstallsParams,
+  type AppRevokePermissionParams,
   type AppStartParams,
   type AppStopParams,
 } from './apps';
+export { Browser, type BrowserExecuteScriptResponse, type BrowserExecuteScriptParams } from './browser';
+export { DeepLink, type DeepLinkExecuteDeepLinkParams } from './deep-link';
 export {
   Devices,
-  type Device,
+  type DeviceCreateResponse,
+  type DeviceRetrieveResponse,
   type DeviceListResponse,
   type DeviceCountResponse,
   type DeviceFingerprintResponse,
+  type DeviceRetrieveCapabilitiesResponse,
+  type DeviceSetNameResponse,
+  type DeviceWaitReadyResponse,
   type DeviceCreateParams,
   type DeviceListParams,
   type DeviceFingerprintParams,
@@ -34,14 +44,16 @@ export {
   Esim,
   type EsimListResponse,
   type EsimActivateResponse,
+  type EsimStatusResponse,
   type EsimListParams,
   type EsimActivateParams,
   type EsimEnableParams,
   type EsimRemoveParams,
-} from './esim';
+  type EsimSetRoamingParams,
+  type EsimStatusParams,
+} from './esim/index';
 export {
   Files,
-  type FileInfo,
   type FileListResponse,
   type FileDownloadResponse,
   type FileListParams,
@@ -55,13 +67,28 @@ export {
   type KeyboardKeyParams,
   type KeyboardWriteParams,
 } from './keyboard';
+export { Kiosk, type KioskDisableParams, type KioskEnableParams } from './kiosk';
 export {
   Language,
   type LanguageGetResponse,
   type LanguageGetParams,
   type LanguageSetParams,
 } from './language';
-export { Location, type LocationGetParams, type LocationSetParams } from './location';
+export {
+  Location,
+  type LocationGetParams,
+  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 {
@@ -71,10 +98,23 @@ export {
   type ProxyDisconnectParams,
   type ProxyStatusParams,
 } from './proxy';
+export {
+  Recordings,
+  type RecordingListResponse,
+  type RecordingStartResponse,
+  type RecordingStatusResponse,
+  type RecordingStopResponse,
+  type RecordingListParams,
+  type RecordingDeleteParams,
+  type RecordingStartParams,
+  type RecordingStatusParams,
+  type RecordingStopParams,
+  type RecordingTrajectoryParams,
+  type RecordingVideoParams,
+} from './recordings';
 export {
   State,
   type A11YNode,
-  type Rect,
   type StateScreenshotResponse,
   type StateTimeResponse,
   type StateUiResponse,

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;

package/src/resources/devices/kiosk.ts

@@ -0,0 +1,74 @@
+// 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 Kiosk extends APIResource {
+  /**
+   * Disables Android lock-task (kiosk) mode on the device, releasing it from the
+   * locked app.
+   */
+  disable(
+    deviceID: string,
+    params: KioskDisableParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.delete(path`/devices/${deviceID}/kiosk`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Locks the device to the package named in the request body using Android
+   * lock-task (kiosk) mode, preventing the user from leaving the app.
+   */
+  enable(deviceID: string, params: KioskEnableParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/kiosk`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface KioskDisableParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface KioskEnableParams {
+  /**
+   * Body param: Package to lock the device to (Android lock-task mode).
+   */
+  packageName: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Kiosk {
+  export { type KioskDisableParams as KioskDisableParams, type KioskEnableParams as KioskEnableParams };
+}

package/src/resources/devices/language.ts

@@ -8,7 +8,7 @@ import { path } from '../../internal/utils/path';
 
 export class Language extends APIResource {
   /**
-   * Get device language/locale
+   * Returns the device's current language/locale as a BCP-47 locale string.
    */
   get(
     deviceID: string,
@@ -30,7 +30,9 @@ export class Language extends APIResource {
   }
 
   /**
-   * Set device language/locale
+   * 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;

package/src/resources/devices/location.ts

@@ -9,7 +9,8 @@ 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,
@@ -31,7 +32,32 @@ export class Location extends APIResource {
   }
 
   /**
-   * Set device location
+   * Clears any simulated GPS location and restores the device's default location
+   * behavior. Devices without geo support return an unsupported-feature error.
+   */
+  reset(
+    deviceID: string,
+    params: LocationResetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.delete(path`/devices/${deviceID}/location`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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;
@@ -55,6 +81,10 @@ export interface LocationGetParams {
   'X-Device-Display-ID'?: number;
 }
 
+export interface LocationResetParams {
+  'X-Device-Display-ID'?: number;
+}
+
 export interface LocationSetParams {
   /**
    * Body param
@@ -73,5 +103,9 @@ export interface LocationSetParams {
 }
 
 export declare namespace Location {
-  export { type LocationGetParams as LocationGetParams, type LocationSetParams as LocationSetParams };
+  export {
+    type LocationGetParams as LocationGetParams,
+    type LocationResetParams as LocationResetParams,
+    type LocationSetParams as LocationSetParams,
+  };
 }

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

@@ -0,0 +1,168 @@
+// 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 MediaSessions extends APIResource {
+  /**
+   * Allocates an exclusive relay path and returns one-time publish and control
+   * credentials. The relay publisher must be established before activation.
+   */
+  create(
+    deviceID: string,
+    body: MediaSessionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<MediaSessionCreateResponse> {
+    return this._client.post(path`/devices/${deviceID}/media-sessions`, { body, ...options });
+  }
+
+  /**
+   * Immediately revokes relay authorization, detaches virtual media inputs, and
+   * kicks the relay publisher.
+   */
+  delete(sessionID: string, params: MediaSessionDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId, 'X-Media-Control-Token': xMediaControlToken } = params;
+    return this._client.delete(path`/devices/${deviceId}/media-sessions/${sessionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', 'X-Media-Control-Token': xMediaControlToken },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Validates relay codecs and attaches one private RTSP source to either the
+   * virtual microphone or the combined microphone-and-camera pipeline.
+   */
+  activate(
+    sessionID: string,
+    params: MediaSessionActivateParams,
+    options?: RequestOptions,
+  ): APIPromise<MediaSessionActivateResponse> {
+    const { deviceId, 'X-Media-Control-Token': xMediaControlToken } = params;
+    return this._client.post(path`/devices/${deviceId}/media-sessions/${sessionID}/activate`, {
+      ...options,
+      headers: buildHeaders([{ 'X-Media-Control-Token': xMediaControlToken }, options?.headers]),
+    });
+  }
+
+  /**
+   * Returns status only. Publish URLs and credentials are never replayed after
+   * creation.
+   */
+  retrieveCurrent(
+    deviceID: string,
+    options?: RequestOptions,
+  ): APIPromise<MediaSessionRetrieveCurrentResponse> {
+    return this._client.get(path`/devices/${deviceID}/media-sessions/current`, options);
+  }
+}
+
+export interface MediaSessionCreateResponse {
+  camera: boolean;
+
+  controlToken: string;
+
+  expiresAt: string;
+
+  microphone: boolean;
+
+  publishToken: string;
+
+  publishUrl: string;
+
+  sessionId: string;
+
+  state: 'created' | 'publishing' | 'active' | 'stopping' | 'closed' | 'failed';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export interface MediaSessionActivateResponse {
+  camera: boolean;
+
+  expiresAt: string;
+
+  microphone: boolean;
+
+  sessionId: string;
+
+  state: 'created' | 'publishing' | 'active' | 'stopping' | 'closed' | 'failed';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export interface MediaSessionRetrieveCurrentResponse {
+  camera: boolean;
+
+  expiresAt: string;
+
+  microphone: boolean;
+
+  sessionId: string;
+
+  state: 'created' | 'publishing' | 'active' | 'stopping' | 'closed' | 'failed';
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export interface MediaSessionCreateParams {
+  /**
+   * Publish combined browser audio and H264 video into the device's virtual
+   * microphone and camera. Requires microphone=true.
+   */
+  camera: boolean;
+
+  /**
+   * Publish browser audio into the device's virtual microphone.
+   */
+  microphone: boolean;
+}
+
+export interface MediaSessionDeleteParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
+  /**
+   * Header param
+   */
+  'X-Media-Control-Token': string;
+}
+
+export interface MediaSessionActivateParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
+  /**
+   * Header param
+   */
+  'X-Media-Control-Token': string;
+}
+
+export declare namespace MediaSessions {
+  export {
+    type MediaSessionCreateResponse as MediaSessionCreateResponse,
+    type MediaSessionActivateResponse as MediaSessionActivateResponse,
+    type MediaSessionRetrieveCurrentResponse as MediaSessionRetrieveCurrentResponse,
+    type MediaSessionCreateParams as MediaSessionCreateParams,
+    type MediaSessionDeleteParams as MediaSessionDeleteParams,
+    type MediaSessionActivateParams as MediaSessionActivateParams,
+  };
+}

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,
@@ -93,6 +97,13 @@ 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
    */
@@ -135,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).
    */