telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/email_template_create_params.rb

@@ -70,17 +70,30 @@ module Telnyx
                nil?: true
 
       # @!attribute variables
-      #   Template variables. Auto-extracted from subject/body fields when absent.
+      #   Persisted variable names. In `automatic` mode a non-null array is rejected; in
+      #   `explicit` mode this is the exact manual array and each item is limited to 255
+      #   Unicode code points.
       #
       #   @return [Array<String>, nil]
-      optional :variables, Telnyx::Internal::Type::ArrayOf[String]
+      optional :variables, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute variables_mode
+      #   Controls how `variables` is maintained. If both fields are omitted (or
+      #   `variables` is null), the template uses `automatic` mode and extracts variable
+      #   names from the effective subject, HTML body, and text body. A non-null
+      #   `variables` array with no mode selects `explicit`. `automatic` rejects a
+      #   simultaneous non-null array; `explicit` requires a non-null array, including
+      #   valid `[]`, and preserves its exact order, duplicates, and string contents.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateCreateParams::VariablesMode, nil]
+      optional :variables_mode, enum: -> { Telnyx::EmailTemplateCreateParams::VariablesMode }
 
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(name:, autoescape: nil, html_body: nil, strict_variables: nil, subject: nil, text_body: nil, variable_schema: nil, variables: nil, idempotency_key: nil, request_options: {})
+      # @!method initialize(name:, autoescape: nil, html_body: nil, strict_variables: nil, subject: nil, text_body: nil, variable_schema: nil, variables: nil, variables_mode: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::EmailTemplateCreateParams} for more details.
       #
@@ -98,7 +111,9 @@ module Telnyx
       #
       #   @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplateCreateParams::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
       #
-      #   @param variables [Array<String>] Template variables. Auto-extracted from subject/body fields when absent.
+      #   @param variables [Array<String>, nil] Persisted variable names. In `automatic` mode a non-null array is rejected; in `
+      #
+      #   @param variables_mode [Symbol, Telnyx::Models::EmailTemplateCreateParams::VariablesMode] Controls how `variables` is maintained. If both fields are omitted (or `variable
       #
       #   @param idempotency_key [String]
       #
@@ -126,6 +141,22 @@ module Telnyx
         #
         #   @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
       end
+
+      # Controls how `variables` is maintained. If both fields are omitted (or
+      # `variables` is null), the template uses `automatic` mode and extracts variable
+      # names from the effective subject, HTML body, and text body. A non-null
+      # `variables` array with no mode selects `explicit`. `automatic` rejects a
+      # simultaneous non-null array; `explicit` requires a non-null array, including
+      # valid `[]`, and preserves its exact order, duplicates, and string contents.
+      module VariablesMode
+        extend Telnyx::Internal::Type::Enum
+
+        AUTOMATIC = :automatic
+        EXPLICIT = :explicit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/telnyx/models/email_template_list_params.rb

@@ -7,6 +7,39 @@ module Telnyx
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
+      # @!attribute filter_autoescape
+      #   Exact match on the template's `autoescape` option. Only the exact query strings
+      #   `true` and `false` are accepted; other values, including blank, return 400.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateListParams::FilterAutoescape, nil]
+      optional :filter_autoescape, enum: -> { Telnyx::EmailTemplateListParams::FilterAutoescape }
+
+      # @!attribute filter_content_type
+      #   Matches templates by stored body presence. `html_and_text` requires both an HTML
+      #   and text body; `html_only` requires HTML and no text body; `text_only` requires
+      #   text and no HTML body; `no_body` requires neither. `null` and exactly `""` count
+      #   as absent; whitespace-only strings count as content. An empty or unsupported
+      #   value returns a 400 response.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateListParams::FilterContentType, nil]
+      optional :filter_content_type, enum: -> { Telnyx::EmailTemplateListParams::FilterContentType }
+
+      # @!attribute filter_query
+      #   Case-insensitive literal substring match over the template `name` or stored
+      #   `subject` only; bodies are never searched. `%`, `_`, and `\` are literal
+      #   characters with no wildcard meaning. A blank value is treated as omitted.
+      #
+      #   @return [String, nil]
+      optional :filter_query, String
+
+      # @!attribute filter_strict_variables
+      #   Exact match on the template's `strict_variables` option. Only the exact query
+      #   strings `true` and `false` are accepted; other values, including blank,
+      #   return 400.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplateListParams::FilterStrictVariables, nil]
+      optional :filter_strict_variables, enum: -> { Telnyx::EmailTemplateListParams::FilterStrictVariables }
+
       # @!attribute page_cursor
       #   Opaque URL-safe Base64 cursor returned by a previous list response.
       #
