telnyx 5.126.0 → 5.128.0

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

@@ -14,7 +14,8 @@ module Telnyx
             )
           end
 
-        # Frequency for refreshing reputation data
+        # How often Telnyx refreshes the stored reputation data for this enterprise's
+        # registered numbers.
         sig do
           returns(
             T.nilable(
@@ -32,29 +33,40 @@ module Telnyx
         end
         attr_writer :check_frequency
 
-        # When the reputation settings were created
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
-
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
-
-        # ID of the associated enterprise
         sig { returns(T.nilable(String)) }
         attr_reader :enterprise_id
 
         sig { params(enterprise_id: String).void }
         attr_writer :enterprise_id
 
-        # ID of the signed LOA document
+        # Id of the signed LOA document.
         sig { returns(T.nilable(String)) }
         attr_accessor :loa_document_id
 
-        # Reasons for rejection (present when status is rejected)
+        # Customer-facing Letter-of-Authorization verification state. `approved` is
+        # required (alongside reputation status) before phone numbers can be added.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :loa_status
+
+        sig do
+          params(
+            loa_status:
+              Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::OrSymbol
+          ).void
+        end
+        attr_writer :loa_status
+
+        # Populated when `status` is `rejected`.
         sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :rejection_reasons
 
-        # Current enrollment status
+        # Lifecycle status of the enterprise's Phone Number Reputation activation.
         sig do
           returns(
             T.nilable(
@@ -72,7 +84,12 @@ module Telnyx
         end
         attr_writer :status
 
-        # When the reputation settings were last updated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
         sig { returns(T.nilable(Time)) }
         attr_reader :updated_at
 
@@ -86,6 +103,8 @@ module Telnyx
             created_at: Time,
             enterprise_id: String,
             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,
@@ -93,19 +112,20 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # Frequency for refreshing reputation data
+          # How often Telnyx refreshes the stored reputation data for this enterprise's
+          # registered numbers.
           check_frequency: nil,
-          # When the reputation settings were created
           created_at: nil,
-          # ID of the associated enterprise
           enterprise_id: nil,
-          # ID of the signed LOA document
+          # Id of the signed LOA document.
           loa_document_id: nil,
-          # Reasons for rejection (present when status is rejected)
+          # Customer-facing Letter-of-Authorization verification state. `approved` is
+          # required (alongside reputation status) before phone numbers can be added.
+          loa_status: nil,
+          # Populated when `status` is `rejected`.
           rejection_reasons: nil,
-          # Current enrollment status
+          # Lifecycle status of the enterprise's Phone Number Reputation activation.
           status: nil,
-          # When the reputation settings were last updated
           updated_at: nil
         )
         end
@@ -118,6 +138,8 @@ module Telnyx
               created_at: Time,
               enterprise_id: String,
               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,
@@ -128,7 +150,8 @@ module Telnyx
         def to_hash
         end
 
-        # Frequency for refreshing reputation data
+        # How often Telnyx refreshes the stored reputation data for this enterprise's
+        # registered numbers.
         module CheckFrequency
           extend Telnyx::Internal::Type::Enum
 
@@ -183,15 +206,16 @@ module Telnyx
           end
         end
 
-        # Current enrollment status
-        module Status
+        # Customer-facing Letter-of-Authorization verification state. `approved` is
+        # required (alongside reputation status) before phone numbers can be added.
+        module LoaStatus
           extend Telnyx::Internal::Type::Enum
 
           TaggedSymbol =
             T.type_alias do
               T.all(
                 Symbol,
-                Telnyx::Enterprises::EnterpriseReputationPublic::Status
+                Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus
               )
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -199,16 +223,51 @@ module Telnyx
           PENDING =
             T.let(
               :pending,
-              Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
+              Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol
             )
           APPROVED =
             T.let(
               :approved,
-              Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
+              Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol
             )
           REJECTED =
             T.let(
               :rejected,
+              Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Enterprises::EnterpriseReputationPublic::LoaStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Lifecycle status of the enterprise's Phone Number Reputation activation.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Enterprises::EnterpriseReputationPublic::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
+            )
+          APPROVED =
+            T.let(
+              :approved,
               Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
             )
           DELETED =
@@ -216,6 +275,11 @@ module Telnyx
               :deleted,
               Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
             )
+          REJECTED =
+            T.let(
+              :rejected,
+              Telnyx::Enterprises::EnterpriseReputationPublic::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

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

@@ -0,0 +1,238 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class LoaRenderParams < 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::LoaRenderParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          # 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::LoaRenderParams::Agent)
+            )
+          end
+          attr_reader :agent
+
+          sig do
+            params(
+              agent:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Agent::OrHash
+            ).void
+          end
+          attr_writer :agent
+
+          # Optional signature embedded in the rendered PDF. When omitted the PDF is
+          # returned unsigned for the customer to sign and upload.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Signature
+              )
+            )
+          end
+          attr_reader :signature
+
+          sig do
+            params(
+              signature:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Signature::OrHash
+            ).void
+          end
+          attr_writer :signature
+
+          sig do
+            params(
+              enterprise_id: String,
+              agent:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Agent::OrHash,
+              signature:
+                Telnyx::Enterprises::Reputation::LoaRenderParams::Signature::OrHash,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            # Third-party reseller / partner managing the enterprise's phone numbers. Omit
+            # when the enterprise works directly with Telnyx.
+            agent: nil,
+            # Optional signature embedded in the rendered PDF. When omitted the PDF is
+            # returned unsigned for the customer to sign and upload.
+            signature: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                agent: Telnyx::Enterprises::Reputation::LoaRenderParams::Agent,
+                signature:
+                  Telnyx::Enterprises::Reputation::LoaRenderParams::Signature,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          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
+                T.any(
+                  Telnyx::Enterprises::Reputation::LoaRenderParams::Signature,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Base64-encoded signature image.
+            sig { returns(String) }
+            attr_accessor :image_base64
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :signer_name
+
+            # Optional signature embedded in the rendered PDF. When omitted the PDF is
+            # returned unsigned for the customer to sign and upload.
+            sig do
+              params(
+                image_base64: String,
+                signer_name: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Base64-encoded signature image.
+              image_base64:,
+              signer_name: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { image_base64: String, signer_name: T.nilable(String) }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class LoaUpdateParams < 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::LoaUpdateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          # Id of the new signed LOA document (from the Telnyx Documents API). Changing it
+          # resets LOA approval; the new document must be approved before more numbers can
+          # be added.
+          sig { returns(String) }
+          attr_accessor :loa_document_id
+
+          sig do
+            params(
+              enterprise_id: String,
+              loa_document_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            # Id of the new signed LOA document (from the Telnyx Documents API). Changing it
+            # resets LOA approval; the new document must be approved before more numbers can
+            # be added.
+            loa_document_id:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                loa_document_id: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -19,7 +19,7 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :enterprise_id
 
-          # List of phone numbers to associate for reputation monitoring (max 100)
+          # 1–100 phone numbers in E.164 format with a leading `+`.
           sig { returns(T::Array[String]) }
           attr_accessor :phone_numbers
 
@@ -32,7 +32,7 @@ module Telnyx
           end
           def self.new(
             enterprise_id:,
-            # List of phone numbers to associate for reputation monitoring (max 100)
+            # 1–100 phone numbers in E.164 format with a leading `+`.
             phone_numbers:,
             request_options: {}
           )