@mobilerun/sdk 5.4.0 → 5.6.0

package/src/resources/connect/proxies.ts

@@ -15,6 +15,13 @@ export class Proxies extends APIResource {
     return this._client.get(path`/connect/proxies/${id}`, options);
   }
 
+  /**
+   * Renames the proxy identified by the path ID.
+   */
+  update(id: string, body: ProxyUpdateParams, options?: RequestOptions): APIPromise<ProxyUpdateResponse> {
+    return this._client.patch(path`/connect/proxies/${id}`, { body, ...options });
+  }
+
   /**
    * Returns proxies owned by the calling tenant (the X-Owner-Id header, falling back
    * to X-User-ID). Credentials are omitted from the list.
@@ -44,6 +51,20 @@ export class Proxies extends APIResource {
     });
   }
 
+  /**
+   * Checks right now that the proxy's upstream accepts a connection through its
+   * current session. If the upstream refuses the session and the proxy is a rotating
+   * (sticky-session) proxy, the proxy is moved onto a fresh session that has been
+   * checked to work; its credentials and country stay the same, its exit IP changes.
+   * Intended for callers that are about to depend on the proxy (e.g. while
+   * provisioning a phone). After `rotated`, the gateway uses the new session within
+   * about 30 seconds. A `refused` or `unreachable` result is not an error: the
+   * response describes the proxy's state.
+   */
+  ensureHealthy(id: string, options?: RequestOptions): APIPromise<ProxyEnsureHealthyResponse> {
+    return this._client.post(path`/connect/proxies/${id}/ensure-healthy`, options);
+  }
+
   /**
    * Returns the connection history recorded for this proxy, one item per connection
    * (aggregated across the connection's lifetime). Supports filtering on every
@@ -84,23 +105,33 @@ export interface ProxyRetrieveResponse {
 
   host: string;
 
+  /**
+   * Display name for the proxy. Set it on create or change it with PATCH; when no
+   * name has been set, a label generated from the proxy's country, type, and id is
+   * returned instead — so this is never empty.
+   */
+  name: string;
+
   password: string;
 
   port: number;
 
   /**
-   * Lifecycle of a proxy. A freshly created proxy is `provisioning` — or
-   * `pending_payment` until the customer completes checkout — and becomes `active`
-   * once its upstream is assigned. `cancelling` retains full access through the paid
-   * period; when the subscription expires the proxy is `ended`. `error` marks a
-   * failed provisioning attempt.
+   * Lifecycle of a proxy. A freshly created proxy is `checking` while its billing
+   * identity is being resolved — clients should poll until a `paymentUrl` or a later
+   * status appears — then `provisioning` — or `pending_payment` until the customer
+   * completes checkout — and becomes `active` once its upstream is assigned.
+   * `cancelling` retains full access through the paid period; when the subscription
+   * expires the proxy is `ended`. `error` marks a failed provisioning attempt.
    */
-  status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
+  status: 'checking' | 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
   type: 'dedicated_residential' | 'residential' | 'mobile';
 
   username: string;
 
+  billingMode?: 'included' | 'standalone_paid';
+
   /**
    * Checkout URL to complete payment while status is `pending_payment`. Null once
    * paid or when no payment was required.
@@ -108,6 +139,47 @@ export interface ProxyRetrieveResponse {
   paymentUrl?: string | null;
 }
 
+/**
+ * A provisioned proxy without its credentials.
+ */
+export interface ProxyUpdateResponse {
+  id: string;
+
+  /**
+   * ISO 3166-1 alpha-2 country code (lowercase).
+   */
+  country: string;
+
+  createdAt: string;
+
+  host: string;
+
+  /**
+   * Display name for the proxy. Set it on create or change it with PATCH; when no
+   * name has been set, a label generated from the proxy's country, type, and id is
+   * returned instead — so this is never empty.
+   */
+  name: string;
+
+  port: number;
+
+  /**
+   * Lifecycle of a proxy. A freshly created proxy is `checking` while its billing
+   * identity is being resolved — clients should poll until a `paymentUrl` or a later
+   * status appears — then `provisioning` — or `pending_payment` until the customer
+   * completes checkout — and becomes `active` once its upstream is assigned.
+   * `cancelling` retains full access through the paid period; when the subscription
+   * expires the proxy is `ended`. `error` marks a failed provisioning attempt.
+   */
+  status: 'checking' | 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
+
+  type: 'dedicated_residential' | 'residential' | 'mobile';
+
+  username: string;
+
+  billingMode?: 'included' | 'standalone_paid';
+}
+
 /**
  * A page of proxies.
  */
