telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/mobile_phone_numbers/messaging_list_response.rbi

@@ -23,6 +23,20 @@ module Telnyx
         sig { returns(T.nilable(String)) }
         attr_accessor :messaging_profile_id
 
+        # The organization that owns this phone number.
+        sig { returns(T.nilable(String)) }
+        attr_reader :organization_id
+
+        sig { params(organization_id: String).void }
+        attr_writer :organization_id
+
+        # Tags associated with this phone number.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tags
+
+        sig { params(tags: T::Array[String]).void }
+        attr_writer :tags
+
         # Identifies the type of resource.
         sig { returns(T.nilable(String)) }
         attr_reader :id
@@ -127,9 +141,11 @@ module Telnyx
               Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::Features::OrHash,
             messaging_product: String,
             messaging_profile_id: T.nilable(String),
+            organization_id: String,
             phone_number: String,
             record_type:
               Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::RecordType::OrSymbol,
+            tags: T::Array[String],
             traffic_type: String,
             type:
               Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::Type::OrSymbol,
@@ -148,10 +164,14 @@ module Telnyx
           messaging_product: nil,
           # Unique identifier for a messaging profile.
           messaging_profile_id: nil,
+          # The organization that owns this phone number.
+          organization_id: nil,
           # +E.164 formatted phone number.
           phone_number: nil,
           # Identifies the type of the resource.
           record_type: nil,
+          # Tags associated with this phone number.
+          tags: nil,
           # The messaging traffic or use case for which the number is currently configured.
           traffic_type: nil,
           # The type of the phone number
@@ -171,9 +191,11 @@ module Telnyx
                 Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::Features,
               messaging_product: String,
               messaging_profile_id: T.nilable(String),
+              organization_id: String,
               phone_number: String,
               record_type:
                 Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::RecordType::TaggedSymbol,
+              tags: T::Array[String],
               traffic_type: String,
               type:
                 Telnyx::Models::MobilePhoneNumbers::MessagingListResponse::Type::TaggedSymbol,

data/rbi/telnyx/models/mobile_phone_numbers/messaging_retrieve_response.rbi

@@ -69,6 +69,20 @@ module Telnyx
           sig { returns(T.nilable(String)) }
           attr_accessor :messaging_profile_id
 
+          # The organization that owns this phone number.
+          sig { returns(T.nilable(String)) }
+          attr_reader :organization_id
+
+          sig { params(organization_id: String).void }
+          attr_writer :organization_id
+
+          # Tags associated with this phone number.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :tags
+
+          sig { params(tags: T::Array[String]).void }
+          attr_writer :tags
+
           # Identifies the type of resource.
           sig { returns(T.nilable(String)) }
           attr_reader :id
@@ -173,9 +187,11 @@ module Telnyx
                 Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::Features::OrHash,
               messaging_product: String,
               messaging_profile_id: T.nilable(String),
+              organization_id: String,
               phone_number: String,
               record_type:
                 Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::RecordType::OrSymbol,
+              tags: T::Array[String],
               traffic_type: String,
               type:
                 Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::Type::OrSymbol,
@@ -194,10 +210,14 @@ module Telnyx
             messaging_product: nil,
             # Unique identifier for a messaging profile.
             messaging_profile_id: nil,
+            # The organization that owns this phone number.
+            organization_id: nil,
             # +E.164 formatted phone number.
             phone_number: nil,
             # Identifies the type of the resource.
             record_type: nil,
+            # Tags associated with this phone number.
+            tags: nil,
             # The messaging traffic or use case for which the number is currently configured.
             traffic_type: nil,
             # The type of the phone number
@@ -217,9 +237,11 @@ module Telnyx
                   Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::Features,
                 messaging_product: String,
                 messaging_profile_id: T.nilable(String),
+                organization_id: String,
                 phone_number: String,
                 record_type:
                   Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::RecordType::TaggedSymbol,
+                tags: T::Array[String],
                 traffic_type: String,
                 type:
                   Telnyx::Models::MobilePhoneNumbers::MessagingRetrieveResponse::Data::Type::TaggedSymbol,

data/rbi/telnyx/models/phone_number_with_messaging_settings.rbi

