telnyx 5.170.0 → 5.173.0

data/lib/telnyx/models/enterprises/dir_create_params.rb

@@ -35,7 +35,8 @@ module Telnyx
         required :call_reasons, Telnyx::Internal::Type::ArrayOf[String]
 
         # @!attribute certify_brand_is_accurate
-        #   Must be `true`.
+        #   Certification that the DIR information is accurate. Must be `true` for the DIR
+        #   to be submitted for vetting.
         #
         #   @return [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate]
         required :certify_brand_is_accurate,
@@ -61,6 +62,17 @@ module Telnyx
         #   @return [String]
         required :display_name, String
 
+        # @!attribute bpo_authorizations
+        #   Optional. Approved BPO (Business Process Outsourcer) accounts on your
+        #   organization authorized to place branded calls for this DIR, each with the
+        #   signed Letter of Authorization the Brand Owner granted it. Each authorization
+        #   starts `pending` and takes effect only after an admin reviews its Letter of
+        #   Authorization. Omit or send an empty list to authorize no BPO on this DIR.
+        #   Maximum 10.
+        #
+        #   @return [Array<Telnyx::Models::BpoAuthorizationInput>, nil]
+        optional :bpo_authorizations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::BpoAuthorizationInput] }
+
         # @!attribute documents
         #   Supporting documents. Each `document_id` may appear at most once on a DIR.
         #
@@ -80,7 +92,15 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :reselling, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(enterprise_id:, authorizer_email:, authorizer_name:, call_reasons:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, documents: nil, logo_url: nil, reselling: nil, request_options: {})
+        # @!attribute webhook_url
+        #   Optional `https://` URL that receives webhook notifications when this DIR's
+        #   compliance review completes (rejection outcomes include structured rejection
+        #   reasons). Maximum 2048 characters.
+        #
+        #   @return [String, nil]
+        optional :webhook_url, String, nil?: true
+
+        # @!method initialize(enterprise_id:, authorizer_email:, authorizer_name:, call_reasons:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, bpo_authorizations: nil, documents: nil, logo_url: nil, reselling: nil, webhook_url: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Enterprises::DirCreateParams} for more details.
         #
@@ -92,7 +112,7 @@ module Telnyx
         #
         #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
         #
-        #   @param certify_brand_is_accurate [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate] Must be `true`.
+        #   @param certify_brand_is_accurate [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate] Certification that the DIR information is accurate. Must be `true` for the DIR t
         #
         #   @param certify_ip_ownership [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership] Must be `true`. Confirms ownership of any logos/trademarks shown.
         #
@@ -100,15 +120,20 @@ module Telnyx
         #
         #   @param display_name [String] Name shown to call recipients. No emoji; not whitespace-only.
         #
+        #   @param bpo_authorizations [Array<Telnyx::Models::BpoAuthorizationInput>] Optional. Approved BPO (Business Process Outsourcer) accounts on your organizati
+        #
         #   @param documents [Array<Telnyx::Models::Document>] Supporting documents. Each `document_id` may appear at most once on a DIR.
         #
         #   @param logo_url [String] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
         #
         #   @param reselling [Boolean] Set to true if your organization places calls on behalf of other enterprises (BP
         #
+        #   @param webhook_url [String, nil] Optional `https://` URL that receives webhook notifications when this DIR's comp
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-        # Must be `true`.
+        # Certification that the DIR information is accurate. Must be `true` for the DIR
+        # to be submitted for vetting.
         module CertifyBrandIsAccurate
           extend Telnyx::Internal::Type::Enum
 

