telnyx 4.2.0 → 4.3.0

data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi

@@ -94,12 +94,90 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :verification_request_id
 
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :age_gated_content
+
+          sig { params(age_gated_content: T::Boolean).void }
+          attr_writer :age_gated_content
+
           sig { returns(T.nilable(String)) }
           attr_reader :business_addr2
 
           sig { params(business_addr2: String).void }
           attr_writer :business_addr2
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_country
+
+          sig { params(business_registration_country: String).void }
+          attr_writer :business_registration_country
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_number
+
+          sig { params(business_registration_number: String).void }
+          attr_writer :business_registration_number
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_type
+
+          sig { params(business_registration_type: String).void }
+          attr_writer :business_registration_type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :doing_business_as
+
+          sig { params(doing_business_as: String).void }
+          attr_writer :doing_business_as
+
+          # Business entity classification
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :entity_type
+
+          sig do
+            params(
+              entity_type:
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::OrSymbol
+            ).void
+          end
+          attr_writer :entity_type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :help_message_response
+
+          sig { params(help_message_response: String).void }
+          attr_writer :help_message_response
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_confirmation_response
+
+          sig { params(opt_in_confirmation_response: String).void }
+          attr_writer :opt_in_confirmation_response
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_keywords
+
+          sig { params(opt_in_keywords: String).void }
+          attr_writer :opt_in_keywords
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :privacy_policy_url
+
+          sig { params(privacy_policy_url: String).void }
+          attr_writer :privacy_policy_url
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :terms_and_condition_url
+
+          sig { params(terms_and_condition_url: String).void }
+          attr_writer :terms_and_condition_url
+
           # Tollfree verification status
           sig do
             returns(
@@ -154,7 +232,19 @@ module Telnyx
                 Telnyx::MessagingTollfree::Verification::UseCaseCategories::OrSymbol,
               use_case_summary: String,
               verification_request_id: String,
+              age_gated_content: T::Boolean,
               business_addr2: String,
+              business_registration_country: String,
+              business_registration_number: String,
+              business_registration_type: String,
+              doing_business_as: String,
+              entity_type:
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::OrSymbol,
+              help_message_response: String,
+              opt_in_confirmation_response: String,
+              opt_in_keywords: String,
+              privacy_policy_url: String,
+              terms_and_condition_url: String,
               verification_status:
                 Telnyx::MessagingTollfree::Verification::TfVerificationStatus::OrSymbol,
               webhook_url: String
@@ -184,7 +274,19 @@ module Telnyx
             use_case:,
             use_case_summary:,
             verification_request_id:,
+            age_gated_content: nil,
             business_addr2: nil,
+            business_registration_country: nil,
+            business_registration_number: nil,
+            business_registration_type: nil,
+            doing_business_as: nil,
+            # Business entity classification
+            entity_type: nil,
+            help_message_response: nil,
+            opt_in_confirmation_response: nil,
+            opt_in_keywords: nil,
+            privacy_policy_url: nil,
+            terms_and_condition_url: nil,
             # Tollfree verification status
             verification_status: nil,
             webhook_url: nil
@@ -221,7 +323,19 @@ module Telnyx
                   Telnyx::MessagingTollfree::Verification::UseCaseCategories::TaggedSymbol,
                 use_case_summary: String,
                 verification_request_id: String,
+                age_gated_content: T::Boolean,
                 business_addr2: String,
+                business_registration_country: String,
+                business_registration_number: String,
+                business_registration_type: String,
+                doing_business_as: String,
+                entity_type:
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol,
+                help_message_response: String,
+                opt_in_confirmation_response: String,
+                opt_in_keywords: String,
+                privacy_policy_url: String,
+                terms_and_condition_url: String,
                 verification_status:
                   Telnyx::MessagingTollfree::Verification::TfVerificationStatus::TaggedSymbol,
                 webhook_url: String
@@ -230,6 +344,56 @@ module Telnyx
           end
           def to_hash
           end
+
+          # Business entity classification
+          module EntityType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SOLE_PROPRIETOR =
+              T.let(
+                :SOLE_PROPRIETOR,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+            PRIVATE_PROFIT =
+              T.let(
+                :PRIVATE_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+            PUBLIC_PROFIT =
+              T.let(
+                :PUBLIC_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+            NON_PROFIT =
+              T.let(
+                :NON_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+            GOVERNMENT =
+              T.let(
+                :GOVERNMENT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestEgress::EntityType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi

@@ -99,24 +99,102 @@ module Telnyx
           end
           attr_accessor :verification_status
 
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :age_gated_content
+
+          sig { params(age_gated_content: T::Boolean).void }
+          attr_writer :age_gated_content
+
           sig { returns(T.nilable(String)) }
           attr_reader :business_addr2
 
           sig { params(business_addr2: String).void }
           attr_writer :business_addr2
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_country
+
+          sig { params(business_registration_country: String).void }
+          attr_writer :business_registration_country
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_number
+
+          sig { params(business_registration_number: String).void }
+          attr_writer :business_registration_number
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_registration_type
+
+          sig { params(business_registration_type: String).void }
+          attr_writer :business_registration_type
+
           sig { returns(T.nilable(Time)) }
           attr_reader :created_at
 
           sig { params(created_at: Time).void }
           attr_writer :created_at
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :doing_business_as
+
+          sig { params(doing_business_as: String).void }
+          attr_writer :doing_business_as
+
+          # Business entity classification
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :entity_type
+
+          sig do
+            params(
+              entity_type:
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::OrSymbol
+            ).void
+          end
+          attr_writer :entity_type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :help_message_response
+
+          sig { params(help_message_response: String).void }
+          attr_writer :help_message_response
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_confirmation_response
+
+          sig { params(opt_in_confirmation_response: String).void }
+          attr_writer :opt_in_confirmation_response
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :opt_in_keywords
+
+          sig { params(opt_in_keywords: String).void }
+          attr_writer :opt_in_keywords
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :privacy_policy_url
+
+          sig { params(privacy_policy_url: String).void }
+          attr_writer :privacy_policy_url
+
           sig { returns(T.nilable(String)) }
           attr_reader :reason
 
           sig { params(reason: String).void }
           attr_writer :reason
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :terms_and_condition_url
+
+          sig { params(terms_and_condition_url: String).void }
+          attr_writer :terms_and_condition_url
+
           sig { returns(T.nilable(Time)) }
           attr_reader :updated_at
 
@@ -160,9 +238,21 @@ module Telnyx
               use_case_summary: String,
               verification_status:
                 Telnyx::MessagingTollfree::Verification::TfVerificationStatus::OrSymbol,
+              age_gated_content: T::Boolean,
               business_addr2: String,
+              business_registration_country: String,
+              business_registration_number: String,
+              business_registration_type: String,
               created_at: Time,
+              doing_business_as: String,
+              entity_type:
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::OrSymbol,
+              help_message_response: String,
+              opt_in_confirmation_response: String,
+              opt_in_keywords: String,
+              privacy_policy_url: String,
               reason: String,
+              terms_and_condition_url: String,
               updated_at: Time,
               webhook_url: String
             ).returns(T.attached_class)
@@ -192,9 +282,21 @@ module Telnyx
             use_case_summary:,
             # Tollfree verification status
             verification_status:,
+            age_gated_content: nil,
             business_addr2: nil,
+            business_registration_country: nil,
+            business_registration_number: nil,
+            business_registration_type: nil,
             created_at: nil,
+            doing_business_as: nil,
+            # Business entity classification
+            entity_type: nil,
+            help_message_response: nil,
+            opt_in_confirmation_response: nil,
+            opt_in_keywords: nil,
+            privacy_policy_url: nil,
             reason: nil,
+            terms_and_condition_url: nil,
             updated_at: nil,
             webhook_url: nil
           )
@@ -231,9 +333,21 @@ module Telnyx
                 use_case_summary: String,
                 verification_status:
                   Telnyx::MessagingTollfree::Verification::TfVerificationStatus::TaggedSymbol,
+                age_gated_content: T::Boolean,
                 business_addr2: String,
+                business_registration_country: String,
+                business_registration_number: String,
+                business_registration_type: String,
                 created_at: Time,
+                doing_business_as: String,
+                entity_type:
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol,
+                help_message_response: String,
+                opt_in_confirmation_response: String,
+                opt_in_keywords: String,
+                privacy_policy_url: String,
                 reason: String,
+                terms_and_condition_url: String,
                 updated_at: Time,
                 webhook_url: String
               }
@@ -241,6 +355,56 @@ module Telnyx
           end
           def to_hash
           end
+
+          # Business entity classification
+          module EntityType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SOLE_PROPRIETOR =
+              T.let(
+                :SOLE_PROPRIETOR,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+            PRIVATE_PROFIT =
+              T.let(
+                :PRIVATE_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+            PUBLIC_PROFIT =
+              T.let(
+                :PUBLIC_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+            NON_PROFIT =
+              T.let(
+                :NON_PROFIT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+            GOVERNMENT =
+              T.let(
+                :GOVERNMENT,
+                Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::MessagingTollfree::Verification::VerificationRequestStatus::EntityType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/telnyx/models/network_coverage_list_response.rbi

@@ -64,16 +64,13 @@ module Telnyx
 
         # List of interface types supported in this region.
         sig do
-          returns(
-            T.nilable(T::Array[Telnyx::Models::AvailableService::TaggedSymbol])
-          )
+          returns(T.nilable(T::Array[Telnyx::AvailableService::TaggedSymbol]))
         end
         attr_reader :available_services
 
         sig do
           params(
-            available_services:
-              T::Array[Telnyx::Models::AvailableService::OrSymbol]
+            available_services: T::Array[Telnyx::AvailableService::OrSymbol]
           ).void
         end
         attr_writer :available_services
@@ -104,8 +101,7 @@ module Telnyx
 
         sig do
           params(
-            available_services:
-              T::Array[Telnyx::Models::AvailableService::OrSymbol],
+            available_services: T::Array[Telnyx::AvailableService::OrSymbol],
             location:
               Telnyx::Models::NetworkCoverageListResponse::Data::Location::OrHash,
             record_type: String
@@ -124,7 +120,7 @@ module Telnyx
           override.returns(
             {
               available_services:
-                T::Array[Telnyx::Models::AvailableService::TaggedSymbol],
+                T::Array[Telnyx::AvailableService::TaggedSymbol],
               location:
                 Telnyx::Models::NetworkCoverageListResponse::Data::Location,
               record_type: String

data/rbi/telnyx/models/outbound_voice_profile.rbi

@@ -30,6 +30,18 @@ module Telnyx
       sig { params(call_recording: Telnyx::OutboundCallRecording::OrHash).void }
       attr_writer :call_recording
 
+      # (BETA) Specifies the time window and call limits for calls made using this
+      # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+      sig { returns(T.nilable(Telnyx::OutboundVoiceProfile::CallingWindow)) }
+      attr_reader :calling_window
+
+      sig do
+        params(
+          calling_window: Telnyx::OutboundVoiceProfile::CallingWindow::OrHash
+        ).void
+      end
+      attr_writer :calling_window
+
       # Must be no more than your global concurrent call limit. Null means no limit.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :concurrent_call_limit
@@ -137,6 +149,7 @@ module Telnyx
           id: String,
           billing_group_id: T.nilable(String),
           call_recording: Telnyx::OutboundCallRecording::OrHash,
+          calling_window: Telnyx::OutboundVoiceProfile::CallingWindow::OrHash,
           concurrent_call_limit: T.nilable(Integer),
           connections_count: Integer,
           created_at: String,
@@ -162,6 +175,9 @@ module Telnyx
         # null (for no group assigned).
         billing_group_id: nil,
         call_recording: nil,
+        # (BETA) Specifies the time window and call limits for calls made using this
+        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        calling_window: nil,
         # Must be no more than your global concurrent call limit. Null means no limit.
         concurrent_call_limit: nil,
         # Amount of connections associated with this outbound voice profile.
@@ -204,6 +220,7 @@ module Telnyx
             id: String,
             billing_group_id: T.nilable(String),
             call_recording: Telnyx::OutboundCallRecording,
+            calling_window: Telnyx::OutboundVoiceProfile::CallingWindow,
             concurrent_call_limit: T.nilable(Integer),
             connections_count: Integer,
             created_at: String,
@@ -223,6 +240,70 @@ module Telnyx
       end
       def to_hash
       end
+
+      class CallingWindow < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::OutboundVoiceProfile::CallingWindow,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # (BETA) The maximum number of calls that can be initiated to a single called
+        # party (CLD) within the calling window. A null value means no limit.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :calls_per_cld
+
+        sig { params(calls_per_cld: Integer).void }
+        attr_writer :calls_per_cld
+
+        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+        # longer allowed to start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :end_time
+
+        sig { params(end_time: String).void }
+        attr_writer :end_time
+
+        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+        # allowed to start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :start_time
+
+        sig { params(start_time: String).void }
+        attr_writer :start_time
+
+        # (BETA) Specifies the time window and call limits for calls made using this
+        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        sig do
+          params(
+            calls_per_cld: Integer,
+            end_time: String,
+            start_time: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # (BETA) The maximum number of calls that can be initiated to a single called
+          # party (CLD) within the calling window. A null value means no limit.
+          calls_per_cld: nil,
+          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+          # longer allowed to start.
+          end_time: nil,
+          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+          # allowed to start.
+          start_time: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { calls_per_cld: Integer, end_time: String, start_time: String }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/outbound_voice_profile_create_params.rbi

@@ -29,6 +29,23 @@ module Telnyx
       sig { params(call_recording: Telnyx::OutboundCallRecording::OrHash).void }
       attr_writer :call_recording
 
+      # (BETA) Specifies the time window and call limits for calls made using this
+      # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+      sig do
+        returns(
+          T.nilable(Telnyx::OutboundVoiceProfileCreateParams::CallingWindow)
+        )
+      end
+      attr_reader :calling_window
+
+      sig do
+        params(
+          calling_window:
+            Telnyx::OutboundVoiceProfileCreateParams::CallingWindow::OrHash
+        ).void
+      end
+      attr_writer :calling_window
+
       # Must be no more than your global concurrent call limit. Null means no limit.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :concurrent_call_limit
@@ -107,6 +124,8 @@ module Telnyx
           name: String,
           billing_group_id: T.nilable(String),
           call_recording: Telnyx::OutboundCallRecording::OrHash,
+          calling_window:
+            Telnyx::OutboundVoiceProfileCreateParams::CallingWindow::OrHash,
           concurrent_call_limit: T.nilable(Integer),
           daily_spend_limit: String,
           daily_spend_limit_enabled: T::Boolean,
@@ -127,6 +146,9 @@ module Telnyx
         # null (for no group assigned).
         billing_group_id: nil,
         call_recording: nil,
+        # (BETA) Specifies the time window and call limits for calls made using this
+        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        calling_window: nil,
         # Must be no more than your global concurrent call limit. Null means no limit.
         concurrent_call_limit: nil,
         # The maximum amount of usage charges, in USD, you want Telnyx to allow on this
@@ -161,6 +183,8 @@ module Telnyx
             name: String,
             billing_group_id: T.nilable(String),
             call_recording: Telnyx::OutboundCallRecording,
+            calling_window:
+              Telnyx::OutboundVoiceProfileCreateParams::CallingWindow,
             concurrent_call_limit: T.nilable(Integer),
             daily_spend_limit: String,
             daily_spend_limit_enabled: T::Boolean,
@@ -177,6 +201,70 @@ module Telnyx
       end
       def to_hash
       end
+
+      class CallingWindow < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::OutboundVoiceProfileCreateParams::CallingWindow,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # (BETA) The maximum number of calls that can be initiated to a single called
+        # party (CLD) within the calling window. A null value means no limit.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :calls_per_cld
+
+        sig { params(calls_per_cld: Integer).void }
+        attr_writer :calls_per_cld
+
+        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+        # longer allowed to start.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :end_time
+
+        sig { params(end_time: Time).void }
+        attr_writer :end_time
+
+        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+        # allowed to start.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :start_time
+
+        sig { params(start_time: Time).void }
+        attr_writer :start_time
+
+        # (BETA) Specifies the time window and call limits for calls made using this
+        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        sig do
+          params(
+            calls_per_cld: Integer,
+            end_time: Time,
+            start_time: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # (BETA) The maximum number of calls that can be initiated to a single called
+          # party (CLD) within the calling window. A null value means no limit.
+          calls_per_cld: nil,
+          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
+          # longer allowed to start.
+          end_time: nil,
+          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+          # allowed to start.
+          start_time: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { calls_per_cld: Integer, end_time: Time, start_time: Time }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end