telnyx 5.50.0 → 6.2.0

package/src/resources/messaging-tollfree/verification/requests.ts

@@ -12,6 +12,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage your tollfree verification requests
+ */
 export class Requests extends APIResource {
   /**
    * Submit a new tollfree verification request

package/src/resources/messaging-url-domains.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Messaging URL Domains
+ */
 export class MessagingURLDomains extends APIResource {
   /**
    * List messaging URL domains

package/src/resources/mobile-network-operators.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Mobile network operators operations
+ */
 export class MobileNetworkOperators extends APIResource {
   /**
    * Telnyx has a set of GSM mobile operators partners that are available through our

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

@@ -14,6 +14,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Mobile phone number operations
+ */
 export class MobilePhoneNumbers extends APIResource {
   messaging: MessagingAPI.Messaging = new MessagingAPI.Messaging(this._client);
 

package/src/resources/mobile-push-credentials.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Mobile push credential management
+ */
 export class MobilePushCredentials extends APIResource {
   /**
    * Creates a new mobile push credential

package/src/resources/mobile-voice-connections.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Mobile voice connection operations
+ */
 export class MobileVoiceConnections extends APIResource {
   /**
    * Create a Mobile Voice Connection

package/src/resources/networks/default-gateway.ts

@@ -8,6 +8,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Network operations
+ */
 export class DefaultGateway extends APIResource {
   /**
    * Create Default Gateway.

package/src/resources/networks/networks.ts

@@ -16,6 +16,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Network operations
+ */
 export class Networks extends APIResource {
   defaultGateway: DefaultGatewayAPI.DefaultGateway = new DefaultGatewayAPI.DefaultGateway(this._client);
 

package/src/resources/notification-channels.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Notification settings operations
+ */
 export class NotificationChannels extends APIResource {
   /**
    * Create a notification channel.

package/src/resources/notification-event-conditions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Notification settings operations
+ */
 export class NotificationEventConditions extends APIResource {
   /**
    * Returns a list of your notifications events conditions.

package/src/resources/notification-events.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Notification settings operations
+ */
 export class NotificationEvents extends APIResource {
   /**
    * Returns a list of your notifications events.

package/src/resources/notification-profiles.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Notification settings operations
+ */
 export class NotificationProfiles extends APIResource {
   /**
    * Create a notification profile.

package/src/resources/notification-settings.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Notification settings operations
+ */
 export class NotificationSettings extends APIResource {
   /**
    * Add a notification setting.

package/src/resources/number-lookup.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Look up phone number data
+ */
 export class NumberLookup extends APIResource {
   /**
    * Returns information about the provided phone number.

package/src/resources/number-orders.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Number orders
+ */
 export class NumberOrders extends APIResource {
   /**
    * Creates a phone number order.

package/src/resources/number-reservations/actions.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number reservations
+ */
 export class Actions extends APIResource {
   /**
    * Extends reservation expiry time on all phone numbers.

package/src/resources/number-reservations/number-reservations.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Number reservations
+ */
 export class NumberReservations extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 

package/src/resources/operator-connect/actions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * External Connections operations
+ */
 export class Actions extends APIResource {
   /**
    * This endpoint will make an asynchronous request to refresh the Operator Connect

package/src/resources/organizations/users/actions.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to users in your organization
+ */
 export class Actions extends APIResource {
   /**
    * Deletes a user in your organization.

package/src/resources/organizations/users/users.ts

@@ -14,6 +14,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Operations related to users in your organization
+ */
 export class Users extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 

package/src/resources/ota-updates.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * OTA updates operations
+ */
 export class OtaUpdates extends APIResource {
   /**
    * This API returns the details of an Over the Air (OTA) update.

package/src/resources/outbound-voice-profiles.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Outbound voice profiles operations
+ */
 export class OutboundVoiceProfiles extends APIResource {
   /**
    * Create an outbound voice profile.

package/src/resources/payment/auto-recharge-prefs.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * V2 Auto Recharge Preferences API
+ */
 export class AutoRechargePrefs extends APIResource {
   /**
    * Update payment auto recharge preferences.

package/src/resources/payment/payment.ts

@@ -12,6 +12,9 @@ import {
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Operations for managing stored payment transactions.
+ */
 export class Payment extends APIResource {
   autoRechargePrefs: AutoRechargePrefsAPI.AutoRechargePrefs = new AutoRechargePrefsAPI.AutoRechargePrefs(
     this._client,

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

@@ -7,6 +7,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Background jobs performed over a phone-numbers block's phone numbers
+ */
 export class Jobs extends APIResource {
   /**
    * Retrieves a phone number blocks job

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

@@ -7,6 +7,9 @@ import { DefaultFlatPagination } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Configure your phone numbers
+ */
 export class Actions extends APIResource {
   /**
    * Change the bundle status for a phone number (set to being in a bundle or remove

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

@@ -9,6 +9,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Background jobs performed over a batch of phone numbers
+ */
 export class Jobs extends APIResource {
   /**
    * Retrieve a phone numbers job

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

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Configure your phone numbers
+ */
 export class Messaging extends APIResource {
   /**
    * Retrieve a phone number with messaging settings

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

@@ -73,6 +73,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Configure your phone numbers
+ */
 export class PhoneNumbers extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
   csvDownloads: CsvDownloadsAPI.CsvDownloads = new CsvDownloadsAPI.CsvDownloads(this._client);

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

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Configure your phone numbers
+ */
 export class Voice extends APIResource {
   /**
    * Retrieve a phone number with voice settings

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

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Voicemail API
+ */
 export class Voicemail extends APIResource {
   /**
    * Create voicemail settings for a phone number

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

@@ -5,6 +5,9 @@ import * as AuthenticationProvidersAPI from './authentication-providers';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Regulatory Requirements
+ */
 export class PhoneNumbersRegulatoryRequirements extends APIResource {
   /**
    * Retrieve regulatory requirements for a list of phone numbers

package/src/resources/portability-checks.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Determining portability of phone numbers
+ */
 export class PortabilityChecks extends APIResource {
   /**
    * Runs a portability check, returning the results immediately.

package/src/resources/porting/events.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class Events extends APIResource {
   /**
    * Show a specific porting event.
@@ -78,14 +81,7 @@ export interface PortingEventDeletedPayload {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.deleted';
 
   payload?: PortingEventDeletedPayload.Payload;
 
@@ -153,14 +149,7 @@ export interface PortingEventMessagingChangedPayload {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.messaging_changed';
 
   /**
    * The webhook payload for the porting_order.messaging_changed event
@@ -270,14 +259,7 @@ export interface PortingEventNewCommentEvent {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.new_comment';
 
   /**
    * The webhook payload for the porting_order.new_comment event
@@ -378,14 +360,7 @@ export interface PortingEventSplitEvent {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.split';
 
   /**
    * The webhook payload for the porting_order.split event
@@ -483,14 +458,7 @@ export interface PortingEventStatusChangedEvent {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.status_changed';
 
   /**
    * The webhook payload for the porting_order.status_changed event
@@ -574,14 +542,7 @@ export interface PortingEventWithoutWebhook {
   /**
    * Identifies the event type
    */
-  event_type?:
-    | 'porting_order.deleted'
-    | 'porting_order.loa_updated'
-    | 'porting_order.messaging_changed'
-    | 'porting_order.status_changed'
-    | 'porting_order.sharing_token_expired'
-    | 'porting_order.new_comment'
-    | 'porting_order.split';
+  event_type?: 'porting_order.loa_updated' | 'porting_order.sharing_token_expired';
 
   payload?: null;
 

package/src/resources/porting/loa-configurations.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class LoaConfigurations extends APIResource {
   /**
    * Create a LOA configuration.

package/src/resources/porting/porting.ts

@@ -42,6 +42,9 @@ import {
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class Porting extends APIResource {
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
   reports: ReportsAPI.Reports = new ReportsAPI.Reports(this._client);

package/src/resources/porting/reports.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class Reports extends APIResource {
   /**
    * Generate reports about porting operations.

package/src/resources/porting-orders/action-requirements.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class ActionRequirements extends APIResource {
   /**
    * Returns a list of action requirements for a specific porting order.

package/src/resources/porting-orders/actions.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class Actions extends APIResource {
   /**
    * Activate each number in a porting order asynchronously. This operation is

package/src/resources/porting-orders/activation-jobs.ts

@@ -8,6 +8,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class ActivationJobs extends APIResource {
   /**
    * Returns a porting activation job.

package/src/resources/porting-orders/additional-documents.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class AdditionalDocuments extends APIResource {
   /**
    * Creates a list of additional documents for a porting order.

package/src/resources/porting-orders/associated-phone-numbers.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class AssociatedPhoneNumbers extends APIResource {
   /**
    * Creates a new associated phone number for a porting order. This is used for

package/src/resources/porting-orders/comments.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class Comments extends APIResource {
   /**
    * Creates a new comment for a porting order.

package/src/resources/porting-orders/phone-number-blocks.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class PhoneNumberBlocks extends APIResource {
   /**
    * Creates a new phone number block.

package/src/resources/porting-orders/phone-number-configurations.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class PhoneNumberConfigurations extends APIResource {
   /**
    * Creates a list of phone number configurations.

package/src/resources/porting-orders/phone-number-extensions.ts

@@ -6,6 +6,9 @@ import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class PhoneNumberExtensions extends APIResource {
   /**
    * Creates a new phone number extension.

package/src/resources/porting-orders/porting-orders.ts

@@ -108,6 +108,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class PortingOrders extends APIResource {
   phoneNumberConfigurations: PhoneNumberConfigurationsAPI.PhoneNumberConfigurations =
     new PhoneNumberConfigurationsAPI.PhoneNumberConfigurations(this._client);

package/src/resources/porting-orders/verification-codes.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class VerificationCodes extends APIResource {
   /**
    * Returns a list of verification codes for a porting order.

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

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints related to porting orders management.
+ */
 export class PortingPhoneNumbers extends APIResource {
   /**
    * Returns a list of your porting phone numbers.