telnyx 5.159.0 → 5.160.0

data/rbi/telnyx/resources/available_phone_numbers.rbi

@@ -4,7 +4,10 @@ module Telnyx
   module Resources
     # Number search
     class AvailablePhoneNumbers
-      # List available phone numbers
+      # Searches the Telnyx inventory for available phone numbers. Filters support
+      # number patterns, location, number type, features, reservability, and other
+      # inventory constraints; the response includes matching numbers and search
+      # metadata.
       sig do
         params(
           filter: Telnyx::AvailablePhoneNumberListParams::Filter::OrHash,

data/rbi/telnyx/resources/balance.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing operations
     class Balance
-      # Get user balance details
+      # Retrieve the current balance, available credit, and credit limit for your
+      # account.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::BalanceRetrieveResponse

data/rbi/telnyx/resources/billing_groups.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing groups operations
     class BillingGroups
-      # Create a billing group
+      # Create a new billing group, which can be used to organize resources for billing
+      # purposes.
       sig do
         params(
           name: String,
@@ -18,7 +19,7 @@ module Telnyx
       )
       end
 
-      # Get a billing group
+      # Retrieve the details of a specific billing group.
       sig do
         params(
           id: String,
@@ -32,7 +33,7 @@ module Telnyx
       )
       end
 
-      # Update a billing group
+      # Update the properties of an existing billing group.
       sig do
         params(
           id: String,
@@ -49,7 +50,7 @@ module Telnyx
       )
       end
 
-      # List all billing groups
+      # Retrieve a paginated list of billing groups on your account.
       sig do
         params(
           page_number: Integer,
@@ -60,7 +61,7 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a billing group
+      # Delete a billing group from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/calls/actions.rbi

@@ -1579,7 +1579,8 @@ module Telnyx
         )
         end
 
-        # Noise Suppression Start (BETA)
+        # Start noise suppression on an active call to reduce background noise. This
+        # feature is currently in beta.
         sig do
           params(
             call_control_id: String,
@@ -2064,7 +2065,8 @@ module Telnyx
         )
         end
 
-        # Noise Suppression Stop (BETA)
+        # Stop noise suppression previously started on an active call. This feature is
+        # currently in beta.
         sig do
           params(
             call_control_id: String,

data/rbi/telnyx/resources/comments.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Number orders
     class Comments
-      # Create a comment
+      # Creates a comment associated with a supported number-order record. The response
+      # contains the created comment.
       sig do
         params(
           body: String,
@@ -21,7 +22,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a comment
+      # Returns the comment identified by `id`, including its associated record and
+      # comment metadata.
       sig do
         params(
           id: String,
@@ -35,7 +37,8 @@ module Telnyx
       )
       end
 
-      # Retrieve all comments
+      # Returns comments associated with number-order records. Results can be filtered
+      # by record type and record ID and include pagination metadata.
       sig do
         params(
           filter: Telnyx::CommentListParams::Filter::OrHash,
@@ -50,7 +53,8 @@ module Telnyx
       )
       end
 
-      # Mark a comment as read
+      # Marks the specified comment as read. The response contains the updated read
+      # state for the comment.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/credential_connections.rbi

@@ -146,6 +146,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -187,6 +188,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # 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: nil,
         # 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
         # avoid RTP timeout.

data/rbi/telnyx/resources/email_blocks.rbi

@@ -39,7 +39,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a suppression
+      # Returns the account-owned suppression identified by ID. Cross-account lookups
+      # and malformed IDs return `404` without exposing another account’s data.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/email_domains/webhooks.rbi

@@ -27,7 +27,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a webhook
+        # Returns the webhook subscription identified by ID within the specified email
+        # domain.
         sig do
           params(
             id: String,
@@ -68,7 +69,8 @@ module Telnyx
         )
         end
 
-        # List webhooks for an email domain
+        # Returns a paginated list of webhook subscriptions scoped to the email domain.
+        # Results can be sorted by creation time.
         sig do
           params(
             domain_id: String,
@@ -95,7 +97,8 @@ module Telnyx
         )
         end
 
-        # Delete a webhook
+        # Deletes the webhook subscription identified by ID within the specified email
+        # domain and returns the deleted subscription.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/email_domains.rbi

@@ -7,7 +7,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::EmailDomains::Webhooks) }
       attr_reader :webhooks
 
-      # Create an email domain
+      # Registers a domain for email sending and optional inbound delivery. The response
+      # includes the domain configuration and current verification state.
       sig do
         params(
           domain: String,
@@ -46,7 +47,9 @@ module Telnyx
       )
       end
 
-      # Update an email domain
+      # Updates mutable settings for an existing email domain, including inbound
+      # delivery and tracking configuration. Shared domains are read-only for non-owner
+      # accounts.
       sig do
         params(
           id: String,
@@ -112,7 +115,8 @@ module Telnyx
       )
       end
 
-      # Delete an email domain
+      # Deletes an email domain configuration. Verified domains require `force=true`,
+      # and shared domains are read-only for non-owner accounts.
       sig do
         params(
           id: String,
@@ -129,7 +133,8 @@ module Telnyx
       )
       end
 
-      # List DNS records for an email domain
+      # Returns the DNS records Telnyx generated for domain ownership and DKIM
+      # verification, plus MX records when inbound delivery is enabled.
       sig do
         params(
           domain_id: String,
@@ -157,7 +162,8 @@ module Telnyx
       )
       end
 
-      # Verify DNS records for an email domain
+      # Checks the published DNS records against the records required for the email
+      # domain and returns the latest verification results.
       sig do
         params(
           domain_id: String,

data/rbi/telnyx/resources/email_templates.rbi

@@ -41,7 +41,8 @@ module Telnyx
       )
       end
 
-      # Get an email template
+      # Returns the account-owned template identified by ID, including its Liquid
+      # subject and bodies, declared variables, and timestamps.
       sig do
         params(
           id: String,
@@ -100,7 +101,8 @@ module Telnyx
       )
       end
 
-      # Delete an email template
+      # Deletes the account-owned template. The operation returns `204` with no body and
+      # prevents future sends or renders from using the deleted template ID.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/rbi/telnyx/resources/email_unsubscribe_groups.rbi

@@ -8,7 +8,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::EmailUnsubscribeGroups::Suppressions) }
       attr_reader :suppressions
 
