telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/enterprises/reputation/agent_input.rb

@@ -6,81 +6,114 @@ module Telnyx
       module Reputation
         class AgentInput < Telnyx::Internal::Type::BaseModel
           # @!attribute administrative_area
+          #   The state or province of the partner's address, as its code, for example IL or
+          #   ON.
           #
           #   @return [String]
           required :administrative_area, String
 
           # @!attribute city
+          #   The city of the partner's address.
           #
           #   @return [String]
           required :city, String
 
           # @!attribute contact_email
+          #   The email address of the contact person at the partner.
           #
           #   @return [String]
           required :contact_email, String
 
           # @!attribute contact_name
+          #   The name of a contact person at the partner.
           #
           #   @return [String]
           required :contact_name, String
 
           # @!attribute contact_phone
+          #   The phone number of the contact person at the partner, in E.164 format, for
+          #   example +13125550000.
           #
           #   @return [String]
           required :contact_phone, String
 
           # @!attribute contact_title
+          #   The job title of the contact person at the partner.
           #
           #   @return [String]
           required :contact_title, String
 
           # @!attribute country
+          #   The two-letter country code of the partner's address, for example US.
           #
           #   @return [String]
           required :country, String
 
           # @!attribute legal_name
+          #   The legal name of the third-party partner or reseller managing these numbers on
+          #   your behalf.
           #
           #   @return [String]
           required :legal_name, String
 
           # @!attribute postal_code
+          #   The postal or ZIP code of the partner's address.
           #
           #   @return [String]
           required :postal_code, String
 
           # @!attribute street_address
+          #   The street address of the partner, including the building number and street
+          #   name.
           #
           #   @return [String]
           required :street_address, String
 
           # @!attribute dba
+          #   The trade name (Doing Business As) the partner operates under, if different from
+          #   its legal name. Leave blank if it does not apply.
           #
           #   @return [String, nil]
           optional :dba, String, nil?: true
 
           # @!attribute extended_address
+          #   An optional second address line for the partner, such as a suite, unit, or
+          #   floor. Leave blank if it does not apply.
           #
           #   @return [String, nil]
           optional :extended_address, String, nil?: true
 
           # @!method initialize(administrative_area:, city:, contact_email:, contact_name:, contact_phone:, contact_title:, country:, legal_name:, postal_code:, street_address:, dba: nil, extended_address: nil)
-          #   Third-party reseller / partner managing the enterprise's phone numbers. Omit
-          #   when the enterprise works directly with Telnyx.
-          #
-          #   @param administrative_area [String]
-          #   @param city [String]
-          #   @param contact_email [String]
-          #   @param contact_name [String]
-          #   @param contact_phone [String]
-          #   @param contact_title [String]
-          #   @param country [String]
-          #   @param legal_name [String]
-          #   @param postal_code [String]
-          #   @param street_address [String]
-          #   @param dba [String, nil]
-          #   @param extended_address [String, nil]
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::AgentInput} for more details.
+          #
+          #   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.
+          #
+          #   @param administrative_area [String] The state or province of the partner's address, as its code, for example IL or O
+          #
+          #   @param city [String] The city of the partner's address.
+          #
+          #   @param contact_email [String] The email address of the contact person at the partner.
+          #
+          #   @param contact_name [String] The name of a contact person at the partner.
+          #
+          #   @param contact_phone [String] The phone number of the contact person at the partner, in E.164 format, for exam
+          #
+          #   @param contact_title [String] The job title of the contact person at the partner.
+          #
+          #   @param country [String] The two-letter country code of the partner's address, for example US.
+          #
+          #   @param legal_name [String] The legal name of the third-party partner or reseller managing these numbers on
+          #
+          #   @param postal_code [String] The postal or ZIP code of the partner's address.
+          #
+          #   @param street_address [String] The street address of the partner, including the building number and street name
+          #
+          #   @param dba [String, nil] The trade name (Doing Business As) the partner operates under, if different from
+          #
+          #   @param extended_address [String, nil] An optional second address line for the partner, such as a suite, unit, or floor
         end
       end
     end

