telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/verify_profile_create_params.rbi

@@ -36,6 +36,12 @@ module Telnyx
       sig { params(language: String).void }
       attr_writer :language
 
+      sig { returns(T.nilable(Telnyx::VerifyProfileCreateParams::Rcs)) }
+      attr_reader :rcs
+
+      sig { params(rcs: Telnyx::VerifyProfileCreateParams::Rcs::OrHash).void }
+      attr_writer :rcs
+
       sig { returns(T.nilable(Telnyx::VerifyProfileCreateParams::SMS)) }
       attr_reader :sms
 
@@ -60,6 +66,7 @@ module Telnyx
           call: Telnyx::VerifyProfileCreateParams::Call::OrHash,
           flashcall: Telnyx::VerifyProfileCreateParams::Flashcall::OrHash,
           language: String,
+          rcs: Telnyx::VerifyProfileCreateParams::Rcs::OrHash,
           sms: Telnyx::VerifyProfileCreateParams::SMS::OrHash,
           webhook_failover_url: String,
           webhook_url: String,
@@ -71,6 +78,7 @@ module Telnyx
         call: nil,
         flashcall: nil,
         language: nil,
+        rcs: nil,
         sms: nil,
         webhook_failover_url: nil,
         webhook_url: nil,
@@ -85,6 +93,7 @@ module Telnyx
             call: Telnyx::VerifyProfileCreateParams::Call,
             flashcall: Telnyx::VerifyProfileCreateParams::Flashcall,
             language: String,
+            rcs: Telnyx::VerifyProfileCreateParams::Rcs,
             sms: Telnyx::VerifyProfileCreateParams::SMS,
             webhook_failover_url: String,
             webhook_url: String,
@@ -198,6 +207,14 @@ module Telnyx
             )
           end
 
+        # The name that identifies the application requesting 2fa in the verification
+        # message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :app_name
+
+        sig { params(app_name: String).void }
+        attr_writer :app_name
+
         # For every request that is initiated via this Verify profile, this sets the
         # number of seconds before a verification request code expires. Once the
         # verification request expires, the user cannot use the code to verify their
