telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/enterprises/enterprise_email_verification_status_wrapped.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    EnterpriseEmailVerificationStatusWrapped =
+      Enterprises::EnterpriseEmailVerificationStatusWrapped
+
+    module Enterprises
+      class EnterpriseEmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Verification state for an enterprise account's contact email.
+        sig do
+          returns(
+            Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Verification state for an enterprise account's contact email.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Whether the enterprise account's contact email has been confirmed.
+          sig { returns(T::Boolean) }
+          attr_accessor :email_verified
+
+          # `sent` after a code is emailed; `verified` after a successful confirm.
+          sig do
+            returns(
+              Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # Always `email_verification`.
+          sig do
+            returns(
+              Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+            )
+          end
+          attr_accessor :record_type
+
+          # When the code just sent stops being accepted. Present on a send response; null
+          # on a confirm response.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :expires_at
+
+          # How many more codes may be requested for this enterprise account today. Present
+          # on a send response; null on a confirm response.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :sends_remaining_today
+
+          # Verification state for an enterprise account's contact email.
+          sig do
+            params(
+              email_verified: T::Boolean,
+              record_type:
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType::OrSymbol,
+              status:
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::OrSymbol,
+              expires_at: T.nilable(Time),
+              sends_remaining_today: T.nilable(Integer)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether the enterprise account's contact email has been confirmed.
+            email_verified:,
+            # Always `email_verification`.
+            record_type:,
+            # `sent` after a code is emailed; `verified` after a successful confirm.
+            status:,
+            # When the code just sent stops being accepted. Present on a send response; null
+            # on a confirm response.
+            expires_at: nil,
+            # How many more codes may be requested for this enterprise account today. Present
+            # on a send response; null on a confirm response.
+            sends_remaining_today: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                email_verified: T::Boolean,
+                record_type:
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol,
+                status:
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::TaggedSymbol,
+                expires_at: T.nilable(Time),
+                sends_remaining_today: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Always `email_verification`.
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EMAIL_VERIFICATION =
+              T.let(
+                :email_verification,
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # `sent` after a code is emailed; `verified` after a successful confirm.
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SENT =
+              T.let(
+                :sent,
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              )
+            VERIFIED =
+              T.let(
+                :verified,
+                Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/enterprise_reputation_public.rbi

@@ -39,6 +39,17 @@ module Telnyx
         sig { params(enterprise_id: String).void }
         attr_writer :enterprise_id
 
+        # 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_accessor :external_verification_status
+
         # Id of the signed LOA document.
         sig { returns(T.nilable(String)) }
         attr_accessor :loa_document_id
@@ -84,6 +95,10 @@ module Telnyx
         end
         attr_writer :status
 
+        # HTTPS URL that receives number-ownership webhook events for this enterprise.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :webhook_url
+
         sig { returns(T.nilable(Time)) }
         attr_reader :created_at
 
@@ -102,13 +117,18 @@ module Telnyx
               Telnyx::Enterprises::ReputationCheckFrequency::OrSymbol,
             created_at: Time,
             enterprise_id: String,
+            external_verification_status:
+              T.nilable(
+                Telnyx::Enterprises::Reputation::ExternalVerificationStatus::OrSymbol
+              ),
             loa_document_id: T.nilable(String),
             loa_status:
               Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::OrSymbol,
             rejection_reasons: T.nilable(T::Array[String]),
             status:
               Telnyx::Enterprises::EnterpriseReputationPublic::Status::OrSymbol,
-            updated_at: Time
+            updated_at: Time,
+            webhook_url: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -117,6 +137,9 @@ module Telnyx
           check_frequency: nil,
           created_at: nil,
           enterprise_id: nil,
+          # Review state of the ownership proof that allows adding phone numbers hosted with
+          # another provider.
+          external_verification_status: nil,
           # Id of the signed LOA document.
           loa_document_id: nil,
           # Customer-facing Letter-of-Authorization verification state. `approved` is
@@ -126,7 +149,9 @@ module Telnyx
           rejection_reasons: nil,
           # Lifecycle status of the enterprise's Phone Number Reputation activation.
           status: nil,
-          updated_at: nil
+          updated_at: nil,
+          # HTTPS URL that receives number-ownership webhook events for this enterprise.
+          webhook_url: nil
         )
         end
 
@@ -137,13 +162,18 @@ module Telnyx
                 Telnyx::Enterprises::ReputationCheckFrequency::TaggedSymbol,
               created_at: Time,
               enterprise_id: String,
+              external_verification_status:
+                T.nilable(
+                  Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+                ),
               loa_document_id: T.nilable(String),
               loa_status:
                 Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol,
               rejection_reasons: T.nilable(T::Array[String]),
               status:
                 Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol,
-              updated_at: Time
+              updated_at: Time,
+              webhook_url: T.nilable(String)
             }
           )
         end

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

@@ -13,44 +13,63 @@ module Telnyx
               )
             end
 
+          # The state or province of the partner's address, as its code, for example IL or
+          # ON.
           sig { returns(String) }
           attr_accessor :administrative_area
 
+          # The city of the partner's address.
           sig { returns(String) }
           attr_accessor :city
 
+          # The email address of the contact person at the partner.
           sig { returns(String) }
           attr_accessor :contact_email
 
+          # The name of a contact person at the partner.
           sig { returns(String) }
           attr_accessor :contact_name
 
+          # The phone number of the contact person at the partner, in E.164 format, for
+          # example +13125550000.
           sig { returns(String) }
           attr_accessor :contact_phone
 
+          # The job title of the contact person at the partner.
           sig { returns(String) }
           attr_accessor :contact_title
 
+          # The two-letter country code of the partner's address, for example US.
           sig { returns(String) }
           attr_accessor :country
 
+          # The legal name of the third-party partner or reseller managing these numbers on
+          # your behalf.
           sig { returns(String) }
           attr_accessor :legal_name
 
+          # The postal or ZIP code of the partner's address.
           sig { returns(String) }
           attr_accessor :postal_code
 
+          # The street address of the partner, including the building number and street
+          # name.
           sig { returns(String) }
           attr_accessor :street_address
 
+          # The trade name (Doing Business As) the partner operates under, if different from
+          # its legal name. Leave blank if it does not apply.
           sig { returns(T.nilable(String)) }
           attr_accessor :dba
 
+          # An optional second address line for the partner, such as a suite, unit, or
+          # floor. Leave blank if it does not apply.
           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.
+          # Third-party reseller / partner managing the enterprise's phone numbers on its
+          # behalf, such as a call center (BPO) acting for a client. Omit when the
+          # enterprise manages its own numbers.
           sig do
             params(
               administrative_area: String,
@@ -68,17 +87,35 @@ module Telnyx
             ).returns(T.attached_class)
           end
           def self.new(
+            # The state or province of the partner's address, as its code, for example IL or
+            # ON.
             administrative_area:,
+            # The city of the partner's address.
             city:,
+            # The email address of the contact person at the partner.
             contact_email:,
+            # The name of a contact person at the partner.
             contact_name:,
+            # The phone number of the contact person at the partner, in E.164 format, for
+            # example +13125550000.
             contact_phone:,
+            # The job title of the contact person at the partner.
             contact_title:,
+            # The two-letter country code of the partner's address, for example US.
             country:,
+            # The legal name of the third-party partner or reseller managing these numbers on
+            # your behalf.
             legal_name:,
+            # The postal or ZIP code of the partner's address.
             postal_code:,
+            # The street address of the partner, including the building number and street
+            # name.
             street_address:,
+            # The trade name (Doing Business As) the partner operates under, if different from
+            # its legal name. Leave blank if it does not apply.
             dba: nil,
+            # An optional second address line for the partner, such as a suite, unit, or
+            # floor. Leave blank if it does not apply.
             extended_address: nil
           )
           end

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

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class ExternalVerificationCreateParams < 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::ExternalVerificationCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          # Ids of uploaded documents (Documents API) proving the enterprise owns its phone
+          # numbers hosted with another provider, for example a carrier invoice or account
+          # statement.
+          sig { returns(T::Array[String]) }
+          attr_accessor :document_ids
+
+          # Optional. The phone numbers hosted with another provider that the documents
+          # cover, in E.164 format. Shown to the reviewer to match the documents to your
+          # numbers; you can still add numbers that are not listed here, and each is checked
+          # on its own.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :phone_numbers
+
+          sig { params(phone_numbers: T::Array[String]).void }
+          attr_writer :phone_numbers
+
+          sig do
+            params(
+              enterprise_id: String,
+              document_ids: T::Array[String],
+              phone_numbers: T::Array[String],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            # Ids of uploaded documents (Documents API) proving the enterprise owns its phone
+            # numbers hosted with another provider, for example a carrier invoice or account
+            # statement.
+            document_ids:,
+            # Optional. The phone numbers hosted with another provider that the documents
+            # cover, in E.164 format. Shown to the reviewer to match the documents to your
+            # numbers; you can still add numbers that are not listed here, and each is checked
+            # on its own.
+            phone_numbers: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                document_ids: T::Array[String],
+                phone_numbers: T::Array[String],
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class ExternalVerificationListParams < 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::ExternalVerificationListParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          sig do
+            params(
+              enterprise_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(enterprise_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { enterprise_id: String, request_options: Telnyx::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # Review state of the ownership proof that allows adding phone numbers hosted with
+        # another provider.
+        module ExternalVerificationStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Enterprises::Reputation::ExternalVerificationStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+            )
+          APPROVED =
+            T.let(
+              :approved,
+              Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Enterprises::Reputation::ExternalVerificationStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end