@@ -20,15 +53,65 @@ module Telnyx
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(page_cursor: nil, page_size: nil, request_options: {})
+      # @!method initialize(filter_autoescape: nil, filter_content_type: nil, filter_query: nil, filter_strict_variables: nil, page_cursor: nil, page_size: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::EmailTemplateListParams} for more details.
       #
+      #   @param filter_autoescape [Symbol, Telnyx::Models::EmailTemplateListParams::FilterAutoescape] Exact match on the template's `autoescape` option. Only the exact query strings
+      #
+      #   @param filter_content_type [Symbol, Telnyx::Models::EmailTemplateListParams::FilterContentType] Matches templates by stored body presence. `html_and_text` requires both an HTML
+      #
+      #   @param filter_query [String] Case-insensitive literal substring match over the template `name` or stored `sub
+      #
+      #   @param filter_strict_variables [Symbol, Telnyx::Models::EmailTemplateListParams::FilterStrictVariables] Exact match on the template's `strict_variables` option. Only the exact query st
+      #
       #   @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
       #
       #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100. Invalid values are
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Exact match on the template's `autoescape` option. Only the exact query strings
+      # `true` and `false` are accepted; other values, including blank, return 400.
+      module FilterAutoescape
+        extend Telnyx::Internal::Type::Enum
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Matches templates by stored body presence. `html_and_text` requires both an HTML
+      # and text body; `html_only` requires HTML and no text body; `text_only` requires
+      # text and no HTML body; `no_body` requires neither. `null` and exactly `""` count
+      # as absent; whitespace-only strings count as content. An empty or unsupported
+      # value returns a 400 response.
+      module FilterContentType
+        extend Telnyx::Internal::Type::Enum
+
+        HTML_AND_TEXT = :html_and_text
+        HTML_ONLY = :html_only
+        TEXT_ONLY = :text_only
+        NO_BODY = :no_body
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Exact match on the template's `strict_variables` option. Only the exact query
+      # strings `true` and `false` are accepted; other values, including blank,
+      # return 400.
+      module FilterStrictVariables
+        extend Telnyx::Internal::Type::Enum
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/telnyx/models/email_template_render_response.rb

@@ -6,8 +6,8 @@ module Telnyx
     class EmailTemplateRenderResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #   Template object with `subject`, `html_body`, and `text_body` replaced by their
-      #   Liquid-rendered values. All other template fields (id, name, variables, etc.)
-      #   remain unchanged.
+      #   Liquid-rendered values. Rendered content is not limited by the stored
+      #   template-field lengths. All other template fields remain unchanged.
       #
       #   @return [Telnyx::Models::EmailTemplateRenderResponse::Data]
       required :data, -> { Telnyx::Models::EmailTemplateRenderResponse::Data }
@@ -19,11 +19,18 @@ module Telnyx
       #   @param data [Telnyx::Models::EmailTemplateRenderResponse::Data] Template object with `subject`, `html_body`, and `text_body` replaced by their L
 
       # @see Telnyx::Models::EmailTemplateRenderResponse#data
-      class Data < Telnyx::Models::EmailTemplate
-        # @!method initialize
+      class Data < Telnyx::Models::EmailTemplateCommon
+        # @!attribute subject
+        #
+        #   @return [String, nil]
+        required :subject, String, nil?: true
+
+        # @!method initialize(subject:)
         #   Template object with `subject`, `html_body`, and `text_body` replaced by their
-        #   Liquid-rendered values. All other template fields (id, name, variables, etc.)
-        #   remain unchanged.
+        #   Liquid-rendered values. Rendered content is not limited by the stored
+        #   template-field lengths. All other template fields remain unchanged.
+        #
+        #   @param subject [String, nil]
       end
     end
   end

data/lib/telnyx/models/enterprise_create_params.rb

@@ -24,6 +24,9 @@ module Telnyx
       required :country_code, String
 
       # @!attribute doing_business_as
+      #   The trade name your business operates under if it is different from your legal
+      #   name, also called a Doing Business As (DBA) name. Leave blank if you only use
+      #   your legal name.
       #
       #   @return [String]
       required :doing_business_as, String
@@ -35,18 +38,22 @@ module Telnyx
       required :fein, String
 
       # @!attribute industry
-      #   Industry classification.
+      #   The industry your business operates in. Choose the closest match from the list;
+      #   if your value is not accepted, pick the nearest category.
       #
       #   @return [Symbol, Telnyx::Models::EnterpriseCreateParams::Industry]
       required :industry, enum: -> { Telnyx::EnterpriseCreateParams::Industry }
 
       # @!attribute jurisdiction_of_incorporation
