telnyx 7.2.0 → 7.5.0

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

@@ -84,38 +84,6 @@ export class PhoneNumbers extends APIResource {
   voice: VoiceAPI.Voice = new VoiceAPI.Voice(this._client);
   voicemail: VoicemailAPI.Voicemail = new VoicemailAPI.Voicemail(this._client);
 
-  /**
-   * Retrieve a phone number
-   *
-   * @example
-   * ```ts
-   * const phoneNumber = await client.phoneNumbers.retrieve(
-   *   '1293384261075731499',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PhoneNumberRetrieveResponse> {
-    return this._client.get(path`/phone_numbers/${id}`, options);
-  }
-
-  /**
-   * Update a phone number
-   *
-   * @example
-   * ```ts
-   * const phoneNumber = await client.phoneNumbers.update(
-   *   '1293384261075731499',
-   * );
-   * ```
-   */
-  update(
-    phoneNumberID: string,
-    body: PhoneNumberUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<PhoneNumberUpdateResponse> {
-    return this._client.patch(path`/phone_numbers/${phoneNumberID}`, { body, ...options });
-  }
-
   /**
    * List phone numbers
    *
@@ -137,20 +105,6 @@ export class PhoneNumbers extends APIResource {
     });
   }
 
-  /**
-   * Delete a phone number
-   *
-   * @example
-   * ```ts
-   * const phoneNumber = await client.phoneNumbers.delete(
-   *   '1293384261075731499',
-   * );
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<PhoneNumberDeleteResponse> {
-    return this._client.delete(path`/phone_numbers/${id}`, options);
-  }
-
   /**
    * List phone numbers, This endpoint is a lighter version of the /phone_numbers
    * endpoint having higher performance and rate limit.
@@ -173,6 +127,52 @@ export class PhoneNumbers extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Delete a phone number
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumbers.delete(
+   *   '1293384261075731499',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PhoneNumberDeleteResponse> {
+    return this._client.delete(path`/phone_numbers/${id}`, options);
+  }
+
+  /**
+   * Retrieve a phone number
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumbers.retrieve(
+   *   '1293384261075731499',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PhoneNumberRetrieveResponse> {
+    return this._client.get(path`/phone_numbers/${id}`, options);
+  }
+
+  /**
+   * Update a phone number
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumbers.update(
+   *   '1293384261075731499',
+   * );
+   * ```
+   */
+  update(
+    phoneNumberID: string,
+    body: PhoneNumberUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberUpdateResponse> {
+    return this._client.patch(path`/phone_numbers/${phoneNumberID}`, { body, ...options });
+  }
 }
 
 export type PhoneNumberDetailedsDefaultFlatPagination = DefaultFlatPagination<PhoneNumberDetailed>;
@@ -676,46 +676,6 @@ export interface PhoneNumberSlimListResponse {
   updated_at?: string;
 }
 
-export interface PhoneNumberUpdateParams {
-  /**
-   * Identifies the address associated with the phone number.
-   */
-  address_id?: string;
-
-  /**
-   * Identifies the billing group associated with the phone number.
-   */
-  billing_group_id?: string;
-
-  /**
-   * Identifies the connection associated with the phone number.
-   */
-  connection_id?: string;
-
-  /**
-   * A customer reference string for customer look ups.
-   */
-  customer_reference?: string;
-
-  /**
-   * If someone attempts to port your phone number away from Telnyx and your phone
-   * number has an external PIN set, we 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;
-
-  /**
-   * Indicates whether HD voice is enabled for this number.
-   */
-  hd_voice_enabled?: boolean;
-
-  /**
-   * A list of user-assigned tags to help organize phone numbers.
-   */
-  tags?: Array<string>;
-}
-
 export interface PhoneNumberListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[tag],
@@ -1033,6 +993,46 @@ export namespace PhoneNumberSlimListParams {
   }
 }
 
+export interface PhoneNumberUpdateParams {
+  /**
+   * Identifies the address associated with the phone number.
+   */
+  address_id?: string;
+
+  /**
+   * Identifies the billing group associated with the phone number.
+   */
+  billing_group_id?: string;
+
+  /**
+   * Identifies the connection associated with the phone number.
+   */
+  connection_id?: string;
+
+  /**
+   * A customer reference string for customer look ups.
+   */
+  customer_reference?: string;
+
+  /**
+   * If someone attempts to port your phone number away from Telnyx and your phone
+   * number has an external PIN set, we 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;
+
+  /**
+   * Indicates whether HD voice is enabled for this number.
+   */
+  hd_voice_enabled?: boolean;
+
+  /**
+   * A list of user-assigned tags to help organize phone numbers.
+   */
+  tags?: Array<string>;
+}
+
 PhoneNumbers.Actions = Actions;
 PhoneNumbers.CsvDownloads = CsvDownloads;
 PhoneNumbers.Jobs = Jobs;
@@ -1049,9 +1049,9 @@ export declare namespace PhoneNumbers {
     type PhoneNumberSlimListResponse as PhoneNumberSlimListResponse,
     type PhoneNumberDetailedsDefaultFlatPagination as PhoneNumberDetailedsDefaultFlatPagination,
     type PhoneNumberSlimListResponsesDefaultFlatPagination as PhoneNumberSlimListResponsesDefaultFlatPagination,
-    type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberSlimListParams as PhoneNumberSlimListParams,
+    type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
   };
 
   export {
@@ -1060,9 +1060,9 @@ export declare namespace PhoneNumbers {
     type ActionChangeBundleStatusResponse as ActionChangeBundleStatusResponse,
     type ActionEnableEmergencyResponse as ActionEnableEmergencyResponse,
     type ActionVerifyOwnershipResponse as ActionVerifyOwnershipResponse,
+    type ActionVerifyOwnershipParams as ActionVerifyOwnershipParams,
     type ActionChangeBundleStatusParams as ActionChangeBundleStatusParams,
     type ActionEnableEmergencyParams as ActionEnableEmergencyParams,
-    type ActionVerifyOwnershipParams as ActionVerifyOwnershipParams,
   };
 
   export {
@@ -1071,8 +1071,8 @@ export declare namespace PhoneNumbers {
     type CsvDownloadCreateResponse as CsvDownloadCreateResponse,
     type CsvDownloadRetrieveResponse as CsvDownloadRetrieveResponse,
     type CsvDownloadsDefaultFlatPagination as CsvDownloadsDefaultFlatPagination,
-    type CsvDownloadCreateParams as CsvDownloadCreateParams,
     type CsvDownloadListParams as CsvDownloadListParams,
+    type CsvDownloadCreateParams as CsvDownloadCreateParams,
   };
 
   export {
@@ -1085,16 +1085,16 @@ export declare namespace PhoneNumbers {
     type PhoneNumbersJobsDefaultFlatPagination as PhoneNumbersJobsDefaultFlatPagination,
     type JobListParams as JobListParams,
     type JobDeleteBatchParams as JobDeleteBatchParams,
-    type JobUpdateBatchParams as JobUpdateBatchParams,
     type JobUpdateEmergencySettingsBatchParams as JobUpdateEmergencySettingsBatchParams,
+    type JobUpdateBatchParams as JobUpdateBatchParams,
   };
 
   export {
     Messaging as Messaging,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
     type MessagingUpdateResponse as MessagingUpdateResponse,
-    type MessagingUpdateParams as MessagingUpdateParams,
     type MessagingListParams as MessagingListParams,
+    type MessagingUpdateParams as MessagingUpdateParams,
   };
 
   export {
@@ -1106,8 +1106,8 @@ export declare namespace PhoneNumbers {
     type UpdateVoiceSettings as UpdateVoiceSettings,
     type VoiceRetrieveResponse as VoiceRetrieveResponse,
     type VoiceUpdateResponse as VoiceUpdateResponse,
-    type VoiceUpdateParams as VoiceUpdateParams,
     type VoiceListParams as VoiceListParams,
+    type VoiceUpdateParams as VoiceUpdateParams,
   };
 
   export {
@@ -1117,7 +1117,7 @@ export declare namespace PhoneNumbers {
     type VoicemailCreateResponse as VoicemailCreateResponse,
     type VoicemailRetrieveResponse as VoicemailRetrieveResponse,
     type VoicemailUpdateResponse as VoicemailUpdateResponse,
-    type VoicemailCreateParams as VoicemailCreateParams,
     type VoicemailUpdateParams as VoicemailUpdateParams,
+    type VoicemailCreateParams as VoicemailCreateParams,
   };
 }

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

@@ -12,6 +12,28 @@ import { path } from '../../internal/utils/path';
  * Configure your phone numbers
  */
 export class Voice extends APIResource {
+  /**
+   * List phone numbers with voice settings
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const phoneNumberWithVoiceSettings of client.phoneNumbers.voice.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: VoiceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PhoneNumberWithVoiceSettingsDefaultFlatPagination, ActionsAPI.PhoneNumberWithVoiceSettings> {
+    return this._client.getAPIList(
+      '/phone_numbers/voice',
+      DefaultFlatPagination<ActionsAPI.PhoneNumberWithVoiceSettings>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Retrieve a phone number with voice settings
    *
@@ -39,28 +61,6 @@ export class Voice extends APIResource {
   update(id: string, body: VoiceUpdateParams, options?: RequestOptions): APIPromise<VoiceUpdateResponse> {
     return this._client.patch(path`/phone_numbers/${id}/voice`, { body, ...options });
   }
-
-  /**
-   * List phone numbers with voice settings
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const phoneNumberWithVoiceSettings of client.phoneNumbers.voice.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: VoiceListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PhoneNumberWithVoiceSettingsDefaultFlatPagination, ActionsAPI.PhoneNumberWithVoiceSettings> {
-    return this._client.getAPIList(
-      '/phone_numbers/voice',
-      DefaultFlatPagination<ActionsAPI.PhoneNumberWithVoiceSettings>,
-      { query, ...options },
-    );
-  }
 }
 
 /**
@@ -210,58 +210,6 @@ export interface VoiceUpdateResponse {
   data?: ActionsAPI.PhoneNumberWithVoiceSettings;
 }
 
-export interface VoiceUpdateParams {
-  /**
-   * The call forwarding settings for a phone number.
-   */
-  call_forwarding?: CallForwarding;
-
-  /**
-   * The call recording settings for a phone number.
-   */
-  call_recording?: CallRecording;
-
-  /**
-   * Controls whether the caller ID name is enabled for this phone number.
-   */
-  caller_id_name_enabled?: boolean;
-
-  /**
-   * The CNAM listing settings for a phone number.
-   */
-  cnam_listing?: CnamListing;
-
-  /**
-   * 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';
-
-  /**
-   * The media features settings for a phone number.
-   */
-  media_features?: MediaFeatures;
-
-  /**
-   * Controls whether a tech prefix is enabled for this phone number.
-   */
-  tech_prefix_enabled?: boolean;
-
-  /**
-   * This field allows you to rewrite the destination number of an inbound call
-   * before the call is routed to you. The value of this field may be any
-   * alphanumeric value, and the value will replace the number originally dialed.
-   */
-  translated_number?: string;
-
-  /**
-   * Controls whether a number is billed per minute or uses your concurrent channels.
-   */
-  usage_payment_method?: 'pay-per-minute' | 'channel';
-}
-
 export interface VoiceListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -319,6 +267,58 @@ export namespace VoiceListParams {
   }
 }
 
+export interface VoiceUpdateParams {
+  /**
+   * The call forwarding settings for a phone number.
+   */
+  call_forwarding?: CallForwarding;
+
+  /**
+   * The call recording settings for a phone number.
+   */
+  call_recording?: CallRecording;
+
+  /**
+   * Controls whether the caller ID name is enabled for this phone number.
+   */
+  caller_id_name_enabled?: boolean;
+
+  /**
+   * The CNAM listing settings for a phone number.
+   */
+  cnam_listing?: CnamListing;
+
+  /**
+   * 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';
+
+  /**
+   * The media features settings for a phone number.
+   */
+  media_features?: MediaFeatures;
+
+  /**
+   * Controls whether a tech prefix is enabled for this phone number.
+   */
+  tech_prefix_enabled?: boolean;
+
+  /**
+   * This field allows you to rewrite the destination number of an inbound call
+   * before the call is routed to you. The value of this field may be any
+   * alphanumeric value, and the value will replace the number originally dialed.
+   */
+  translated_number?: string;
+
+  /**
+   * Controls whether a number is billed per minute or uses your concurrent channels.
+   */
+  usage_payment_method?: 'pay-per-minute' | 'channel';
+}
+
 export declare namespace Voice {
   export {
     type CallForwarding as CallForwarding,
@@ -328,8 +328,8 @@ export declare namespace Voice {
     type UpdateVoiceSettings as UpdateVoiceSettings,
     type VoiceRetrieveResponse as VoiceRetrieveResponse,
     type VoiceUpdateResponse as VoiceUpdateResponse,
-    type VoiceUpdateParams as VoiceUpdateParams,
     type VoiceListParams as VoiceListParams,
+    type VoiceUpdateParams as VoiceUpdateParams,
   };
 }
 

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

@@ -10,56 +10,56 @@ import { path } from '../../internal/utils/path';
  */
 export class Voicemail extends APIResource {
   /**
-   * Create voicemail settings for a phone number
+   * Returns the voicemail settings for a phone number
    *
    * @example
    * ```ts
    * const voicemail =
-   *   await client.phoneNumbers.voicemail.create(
+   *   await client.phoneNumbers.voicemail.retrieve(
    *     '123455678900',
    *   );
    * ```
    */
-  create(
-    phoneNumberID: string,
-    body: VoicemailCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<VoicemailCreateResponse> {
-    return this._client.post(path`/phone_numbers/${phoneNumberID}/voicemail`, { body, ...options });
+  retrieve(phoneNumberID: string, options?: RequestOptions): APIPromise<VoicemailRetrieveResponse> {
+    return this._client.get(path`/phone_numbers/${phoneNumberID}/voicemail`, options);
   }
 
   /**
-   * Returns the voicemail settings for a phone number
+   * Update voicemail settings for a phone number
    *
    * @example
    * ```ts
    * const voicemail =
-   *   await client.phoneNumbers.voicemail.retrieve(
+   *   await client.phoneNumbers.voicemail.update(
    *     '123455678900',
    *   );
    * ```
    */
-  retrieve(phoneNumberID: string, options?: RequestOptions): APIPromise<VoicemailRetrieveResponse> {
-    return this._client.get(path`/phone_numbers/${phoneNumberID}/voicemail`, options);
+  update(
+    phoneNumberID: string,
+    body: VoicemailUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<VoicemailUpdateResponse> {
+    return this._client.patch(path`/phone_numbers/${phoneNumberID}/voicemail`, { body, ...options });
   }
 
   /**
-   * Update voicemail settings for a phone number
+   * Create voicemail settings for a phone number
    *
    * @example
    * ```ts
    * const voicemail =
-   *   await client.phoneNumbers.voicemail.update(
+   *   await client.phoneNumbers.voicemail.create(
    *     '123455678900',
    *   );
    * ```
    */
-  update(
+  create(
     phoneNumberID: string,
-    body: VoicemailUpdateParams,
+    body: VoicemailCreateParams,
     options?: RequestOptions,
-  ): APIPromise<VoicemailUpdateResponse> {
-    return this._client.patch(path`/phone_numbers/${phoneNumberID}/voicemail`, { body, ...options });
+  ): APIPromise<VoicemailCreateResponse> {
+    return this._client.post(path`/phone_numbers/${phoneNumberID}/voicemail`, { body, ...options });
   }
 }
 
@@ -99,7 +99,7 @@ export interface VoicemailUpdateResponse {
   data?: VoicemailPrefResponse;
 }
 
-export interface VoicemailCreateParams {
+export interface VoicemailUpdateParams {
   /**
    * Whether voicemail is enabled.
    */
@@ -111,7 +111,7 @@ export interface VoicemailCreateParams {
   pin?: string;
 }
 
-export interface VoicemailUpdateParams {
+export interface VoicemailCreateParams {
   /**
    * Whether voicemail is enabled.
    */
@@ -130,7 +130,7 @@ export declare namespace Voicemail {
     type VoicemailCreateResponse as VoicemailCreateResponse,
     type VoicemailRetrieveResponse as VoicemailRetrieveResponse,
     type VoicemailUpdateResponse as VoicemailUpdateResponse,
-    type VoicemailCreateParams as VoicemailCreateParams,
     type VoicemailUpdateParams as VoicemailUpdateParams,
+    type VoicemailCreateParams as VoicemailCreateParams,
   };
 }

package/src/resources/porting/events.ts

@@ -12,20 +12,6 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class Events extends APIResource {
-  /**
-   * Show a specific porting event.
-   *
-   * @example
-   * ```ts
-   * const event = await client.porting.events.retrieve(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<EventRetrieveResponse> {
-    return this._client.get(path`/porting/events/${id}`, options);
-  }
-
   /**
    * Returns a list of all porting events.
    *
@@ -47,6 +33,20 @@ export class Events extends APIResource {
     });
   }
 
+  /**
+   * Show a specific porting event.
+   *
+   * @example
+   * ```ts
+   * const event = await client.porting.events.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EventRetrieveResponse> {
+    return this._client.get(path`/porting/events/${id}`, options);
+  }
+
   /**
    * Republish a specific porting event.
    *

package/src/resources/porting/index.ts

@@ -19,11 +19,11 @@ export {
   type LoaConfigurationCreateResponse,
   type LoaConfigurationRetrieveResponse,
   type LoaConfigurationUpdateResponse,
+  type LoaConfigurationPreview0Params,
+  type LoaConfigurationListParams,
   type LoaConfigurationCreateParams,
   type LoaConfigurationUpdateParams,
-  type LoaConfigurationListParams,
   type LoaConfigurationPreviewParams,
-  type LoaConfigurationPreview0Params,
   type PortingLoaConfigurationsDefaultFlatPagination,
 } from './loa-configurations';
 export { Porting, type PortingListUkCarriersResponse } from './porting';
@@ -33,7 +33,7 @@ export {
   type PortingReport,
   type ReportCreateResponse,
   type ReportRetrieveResponse,
-  type ReportCreateParams,
   type ReportListParams,
+  type ReportCreateParams,
   type PortingReportsDefaultFlatPagination,
 } from './reports';