data/lib/telnyx/models/enterprises/enterprise_email_verification_status_wrapped.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::VerifyEmail#create
+      class EnterpriseEmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   Verification state for an enterprise account's contact email.
+        #
+        #   @return [Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data]
+        required :data, -> { Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data] Verification state for an enterprise account's contact email.
+
+        # @see Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute email_verified
+          #   Whether the enterprise account's contact email has been confirmed.
+          #
+          #   @return [Boolean]
+          required :email_verified, Telnyx::Internal::Type::Boolean
+
+          # @!attribute status
+          #   `sent` after a code is emailed; `verified` after a successful confirm.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status]
+          required :status, enum: -> { Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status }
+
+          response_only do
+            # @!attribute record_type
+            #   Always `email_verification`.
+            #
+            #   @return [Symbol, Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType]
+            required :record_type,
+                     enum: -> { Telnyx::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType }
+
+            # @!attribute expires_at
+            #   When the code just sent stops being accepted. Present on a send response; null
+            #   on a confirm response.
+            #
+            #   @return [Time, nil]
+            optional :expires_at, Time, nil?: true
+
+            # @!attribute sends_remaining_today
+            #   How many more codes may be requested for this enterprise account today. Present
+            #   on a send response; null on a confirm response.
+            #
+            #   @return [Integer, nil]
+            optional :sends_remaining_today, Integer, nil?: true
+          end
+
+          # @!method initialize(email_verified:, record_type:, status:, expires_at: nil, sends_remaining_today: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data}
+          #   for more details.
+          #
+          #   Verification state for an enterprise account's contact email.
+          #
+          #   @param email_verified [Boolean] Whether the enterprise account's contact email has been confirmed.
+          #
+          #   @param record_type [Symbol, Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::RecordType] Always `email_verification`.
+          #
+          #   @param status [Symbol, Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data::Status] `sent` after a code is emailed; `verified` after a successful confirm.
+          #
+          #   @param expires_at [Time, nil] When the code just sent stops being accepted. Present on a send response; null o
+          #
+          #   @param sends_remaining_today [Integer, nil] How many more codes may be requested for this enterprise account today. Present
+
+          # Always `email_verification`.
+          #
+          # @see Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_VERIFICATION = :email_verification
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # `sent` after a code is emailed; `verified` after a successful confirm.
+          #
+          # @see Telnyx::Models::Enterprises::EnterpriseEmailVerificationStatusWrapped::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SENT = :sent
+            VERIFIED = :verified
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+
+    EnterpriseEmailVerificationStatusWrapped = Enterprises::EnterpriseEmailVerificationStatusWrapped
+  end
+end

data/lib/telnyx/models/enterprises/enterprise_reputation_public.rb

@@ -16,6 +16,15 @@ module Telnyx
         #   @return [String, nil]
         optional :enterprise_id, String
 
+        # @!attribute external_verification_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 :external_verification_status,
+                 enum: -> { Telnyx::Enterprises::Reputation::ExternalVerificationStatus },
+                 nil?: true
+
         # @!attribute loa_document_id
         #   Id of the signed LOA document.
         #
@@ -41,6 +50,12 @@ module Telnyx
         #   @return [Symbol, Telnyx::Models::Enterprises::EnterpriseReputationPublic::Status, nil]
         optional :status, enum: -> { Telnyx::Enterprises::EnterpriseReputationPublic::Status }
 
+        # @!attribute webhook_url
+        #   HTTPS URL that receives number-ownership webhook events for this enterprise.
+        #
+        #   @return [String, nil]
+        optional :webhook_url, String, nil?: true
+
         response_only do
           # @!attribute created_at
           #
@@ -53,7 +68,7 @@ module Telnyx
           optional :updated_at, Time
         end
 
-        # @!method initialize(check_frequency: nil, created_at: nil, enterprise_id: nil, loa_document_id: nil, loa_status: nil, rejection_reasons: nil, status: nil, updated_at: nil)
+        # @!method initialize(check_frequency: nil, created_at: nil, enterprise_id: nil, external_verification_status: nil, loa_document_id: nil, loa_status: nil, rejection_reasons: nil, status: nil, updated_at: nil, webhook_url: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Enterprises::EnterpriseReputationPublic} for more details.
         #
@@ -63,6 +78,8 @@ module Telnyx
         #
         #   @param enterprise_id [String]
         #
+        #   @param external_verification_status [Symbol, Telnyx::Models::Enterprises::Reputation::ExternalVerificationStatus, nil] Review state of the ownership proof that allows adding phone numbers hosted with
+        #
         #   @param loa_document_id [String, nil] Id of the signed LOA document.
         #
         #   @param loa_status [Symbol, Telnyx::Models::Enterprises::EnterpriseReputationPublic::LoaStatus] Customer-facing Letter-of-Authorization verification state. `approved` is requir
@@ -72,6 +89,8 @@ module Telnyx
         #   @param status [Symbol, Telnyx::Models::Enterprises::EnterpriseReputationPublic::Status] Lifecycle status of the enterprise's Phone Number Reputation activation.
         #
         #   @param updated_at [Time]
+        #
+        #   @param webhook_url [String, nil] HTTPS URL that receives number-ownership webhook events for this enterprise.
 
         # Customer-facing Letter-of-Authorization verification state. `approved` is
         # required (alongside reputation status) before phone numbers can be added.

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.