@mobilerun/sdk 5.2.0 → 5.3.0

package/src/resources/numbers/numbers.ts

@@ -0,0 +1,415 @@
+// 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 MessagesAPI from './messages';
+import { MessageListParams, MessageListResponse, Messages } from './messages';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Numbers extends APIResource {
+  messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
+
+  /**
+   * Starts a Mobilerun Phone purchase for the authenticated owner. Accepted requests
+   * always return the same asynchronous envelope; poll GET /numbers/phones/{id} for
+   * its business state. `purpose` and `country` are mutually exclusive.
+   *
+   * @example
+   * ```ts
+   * const number = await client.numbers.create();
+   * ```
+   */
+  create(
+    params: NumberCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params ?? {};
+    return this._client.post('/numbers/phones', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieves a single phone number.
+   *
+   * @example
+   * ```ts
+   * const number = await client.numbers.retrieve(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<NumberRetrieveResponse> {
+    return this._client.get(path`/numbers/phones/${id}`, options);
+  }
+
+  /**
+   * Updates the phone number's user-defined display label. Omitting `label` leaves
+   * it unchanged; setting it to null or an empty string clears it. The label is
+   * capped at 100 characters, is display-only, and never affects routing. It also
+   * seeds the billing entity name when set at purchase time; a later change here
+   * does not rename the already-created billing entity.
+   *
+   * @example
+   * ```ts
+   * const number = await client.numbers.update(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    body: NumberUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberUpdateResponse> {
+    return this._client.patch(path`/numbers/phones/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists phone numbers owned by the authenticated user — both BYO (`user`) and
+   * provisioned (`mobilerun`) numbers.
+   *
+   * @example
+   * ```ts
+   * const numbers = await client.numbers.list();
+   * ```
+   */
+  list(
+    query: NumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<NumberListResponse> {
+    return this._client.get('/numbers/phones', { query, ...options });
+  }
+
+  /**
+   * Cancels a Mobilerun Phone. The outcome depends on the number's current state:
+   *
+   * - If the number is still awaiting payment and no payment for it is currently
+   *   being processed, the checkout is closed immediately and the number is retired.
+   * - If the number is on the standard paid plan and already paid and in service,
+   *   cancellation is scheduled for the end of the current billing period rather
+   *   than taking effect immediately. The number stays usable through the period
+   *   already paid for, with no partial refund. Calling this again while a
+   *   cancellation is already scheduled is a no-op that returns the same result. The
+   *   response's `state` reflects this as `cancel_scheduled` with
+   *   `cancelAtPeriodEnd: true`; `currentPeriodEnd` is populated once billing
+   *   confirms the cancellation.
+   *
+   * Any other state (already refunding, a permanent billing failure, a payment
+   * currently being processed, an included-plan number, or a non-hosted/BYO number)
+   * returns 409 `not_cancellable`. Returns 404 if the number doesn't exist or isn't
+   * owned by the caller.
+   *
+   * @example
+   * ```ts
+   * const number = await client.numbers.delete(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<NumberDeleteResponse> {
+    return this._client.delete(path`/numbers/phones/${id}`, options);
+  }
+
+  /**
+   * Lists the countries currently offered for a dedicated Mobilerun Phone, with live
+   * stock status. Pass `country` as the `country` field on POST /numbers/phones.
+   *
+   * @example
+   * ```ts
+   * const response = await client.numbers.countries();
+   * ```
+   */
+  countries(options?: RequestOptions): APIPromise<NumberCountriesResponse> {
+    return this._client.get('/numbers/phones/countries', options);
+  }
+
+  /**
+   * Lists the optional purposes currently available for a Mobilerun Phone.
+   *
+   * @example
+   * ```ts
+   * const response = await client.numbers.purposes();
+   * ```
+   */
+  purposes(options?: RequestOptions): APIPromise<NumberPurposesResponse> {
+    return this._client.get('/numbers/phones/purposes', options);
+  }
+}
+
+export interface NumberCreateResponse {
+  data: NumberCreateResponse.Data;
+}
+
+export namespace NumberCreateResponse {
+  export interface Data {
+    checkoutUrl: string | null;
+
+    numberId: string;
+
+    state: 'awaiting_payment' | 'provisioning';
+  }
+}
+
+export interface NumberRetrieveResponse {
+  data: NumberRetrieveResponse.Data;
+}
+
+export namespace NumberRetrieveResponse {
+  export interface Data {
+    id: string;
+
+    cancelAtPeriodEnd: boolean;
+
+    cancellable: boolean;
+
+    canSend: boolean;
+
+    capabilities: Array<'sms' | 'voice'> | null;
+
+    checkoutUrl: string | null;
+
+    countryCode: string | null;
+
+    createdAt: string | null;
+
+    currentPeriodEnd: string | null;
+
+    label: string | null;
+
+    phoneNumber: string | null;
+
+    purpose: string | null;
+
+    state: 'awaiting_payment' | 'provisioning' | 'active' | 'cancel_scheduled' | 'expired' | 'failed';
+
+    updatedAt: string | null;
+  }
+}
+
+export interface NumberUpdateResponse {
+  data: NumberUpdateResponse.Data;
+}
+
+export namespace NumberUpdateResponse {
+  export interface Data {
+    id: string;
+
+    cancelAtPeriodEnd: boolean;
+
+    cancellable: boolean;
+
+    canSend: boolean;
+
+    capabilities: Array<'sms' | 'voice'> | null;
+
+    checkoutUrl: string | null;
+
+    countryCode: string | null;
+
+    createdAt: string | null;
+
+    currentPeriodEnd: string | null;
+
+    label: string | null;
+
+    phoneNumber: string | null;
+
+    purpose: string | null;
+
+    state: 'awaiting_payment' | 'provisioning' | 'active' | 'cancel_scheduled' | 'expired' | 'failed';
+
+    updatedAt: string | null;
+  }
+}
+
+export interface NumberListResponse {
+  items: Array<NumberListResponse.Item>;
+
+  pagination: Shared.Pagination;
+}
+
+export namespace NumberListResponse {
+  export interface Item {
+    id: string;
+
+    cancelAtPeriodEnd: boolean;
+
+    cancellable: boolean;
+
+    canSend: boolean;
+
+    capabilities: Array<'sms' | 'voice'> | null;
+
+    checkoutUrl: string | null;
+
+    countryCode: string | null;
+
+    createdAt: string | null;
+
+    currentPeriodEnd: string | null;
+
+    label: string | null;
+
+    phoneNumber: string | null;
+
+    purpose: string | null;
+
+    state: 'awaiting_payment' | 'provisioning' | 'active' | 'cancel_scheduled' | 'expired' | 'failed';
+
+    updatedAt: string | null;
+  }
+}
+
+export interface NumberDeleteResponse {
+  data: NumberDeleteResponse.Data;
+}
+
+export namespace NumberDeleteResponse {
+  export interface Data {
+    id: string;
+
+    cancelAtPeriodEnd: boolean;
+
+    cancellable: boolean;
+
+    canSend: boolean;
+
+    capabilities: Array<'sms' | 'voice'> | null;
+
+    checkoutUrl: string | null;
+
+    countryCode: string | null;
+
+    createdAt: string | null;
+
+    currentPeriodEnd: string | null;
+
+    label: string | null;
+
+    phoneNumber: string | null;
+
+    purpose: string | null;
+
+    state: 'awaiting_payment' | 'provisioning' | 'active' | 'cancel_scheduled' | 'expired' | 'failed';
+
+    updatedAt: string | null;
+  }
+}
+
+export interface NumberCountriesResponse {
+  data: NumberCountriesResponse.Data;
+}
+
+export namespace NumberCountriesResponse {
+  export interface Data {
+    items: Array<Data.Item>;
+  }
+
+  export namespace Data {
+    export interface Item {
+      country: string;
+
+      inStock: boolean;
+
+      name: string;
+
+      planId: string;
+    }
+  }
+}
+
+export interface NumberPurposesResponse {
+  data: NumberPurposesResponse.Data;
+}
+
+export namespace NumberPurposesResponse {
+  export interface Data {
+    items: Array<Data.Item>;
+  }
+
+  export namespace Data {
+    export interface Item {
+      label: string;
+
+      slug: string;
+    }
+  }
+}
+
+export interface NumberCreateParams {
+  /**
+   * Body param: Prefer a free package seat ('included', default) or force the paid
+   * checkout ('rent')
+   */
+  billingPreference?: 'included' | 'rent';
+
+  /**
+   * Body param: Optional ISO 3166-1 alpha-2 country code from GET
+   * /numbers/countries. Cannot be combined with `purpose`.
+   */
+  country?: string;
+
+  /**
+   * Body param: User-defined display label — NFC-normalized, up to 100 GRAPHEMES
+   * (not UTF-16 code units; an emoji/flag may span several). Display-only, never
+   * used for routing. Also seeds the billing entity name at purchase.
+   */
+  label?: string | null;
+
+  /**
+   * Body param: Optional Mobilerun Phone purpose slug from GET /numbers/purposes.
+   */
+  purpose?: string;
+
+  /**
+   * Header param: Optional request idempotency key.
+   */
+  'Idempotency-Key'?: string;
+}
+
+export interface NumberUpdateParams {
+  /**
+   * User-defined display label — NFC-normalized, up to 100 GRAPHEMES (not UTF-16
+   * code units; an emoji/flag may span several). Display-only, never used for
+   * routing. Also seeds the billing entity name at purchase.
+   */
+  label?: string | null;
+}
+
+export interface NumberListParams {
+  page?: number;
+
+  pageSize?: number;
+}
+
+Numbers.Messages = Messages;
+
+export declare namespace Numbers {
+  export {
+    type NumberCreateResponse as NumberCreateResponse,
+    type NumberRetrieveResponse as NumberRetrieveResponse,
+    type NumberUpdateResponse as NumberUpdateResponse,
+    type NumberListResponse as NumberListResponse,
+    type NumberDeleteResponse as NumberDeleteResponse,
+    type NumberCountriesResponse as NumberCountriesResponse,
+    type NumberPurposesResponse as NumberPurposesResponse,
+    type NumberCreateParams as NumberCreateParams,
+    type NumberUpdateParams as NumberUpdateParams,
+    type NumberListParams as NumberListParams,
+  };
+
+  export {
+    Messages as Messages,
+    type MessageListResponse as MessageListResponse,
+    type MessageListParams as MessageListParams,
+  };
+}

package/src/resources/numbers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './numbers/index';

package/src/resources/proxies.ts

@@ -1,6 +1,7 @@
 // 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';
@@ -65,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;
 
@@ -95,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.
@@ -286,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;
 
@@ -85,7 +83,7 @@ export namespace DeviceSpec {
 
     smartIp?: boolean;
 
-    socks5?: Shared.Socks5;
+    socks5?: Proxy.Socks5;
   }
 
   export namespace Proxy {
@@ -101,6 +99,16 @@ export namespace DeviceSpec {
        */
       country?: string;
     }
+
+    export interface Socks5 {
+      host: string;
+
+      password: string;
+
+      port: number;
+
+      user: string;
+    }
   }
 }
 
@@ -186,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;
 }