@@ -219,11 +236,15 @@ module Telnyx
 
         sig do
           params(
+            app_name: String,
             default_verification_timeout_secs: Integer,
             whitelisted_destinations: T::Array[String]
           ).returns(T.attached_class)
         end
         def self.new(
+          # The name that identifies the application requesting 2fa in the verification
+          # message.
+          app_name: nil,
           # For every request that is initiated via this Verify profile, this sets the
           # number of seconds before a verification request code expires. Once the
           # verification request expires, the user cannot use the code to verify their
@@ -239,6 +260,7 @@ module Telnyx
         sig do
           override.returns(
             {
+              app_name: String,
               default_verification_timeout_secs: Integer,
               whitelisted_destinations: T::Array[String]
             }
@@ -248,20 +270,119 @@ module Telnyx
         end
       end
 
-      class SMS < Telnyx::Internal::Type::BaseModel
+      class Rcs < Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Telnyx::VerifyProfileCreateParams::SMS,
+              Telnyx::VerifyProfileCreateParams::Rcs,
               Telnyx::Internal::AnyHash
             )
           end
 
+        # The name that identifies the application requesting 2fa in the verification
+        # message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :app_name
+
+        sig { params(app_name: String).void }
+        attr_writer :app_name
+
+        # The length of the verify code to generate.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :code_length
+
+        sig { params(code_length: Integer).void }
+        attr_writer :code_length
+
+        # For every request that is initiated via this Verify profile, this sets the
+        # number of seconds before a verification request code expires. Once the
+        # verification request expires, the user cannot use the code to verify their
+        # identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :default_verification_timeout_secs
+
+        sig { params(default_verification_timeout_secs: Integer).void }
+        attr_writer :default_verification_timeout_secs
+
+        # The message template identifier selected from /verify_profiles/templates
+        sig { returns(T.nilable(String)) }
+        attr_reader :messaging_template_id
+
+        sig { params(messaging_template_id: String).void }
+        attr_writer :messaging_template_id
+
+        # Enable SMS fallback when RCS delivery fails.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sms_fallback
+
+        sig { params(sms_fallback: T::Boolean).void }
+        attr_writer :sms_fallback
+
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
         # destinations will be allowed.
-        sig { returns(T::Array[String]) }
-        attr_accessor :whitelisted_destinations
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :whitelisted_destinations
+
+        sig { params(whitelisted_destinations: T::Array[String]).void }
+        attr_writer :whitelisted_destinations
+
+        sig do
+          params(
+            app_name: String,
+            code_length: Integer,
+            default_verification_timeout_secs: Integer,
+            messaging_template_id: String,
+            sms_fallback: T::Boolean,
+            whitelisted_destinations: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name that identifies the application requesting 2fa in the verification
+          # message.
+          app_name: nil,
+          # The length of the verify code to generate.
+          code_length: nil,
+          # For every request that is initiated via this Verify profile, this sets the
+          # number of seconds before a verification request code expires. Once the
+          # verification request expires, the user cannot use the code to verify their
+          # identity.
+          default_verification_timeout_secs: nil,
+          # The message template identifier selected from /verify_profiles/templates
+          messaging_template_id: nil,
+          # Enable SMS fallback when RCS delivery fails.
+          sms_fallback: nil,
+          # Enabled country destinations to send verification codes. The elements in the
+          # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+          # destinations will be allowed.
+          whitelisted_destinations: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              app_name: String,
+              code_length: Integer,
+              default_verification_timeout_secs: Integer,
+              messaging_template_id: String,
+              sms_fallback: T::Boolean,
+              whitelisted_destinations: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class SMS < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::VerifyProfileCreateParams::SMS,
+              Telnyx::Internal::AnyHash
+            )
+          end
 
         # The alphanumeric sender ID to use when sending to destinations that require an
         # alphanumeric sender ID.
@@ -300,21 +421,26 @@ module Telnyx
         sig { params(messaging_template_id: String).void }
         attr_writer :messaging_template_id
 
+        # Enabled country destinations to send verification codes. The elements in the
+        # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+        # destinations will be allowed.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :whitelisted_destinations
+
+        sig { params(whitelisted_destinations: T::Array[String]).void }
+        attr_writer :whitelisted_destinations
+
         sig do
           params(
-            whitelisted_destinations: T::Array[String],
             alpha_sender: T.nilable(String),
             app_name: String,
             code_length: Integer,
             default_verification_timeout_secs: Integer,
-            messaging_template_id: String
+            messaging_template_id: String,
+            whitelisted_destinations: T::Array[String]
           ).returns(T.attached_class)
         end
         def self.new(
-          # Enabled country destinations to send verification codes. The elements in the
-          # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
-          whitelisted_destinations:,
           # The alphanumeric sender ID to use when sending to destinations that require an
           # alphanumeric sender ID.
           alpha_sender: nil,
@@ -329,19 +455,23 @@ module Telnyx
           # identity.
           default_verification_timeout_secs: nil,
           # The message template identifier selected from /verify_profiles/templates
-          messaging_template_id: nil
+          messaging_template_id: nil,
+          # Enabled country destinations to send verification codes. The elements in the
+          # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+          # destinations will be allowed.
+          whitelisted_destinations: nil
         )
         end
 
         sig do
           override.returns(
             {
-              whitelisted_destinations: T::Array[String],
               alpha_sender: T.nilable(String),
               app_name: String,
               code_length: Integer,
               default_verification_timeout_secs: Integer,
-              messaging_template_id: String
+              messaging_template_id: String,
+              whitelisted_destinations: T::Array[String]
             }
           )
         end

data/rbi/telnyx/models/verify_profile_update_params.rbi

@@ -39,6 +39,12 @@ module Telnyx
       sig { params(name: String).void }
       attr_writer :name
 
+      sig { returns(T.nilable(Telnyx::VerifyProfileUpdateParams::Rcs)) }
+      attr_reader :rcs
+
+      sig { params(rcs: Telnyx::VerifyProfileUpdateParams::Rcs::OrHash).void }
+      attr_writer :rcs
+
       sig { returns(T.nilable(Telnyx::VerifyProfileUpdateParams::SMS)) }
       attr_reader :sms
 
@@ -63,6 +69,7 @@ module Telnyx
           flashcall: Telnyx::VerifyProfileUpdateParams::Flashcall::OrHash,
           language: String,
           name: String,
+          rcs: Telnyx::VerifyProfileUpdateParams::Rcs::OrHash,
           sms: Telnyx::VerifyProfileUpdateParams::SMS::OrHash,
           webhook_failover_url: String,
           webhook_url: String,
@@ -74,6 +81,7 @@ module Telnyx
         flashcall: nil,
         language: nil,
         name: nil,
+        rcs: nil,
         sms: nil,
         webhook_failover_url: nil,
         webhook_url: nil,
@@ -88,6 +96,7 @@ module Telnyx
             flashcall: Telnyx::VerifyProfileUpdateParams::Flashcall,
             language: String,
             name: String,
+            rcs: Telnyx::VerifyProfileUpdateParams::Rcs,
             sms: Telnyx::VerifyProfileUpdateParams::SMS,
             webhook_failover_url: String,
             webhook_url: String,
@@ -201,6 +210,14 @@ module Telnyx
             )
           end
 