+      #   The state, province, or country where your business was legally incorporated,
+      #   for example Delaware.
       #
       #   @return [String]
       required :jurisdiction_of_incorporation, String
 
       # @!attribute legal_name
-      #   Legal name of the enterprise.
+      #   Your business's full registered legal name, exactly as it appears on your
+      #   incorporation or tax documents, 3 to 64 characters.
       #
       #   @return [String]
       required :legal_name, String
@@ -95,44 +102,59 @@ module Telnyx
       required :organization_type, enum: -> { Telnyx::EnterpriseCreateParams::OrganizationType }
 
       # @!attribute website
+      #   Your business's public website address, including https://. Leave blank if your
+      #   business has no website.
       #
       #   @return [String]
       required :website, String
 
       # @!attribute corporate_registration_number
-      #   Optional corporate-registration / company-number identifier.
+      #   The official number your company received when it was legally registered or
+      #   incorporated (for example from your state or national business registry). It is
+      #   on your certificate of incorporation.
       #
       #   @return [String, nil]
       optional :corporate_registration_number, String, nil?: true
 
       # @!attribute customer_reference
-      #   Optional free-form string the caller can attach for their own bookkeeping.
-      #   Telnyx does not interpret it.
+      #   Your own label for this account. Enter any reference that helps you find it in
+      #   your records. Telnyx does not use it during vetting.
       #
       #   @return [String, nil]
       optional :customer_reference, String
 
       # @!attribute dun_bradstreet_number
-      #   Optional D-U-N-S Number.
+      #   Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique
+      #   identifier for your business. Leave blank if you do not have one.
       #
       #   @return [String, nil]
       optional :dun_bradstreet_number, String, nil?: true
 
       # @!attribute primary_business_domain_sic_code
-      #   Optional SIC code for the primary line of business.
+      #   The 4-digit Standard Industrial Classification code for your main line of
+      #   business, which tells us what industry you operate in. Look it up in the SIC
+      #   code directory if you are unsure.
       #
       #   @return [String, nil]
       optional :primary_business_domain_sic_code, String, nil?: true
 
       # @!attribute professional_license_number
-      #   Optional professional-license number for regulated industries.
+      #   If your business operates under a professional license (for example legal,
+      #   medical, or financial services), enter the license number issued by the
+      #   licensing authority. Leave blank if it does not apply.
       #
       #   @return [String, nil]
       optional :professional_license_number, String, nil?: true
 
       # @!attribute role_type
-      #   `enterprise` for an organization registering its own DIRs; `bpo` for a Business
-      #   Process Outsourcer placing calls on behalf of one or more enterprises.
+      #   `enterprise` for an organization registering its own DIRs (the default, and the
+      #   right choice when the calls display your own brand). `bpo` for a Business
+      #   Process Outsourcer: a call center that places calls on behalf of other
+      #   enterprises and displays their brand. A `bpo` enterprise describes the call
+      #   center itself and cannot own a DIR. Each client the call center calls for gets
+      #   its own `enterprise` in the same account, with the client's DIR under it; that
+      #   DIR is then linked to the `bpo` enterprise through `bpo_authorizations`. Fixed
+      #   at creation.
       #
       #   @return [Symbol, Telnyx::Models::EnterpriseCreateParams::RoleType, nil]
       optional :role_type, enum: -> { Telnyx::EnterpriseCreateParams::RoleType }
@@ -147,15 +169,15 @@ module Telnyx
       #
       #   @param country_code [String] ISO 3166-1 alpha-2 country code. Currently `US` and `CA` are supported.
       #
-      #   @param doing_business_as [String]
+      #   @param doing_business_as [String] The trade name your business operates under if it is different from your legal n
       #
       #   @param fein [String] US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
       #
-      #   @param industry [Symbol, Telnyx::Models::EnterpriseCreateParams::Industry] Industry classification.
+      #   @param industry [Symbol, Telnyx::Models::EnterpriseCreateParams::Industry] The industry your business operates in. Choose the closest match from the list;
       #
-      #   @param jurisdiction_of_incorporation [String]
+      #   @param jurisdiction_of_incorporation [String] The state, province, or country where your business was legally incorporated, fo
       #
-      #   @param legal_name [String] Legal name of the enterprise.
+      #   @param legal_name [String] Your business's full registered legal name, exactly as it appears on your incorp
       #
       #   @param number_of_employees [Symbol, Telnyx::Models::EnterpriseCreateParams::NumberOfEmployees] Approximate headcount range. Used for vetting heuristics; pick the bucket that c
       #
