@mobilerun/sdk 5.1.0 → 5.2.1

package/src/resources/profiles.ts

@@ -10,21 +10,25 @@ export class Profiles extends APIResource {
   /**
    * Create a new device profile
    */
-  create(body: ProfileCreateParams, options?: RequestOptions): APIPromise<Profile> {
+  create(body: ProfileCreateParams, options?: RequestOptions): APIPromise<ProfileCreateResponse> {
     return this._client.post('/profiles', { body, ...options });
   }
 
   /**
    * Get device profile by ID
    */
-  retrieve(profileID: string, options?: RequestOptions): APIPromise<Profile> {
+  retrieve(profileID: string, options?: RequestOptions): APIPromise<ProfileRetrieveResponse> {
     return this._client.get(path`/profiles/${profileID}`, options);
   }
 
   /**
    * Update a device profile
    */
-  update(profileID: string, body: ProfileUpdateParams, options?: RequestOptions): APIPromise<Profile> {
+  update(
+    profileID: string,
+    body: ProfileUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileUpdateResponse> {
     return this._client.put(path`/profiles/${profileID}`, { body, ...options });
   }
 
@@ -46,27 +50,86 @@ export class Profiles extends APIResource {
   }
 }
 
-export interface Profile {
+export interface ProfileCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  name: string;
+
+  ownerId: string;
+
+  spec: Shared.DeviceSpec;
+
+  updatedAt: string;
+
+  /**
+   * @deprecated Deprecated: use ownerId/createdBy.
+   */
+  userId: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  createdBy?: string;
+}
+
+export interface ProfileRetrieveResponse {
   id: string;
 
   createdAt: string;
 
   name: string;
 
+  ownerId: string;
+
   spec: Shared.DeviceSpec;
 
   updatedAt: string;
 
+  /**
+   * @deprecated Deprecated: use ownerId/createdBy.
+   */
   userId: string;
 
   /**
    * A URL to the JSON Schema for this object.
    */
   $schema?: string;
+
+  createdBy?: string;
+}
+
+export interface ProfileUpdateResponse {
+  id: string;
+
+  createdAt: string;
+
+  name: string;
+
+  ownerId: string;
+
+  spec: Shared.DeviceSpec;
+
+  updatedAt: string;
+
+  /**
+   * @deprecated Deprecated: use ownerId/createdBy.
+   */
+  userId: string;
+
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  $schema?: string;
+
+  createdBy?: string;
 }
 
 export interface ProfileListResponse {
-  items: Array<Profile> | null;
+  items: Array<ProfileListResponse.Item> | null;
 
   pagination: Shared.Meta;
 
@@ -76,6 +139,34 @@ export interface ProfileListResponse {
   $schema?: string;
 }
 
+export namespace ProfileListResponse {
+  export interface Item {
+    id: string;
+
+    createdAt: string;
+
+    name: string;
+
+    ownerId: string;
+
+    spec: Shared.DeviceSpec;
+
+    updatedAt: string;
+
+    /**
+     * @deprecated Deprecated: use ownerId/createdBy.
+     */
+    userId: string;
+
+    /**
+     * A URL to the JSON Schema for this object.
+     */
+    $schema?: string;
+
+    createdBy?: string;
+  }
+}
+
 export interface ProfileDeleteResponse {
   message: string;
 
@@ -110,6 +201,12 @@ export interface ProfileUpdateParams {
 }
 
 export interface ProfileListParams {
+  /**
+   * When true, only return profiles created by the calling user (resolved from
+   * X-User-ID, never a client-supplied id).
+   */
+  mine?: boolean;
+
   name?: string;
 
   orderBy?: 'name' | 'created_at' | 'updated_at';
@@ -123,7 +220,9 @@ export interface ProfileListParams {
 
 export declare namespace Profiles {
   export {
-    type Profile as Profile,
+    type ProfileCreateResponse as ProfileCreateResponse,
+    type ProfileRetrieveResponse as ProfileRetrieveResponse,
+    type ProfileUpdateResponse as ProfileUpdateResponse,
     type ProfileListResponse as ProfileListResponse,
     type ProfileDeleteResponse as ProfileDeleteResponse,
     type ProfileCreateParams as ProfileCreateParams,

package/src/resources/proxies.ts

@@ -1,30 +1,35 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
-/**
- * Network Proxies
- */
 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,
@@ -35,7 +40,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 = {},
@@ -45,7 +51,8 @@ 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);
@@ -59,25 +66,31 @@ export class Proxies extends APIResource {
   }
 }
 
-export type ProxyConfig = ProxyConfig.Socks5ProxyConfig | ProxyConfig.WireguardProxyConfig;
+export interface ProxyCreateResponse {
+  data: Shared.Socks5ProxyConfig | ProxyCreateResponse.WireguardProxyConfig;
 
-export namespace ProxyConfig {
-  export interface Socks5ProxyConfig {
-    host: string;
+  message: string;
 
-    name: string;
+  success: true;
+}
 
-    password: string;
+export namespace ProxyCreateResponse {
+  export interface WireguardProxyConfig {
+    config: string;
 
-    port: number;
+    name: string;
 
-    protocol: 'socks5';
+    protocol: 'wireguard';
 
     proxyId: string;
-
-    user: string;
   }
+}
 
+export interface ProxyRetrieveResponse {
+  data: Shared.Socks5ProxyConfig | ProxyRetrieveResponse.WireguardProxyConfig;
+}
+
+export namespace ProxyRetrieveResponse {
   export interface WireguardProxyConfig {
     config: string;
 
@@ -89,38 +102,62 @@ export namespace ProxyConfig {
   }
 }
 
-export interface ProxyCreateResponse {
-  data: ProxyConfig;
+export interface ProxyUpdateResponse {
+  data: Shared.Socks5ProxyConfig | ProxyUpdateResponse.WireguardProxyConfig;
 
   message: string;
 
   success: true;
 }
 
-export interface ProxyRetrieveResponse {
-  data: ProxyConfig;
-}
+export namespace ProxyUpdateResponse {
+  export interface WireguardProxyConfig {
+    config: string;
 
-export interface ProxyUpdateResponse {
-  data: ProxyConfig;
+    name: string;
 
-  message: string;
+    protocol: 'wireguard';
 
-  success: true;
+    proxyId: string;
+  }
 }
 
 export interface ProxyListResponse {
-  data: Array<ProxyConfig>;
+  data: Array<Shared.Socks5ProxyConfig | ProxyListResponse.WireguardProxyConfig>;
+}
+
+export namespace ProxyListResponse {
+  export interface WireguardProxyConfig {
+    config: string;
+
+    name: string;
+
+    protocol: 'wireguard';
+
+    proxyId: string;
+  }
 }
 
 export interface ProxyDeleteResponse {
-  data: ProxyConfig;
+  data: Shared.Socks5ProxyConfig | ProxyDeleteResponse.WireguardProxyConfig;
 
   message: string;
 
   success: true;
 }
 
+export namespace ProxyDeleteResponse {
+  export interface WireguardProxyConfig {
+    config: string;
+
+    name: string;
+
+    protocol: 'wireguard';
+
+    proxyId: string;
+  }
+}
+
 export interface ProxyLookupResponse {
   /**
    * IP address of the proxy.
@@ -280,7 +317,6 @@ export namespace ProxyLookupParams {
 
 export declare namespace Proxies {
   export {
-    type ProxyConfig as ProxyConfig,
     type ProxyCreateResponse as ProxyCreateResponse,
     type ProxyRetrieveResponse as ProxyRetrieveResponse,
     type ProxyUpdateResponse as ProxyUpdateResponse,

package/src/resources/shared.ts

@@ -1,7 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Shared from './shared';
-
 export interface DeviceCarrier {
   GsmOperatorAlpha: string;
 
@@ -79,11 +77,38 @@ export interface DeviceSpec {
 
 export namespace DeviceSpec {
   export interface Proxy {
+    connect?: Proxy.Connect;
+
     name?: string;
 
     smartIp?: boolean;
 
-    socks5?: Shared.Socks5;
+    socks5?: Proxy.Socks5;
+  }
+
+  export namespace Proxy {
+    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;
+    }
+
+    export interface Socks5 {
+      host: string;
+
+      password: string;
+
+      port: number;
+
+      user: string;
+    }
   }
 }
 
@@ -169,12 +194,18 @@ export interface PermissionSet {
   write: boolean;
 }
 
-export interface Socks5 {
+export interface Socks5ProxyConfig {
   host: string;
 
+  name: string;
+
   password: string;
 
   port: number;
 
+  protocol: 'socks5';
+
+  proxyId: string;
+
   user: string;
 }