telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/dir_new_loa_params.rb

@@ -20,8 +20,9 @@ module Telnyx
       required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
 
       # @!attribute agent
-      #   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.
       #
       #   @return [Telnyx::Models::Enterprises::Reputation::AgentInput, nil]
       optional :agent, -> { Telnyx::Enterprises::Reputation::AgentInput }
@@ -31,8 +32,8 @@ module Telnyx
       #   name, and signed-at date. When absent the PDF is returned unsigned so the
       #   customer can sign externally and upload it via the Documents API.
       #
-      #   @return [Telnyx::Models::DirNewLoaParams::Signature, nil]
-      optional :signature, -> { Telnyx::DirNewLoaParams::Signature }
+      #   @return [Telnyx::Models::SignaturePayload, nil]
+      optional :signature, -> { Telnyx::SignaturePayload }
 
       # @!method initialize(dir_id:, phone_numbers:, agent: nil, signature: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -42,38 +43,11 @@ module Telnyx
       #
       #   @param phone_numbers [Array<String>] Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by 10
       #
-      #   @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::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers on its be
       #
-      #   @param signature [Telnyx::Models::DirNewLoaParams::Signature] Optional. When provided the rendered PDF embeds the signature image, printed nam
+      #   @param signature [Telnyx::Models::SignaturePayload] Optional. When provided the rendered PDF embeds the signature image, printed nam
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-      class Signature < Telnyx::Internal::Type::BaseModel
-        # @!attribute image_base64
-        #   PNG image, base64-encoded.
-        #
-        #   @return [String]
-        required :image_base64, String
-
-        # @!attribute signer_name
-        #   Optional. When absent the rendered PDF falls back to the enterprise contact's
-        #   legal name.
-        #
-        #   @return [String, nil]
-        optional :signer_name, String, nil?: true
-
-        # @!method initialize(image_base64:, signer_name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::DirNewLoaParams::Signature} for more details.
-        #
-        #   Optional. When provided the rendered PDF embeds the signature image, printed
-        #   name, and signed-at date. When absent the PDF is returned unsigned so the
-        #   customer can sign externally and upload it via the Documents API.
-        #
-        #   @param image_base64 [String] PNG image, base64-encoded.
-        #
-        #   @param signer_name [String, nil] Optional. When absent the rendered PDF falls back to the enterprise contact's le
-      end
     end
   end
 end

