@mobilerun/sdk 1.0.0 → 2.1.0

package/src/resources/devices/apps.ts

@@ -0,0 +1,204 @@
+// 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 {
+  /**
+   * Stop app
+   */
+  update(packageName: string, params: AppUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { deviceId, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
+    return this._client.patch(path`/devices/${deviceId}/apps/${packageName}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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 AppUpdateParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
+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 AppUpdateParams as AppUpdateParams,
+    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,303 @@
+// 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,
+  AppUpdateParams,
+  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 });
+  }
+
+  /**
+   * Count claimed devices
+   */
+  count(options?: RequestOptions): APIPromise<DeviceCountResponse> {
+    return this._client.get('/devices/count', options);
+  }
+
+  /**
+   * Terminate a device
+   */
+  terminate(deviceID: string, body: DeviceTerminateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/devices/${deviceID}`, {
+      body,
+      ...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;
+
+  terminatesAt: string | null;
+
+  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 type DeviceCountResponse = { [key: string]: number };
+
+export interface DeviceCreateParams {
+  /**
+   * Query param
+   */
+  deviceType?:
+    | 'device_slot'
+    | 'dedicated_emulated_device'
+    | 'dedicated_physical_device'
+    | 'dedicated_premium_device';
+
+  /**
+   * Query param
+   */
+  provider?: 'limrun' | 'physical' | 'premium' | '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?: Array<'creating' | 'assigned' | 'ready' | 'disconnected' | 'terminated' | 'unknown'> | null;
+
+  type?: 'device_slot' | 'dedicated_emulated_device' | 'dedicated_physical_device';
+}
+
+export interface DeviceTerminateParams {
+  previousDeviceId?: string;
+
+  terminateAt?: string;
+}
+
+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 DeviceCountResponse as DeviceCountResponse,
+    type DeviceCreateParams as DeviceCreateParams,
+    type DeviceListParams as DeviceListParams,
+    type DeviceTerminateParams as DeviceTerminateParams,
+  };
+
+  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 AppUpdateParams as AppUpdateParams,
+    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 };
+}

package/src/resources/devices/index.ts

@@ -0,0 +1,38 @@
+// 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 AppUpdateParams,
+  type AppListParams,
+  type AppDeleteParams,
+  type AppInstallParams,
+  type AppStartParams,
+} from './apps';
+export {
+  Devices,
+  type Device,
+  type DeviceListResponse,
+  type DeviceCountResponse,
+  type DeviceCreateParams,
+  type DeviceListParams,
+  type DeviceTerminateParams,
+} 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 };
+}