@mobilerun/sdk 5.1.0 → 5.2.1

package/src/resources/devices/recordings.ts

@@ -0,0 +1,358 @@
+// 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 Recordings extends APIResource {
+  /**
+   * List device recordings
+   */
+  list(
+    deviceID: string,
+    query: RecordingListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RecordingListResponse | null> {
+    return this._client.get(path`/devices/${deviceID}/recordings`, { query, ...options });
+  }
+
+  /**
+   * Delete a device recording
+   */
+  delete(recordingID: string, params: RecordingDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId } = params;
+    return this._client.delete(path`/devices/${deviceId}/recordings/${recordingID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Start a device recording
+   */
+  start(
+    deviceID: string,
+    body: RecordingStartParams,
+    options?: RequestOptions,
+  ): APIPromise<RecordingStartResponse> {
+    return this._client.post(path`/devices/${deviceID}/recordings`, { body, ...options });
+  }
+
+  /**
+   * Get a device recording
+   */
+  status(
+    recordingID: string,
+    params: RecordingStatusParams,
+    options?: RequestOptions,
+  ): APIPromise<RecordingStatusResponse> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/recordings/${recordingID}`, options);
+  }
+
+  /**
+   * Stop a device recording
+   */
+  stop(
+    recordingID: string,
+    params: RecordingStopParams,
+    options?: RequestOptions,
+  ): APIPromise<RecordingStopResponse> {
+    const { deviceId } = params;
+    return this._client.post(path`/devices/${deviceId}/recordings/${recordingID}`, options);
+  }
+
+  /**
+   * Get a device recording trajectory
+   */
+  trajectory(
+    recordingID: string,
+    params: RecordingTrajectoryParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/recordings/${recordingID}/trajectory`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a device recording video
+   */
+  video(recordingID: string, params: RecordingVideoParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId } = params;
+    return this._client.get(path`/devices/${deviceId}/recordings/${recordingID}/video`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type RecordingListResponse = Array<RecordingListResponse.RecordingListResponseItem>;
+
+export namespace RecordingListResponse {
+  export interface RecordingListResponseItem {
+    id: string;
+
+    actions: number;
+
+    deviceId: string;
+
+    display: RecordingListResponseItem.Display;
+
+    expiresAt: string;
+
+    name: string;
+
+    startedAt: string;
+
+    status: string;
+
+    types: Array<string> | null;
+
+    /**
+     * A URL to the JSON Schema for this object.
+     */
+    $schema?: string;
+
+    endedAt?: string;
+
+    error?: string;
+
+    video?: RecordingListResponseItem.Video;
+  }
+
+  export namespace RecordingListResponseItem {
+    export interface Display {
+      height: number;
+
+      rotation: number;
+
+      width: number;
+    }
+
+    export interface Video {
+      durationMs: number;
+
+      format: string;
+
+      sizeBytes: number;
+
+      limited?: boolean;
+
+      limitReason?: string;
+    }
+  }
+}
+
+export interface RecordingStartResponse {
+  id: string;
+
+  actions: number;
+
+  deviceId: string;
+
+  display: RecordingStartResponse.Display;
+
+  expiresAt: string;
+
+  name: string;
+
+  startedAt: string;
+
+  status: string;
+
+  types: Array<string> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  endedAt?: string;
+
+  error?: string;
+
+  video?: RecordingStartResponse.Video;
+}
+
+export namespace RecordingStartResponse {
+  export interface Display {
+    height: number;
+
+    rotation: number;
+
+    width: number;
+  }
+
+  export interface Video {
+    durationMs: number;
+
+    format: string;
+
+    sizeBytes: number;
+
+    limited?: boolean;
+
+    limitReason?: string;
+  }
+}
+
+export interface RecordingStatusResponse {
+  id: string;
+
+  actions: number;
+
+  deviceId: string;
+
+  display: RecordingStatusResponse.Display;
+
+  expiresAt: string;
+
+  name: string;
+
+  startedAt: string;
+
+  status: string;
+
+  types: Array<string> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  endedAt?: string;
+
+  error?: string;
+
+  video?: RecordingStatusResponse.Video;
+}
+
+export namespace RecordingStatusResponse {
+  export interface Display {
+    height: number;
+
+    rotation: number;
+
+    width: number;
+  }
+
+  export interface Video {
+    durationMs: number;
+
+    format: string;
+
+    sizeBytes: number;
+
+    limited?: boolean;
+
+    limitReason?: string;
+  }
+}
+
+export interface RecordingStopResponse {
+  id: string;
+
+  actions: number;
+
+  deviceId: string;
+
+  display: RecordingStopResponse.Display;
+
+  expiresAt: string;
+
+  name: string;
+
+  startedAt: string;
+
+  status: string;
+
+  types: Array<string> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  endedAt?: string;
+
+  error?: string;
+
+  video?: RecordingStopResponse.Video;
+}
+
+export namespace RecordingStopResponse {
+  export interface Display {
+    height: number;
+
+    rotation: number;
+
+    width: number;
+  }
+
+  export interface Video {
+    durationMs: number;
+
+    format: string;
+
+    sizeBytes: number;
+
+    limited?: boolean;
+
+    limitReason?: string;
+  }
+}
+
+export interface RecordingListParams {
+  status?: string;
+
+  type?: string;
+}
+
+export interface RecordingDeleteParams {
+  deviceId: string;
+}
+
+export interface RecordingStartParams {
+  name?: string;
+
+  retentionDays?: number;
+
+  types?: Array<string> | null;
+}
+
+export interface RecordingStatusParams {
+  deviceId: string;
+}
+
+export interface RecordingStopParams {
+  deviceId: string;
+}
+
+export interface RecordingTrajectoryParams {
+  deviceId: string;
+}
+
+export interface RecordingVideoParams {
+  deviceId: string;
+}
+
+export declare namespace Recordings {
+  export {
+    type RecordingListResponse as RecordingListResponse,
+    type RecordingStartResponse as RecordingStartResponse,
+    type RecordingStatusResponse as RecordingStatusResponse,
+    type RecordingStopResponse as RecordingStopResponse,
+    type RecordingListParams as RecordingListParams,
+    type RecordingDeleteParams as RecordingDeleteParams,
+    type RecordingStartParams as RecordingStartParams,
+    type RecordingStatusParams as RecordingStatusParams,
+    type RecordingStopParams as RecordingStopParams,
+    type RecordingTrajectoryParams as RecordingTrajectoryParams,
+    type RecordingVideoParams as RecordingVideoParams,
+  };
+}

package/src/resources/devices/state.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as StateAPI from './state';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -9,7 +8,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 +32,7 @@ export class State extends APIResource {
   }
 
   /**
-   * Device time
+   * Returns the device's current wall-clock time as an RFC 3339 timestamp.
    */
   time(
     deviceID: string,
@@ -54,7 +54,9 @@ export class State extends APIResource {
   }
 
   /**
-   * UI state
+   * 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,
@@ -111,6 +113,8 @@ export interface A11YNode {
   resourceId: string;
 
   text: string;
+
+  isVisibleToUser?: boolean;
 }
 
 export namespace A11YNode {
@@ -125,12 +129,6 @@ export namespace A11YNode {
   }
 }
 
-export interface Rect {
-  height: number;
-
-  width: number;
-}
-
 export type StateScreenshotResponse = string;
 
 export type StateTimeResponse = string;
@@ -156,7 +154,7 @@ export namespace StateUiResponse {
 
     filtering_params: DeviceContext.FilteringParams;
 
-    screen_bounds: StateAPI.Rect;
+    screen_bounds: DeviceContext.ScreenBounds;
   }
 
   export namespace DeviceContext {
@@ -177,6 +175,12 @@ export namespace StateUiResponse {
 
       overlay_offset: number;
     }
+
+    export interface ScreenBounds {
+      height: number;
+
+      width: number;
+    }
   }
 
   export interface PhoneState {
@@ -235,7 +239,6 @@ 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,

package/src/resources/devices/tasks.ts

@@ -6,12 +6,10 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
-/**
- * Device Management
- */
 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,

package/src/resources/devices/timezone.ts

@@ -8,7 +8,8 @@ import { path } from '../../internal/utils/path';
 
 export class Timezone extends APIResource {
   /**
-   * Get device timezone
+   * Returns the device's current timezone identifier. Devices that do not support
+   * timezone control return an unsupported-feature error.
    */
   get(
     deviceID: string,
@@ -30,7 +31,8 @@ export class Timezone extends APIResource {
   }
 
   /**
-   * Set device timezone
+   * Sets the device timezone to the identifier in the request body. Devices that do
+   * not support timezone control return an unsupported-feature error.
    */
   set(deviceID: string, params: TimezoneSetParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;