data/lib/telnyx/models/dir_retrieve_bpo_authorizations_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#retrieve_bpo_authorizations
+    class DirRetrieveBpoAuthorizationsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute dir_id
+      #
+      #   @return [String]
+      required :dir_id, String
+
+      # @!attribute page_number
+      #   1-based page number. Out-of-range values return an empty page with correct meta.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Items per page. Maximum 250; values above are clamped to 250.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(dir_id:, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirRetrieveBpoAuthorizationsParams} for more details.
+      #
+      #   @param dir_id [String]
+      #
+      #   @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. Maximum 250; values above are clamped to 250.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/dir_retrieve_bpo_authorizations_response.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#retrieve_bpo_authorizations
+    class DirRetrieveBpoAuthorizationsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data] }
+
+      # @!attribute meta
+      #   JSON:API pagination metadata returned with every paginated list response. Page
+      #   numbering is 1-based. `page_size` reports the number of items actually returned
+      #   in `data` for this page; the requested size is taken from the `page[size]` query
+      #   parameter.
+      #
+      #   @return [Telnyx::Models::BrandedCallingPaginationMeta]
+      required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
+
+      # @!method initialize(data:, meta:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirRetrieveBpoAuthorizationsResponse} for more details.
+      #
+      #   Paginated list of a DIR's BPO authorizations.
+      #
+      #   @param data [Array<Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data>]
+      #
+      #   @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute bpo_enterprise_id
+        #   The authorized BPO account's enterprise id.
+        #
+        #   @return [String]
+        required :bpo_enterprise_id, String
+
+        # @!attribute loa_document_id
+        #   Id of the signed Letter of Authorization document submitted for this BPO. Send
+        #   it back unchanged in `bpo_authorizations` when updating the DIR to keep this
+        #   authorization and its review state.
+        #
+        #   @return [String]
+        required :loa_document_id, String
+
+        # @!attribute status
+        #   Review state of this authorization. `pending` when the authorization is first
+        #   added, or when you send a different `loa_document_id` for this BPO in
+        #   `bpo_authorizations` (uploading a document alone changes nothing). Approving the
+        #   DIR approves its pending authorizations; an admin can also approve or reject one
+        #   on its own. Only an `approved` authorization adds the BPO to this DIR's
+        #   authorized callers in the branded calling registry.
+        #
+        #   @return [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status]
+        required :status, enum: -> { Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status }
+
+        # @!attribute rejection_reason
+        #   Why the authorization was rejected. `null` unless `status` is `rejected`.
+        #
+        #   @return [String, nil]
+        optional :rejection_reason, String, nil?: true
+
+        response_only do
+          # @!attribute record_type
+          #   Always `bpo_authorization`.
+          #
+          #   @return [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType]
+          required :record_type, enum: -> { Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType }
+        end
+
+        # @!method initialize(bpo_enterprise_id:, loa_document_id:, record_type:, status:, rejection_reason: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data} for more details.
+        #
+        #   A single authorization of a BPO (Business Process Outsourcer) account on a DIR.
+        #
+        #   @param bpo_enterprise_id [String] The authorized BPO account's enterprise id.
+        #
+        #   @param loa_document_id [String] Id of the signed Letter of Authorization document submitted for this BPO. Send i
+        #
+        #   @param record_type [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType] Always `bpo_authorization`.
+        #
+        #   @param status [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status] Review state of this authorization. `pending` when the authorization is first ad
+        #
+        #   @param rejection_reason [String, nil] Why the authorization was rejected. `null` unless `status` is `rejected`.
+
+        # Always `bpo_authorization`.
+        #
+        # @see Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          BPO_AUTHORIZATION = :bpo_authorization
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Review state of this authorization. `pending` when the authorization is first
+        # added, or when you send a different `loa_document_id` for this BPO in
+        # `bpo_authorizations` (uploading a document alone changes nothing). Approving the
+        # DIR approves its pending authorizations; an admin can also approve or reject one
+        # on its own. Only an `approved` authorization adds the BPO to this DIR's
+        # authorized callers in the branded calling registry.
+        #
+        # @see Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data#status
+        module Status
+          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/dir_status.rb

@@ -16,6 +16,10 @@ module Telnyx
     # - `infringement_claimed` - a trademark/impersonation claim is open against this
     #   DIR.
     # - `permanently_rejected` - terminal; cannot be resubmitted.
+    # - `delete_requested` - you have requested deletion; the DIR still exists and
+    #   Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+    #   keeps serving its branded identity, and keeps billing, until the removal
+    #   finishes.
     module DirStatus
       extend Telnyx::Internal::Type::Enum
 
@@ -29,6 +33,7 @@ module Telnyx
       EXPIRED = :expired
       INFRINGEMENT_CLAIMED = :infringement_claimed
       PERMANENTLY_REJECTED = :permanently_rejected
+      DELETE_REQUESTED = :delete_requested
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/telnyx/models/dir_update_infringement_params.rb

@@ -26,7 +26,8 @@ module Telnyx
       required :certify_ip_ownership, enum: -> { Telnyx::DirUpdateInfringementParams::CertifyIPOwnership }
 
       # @!attribute certify_no_infringement
-      #   Must be `true`.
+      #   Check to certify that the brand no longer infringes anyone else's trademark or
+      #   intellectual property.
       #
       #   @return [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement]
       required :certify_no_infringement, enum: -> { Telnyx::DirUpdateInfringementParams::CertifyNoInfringement }
@@ -50,6 +51,8 @@ module Telnyx
       optional :call_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute display_name
+      #   The business name shown to call recipients, 1 to 35 characters, no emoji, not
+      #   blank.
       #
       #   @return [String, nil]
       optional :display_name, String, nil?: true
@@ -77,7 +80,7 @@ module Telnyx
       #
       #   @param certify_ip_ownership [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyIPOwnership] Must be `true`.
       #
-      #   @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement] Must be `true`.
+      #   @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement] Check to certify that the brand no longer infringes anyone else's trademark or i
       #
       #   @param certify_no_shaft_content [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoShaftContent] Must be `true`.
       #
