telnyx 7.12.0 → 7.14.0

package/src/resources/global-ip-assignment-health.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPAssignmentHealth extends APIResource {
   /**
-   * Global IP Assignment Health Check Metrics
+   * Retrieve health check metrics for your Global IP assignments.
    */
   retrieve(
     query: GlobalIPAssignmentHealthRetrieveParams | null | undefined = {},

package/src/resources/global-ip-assignments-usage.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPAssignmentsUsage extends APIResource {
   /**
-   * Global IP Assignment Usage Metrics
+   * Retrieve usage metrics for your Global IP assignments.
    */
   retrieve(
     query: GlobalIPAssignmentsUsageRetrieveParams | null | undefined = {},

package/src/resources/global-ip-latency.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPLatency extends APIResource {
   /**
-   * Global IP Latency Metrics
+   * Retrieve latency metrics measured for your Global IPs.
    */
   retrieve(
     query: GlobalIPLatencyRetrieveParams | null | undefined = {},

package/src/resources/global-ip-usage.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPUsage extends APIResource {
   /**
-   * Global IP Usage Metrics
+   * Retrieve usage metrics for your Global IPs.
    */
   retrieve(
     query: GlobalIPUsageRetrieveParams | null | undefined = {},

package/src/resources/index.ts

@@ -48,6 +48,7 @@ export {
 export {
   AlphanumericSenderIDs,
   type AlphanumericSenderID,
+  type MessagingPaginationMeta0b38e7044b,
   type AlphanumericSenderIDCreateResponse,
   type AlphanumericSenderIDRetrieveResponse,
   type AlphanumericSenderIDDeleteResponse,
@@ -325,6 +326,106 @@ export {
   type DynamicEmergencyEndpointCreateParams,
   type DynamicEmergencyEndpointsDefaultFlatPagination,
 } from './dynamic-emergency-endpoints';
+export {
+  EmailBlocks,
+  type EmailBlock,
+  type EmailBlockResponse,
+  type OffsetMeta,
+  type EmailBlockRetrieveEventsResponse,
+  type EmailBlockRetrieveExportResponse,
+  type EmailBlockListParams,
+  type EmailBlockCreateParams,
+  type EmailBlockRetrieveExportParams,
+  type EmailBlockRetrieveEventsParams,
+  type EmailBlocksDefaultFlatPagination,
+} from './email-blocks/email-blocks';
+export {
+  EmailDomains,
+  type DNSRecord,
+  type DomainsTrackingSettings,
+  type EmailDmarcPolicy,
+  type EmailDomain,
+  type EmailDomainResponse,
+  type EmailDomainStatus,
+  type EmailDomainType,
+  type EmailDomainVerification,
+  type EmailDomainRetrieveDNSRecordsResponse,
+  type EmailDomainRetrieveHealthResponse,
+  type EmailDomainListParams,
+  type EmailDomainCreateParams,
+  type EmailDomainDeleteParams,
+  type EmailDomainUpdateParams,
+  type EmailDomainsDefaultFlatPagination,
+} from './email-domains/email-domains';
+export {
+  EmailEvents,
+  type EmailEventType,
+  type TimeRange,
+  type EmailEventListResponse,
+  type EmailEventRetrieveStatsResponse,
+  type EmailEventListParams,
+  type EmailEventRetrieveStatsParams,
+} from './email-events';
+export {
+  EmailInboxes,
+  type EmailInbox,
+  type EmailInboxResponse,
+  type EmailInboxListResponse,
+  type EmailInboxListParams,
+  type EmailInboxCreateParams,
+} from './email-inboxes/email-inboxes';
+export {
+  EmailMessages,
+  type AttachmentRequest,
+  type EmailAddressInput,
+  type MessageEvent,
+  type TrackingSettings,
+  type EmailMessageRetrieveResponse,
+  type EmailMessageListResponse,
+  type EmailMessageBatchResponse,
+  type EmailMessageRetrieveEventsResponse,
+  type EmailMessageDeleteAllParams,
+  type EmailMessageListParams,
+  type EmailMessageCreateParams,
+  type EmailMessageBatchParams,
+  type EmailMessageRetrieveEventsParams,
+} from './email-messages/email-messages';
+export {
+  EmailTemplates,
+  type EmailTemplate,
+  type EmailTemplateResponse,
+  type UpdateEmailTemplateRequest,
+  type EmailTemplateListResponse,
+  type EmailTemplateRenderResponse,
+  type EmailTemplateListParams,
+  type EmailTemplateCreateParams,
+  type EmailTemplateReplaceParams,
+  type EmailTemplateUpdateParams,
+  type EmailTemplateRenderParams,
+} from './email-templates';
+export {
+  EmailThreads,
+  type EmailThreadRetrieveResponse,
+  type EmailThreadListParams,
+  type EmailThreadRetrieveParams,
+} from './email-threads';
+export {
+  EmailUnsubscribeGroups,
+  type GroupListMeta,
+  type UnsubscribeGroup,
+  type UnsubscribeGroupResponse,
+  type EmailUnsubscribeGroupListParams,
+  type EmailUnsubscribeGroupCreateParams,
+  type EmailUnsubscribeGroupDeleteParams,
+  type EmailUnsubscribeGroupUpdateParams,
+  type UnsubscribeGroupsDefaultFlatPagination,
+} from './email-unsubscribe-groups/email-unsubscribe-groups';
+export {
+  EmailValidations,
+  type EmailValidationCheck,
+  type EmailValidationCreateResponse,
+  type EmailValidationCreateParams,
+} from './email-validations/email-validations';
 export {
   Enterprises,
   type BillingAddress,
@@ -391,7 +492,7 @@ export {
   type FqdnConnectionCreateParams,
   type FqdnConnectionUpdateParams,
   type FqdnConnectionsDefaultFlatPagination,
-} from './fqdn-connections';
+} from './fqdn-connections/fqdn-connections';
 export {
   Fqdns,
   type Fqdn,
@@ -570,6 +671,8 @@ export {
 } from './media';
 export {
   Messages,
+  type MessagingError0b38e7044b,
+  type MessagingOutboundMessagePayload,
   type OutboundMessagePayload,
   type RcsAgentMessage,
   type RcsCardContent,
@@ -592,6 +695,7 @@ export {
   type MessageSendNumberPoolResponse,
   type MessageSendShortCodeResponse,
   type MessageSendWithAlphanumericSenderResponse,
+  type MessageWhatsappResponse,
   type MessageSendParams,
   type MessageSendLongCodeParams,
   type MessageSendNumberPoolParams,
@@ -599,6 +703,7 @@ export {
   type MessageSendGroupMmsParams,
   type MessageScheduleParams,
   type MessageSendWithAlphanumericSenderParams,
+  type MessageWhatsappParams,
 } from './messages/messages';
 export { Messaging } from './messaging/messaging';
 export { Messaging10dlc, type Messaging10dlcGetEnumResponse } from './messaging-10dlc/messaging-10dlc';
@@ -708,6 +813,7 @@ export {
 export {
   NetworkCoverage,
   type AvailableService,
+  type NetappsLocation17904fcfbc,
   type NetworkCoverageListResponse,
   type NetworkCoverageListParams,
   type NetworkCoverageListResponsesDefaultFlatPagination,
@@ -846,6 +952,7 @@ export {
 export {
   OAuthClients,
   type OAuthClient,
+  type OAuthOAuthPaginationMeta,
   type PaginationMetaOAuth,
   type OAuthClientCreateResponse,
   type OAuthClientRetrieveResponse,
@@ -896,6 +1003,7 @@ export {
 export { PhoneNumberBlocks } from './phone-number-blocks/phone-number-blocks';
 export {
   PhoneNumbers,
+  type NumbersPhoneNumberDetailed,
   type PhoneNumberDetailed,
   type PhoneNumberRetrieveResponse,
   type PhoneNumberUpdateResponse,
@@ -904,7 +1012,7 @@ export {
   type PhoneNumberListParams,
   type PhoneNumberSlimListParams,
   type PhoneNumberUpdateParams,
-  type PhoneNumberDetailedsDefaultFlatPagination,
+  type NumbersPhoneNumberDetailedsDefaultFlatPagination,
   type PhoneNumberSlimListResponsesDefaultFlatPagination,
 } from './phone-numbers/phone-numbers';
 export {
@@ -968,6 +1076,7 @@ export {
   type PortoutUpdateStatusParams,
   type PortoutDetailsDefaultFlatPagination,
 } from './portouts/portouts';
+export { Pricing } from './pricing/pricing';
 export {
   PrivateWirelessGateways,
   type PrivateWirelessGateway,
@@ -1016,12 +1125,7 @@ export {
   type QueueUpdateParams,
   type QueuesDefaultFlatPagination,
 } from './queues/queues';
-export {
-  RcsAgents,
-  type RcsAgent,
-  type RcsAgentResponse,
-  type RcsAgentsDefaultFlatPagination,
-} from './rcs-agents';
+export { Rcs } from './rcs/rcs';
 export {
   RecordingTranscriptions,
   type RecordingTranscription,
@@ -1324,11 +1428,12 @@ export {
 export {
   UserAddresses,
   type UserAddress,
+  type UserAddressesUserAddress,
   type UserAddressCreateResponse,
   type UserAddressRetrieveResponse,
   type UserAddressListParams,
   type UserAddressCreateParams,
-  type UserAddressesDefaultFlatPagination,
+  type UserAddressesUserAddressesDefaultFlatPagination,
 } from './user-addresses';
 export { UserTags, type UserTagListResponse, type UserTagListParams } from './user-tags';
 export {
@@ -1513,6 +1618,8 @@ export {
   type CallMachineGreetingEndedWebhookEvent,
   type CallMachinePremiumDetectionEndedWebhookEvent,
   type CallMachinePremiumGreetingEndedWebhookEvent,
+  type CallPaymentCompletedWebhookEvent,
+  type CallPaymentProgressWebhookEvent,
   type CallPlaybackEndedWebhookEvent,
   type CallPlaybackStartedWebhookEvent,
   type CallRecordingErrorWebhookEvent,
@@ -1546,6 +1653,7 @@ export {
   type DeliveryUpdateWebhookEvent,
   type HostedNumberOrderEventWebhookEvent,
   type InboundMessageWebhookEvent,
+  type NumberOrderStatusUpdateWebhookEvent,
   type ReplacedLinkClickWebhookEvent,
   type TranscriptionWebhookEvent,
   type UnsafeUnwrapWebhookEvent,

package/src/resources/inexplicit-number-orders.ts

@@ -16,6 +16,14 @@ import { path } from '../internal/utils/path';
 export class InexplicitNumberOrders extends APIResource {
   /**
    * Get a paginated list of inexplicit number orders.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const inexplicitNumberOrderResponse of client.inexplicitNumberOrders.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: InexplicitNumberOrderListParams | null | undefined = {},
@@ -34,6 +42,22 @@ export class InexplicitNumberOrders extends APIResource {
   /**
    * Create an inexplicit number order to programmatically purchase phone numbers
    * without specifying exact numbers.
+   *
+   * @example
+   * ```ts
+   * const inexplicitNumberOrder =
+   *   await client.inexplicitNumberOrders.create({
+   *     ordering_groups: [
+   *       {
+   *         country_iso: 'US',
+   *         count_requested: '5',
+   *         phone_number_type: 'local',
+   *         administrative_area: 'CA',
+   *         features: ['voice'],
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   create(
     body: InexplicitNumberOrderCreateParams,
@@ -44,6 +68,14 @@ export class InexplicitNumberOrders extends APIResource {
 
   /**
    * Get an existing inexplicit number order by ID.
+   *
+   * @example
+   * ```ts
+   * const inexplicitNumberOrder =
+   *   await client.inexplicitNumberOrders.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<InexplicitNumberOrderRetrieveResponse> {
     return this._client.get(path`/inexplicit_number_orders/${id}`, options);

package/src/resources/ip-connections.ts

@@ -237,6 +237,13 @@ export interface IPConnection {
 
   connection_name?: string;
 
+  /**
+   * Whether conversation persistence is enabled for this connection. When enabled,
+   * calls handled by the connection are transcribed, stored, and indexed. Defaults
+   * to false.
+   */
+  conversation_persistence?: boolean;
+
   /**
    * ISO 8601 formatted date indicating when the resource was created.
    */
@@ -757,6 +764,13 @@ export interface IPConnectionUpdateParams {
 
   connection_name?: string;
 
+  /**
+   * Whether conversation persistence is enabled for this connection. When enabled,
+   * calls handled by the connection are transcribed, stored, and indexed. Defaults
+   * to false.
+   */
+  conversation_persistence?: boolean;
+
   /**
    * When enabled, Telnyx will generate comfort noise when you place the call on
    * hold. If disabled, you will need to generate comfort noise or on hold music to

package/src/resources/ledger-billing-group-reports.ts

@@ -10,7 +10,8 @@ import { path } from '../internal/utils/path';
  */
 export class LedgerBillingGroupReports extends APIResource {
   /**
-   * Create a ledger billing group report
+   * Create a ledger billing group report, which aggregates ledger activity by
+   * billing group.
    *
    * @example
    * ```ts
@@ -29,7 +30,8 @@ export class LedgerBillingGroupReports extends APIResource {
   }
 
   /**
-   * Get a ledger billing group report
+   * Retrieve the details and status of a previously created ledger billing group
+   * report.
    *
    * @example
    * ```ts

package/src/resources/legacy/reporting/batch-detail-records/batch-detail-records.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../../../core/resource';
 import * as MessagingAPI from './messaging';
 import {
   BatchCsvPaginationMeta,
+  BatchCsvPaginationMeta705dfa7312,
   MdrDetailReportResponse,
   Messaging,
   MessagingCreateParams,
@@ -91,6 +92,7 @@ export declare namespace BatchDetailRecords {
   export {
     Messaging as Messaging,
     type BatchCsvPaginationMeta as BatchCsvPaginationMeta,
+    type BatchCsvPaginationMeta705dfa7312 as BatchCsvPaginationMeta705dfa7312,
     type MdrDetailReportResponse as MdrDetailReportResponse,
     type MessagingCreateResponse as MessagingCreateResponse,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,

package/src/resources/legacy/reporting/batch-detail-records/index.ts

@@ -4,6 +4,7 @@ export { BatchDetailRecords, type Filter } from './batch-detail-records';
 export {
   Messaging,
   type BatchCsvPaginationMeta,
+  type BatchCsvPaginationMeta705dfa7312,
   type MdrDetailReportResponse,
   type MessagingCreateResponse,
   type MessagingRetrieveResponse,

package/src/resources/legacy/reporting/batch-detail-records/messaging.ts

@@ -82,6 +82,16 @@ export interface BatchCsvPaginationMeta {
   total_results?: number;
 }
 
+export interface BatchCsvPaginationMeta705dfa7312 {
+  page_number?: number;
+
+  page_size?: number;
+
+  total_pages?: number;
+
+  total_results?: number;
+}
+
 export interface MdrDetailReportResponse {
   /**
    * Identifies the resource
@@ -129,7 +139,7 @@ export interface MessagingRetrieveResponse {
 export interface MessagingListResponse {
   data?: Array<MdrDetailReportResponse>;
 
-  meta?: BatchCsvPaginationMeta;
+  meta?: BatchCsvPaginationMeta705dfa7312;
 }
 
 export interface MessagingDeleteResponse {
@@ -203,6 +213,7 @@ export interface MessagingCreateParams {
 export declare namespace Messaging {
   export {
     type BatchCsvPaginationMeta as BatchCsvPaginationMeta,
+    type BatchCsvPaginationMeta705dfa7312 as BatchCsvPaginationMeta705dfa7312,
     type MdrDetailReportResponse as MdrDetailReportResponse,
     type MessagingCreateResponse as MessagingCreateResponse,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,

package/src/resources/legacy/reporting/batch-detail-records/voice.ts

@@ -191,7 +191,7 @@ export interface VoiceRetrieveResponse {
 export interface VoiceListResponse {
   data?: Array<CdrDetailedReqResponse>;
 
-  meta?: MessagingAPI.BatchCsvPaginationMeta;
+  meta?: MessagingAPI.BatchCsvPaginationMeta705dfa7312;
 }
 
 export interface VoiceDeleteResponse {

package/src/resources/legacy/reporting/usage-reports/index.ts

@@ -4,6 +4,7 @@ export {
   Messaging,
   type MdrUsageReportResponseLegacy,
   type StandardPaginationMeta,
+  type StandardPaginationMetaFfba4faa88,
   type MessagingCreateResponse,
   type MessagingRetrieveResponse,
   type MessagingDeleteResponse,

package/src/resources/legacy/reporting/usage-reports/messaging.ts

@@ -136,6 +136,16 @@ export interface StandardPaginationMeta {
   total_results?: number;
 }
 
+export interface StandardPaginationMetaFfba4faa88 {
+  page_number?: number;
+
+  page_size?: number;
+
+  total_pages?: number;
+
+  total_results?: number;
+}
+
 export interface MessagingCreateResponse {
   /**
    * Legacy V2 MDR usage report response
@@ -186,6 +196,7 @@ export declare namespace Messaging {
   export {
     type MdrUsageReportResponseLegacy as MdrUsageReportResponseLegacy,
     type StandardPaginationMeta as StandardPaginationMeta,
+    type StandardPaginationMetaFfba4faa88 as StandardPaginationMetaFfba4faa88,
     type MessagingCreateResponse as MessagingCreateResponse,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
     type MessagingDeleteResponse as MessagingDeleteResponse,

package/src/resources/legacy/reporting/usage-reports/usage-reports.ts

@@ -12,6 +12,7 @@ import {
   MessagingListParams,
   MessagingRetrieveResponse,
   StandardPaginationMeta,
+  StandardPaginationMetaFfba4faa88,
 } from './messaging';
 import * as NumberLookupAPI from './number-lookup';
 import {
@@ -95,6 +96,7 @@ export declare namespace UsageReports {
     Messaging as Messaging,
     type MdrUsageReportResponseLegacy as MdrUsageReportResponseLegacy,
     type StandardPaginationMeta as StandardPaginationMeta,
+    type StandardPaginationMetaFfba4faa88 as StandardPaginationMetaFfba4faa88,
     type MessagingCreateResponse as MessagingCreateResponse,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
     type MessagingDeleteResponse as MessagingDeleteResponse,

package/src/resources/messages/index.ts

@@ -2,6 +2,8 @@
 
 export {
   Messages,
+  type MessagingError0b38e7044b,
+  type MessagingOutboundMessagePayload,
   type OutboundMessagePayload,
   type RcsAgentMessage,
   type RcsCardContent,
@@ -24,6 +26,7 @@ export {
   type MessageSendNumberPoolResponse,
   type MessageSendShortCodeResponse,
   type MessageSendWithAlphanumericSenderResponse,
+  type MessageWhatsappResponse,
   type MessageSendParams,
   type MessageSendLongCodeParams,
   type MessageSendNumberPoolParams,
@@ -31,6 +34,7 @@ export {
   type MessageSendGroupMmsParams,
   type MessageScheduleParams,
   type MessageSendWithAlphanumericSenderParams,
+  type MessageWhatsappParams,
 } from './messages';
 export {
   Rcs,