@@ -167,23 +189,24 @@ module Telnyx
       #
       #   @param organization_type [Symbol, Telnyx::Models::EnterpriseCreateParams::OrganizationType] Organization category for vetting purposes:
       #
-      #   @param website [String]
+      #   @param website [String] Your business's public website address, including https://. Leave blank if your
       #
-      #   @param corporate_registration_number [String, nil] Optional corporate-registration / company-number identifier.
+      #   @param corporate_registration_number [String, nil] The official number your company received when it was legally registered or inco
       #
-      #   @param customer_reference [String] Optional free-form string the caller can attach for their own bookkeeping. Telny
+      #   @param customer_reference [String] Your own label for this account. Enter any reference that helps you find it in y
       #
-      #   @param dun_bradstreet_number [String, nil] Optional D-U-N-S Number.
+      #   @param dun_bradstreet_number [String, nil] Your optional 9-digit D-U-N-S Number issued by Dun & Bradstreet, a unique identi
       #
-      #   @param primary_business_domain_sic_code [String, nil] Optional SIC code for the primary line of business.
+      #   @param primary_business_domain_sic_code [String, nil] The 4-digit Standard Industrial Classification code for your main line of busine
       #
-      #   @param professional_license_number [String, nil] Optional professional-license number for regulated industries.
+      #   @param professional_license_number [String, nil] If your business operates under a professional license (for example legal, medic
       #
-      #   @param role_type [Symbol, Telnyx::Models::EnterpriseCreateParams::RoleType] `enterprise` for an organization registering its own DIRs; `bpo` for a Business
+      #   @param role_type [Symbol, Telnyx::Models::EnterpriseCreateParams::RoleType] `enterprise` for an organization registering its own DIRs (the default, and the
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-      # Industry classification.
+      # The industry your business operates in. Choose the closest match from the list;
+      # if your value is not accepted, pick the nearest category.
       module Industry
         extend Telnyx::Internal::Type::Enum
 
@@ -292,8 +315,14 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # `enterprise` for an organization registering its own DIRs; `bpo` for a Business
-      # Process Outsourcer placing calls on behalf of one or more enterprises.
+      # `enterprise` for an organization registering its own DIRs (the default, and the
+      # right choice when the calls display your own brand). `bpo` for a Business
+      # Process Outsourcer: a call center that places calls on behalf of other
+      # enterprises and displays their brand. A `bpo` enterprise describes the call
+      # center itself and cannot own a DIR. Each client the call center calls for gets
+      # its own `enterprise` in the same account, with the client's DIR under it; that
+      # DIR is then linked to the `bpo` enterprise through `bpo_authorizations`. Fixed
+      # at creation.
       module RoleType
         extend Telnyx::Internal::Type::Enum
 

data/lib/telnyx/models/enterprise_list_params.rb

@@ -13,6 +13,13 @@ module Telnyx
       #   @return [String, nil]
       optional :filter_legal_name_contains, String
 
+      # @!attribute filter_role_type
+      #   Only return enterprises of this type: `bpo` for call-center (BPO) enterprises,
+      #   `enterprise` for normal enterprises. Omit to return both.
+      #
+      #   @return [Symbol, Telnyx::Models::EnterpriseListParams::FilterRoleType, nil]
+      optional :filter_role_type, enum: -> { Telnyx::EnterpriseListParams::FilterRoleType }
+
       # @!attribute legal_name
       #   Filter by legal name (partial match).
       #
@@ -31,12 +38,14 @@ module Telnyx
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(filter_legal_name_contains: nil, legal_name: nil, page_number: nil, page_size: nil, request_options: {})
+      # @!method initialize(filter_legal_name_contains: nil, filter_role_type: nil, legal_name: nil, page_number: nil, page_size: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::EnterpriseListParams} for more details.
       #
       #   @param filter_legal_name_contains [String] Case-insensitive partial match on legal name.
       #
+      #   @param filter_role_type [Symbol, Telnyx::Models::EnterpriseListParams::FilterRoleType] Only return enterprises of this type: `bpo` for call-center (BPO) enterprises, `
+      #
       #   @param legal_name [String] Filter by legal name (partial match).
       #
       #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
@@ -44,6 +53,18 @@ module Telnyx
       #   @param page_size [Integer] Items per page. Default 10. Maximum 250; values above are clamped to 250.
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Only return enterprises of this type: `bpo` for call-center (BPO) enterprises,
+      # `enterprise` for normal enterprises. Omit to return both.
+      module FilterRoleType
+        extend Telnyx::Internal::Type::Enum
+
+        ENTERPRISE = :enterprise
+        BPO = :bpo
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end