@@ -85,7 +88,7 @@ module Telnyx
       #
       #   @param call_reasons [Array<String>, nil]
       #
-      #   @param display_name [String, nil]
+      #   @param display_name [String, nil] The business name shown to call recipients, 1 to 35 characters, no emoji, not bl
       #
       #   @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents to attach while resolving the claim (e.g. autho
       #
@@ -113,7 +116,8 @@ module Telnyx
         #   @return [Array<Boolean>]
       end
 
-      # Must be `true`.
+      # Check to certify that the brand no longer infringes anyone else's trademark or
+      # intellectual property.
       module CertifyNoInfringement
         extend Telnyx::Internal::Type::Enum
 

data/lib/telnyx/models/dir_update_params.rb

@@ -26,6 +26,17 @@ module Telnyx
       #   @return [String, nil]
       optional :authorizer_name, String
 
+      # @!attribute bpo_authorizations
+      #   Optional. Replace this DIR's authorized BPO (Business Process Outsourcer)
+      #   accounts with these, each with its signed Letter of Authorization. The supplied
+      #   list replaces the current one: a BPO left out has its authorization removed, and
+      #   a new BPO (or a changed Letter of Authorization) is created `pending` admin
+      #   review. Send an empty list to clear all authorizations; omit the field to leave
+      #   them unchanged. Editing this list does not re-vet the DIR. Maximum 10.
+      #
+      #   @return [Array<Telnyx::Models::BpoAuthorizationInput>, nil]
+      optional :bpo_authorizations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::BpoAuthorizationInput] }
+
       # @!attribute call_reasons
       #   1–10 reasons your business calls customers. Validate phrasing against
       #   `POST /call_reasons/validate`.
@@ -82,7 +93,15 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :reselling, Telnyx::Internal::Type::Boolean
 
-      # @!method initialize(dir_id:, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, display_name: nil, 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. Send `null` to clear. Changing only this field on a
+      #   `verified` DIR does not re-vet it. Maximum 2048 characters.
+      #
+      #   @return [String, nil]
+      optional :webhook_url, String, nil?: true
+
+      # @!method initialize(dir_id:, authorizer_email: nil, authorizer_name: nil, bpo_authorizations: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, display_name: nil, documents: nil, logo_url: nil, reselling: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::DirUpdateParams} for more details.
       #
@@ -92,6 +111,8 @@ module Telnyx
       #
       #   @param authorizer_name [String] Name of the person at your enterprise authorizing this DIR. Must be a real indiv
       #
+      #   @param bpo_authorizations [Array<Telnyx::Models::BpoAuthorizationInput>] Optional. Replace this DIR's authorized BPO (Business Process Outsourcer) accoun
+      #
       #   @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
       #
       #   @param certify_brand_is_accurate [Boolean] Certification that the DIR information is accurate. Must be `true` for the DIR t
@@ -108,6 +129,8 @@ module Telnyx
       #
       #   @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}]
     end
   end

data/lib/telnyx/models/doc_reqs_requirement.rb

@@ -133,7 +133,10 @@ module Telnyx
         extend Telnyx::Internal::Type::Enum
 
         LOCAL = :local
+        MOBILE = :mobile
+        MULTIPURPOSE = :multipurpose
         NATIONAL = :national
+        SHARED_COST = :shared_cost
         TOLL_FREE = :toll_free
 
         # @!method self.values

data/lib/telnyx/models/document.rb

@@ -19,6 +19,7 @@ module Telnyx
       required :document_type, enum: -> { Telnyx::Document::DocumentType }
 
       # @!attribute description
+      #   An optional note describing this document, for example what it proves.
       #
       #   @return [String, nil]
       optional :description, String
@@ -31,7 +32,7 @@ module Telnyx
       #
       #   @param document_type [Symbol, Telnyx::Models::Document::DocumentType] Type of supporting document. Pick the closest match to what the file actually co
       #
-      #   @param description [String]
+      #   @param description [String] An optional note describing this document, for example what it proves.
 
       # Type of supporting document. Pick the closest match to what the file actually
       # contains; `other` triggers manual vetting and may slow approval. The matching

