telnyx 5.36.0 → 5.36.2

data/rbi/telnyx/models/messaging_profile_retrieve_metrics_params.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileRetrieveMetricsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::MessagingProfileRetrieveMetricsParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # The time frame for metrics.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::OrSymbol
+          )
+        )
+      end
+      attr_reader :time_frame
+
+      sig do
+        params(
+          time_frame:
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::OrSymbol
+        ).void
+      end
+      attr_writer :time_frame
+
+      sig do
+        params(
+          time_frame:
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The time frame for metrics.
+        time_frame: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            time_frame:
+              Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::OrSymbol,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The time frame for metrics.
+      module TimeFrame
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TIME_FRAME_1H =
+          T.let(
+            :"1h",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_3H =
+          T.let(
+            :"3h",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_24H =
+          T.let(
+            :"24h",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_3D =
+          T.let(
+            :"3d",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_7D =
+          T.let(
+            :"7d",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+        TIME_FRAME_30D =
+          T.let(
+            :"30d",
+            Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::MessagingProfileRetrieveMetricsParams::TimeFrame::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profile_retrieve_metrics_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileRetrieveMetricsResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::MessagingProfileRetrieveMetricsResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Detailed metrics for a messaging profile.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :data
+
+      sig { params(data: T::Hash[Symbol, T.anything]).void }
+      attr_writer :data
+
+      sig do
+        params(data: T::Hash[Symbol, T.anything]).returns(T.attached_class)
+      end
+      def self.new(
+        # Detailed metrics for a messaging profile.
+        data: nil
+      )
+      end
+
+      sig { override.returns({ data: T::Hash[Symbol, T.anything] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module MessagingProfiles
+      class ActionRegenerateSecretParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::MessagingProfiles::ActionRegenerateSecretParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Telnyx::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profiles/action_regenerate_secret_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module MessagingProfiles
+      class ActionRegenerateSecretResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::MessagingProfiles::ActionRegenerateSecretResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Telnyx::MessagingProfile)) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::MessagingProfile::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::MessagingProfile::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data: nil)
+        end
+
+        sig { override.returns({ data: Telnyx::MessagingProfile }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -25,6 +25,13 @@ module Telnyx
           sig { returns(Integer) }
           attr_accessor :page_size
 
+          # Filter verification requests by business name
+          sig { returns(T.nilable(String)) }
+          attr_reader :business_name
+
+          sig { params(business_name: String).void }
+          attr_writer :business_name
+
           sig { returns(T.nilable(Time)) }
           attr_reader :date_end
 
@@ -65,6 +72,7 @@ module Telnyx
             params(
               page: Integer,
               page_size: Integer,
+              business_name: String,
               date_end: Time,
               date_start: Time,
               phone_number: String,
@@ -79,6 +87,8 @@ module Telnyx
             #
             #         This value is automatically clamped if the provided value is too large.
             page_size:,
+            # Filter verification requests by business name
+            business_name: nil,
             date_end: nil,
             date_start: nil,
             phone_number: nil,
@@ -93,6 +103,7 @@ module Telnyx
               {
                 page: Integer,
                 page_size: Integer,
+                business_name: String,
                 date_end: Time,
                 date_start: Time,
                 phone_number: String,

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

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module MessagingTollfree
+      module Verification
+        class RequestRetrieveStatusHistoryParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Integer) }
+          attr_accessor :page_number
+
+          # Request this many records per page. This value is automatically clamped if the
+          # provided value is too large.
+          sig { returns(Integer) }
+          attr_accessor :page_size
+
+          sig do
+            params(
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            page_number:,
+            # Request this many records per page. This value is automatically clamped if the
+            # provided value is too large.
+            page_size:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module MessagingTollfree
+      module Verification
+        class RequestRetrieveStatusHistoryResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The records yielded by this request
+          sig do
+            returns(
+              T::Array[
+                Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record
+              ]
+            )
+          end
+          attr_accessor :records
+
+          # The total amount of records for these query parameters
+          sig { returns(Integer) }
+          attr_accessor :total_records
+
+          # A paginated response
+          sig do
+            params(
+              records:
+                T::Array[
+                  Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record::OrHash
+                ],
+              total_records: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The records yielded by this request
+            records:,
+            # The total amount of records for these query parameters
+            total_records:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                records:
+                  T::Array[
+                    Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record
+                  ],
+                total_records: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Record < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The timestamp at which this status change occurred
+            sig { returns(Time) }
+            attr_accessor :updated_at
+
+            # Tollfree verification status
+            sig do
+              returns(
+                Telnyx::MessagingTollfree::Verification::TfVerificationStatus::TaggedSymbol
+              )
+            end
+            attr_accessor :verification_status
+
+            # An explanation of why this request has its current status.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :reason
+
+            # A single entry in the verification request status history
+            sig do
+              params(
+                updated_at: Time,
+                verification_status:
+                  Telnyx::MessagingTollfree::Verification::TfVerificationStatus::OrSymbol,
+                reason: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The timestamp at which this status change occurred
+              updated_at:,
+              # Tollfree verification status
+              verification_status:,
+              # An explanation of why this request has its current status.
+              reason: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  updated_at: Time,
+                  verification_status:
+                    Telnyx::MessagingTollfree::Verification::TfVerificationStatus::TaggedSymbol,
+                  reason: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -60,10 +60,6 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :corporate_website
 
-          # ISV name
-          sig { returns(String) }
-          attr_accessor :isv_reseller
-
           # Message Volume Enums
           sig do
             returns(Telnyx::MessagingTollfree::Verification::Volume::OrSymbol)
@@ -159,6 +155,10 @@ module Telnyx
           sig { returns(T.nilable(String)) }
           attr_accessor :help_message_response
 
+          # ISV name
+          sig { returns(T.nilable(String)) }
+          attr_accessor :isv_reseller
+
           # Message sent to users confirming their opt-in to receive messages
           sig { returns(T.nilable(String)) }
           attr_accessor :opt_in_confirmation_response
@@ -198,7 +198,6 @@ module Telnyx
               business_state: String,
               business_zip: String,
               corporate_website: String,
-              isv_reseller: String,
               message_volume:
                 Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
               opt_in_workflow: String,
@@ -224,6 +223,7 @@ module Telnyx
                   Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                 ),
               help_message_response: T.nilable(String),
+              isv_reseller: T.nilable(String),
               opt_in_confirmation_response: T.nilable(String),
               opt_in_keywords: T.nilable(String),
               privacy_policy_url: T.nilable(String),
@@ -257,8 +257,6 @@ module Telnyx
             business_zip:,
             # A URL, including the scheme, pointing to the corporate website
             corporate_website:,
-            # ISV name
-            isv_reseller:,
             # Message Volume Enums
             message_volume:,
             # Human-readable description of how end users will opt into receiving messages
@@ -298,6 +296,8 @@ module Telnyx
             entity_type: nil,
             # The message returned when users text 'HELP'
             help_message_response: nil,
+            # ISV name
+            isv_reseller: nil,
             # Message sent to users confirming their opt-in to receive messages
             opt_in_confirmation_response: nil,
             # Keywords used to collect and process consumer opt-ins
@@ -327,7 +327,6 @@ module Telnyx
                 business_state: String,
                 business_zip: String,
                 corporate_website: String,
-                isv_reseller: String,
                 message_volume:
                   Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
                 opt_in_workflow: String,
@@ -353,6 +352,7 @@ module Telnyx
                     Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol
                   ),
                 help_message_response: T.nilable(String),
+                isv_reseller: T.nilable(String),
                 opt_in_confirmation_response: T.nilable(String),
                 opt_in_keywords: T.nilable(String),
                 privacy_policy_url: T.nilable(String),

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

@@ -51,9 +51,6 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :corporate_website
 
-          sig { returns(String) }
-          attr_accessor :isv_reseller
-
           # Message Volume Enums
           sig do
             returns(
@@ -159,6 +156,12 @@ module Telnyx
           sig { params(help_message_response: String).void }
           attr_writer :help_message_response
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :isv_reseller
+
+          sig { params(isv_reseller: String).void }
+          attr_writer :isv_reseller
+
           sig { returns(T.nilable(String)) }
           attr_reader :opt_in_confirmation_response
 
@@ -222,7 +225,6 @@ module Telnyx
               business_state: String,
               business_zip: String,
               corporate_website: String,
-              isv_reseller: String,
               message_volume:
                 Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
               opt_in_workflow: String,
@@ -247,6 +249,7 @@ module Telnyx
               entity_type:
                 Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol,
               help_message_response: String,
+              isv_reseller: String,
               opt_in_confirmation_response: String,
               opt_in_keywords: String,
               privacy_policy_url: String,
@@ -269,7 +272,6 @@ module Telnyx
             business_state:,
             business_zip:,
             corporate_website:,
-            isv_reseller:,
             # Message Volume Enums
             message_volume:,
             opt_in_workflow:,
@@ -292,6 +294,7 @@ module Telnyx
             # Business entity classification
             entity_type: nil,
             help_message_response: nil,
+            isv_reseller: nil,
             opt_in_confirmation_response: nil,
             opt_in_keywords: nil,
             privacy_policy_url: nil,
@@ -317,7 +320,6 @@ module Telnyx
                 business_state: String,
                 business_zip: String,
                 corporate_website: String,
-                isv_reseller: String,
                 message_volume:
                   Telnyx::MessagingTollfree::Verification::Volume::TaggedSymbol,
                 opt_in_workflow: String,
@@ -342,6 +344,7 @@ module Telnyx
                 entity_type:
                   Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::TaggedSymbol,
                 help_message_response: String,
+                isv_reseller: String,
                 opt_in_confirmation_response: String,
                 opt_in_keywords: String,
                 privacy_policy_url: String,

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

@@ -51,9 +51,6 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :corporate_website
 
-          sig { returns(String) }
-          attr_accessor :isv_reseller
-
           # Message Volume Enums
           sig do
             returns(
@@ -170,6 +167,12 @@ module Telnyx
           sig { params(help_message_response: String).void }
           attr_writer :help_message_response
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :isv_reseller
+
+          sig { params(isv_reseller: String).void }
+          attr_writer :isv_reseller
+
           sig { returns(T.nilable(String)) }
           attr_reader :opt_in_confirmation_response
 
@@ -227,7 +230,6 @@ module Telnyx
               business_state: String,
               business_zip: String,
               corporate_website: String,
-              isv_reseller: String,
               message_volume:
                 Telnyx::MessagingTollfree::Verification::Volume::OrSymbol,
               opt_in_workflow: String,
@@ -254,6 +256,7 @@ module Telnyx
               entity_type:
                 Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::OrSymbol,
               help_message_response: String,
+              isv_reseller: String,
               opt_in_confirmation_response: String,
               opt_in_keywords: String,
               privacy_policy_url: String,
@@ -276,7 +279,6 @@ module Telnyx
             business_state:,
             business_zip:,
             corporate_website:,
-            isv_reseller:,
             # Message Volume Enums
             message_volume:,
             opt_in_workflow:,
@@ -301,6 +303,7 @@ module Telnyx
             # Business entity classification
             entity_type: nil,
             help_message_response: nil,
+            isv_reseller: nil,
             opt_in_confirmation_response: nil,
             opt_in_keywords: nil,
             privacy_policy_url: nil,
@@ -326,7 +329,6 @@ module Telnyx
                 business_state: String,
                 business_zip: String,
                 corporate_website: String,
-                isv_reseller: String,
                 message_volume:
                   Telnyx::MessagingTollfree::Verification::Volume::TaggedSymbol,
                 opt_in_workflow: String,
@@ -353,6 +355,7 @@ module Telnyx
                 entity_type:
                   Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType::TaggedSymbol,
                 help_message_response: String,
+                isv_reseller: String,
                 opt_in_confirmation_response: String,
                 opt_in_keywords: String,
                 privacy_policy_url: String,