@mobilerun/sdk 5.5.0 → 6.0.0

package/src/resources/connect/index.ts

@@ -5,10 +5,13 @@ export { Countries, type CountryListResponse, type CountryListParams } from './c
 export {
   Proxies,
   type ProxyRetrieveResponse,
+  type ProxyUpdateResponse,
   type ProxyListResponse,
   type ProxyBuyResponse,
+  type ProxyEnsureHealthyResponse,
   type ProxyListConnectionsResponse,
   type ProxyPingResponse,
+  type ProxyUpdateParams,
   type ProxyListParams,
   type ProxyBuyParams,
   type ProxyListConnectionsParams,

package/src/resources/connect/proxies.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 Proxies
+ */
 export class Proxies extends APIResource {
   /**
    * Returns the proxy identified by the path ID. The response includes the proxy's
@@ -16,8 +19,14 @@ export class Proxies extends APIResource {
   }
 
   /**
-   * Returns proxies owned by the calling tenant (the X-Owner-Id header, falling back
-   * to X-User-ID). Credentials are omitted from the list.
+   * 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 caller. Credentials are omitted from the list.
    */
   list(
     query: ProxyListParams | null | undefined = {},
@@ -29,16 +38,8 @@ export class Proxies extends APIResource {
   /**
    * Provisions a proxy of the requested type for the caller in the selected country.
    */
-  buy(params: ProxyBuyParams, options?: RequestOptions): APIPromise<ProxyBuyResponse> {
-    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
-    return this._client.post('/connect/proxies', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
-        options?.headers,
-      ]),
-    });
+  buy(body: ProxyBuyParams, options?: RequestOptions): APIPromise<ProxyBuyResponse> {
+    return this._client.post('/connect/proxies', { body, ...options });
   }
 
   /**
@@ -52,11 +53,25 @@ 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
-   * property plus ordering and pagination. Returns 503 when the connection-insights
-   * backend is disabled or unreachable.
+   * property plus ordering and pagination. Returns 503 when connection history is
+   * temporarily unavailable.
    */
   listConnections(
     id: string,
@@ -92,6 +107,13 @@ 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;
@@ -119,6 +141,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.
  */
@@ -147,6 +210,13 @@ 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;
 
     /**
@@ -217,6 +287,13 @@ 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;
@@ -244,6 +321,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.
  */
@@ -303,7 +396,7 @@ export namespace ProxyListConnectionsResponse {
     protocol: 'tcp' | 'udp' | 'unknown';
 
     /**
-     * Upstream provider that served the connection.
+     * Identifier of the upstream provider that served the connection.
      */
     provider: string;
 
@@ -446,6 +539,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).
@@ -465,22 +568,18 @@ export interface ProxyListParams {
 
 export interface ProxyBuyParams {
   /**
-   * Body param: ISO 3166-1 alpha-2 country code to provision the proxy in.
+   * ISO 3166-1 alpha-2 country code to provision the proxy in.
    */
   country: string;
 
-  /**
-   * Body param
-   */
   type: 'dedicated_residential' | 'residential' | 'mobile';
 
   /**
-   * Header param: Optional idempotency key, unique per owner (1-128 characters after
-   * trimming; surrounding whitespace is ignored). Reusing a key returns the
-   * originally created proxy with its original credentials, regardless of changed
-   * request parameters.
+   * 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.
    */
-  'Idempotency-Key'?: string;
+  name?: string;
 }
 
 export interface ProxyListConnectionsParams {
@@ -582,7 +681,7 @@ export interface ProxyListConnectionsParams {
   protocol?: 'tcp' | 'udp' | 'unknown';
 
   /**
-   * Filter to connections served by this upstream provider.
+   * Filter to connections served by this upstream provider identifier.
    */
   provider?: string;
 
@@ -615,10 +714,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/connect/users.ts

@@ -57,8 +57,8 @@ export class Users extends APIResource {
   /**
    * Returns the connection history recorded for this user, one item per connection
    * (aggregated across the connection's lifetime). Supports filtering on every
-   * property plus ordering and pagination. Returns 503 when the connection-insights
-   * backend is disabled or unreachable.
+   * property plus ordering and pagination. Returns 503 when connection history is
+   * temporarily unavailable.
    */
   listConnections(
     id: string,
@@ -247,7 +247,7 @@ export namespace UserListConnectionsResponse {
     protocol: 'tcp' | 'udp' | 'unknown';
 
     /**
-     * Upstream provider that served the connection.
+     * Identifier of the upstream provider that served the connection.
      */
     provider: string;
 
@@ -472,7 +472,7 @@ export interface UserListConnectionsParams {
   protocol?: 'tcp' | 'udp' | 'unknown';
 
   /**
-   * Filter to connections served by this upstream provider.
+   * Filter to connections served by this upstream provider identifier.
    */
   provider?: string;
 

package/src/resources/devices/actions.ts

@@ -77,8 +77,10 @@ export class Actions extends APIResource {
 
   /**
    * 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.
+   * milliseconds. An optional humanize flag applies human-like jitter and curved
+   * paths on devices that support it. With holdMs > 0 the request returns 422 when
+   * combined with humanize, when duration + holdMs exceeds 9000 ms, or on devices
+   * that do not support it.
    */
   swipe(deviceID: string, params: ActionSwipeParams, options?: RequestOptions): APIPromise<void> {
     const { 'X-Device-Display-ID': xDeviceDisplayID, ...body } = params;
@@ -98,7 +100,7 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Taps the device screen at the given x/y coordinates. An optional stealth flag
+   * Taps the device screen at the given x/y coordinates. An optional humanize flag
    * routes the tap through human-like input on devices that support it.
    */
   tap(deviceID: string, params: ActionTapParams, options?: RequestOptions): APIPromise<void> {
@@ -183,7 +185,21 @@ export interface ActionSwipeParams {
   startY: number;
 
   /**
-   * Body param
+   * Body param: Keep the finger at the end point for holdMs and suppress fling
+   * before lifting, so content moves by about the finger travel. Supported on
+   * Android cloud phones.
+   */
+  holdMs?: number;
+
+  /**
+   * Body param: Request human-like input where supported by the device. Defaults to
+   * false.
+   */
+  humanize?: boolean;
+
+  /**
+   * @deprecated Body param: Deprecated: use humanize. Both names must agree when
+   * supplied together.
    */
   stealth?: boolean;
 
@@ -205,7 +221,14 @@ export interface ActionTapParams {
   y: number;
 
   /**
-   * Body param
+   * Body param: Request human-like input where supported by the device. Defaults to
+   * false.
+   */
+  humanize?: boolean;
+
+  /**
+   * @deprecated Body param: Deprecated: use humanize. Both names must agree when
+   * supplied together.
    */
   stealth?: boolean;
 

package/src/resources/devices/apps.ts

@@ -215,6 +215,18 @@ export namespace AppListResponse {
     versionCode: number;
 
     versionName: string;
+
+    availableUpdate?: AppListResponseItem.AvailableUpdate;
+  }
+
+  export namespace AppListResponseItem {
+    export interface AvailableUpdate {
+      country: string;
+
+      versionCode: number;
+
+      versionName: string;
+    }
   }
 }
 
@@ -267,6 +279,12 @@ export interface AppListParams {
    */
   includeSystemApps?: boolean;
 
+  /**
+   * Query param: Resolve availableUpdate for Android user apps (one library lookup
+   * per app). Off by default.
+   */
+  includeUpdates?: boolean;
+
   /**
    * 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,