-      # Create an unsubscribe group
+      # Creates an account-owned unsubscribe group for associating email categories with
+      # separate recipient suppression lists.
       sig do
         params(
           name: String,
@@ -19,7 +20,7 @@ module Telnyx
       def create(name:, description: nil, request_options: {})
       end
 
-      # Retrieve an unsubscribe group
+      # Returns the account-owned unsubscribe group identified by ID.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/external_connections.rbi

@@ -155,7 +155,8 @@ module Telnyx
       )
       end
 
-      # Update a location's static emergency address
+      # Update the static emergency address assigned to a specific location of an
+      # external connection.
       sig do
         params(
           location_id: String,

data/rbi/telnyx/resources/faxes.rbi

@@ -101,7 +101,7 @@ module Telnyx
       )
       end
 
-      # View a fax
+      # Retrieve the details of a single fax.
       sig do
         params(
           id: String,
@@ -115,7 +115,7 @@ module Telnyx
       )
       end
 
-      # View a list of faxes
+      # Retrieve a paginated list of faxes sent or received on your account.
       sig do
         params(
           filter: Telnyx::FaxListParams::Filter::OrHash,
@@ -135,7 +135,7 @@ module Telnyx
       )
       end
 
-      # Delete a fax
+      # Delete a fax resource from your account.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/rbi/telnyx/resources/fqdn_connections/fqdn_authentication.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class FqdnConnections
+      # FQDN connection operations
+      class FqdnAuthentication
+        # Retrieves the details of an existing FQDN authentication strategy for a specific
+        # FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse
+          )
+        end
+        def list(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          request_options: {}
+        )
+        end
+
+        # Updates the FQDN authentication strategy for a specific FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            failover_url: String,
+            fqdn_outbound_authentication:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication::OrSymbol,
+            ip_authentication_method:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod::OrSymbol,
+            password: String,
+            txt_name: String,
+            txt_ttl: Integer,
+            txt_value: String,
+            user_name: String,
+            webhook_url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse
+          )
+        end
+        def patch_all(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          # The failover webhook URL.
+          failover_url: nil,
+          # The outbound authentication type.
+          fqdn_outbound_authentication: nil,
+          # The IP authentication method.
+          ip_authentication_method: nil,
+          # The password for authentication.
+          password: nil,
+          # The TXT record name for Microsoft Teams SBC DNS verification.
+          txt_name: nil,
+          # The TTL for the TXT record.
+          txt_ttl: nil,
+          # The TXT record value for Microsoft Teams SBC DNS verification.
+          txt_value: nil,
+          # The username for authentication.
+          user_name: nil,
+          # The webhook URL for authentication events.
+          webhook_url: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/fqdn_connections.rbi

@@ -4,6 +4,10 @@ module Telnyx
   module Resources
     # FQDN connection operations
     class FqdnConnections
+      # FQDN connection operations
+      sig { returns(Telnyx::Resources::FqdnConnections::FqdnAuthentication) }
+      attr_reader :fqdn_authentication
+
       # Creates a FQDN connection.
       sig do
         params(
@@ -131,6 +135,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -168,6 +173,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # 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: nil,
         # 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
         # avoid RTP timeout.

data/rbi/telnyx/resources/global_ip_assignment_health.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentHealth
-      # Global IP Assignment Health Check Metrics
+      # Retrieve health check metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_assignments_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentsUsage
-      # Global IP Assignment Usage Metrics
+      # Retrieve usage metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_latency.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPLatency
-      # Global IP Latency Metrics
+      # Retrieve latency metrics measured for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPLatencyRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/global_ip_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPUsage
-      # Global IP Usage Metrics
+      # Retrieve usage metrics for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPUsageRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/ip_connections.rbi

@@ -128,6 +128,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -166,6 +167,10 @@ module Telnyx
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
+        # 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: nil,
         # 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
         # avoid RTP timeout.

data/rbi/telnyx/resources/ledger_billing_group_reports.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Ledger billing reports
     class LedgerBillingGroupReports
-      # Create a ledger billing group report
+      # Create a ledger billing group report, which aggregates ledger activity by
+      # billing group.
       sig do
         params(
           month: Integer,
@@ -21,7 +22,8 @@ module Telnyx
       )
       end
 
-      # Get a ledger billing group report
+      # Retrieve the details and status of a previously created ledger billing group
+      # report.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/messages/rcs.rbi

@@ -26,7 +26,8 @@ module Telnyx
         )
         end
 
-        # Send an RCS message
+        # Queues an outbound RCS message through the selected RCS agent. Check recipient
+        # capabilities before sending features that require RCS support.
         sig do
           params(
             agent_id: String,

data/rbi/telnyx/resources/messages.rbi

@@ -2,7 +2,6 @@
 
 module Telnyx
   module Resources
-    # Messages
     class Messages
       # Send RCS messages
       sig { returns(Telnyx::Resources::Messages::Rcs) }
@@ -195,7 +194,8 @@ module Telnyx
       )
       end
 
-      # Send a group MMS message
+      # Queues an MMS addressed to multiple recipients as a group conversation. Delivery
+      # events are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -233,7 +233,8 @@ module Telnyx
       )
       end
 
