@mobilerun/sdk 5.5.0 → 6.0.0

package/src/resources/numbers/numbers.ts

@@ -3,9 +3,14 @@
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import * as MessagesAPI from './messages';
-import { MessageListParams, MessageListResponse, Messages } from './messages';
+import {
+  MessageListParams,
+  MessageListResponse,
+  MessageSendParams,
+  MessageSendResponse,
+  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';
 
@@ -14,7 +19,7 @@ export class Numbers extends APIResource {
 
   /**
    * Starts a phone-number purchase. Poll the returned phone number for status
-   * updates. `purpose` and `country` cannot be combined.
+   * updates.
    *
    * @example
    * ```ts
@@ -22,18 +27,10 @@ export class Numbers extends APIResource {
    * ```
    */
   create(
-    params: NumberCreateParams | null | undefined = {},
+    body: 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,
-      ]),
-    });
+    return this._client.post('/numbers/phones', { body, ...options });
   }
 
   /**
@@ -126,18 +123,6 @@ export class Numbers extends APIResource {
   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 {
@@ -162,10 +147,21 @@ export namespace NumberRetrieveResponse {
   export interface Data {
     id: string;
 
+    /**
+     * Actions currently available for this phone number.
+     */
+    actions: Data.Actions;
+
     cancelAtPeriodEnd: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.cancel`
+     */
     cancellable: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.send`
+     */
     canSend: boolean;
 
     capabilities: Array<'sms' | 'voice'> | null;
@@ -178,6 +174,13 @@ export namespace NumberRetrieveResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * Why setup failed. Null unless state is failed, and null when the failure has no
+     * classified reason. out_of_stock: no number is currently available for the
+     * requested country.
+     */
+    failureReason: 'out_of_stock' | 'unknown' | null;
+
     label: string | null;
 
     phoneNumber: string | null;
@@ -188,6 +191,26 @@ export namespace NumberRetrieveResponse {
 
     updatedAt: string | null;
   }