@@ -29,6 +29,20 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :messaging_profile_id
 
+      # The organization that owns this phone number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :organization_id
+
+      sig { params(organization_id: String).void }
+      attr_writer :organization_id
+
+      # Tags associated with this phone number.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Identifies the type of resource.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -135,9 +149,11 @@ module Telnyx
           health: Telnyx::NumberHealthMetrics::OrHash,
           messaging_product: String,
           messaging_profile_id: T.nilable(String),
+          organization_id: String,
           phone_number: String,
           record_type:
             Telnyx::PhoneNumberWithMessagingSettings::RecordType::OrSymbol,
+          tags: T::Array[String],
           traffic_type: String,
           type: Telnyx::PhoneNumberWithMessagingSettings::Type::OrSymbol,
           updated_at: Time
@@ -159,10 +175,14 @@ module Telnyx
         messaging_product: nil,
         # Unique identifier for a messaging profile.
         messaging_profile_id: nil,
+        # The organization that owns this phone number.
+        organization_id: nil,
         # +E.164 formatted phone number.
         phone_number: nil,
         # Identifies the type of the resource.
         record_type: nil,
+        # Tags associated with this phone number.
+        tags: nil,
         # The messaging traffic or use case for which the number is currently configured.
         traffic_type: nil,
         # The type of the phone number
@@ -183,9 +203,11 @@ module Telnyx
             health: Telnyx::NumberHealthMetrics,
             messaging_product: String,
             messaging_profile_id: T.nilable(String),
+            organization_id: String,
             phone_number: String,
             record_type:
               Telnyx::PhoneNumberWithMessagingSettings::RecordType::TaggedSymbol,
+            tags: T::Array[String],
             traffic_type: String,
             type: Telnyx::PhoneNumberWithMessagingSettings::Type::TaggedSymbol,
             updated_at: Time

data/rbi/telnyx/models/phone_numbers/messaging_list_params.rbi

@@ -15,6 +15,45 @@ module Telnyx
             )
           end
 
+        # Filter by messaging profile ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_messaging_profile_id
+
+        sig { params(filter_messaging_profile_id: String).void }
+        attr_writer :filter_messaging_profile_id
+
+        # Filter by exact phone number (supports comma-separated list).
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_phone_number
+
+        sig { params(filter_phone_number: String).void }
+        attr_writer :filter_phone_number
+
+        # Filter by phone number substring.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_phone_number_contains
+
+        sig { params(filter_phone_number_contains: String).void }
+        attr_writer :filter_phone_number_contains
+
+        # Filter by phone number type.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::OrSymbol
+            )
+          )
+        end
+        attr_reader :filter_type
+
+        sig do
+          params(
+            filter_type:
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::OrSymbol
+          ).void
+        end
+        attr_writer :filter_type
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_number
 
@@ -27,27 +66,148 @@ module Telnyx
         sig { params(page_size: Integer).void }
         attr_writer :page_size
 
