telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/enterprises/reputation/external_verification_wrapped.rbi

@@ -0,0 +1,158 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class ExternalVerificationWrapped < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Enterprises::Reputation::ExternalVerificationWrapped,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The ownership-proof documents on file.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :document_ids
+
+            sig { params(document_ids: T::Array[String]).void }
+            attr_writer :document_ids
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :enterprise_id
+
+            sig { params(enterprise_id: String).void }
+            attr_writer :enterprise_id
+
+            # The phone numbers you listed with the documents.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :phone_numbers
+
+            sig { params(phone_numbers: T::Array[String]).void }
+            attr_writer :phone_numbers
+
+            # Why the proof was rejected. Set only when `status` is `rejected`.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :rejection_reason
+
+            # Review state of the ownership proof that allows adding phone numbers hosted with
+            # another provider.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :status
+
+            sig do
+              params(
+                status:
+                  Telnyx::Enterprises::Reputation::ExternalVerificationStatus::OrSymbol
+              ).void
+            end
+            attr_writer :status
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :reviewed_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :submitted_at
+
+            sig do
+              params(
+                document_ids: T::Array[String],
+                enterprise_id: String,
+                phone_numbers: T::Array[String],
+                rejection_reason: T.nilable(String),
+                reviewed_at: T.nilable(Time),
+                status:
+                  Telnyx::Enterprises::Reputation::ExternalVerificationStatus::OrSymbol,
+                submitted_at: T.nilable(Time)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ownership-proof documents on file.
+              document_ids: nil,
+              enterprise_id: nil,
+              # The phone numbers you listed with the documents.
+              phone_numbers: nil,
+              # Why the proof was rejected. Set only when `status` is `rejected`.
+              rejection_reason: nil,
+              reviewed_at: nil,
+              # Review state of the ownership proof that allows adding phone numbers hosted with
+              # another provider.
+              status: nil,
+              submitted_at: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  document_ids: T::Array[String],
+                  enterprise_id: String,
+                  phone_numbers: T::Array[String],
+                  rejection_reason: T.nilable(String),
+                  reviewed_at: T.nilable(Time),
+                  status:
+                    Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol,
+                  submitted_at: T.nilable(Time)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/loa_render_params.rbi

@@ -22,13 +22,16 @@ module Telnyx
           # Third-party reseller / partner managing the enterprise's phone numbers. Omit
           # when the enterprise works directly with Telnyx.
           sig do
-            returns(T.nilable(Telnyx::Enterprises::Reputation::AgentInput))
+            returns(
+              T.nilable(Telnyx::Enterprises::Reputation::LoaRenderParams::Agent)
+            )
           end
           attr_reader :agent
 
           sig do
             params(
-              agent: Telnyx::Enterprises::Reputation::AgentInput::OrHash
+              agent:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Agent::OrHash
             ).void
           end
           attr_writer :agent
@@ -55,7 +58,8 @@ module Telnyx
           sig do
             params(
               enterprise_id: String,
-              agent: Telnyx::Enterprises::Reputation::AgentInput::OrHash,
+              agent:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Agent::OrHash,
               signature:
                 Telnyx::Enterprises::Reputation::LoaRenderParams::Signature::OrHash,
               request_options: Telnyx::RequestOptions::OrHash
@@ -77,7 +81,7 @@ module Telnyx
             override.returns(
               {
                 enterprise_id: String,
-                agent: Telnyx::Enterprises::Reputation::AgentInput,
+                agent: Telnyx::Enterprises::Reputation::LoaRenderParams::Agent,
                 signature:
                   Telnyx::Enterprises::Reputation::LoaRenderParams::Signature,
                 request_options: Telnyx::RequestOptions
@@ -87,6 +91,107 @@ module Telnyx
           def to_hash
           end
 
+          class Agent < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Enterprises::Reputation::LoaRenderParams::Agent,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :administrative_area
+
+            sig { returns(String) }
+            attr_accessor :city
+
+            sig { returns(String) }
+            attr_accessor :contact_email
+
+            sig { returns(String) }
+            attr_accessor :contact_name
+
+            sig { returns(String) }
+            attr_accessor :contact_phone
+
+            sig { returns(String) }
+            attr_accessor :contact_title
+
+            sig { returns(String) }
+            attr_accessor :country
+
+            sig { returns(String) }
+            attr_accessor :legal_name
+
+            sig { returns(String) }
+            attr_accessor :postal_code
+
+            sig { returns(String) }
+            attr_accessor :street_address
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :dba
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :extended_address
+
+            # Third-party reseller / partner managing the enterprise's phone numbers. Omit
+            # when the enterprise works directly with Telnyx.
+            sig do
+              params(
+                administrative_area: String,
+                city: String,
+                contact_email: String,
+                contact_name: String,
+                contact_phone: String,
+                contact_title: String,
+                country: String,
+                legal_name: String,
+                postal_code: String,
+                street_address: String,
+                dba: T.nilable(String),
+                extended_address: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              administrative_area:,
+              city:,
+              contact_email:,
+              contact_name:,
+              contact_phone:,
+              contact_title:,
+              country:,
+              legal_name:,
+              postal_code:,
+              street_address:,
+              dba: nil,
+              extended_address: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  administrative_area: String,
+                  city: String,
+                  contact_email: String,
+                  contact_name: String,
+                  contact_phone: String,
+                  contact_title: String,
+                  country: String,
+                  legal_name: String,
+                  postal_code: String,
+                  street_address: String,
+                  dba: T.nilable(String),
+                  extended_address: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
           class Signature < Telnyx::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/telnyx/models/enterprises/reputation/number_list_params.rbi

@@ -19,6 +19,26 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :enterprise_id
 
+          # Only numbers with this ownership status. `removed` lists the numbers that were
+          # removed, each with its `removal_reason` and `removed_at`; removed numbers are
+          # not returned otherwise.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol
+              )
+            )
+          end
+          attr_reader :filter_ownership_status
+
+          sig do
+            params(
+              filter_ownership_status:
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol
+            ).void
+          end
+          attr_writer :filter_ownership_status
+
           # Partial match on phone number. Must contain at least 5 digits.
           sig { returns(T.nilable(String)) }
           attr_reader :filter_phone_number_contains
@@ -33,6 +53,24 @@ module Telnyx
           sig { params(filter_phone_number_eq: String).void }
           attr_writer :filter_phone_number_eq
 
+          # Only numbers with this source.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+              )
+            )
+          end
+          attr_reader :filter_source
+
+          sig do
+            params(
+              filter_source:
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol
+            ).void
+          end
+          attr_writer :filter_source
+
           # 1-based page number. Out-of-range values return an empty page with correct meta.
           sig { returns(T.nilable(Integer)) }
           attr_reader :page_number
@@ -50,8 +88,12 @@ module Telnyx
           sig do
             params(
               enterprise_id: String,
+              filter_ownership_status:
+                Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol,
               filter_phone_number_contains: String,
               filter_phone_number_eq: String,
+              filter_source:
+                Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol,
               page_number: Integer,
               page_size: Integer,
               request_options: Telnyx::RequestOptions::OrHash
@@ -59,10 +101,16 @@ module Telnyx
           end
           def self.new(
             enterprise_id:,
+            # Only numbers with this ownership status. `removed` lists the numbers that were
+            # removed, each with its `removal_reason` and `removed_at`; removed numbers are
+            # not returned otherwise.
+            filter_ownership_status: nil,
             # Partial match on phone number. Must contain at least 5 digits.
             filter_phone_number_contains: nil,
             # Exact phone-number match (E.164).
             filter_phone_number_eq: nil,
+            # Only numbers with this source.
+            filter_source: nil,
             # 1-based page number. Out-of-range values return an empty page with correct meta.
             page_number: nil,
             # Items per page. Default 10. Maximum 250; values above are clamped to 250.
@@ -75,8 +123,12 @@ module Telnyx
             override.returns(
               {
                 enterprise_id: String,
+                filter_ownership_status:
+                  Telnyx::Enterprises::Reputation::ReputationOwnershipStatus::OrSymbol,
                 filter_phone_number_contains: String,
                 filter_phone_number_eq: String,
+                filter_source:
+                  Telnyx::Enterprises::Reputation::ReputationNumberSource::OrSymbol,
                 page_number: Integer,
                 page_size: Integer,
                 request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/enterprises/reputation/number_ownership_confirm_params.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class NumberOwnershipConfirmParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Enterprises::Reputation::NumberOwnershipConfirmParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          sig { returns(String) }
+          attr_accessor :phone_number
+
+          # `true` confirms you still own the number. `false` reports that you no longer own
+          # it and removes it from Number Reputation.
+          sig { returns(T::Boolean) }
+          attr_accessor :still_own
+
+          # Optional id of an uploaded document supporting the confirmation.
+          sig { returns(T.nilable(String)) }
+          attr_reader :evidence_document_id
+
+          sig { params(evidence_document_id: String).void }
+          attr_writer :evidence_document_id
+
+          sig do
+            params(
+              enterprise_id: String,
+              phone_number: String,
+              still_own: T::Boolean,
+              evidence_document_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            phone_number:,
+            # `true` confirms you still own the number. `false` reports that you no longer own
+            # it and removes it from Number Reputation.
+            still_own:,
+            # Optional id of an uploaded document supporting the confirmation.
+            evidence_document_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                phone_number: String,
+                still_own: T::Boolean,
+                evidence_document_id: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/number_retrieve_ownership_params.rbi

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