data/lib/telnyx/models/email_template.rb

@@ -3,138 +3,14 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::EmailTemplates#list
-    class EmailTemplate < Telnyx::Internal::Type::BaseModel
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute autoescape
-      #   Whether HTML autoescaping is enabled for this template. When `true`, only
-      #   rendered `html_body` expression output is HTML-escaped at the output boundary;
-      #   `subject` and `text_body` are never autoescaped.
-      #
-      #   @return [Boolean]
-      required :autoescape, Telnyx::Internal::Type::Boolean
-
-      # @!attribute created_at
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute html_body
-      #
-      #   @return [String, nil]
-      required :html_body, String, nil?: true
-
-      # @!attribute name
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute record_type
-      #
-      #   @return [Symbol, Telnyx::Models::EmailTemplate::RecordType]
-      required :record_type, enum: -> { Telnyx::EmailTemplate::RecordType }
-
-      # @!attribute strict_variables
-      #   Whether strict variable validation is enabled for this template. When `true`,
-      #   sends and renders that are missing a variable marked `required: true` in
-      #   `variable_schema` fail with 422 naming the variable.
-      #
-      #   @return [Boolean]
-      required :strict_variables, Telnyx::Internal::Type::Boolean
-
+    class EmailTemplate < Telnyx::Models::EmailTemplateCommon
       # @!attribute subject
       #
       #   @return [String, nil]
       required :subject, String, nil?: true
 
-      # @!attribute text_body
-      #
-      #   @return [String, nil]
-      required :text_body, String, nil?: true
-
-      # @!attribute updated_at
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!attribute variable_schema
-      #   Structured variable requirements, or `null` when the template uses only the
-      #   legacy `variables` array.
-      #
-      #   @return [Hash{Symbol=>Telnyx::Models::EmailTemplate::VariableSchema}, nil]
-      required :variable_schema,
-               -> { Telnyx::Internal::Type::HashOf[Telnyx::EmailTemplate::VariableSchema] },
-               nil?: true
-
-      # @!attribute variables
-      #   Legacy unstructured variable names. This path remains supported unchanged.
-      #
-      #   @return [Array<String>]
-      required :variables, Telnyx::Internal::Type::ArrayOf[String]
-
-      # @!method initialize(id:, autoescape:, created_at:, html_body:, name:, record_type:, strict_variables:, subject:, text_body:, updated_at:, variable_schema:, variables:)
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::EmailTemplate} for more details.
-      #
-      #   @param id [String]
-      #
-      #   @param autoescape [Boolean] Whether HTML autoescaping is enabled for this template. When `true`, only render
-      #
-      #   @param created_at [Time]
-      #
-      #   @param html_body [String, nil]
-      #
-      #   @param name [String]
-      #
-      #   @param record_type [Symbol, Telnyx::Models::EmailTemplate::RecordType]
-      #
-      #   @param strict_variables [Boolean] Whether strict variable validation is enabled for this template. When `true`, se
-      #
+      # @!method initialize(subject:)
       #   @param subject [String, nil]
-      #
-      #   @param text_body [String, nil]
-      #
-      #   @param updated_at [Time]
-      #
-      #   @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplate::VariableSchema}, nil] Structured variable requirements, or `null` when the template uses only the lega
-      #
-      #   @param variables [Array<String>] Legacy unstructured variable names. This path remains supported unchanged.
-
-      # @see Telnyx::Models::EmailTemplate#record_type
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
-
-        EMAIL_TEMPLATE = :email_template
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class VariableSchema < Telnyx::Internal::Type::BaseModel
-        # @!attribute required
-        #   Whether the variable must be supplied when strict variable validation is
-        #   enabled.
-        #
-        #   @return [Boolean]
-        required :required, Telnyx::Internal::Type::Boolean
-
-        # @!attribute default
-        #   Default value for an optional variable. Rejected when `required` is `true`.
-        #
-        #   @return [String, nil]
-        optional :default, String
-
-        # @!method initialize(required:, default: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::EmailTemplate::VariableSchema} for more details.
-        #
-        #   @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
-        #
-        #   @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
-      end
     end
   end
 end

