telnyx 5.159.0 → 5.161.0

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,

data/rbi/telnyx/resources/messaging_10dlc/brand.rbi

@@ -321,7 +321,9 @@ module Telnyx
         )
         end
 
-        # Resend brand 2FA email
+        # Requests a new two-factor authentication email for the specified 10DLC brand.
+        # Complete verification through the link delivered to the brand contact before
+        # continuing registration.
         sig do
           params(
             brand_id: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign/osr.rbi

@@ -6,7 +6,9 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Osr
-          # Get OSR campaign attributes
+          # Returns the optional shared-responsibility attributes recorded for the campaign.
+          # Use these values to inspect the campaign configuration submitted to the
+          # registry.
           sig do
             params(
               campaign_id: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign/usecase.rbi

@@ -6,7 +6,8 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Usecase
-          # Get Campaign Cost
+          # Returns the upfront and monthly cost associated with the selected 10DLC campaign
+          # use case.
           sig do
             params(
               usecase: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign.rbi

@@ -163,7 +163,8 @@ module Telnyx
         )
         end
 
-        # Get Sharing Status
+        # Returns whether the campaign is configured for partner sharing and the current
+        # sharing state.
         sig do
           params(
             campaign_id: String,

data/rbi/telnyx/resources/messaging_10dlc/partner_campaigns.rbi

@@ -96,7 +96,7 @@ module Telnyx
         )
         end
 
-        # Get Sharing Status
+        # Returns the partner-sharing state for the specified campaign.
         sig do
           params(
             campaign_id: String,

data/rbi/telnyx/resources/messaging_10dlc/phone_number_campaigns.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Messaging10dlc
       # Phone number campaign assignment
       class PhoneNumberCampaigns
-        # Create New Phone Number Campaign
+        # Assigns a phone number to a 10DLC campaign. The assignment controls which
+        # registered campaign is used for traffic from that number.
         sig do
           params(
             campaign_id: String,
@@ -36,7 +37,7 @@ module Telnyx
         )
         end
 
-        # Create New Phone Number Campaign
+        # Replaces the 10DLC campaign assignment for the specified phone number.
         sig do
           params(
             campaign_phone_number: String,
@@ -56,7 +57,8 @@ module Telnyx
         )
         end
 
-        # List phone number campaigns
+        # Returns phone-number-to-campaign assignments for the authenticated account.
+        # Apply the documented filters and pagination parameters to narrow the result set.
         sig do
           params(
             filter:

data/rbi/telnyx/resources/messaging_10dlc.rbi

@@ -30,7 +30,8 @@ module Telnyx
       end
       attr_reader :phone_number_assignment_by_profile
 
-      # Get Enum
+      # Returns the accepted values for the selected 10DLC enumeration endpoint. Use
+      # these values when constructing brand and campaign requests.
       sig do
         params(
           endpoint: Telnyx::Messaging10dlcGetEnumParams::Endpoint::OrSymbol,

data/rbi/telnyx/resources/messaging_hosted_number_orders/actions.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class MessagingHostedNumberOrders
       # Manage your messaging hosted numbers
       class Actions
-        # Upload hosted number document
+        # Uploads a supporting document to the specified hosted-messaging order.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/messaging_hosted_number_orders.rbi

@@ -8,7 +8,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::MessagingHostedNumberOrders::Actions) }
       attr_reader :actions
 
-      # Create a messaging hosted number order
+      # Creates an order to enable Telnyx messaging on phone numbers whose voice service
+      # remains with another carrier.
       sig do
         params(
           messaging_profile_id: String,
@@ -26,7 +27,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a messaging hosted number order
+      # Returns the current state, phone numbers, and required actions for the specified
+      # hosted-messaging order.
       sig do
         params(
           id: String,
@@ -40,7 +42,8 @@ module Telnyx
       )
       end
 
-      # List messaging hosted number orders
+      # Returns hosted-messaging orders for the authenticated account. Apply the
+      # documented filters and pagination parameters to narrow the result set.
       sig do
         params(
           page_number: Integer,
@@ -69,7 +72,8 @@ module Telnyx
       )
       end
 
-      # Check hosted messaging eligibility
+      # Checks whether the supplied phone numbers are eligible for hosted messaging
+      # before an order is created.
       sig do
         params(
           phone_numbers: T::Array[String],

data/rbi/telnyx/resources/messaging_hosted_numbers.rbi

@@ -82,7 +82,7 @@ module Telnyx
       )
       end
 
-      # Delete a messaging hosted number
+      # Removes the specified hosted number from Telnyx messaging management.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/messaging_numbers_bulk_updates.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Configure your phone numbers
     class MessagingNumbersBulkUpdates
-      # Bulk update phone number profiles
+      # Starts a bulk update of messaging-profile assignments for the supplied phone
+      # numbers. The response identifies the order used to monitor processing.
       sig do
         params(
           messaging_profile_id: String,
@@ -29,7 +30,8 @@ module Telnyx
       )
       end
 
-      # Retrieve bulk update status
+      # Returns processing status and results for a bulk messaging-settings update
+      # order.
       sig do
         params(
           order_id: String,

data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class MessagingProfiles
       # Opt-Out Management
       class AutorespConfigs
-        # Create auto-response setting
+        # Creates an auto-response rule on the specified messaging profile. Matching
+        # inbound messages trigger the configured response.
         sig do
           params(
             profile_id: String,
@@ -27,7 +28,8 @@ module Telnyx
         )
         end
 
-        # Get Auto-Response Setting
+        # Returns the matching criteria and response content for the specified
+        # auto-response rule.
         sig do
           params(
             autoresp_cfg_id: String,
@@ -44,7 +46,7 @@ module Telnyx
         )
         end
 
-        # Update Auto-Response Setting
+        # Replaces the configuration of the specified auto-response rule.
         sig do
           params(
             autoresp_cfg_id: String,
@@ -73,7 +75,7 @@ module Telnyx
         )
         end
 
-        # List Auto-Response Settings
+        # Returns the auto-response rules configured for the specified messaging profile.
         sig do
           params(
             profile_id: String,
@@ -102,7 +104,7 @@ module Telnyx
         )
         end
 
-        # Delete Auto-Response Setting
+        # Deletes the specified auto-response rule from the messaging profile.
         sig do
           params(
             autoresp_cfg_id: String,

data/rbi/telnyx/resources/messaging_profiles.rbi

@@ -10,7 +10,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::MessagingProfiles::Actions) }
       attr_reader :actions
 
-      # Create a messaging profile
+      # Creates a messaging profile that controls outbound sender selection, webhook
+      # delivery, and inbound message handling for associated numbers and short codes.
       sig do
         params(
           name: String,
@@ -95,7 +96,8 @@ module Telnyx
       )
       end
 
-      # Retrieve a messaging profile
+      # Returns the complete configuration of the specified messaging profile, including
+      # webhook and sender-selection settings.
       sig do
         params(
           messaging_profile_id: String,
@@ -109,7 +111,8 @@ module Telnyx
       )
       end
 
-      # Update a messaging profile
+      # Updates the supplied settings on the specified messaging profile. Settings
+      # omitted from the request remain unchanged.
       sig do
         params(
           messaging_profile_id: String,
@@ -196,7 +199,8 @@ module Telnyx
       )
       end
 
-      # List messaging profiles
+      # Returns messaging profiles owned by the authenticated account. Apply the
+      # documented filters and pagination parameters to narrow the result set.
       sig do
         params(
           filter: Telnyx::MessagingProfileListParams::Filter::OrHash,
@@ -222,7 +226,8 @@ module Telnyx
       )
       end
 
-      # Delete a messaging profile
+      # Deletes the specified messaging profile and returns the profile's final
+      # configuration.
       sig do
         params(
           messaging_profile_id: String,
@@ -258,7 +263,8 @@ module Telnyx
       )
       end
 
-      # List phone numbers associated with a messaging profile
+      # Returns the phone numbers currently associated with the specified messaging
+      # profile.
       sig do
         params(
           messaging_profile_id: String,
@@ -280,7 +286,8 @@ module Telnyx
       )
       end
 
-      # List short codes associated with a messaging profile
+      # Returns the short codes currently associated with the specified messaging
+      # profile.
       sig do
         params(
           messaging_profile_id: String,

data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi

@@ -42,7 +42,7 @@ module Telnyx
               doing_business_as: T.nilable(String),
               entity_type:
                 T.nilable(
-                  Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
+                  Telnyx::MessagingTollfree::Verification::MessagingTollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
               isv_reseller: T.nilable(String),
@@ -53,7 +53,7 @@ module Telnyx
               webhook_url: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(
-              Telnyx::MessagingTollfree::Verification::VerificationRequestEgress
+              Telnyx::MessagingTollfree::Verification::MessagingTollFreeVerificationVerificationRequestEgress
             )
           end
           def create(
@@ -145,7 +145,7 @@ module Telnyx
               id: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(
-              Telnyx::MessagingTollfree::Verification::VerificationRequestStatus
+              Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveResponse
             )
           end
           def retrieve(
@@ -193,7 +193,7 @@ module Telnyx
               doing_business_as: T.nilable(String),
               entity_type:
                 T.nilable(
-                  Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
+                  Telnyx::MessagingTollfree::Verification::MessagingTollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
               isv_reseller: T.nilable(String),
@@ -204,7 +204,7 @@ module Telnyx
               webhook_url: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(
-              Telnyx::MessagingTollfree::Verification::VerificationRequestEgress
+              Telnyx::MessagingTollfree::Verification::MessagingTollFreeVerificationVerificationRequestEgress
             )
           end
           def update(

data/rbi/telnyx/resources/messaging_url_domains.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Messaging URL Domains
     class MessagingURLDomains
-      # List messaging URL domains
+      # Returns the URL domains available to the authenticated account for message URL
+      # shortening.
       sig do
         params(
           page_number: Integer,

data/rbi/telnyx/resources/mobile_phone_numbers/messaging.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     class MobilePhoneNumbers
       class Messaging
-        # Retrieve a mobile phone number with messaging settings
+        # Returns the messaging configuration for the specified mobile phone number.
         sig do
           params(
             id: String,
@@ -20,7 +20,7 @@ module Telnyx
         )
         end
 
-        # List mobile phone numbers with messaging settings
+        # Returns mobile phone numbers with their current messaging configuration.
         sig do
           params(
             page_number: Integer,

data/rbi/telnyx/resources/mobile_phone_numbers.rbi

@@ -7,7 +7,7 @@ module Telnyx
       sig { returns(Telnyx::Resources::MobilePhoneNumbers::Messaging) }
       attr_reader :messaging
 
-      # Retrieve a Mobile Phone Number
+      # Retrieve the details of a specific mobile phone number.
       sig do
         params(
           id: String,
@@ -21,7 +21,7 @@ module Telnyx
       )
       end
 
-      # Update a Mobile Phone Number
+      # Update the settings of a specific mobile phone number.
       sig do
         params(
           id: String,
@@ -61,7 +61,7 @@ module Telnyx
       )
       end
 
-      # List Mobile Phone Numbers
+      # Retrieve a paginated list of mobile phone numbers on your account.
       sig do
         params(
           page_number: Integer,

data/rbi/telnyx/resources/mobile_voice_connections.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Mobile voice connection operations
     class MobileVoiceConnections
-      # Create a Mobile Voice Connection
+      # Create a new mobile voice connection.
       sig do
         params(
           active: T::Boolean,
@@ -34,7 +34,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a Mobile Voice Connection
+      # Retrieve the details of a specific mobile voice connection.
       sig do
         params(
           id: String,
@@ -48,7 +48,7 @@ module Telnyx
       )
       end
 
-      # Update a Mobile Voice Connection
+      # Update the settings of a specific mobile voice connection.
       sig do
         params(
           id: String,
@@ -81,7 +81,7 @@ module Telnyx
       )
       end
 
-      # List Mobile Voice Connections
+      # Retrieve a paginated list of mobile voice connections on your account.
       sig do
         params(
           filter_connection_name_contains: String,
@@ -107,7 +107,7 @@ module Telnyx
       )
       end
 
-      # Delete a Mobile Voice Connection
+      # Delete a mobile voice connection from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/number_order_phone_numbers.rbi

@@ -32,7 +32,8 @@ module Telnyx
       )
       end
 
-      # 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.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/ota_updates.rbi

@@ -18,7 +18,8 @@ module Telnyx
       )
       end
 
-      # List OTA updates
+      # Retrieve a paginated list of over-the-air (OTA) update operations for your SIM
+      # cards.
       sig do
         params(
           filter: Telnyx::OtaUpdateListParams::Filter::OrHash,

data/rbi/telnyx/resources/payment.rbi

@@ -8,7 +8,7 @@ module Telnyx
       sig { returns(Telnyx::Resources::Payment::AutoRechargePrefs) }
       attr_reader :auto_recharge_prefs
 
-      # Create a stored payment transaction
+      # Create a transaction that charges a stored payment method on the account.
       sig do
         params(
           amount: String,

data/rbi/telnyx/resources/phone_number_blocks/jobs.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PhoneNumberBlocks
       # Background jobs performed over a phone-numbers block's phone numbers
       class Jobs
-        # Retrieves a phone number blocks job
+        # Returns the status and details of the phone-number-block background job
+        # identified by `id`.
         sig do
           params(
             id: String,
@@ -19,7 +20,9 @@ module Telnyx
         )
         end
 
-        # 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.
         sig do
           params(
             filter: Telnyx::PhoneNumberBlocks::JobListParams::Filter::OrHash,