@mobilerun/sdk 1.0.0 → 2.0.0

package/src/client.ts

@@ -22,6 +22,7 @@ import {
   HookListParams,
   HookListResponse,
   HookPerformResponse,
+  HookRetrieveResponse,
   HookSubscribeParams,
   HookSubscribeResponse,
   HookUnsubscribeResponse,
@@ -30,6 +31,13 @@ import {
   Hooks,
 } from './resources/hooks';
 import { CredentialListResponse, Credentials } from './resources/credentials/credentials';
+import {
+  Device,
+  DeviceCreateParams,
+  DeviceListParams,
+  DeviceListResponse,
+  Devices,
+} from './resources/devices/devices';
 import {
   LlmModel,
   Task,
@@ -750,12 +758,14 @@ export class Mobilerun {
   static toFile = Uploads.toFile;
 
   tasks: API.Tasks = new API.Tasks(this);
+  devices: API.Devices = new API.Devices(this);
   apps: API.Apps = new API.Apps(this);
   credentials: API.Credentials = new API.Credentials(this);
   hooks: API.Hooks = new API.Hooks(this);
 }
 
 Mobilerun.Tasks = Tasks;
+Mobilerun.Devices = Devices;
 Mobilerun.Apps = Apps;
 Mobilerun.Credentials = Credentials;
 Mobilerun.Hooks = Hooks;
@@ -780,12 +790,21 @@ export declare namespace Mobilerun {
     type TaskRunStreamedParams as TaskRunStreamedParams,
   };
 
+  export {
+    Devices as Devices,
+    type Device as Device,
+    type DeviceListResponse as DeviceListResponse,
+    type DeviceCreateParams as DeviceCreateParams,
+    type DeviceListParams as DeviceListParams,
+  };
+
   export { Apps as Apps, type AppListResponse as AppListResponse, type AppListParams as AppListParams };
 
   export { Credentials as Credentials, type CredentialListResponse as CredentialListResponse };
 
   export {
     Hooks as Hooks,
+    type HookRetrieveResponse as HookRetrieveResponse,
     type HookUpdateResponse as HookUpdateResponse,
     type HookListResponse as HookListResponse,
     type HookGetSampleDataResponse as HookGetSampleDataResponse,

package/src/resources/apps.ts

@@ -14,21 +14,27 @@ export class Apps extends APIResource {
 }
 
 export interface AppListResponse {
-  apps: Array<AppListResponse.App>;
+  count: AppListResponse.Count;
 
-  availableCount: number;
+  items: Array<AppListResponse.Item>;
 
-  queuedCount: number;
+  pagination: AppListResponse.Pagination;
+}
 
-  storeCount: number;
+export namespace AppListResponse {
+  export interface Count {
+    availableCount: number;
 
-  totalCount: number;
+    queuedCount: number;
 
-  uploadCount: number;
-}
+    storeCount: number;
 
-export namespace AppListResponse {
-  export interface App {
+    totalCount: number;
+
+    uploadCount: number;
+  }
+
+  export interface Item {
     id: string;
 
     categoryName: string | null;
@@ -322,6 +328,20 @@ export namespace AppListResponse {
 
     versionName: string;
   }
+
+  export interface Pagination {
+    hasNext: boolean;
+
+    hasPrev: boolean;
+
+    page: number;
+
+    pages: number;
+
+    pageSize: number;
+
+    total: number;
+  }
 }
 
 export interface AppListParams {

package/src/resources/devices/actions.ts

@@ -0,0 +1,138 @@
+// 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 Actions extends APIResource {
+  /**
+   * Perform a global action
+   */
+  global(deviceID: string, params: ActionGlobalParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/global`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Swipe
+   */
+  swipe(deviceID: string, params: ActionSwipeParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/swipe`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Tap by coordinates
+   */
+  tap(deviceID: string, params: ActionTapParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/tap`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ActionGlobalParams {
+  /**
+   * Body param:
+   */
+  action: number;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface ActionSwipeParams {
+  /**
+   * Body param: Swipe duration in milliseconds
+   */
+  duration: number;
+
+  /**
+   * Body param:
+   */
+  endX: number;
+
+  /**
+   * Body param:
+   */
+  endY: number;
+
+  /**
+   * Body param:
+   */
+  startX: number;
+
+  /**
+   * Body param:
+   */
+  startY: number;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface ActionTapParams {
+  /**
+   * Body param:
+   */
+  x: number;
+
+  /**
+   * Body param:
+   */
+  y: number;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Actions {
+  export {
+    type ActionGlobalParams as ActionGlobalParams,
+    type ActionSwipeParams as ActionSwipeParams,
+    type ActionTapParams as ActionTapParams,
+  };
+}

package/src/resources/devices/apps.ts

@@ -0,0 +1,171 @@
+// 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 Apps extends APIResource {
+  /**
+   * List apps
+   */
+  list(
+    deviceID: string,
+    params: AppListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AppListResponse | null> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...query } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/apps`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Delete app
+   */
+  delete(packageName: string, params: AppDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.delete(path`/devices/${deviceId}/apps/${packageName}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Install app
+   */
+  install(deviceID: string, params: AppInstallParams, options?: RequestOptions): APIPromise<void> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.post(path`/devices/${deviceID}/apps`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Start app
+   */
+  start(packageName: string, params: AppStartParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.put(path`/devices/${deviceId}/apps/${packageName}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type AppListResponse = Array<AppListResponse.AppListResponseItem>;
+
+export namespace AppListResponse {
+  export interface AppListResponseItem {
+    isSystemApp: boolean;
+
+    label: string;
+
+    packageName: string;
+
+    versionCode: number;
+
+    versionName: string;
+  }
+}
+
+export interface AppListParams {
+  /**
+   * Query param:
+   */
+  includeSystemApps?: boolean;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface AppDeleteParams {
+  /**
+   * Path param:
+   */
+  deviceId: string;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface AppInstallParams {
+  /**
+   * Body param:
+   */
+  packageName: string;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export interface AppStartParams {
+  /**
+   * Path param:
+   */
+  deviceId: string;
+
+  /**
+   * Body param:
+   */
+  activity?: string;
+
+  /**
+   * Header param:
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+export declare namespace Apps {
+  export {
+    type AppListResponse as AppListResponse,
+    type AppListParams as AppListParams,
+    type AppDeleteParams as AppDeleteParams,
+    type AppInstallParams as AppInstallParams,
+    type AppStartParams as AppStartParams,
+  };
+}

package/src/resources/devices/devices.ts

@@ -0,0 +1,277 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ActionsAPI from './actions';
+import { ActionGlobalParams, ActionSwipeParams, ActionTapParams, Actions } from './actions';
+import * as AppsAPI from './apps';
+import {
+  AppDeleteParams,
+  AppInstallParams,
+  AppListParams,
+  AppListResponse,
+  AppStartParams,
+  Apps,
+} from './apps';
+import * as KeyboardAPI from './keyboard';
+import { Keyboard, KeyboardClearParams, KeyboardKeyParams, KeyboardWriteParams } from './keyboard';
+import * as PackagesAPI from './packages';
+import { PackageListParams, PackageListResponse, Packages } from './packages';
+import * as StateAPI from './state';
+import {
+  State,
+  StateScreenshotParams,
+  StateScreenshotResponse,
+  StateTimeParams,
+  StateTimeResponse,
+  StateUiParams,
+  StateUiResponse,
+} from './state';
+import * as TasksAPI from './tasks';
+import { TaskListParams, TaskListResponse, Tasks } from './tasks';
+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 {
+  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);
+  keyboard: KeyboardAPI.Keyboard = new KeyboardAPI.Keyboard(this._client);
+  tasks: TasksAPI.Tasks = new TasksAPI.Tasks(this._client);
+
+  /**
+   * Provision a new device
+   */
+  create(params: DeviceCreateParams, options?: RequestOptions): APIPromise<Device> {
+    const { deviceType, provider, ...body } = params;
+    return this._client.post('/devices', { query: { deviceType, provider }, body, ...options });
+  }
+
+  /**
+   * Get device info
+   */
+  retrieve(deviceID: string, options?: RequestOptions): APIPromise<Device> {
+    return this._client.get(path`/devices/${deviceID}`, options);
+  }
+
+  /**
+   * List devices
+   */
+  list(
+    query: DeviceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DeviceListResponse> {
+    return this._client.get('/devices', { query, ...options });
+  }
+
+  /**
+   * Terminate a device
+   */
+  terminate(deviceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/devices/${deviceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Wait for device to be ready
+   */
+  waitReady(deviceID: string, options?: RequestOptions): APIPromise<Device> {
+    return this._client.get(path`/devices/${deviceID}/wait`, options);
+  }
+}
+
+export interface Device {
+  id: string;
+
+  apps: Array<string> | null;
+
+  assignedAt: string | null;
+
+  country: string;
+
+  createdAt: string;
+
+  deviceType: string;
+
+  files: Array<string> | null;
+
+  name: string;
+
+  provider: string;
+
+  state: string;
+
+  stateMessage: string;
+
+  streamToken: string;
+
+  streamUrl: string;
+
+  taskCount: number;
+
+  updatedAt: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  userId?: string;
+}
+
+export interface DeviceListResponse {
+  items: Array<Device> | null;
+
+  pagination: DeviceListResponse.Pagination;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace DeviceListResponse {
+  export interface Pagination {
+    hasNext: boolean;
+
+    hasPrev: boolean;
+
+    page: number;
+
+    pages: number;
+
+    pageSize: number;
+
+    total: number;
+  }
+}
+
+export interface DeviceCreateParams {
+  /**
+   * Query param:
+   */
+  deviceType?: 'device_slot' | 'dedicated_emulated_device' | 'dedicated_physical_device';
+
+  /**
+   * Query param:
+   */
+  provider?: 'limrun' | 'remote' | 'roidrun';
+
+  /**
+   * Body param:
+   */
+  apps?: Array<string> | null;
+
+  /**
+   * Body param:
+   */
+  country?: string;
+
+  /**
+   * Body param:
+   */
+  files?: Array<string> | null;
+
+  /**
+   * Body param:
+   */
+  name?: string;
+
+  /**
+   * Body param:
+   */
+  proxy?: DeviceCreateParams.Proxy;
+}
+
+export namespace DeviceCreateParams {
+  export interface Proxy {
+    host: string;
+
+    password: string;
+
+    port: number;
+
+    user: string;
+  }
+}
+
+export interface DeviceListParams {
+  country?: string;
+
+  name?: string;
+
+  orderBy?: 'id' | 'createdAt' | 'updatedAt' | 'assignedAt';
+
+  orderByDirection?: 'asc' | 'desc';
+
+  page?: number;
+
+  pageSize?: number;
+
+  provider?: 'limrun' | 'personal' | 'remote' | 'roidrun';
+
+  state?: 'creating' | 'assigned' | 'ready' | 'terminated' | 'unknown';
+
+  type?: 'device_slot' | 'dedicated_emulated_device' | 'dedicated_physical_device';
+}
+
+Devices.Actions = Actions;
+Devices.State = State;
+Devices.Apps = Apps;
+Devices.Packages = Packages;
+Devices.Keyboard = Keyboard;
+Devices.Tasks = Tasks;
+
+export declare namespace Devices {
+  export {
+    type Device as Device,
+    type DeviceListResponse as DeviceListResponse,
+    type DeviceCreateParams as DeviceCreateParams,
+    type DeviceListParams as DeviceListParams,
+  };
+
+  export {
+    Actions as Actions,
+    type ActionGlobalParams as ActionGlobalParams,
+    type ActionSwipeParams as ActionSwipeParams,
+    type ActionTapParams as ActionTapParams,
+  };
+
+  export {
+    State as State,
+    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 AppListParams as AppListParams,
+    type AppDeleteParams as AppDeleteParams,
+    type AppInstallParams as AppInstallParams,
+    type AppStartParams as AppStartParams,
+  };
+
+  export {
+    Packages as Packages,
+    type PackageListResponse as PackageListResponse,
+    type PackageListParams as PackageListParams,
+  };
+
+  export {
+    Keyboard as Keyboard,
+    type KeyboardClearParams as KeyboardClearParams,
+    type KeyboardKeyParams as KeyboardKeyParams,
+    type KeyboardWriteParams as KeyboardWriteParams,
+  };
+
+  export { Tasks as Tasks, type TaskListResponse as TaskListResponse, type TaskListParams as TaskListParams };
+}