@@ -136,20 +208,30 @@ export namespace ProxyListResponse {
 
     host: string;
 
+    /**
+     * Display name for the proxy. Set it on create or change it with PATCH; when no
+     * name has been set, a label generated from the proxy's country, type, and id is
+     * returned instead — so this is never empty.
+     */
+    name: string;
+
     port: number;
 
     /**
-     * Lifecycle of a proxy. A freshly created proxy is `provisioning` — or
-     * `pending_payment` until the customer completes checkout — and becomes `active`
-     * once its upstream is assigned. `cancelling` retains full access through the paid
-     * period; when the subscription expires the proxy is `ended`. `error` marks a
-     * failed provisioning attempt.
+     * Lifecycle of a proxy. A freshly created proxy is `checking` while its billing
+     * identity is being resolved — clients should poll until a `paymentUrl` or a later
+     * status appears — then `provisioning` — or `pending_payment` until the customer
+     * completes checkout — and becomes `active` once its upstream is assigned.
+     * `cancelling` retains full access through the paid period; when the subscription
+     * expires the proxy is `ended`. `error` marks a failed provisioning attempt.
      */
-    status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
+    status: 'checking' | 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
     type: 'dedicated_residential' | 'residential' | 'mobile';
 
     username: string;
+
+    billingMode?: 'included' | 'standalone_paid';
   }
 
   /**
@@ -203,23 +285,33 @@ export interface ProxyBuyResponse {
 
   host: string;
 
+  /**
+   * Display name for the proxy. Set it on create or change it with PATCH; when no
+   * name has been set, a label generated from the proxy's country, type, and id is
+   * returned instead — so this is never empty.
+   */
+  name: string;
+
   password: string;
 
   port: number;
 
   /**
-   * Lifecycle of a proxy. A freshly created proxy is `provisioning` — or
-   * `pending_payment` until the customer completes checkout — and becomes `active`
-   * once its upstream is assigned. `cancelling` retains full access through the paid
-   * period; when the subscription expires the proxy is `ended`. `error` marks a
-   * failed provisioning attempt.
+   * Lifecycle of a proxy. A freshly created proxy is `checking` while its billing
+   * identity is being resolved — clients should poll until a `paymentUrl` or a later
+   * status appears — then `provisioning` — or `pending_payment` until the customer
+   * completes checkout — and becomes `active` once its upstream is assigned.
+   * `cancelling` retains full access through the paid period; when the subscription
+   * expires the proxy is `ended`. `error` marks a failed provisioning attempt.
    */
-  status: 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
+  status: 'checking' | 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error';
 
   type: 'dedicated_residential' | 'residential' | 'mobile';
 
   username: string;
 
+  billingMode?: 'included' | 'standalone_paid';
+
   /**
    * Checkout URL to complete payment while status is `pending_payment`. Null once
    * paid or when no payment was required.
@@ -227,6 +319,22 @@ export interface ProxyBuyResponse {
   paymentUrl?: string | null;
 }
 
+/**
+ * The outcome of an ensure-healthy check.
+ */
+export interface ProxyEnsureHealthyResponse {
+  proxyId: string;
+
+  /**
+   * `healthy`: the upstream accepted the current session. `rotated`: the session was
+   * refused and the proxy now uses a fresh, checked session; retry through the
+   * proxy. `refused`: the session was refused and could not be replaced.
+   * `unreachable`: the upstream could not be reached; the session was left
+   * unchanged.
+   */
+  status: 'healthy' | 'rotated' | 'refused' | 'unreachable';
+}
+
 /**
  * A page of connections.
  */
@@ -429,6 +537,16 @@ export namespace ProxyPingResponse {
   }
 }
 
