telnyx 5.169.0 → 5.170.0

data/rbi/telnyx/models/email_messages/email_recipient.rbi

@@ -243,6 +243,16 @@ module Telnyx
               :cancelled,
               Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
             )
+          INJECTION_TIMEOUT =
+            T.let(
+              :injection_timeout,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/email_messages/recipient_list_params.rbi

@@ -201,6 +201,16 @@ module Telnyx
               :cancelled,
               Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
             )
+          INJECTION_TIMEOUT =
+            T.let(
+              :injection_timeout,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/email_template.rbi

@@ -9,6 +9,12 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :id
 
+      # 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.
+      sig { returns(T::Boolean) }
+      attr_accessor :autoescape
+
       sig { returns(Time) }
       attr_accessor :created_at
 
@@ -21,6 +27,12 @@ module Telnyx
       sig { returns(Telnyx::EmailTemplate::RecordType::TaggedSymbol) }
       attr_accessor :record_type
 
+      # 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.
+      sig { returns(T::Boolean) }
+      attr_accessor :strict_variables
+
       sig { returns(T.nilable(String)) }
       attr_accessor :subject
 
@@ -30,31 +42,59 @@ module Telnyx
       sig { returns(Time) }
       attr_accessor :updated_at
 
+      # Structured variable requirements, or `null` when the template uses only the
+      # legacy `variables` array.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema])
+        )
+      end
+      attr_accessor :variable_schema
+
+      # Legacy unstructured variable names. This path remains supported unchanged.
       sig { returns(T::Array[String]) }
       attr_accessor :variables
 
       sig do
         params(
           id: String,
+          autoescape: T::Boolean,
           created_at: Time,
           html_body: T.nilable(String),
           name: String,
           record_type: Telnyx::EmailTemplate::RecordType::OrSymbol,
+          strict_variables: T::Boolean,
           subject: T.nilable(String),
           text_body: T.nilable(String),
           updated_at: Time,
+          variable_schema:
+            T.nilable(
+              T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema::OrHash]
+            ),
           variables: T::Array[String]
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
+        # 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.
+        autoescape:,
         created_at:,
         html_body:,
         name:,
         record_type:,
+        # 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.
+        strict_variables:,
         subject:,
         text_body:,
         updated_at:,
+        # Structured variable requirements, or `null` when the template uses only the
+        # legacy `variables` array.
+        variable_schema:,
+        # Legacy unstructured variable names. This path remains supported unchanged.
         variables:
       )
       end
@@ -63,13 +103,17 @@ module Telnyx
         override.returns(
           {
             id: String,
+            autoescape: T::Boolean,
             created_at: Time,
             html_body: T.nilable(String),
             name: String,
             record_type: Telnyx::EmailTemplate::RecordType::TaggedSymbol,
+            strict_variables: T::Boolean,
             subject: T.nilable(String),
             text_body: T.nilable(String),
             updated_at: Time,
+            variable_schema:
+              T.nilable(T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema]),
             variables: T::Array[String]
           }
         )
@@ -98,6 +142,46 @@ module Telnyx
         def self.values
         end
       end
+
+      class VariableSchema < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailTemplate::VariableSchema,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Whether the variable must be supplied when strict variable validation is
+        # enabled.
+        sig { returns(T::Boolean) }
+        attr_accessor :required
+
+        # Default value for an optional variable. Rejected when `required` is `true`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :default
+
+        sig { params(default: String).void }
+        attr_writer :default
+
+        sig do
+          params(required: T::Boolean, default: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Whether the variable must be supplied when strict variable validation is
+          # enabled.
+          required:,
+          # Default value for an optional variable. Rejected when `required` is `true`.
+          default: nil
+        )
+        end
+
+        sig { override.returns({ required: T::Boolean, default: String }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/email_template_create_params.rbi

@@ -15,10 +15,36 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :name
 
+      # Per-template HTML autoescaping setting. Defaults to `false` for backward
+      # compatibility. When `true`, the rendered `html_body` HTML-escapes each Liquid
+      # expression's output at the output boundary (after its filters run, before
+      # concatenation with literal template markup). Input values are never mutated and
+      # `subject`/`text_body` are never autoescaped. The boundary escape is idempotent:
+      # HTML entities already present in the output (e.g. from an explicit `escape`
+      # filter) are preserved, so an explicit `escape`/`escape_once` is never
+      # double-escaped, and markup introduced by any later filter in the chain is still
+      # escaped.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :autoescape
+
+      sig { params(autoescape: T::Boolean).void }
+      attr_writer :autoescape
+
       # Liquid template HTML body.
       sig { returns(T.nilable(String)) }
       attr_accessor :html_body
 
+      # Per-template strict variable-validation setting. Defaults to `false` for
+      # backward compatibility. When `true`, a send or render that is missing a variable
+      # marked `required: true` in `variable_schema` fails with 422 naming the variable.
+      # Missing optional variables never fail; their schema `default` (when set) is
+      # applied to the render.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :strict_variables
+
+      sig { params(strict_variables: T::Boolean).void }
+      attr_writer :strict_variables
+
       # Liquid template subject.
       sig { returns(T.nilable(String)) }
       attr_accessor :subject
@@ -27,6 +53,22 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :text_body
 
+      # Structured variable requirements. Required variables cannot define defaults;
+      # invalid combinations return 422. This is independent of the legacy `variables`
+      # array. On render with `strict_variables` enabled: `required` variables must be
+      # supplied as non-empty values — absent, `null`, empty string, empty object `{}`,
+      # and empty array `[]` all fail with 422 naming the variable, while present values
+      # such as `false` and `0` pass (they are present, not empty). Optional variables
+      # fall back to their `default` when absent.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[Symbol, Telnyx::EmailTemplateCreateParams::VariableSchema]
+          )
+        )
+      end
+      attr_accessor :variable_schema
+
       # Template variables. Auto-extracted from subject/body fields when absent.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :variables
