@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/devices/apps.ts

@@ -8,27 +8,9 @@ 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
+   * Returns detailed information about apps installed on the device, including
+   * package name and label. System and protected apps are excluded unless the
+   * corresponding query parameters are set.
    */
   list(
     deviceID: string,
@@ -51,7 +33,8 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Delete app
+   * Uninstalls the app identified by the path package name from the device.
+   * Protected packages cannot be deleted.
    */
   delete(packageName: string, params: AppDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { deviceId, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -71,7 +54,16 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Install app
+   * Requests an app install on the device. The request body must supply exactly one
+   * of an Android packageName or an iOS bundleId; protected packages are rejected.
+   * background (default false) selects the response contract: false installs inline
+   * and returns the outcome directly (200 on success, an error status on failure);
+   * true accepts the request and runs the download + install in the background,
+   * returning 202 immediately — poll list-app-installs for the backend's view of
+   * that attempt's status. Refuses with 409 once 2 other installs are already
+   * running on the device, in either mode; a repeat request for an app that already
+   * has an install running is also refused with 409 rather than superseding it —
+   * retry once that attempt reaches a terminal state.
    */
   install(deviceID: string, params: AppInstallParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -91,7 +83,9 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Start app
+   * Launches the app identified by the path package name, optionally starting a
+   * specific activity given in the request body. Protected packages cannot be
+   * started.
    */
   start(packageName: string, params: AppStartParams, options?: RequestOptions): APIPromise<void> {
     const { deviceId, 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -109,6 +103,28 @@ export class Apps extends APIResource {
       ]),
     });
   }
+
+  /**
+   * Force-stops the app identified by the path package name. When clearData is set
+   * in the request body, the app's data is also cleared. Protected packages cannot
+   * be stopped.
+   */
+  stop(packageName: string, params: AppStopParams, 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,
+      ]),
+    });
+  }
 }
 
 export type AppListResponse = Array<AppListResponse.AppListResponseItem>;
@@ -127,18 +143,6 @@ export namespace AppListResponse {
   }
 }
 
-export interface AppUpdateParams {
-  /**
-   * Path param
-   */
-  deviceId: string;
-
-  /**
-   * Header param
-   */
-  'X-Device-Display-ID'?: number;
-}
-
 export interface AppListParams {
   /**
    * Query param
@@ -168,11 +172,68 @@ export interface AppDeleteParams {
   'X-Device-Display-ID'?: number;
 }
 
-export interface AppInstallParams {
+export type AppInstallParams = AppInstallParams.Variant0 | AppInstallParams.Variant1;
+
+export declare namespace AppInstallParams {
+  export interface Variant0 {
+    /**
+     * Body param: iOS bundle identifier (e.g. com.example.app)
+     */
+    bundleId: string;
+
+    /**
+     * Body param: true: return 202 immediately and install in the background (poll
+     * list-app-installs). false/omitted: install inline and return the outcome
+     * directly (200 on success, an error status on failure).
+     */
+    background?: boolean;
+
+    /**
+     * Body param: Android package name (e.g. com.example.app)
+     */
+    packageName?: string;
+
+    /**
+     * Header param
+     */
+    'X-Device-Display-ID'?: number;
+  }
+
+  export interface Variant1 {
+    /**
+     * Body param: Android package name (e.g. com.example.app)
+     */
+    packageName: string;
+
+    /**
+     * Body param: true: return 202 immediately and install in the background (poll
+     * list-app-installs). false/omitted: install inline and return the outcome
+     * directly (200 on success, an error status on failure).
+     */
+    background?: boolean;
+
+    /**
+     * Body param: iOS bundle identifier (e.g. com.example.app)
+     */
+    bundleId?: string;
+
+    /**
+     * Header param
+     */
+    'X-Device-Display-ID'?: number;
+  }
+}
+
+export interface AppStartParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
   /**
    * Body param
    */
-  packageName: string;
+  activity?: string;
 
   /**
    * Header param
@@ -180,16 +241,17 @@ export interface AppInstallParams {
   'X-Device-Display-ID'?: number;
 }
 
-export interface AppStartParams {
+export interface AppStopParams {
   /**
    * Path param
    */
   deviceId: string;
 
   /**
-   * Body param
+   * Body param: If true, clears all app data (pm clear) in addition to stopping the
+   * app.
    */
-  activity?: string;
+  clearData?: boolean;
 
   /**
    * Header param
@@ -200,10 +262,10 @@ export interface AppStartParams {
 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,
+    type AppStopParams as AppStopParams,
   };
 }