data/lib/telnyx/models/email_template_common.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class EmailTemplateCommon < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute autoescape
+      #   Whether HTML autoescaping is enabled for this template. When `true`, only
+      #   rendered `html_body` expression output is HTML-escaped at the output boundary;
+      #   `subject` and `text_body` are never autoescaped.
+      #
+      #   @return [Boolean]
+      required :autoescape, Telnyx::Internal::Type::Boolean
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute html_body
+      #
+      #   @return [String, nil]
+      required :html_body, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute record_type
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateCommon::RecordType]
+      required :record_type, enum: -> { Telnyx::EmailTemplateCommon::RecordType }
+
+      # @!attribute strict_variables
+      #   Whether strict variable validation is enabled for this template. When `true`,
+      #   sends and renders that are missing a variable marked `required: true` in
+      #   `variable_schema` fail with 422 naming the variable.
+      #
+      #   @return [Boolean]
+      required :strict_variables, Telnyx::Internal::Type::Boolean
+
+      # @!attribute text_body
+      #
+      #   @return [String, nil]
+      required :text_body, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute variable_schema
+      #   Structured variable requirements, or `null` when the template uses only the
+      #   legacy `variables` array.
+      #
+      #   @return [Hash{Symbol=>Telnyx::Models::EmailTemplateCommon::VariableSchema}, nil]
+      required :variable_schema,
+               -> { Telnyx::Internal::Type::HashOf[Telnyx::EmailTemplateCommon::VariableSchema] },
+               nil?: true
+
+      # @!attribute variables
+      #   Persisted variable names. In `explicit` mode this array preserves the exact
+      #   provided order, duplicates, and string contents; in `automatic` mode it is
+      #   derived from the stored subject and bodies.
+      #
+      #   @return [Array<String>]
+      required :variables, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute variables_mode
+      #   `automatic` when variable names are derived from template content; `explicit`
+      #   when `variables` is the exact manually managed array.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateCommon::VariablesMode]
+      required :variables_mode, enum: -> { Telnyx::EmailTemplateCommon::VariablesMode }
+
+      # @!method initialize(id:, autoescape:, created_at:, html_body:, name:, record_type:, strict_variables:, text_body:, updated_at:, variable_schema:, variables:, variables_mode:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailTemplateCommon} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param autoescape [Boolean] Whether HTML autoescaping is enabled for this template. When `true`, only render
+      #
+      #   @param created_at [Time]
+      #
+      #   @param html_body [String, nil]
+      #
+      #   @param name [String]
+      #
+      #   @param record_type [Symbol, Telnyx::Models::EmailTemplateCommon::RecordType]
+      #
+      #   @param strict_variables [Boolean] Whether strict variable validation is enabled for this template. When `true`, se
+      #
+      #   @param text_body [String, nil]
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplateCommon::VariableSchema}, nil] Structured variable requirements, or `null` when the template uses only the lega
+      #
+      #   @param variables [Array<String>] Persisted variable names. In `explicit` mode this array preserves the exact prov
+      #
+      #   @param variables_mode [Symbol, Telnyx::Models::EmailTemplateCommon::VariablesMode] `automatic` when variable names are derived from template content; `explicit` wh
+
+      # @see Telnyx::Models::EmailTemplateCommon#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_TEMPLATE = :email_template
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class VariableSchema < Telnyx::Internal::Type::BaseModel
+        # @!attribute required
+        #   Whether the variable must be supplied when strict variable validation is
+        #   enabled.
+        #
+        #   @return [Boolean]
+        required :required, Telnyx::Internal::Type::Boolean
+
+        # @!attribute default
+        #   Default value for an optional variable. Rejected when `required` is `true`.
+        #
+        #   @return [String, nil]
+        optional :default, String
+
+        # @!method initialize(required:, default: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailTemplateCommon::VariableSchema} for more details.
+        #
+        #   @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
+        #
+        #   @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
+      end
+
+      # `automatic` when variable names are derived from template content; `explicit`
+      # when `variables` is the exact manually managed array.
+      #
+      # @see Telnyx::Models::EmailTemplateCommon#variables_mode
+      module VariablesMode
+        extend Telnyx::Internal::Type::Enum
+
+        AUTOMATIC = :automatic
+        EXPLICIT = :explicit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end