+
+  export namespace Data {
+    /**
+     * Actions currently available for this phone number.
+     */
+    export interface Actions {
+      /**
+       * True when DELETE /numbers/phones/{id} would currently succeed.
+       */
+      cancel: boolean;
+
+      /**
+       * True when this number passes the send gate of POST
+       * /numbers/phones/{id}/messages: self-service sending is switched on and the
+       * number is active and able to send SMS. Daily and burst limits and recipient/body
+       * checks still apply; the send endpoint stays the final judge.
+       */
+      send: boolean;
+    }
+  }
 }
 
 export interface NumberUpdateResponse {
@@ -198,10 +221,21 @@ export namespace NumberUpdateResponse {
   export interface Data {
     id: string;
 
+    /**
+     * Actions currently available for this phone number.
+     */
+    actions: Data.Actions;
+
     cancelAtPeriodEnd: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.cancel`
+     */
     cancellable: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.send`
+     */
     canSend: boolean;
 
     capabilities: Array<'sms' | 'voice'> | null;
@@ -214,6 +248,13 @@ export namespace NumberUpdateResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * Why setup failed. Null unless state is failed, and null when the failure has no
+     * classified reason. out_of_stock: no number is currently available for the
+     * requested country.
+     */
+    failureReason: 'out_of_stock' | 'unknown' | null;
+
     label: string | null;
 
     phoneNumber: string | null;
@@ -224,6 +265,26 @@ export namespace NumberUpdateResponse {
 
     updatedAt: string | null;
   }
+
+  export namespace Data {
+    /**
+     * Actions currently available for this phone number.
+     */
+    export interface Actions {
+      /**
+       * True when DELETE /numbers/phones/{id} would currently succeed.
+       */
+      cancel: boolean;
+
+      /**
+       * True when this number passes the send gate of POST
+       * /numbers/phones/{id}/messages: self-service sending is switched on and the
+       * number is active and able to send SMS. Daily and burst limits and recipient/body
+       * checks still apply; the send endpoint stays the final judge.
+       */
+      send: boolean;
+    }
+  }
 }
 
 export interface NumberListResponse {
@@ -236,10 +297,21 @@ export namespace NumberListResponse {
   export interface Item {
     id: string;
 
+    /**
+     * Actions currently available for this phone number.
+     */
+    actions: Item.Actions;
+
     cancelAtPeriodEnd: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.cancel`
+     */
     cancellable: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.send`
+     */
     canSend: boolean;
 
     capabilities: Array<'sms' | 'voice'> | null;
@@ -252,6 +324,13 @@ export namespace NumberListResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * Why setup failed. Null unless state is failed, and null when the failure has no
+     * classified reason. out_of_stock: no number is currently available for the
+     * requested country.
+     */
+    failureReason: 'out_of_stock' | 'unknown' | null;
+
     label: string | null;
 
     phoneNumber: string | null;
@@ -262,6 +341,26 @@ export namespace NumberListResponse {
 
     updatedAt: string | null;
   }
+
+  export namespace Item {
+    /**
+     * Actions currently available for this phone number.
+     */
+    export interface Actions {
+      /**
+       * True when DELETE /numbers/phones/{id} would currently succeed.
+       */
+      cancel: boolean;
+
+      /**
+       * True when this number passes the send gate of POST
+       * /numbers/phones/{id}/messages: self-service sending is switched on and the
+       * number is active and able to send SMS. Daily and burst limits and recipient/body
+       * checks still apply; the send endpoint stays the final judge.
+       */
+      send: boolean;
+    }
+  }
 }
 
 export interface NumberDeleteResponse {
@@ -272,10 +371,21 @@ export namespace NumberDeleteResponse {
   export interface Data {
     id: string;
 
+    /**
+     * Actions currently available for this phone number.
+     */
+    actions: Data.Actions;
+
     cancelAtPeriodEnd: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.cancel`
+     */
     cancellable: boolean;
 
+    /**
+     * @deprecated Deprecated: use `actions.send`
+     */
     canSend: boolean;
 
     capabilities: Array<'sms' | 'voice'> | null;
@@ -288,6 +398,13 @@ export namespace NumberDeleteResponse {
 
     currentPeriodEnd: string | null;
 
+    /**
+     * Why setup failed. Null unless state is failed, and null when the failure has no
+     * classified reason. out_of_stock: no number is currently available for the
+     * requested country.
+     */
+    failureReason: 'out_of_stock' | 'unknown' | null;
+
     label: string | null;
 
     phoneNumber: string | null;
@@ -298,6 +415,26 @@ export namespace NumberDeleteResponse {
 
     updatedAt: string | null;
   }
+
+  export namespace Data {
+    /**
+     * Actions currently available for this phone number.
+     */
+    export interface Actions {
+      /**
+       * True when DELETE /numbers/phones/{id} would currently succeed.
+       */
+      cancel: boolean;
+
+      /**
+       * True when this number passes the send gate of POST
+       * /numbers/phones/{id}/messages: self-service sending is switched on and the
+       * number is active and able to send SMS. Daily and burst limits and recipient/body
+       * checks still apply; the send endpoint stays the final judge.
+       */
+      send: boolean;
+    }
+  }
 }
 
 export interface NumberCapacityResponse {
@@ -342,60 +479,31 @@ export namespace NumberCountriesResponse {
   }
 }
 
-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: Use included capacity when available, require included capacity
-   * without paid fallback (included_only), or start a paid checkout (rent).
+   * Use included capacity when available, require included capacity without paid
+   * fallback (included_only), or start a paid checkout (rent).
    */
   billingPreference?: 'included' | 'included_only' | 'rent';
 
   /**
-   * Body param: Optional ISO 3166-1 alpha-2 country code from GET
-   * /numbers/phones/countries. Cannot be combined with `purpose`.
+   * Optional ISO 3166-1 alpha-2 country code from GET /numbers/phones/countries.
    */
   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.
+   * 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.
    */
   label?: string | null;
-
-  /**
-   * Body param: Optional purpose from GET /numbers/phones/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.
+   * routing.
    */
   label?: string | null;
 }
@@ -424,7 +532,6 @@ export declare namespace Numbers {
     type NumberDeleteResponse as NumberDeleteResponse,
     type NumberCapacityResponse as NumberCapacityResponse,
     type NumberCountriesResponse as NumberCountriesResponse,
-    type NumberPurposesResponse as NumberPurposesResponse,
     type NumberCreateParams as NumberCreateParams,
     type NumberUpdateParams as NumberUpdateParams,
     type NumberListParams as NumberListParams,
@@ -434,6 +541,8 @@ export declare namespace Numbers {
   export {
     Messages as Messages,
     type MessageListResponse as MessageListResponse,
+    type MessageSendResponse as MessageSendResponse,
     type MessageListParams as MessageListParams,
+    type MessageSendParams as MessageSendParams,
   };
 }

package/src/resources/proxies.ts

@@ -57,13 +57,6 @@ export class Proxies extends APIResource {
   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 interface ProxyCreateResponse {
@@ -158,85 +151,6 @@ export namespace ProxyDeleteResponse {
   }
 }
 
-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 {
@@ -293,28 +207,6 @@ 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 ProxyCreateResponse as ProxyCreateResponse,
@@ -322,10 +214,8 @@ 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,
   };
 }