-      # Send a long code message
+      # Queues an outbound SMS or MMS using a long-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -289,7 +290,8 @@ module Telnyx
       )
       end
 
-      # Send a message using number pool
+      # Queues an outbound message using a number pool. Telnyx selects an eligible
+      # sender from the pool according to its messaging profile configuration.
       sig do
         params(
           messaging_profile_id: String,
@@ -345,7 +347,8 @@ module Telnyx
       )
       end
 
-      # Send a short code message
+      # Queues an outbound SMS or MMS using a short-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -433,6 +436,37 @@ module Telnyx
       )
       end
 
+      # Sends a WhatsApp message using a Telnyx WhatsApp-enabled number. The message
+      # body, interactive elements, media, location, and reaction content are specified
+      # in the `whatsapp_message` field. Delivery progress and final disposition are
+      # reported asynchronously through messaging webhooks.
+      sig do
+        params(
+          from: String,
+          to: String,
+          whatsapp_message: Telnyx::WhatsappMessageContent::OrHash,
+          messaging_profile_id: String,
+          type: Telnyx::MessageWhatsappParams::Type::OrSymbol,
+          webhook_url: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessageWhatsappResponse)
+      end
+      def whatsapp(
+        # Phone number in +E.164 format associated with Whatsapp account
+        from:,
+        # Phone number in +E.164 format
+        to:,
+        whatsapp_message:,
+        # Messaging profile ID - required if the 'from' number is not SMS-enabled
+        messaging_profile_id: nil,
+        # Message type - must be set to "WHATSAPP"
+        type: nil,
+        # The URL where webhooks related to this message will be sent.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/messaging/rcs/agents.rbi

@@ -6,12 +6,12 @@ module Telnyx
       class Rcs
         # Send RCS messages
         class Agents
-          # Retrieve an RCS agent
+          # Returns the configuration and current state of the specified RCS agent.
           sig do
             params(
               id: String,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::RcsAgentResponse)
+            ).returns(Telnyx::Rcs::RcsAgentResponse)
           end
           def retrieve(
             # RCS agent ID
@@ -20,7 +20,7 @@ module Telnyx
           )
           end
 
-          # Modify an RCS agent
+          # Updates the supplied configuration fields on the specified RCS agent.
           sig do
             params(
               id: String,
@@ -28,7 +28,7 @@ module Telnyx
               webhook_failover_url: T.nilable(String),
               webhook_url: T.nilable(String),
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::RcsAgentResponse)
+            ).returns(Telnyx::Rcs::RcsAgentResponse)
           end
           def update(
             # RCS agent ID
@@ -43,13 +43,15 @@ module Telnyx
           )
           end
 
-          # List all RCS agents
+          # Returns RCS agents available to the authenticated account.
           sig do
             params(
               page_number: Integer,
               page_size: Integer,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::RcsAgent])
+            ).returns(
+              Telnyx::Internal::DefaultFlatPagination[Telnyx::Rcs::RcsAgent]
+            )
           end
           def list(page_number: nil, page_size: nil, request_options: {})
           end

data/rbi/telnyx/resources/messaging/rcs.rbi

@@ -26,7 +26,7 @@ module Telnyx
         )
         end
 
-        # Check RCS capabilities (batch)
+        # Returns RCS capability information for multiple recipients in one request.
         sig do
           params(
             agent_id: String,
@@ -43,7 +43,8 @@ module Telnyx
         )
         end
 
-        # Check RCS capabilities
+        # Returns the RCS features supported by the specified recipient for the selected
+        # agent.
         sig do
           params(
             phone_number: String,