@@ -43,9 +85,18 @@ module Telnyx
       sig do
         params(
           name: String,
+          autoescape: T::Boolean,
           html_body: T.nilable(String),
+          strict_variables: T::Boolean,
           subject: T.nilable(String),
           text_body: T.nilable(String),
+          variable_schema:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Telnyx::EmailTemplateCreateParams::VariableSchema::OrHash
+              ]
+            ),
           variables: T::Array[String],
           idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
@@ -54,12 +105,36 @@ module Telnyx
       def self.new(
         # Letters, numbers, spaces, hyphens, and underscores only.
         name:,
+        # Per-template HTML autoescaping setting. Defaults to `false` for backward
+        # compatibility. When `true`, the rendered `html_body` HTML-escapes each Liquid
+        # expression's output at the output boundary (after its filters run, before
+        # concatenation with literal template markup). Input values are never mutated and
+        # `subject`/`text_body` are never autoescaped. The boundary escape is idempotent:
+        # HTML entities already present in the output (e.g. from an explicit `escape`
+        # filter) are preserved, so an explicit `escape`/`escape_once` is never
+        # double-escaped, and markup introduced by any later filter in the chain is still
+        # escaped.
+        autoescape: nil,
         # Liquid template HTML body.
         html_body: nil,
+        # Per-template strict variable-validation setting. Defaults to `false` for
+        # backward compatibility. When `true`, a send or render that is missing a variable
+        # marked `required: true` in `variable_schema` fails with 422 naming the variable.
+        # Missing optional variables never fail; their schema `default` (when set) is
+        # applied to the render.
+        strict_variables: nil,
         # Liquid template subject.
         subject: nil,
         # Liquid template text body.
         text_body: nil,
+        # Structured variable requirements. Required variables cannot define defaults;
+        # invalid combinations return 422. This is independent of the legacy `variables`
+        # array. On render with `strict_variables` enabled: `required` variables must be
+        # supplied as non-empty values — absent, `null`, empty string, empty object `{}`,
+        # and empty array `[]` all fail with 422 naming the variable, while present values
+        # 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.
         variables: nil,
         idempotency_key: nil,
@@ -71,9 +146,18 @@ module Telnyx
         override.returns(
           {
             name: String,
+            autoescape: T::Boolean,
             html_body: T.nilable(String),
+            strict_variables: T::Boolean,
             subject: T.nilable(String),
             text_body: T.nilable(String),
+            variable_schema:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Telnyx::EmailTemplateCreateParams::VariableSchema
+                ]
+              ),
             variables: T::Array[String],
             idempotency_key: String,
             request_options: Telnyx::RequestOptions
@@ -82,6 +166,46 @@ module Telnyx
       end
       def to_hash
       end
+
+      class VariableSchema < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailTemplateCreateParams::VariableSchema,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Whether the variable must be supplied when strict variable validation is
+        # enabled.
+        sig { returns(T::Boolean) }
+        attr_accessor :required
+
+        # Default value for an optional variable. Rejected when `required` is `true`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :default
+
+        sig { params(default: String).void }
+        attr_writer :default
+
+        sig do
+          params(required: T::Boolean, default: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Whether the variable must be supplied when strict variable validation is
+          # enabled.
+          required:,
+          # Default value for an optional variable. Rejected when `required` is `true`.
+          default: nil
+        )
+        end
+
+        sig { override.returns({ required: T::Boolean, default: String }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/email_webhook_recipient.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailWebhookRecipient < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailWebhookRecipient, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :email
+
+      sig do
+        returns(T.nilable(Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol))
+      end
+      attr_reader :kind
+
+      sig { params(kind: Telnyx::EmailWebhookRecipient::Kind::OrSymbol).void }
+      attr_writer :kind
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          email: String,
+          kind: Telnyx::EmailWebhookRecipient::Kind::OrSymbol,
+          name: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(email:, kind: nil, name: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            kind: Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol,
+            name: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Kind
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailWebhookRecipient::Kind) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TO = T.let(:to, Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol)
+        CC = T.let(:cc, Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol)
+        BCC = T.let(:bcc, Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailWebhookRecipient::Kind::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/meeting_session.rbi

@@ -263,24 +263,40 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :id
 
-        # Audio gating strategy for the assistant call leg.
+        # Audio gating strategy in force for the assistant call leg.
         sig do
           returns(Telnyx::MeetingSession::Assistant::AudioGate::TaggedSymbol)
         end
         attr_accessor :audio_gate
 
+        # The dynamic variables in force for this session, or null when none were
+        # supplied.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :dynamic_variables
+
+        # Whether the bot leaves when the Assistant's conversation ends or fails.
+        sig { returns(T::Boolean) }
+        attr_accessor :leave_on_end
+
         # Assistant configuration if an assistant is attached, otherwise null.
         sig do
           params(
             id: String,
-            audio_gate: Telnyx::MeetingSession::Assistant::AudioGate::OrSymbol
+            audio_gate: Telnyx::MeetingSession::Assistant::AudioGate::OrSymbol,
+            dynamic_variables: T.nilable(T::Hash[Symbol, String]),
+            leave_on_end: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
           # Identifier of the assistant.
           id:,
-          # Audio gating strategy for the assistant call leg.
-          audio_gate:
+          # Audio gating strategy in force for the assistant call leg.
+          audio_gate:,
+          # The dynamic variables in force for this session, or null when none were
+          # supplied.
+          dynamic_variables:,
+          # Whether the bot leaves when the Assistant's conversation ends or fails.
+          leave_on_end:
         )
         end
 
@@ -289,14 +305,16 @@ module Telnyx
             {
               id: String,
               audio_gate:
-                Telnyx::MeetingSession::Assistant::AudioGate::TaggedSymbol
+                Telnyx::MeetingSession::Assistant::AudioGate::TaggedSymbol,
+              dynamic_variables: T.nilable(T::Hash[Symbol, String]),
+              leave_on_end: T::Boolean
             }
           )
         end
         def to_hash
         end
 
-        # Audio gating strategy for the assistant call leg.
+        # Audio gating strategy in force for the assistant call leg.
         module AudioGate
           extend Telnyx::Internal::Type::Enum
 
@@ -306,14 +324,14 @@ module Telnyx
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          NONE =
+          HALF_DUPLEX =
             T.let(
-              :none,
+              :half_duplex,
               Telnyx::MeetingSession::Assistant::AudioGate::TaggedSymbol
             )
-          HALF_DUPLEX =
+          FULL_DUPLEX =
             T.let(
-              :half_duplex,
+              :full_duplex,
               Telnyx::MeetingSession::Assistant::AudioGate::TaggedSymbol
             )
 
@@ -430,6 +448,10 @@ module Telnyx
         sig { returns(T::Boolean) }
         attr_accessor :barge_in
 
+        # The message posted to chat on join, or null when unset.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :chat_on_enter
+
         # Text spoken on meeting entry, or null if not set.
         sig { returns(T.nilable(String)) }
         attr_accessor :speak_on_enter
@@ -445,6 +467,7 @@ module Telnyx
         sig do
           params(
             barge_in: T::Boolean,
+            chat_on_enter: T.nilable(String),
             speak_on_enter: T.nilable(String),
             summarize_on_end: T::Boolean,
             voice: T.nilable(String)
@@ -455,6 +478,8 @@ module Telnyx
           # current bot audio; it does not bypass admission or initiate speech. Assistant
           # sessions reject `barge_in: true`.
           barge_in:,
+          # The message posted to chat on join, or null when unset.
+          chat_on_enter:,
           # Text spoken on meeting entry, or null if not set.
           speak_on_enter:,
           # Whether a summary artifact is generated on session end.
@@ -468,6 +493,7 @@ module Telnyx
           override.returns(
             {
               barge_in: T::Boolean,
+              chat_on_enter: T.nilable(String),
               speak_on_enter: T.nilable(String),
               summarize_on_end: T::Boolean,
               voice: T.nilable(String)