+export interface ProxyUpdateParams {
+  /**
+   * New display name, up to 64 characters excluding surrounding whitespace, and
+   * containing no NUL. Send null (or an empty/whitespace-only string) to drop a
+   * custom name and go back to the generated label. Omit to leave the name
+   * unchanged.
+   */
+  name?: string | null;
+}
+
 export interface ProxyListParams {
   /**
    * Filter to proxies in this country (ISO 3166-1 alpha-2, lowercase).
@@ -453,6 +571,13 @@ export interface ProxyBuyParams {
   country: string;
 
   type: 'dedicated_residential' | 'residential' | 'mobile';
+
+  /**
+   * Display name for the proxy, up to 64 characters excluding surrounding
+   * whitespace, and containing no NUL. Omit it (or send only whitespace) to get a
+   * generated label built from the country, type, and id.
+   */
+  name?: string;
 }
 
 export interface ProxyListConnectionsParams {
@@ -587,10 +712,13 @@ export interface ProxyListConnectionsParams {
 export declare namespace Proxies {
   export {
     type ProxyRetrieveResponse as ProxyRetrieveResponse,
+    type ProxyUpdateResponse as ProxyUpdateResponse,
     type ProxyListResponse as ProxyListResponse,
     type ProxyBuyResponse as ProxyBuyResponse,
+    type ProxyEnsureHealthyResponse as ProxyEnsureHealthyResponse,
     type ProxyListConnectionsResponse as ProxyListConnectionsResponse,
     type ProxyPingResponse as ProxyPingResponse,
+    type ProxyUpdateParams as ProxyUpdateParams,
     type ProxyListParams as ProxyListParams,
     type ProxyBuyParams as ProxyBuyParams,
     type ProxyListConnectionsParams as ProxyListConnectionsParams,

package/src/resources/devices/apps.ts

@@ -79,15 +79,16 @@ export class Apps extends APIResource {
 
   /**
    * 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.
+   * of an Android packageName or an iOS bundleId; optional country and versionCode
+   * select an exact regional uploaded Android version, and 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;
@@ -107,11 +108,11 @@ export class Apps extends APIResource {
   }
 
   /**
-   * 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.
+   * Reports the backend's durable 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. Terminal and projected
+   * timeout records are kept ~15 minutes. Not gated on device readiness, so it also
+   * answers while the device is offline or crashed.
    */
   listInstalls(
     deviceID: string,
@@ -249,10 +250,9 @@ export namespace AppListInstallsResponse {
     updatedAt: string;
 
     /**
-     * Closed set: download_failed, adb_install_failed, panic, timeout, failed. Only
-     * present when status is failed.
+     * Only present when status is failed.
      */
-    errorClass?: string;
+    errorClass?: 'download_failed' | 'adb_install_failed' | 'panic' | 'timeout' | 'failed';
   }
 }
 
@@ -318,11 +318,23 @@ export declare namespace AppInstallParams {
      */
     background?: boolean;
 
+    /**
+     * Body param: Optional ISO 3166-1 alpha-2 country of the uploaded app version
+     * (e.g. MY or SG).
+     */
+    country?: string;
+
     /**
      * Body param: Android package name (e.g. com.example.app)
      */
     packageName?: string;
 
+    /**
+     * Body param: Optional exact app-library version code. Use with country when
+     * multiple regional versions share an identifier.
+     */
+    versionCode?: number;
+
     /**
      * Header param
      */
@@ -347,6 +359,18 @@ export declare namespace AppInstallParams {
      */
     bundleId?: string;
 
+    /**
+     * Body param: Optional ISO 3166-1 alpha-2 country of the uploaded app version
+     * (e.g. MY or SG).
+     */
+    country?: string;
+
+    /**
+     * Body param: Optional exact app-library version code. Use with country when
+     * multiple regional versions share an identifier.
+     */
+    versionCode?: number;
+
     /**
      * Header param
      */

package/src/resources/devices/browser.ts

@@ -8,9 +8,15 @@ import { path } from '../../internal/utils/path';
 
 export class Browser extends APIResource {
   /**
-   * Evaluates a JavaScript expression in the device's foreground Chrome tab via the
-   * Chrome DevTools Protocol and returns its JSON-serialized result. Devices without
-   * browser support return an unsupported-feature error.
+   * Evaluates a JavaScript expression exactly once in the device's single, confirmed
+   * foreground Chrome tab via the Chrome DevTools Protocol and returns its
+   * JSON-serialized result. A responsive browser state without exactly one visible
+   * page returns DEVICE_NO_BROWSER_TARGET (400). Transient discovery, page-dial, or
+   * visibility-probe transport failures return CDP_TRANSPORT_UNAVAILABLE (503) with
+   * Retry-After and an executionOutcome; the service may start Chrome once and retry
+   * selection before Runtime.evaluate, but dial or probe recovery is skipped for a
+   * backgrounded Chrome, and a user script is never retried after its write or read.
+   * Devices without browser support return an unsupported-feature error.
    */
   executeScript(
     deviceID: string,