data/lib/telnyx/models/enterprises/reputation/external_verification_create_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::ExternalVerification#create
+        class ExternalVerificationCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute document_ids
+          #   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.
+          #
+          #   @return [Array<String>]
+          required :document_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute phone_numbers
+          #   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.
+          #
+          #   @return [Array<String>, nil]
+          optional :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(enterprise_id:, document_ids:, phone_numbers: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::ExternalVerificationCreateParams} for
+          #   more details.
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param document_ids [Array<String>] Ids of uploaded documents (Documents API) proving the enterprise owns its phone
+          #
+          #   @param phone_numbers [Array<String>] Optional. The phone numbers hosted with another provider that the documents cove
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/external_verification_list_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::ExternalVerification#list
+        class ExternalVerificationListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!method initialize(enterprise_id:, request_options: {})
+          #   @param enterprise_id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/external_verification_status.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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
+
+          PENDING = :pending
+          APPROVED = :approved
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/external_verification_wrapped.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::ExternalVerification#create
+        class ExternalVerificationWrapped < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::Enterprises::Reputation::ExternalVerificationWrapped::Data]
+          required :data, -> { Telnyx::Enterprises::Reputation::ExternalVerificationWrapped::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::Enterprises::Reputation::ExternalVerificationWrapped::Data]
+
+          # @see Telnyx::Models::Enterprises::Reputation::ExternalVerificationWrapped#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute document_ids
+            #   The ownership-proof documents on file.
+            #
+            #   @return [Array<String>, nil]
+            optional :document_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute enterprise_id
+            #
+            #   @return [String, nil]
+            optional :enterprise_id, String
+
+            # @!attribute phone_numbers
+            #   The phone numbers you listed with the documents.
+            #
+            #   @return [Array<String>, nil]
+            optional :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute rejection_reason
+            #   Why the proof was rejected. Set only when `status` is `rejected`.
+            #
+            #   @return [String, nil]
+            optional :rejection_reason, String, nil?: true
+
+            # @!attribute status
+            #   Review state of the ownership proof that allows adding phone numbers hosted with
+            #   another provider.
+            #
+            #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ExternalVerificationStatus, nil]
+            optional :status, enum: -> { Telnyx::Enterprises::Reputation::ExternalVerificationStatus }
+
+            response_only do
+              # @!attribute reviewed_at
+              #
+              #   @return [Time, nil]
+              optional :reviewed_at, Time, nil?: true
+
+              # @!attribute submitted_at
+              #
+              #   @return [Time, nil]
+              optional :submitted_at, Time, nil?: true
+            end
+
+            # @!method initialize(document_ids: nil, enterprise_id: nil, phone_numbers: nil, rejection_reason: nil, reviewed_at: nil, status: nil, submitted_at: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Enterprises::Reputation::ExternalVerificationWrapped::Data} for
+            #   more details.
+            #
+            #   @param document_ids [Array<String>] The ownership-proof documents on file.
+            #
+            #   @param enterprise_id [String]
+            #
+            #   @param phone_numbers [Array<String>] The phone numbers you listed with the documents.
+            #
+            #   @param rejection_reason [String, nil] Why the proof was rejected. Set only when `status` is `rejected`.
+            #
+            #   @param reviewed_at [Time, nil]
+            #
+            #   @param status [Symbol, Telnyx::Models::Enterprises::Reputation::ExternalVerificationStatus] Review state of the ownership proof that allows adding phone numbers hosted with
+            #
+            #   @param submitted_at [Time, nil]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/loa_render_params.rb

@@ -18,8 +18,8 @@ module Telnyx
           #   Third-party reseller / partner managing the enterprise's phone numbers. Omit
           #   when the enterprise works directly with Telnyx.
           #
-          #   @return [Telnyx::Models::Enterprises::Reputation::AgentInput, nil]
-          optional :agent, -> { Telnyx::Enterprises::Reputation::AgentInput }
+          #   @return [Telnyx::Models::Enterprises::Reputation::LoaRenderParams::Agent, nil]
+          optional :agent, -> { Telnyx::Enterprises::Reputation::LoaRenderParams::Agent }
 
           # @!attribute signature
           #   Optional signature embedded in the rendered PDF. When omitted the PDF is
@@ -34,12 +34,91 @@ module Telnyx
           #
           #   @param enterprise_id [String]
           #