+        # Sort by phone number.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::OrSymbol
+            )
+          )
+        end
+        attr_reader :sort_phone_number
+
         sig do
           params(
+            sort_phone_number:
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::OrSymbol
+          ).void
+        end
+        attr_writer :sort_phone_number
+
+        sig do
+          params(
+            filter_messaging_profile_id: String,
+            filter_phone_number: String,
+            filter_phone_number_contains: String,
+            filter_type:
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::OrSymbol,
             page_number: Integer,
             page_size: Integer,
+            sort_phone_number:
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(page_number: nil, page_size: nil, request_options: {})
+        def self.new(
+          # Filter by messaging profile ID.
+          filter_messaging_profile_id: nil,
+          # Filter by exact phone number (supports comma-separated list).
+          filter_phone_number: nil,
+          # Filter by phone number substring.
+          filter_phone_number_contains: nil,
+          # Filter by phone number type.
+          filter_type: nil,
+          page_number: nil,
+          page_size: nil,
+          # Sort by phone number.
+          sort_phone_number: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
             {
+              filter_messaging_profile_id: String,
+              filter_phone_number: String,
+              filter_phone_number_contains: String,
+              filter_type:
+                Telnyx::PhoneNumbers::MessagingListParams::FilterType::OrSymbol,
               page_number: Integer,
               page_size: Integer,
+              sort_phone_number:
+                Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::OrSymbol,
               request_options: Telnyx::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        # Filter by phone number type.
+        module FilterType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::PhoneNumbers::MessagingListParams::FilterType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TOLLFREE =
+            T.let(
+              :tollfree,
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::TaggedSymbol
+            )
+          LONGCODE =
+            T.let(
+              :longcode,
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::TaggedSymbol
+            )
+          SHORTCODE =
+            T.let(
+              :shortcode,
+              Telnyx::PhoneNumbers::MessagingListParams::FilterType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::PhoneNumbers::MessagingListParams::FilterType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Sort by phone number.
+        module SortPhoneNumber
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ASC =
+            T.let(
+              :asc,
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::TaggedSymbol
+            )
+          DESC =
+            T.let(
+              :desc,
+              Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/phone_numbers/messaging_update_params.rbi

@@ -37,10 +37,18 @@ module Telnyx
         sig { params(messaging_profile_id: String).void }
         attr_writer :messaging_profile_id
 
+        # Tags to set on this phone number.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tags
+
+        sig { params(tags: T::Array[String]).void }
+        attr_writer :tags
+
         sig do
           params(
             messaging_product: String,
             messaging_profile_id: String,
+            tags: T::Array[String],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -57,6 +65,8 @@ module Telnyx
           # - Set this field to a quoted UUID of a messaging profile to assign this number
           #   to that messaging profile
           messaging_profile_id: nil,
+          # Tags to set on this phone number.
+          tags: nil,
           request_options: {}
         )
         end
@@ -66,6 +76,7 @@ module Telnyx
             {
               messaging_product: String,
               messaging_profile_id: String,
+              tags: T::Array[String],
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/verify_profile.rbi

@@ -42,6 +42,12 @@ module Telnyx
       sig { params(name: String).void }
       attr_writer :name
 
+      sig { returns(T.nilable(Telnyx::VerifyProfile::Rcs)) }
+      attr_reader :rcs
+
+      sig { params(rcs: Telnyx::VerifyProfile::Rcs::OrHash).void }
+      attr_writer :rcs
+
       # The possible verification profile record types.
       sig do
         returns(T.nilable(Telnyx::VerifyProfile::RecordType::TaggedSymbol))
@@ -85,6 +91,7 @@ module Telnyx
           flashcall: Telnyx::VerifyProfile::Flashcall::OrHash,
           language: String,
           name: String,
+          rcs: Telnyx::VerifyProfile::Rcs::OrHash,
           record_type: Telnyx::VerifyProfile::RecordType::OrSymbol,
           sms: Telnyx::VerifyProfile::SMS::OrHash,
           updated_at: String,
@@ -99,6 +106,7 @@ module Telnyx
         flashcall: nil,
         language: nil,
         name: nil,
+        rcs: nil,
         # The possible verification profile record types.
         record_type: nil,
         sms: nil,
@@ -117,6 +125,7 @@ module Telnyx
             flashcall: Telnyx::VerifyProfile::Flashcall,
             language: String,
             name: String,
+            rcs: Telnyx::VerifyProfile::Rcs,
             record_type: Telnyx::VerifyProfile::RecordType::TaggedSymbol,
             sms: Telnyx::VerifyProfile::SMS,
             updated_at: String,
@@ -225,6 +234,14 @@ module Telnyx
             T.any(Telnyx::VerifyProfile::Flashcall, 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
+
         # 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
@@ -236,11 +253,15 @@ module Telnyx
         attr_writer :default_verification_timeout_secs
 
         sig do
-          params(default_verification_timeout_secs: Integer).returns(
-            T.attached_class
-          )
+          params(
+            app_name: String,
+            default_verification_timeout_secs: Integer
+          ).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
@@ -249,7 +270,113 @@ module Telnyx
         )
         end
 
-        sig { override.returns({ default_verification_timeout_secs: Integer }) }
+        sig do
+          override.returns(
+            { app_name: String, default_verification_timeout_secs: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Rcs < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::VerifyProfile::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