@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/proxies.ts

@@ -7,21 +7,28 @@ import { path } from '../internal/utils/path';
 
 export class Proxies extends APIResource {
   /**
-   * Create a new proxy config
+   * Creates a proxy config. The body is a discriminated union on `protocol`:
+   * `socks5` requires name, host, port, user, and password, while `wireguard`
+   * requires name and a config string. Returns the created config with its generated
+   * `proxyId`.
    */
   create(body: ProxyCreateParams, options?: RequestOptions): APIPromise<ProxyCreateResponse> {
     return this._client.post('/proxies', { body, ...options });
   }
 
   /**
-   * Get a specific proxy config
+   * Fetches a single proxy config by its `proxyId`. The response shape depends on
+   * the proxy's `protocol` (socks5 or wireguard). Returns not found if no matching
+   * config exists.
    */
   retrieve(proxyID: string, options?: RequestOptions): APIPromise<ProxyRetrieveResponse> {
     return this._client.get(path`/proxies/${proxyID}`, options);
   }
 
   /**
-   * Update a proxy config
+   * Replaces the proxy config identified by `proxyId` with the provided body. As
+   * with creation, the body is a `protocol`-discriminated union of socks5 or
+   * wireguard fields. Returns the updated config.
    */
   update(
     proxyID: string,
@@ -32,7 +39,8 @@ export class Proxies extends APIResource {
   }
 
   /**
-   * List all proxy configs for the authenticated user
+   * Returns all proxy configs for the authenticated user. An optional `protocol`
+   * query parameter (`socks5` or `wireguard`) filters the results by proxy type.
    */
   list(
     query: ProxyListParams | null | undefined = {},
@@ -42,11 +50,19 @@ export class Proxies extends APIResource {
   }
 
   /**
-   * Delete a proxy config
+   * Permanently deletes the proxy config identified by `proxyId` and returns the
+   * deleted config. Returns not found if no matching config exists.
    */
   delete(proxyID: string, options?: RequestOptions): APIPromise<ProxyDeleteResponse> {
     return this._client.delete(path`/proxies/${proxyID}`, options);
   }
+
+  /**
+   * Lookup proxy location
+   */
+  lookup(body: ProxyLookupParams, options?: RequestOptions): APIPromise<ProxyLookupResponse> {
+    return this._client.post('/proxies/lookup', { body, ...options });
+  }
 }
 
 export type ProxyConfig = ProxyConfig.Socks5ProxyConfig | ProxyConfig.WireguardProxyConfig;
@@ -111,6 +127,85 @@ export interface ProxyDeleteResponse {
   success: true;
 }
 
+export interface ProxyLookupResponse {
+  /**
+   * IP address of the proxy.
+   */
+  ip: string;
+
+  /**
+   * Whether the IP is a mobile connection.
+   */
+  isMobile: boolean;
+
+  /**
+   * Latitude of the proxy.
+   */
+  latitude: number;
+
+  /**
+   * Longitude of the proxy.
+   */
+  longitude: number;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  /**
+   * Mobile carrier information.
+   */
+  carrier?: ProxyLookupResponse.Carrier;
+
+  /**
+   * City of the proxy.
+   */
+  city?: string;
+
+  /**
+   * Country of the proxy.
+   */
+  country?: string;
+
+  /**
+   * ISO country code.
+   */
+  countryCode?: string;
+
+  /**
+   * Region of the proxy.
+   */
+  region?: string;
+
+  /**
+   * Timezone of the proxy.
+   */
+  timezone?: string;
+}
+
+export namespace ProxyLookupResponse {
+  /**
+   * Mobile carrier information.
+   */
+  export interface Carrier {
+    /**
+     * Mobile Country Code.
+     */
+    mcc?: string;
+
+    /**
+     * Mobile Network Code.
+     */
+    mnc?: string;
+
+    /**
+     * Carrier name.
+     */
+    name?: string;
+  }
+}
+
 export type ProxyCreateParams = ProxyCreateParams.CreateSocks5Proxy | ProxyCreateParams.CreateWireguardProxy;
 
 export declare namespace ProxyCreateParams {
@@ -167,6 +262,28 @@ export interface ProxyListParams {
   protocol?: 'socks5' | 'wireguard';
 }
 
+export interface ProxyLookupParams {
+  /**
+   * SOCKS5 proxy configuration.
+   */
+  socks5: ProxyLookupParams.Socks5;
+}
+
+export namespace ProxyLookupParams {
+  /**
+   * SOCKS5 proxy configuration.
+   */
+  export interface Socks5 {
+    host: string;
+
+    port: number;
+
+    password?: string;
+
+    user?: string;
+  }
+}
+
 export declare namespace Proxies {
   export {
     type ProxyConfig as ProxyConfig,
@@ -175,8 +292,10 @@ export declare namespace Proxies {
     type ProxyUpdateResponse as ProxyUpdateResponse,
     type ProxyListResponse as ProxyListResponse,
     type ProxyDeleteResponse as ProxyDeleteResponse,
+    type ProxyLookupResponse as ProxyLookupResponse,
     type ProxyCreateParams as ProxyCreateParams,
     type ProxyUpdateParams as ProxyUpdateParams,
     type ProxyListParams as ProxyListParams,
+    type ProxyLookupParams as ProxyLookupParams,
   };
 }

package/src/resources/shared.ts

@@ -1,5 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import * as Shared from './shared';
+
 export interface DeviceCarrier {
   GsmOperatorAlpha: string;
 
@@ -52,41 +54,65 @@ export interface DeviceSpec {
    */
   $schema?: string;
 
+  androidVersion?: number;
+
   apps?: Array<string> | null;
 
   carrier?: DeviceCarrier;
 
+  country?: string;
+
   files?: Array<string> | null;
 
   identifiers?: DeviceIdentifiers;
 
+  locale?: string;
+
+  location?: Location;
+
   name?: string;
 
   proxy?: DeviceSpec.Proxy;
+
+  timezone?: string;
 }
 
 export namespace DeviceSpec {
   export interface Proxy {
+    connect?: Proxy.Connect;
+
     name?: string;
 
     smartIp?: boolean;
 
-    socks5?: Proxy.Socks5;
-
-    wireguard?: string;
+    socks5?: Shared.Socks5;
   }
 
   export namespace Proxy {
-    export interface Socks5 {
-      host: string;
+    export interface Connect {
+      /**
+       * Existing Mobilerun Connect proxy id; its credentials are fetched server-side.
+       */
+      id?: string;
+
+      /**
+       * ISO 3166-1 alpha-2 country code; provisions (or reuses) a rotating residential
+       * Mobilerun Connect proxy for the device.
+       */
+      country?: string;
+    }
+  }
+}
 
-      password: string;
+export interface Location {
+  latitude: number;
 
-      port: number;
+  longitude: number;
 
-      user: string;
-    }
-  }
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
 }
 
 export interface Meta {
@@ -159,3 +185,13 @@ export interface PermissionSet {
 
   write: boolean;
 }
+
+export interface Socks5 {
+  host: string;
+
+  password: string;
+
+  port: number;
+
+  user: string;
+}