-          #   @param agent [Telnyx::Models::Enterprises::Reputation::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
+          #   @param agent [Telnyx::Models::Enterprises::Reputation::LoaRenderParams::Agent] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
           #
           #   @param signature [Telnyx::Models::Enterprises::Reputation::LoaRenderParams::Signature] Optional signature embedded in the rendered PDF. When omitted the PDF is returne
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
+          class Agent < Telnyx::Internal::Type::BaseModel
+            # @!attribute administrative_area
+            #
+            #   @return [String]
+            required :administrative_area, String
+
+            # @!attribute city
+            #
+            #   @return [String]
+            required :city, String
+
+            # @!attribute contact_email
+            #
+            #   @return [String]
+            required :contact_email, String
+
+            # @!attribute contact_name
+            #
+            #   @return [String]
+            required :contact_name, String
+
+            # @!attribute contact_phone
+            #
+            #   @return [String]
+            required :contact_phone, String
+
+            # @!attribute contact_title
+            #
+            #   @return [String]
+            required :contact_title, String
+
+            # @!attribute country
+            #
+            #   @return [String]
+            required :country, String
+
+            # @!attribute legal_name
+            #
+            #   @return [String]
+            required :legal_name, String
+
+            # @!attribute postal_code
+            #
+            #   @return [String]
+            required :postal_code, String
+
+            # @!attribute street_address
+            #
+            #   @return [String]
+            required :street_address, String
+
+            # @!attribute dba
+            #
+            #   @return [String, nil]
+            optional :dba, String, nil?: true
+
+            # @!attribute extended_address
+            #
+            #   @return [String, nil]
+            optional :extended_address, String, nil?: true
+
+            # @!method initialize(administrative_area:, city:, contact_email:, contact_name:, contact_phone:, contact_title:, country:, legal_name:, postal_code:, street_address:, dba: nil, extended_address: nil)
+            #   Third-party reseller / partner managing the enterprise's phone numbers. Omit
+            #   when the enterprise works directly with Telnyx.
+            #
+            #   @param administrative_area [String]
+            #   @param city [String]
+            #   @param contact_email [String]
+            #   @param contact_name [String]
+            #   @param contact_phone [String]
+            #   @param contact_title [String]
+            #   @param country [String]
+            #   @param legal_name [String]
+            #   @param postal_code [String]
+            #   @param street_address [String]
+            #   @param dba [String, nil]
+            #   @param extended_address [String, nil]
+          end
+
           class Signature < Telnyx::Internal::Type::BaseModel
             # @!attribute image_base64
             #   Base64-encoded signature image.

data/lib/telnyx/models/enterprises/reputation/number_list_params.rb

@@ -14,6 +14,14 @@ module Telnyx
           #   @return [String]
           required :enterprise_id, String
 
+          # @!attribute filter_ownership_status
+          #   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.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus, nil]
+          optional :filter_ownership_status, enum: -> { Telnyx::Enterprises::Reputation::ReputationOwnershipStatus }
+
           # @!attribute filter_phone_number_contains
           #   Partial match on phone number. Must contain at least 5 digits.
           #
@@ -26,6 +34,12 @@ module Telnyx
           #   @return [String, nil]
           optional :filter_phone_number_eq, String
 
+          # @!attribute filter_source
+          #   Only numbers with this source.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource, nil]
+          optional :filter_source, enum: -> { Telnyx::Enterprises::Reputation::ReputationNumberSource }
+
           # @!attribute page_number
           #   1-based page number. Out-of-range values return an empty page with correct meta.
           #
@@ -38,16 +52,20 @@ module Telnyx
           #   @return [Integer, nil]
           optional :page_size, Integer
 
-          # @!method initialize(enterprise_id:, filter_phone_number_contains: nil, filter_phone_number_eq: nil, page_number: nil, page_size: nil, request_options: {})
+          # @!method initialize(enterprise_id:, filter_ownership_status: nil, filter_phone_number_contains: nil, filter_phone_number_eq: nil, filter_source: nil, page_number: nil, page_size: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::Enterprises::Reputation::NumberListParams} for more details.
           #
           #   @param enterprise_id [String]
           #
+          #   @param filter_ownership_status [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus] Only numbers with this ownership status. `removed` lists the numbers that were r
+          #
           #   @param filter_phone_number_contains [String] Partial match on phone number. Must contain at least 5 digits.
           #
           #   @param filter_phone_number_eq [String] Exact phone-number match (E.164).
           #
+          #   @param filter_source [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource] Only numbers with this source.
+          #
           #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
           #
           #   @param page_size [Integer] Items per page. Default 10. Maximum 250; values above are clamped to 250.

data/lib/telnyx/models/enterprises/reputation/number_ownership_confirm_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#ownership_confirm
+        class NumberOwnershipConfirmParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute phone_number
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!attribute still_own
+          #   `true` confirms you still own the number. `false` reports that you no longer own
+          #   it and removes it from Number Reputation.
+          #
+          #   @return [Boolean]
+          required :still_own, Telnyx::Internal::Type::Boolean
+
+          # @!attribute evidence_document_id
+          #   Optional id of an uploaded document supporting the confirmation.
+          #
+          #   @return [String, nil]
+          optional :evidence_document_id, String
+
+          # @!method initialize(enterprise_id:, phone_number:, still_own:, evidence_document_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::NumberOwnershipConfirmParams} for more
+          #   details.
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param phone_number [String]
+          #
+          #   @param still_own [Boolean] `true` confirms you still own the number. `false` reports that you no longer own
+          #
+          #   @param evidence_document_id [String] Optional id of an uploaded document supporting the confirmation.
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/number_retrieve_ownership_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#retrieve_ownership
+        class NumberRetrieveOwnershipParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute phone_number
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(enterprise_id:, phone_number:, request_options: {})
+          #   @param enterprise_id [String]
+          #   @param phone_number [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end