telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/email_template_create_params.rbi

@@ -69,12 +69,32 @@ module Telnyx
       end
       attr_accessor :variable_schema
 
-      # 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.
       sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :variables
+      attr_accessor :variables
 
-      sig { params(variables: T::Array[String]).void }
-      attr_writer :variables
+      # 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.
+      sig do
+        returns(
+          T.nilable(Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol)
+        )
+      end
+      attr_reader :variables_mode
+
+      sig do
+        params(
+          variables_mode:
+            Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol
+        ).void
+      end
+      attr_writer :variables_mode
 
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
@@ -97,7 +117,9 @@ module Telnyx
                 Telnyx::EmailTemplateCreateParams::VariableSchema::OrHash
               ]
             ),
-          variables: T::Array[String],
+          variables: T.nilable(T::Array[String]),
+          variables_mode:
+            Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol,
           idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -135,8 +157,17 @@ module Telnyx
         # such as `false` and `0` pass (they are present, not empty). Optional variables
         # fall back to their `default` when absent.
         variable_schema: nil,
-        # 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.
         variables: nil,
+        # 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.
+        variables_mode: nil,
         idempotency_key: nil,
         request_options: {}
       )
@@ -158,7 +189,9 @@ module Telnyx
                   Telnyx::EmailTemplateCreateParams::VariableSchema
                 ]
               ),
-            variables: T::Array[String],
+            variables: T.nilable(T::Array[String]),
+            variables_mode:
+              Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol,
             idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
@@ -206,6 +239,43 @@ module Telnyx
         def to_hash
         end
       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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailTemplateCreateParams::VariablesMode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTOMATIC =
+          T.let(
+            :automatic,
+            Telnyx::EmailTemplateCreateParams::VariablesMode::TaggedSymbol
+          )
+        EXPLICIT =
+          T.let(
+            :explicit,
+            Telnyx::EmailTemplateCreateParams::VariablesMode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailTemplateCreateParams::VariablesMode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/email_template_list_params.rbi

@@ -11,6 +11,74 @@ module Telnyx
           T.any(Telnyx::EmailTemplateListParams, Telnyx::Internal::AnyHash)
         end
 
+      # Exact match on the template's `autoescape` option. Only the exact query strings
+      # `true` and `false` are accepted; other values, including blank, return 400.
+      sig do
+        returns(
+          T.nilable(Telnyx::EmailTemplateListParams::FilterAutoescape::OrSymbol)
+        )
+      end
+      attr_reader :filter_autoescape
+
+      sig do
+        params(
+          filter_autoescape:
+            Telnyx::EmailTemplateListParams::FilterAutoescape::OrSymbol
+        ).void
+      end
+      attr_writer :filter_autoescape
+
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::EmailTemplateListParams::FilterContentType::OrSymbol
+          )
+        )
+      end
+      attr_reader :filter_content_type
+
+      sig do
+        params(
+          filter_content_type:
+            Telnyx::EmailTemplateListParams::FilterContentType::OrSymbol
+        ).void
+      end
+      attr_writer :filter_content_type
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter_query
+
+      sig { params(filter_query: String).void }
+      attr_writer :filter_query
+
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::EmailTemplateListParams::FilterStrictVariables::OrSymbol
+          )
+        )
+      end
+      attr_reader :filter_strict_variables
+
+      sig do
+        params(
+          filter_strict_variables:
+            Telnyx::EmailTemplateListParams::FilterStrictVariables::OrSymbol
+        ).void
+      end
+      attr_writer :filter_strict_variables
+
       # Opaque URL-safe Base64 cursor returned by a previous list response.
       sig { returns(T.nilable(String)) }
       attr_reader :page_cursor
