@mobilerun/sdk 5.1.0 → 5.2.1

package/src/resources/credentials/packages/credentials/fields.ts

@@ -1,17 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../../core/resource';
-import * as CredentialsAPI from './credentials';
 import { APIPromise } from '../../../../core/api-promise';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
-/**
- * Vault & Secrets
- */
 export class Fields extends APIResource {
   /**
-   * Add a new field to an existing credential
+   * Adds a single field to an existing credential. The body specifies a `fieldType`
+   * (one of the supported field types) and its value. Returns a conflict if a field
+   * of that type already exists on the credential.
    */
   create(
     credentialName: string,
@@ -26,7 +24,9 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Update the value of a credential field
+   * Updates the value of an existing field on a credential, identified by
+   * `packageName`, `credentialName`, and `fieldType` in the path. The body carries
+   * the new value and returns the updated credential.
    */
   update(
     fieldType:
@@ -48,7 +48,8 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Delete a field from a credential
+   * Removes a single field of the given `fieldType` from the specified credential
+   * while leaving the credential itself intact. Returns the updated credential.
    */
   delete(
     fieldType:
@@ -71,29 +72,140 @@ export class Fields extends APIResource {
 }
 
 export interface FieldCreateResponse {
-  data: CredentialsAPI.Credential;
+  data: FieldCreateResponse.Data;
 
   message: string;
 
   success: true;
 }
 
+export namespace FieldCreateResponse {
+  export interface Data {
+    createdBy: string | null;
+
+    credentialName: string;
+
+    fields: Array<Data.Field>;
+
+    ownerId: string;
+
+    packageName: string;
+
+    secretPath: string;
+
+    /**
+     * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+     * for credentials created before rollout.
+     */
+    userId: string | null;
+  }
+
+  export namespace Data {
+    export interface Field {
+      fieldType:
+        | 'email'
+        | 'username'
+        | 'password'
+        | 'api_token'
+        | 'phone_number'
+        | 'two_factor_secret'
+        | 'backup_codes';
+
+      value: string;
+    }
+  }
+}
+
 export interface FieldUpdateResponse {
-  data: CredentialsAPI.Credential;
+  data: FieldUpdateResponse.Data;
 
   message: string;
 
   success: true;
 }
 
+export namespace FieldUpdateResponse {
+  export interface Data {
+    createdBy: string | null;
+
+    credentialName: string;
+
+    fields: Array<Data.Field>;
+
+    ownerId: string;
+
+    packageName: string;
+
+    secretPath: string;
+
+    /**
+     * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+     * for credentials created before rollout.
+     */
+    userId: string | null;
+  }
+
+  export namespace Data {
+    export interface Field {
+      fieldType:
+        | 'email'
+        | 'username'
+        | 'password'
+        | 'api_token'
+        | 'phone_number'
+        | 'two_factor_secret'
+        | 'backup_codes';
+
+      value: string;
+    }
+  }
+}
+
 export interface FieldDeleteResponse {
-  data: CredentialsAPI.Credential;
+  data: FieldDeleteResponse.Data;
 
   message: string;
 
   success: true;
 }
 
+export namespace FieldDeleteResponse {
+  export interface Data {
+    createdBy: string | null;
+
+    credentialName: string;
+
+    fields: Array<Data.Field>;
+
+    ownerId: string;
+
+    packageName: string;
+
+    secretPath: string;
+
+    /**
+     * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+     * for credentials created before rollout.
+     */
+    userId: string | null;
+  }
+
+  export namespace Data {
+    export interface Field {
+      fieldType:
+        | 'email'
+        | 'username'
+        | 'password'
+        | 'api_token'
+        | 'phone_number'
+        | 'two_factor_secret'
+        | 'backup_codes';
+
+      value: string;
+    }
+  }
+}
+
 export interface FieldCreateParams {
   /**
    * Path param

package/src/resources/credentials/packages/credentials/index.ts

@@ -2,7 +2,6 @@
 
 export {
   Credentials,
-  type Credential,
   type CredentialCreateResponse,
   type CredentialRetrieveResponse,
   type CredentialDeleteResponse,

package/src/resources/credentials/packages/index.ts

@@ -2,7 +2,6 @@
 
 export {
   Credentials,
-  type Credential,
   type CredentialCreateResponse,
   type CredentialRetrieveResponse,
   type CredentialDeleteResponse,
@@ -14,5 +13,6 @@ export {
   Packages,
   type PackageCreateResponse,
   type PackageListResponse,
+  type PackageListAllResponse,
   type PackageCreateParams,
 } from './packages';

package/src/resources/credentials/packages/packages.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../../../core/resource';
 import * as CredentialsAPI from './credentials/credentials';
 import {
-  Credential,
   CredentialCreateParams,
   CredentialCreateResponse,
   CredentialDeleteParams,
@@ -16,25 +15,34 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
-/**
- * Vault & Secrets
- */
 export class Packages extends APIResource {
   credentials: CredentialsAPI.Credentials = new CredentialsAPI.Credentials(this._client);
 
   /**
-   * Initialize a new package/app
+   * Creates a new package (identified by `packageName`) under which credentials can
+   * be grouped. Returns a conflict if a package with the same name already exists
+   * for the user.
    */
   create(body: PackageCreateParams, options?: RequestOptions): APIPromise<PackageCreateResponse> {
     return this._client.post('/credentials/packages', { body, ...options });
   }
 
   /**
-   * List credentials for a specific package
+   * Returns all credentials stored under the given `packageName`. Each credential
+   * includes its name, secret path, and the list of fields it holds.
    */
   list(packageName: string, options?: RequestOptions): APIPromise<PackageListResponse> {
     return this._client.get(path`/credentials/packages/${packageName}`, options);
   }
+
+  /**
+   * Returns the names of all packages (apps) the authenticated owner has credentials
+   * grouped under. Use this to discover which `packageName` values are valid for the
+   * per-package credential routes.
+   */
+  listAll(options?: RequestOptions): APIPromise<PackageListAllResponse> {
+    return this._client.get('/credentials/packages', options);
+  }
 }
 
 export interface PackageCreateResponse {
@@ -52,7 +60,54 @@ export namespace PackageCreateResponse {
 }
 
 export interface PackageListResponse {
-  data: Array<CredentialsAPI.Credential>;
+  data: Array<PackageListResponse.Data>;
+}
+
+export namespace PackageListResponse {
+  export interface Data {
+    createdBy: string | null;
+
+    credentialName: string;
+
+    fields: Array<Data.Field>;
+
+    ownerId: string;
+
+    packageName: string;
+
+    secretPath: string;
+
+    /**
+     * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+     * for credentials created before rollout.
+     */
+    userId: string | null;
+  }
+
+  export namespace Data {
+    export interface Field {
+      fieldType:
+        | 'email'
+        | 'username'
+        | 'password'
+        | 'api_token'
+        | 'phone_number'
+        | 'two_factor_secret'
+        | 'backup_codes';
+
+      value: string;
+    }
+  }
+}
+
+export interface PackageListAllResponse {
+  data: Array<PackageListAllResponse.Data>;
+}
+
+export namespace PackageListAllResponse {
+  export interface Data {
+    packageName: string;
+  }
 }
 
 export interface PackageCreateParams {
@@ -65,12 +120,12 @@ export declare namespace Packages {
   export {
     type PackageCreateResponse as PackageCreateResponse,
     type PackageListResponse as PackageListResponse,
+    type PackageListAllResponse as PackageListAllResponse,
     type PackageCreateParams as PackageCreateParams,
   };
 
   export {
     Credentials as Credentials,
-    type Credential as Credential,
     type CredentialCreateResponse as CredentialCreateResponse,
     type CredentialRetrieveResponse as CredentialRetrieveResponse,
     type CredentialDeleteResponse as CredentialDeleteResponse,

package/src/resources/devices/actions.ts

@@ -8,7 +8,8 @@ import { path } from '../../internal/utils/path';
 
 export class Actions extends APIResource {
   /**
-   * Perform a global action
+   * Performs a global system action on the device, such as navigating back or going
+   * to the home screen, identified by an action code.
    */
   global(deviceID: string, params: ActionGlobalParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -28,7 +29,7 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Check if overlay is visible
+   * Returns whether the accessibility overlay is currently visible on the device.
    */
   overlayVisible(
     deviceID: string,
@@ -50,7 +51,8 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Set overlay visibility
+   * Shows or hides the accessibility overlay on the device based on the visibility
+   * flag in the request body.
    */
   setOverlayVisible(
     deviceID: string,
@@ -74,7 +76,9 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Swipe
+   * Swipes from a start coordinate to an end coordinate over the given duration in
+   * milliseconds. An optional stealth flag applies human-like jitter and curved
+   * paths on devices that support it.
    */
   swipe(deviceID: string, params: ActionSwipeParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -94,7 +98,8 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Tap by coordinates
+   * Taps the device screen at the given x/y coordinates. An optional stealth flag
+   * routes the tap through human-like input on devices that support it.
    */
   tap(deviceID: string, params: ActionTapParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;

package/src/resources/devices/apps.ts

@@ -8,7 +8,9 @@ import { path } from '../../internal/utils/path';
 
 export class Apps extends APIResource {
   /**
-   * 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,
@@ -31,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;
@@ -51,7 +54,40 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Install app
+   * Grants an Android runtime permission to the package named in the path. The
+   * permission is given by its short name (e.g. POST_NOTIFICATIONS).
+   */
+  grantPermission(
+    permission: 'POST_NOTIFICATIONS',
+    params: AppGrantPermissionParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { deviceId, packageName, 'X-Device-Display-ID': xDeviceDisplayID } = params;
+    return this._client.put(path`/devices/${deviceId}/apps/${packageName}/permissions/${permission}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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;
@@ -71,7 +107,59 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Start app
+   * Reports the backend's view of background app-install attempts on this device —
+   * status reflects the install ATTEMPT, not device ground truth; list-apps remains
+   * authoritative for what is actually installed. Records are in-memory and lost on
+   * service restart; terminal records are kept ~15 minutes. Not gated on device
+   * readiness, so it also answers while the device is offline or crashed.
+   */
+  listInstalls(
+    deviceID: string,
+    params: AppListInstallsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AppListInstallsResponse> {
+    const { 'X-Device-Display-ID': xDeviceDisplayID } = params ?? {};
+    return this._client.get(path`/devices/${deviceID}/apps/installs`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Revokes an Android runtime permission from the package named in the path. The
+   * permission is given by its short name (e.g. POST_NOTIFICATIONS).
+   */
+  revokePermission(
+    permission: 'POST_NOTIFICATIONS',
+    params: AppRevokePermissionParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { deviceId, packageName, 'X-Device-Display-ID': xDeviceDisplayID } = params;
+    return this._client.delete(path`/devices/${deviceId}/apps/${packageName}/permissions/${permission}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xDeviceDisplayID?.toString() != null ?
+            { 'X-Device-Display-ID': xDeviceDisplayID?.toString() }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * 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;
@@ -91,7 +179,9 @@ export class Apps extends APIResource {
   }
 
   /**
-   * Stop app
+   * 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;
@@ -127,6 +217,45 @@ export namespace AppListResponse {
   }
 }
 
+export interface AppListInstallsResponse {
+  installs: Array<AppListInstallsResponse.Install> | null;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+}
+
+export namespace AppListInstallsResponse {
+  export interface Install {
+    /**
+     * Android package name or iOS bundle id
+     */
+    appId: string;
+
+    /**
+     * android or ios
+     */
+    platform: string;
+
+    startedAt: string;
+
+    /**
+     * On iOS MDM devices, succeeded means the install command was accepted by the
+     * device's MDM channel, not that the install finished on-device.
+     */
+    status: 'running' | 'succeeded' | 'failed';
+
+    updatedAt: string;
+
+    /**
+     * Closed set: download_failed, adb_install_failed, panic, timeout, failed. Only
+     * present when status is failed.
+     */
+    errorClass?: string;
+  }
+}
+
 export interface AppListParams {
   /**
    * Query param
@@ -156,6 +285,23 @@ export interface AppDeleteParams {
   'X-Device-Display-ID'?: number;
 }
 
+export interface AppGrantPermissionParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
+  /**
+   * Path param
+   */
+  packageName: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
 export type AppInstallParams = AppInstallParams.Variant0 | AppInstallParams.Variant1;
 
 export declare namespace AppInstallParams {
@@ -165,6 +311,13 @@ export declare namespace AppInstallParams {
      */
     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)
      */
@@ -182,6 +335,13 @@ export declare namespace AppInstallParams {
      */
     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)
      */
@@ -194,6 +354,27 @@ export declare namespace AppInstallParams {
   }
 }
 
+export interface AppListInstallsParams {
+  'X-Device-Display-ID'?: number;
+}
+
+export interface AppRevokePermissionParams {
+  /**
+   * Path param
+   */
+  deviceId: string;
+
+  /**
+   * Path param
+   */
+  packageName: string;
+
+  /**
+   * Header param
+   */
+  'X-Device-Display-ID'?: number;
+}
+
 export interface AppStartParams {
   /**
    * Path param
@@ -217,6 +398,12 @@ export interface AppStopParams {
    */
   deviceId: string;
 
+  /**
+   * Body param: If true, clears all app data (pm clear) in addition to stopping the
+   * app.
+   */
+  clearData?: boolean;
+
   /**
    * Header param
    */
@@ -226,9 +413,13 @@ export interface AppStopParams {
 export declare namespace Apps {
   export {
     type AppListResponse as AppListResponse,
+    type AppListInstallsResponse as AppListInstallsResponse,
     type AppListParams as AppListParams,
     type AppDeleteParams as AppDeleteParams,
+    type AppGrantPermissionParams as AppGrantPermissionParams,
     type AppInstallParams as AppInstallParams,
+    type AppListInstallsParams as AppListInstallsParams,
+    type AppRevokePermissionParams as AppRevokePermissionParams,
     type AppStartParams as AppStartParams,
     type AppStopParams as AppStopParams,
   };