@mobilerun/sdk 1.0.0 → 2.0.0

package/src/resources/devices/index.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type ActionGlobalParams, type ActionSwipeParams, type ActionTapParams } from './actions';
+export {
+  Apps,
+  type AppListResponse,
+  type AppListParams,
+  type AppDeleteParams,
+  type AppInstallParams,
+  type AppStartParams,
+} from './apps';
+export {
+  Devices,
+  type Device,
+  type DeviceListResponse,
+  type DeviceCreateParams,
+  type DeviceListParams,
+} from './devices';
+export {
+  Keyboard,
+  type KeyboardClearParams,
+  type KeyboardKeyParams,
+  type KeyboardWriteParams,
+} from './keyboard';
+export { Packages, type PackageListResponse, type PackageListParams } from './packages';
+export {
+  State,
+  type StateScreenshotResponse,
+  type StateTimeResponse,
+  type StateUiResponse,
+  type StateScreenshotParams,
+  type StateTimeParams,
+  type StateUiParams,
+} from './state';
+export { Tasks, type TaskListResponse, type TaskListParams } from './tasks';

package/src/resources/devices/keyboard.ts

@@ -0,0 +1,113 @@
+// 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 Keyboard extends APIResource {
+  /**
+   * Clear input
+   */
+  clear(
+    deviceID: string,
+    params: KeyboardClearParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.delete(path`/devices/${deviceID}/keyboard`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Input key
+   */
+  key(deviceID: string, params: KeyboardKeyParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceID}/keyboard`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Input text
+   */
+  write(deviceID: string, params: KeyboardWriteParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/keyboard`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface KeyboardClearParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface KeyboardKeyParams {
+  /**
+   * Body param:
+   */
+  key: number;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface KeyboardWriteParams {
+  /**
+   * Body param:
+   */
+  clear: boolean;
+
+  /**
+   * Body param:
+   */
+  text: string;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Keyboard {
+  export {
+    type KeyboardClearParams as KeyboardClearParams,
+    type KeyboardKeyParams as KeyboardKeyParams,
+    type KeyboardWriteParams as KeyboardWriteParams,
+  };
+}

package/src/resources/devices/packages.ts

@@ -0,0 +1,50 @@
+// 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 Packages extends APIResource {
+  /**
+   * List packages
+   */
+  list(
+    deviceID: string,
+    params: PackageListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PackageListResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/packages`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type PackageListResponse = Array<string>;
+
+export interface PackageListParams {
+  /**
+   * Query param:
+   */
+  includeSystemPackages?: boolean;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Packages {
+  export { type PackageListResponse as PackageListResponse, type PackageListParams as PackageListParams };
+}

package/src/resources/devices/state.ts

@@ -0,0 +1,201 @@
+// 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 State extends APIResource {
+  /**
+   * Take screenshot
+   */
+  screenshot(
+    deviceID: string,
+    params: StateScreenshotParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/screenshot`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Device time
+   */
+  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,
+      ]),
+    });
+  }
+
+  /**
+   * UI state
+   */
+  ui(
+    deviceID: string,
+    params: StateUiParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<StateUiResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/ui-state`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type StateScreenshotResponse = string;
+
+export type StateTimeResponse = string;
+
+export interface StateUiResponse {
+  a11y_tree: unknown;
+
+  device_context: StateUiResponse.DeviceContext;
+
+  phone_state: StateUiResponse.PhoneState;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace StateUiResponse {
+  export interface DeviceContext {
+    display_metrics: DeviceContext.DisplayMetrics;
+
+    filtering_params: DeviceContext.FilteringParams;
+
+    screen_bounds: DeviceContext.ScreenBounds;
+
+    screenSize: DeviceContext.ScreenSize;
+  }
+
+  export namespace DeviceContext {
+    export interface DisplayMetrics {
+      density: number;
+
+      densityDpi: number;
+
+      heightPixels: number;
+
+      scaledDensity: number;
+
+      widthPixels: number;
+    }
+
+    export interface FilteringParams {
+      min_element_size: number;
+
+      overlay_offset: number;
+    }
+
+    export interface ScreenBounds {
+      height: number;
+
+      width: number;
+    }
+
+    export interface ScreenSize {
+      height: number;
+
+      width: number;
+    }
+  }
+
+  export interface PhoneState {
+    isEditable: boolean;
+
+    keyboardVisible: boolean;
+
+    activityName?: string;
+
+    currentApp?: string;
+
+    focusedElement?: PhoneState.FocusedElement;
+
+    packageName?: string;
+  }
+
+  export namespace PhoneState {
+    export interface FocusedElement {
+      className?: string;
+
+      resourceId?: string;
+
+      text?: string;
+    }
+  }
+}
+
+export interface StateScreenshotParams {
+  /**
+   * Query param:
+   */
+  hideOverlay?: boolean;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface StateTimeParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface StateUiParams {
+  /**
+   * Query param:
+   */
+  filter?: boolean;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace State {
+  export {
+    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

@@ -0,0 +1,68 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+export class Tasks extends APIResource {
+  /**
+   * List tasks for a device
+   */
+  list(
+    deviceID: string,
+    query: TaskListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TaskListResponse> {
+    return this._client.get(path`/devices/${deviceID}/tasks`, { query, ...options });
+  }
+}
+
+export interface TaskListResponse {
+  items: Array<TaskListResponse.Item> | null;
+
+  pagination: TaskListResponse.Pagination;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace TaskListResponse {
+  export interface Item {
+    createdAt: string;
+
+    taskId: string;
+
+    updatedAt: string;
+  }
+
+  export interface Pagination {
+    hasNext: boolean;
+
+    hasPrev: boolean;
+
+    page: number;
+
+    pages: number;
+
+    pageSize: number;
+
+    total: number;
+  }
+}
+
+export interface TaskListParams {
+  orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt';
+
+  orderByDirection?: 'asc' | 'desc';
+
+  page?: number;
+
+  pageSize?: number;
+}
+
+export declare namespace Tasks {
+  export { type TaskListResponse as TaskListResponse, type TaskListParams as TaskListParams };
+}

package/src/resources/devices.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './devices/index';

package/src/resources/hooks.ts

@@ -7,6 +7,13 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Hooks extends APIResource {
+  /**
+   * Get a hook subscription by id.
+   */
+  retrieve(hookID: string, options?: RequestOptions): APIPromise<HookRetrieveResponse> {
+    return this._client.get(path`/hooks/${hookID}`, options);
+  }
+
   /**
    * Edit a hook subscription (events or state).
    *
@@ -50,13 +57,31 @@ export class Hooks extends APIResource {
   /**
    * Unsubscribe a previously created subscription by id.
    *
-   * Marks the subscription as DELETED if it belongs to the user.
+   * Permanently deletes the subscription if it belongs to the user.
    */
   unsubscribe(hookID: string, options?: RequestOptions): APIPromise<HookUnsubscribeResponse> {
     return this._client.post(path`/hooks/${hookID}/unsubscribe`, options);
   }
 }
 
+export interface HookRetrieveResponse {
+  service: 'zapier' | 'n8n' | 'make' | 'internal' | 'other';
+
+  url: string;
+
+  userId: string;
+
+  id?: string;
+
+  createdAt?: string;
+
+  events?: Array<TasksAPI.TaskStatus>;
+
+  state?: 'active' | 'disabled' | 'deleted';
+
+  updatedAt?: string;
+}
+
 /**
  * Response model after successfully editing a hook.
  */
@@ -282,6 +307,7 @@ export interface HookSubscribeParams {
 
 export declare namespace Hooks {
   export {
+    type HookRetrieveResponse as HookRetrieveResponse,
     type HookUpdateResponse as HookUpdateResponse,
     type HookListResponse as HookListResponse,
     type HookGetSampleDataResponse as HookGetSampleDataResponse,

package/src/resources/index.ts

@@ -2,8 +2,16 @@
 
 export { Apps, type AppListResponse, type AppListParams } from './apps';
 export { Credentials, type CredentialListResponse } from './credentials/credentials';
+export {
+  Devices,
+  type Device,
+  type DeviceListResponse,
+  type DeviceCreateParams,
+  type DeviceListParams,
+} from './devices/devices';
 export {
   Hooks,
+  type HookRetrieveResponse,
   type HookUpdateResponse,
   type HookListResponse,
   type HookGetSampleDataResponse,