@@ -28,12 +96,36 @@ module Telnyx
 
       sig do
         params(
+          filter_autoescape:
+            Telnyx::EmailTemplateListParams::FilterAutoescape::OrSymbol,
+          filter_content_type:
+            Telnyx::EmailTemplateListParams::FilterContentType::OrSymbol,
+          filter_query: String,
+          filter_strict_variables:
+            Telnyx::EmailTemplateListParams::FilterStrictVariables::OrSymbol,
           page_cursor: String,
           page_size: Integer,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Exact match on the template's `autoescape` option. Only the exact query strings
+        # `true` and `false` are accepted; other values, including blank, return 400.
+        filter_autoescape: nil,
+        # 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.
+        filter_content_type: nil,
+        # 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.
+        filter_query: nil,
+        # 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.
+        filter_strict_variables: nil,
         # Opaque URL-safe Base64 cursor returned by a previous list response.
         page_cursor: nil,
         # Number of results to return. Defaults to 25; maximum is 100. Invalid values are
@@ -46,6 +138,13 @@ module Telnyx
       sig do
         override.returns(
           {
+            filter_autoescape:
+              Telnyx::EmailTemplateListParams::FilterAutoescape::OrSymbol,
+            filter_content_type:
+              Telnyx::EmailTemplateListParams::FilterContentType::OrSymbol,
+            filter_query: String,
+            filter_strict_variables:
+              Telnyx::EmailTemplateListParams::FilterStrictVariables::OrSymbol,
             page_cursor: String,
             page_size: Integer,
             request_options: Telnyx::RequestOptions
@@ -54,6 +153,122 @@ module Telnyx
       end
       def to_hash
       end
+
+      # 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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailTemplateListParams::FilterAutoescape)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            Telnyx::EmailTemplateListParams::FilterAutoescape::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            Telnyx::EmailTemplateListParams::FilterAutoescape::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailTemplateListParams::FilterAutoescape::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailTemplateListParams::FilterContentType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML_AND_TEXT =
+          T.let(
+            :html_and_text,
+            Telnyx::EmailTemplateListParams::FilterContentType::TaggedSymbol
+          )
+        HTML_ONLY =
+          T.let(
+            :html_only,
+            Telnyx::EmailTemplateListParams::FilterContentType::TaggedSymbol
+          )
+        TEXT_ONLY =
+          T.let(
+            :text_only,
+            Telnyx::EmailTemplateListParams::FilterContentType::TaggedSymbol
+          )
+        NO_BODY =
+          T.let(
+            :no_body,
+            Telnyx::EmailTemplateListParams::FilterContentType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailTemplateListParams::FilterContentType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::EmailTemplateListParams::FilterStrictVariables
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRUE =
+          T.let(
+            :true,
+            Telnyx::EmailTemplateListParams::FilterStrictVariables::TaggedSymbol
+          )
+        FALSE =
+          T.let(
+            :false,
+            Telnyx::EmailTemplateListParams::FilterStrictVariables::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::EmailTemplateListParams::FilterStrictVariables::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/email_template_render_response.rbi

@@ -12,8 +12,8 @@ module Telnyx
         end
 
       # 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.
       sig { returns(Telnyx::Models::EmailTemplateRenderResponse::Data) }
       attr_reader :data
 
@@ -31,8 +31,8 @@ module Telnyx
       end
       def self.new(
         # 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.
         data:
       )
       end
@@ -45,7 +45,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Models::EmailTemplate
+      class Data < Telnyx::Models::EmailTemplateCommon
         OrHash =
           T.type_alias do
             T.any(
@@ -54,14 +54,17 @@ module Telnyx
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :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.
-        sig { returns(T.attached_class) }
-        def self.new
+        # Liquid-rendered values. Rendered content is not limited by the stored
+        # template-field lengths. All other template fields remain unchanged.
+        sig { params(subject: T.nilable(String)).returns(T.attached_class) }
+        def self.new(subject:)
         end
 
-        sig { override.returns({}) }
+        sig { override.returns({ subject: T.nilable(String) }) }
         def to_hash
         end
       end

data/rbi/telnyx/models/enterprise_create_params.rbi

@@ -27,6 +27,9 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :country_code
 
+      # 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.
       sig { returns(String) }
       attr_accessor :doing_business_as
 
@@ -34,14 +37,18 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :fein
 
-      # 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.
       sig { returns(Telnyx::EnterpriseCreateParams::Industry::OrSymbol) }
       attr_accessor :industry
 
+      # The state, province, or country where your business was legally incorporated,
+      # for example Delaware.
       sig { returns(String) }
       attr_accessor :jurisdiction_of_incorporation
 
-      # 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.
       sig { returns(String) }
       attr_accessor :legal_name
 
@@ -96,35 +103,50 @@ module Telnyx
       end
       attr_accessor :organization_type
 
+      # Your business's public website address, including https://. Leave blank if your
+      # business has no website.
       sig { returns(String) }
       attr_accessor :website
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :corporate_registration_number
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_reader :customer_reference
 
       sig { params(customer_reference: String).void }
       attr_writer :customer_reference
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :dun_bradstreet_number
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :primary_business_domain_sic_code
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :professional_license_number
 
-      # `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.
       sig do
         returns(T.nilable(Telnyx::EnterpriseCreateParams::RoleType::OrSymbol))
       end
@@ -170,13 +192,20 @@ module Telnyx
         billing_contact:,
         # ISO 3166-1 alpha-2 country code. Currently `US` and `CA` are supported.
         country_code:,
+        # 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.
         doing_business_as:,
         # US Federal Employer Identification Number (`NN-NNNNNNN`) or Canadian equivalent.
         fein:,
-        # 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.
         industry:,
+        # The state, province, or country where your business was legally incorporated,
+        # for example Delaware.
         jurisdiction_of_incorporation:,
-        # 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.
         legal_name:,
         # Approximate headcount range. Used for vetting heuristics; pick the bucket that
         # contains your current employee count.
@@ -201,20 +230,35 @@ module Telnyx
         # - `non_profit` - registered 501(c)(3)/equivalent (incl. educational
         #   institutions, charities, religious organisations).
         organization_type:,
+        # Your business's public website address, including https://. Leave blank if your
+        # business has no website.
         website:,
-        # 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.
         corporate_registration_number: nil,
-        # 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.
         customer_reference: nil,
-        # 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.
         dun_bradstreet_number: nil,
-        # 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.
         primary_business_domain_sic_code: nil,
-        # 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.
         professional_license_number: nil,
-        # `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.
         role_type: nil,
         request_options: {}
       )
@@ -253,7 +297,8 @@ module Telnyx
       def to_hash
       end
 
-      # 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
 
@@ -614,8 +659,14 @@ module Telnyx
         end
       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