+        # The name that identifies the application requesting 2fa in the verification
+        # message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :app_name
+
+        sig { params(app_name: String).void }
+        attr_writer :app_name
+
         # For every request that is initiated via this Verify profile, this sets the
         # number of seconds before a verification request code expires. Once the
         # verification request expires, the user cannot use the code to verify their
@@ -222,11 +239,15 @@ module Telnyx
 
         sig do
           params(
+            app_name: String,
             default_verification_timeout_secs: Integer,
             whitelisted_destinations: T::Array[String]
           ).returns(T.attached_class)
         end
         def self.new(
+          # The name that identifies the application requesting 2fa in the verification
+          # message.
+          app_name: nil,
           # For every request that is initiated via this Verify profile, this sets the
           # number of seconds before a verification request code expires. Once the
           # verification request expires, the user cannot use the code to verify their
@@ -242,6 +263,7 @@ module Telnyx
         sig do
           override.returns(
             {
+              app_name: String,
               default_verification_timeout_secs: Integer,
               whitelisted_destinations: T::Array[String]
             }
@@ -251,6 +273,111 @@ module Telnyx
         end
       end
 
+      class Rcs < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::VerifyProfileUpdateParams::Rcs,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The name that identifies the application requesting 2fa in the verification
+        # message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :app_name
+
+        sig { params(app_name: String).void }
+        attr_writer :app_name
+
+        # The length of the verify code to generate.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :code_length
+
+        sig { params(code_length: Integer).void }
+        attr_writer :code_length
+
+        # For every request that is initiated via this Verify profile, this sets the
+        # number of seconds before a verification request code expires. Once the
+        # verification request expires, the user cannot use the code to verify their
+        # identity.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :default_verification_timeout_secs
+
+        sig { params(default_verification_timeout_secs: Integer).void }
+        attr_writer :default_verification_timeout_secs
+
+        # The message template identifier selected from /verify_profiles/templates
+        sig { returns(T.nilable(String)) }
+        attr_reader :messaging_template_id
+
+        sig { params(messaging_template_id: String).void }
+        attr_writer :messaging_template_id
+
+        # Enable SMS fallback when RCS delivery fails.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sms_fallback
+
+        sig { params(sms_fallback: T::Boolean).void }
+        attr_writer :sms_fallback
+
+        # Enabled country destinations to send verification codes. The elements in the
+        # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+        # destinations will be allowed.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :whitelisted_destinations
+
+        sig { params(whitelisted_destinations: T::Array[String]).void }
+        attr_writer :whitelisted_destinations
+
+        sig do
+          params(
+            app_name: String,
+            code_length: Integer,
+            default_verification_timeout_secs: Integer,
+            messaging_template_id: String,
+            sms_fallback: T::Boolean,
+            whitelisted_destinations: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name that identifies the application requesting 2fa in the verification
+          # message.
+          app_name: nil,
+          # The length of the verify code to generate.
+          code_length: nil,
+          # For every request that is initiated via this Verify profile, this sets the
+          # number of seconds before a verification request code expires. Once the
+          # verification request expires, the user cannot use the code to verify their
+          # identity.
+          default_verification_timeout_secs: nil,
+          # The message template identifier selected from /verify_profiles/templates
+          messaging_template_id: nil,
+          # Enable SMS fallback when RCS delivery fails.
+          sms_fallback: nil,
+          # Enabled country destinations to send verification codes. The elements in the
+          # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+          # destinations will be allowed.
+          whitelisted_destinations: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              app_name: String,
+              code_length: Integer,
+              default_verification_timeout_secs: Integer,
+              messaging_template_id: String,
+              sms_fallback: T::Boolean,
+              whitelisted_destinations: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class SMS < Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/telnyx/models.rbi

@@ -50,6 +50,18 @@ module Telnyx
 
   AISummarizeParams = Telnyx::Models::AISummarizeParams
 
+  AlphanumericSenderIDCreateParams =
+    Telnyx::Models::AlphanumericSenderIDCreateParams
+
+  AlphanumericSenderIDDeleteParams =
+    Telnyx::Models::AlphanumericSenderIDDeleteParams
+
+  AlphanumericSenderIDListParams =
+    Telnyx::Models::AlphanumericSenderIDListParams
+
+  AlphanumericSenderIDRetrieveParams =
+    Telnyx::Models::AlphanumericSenderIDRetrieveParams
+
   AnchorsiteOverride = Telnyx::Models::AnchorsiteOverride
 
   APIError = Telnyx::Models::APIError
@@ -810,6 +822,9 @@ module Telnyx
 
   MessageCancelScheduledParams = Telnyx::Models::MessageCancelScheduledParams
 
+  MessageRetrieveGroupMessagesParams =
+    Telnyx::Models::MessageRetrieveGroupMessagesParams
+
   MessageRetrieveParams = Telnyx::Models::MessageRetrieveParams
 
   Messages = Telnyx::Models::Messages
@@ -828,6 +843,9 @@ module Telnyx
 
   MessageSendWhatsappParams = Telnyx::Models::MessageSendWhatsappParams
 
+  MessageSendWithAlphanumericSenderParams =
+    Telnyx::Models::MessageSendWithAlphanumericSenderParams
+
   MessageTemplate = Telnyx::Models::MessageTemplate
 
   Messaging = Telnyx::Models::Messaging
@@ -843,6 +861,9 @@ module Telnyx
   MessagingHostedNumberDeleteParams =
     Telnyx::Models::MessagingHostedNumberDeleteParams
 
+  MessagingHostedNumberListParams =
+    Telnyx::Models::MessagingHostedNumberListParams
+
   MessagingHostedNumberOrder = Telnyx::Models::MessagingHostedNumberOrder
 
   MessagingHostedNumberOrderCheckEligibilityParams =
@@ -868,6 +889,12 @@ module Telnyx
   MessagingHostedNumberOrderValidateCodesParams =
     Telnyx::Models::MessagingHostedNumberOrderValidateCodesParams
 
+  MessagingHostedNumberRetrieveParams =
+    Telnyx::Models::MessagingHostedNumberRetrieveParams
+
+  MessagingHostedNumberUpdateParams =
+    Telnyx::Models::MessagingHostedNumberUpdateParams
+
   MessagingNumbersBulkUpdateCreateParams =
     Telnyx::Models::MessagingNumbersBulkUpdateCreateParams
 
@@ -884,6 +911,9 @@ module Telnyx
 
   MessagingProfileDeleteParams = Telnyx::Models::MessagingProfileDeleteParams
 
+  MessagingProfileListAlphanumericSenderIDsParams =
+    Telnyx::Models::MessagingProfileListAlphanumericSenderIDsParams
+
   MessagingProfileListParams = Telnyx::Models::MessagingProfileListParams
 
   MessagingProfileListPhoneNumbersParams =
@@ -892,6 +922,12 @@ module Telnyx
   MessagingProfileListShortCodesParams =
     Telnyx::Models::MessagingProfileListShortCodesParams
 
+  MessagingProfileMetricListParams =
+    Telnyx::Models::MessagingProfileMetricListParams
+
+  MessagingProfileRetrieveMetricsParams =
+    Telnyx::Models::MessagingProfileRetrieveMetricsParams
+
   MessagingProfileRetrieveParams =
     Telnyx::Models::MessagingProfileRetrieveParams
 

data/rbi/telnyx/resources/alphanumeric_sender_ids.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AlphanumericSenderIDs
+      # Create a new alphanumeric sender ID associated with a messaging profile.
+      sig do
+        params(
+          alphanumeric_sender_id: String,
+          messaging_profile_id: String,
+          us_long_code_fallback: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::AlphanumericSenderIDCreateResponse)
+      end
+      def create(
+        # The alphanumeric sender ID string.
+        alphanumeric_sender_id:,
+        # The messaging profile to associate the sender ID with.
+        messaging_profile_id:,
+        # A US long code number to use as fallback when sending to US destinations.
+        us_long_code_fallback: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a specific alphanumeric sender ID.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::AlphanumericSenderIDRetrieveResponse)
+      end
+      def retrieve(
+        # The identifier of the alphanumeric sender ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # List all alphanumeric sender IDs for the authenticated user.
+      sig do
+        params(
+          filter_messaging_profile_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::Models::AlphanumericSenderIDListResponse
+          ]
+        )
+      end
+      def list(
+        # Filter by messaging profile ID.
+        filter_messaging_profile_id: nil,
+        # Page number.
+        page_number: nil,
+        # Page size.
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an alphanumeric sender ID and disassociate it from its messaging profile.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::AlphanumericSenderIDDeleteResponse)
+      end
+      def delete(
+        # The identifier of the alphanumeric sender ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/messages.rbi

@@ -38,6 +38,20 @@ module Telnyx
       )
       end
 
+      # Retrieve all messages in a group MMS conversation by the group message ID.
+      sig do
+        params(
+          message_id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessageRetrieveGroupMessagesResponse)
+      end
+      def retrieve_group_messages(
+        # The group message ID.
+        message_id,
+        request_options: {}
+      )
+      end
+
       # Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or
       # Number Pool.
       #
@@ -411,6 +425,38 @@ module Telnyx
       )
       end
 
+      # Send an SMS message using an alphanumeric sender ID. This is SMS only.
+      sig do
+        params(
+          from: String,
+          messaging_profile_id: String,
+          text: String,
+          to: String,
+          use_profile_webhooks: T::Boolean,
+          webhook_failover_url: T.nilable(String),
+          webhook_url: T.nilable(String),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessageSendWithAlphanumericSenderResponse)
+      end
+      def send_with_alphanumeric_sender(
+        # A valid alphanumeric sender ID on the user's account.
+        from:,
+        # The messaging profile ID to use.
+        messaging_profile_id:,
+        # The message body.
+        text:,
+        # Receiving address (+E.164 formatted phone number).
+        to:,
+        # If true, use the messaging profile's webhook settings.
+        use_profile_webhooks: nil,
+        # Failover callback URL for delivery status updates.
+        webhook_failover_url: nil,
+        # Callback URL for delivery status updates.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)