telnyx 7.13.0 → 7.14.0

package/src/resources/network-coverage.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../core/resource';
 import * as NetworkCoverageAPI from './network-coverage';
-import * as Shared from './shared';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
@@ -26,13 +25,40 @@ export type NetworkCoverageListResponsesDefaultFlatPagination =
 
 export type AvailableService = 'cloud_vpn' | 'private_wireless_gateway' | 'virtual_cross_connect';
 
+export interface NetappsLocation17904fcfbc {
+  /**
+   * Location code.
+   */
+  code?: string;
+
+  /**
+   * Human readable name of location.
+   */
+  name?: string;
+
+  /**
+   * Point of presence of location.
+   */
+  pop?: string;
+
+  /**
+   * Identifies the geographical region of location.
+   */
+  region?: string;
+
+  /**
+   * Site of location.
+   */
+  site?: string;
+}
+
 export interface NetworkCoverageListResponse {
   /**
    * List of interface types supported in this region.
    */
   available_services?: Array<AvailableService>;
 
-  location?: Shared.NetappsLocation;
+  location?: NetappsLocation17904fcfbc;
 
   /**
    * Identifies the type of the resource.
@@ -110,6 +136,7 @@ export namespace NetworkCoverageListParams {
 export declare namespace NetworkCoverage {
   export {
     type AvailableService as AvailableService,
+    type NetappsLocation17904fcfbc as NetappsLocation17904fcfbc,
     type NetworkCoverageListResponse as NetworkCoverageListResponse,
     type NetworkCoverageListResponsesDefaultFlatPagination as NetworkCoverageListResponsesDefaultFlatPagination,
     type NetworkCoverageListParams as NetworkCoverageListParams,

package/src/resources/number-order-phone-numbers.ts

@@ -10,6 +10,12 @@ import { path } from '../internal/utils/path';
 export class NumberOrderPhoneNumbers extends APIResource {
   /**
    * Get a list of phone numbers associated to orders.
+   *
+   * @example
+   * ```ts
+   * const numberOrderPhoneNumbers =
+   *   await client.numberOrderPhoneNumbers.list();
+   * ```
    */
   list(
     query: NumberOrderPhoneNumberListParams | null | undefined = {},
@@ -19,7 +25,20 @@ export class NumberOrderPhoneNumbers extends APIResource {
   }
 
   /**
-   * Update requirement group for a phone number order
+   * Associates an existing requirement group with a phone number in a number order.
+   * The response contains the updated number-order phone-number details.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.numberOrderPhoneNumbers.updateRequirementGroup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       requirement_group_id:
+   *         'a4b201f9-8646-4e54-a7d2-b2e403eeaf8c',
+   *     },
+   *   );
+   * ```
    */
   updateRequirementGroup(
     id: string,
@@ -31,6 +50,14 @@ export class NumberOrderPhoneNumbers extends APIResource {
 
   /**
    * Get an existing phone number in number order.
+   *
+   * @example
+   * ```ts
+   * const numberOrderPhoneNumber =
+   *   await client.numberOrderPhoneNumbers.retrieve(
+   *     'number_order_phone_number_id',
+   *   );
+   * ```
    */
   retrieve(
     numberOrderPhoneNumberID: string,
@@ -41,6 +68,14 @@ export class NumberOrderPhoneNumbers extends APIResource {
 
   /**
    * Updates requirements for a single phone number within a number order.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.numberOrderPhoneNumbers.updateRequirements(
+   *     'number_order_phone_number_id',
+   *   );
+   * ```
    */
   updateRequirements(
     numberOrderPhoneNumberID: string,

package/src/resources/numbers-features.ts

@@ -7,6 +7,13 @@ import { RequestOptions } from '../internal/request-options';
 export class NumbersFeatures extends APIResource {
   /**
    * Retrieve the features for a list of numbers
+   *
+   * @example
+   * ```ts
+   * const numbersFeature = await client.numbersFeatures.create({
+   *   phone_numbers: ['+19705555098'],
+   * });
+   * ```
    */
   create(
     body: NumbersFeatureCreateParams,

package/src/resources/oauth-clients.ts

@@ -180,6 +180,28 @@ export interface OAuthClient {
   tos_uri?: string | null;
 }
 
+export interface OAuthOAuthPaginationMeta {
+  /**
+   * Current page number
+   */
+  page_number?: number;
+
+  /**
+   * Number of items per page
+   */
+  page_size?: number;
+
+  /**
+   * Total number of pages
+   */
+  total_pages?: number;
+
+  /**
+   * Total number of results
+   */
+  total_results?: number;
+}
+
 export interface PaginationMetaOAuth {
   /**
    * Current page number
@@ -338,6 +360,7 @@ export interface OAuthClientUpdateParams {
 export declare namespace OAuthClients {
   export {
     type OAuthClient as OAuthClient,
+    type OAuthOAuthPaginationMeta as OAuthOAuthPaginationMeta,
     type PaginationMetaOAuth as PaginationMetaOAuth,
     type OAuthClientCreateResponse as OAuthClientCreateResponse,
     type OAuthClientRetrieveResponse as OAuthClientRetrieveResponse,

package/src/resources/oauth.ts

@@ -45,8 +45,8 @@ export class OAuth extends APIResource {
    * @example
    * ```ts
    * const response = await client.oauth.grants({
-   *   allowed: true,
-   *   consent_token: 'consent_token',
+   *   allowed: false,
+   *   consent_token: 'string',
    * });
    * ```
    */
@@ -60,7 +60,7 @@ export class OAuth extends APIResource {
    * @example
    * ```ts
    * const response = await client.oauth.introspect({
-   *   token: 'token',
+   *   token: 'string',
    * });
    * ```
    */

package/src/resources/ota-updates.ts

@@ -11,7 +11,8 @@ import { path } from '../internal/utils/path';
  */
 export class OtaUpdates extends APIResource {
   /**
-   * List OTA updates
+   * Retrieve a paginated list of over-the-air (OTA) update operations for your SIM
+   * cards.
    */
   list(
     query: OtaUpdateListParams | null | undefined = {},

package/src/resources/payment/payment.ts

@@ -21,7 +21,7 @@ export class Payment extends APIResource {
   );
 
   /**
-   * Create a stored payment transaction
+   * Create a transaction that charges a stored payment method on the account.
    *
    * @example
    * ```ts

package/src/resources/phone-number-blocks/jobs.ts

@@ -12,7 +12,9 @@ import { path } from '../../internal/utils/path';
  */
 export class Jobs extends APIResource {
   /**
-   * Lists the phone number blocks jobs
+   * Returns background jobs that operate on phone-number blocks. Results can be
+   * filtered by job type and status, sorted by creation time, and include pagination
+   * metadata.
    *
    * @example
    * ```ts
@@ -58,7 +60,8 @@ export class Jobs extends APIResource {
   }
 
   /**
-   * Retrieves a phone number blocks job
+   * Returns the status and details of the phone-number-block background job
+   * identified by `id`.
    *
    * @example
    * ```ts

package/src/resources/phone-numbers/actions.ts

@@ -31,8 +31,9 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Change the bundle status for a phone number (set to being in a bundle or remove
-   * from a bundle)
+   * Adds the specified phone number to a bundle or removes it from a bundle
+   * according to the requested status change. The response contains the phone number
+   * with its updated bundle state.
    *
    * @example
    * ```ts
@@ -52,7 +53,9 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Enable emergency for a phone number
+   * Associates emergency-service settings with the specified phone number. The
+   * operation returns the updated phone-number configuration when completed
+   * immediately or an accepted state when processing continues asynchronously.
    *
    * @example
    * ```ts

package/src/resources/phone-numbers/csv-downloads.ts

@@ -8,7 +8,8 @@ import { path } from '../../internal/utils/path';
 
 export class CsvDownloads extends APIResource {
   /**
-   * List CSV downloads
+   * Returns CSV export jobs created for account phone numbers, including each
+   * export's current status and pagination metadata.
    *
    * @example
    * ```ts
@@ -29,7 +30,9 @@ export class CsvDownloads extends APIResource {
   }
 
   /**
-   * Create a CSV download
+   * Starts generation of a CSV export for phone numbers matching the supplied
+   * filters. The `csv_format` parameter selects the output format, and the response
+   * contains the resulting download record.
    *
    * @example
    * ```ts
@@ -46,7 +49,8 @@ export class CsvDownloads extends APIResource {
   }
 
   /**
-   * Retrieve a CSV download
+   * Returns the current status and download details for the CSV export identified by
+   * `id`.
    *
    * @example
    * ```ts

package/src/resources/phone-numbers/index.ts

@@ -42,6 +42,7 @@ export {
 } from './messaging';
 export {
   PhoneNumbers,
+  type NumbersPhoneNumberDetailed,
   type PhoneNumberDetailed,
   type PhoneNumberRetrieveResponse,
   type PhoneNumberUpdateResponse,
@@ -50,7 +51,7 @@ export {
   type PhoneNumberListParams,
   type PhoneNumberSlimListParams,
   type PhoneNumberUpdateParams,
-  type PhoneNumberDetailedsDefaultFlatPagination,
+  type NumbersPhoneNumberDetailedsDefaultFlatPagination,
   type PhoneNumberSlimListResponsesDefaultFlatPagination,
 } from './phone-numbers';
 export {

package/src/resources/phone-numbers/jobs.ts

@@ -14,7 +14,8 @@ import { path } from '../../internal/utils/path';
  */
 export class Jobs extends APIResource {
   /**
-   * Lists the phone numbers jobs
+   * Returns background jobs that operate on phone numbers. Results can be filtered
+   * by job type and sorted by creation time, and include pagination metadata.
    *
    * @example
    * ```ts
@@ -111,7 +112,8 @@ export class Jobs extends APIResource {
   }
 
   /**
-   * Retrieve a phone numbers job
+   * Returns the status and details of the phone-number background job identified by
+   * `id`.
    *
    * @example
    * ```ts

package/src/resources/phone-numbers/messaging.ts

@@ -13,7 +13,8 @@ import { path } from '../../internal/utils/path';
  */
 export class Messaging extends APIResource {
   /**
-   * List phone numbers with messaging settings
+   * Returns phone numbers with their current messaging product and messaging-profile
+   * assignments.
    *
    * @example
    * ```ts
@@ -38,7 +39,8 @@ export class Messaging extends APIResource {
   }
 
   /**
-   * Retrieve a phone number with messaging settings
+   * Returns the messaging product and messaging-profile assignment for the specified
+   * phone number.
    *
    * @example
    * ```ts
@@ -51,7 +53,8 @@ export class Messaging extends APIResource {
   }
 
   /**
-   * Update the messaging profile and/or messaging product of a phone number
+   * Updates the messaging product, messaging profile, or both for the specified
+   * phone number.
    *
    * @example
    * ```ts

package/src/resources/phone-numbers/phone-numbers.ts

@@ -85,12 +85,14 @@ export class PhoneNumbers extends APIResource {
   voicemail: VoicemailAPI.Voicemail = new VoicemailAPI.Voicemail(this._client);
 
   /**
-   * List phone numbers
+   * Returns phone numbers associated with the account. Results support pagination,
+   * sorting, and filters for number attributes, status, source, connections, billing
+   * groups, emergency addresses, tags, and customer references.
    *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const phoneNumberDetailed of client.phoneNumbers.list()) {
+   * for await (const numbersPhoneNumberDetailed of client.phoneNumbers.list()) {
    *   // ...
    * }
    * ```
@@ -98,8 +100,8 @@ export class PhoneNumbers extends APIResource {
   list(
     query: PhoneNumberListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<PhoneNumberDetailedsDefaultFlatPagination, PhoneNumberDetailed> {
-    return this._client.getAPIList('/phone_numbers', DefaultFlatPagination<PhoneNumberDetailed>, {
+  ): PagePromise<NumbersPhoneNumberDetailedsDefaultFlatPagination, NumbersPhoneNumberDetailed> {
+    return this._client.getAPIList('/phone_numbers', DefaultFlatPagination<NumbersPhoneNumberDetailed>, {
       query,
       ...options,
     });
@@ -129,7 +131,8 @@ export class PhoneNumbers extends APIResource {
   }
 
   /**
-   * Delete a phone number
+   * Deletes the specified phone number from the account. The response contains the
+   * phone number's final deleted representation.
    *
    * @example
    * ```ts
@@ -143,7 +146,8 @@ export class PhoneNumbers extends APIResource {
   }
 
   /**
-   * Retrieve a phone number
+   * Returns the detailed configuration and current state of the phone number
+   * identified by `id`.
    *
    * @example
    * ```ts
@@ -157,7 +161,8 @@ export class PhoneNumbers extends APIResource {
   }
 
   /**
-   * Update a phone number
+   * Updates the configurable settings of the specified phone number. The response
+   * contains the complete updated phone-number representation.
    *
    * @example
    * ```ts
@@ -175,11 +180,205 @@ export class PhoneNumbers extends APIResource {
   }
 }
 
-export type PhoneNumberDetailedsDefaultFlatPagination = DefaultFlatPagination<PhoneNumberDetailed>;
+export type NumbersPhoneNumberDetailedsDefaultFlatPagination =
+  DefaultFlatPagination<NumbersPhoneNumberDetailed>;
 
 export type PhoneNumberSlimListResponsesDefaultFlatPagination =
   DefaultFlatPagination<PhoneNumberSlimListResponse>;
 
+export interface NumbersPhoneNumberDetailed {
+  /**
+   * Identifies the resource.
+   */
+  id: string;
+
+  /**
+   * The ISO 3166-1 alpha-2 country code of the phone number.
+   */
+  country_iso_alpha2: string;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was created.
+   */
+  created_at: string;
+
+  /**
+   * Indicates whether deletion lock is enabled for this number. When enabled, this
+   * prevents the phone number from being deleted via the API or Telnyx portal.
+   */
+  deletion_lock_enabled: boolean;
+
+  /**
+   * If someone attempts to port your phone number away from Telnyx and your phone
+   * number has an external PIN set, Telnyx will attempt to verify that you provided
+   * the correct external PIN to the winning carrier. Note that not all carriers
+   * cooperate with this security mechanism.
+   */
+  external_pin: string | null;
+
+  /**
+   * The +E.164-formatted phone number associated with this record.
+   */
+  phone_number: string;
+
+  /**
+   * The phone number's type. Note: For numbers purchased prior to July 2023 or when
+   * fetching a number's details immediately after a purchase completes, the legacy
+   * values `tollfree`, `shortcode` or `longcode` may be returned instead.
+   */
+  phone_number_type:
+    | 'local'
+    | 'toll_free'
+    | 'mobile'
+    | 'national'
+    | 'shared_cost'
+    | 'landline'
+    | 'tollfree'
+    | 'shortcode'
+    | 'longcode';
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was purchased.
+   */
+  purchased_at: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type: string;
+
+  /**
+   * The phone number's current status.
+   */
+  status:
+    | 'purchase-pending'
+    | 'purchase-failed'
+    | 'port-pending'
+    | 'port-failed'
+    | 'active'
+    | 'deleted'
+    | 'emergency-only'
+    | 'ported-out'
+    | 'port-out-pending'
+    | 'requirement-info-pending'
+    | 'requirement-info-under-review'
+    | 'requirement-info-exception'
+    | 'provision-pending';
+
+  /**
+   * A list of user-assigned tags to help manage the phone number.
+   */
+  tags: Array<string>;
+
+  /**
+   * ISO 8601 formatted date indicating when the phone number was first activated
+   * (transitioned from purchase-pending or port-pending to active). Will be null for
+   * numbers that have not yet been activated, or for legacy numbers activated before
+   * this field was tracked.
+   */
+  activated_at?: string | null;
+
+  /**
+   * Identifies the billing group associated with the phone number.
+   */
+  billing_group_id?: string | null;
+
+  /**
+   * Indicates if call forwarding will be enabled for this number if forwards_to and
+   * forwarding_type are filled in. Defaults to true for backwards compatibility with
+   * APIV1 use of numbers endpoints.
+   */
+  call_forwarding_enabled?: boolean;
+
+  /**
+   * Indicates whether call recording is enabled for this number.
+   */
+  call_recording_enabled?: boolean;
+
+  /**
+   * Indicates whether caller ID is enabled for this number.
+   */
+  caller_id_name_enabled?: boolean;
+
+  /**
+   * Indicates whether a CNAM listing is enabled for this number.
+   */
+  cnam_listing_enabled?: boolean;
+
+  /**
+   * Identifies the connection associated with the phone number.
+   */
+  connection_id?: string | null;
+
+  /**
+   * The user-assigned name of the connection to be associated with this phone
+   * number.
+   */
+  connection_name?: string | null;
+
+  /**
+   * A customer reference string for customer look ups.
+   */
+  customer_reference?: string | null;
+
+  /**
+   * Identifies the emergency address associated with the phone number.
+   */
+  emergency_address_id?: string | null;
+
+  /**
+   * Indicates whether emergency services are enabled for this number.
+   */
+  emergency_enabled?: boolean;
+
+  /**
+   * Indicates the status of the provisioning of emergency services for the phone
+   * number. This field contains information about activity that may be ongoing for a
+   * number where it either is being provisioned or deprovisioned but is not yet
+   * enabled/disabled.
+   */
+  emergency_status?: 'active' | 'deprovisioning' | 'disabled' | 'provisioning' | 'provisioning-failed';
+
+  /**
+   * Indicates whether HD voice is enabled for this number.
+   */
+  hd_voice_enabled?: boolean;
+
+  /**
+   * The inbound_call_screening setting is a phone number configuration option
+   * variable that allows users to configure their settings to block or flag
+   * fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This
+   * feature has an additional per-number monthly cost associated with it.
+   */
+  inbound_call_screening?: 'disabled' | 'reject_calls' | 'flag_calls';
+
+  /**
+   * Identifies the messaging profile associated with the phone number.
+   */
+  messaging_profile_id?: string | null;
+
+  /**
+   * The name of the messaging profile associated with the phone number.
+   */
+  messaging_profile_name?: string | null;
+
+  /**
+   * Indicates if the phone number was purchased or ported in. For some numbers this
+   * information may not be available.
+   */
+  source_type?: 'number_order' | 'port_request' | null;
+
+  /**
+   * Indicates whether T38 Fax Gateway for inbound calls to this number.
+   */
+  t38_fax_gateway_enabled?: boolean;
+
+  /**
+   * ISO 8601 formatted date indicating when the resource was updated.
+   */
+  updated_at?: string;
+}
+
 export interface PhoneNumberDetailed {
   /**
    * Identifies the resource.
@@ -374,11 +573,11 @@ export interface PhoneNumberDetailed {
 }
 
 export interface PhoneNumberRetrieveResponse {
-  data?: PhoneNumberDetailed;
+  data?: NumbersPhoneNumberDetailed;
 }
 
 export interface PhoneNumberUpdateResponse {
-  data?: PhoneNumberDetailed;
+  data?: NumbersPhoneNumberDetailed;
 }
 
 export interface PhoneNumberDeleteResponse {
@@ -1066,12 +1265,13 @@ PhoneNumbers.Voicemail = Voicemail;
 
 export declare namespace PhoneNumbers {
   export {
+    type NumbersPhoneNumberDetailed as NumbersPhoneNumberDetailed,
     type PhoneNumberDetailed as PhoneNumberDetailed,
     type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse,
     type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse,
     type PhoneNumberDeleteResponse as PhoneNumberDeleteResponse,
     type PhoneNumberSlimListResponse as PhoneNumberSlimListResponse,
-    type PhoneNumberDetailedsDefaultFlatPagination as PhoneNumberDetailedsDefaultFlatPagination,
+    type NumbersPhoneNumberDetailedsDefaultFlatPagination as NumbersPhoneNumberDetailedsDefaultFlatPagination,
     type PhoneNumberSlimListResponsesDefaultFlatPagination as PhoneNumberSlimListResponsesDefaultFlatPagination,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberSlimListParams as PhoneNumberSlimListParams,

package/src/resources/phone-numbers/voice.ts

@@ -13,7 +13,9 @@ import { path } from '../../internal/utils/path';
  */
 export class Voice extends APIResource {
   /**
-   * List phone numbers with voice settings
+   * Returns account phone numbers together with their voice settings. Results
+   * support pagination, sorting, and filters for number, connection name, customer
+   * reference, and voice usage payment method.
    *
    * @example
    * ```ts
@@ -35,7 +37,8 @@ export class Voice extends APIResource {
   }
 
   /**
-   * Retrieve a phone number with voice settings
+   * Returns the specified phone number together with its current voice
+   * configuration.
    *
    * @example
    * ```ts
@@ -49,7 +52,8 @@ export class Voice extends APIResource {
   }
 
   /**
-   * Update a phone number with voice settings
+   * Updates the voice configuration for the specified phone number. The response
+   * contains the phone number with its updated voice settings.
    *
    * @example
    * ```ts