@mobilerun/sdk 5.1.0 → 5.2.0

package/src/resources/apps.ts

@@ -6,9 +6,6 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
-/**
- * App Management
- */
 export class Apps extends APIResource {
   /**
    * Retrieves an app by its ID
@@ -82,7 +79,6 @@ export class Apps extends APIResource {
    *       fileName: 'J!Q0Ok0bzJb7.apk/i',
    *     },
    *   ],
-   *   sizeBytes: 0,
    *   versionCode: 0,
    *   versionName: 'x',
    * });
@@ -454,11 +450,15 @@ export namespace AppListResponse {
 
       createdAt: string | null;
 
+      createdBy: string | null;
+
+      ownerId: string | null;
+
       queuedAt: string | null;
 
       sizeBytes: number | null;
 
-      source: 'user' | 'system' | 'portal';
+      source: 'user' | 'system' | 'portal' | 'store';
 
       status: 'queued' | 'available' | 'failed';
 
@@ -466,6 +466,9 @@ export namespace AppListResponse {
 
       updatedAt: string | null;
 
+      /**
+       * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+       */
       userId: string | null;
 
       versionCode: number;
@@ -778,11 +781,15 @@ export namespace AppListVersionsResponse {
 
     createdAt: string | null;
 
+    createdBy: string | null;
+
+    ownerId: string | null;
+
     queuedAt: string | null;
 
     sizeBytes: number | null;
 
-    source: 'user' | 'system' | 'portal';
+    source: 'user' | 'system' | 'portal' | 'store';
 
     status: 'queued' | 'available' | 'failed';
 
@@ -790,6 +797,9 @@ export namespace AppListVersionsResponse {
 
     updatedAt: string | null;
 
+    /**
+     * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+     */
     userId: string | null;
 
     versionCode: number;
@@ -827,8 +837,6 @@ export interface AppCreateSignedUploadURLParams {
 
   files: Array<AppCreateSignedUploadURLParams.File>;
 
-  sizeBytes: number;
-
   versionCode: number;
 
   versionName: string;

package/src/resources/carriers.ts

@@ -6,9 +6,6 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
-/**
- * Mobile Carriers
- */
 export class Carriers extends APIResource {
   /**
    * Create a new carrier

package/src/resources/connect/countries.ts

@@ -4,9 +4,14 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Mobilerun Connect country coverage information
+ */
 export class Countries extends APIResource {
   /**
-   * Lookup of countries that can be selected when creating a proxy.
+   * Lookup of countries that can be selected when creating a proxy. Each country
+   * lists the proxy types available there; without a ?type filter, every covered
+   * country is returned.
    */
   list(
     query: CountryListParams | null | undefined = {},
@@ -40,7 +45,7 @@ export namespace CountryListResponse {
     /**
      * Proxy types available to provision in this country.
      */
-    proxyTypes: Array<'residential'>;
+    proxyTypes: Array<'dedicated_residential' | 'residential' | 'mobile'>;
   }
 
   /**
@@ -93,7 +98,7 @@ export interface CountryListParams {
   /**
    * Filter to countries offering this proxy type.
    */
-  type?: 'residential';
+  type?: 'dedicated_residential' | 'residential' | 'mobile';
 }
 
 export declare namespace Countries {

package/src/resources/connect/proxies.ts

@@ -8,15 +8,16 @@ import { path } from '../../internal/utils/path';
 
 export class Proxies extends APIResource {
   /**
-   * Get a proxy by ID, including its password
+   * Returns the proxy identified by the path ID. The response includes the proxy's
+   * password.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ProxyRetrieveResponse> {
     return this._client.get(path`/connect/proxies/${id}`, options);
   }
 
   /**
-   * Returns proxies owned by the user identified by the X-User-ID header.
-   * Credentials are omitted from the list.
+   * Returns proxies owned by the calling tenant (the X-Owner-Id header, falling back
+   * to X-User-ID). Credentials are omitted from the list.
    */
   list(
     query: ProxyListParams | null | undefined = {},
@@ -26,14 +27,15 @@ export class Proxies extends APIResource {
   }
 
   /**
-   * Provisions a proxy for the caller in the selected country.
+   * Provisions a proxy of the requested type for the caller in the selected country.
    */
   buy(body: ProxyBuyParams, options?: RequestOptions): APIPromise<ProxyBuyResponse> {
     return this._client.post('/connect/proxies', { body, ...options });
   }
 
   /**
-   * Delete a proxy
+   * Deletes the proxy identified by the path ID and releases its provisioning.
+   * Returns 404 if no such proxy exists for the caller.
    */
   cancel(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/connect/proxies/${id}`, {
@@ -95,7 +97,7 @@ export interface ProxyRetrieveResponse {
    */
   status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
-  type: 'residential';
+  type: 'dedicated_residential' | 'residential' | 'mobile';
 
   username: string;
 
@@ -145,7 +147,7 @@ export namespace ProxyListResponse {
      */
     status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
-    type: 'residential';
+    type: 'dedicated_residential' | 'residential' | 'mobile';
 
     username: string;
   }
@@ -214,7 +216,7 @@ export interface ProxyBuyResponse {
    */
   status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
-  type: 'residential';
+  type: 'dedicated_residential' | 'residential' | 'mobile';
 
   username: string;
 
@@ -450,7 +452,7 @@ export interface ProxyBuyParams {
    */
   country: string;
 
-  type?: 'residential';
+  type: 'dedicated_residential' | 'residential' | 'mobile';
 }
 
 export interface ProxyListConnectionsParams {

package/src/resources/connect/users.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Manage your Mobilerun Connect Socks Users
+ */
 export class Users extends APIResource {
   /**
    * Creates a SOCKS5 credential, optionally bound to a proxy for dedicated routing.
@@ -16,7 +19,8 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get a SOCKS5 user by ID, including its password
+   * Returns the SOCKS5 user identified by the path ID. The response includes the
+   * user's password.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<UserRetrieveResponse> {
     return this._client.get(path`/connect/users/${id}`, options);
@@ -40,7 +44,8 @@ export class Users extends APIResource {
   }
 
   /**
-   * Delete a SOCKS5 user
+   * Deletes the SOCKS5 user identified by the path ID, revoking its credentials and
+   * any proxy binding. Returns 404 if no such user exists for the caller.
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/connect/users/${id}`, {

package/src/resources/credentials/credentials.ts

@@ -13,14 +13,13 @@ import * as PackagesCredentialsAPI from './packages/credentials/credentials';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
-/**
- * Vault & Secrets
- */
 export class Credentials extends APIResource {
   packages: PackagesAPI.Packages = new PackagesAPI.Packages(this._client);
 
   /**
-   * List all credentials for the authenticated user
+   * Returns a paginated list of all credentials belonging to the authenticated user
+   * across every package. Accepts standard pagination query parameters and responds
+   * with the credential items plus pagination metadata.
    */
   list(
     query: CredentialListParams | null | undefined = {},

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

@@ -15,14 +15,13 @@ import { APIPromise } from '../../../../core/api-promise';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
-/**
- * Vault & Secrets
- */
 export class Credentials extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
 
   /**
-   * Create a credential with fields for a package
+   * Creates a credential under the given package with a `credentialName` and at
+   * least one field. Each field has a `fieldType` (email, username, password,
+   * api_token, phone_number, two_factor_secret, or backup_codes) and a value.
    */
   create(
     packageName: string,
@@ -33,7 +32,8 @@ export class Credentials extends APIResource {
   }
 
   /**
-   * Get a specific credential with its fields
+   * Fetches a single credential by `packageName` and `credentialName`, including all
+   * of its stored fields. Returns not found if no matching credential exists.
    */
   retrieve(
     credentialName: string,
@@ -48,7 +48,8 @@ export class Credentials extends APIResource {
   }
 
   /**
-   * Delete a credential and all its fields
+   * Permanently deletes the credential identified by `packageName` and
+   * `credentialName`, removing all of its fields. Returns the deleted credential.
    */
   delete(
     credentialName: string,
@@ -64,15 +65,23 @@ export class Credentials extends APIResource {
 }
 
 export interface Credential {
+  createdBy: string | null;
+
   credentialName: string;
 
   fields: Array<Credential.Field>;
 
+  ownerId: string;
+
   packageName: string;
 
   secretPath: string;
 
-  userId: string;
+  /**
+   * @deprecated Deprecated: use createdBy (same value — the creating actor). Null
+   * for credentials created before rollout.
+   */
+  userId: string | null;
 }
 
 export namespace Credential {

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

@@ -6,12 +6,11 @@ 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 +25,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 +49,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:

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

@@ -16,21 +16,21 @@ 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);

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,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;
@@ -71,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;
@@ -91,7 +105,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;
@@ -165,6 +181,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 +205,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)
      */
@@ -217,6 +247,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
    */