@mobilerun/sdk 5.1.0 → 5.2.0

package/src/resources/hooks.ts

@@ -1,337 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as Shared from './shared';
-import * as TasksAPI from './tasks/tasks';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
 
-export class Hooks extends APIResource {
-  /**
-   * Get a hook subscription by id.
-   */
-  retrieve(hookID: string, options?: RequestOptions): APIPromise<HookRetrieveResponse> {
-    return this._client.get(path`/hooks/${hookID}`, options);
-  }
-
-  /**
-   * Edit a hook subscription (events or state).
-   *
-   * Allows updating the events filter and/or the state of a hook.
-   */
-  update(hookID: string, body: HookUpdateParams, options?: RequestOptions): APIPromise<HookUpdateResponse> {
-    return this._client.post(path`/hooks/${hookID}/edit`, { body, ...options });
-  }
-
-  /**
-   * List hooks belonging to the requesting user (paginated).
-   */
-  list(
-    query: HookListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<HookListResponse> {
-    return this._client.get('/hooks', { query, ...options });
-  }
-
-  /**
-   * Get sample hook data for Zapier Perform List (testing/field mapping).
-   */
-  getSampleData(options?: RequestOptions): APIPromise<HookGetSampleDataResponse> {
-    return this._client.get('/hooks/sample', options);
-  }
-
-  /**
-   * Zapier Perform endpoint - processes webhook payloads.
-   */
-  perform(params: HookPerformParams, options?: RequestOptions): APIPromise<HookPerformResponse> {
-    const { body } = params;
-    return this._client.post('/hooks/perform', { body: body, ...options });
-  }
-
-  /**
-   * Subscribe the current user to a webhook URL. Returns subscription id.
-   */
-  subscribe(body: HookSubscribeParams, options?: RequestOptions): APIPromise<HookSubscribeResponse> {
-    return this._client.post('/hooks/subscribe', { body, ...options });
-  }
-
-  /**
-   * Send a test event to a webhook endpoint.
-   *
-   * Delivers a sample payload to the hook's URL with a single attempt (no retries)
-   * for fast feedback.
-   */
-  test(hookID: string, body: HookTestParams, options?: RequestOptions): APIPromise<HookTestResponse> {
-    return this._client.post(path`/hooks/${hookID}/test`, { body, ...options });
-  }
-
-  /**
-   * Unsubscribe a previously created subscription by id.
-   *
-   * Permanently deletes the subscription if it belongs to the user.
-   */
-  unsubscribe(hookID: string, options?: RequestOptions): APIPromise<HookUnsubscribeResponse> {
-    return this._client.post(path`/hooks/${hookID}/unsubscribe`, options);
-  }
-}
-
-export interface HookRetrieveResponse {
-  service: 'zapier' | 'n8n' | 'make' | 'internal' | 'other';
-
-  url: string;
-
-  userId: string;
-
-  id?: string;
-
-  createdAt?: string;
-
-  events?: Array<TasksAPI.TaskStatus>;
-
-  state?: 'active' | 'disabled' | 'deleted';
-
-  updatedAt?: string;
-}
-
-/**
- * Response model after successfully editing a hook.
- */
-export interface HookUpdateResponse {
-  /**
-   * The subscription ID
-   */
-  id: string;
-
-  /**
-   * The hook state
-   */
-  state: string;
-
-  /**
-   * Whether the hook was updated
-   */
-  updated: boolean;
-
-  /**
-   * The webhook URL
-   */
-  url: string;
-
-  /**
-   * List of subscribed events
-   */
-  events?: Array<string> | null;
-}
-
-export interface HookListResponse {
-  /**
-   * The paginated items
-   */
-  items: Array<HookListResponse.Item>;
-
-  /**
-   * Pagination metadata
-   */
-  pagination: Shared.PaginationMeta;
-}
-
-export namespace HookListResponse {
-  export interface Item {
-    service: 'zapier' | 'n8n' | 'make' | 'internal' | 'other';
-
-    url: string;
-
-    userId: string;
-
-    id?: string;
-
-    createdAt?: string;
-
-    events?: Array<TasksAPI.TaskStatus>;
-
-    state?: 'active' | 'disabled' | 'deleted';
-
-    updatedAt?: string;
-  }
-}
-
-export type HookGetSampleDataResponse = Array<HookGetSampleDataResponse.HookGetSampleDataResponseItem>;
-
-export namespace HookGetSampleDataResponse {
-  /**
-   * Sample webhook event data for testing/mapping in Zapier.
-   */
-  export interface HookGetSampleDataResponseItem {
-    /**
-     * The subscription ID
-     */
-    id: string;
-
-    /**
-     * ISO timestamp of when the subscription was created
-     */
-    createdAt: string;
-
-    /**
-     * List of subscribed events
-     */
-    events: Array<string>;
-
-    /**
-     * The hook state
-     */
-    state: string;
-
-    /**
-     * The webhook URL
-     */
-    url: string;
-
-    /**
-     * ISO timestamp of the last update
-     */
-    updatedAt?: string | null;
-  }
-}
-
-export type HookPerformResponse = Array<{ [key: string]: unknown }>;
-
-/**
- * Response model after successful subscription.
- */
-export interface HookSubscribeResponse {
-  /**
-   * The subscription ID
-   */
-  id: string;
-
-  /**
-   * Whether subscription was successful
-   */
-  subscribed: boolean;
-
-  /**
-   * The webhook URL
-   */
-  url: string;
-
-  /**
-   * List of subscribed events
-   */
-  events?: Array<string> | null;
-
-  /**
-   * Service that receives the webhook
-   */
-  service?: string | null;
-}
-
-/**
- * Response after attempting test delivery.
- */
-export interface HookTestResponse {
-  /**
-   * The hook ID
-   */
-  id: string;
-
-  /**
-   * Whether delivery succeeded (2xx)
-   */
-  success: boolean;
-
-  /**
-   * Error message if delivery failed
-   */
-  error?: string | null;
-
-  /**
-   * HTTP status from target
-   */
-  statusCode?: number | null;
-}
-
-/**
- * Response model after successful unsubscription.
- */
-export interface HookUnsubscribeResponse {
-  /**
-   * The subscription ID
-   */
-  id: string;
-
-  /**
-   * Whether unsubscription was successful
-   */
-  unsubscribed: boolean;
-}
-
-export interface HookUpdateParams {
-  /**
-   * Updated list of events to subscribe to
-   */
-  events?: Array<string> | null;
-
-  /**
-   * Updated hook state (active, disabled, deleted)
-   */
-  state?: string | null;
-}
-
-export interface HookListParams {
-  orderBy?: string | null;
-
-  orderByDirection?: 'asc' | 'desc';
-
-  page?: number;
-
-  pageSize?: number;
-}
-
-export interface HookPerformParams {
-  body: { [key: string]: unknown };
-}
-
-export interface HookSubscribeParams {
-  /**
-   * The webhook URL to send notifications to
-   */
-  targetUrl: string;
-
-  /**
-   * List of task events to subscribe to (created, running, completed, failed,
-   * cancelled, paused)
-   */
-  events?: Array<string> | null;
-
-  /**
-   * Service that receives the webhook
-   */
-  service?: string | null;
-}
-
-export interface HookTestParams {
-  /**
-   * Event type to simulate (default: completed)
-   */
-  event?: string | null;
-}
-
-export declare namespace Hooks {
-  export {
-    type HookRetrieveResponse as HookRetrieveResponse,
-    type HookUpdateResponse as HookUpdateResponse,
-    type HookListResponse as HookListResponse,
-    type HookGetSampleDataResponse as HookGetSampleDataResponse,
-    type HookPerformResponse as HookPerformResponse,
-    type HookSubscribeResponse as HookSubscribeResponse,
-    type HookTestResponse as HookTestResponse,
-    type HookUnsubscribeResponse as HookUnsubscribeResponse,
-    type HookUpdateParams as HookUpdateParams,
-    type HookListParams as HookListParams,
-    type HookPerformParams as HookPerformParams,
-    type HookSubscribeParams as HookSubscribeParams,
-    type HookTestParams as HookTestParams,
-  };
-}
+export class Hooks extends APIResource {}

package/src/resources/index.ts

@@ -44,26 +44,13 @@ export {
   type DeviceSetNameParams,
   type DeviceTerminateParams,
 } from './devices/devices';
-export {
-  Hooks,
-  type HookRetrieveResponse,
-  type HookUpdateResponse,
-  type HookListResponse,
-  type HookGetSampleDataResponse,
-  type HookPerformResponse,
-  type HookSubscribeResponse,
-  type HookTestResponse,
-  type HookUnsubscribeResponse,
-  type HookUpdateParams,
-  type HookListParams,
-  type HookPerformParams,
-  type HookSubscribeParams,
-  type HookTestParams,
-} from './hooks';
+export { Hooks } from './hooks';
 export { Models, type ModelListResponse } from './models';
 export {
   Profiles,
-  type Profile,
+  type ProfileCreateResponse,
+  type ProfileRetrieveResponse,
+  type ProfileUpdateResponse,
   type ProfileListResponse,
   type ProfileDeleteResponse,
   type ProfileCreateParams,

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

@@ -5,26 +5,30 @@ 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 +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 = {},
@@ -45,7 +50,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);

package/src/resources/shared.ts

@@ -79,12 +79,29 @@ export interface DeviceSpec {
 
 export namespace DeviceSpec {
   export interface Proxy {
+    connect?: Proxy.Connect;
+
     name?: string;
 
     smartIp?: boolean;
 
     socks5?: Shared.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 Location {