telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/call_machine_premium_detection_started_webhook_event.rbi

@@ -0,0 +1,336 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class CallMachinePremiumDetectionStartedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::CallMachinePremiumDetectionStartedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data
+          )
+        )
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data:
+            Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the type of resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The type of event being delivered.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :event_type
+
+        sig do
+          params(
+            event_type:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::OrSymbol
+          ).void
+        end
+        attr_writer :event_type
+
+        # ISO 8601 datetime of when the event occurred.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :occurred_at
+
+        sig { params(occurred_at: Time).void }
+        attr_writer :occurred_at
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload
+            )
+          )
+        end
+        attr_reader :payload
+
+        sig do
+          params(
+            payload:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        # Identifies the type of the resource.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::OrSymbol
+          ).void
+        end
+        attr_writer :record_type
+
+        sig do
+          params(
+            id: String,
+            event_type:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the type of resource.
+          id: nil,
+          # The type of event being delivered.
+          event_type: nil,
+          # ISO 8601 datetime of when the event occurred.
+          occurred_at: nil,
+          payload: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              event_type:
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload:
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of event being delivered.
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CALL_MACHINE_PREMIUM_DETECTION_STARTED =
+            T.let(
+              :"call.machine.premium.detection.started",
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Call ID used to issue commands via Call Control API.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_control_id
+
+          sig { params(call_control_id: String).void }
+          attr_writer :call_control_id
+
+          # ID that is unique to the call and can be used to correlate webhook events.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_leg_id
+
+          sig { params(call_leg_id: String).void }
+          attr_writer :call_leg_id
+
+          # ID that is unique to the call session and can be used to correlate webhook
+          # events. Call session is a group of related call legs that logically belong to
+          # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_session_id
+
+          sig { params(call_session_id: String).void }
+          attr_writer :call_session_id
+
+          # State received from a command.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_state
+
+          sig { params(client_state: String).void }
+          attr_writer :client_state
+
+          # Call Control App ID (formerly Telnyx connection ID) used in the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :connection_id
+
+          sig { params(connection_id: String).void }
+          attr_writer :connection_id
+
+          # Number or SIP URI placing the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :from
+
+          sig { params(from: String).void }
+          attr_writer :from
+
+          # Destination number or SIP URI of the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          sig do
+            params(
+              call_control_id: String,
+              call_leg_id: String,
+              call_session_id: String,
+              client_state: String,
+              connection_id: String,
+              from: String,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Call ID used to issue commands via Call Control API.
+            call_control_id: nil,
+            # ID that is unique to the call and can be used to correlate webhook events.
+            call_leg_id: nil,
+            # ID that is unique to the call session and can be used to correlate webhook
+            # events. Call session is a group of related call legs that logically belong to
+            # the same phone call, e.g. an inbound and outbound leg of a transferred call.
+            call_session_id: nil,
+            # State received from a command.
+            client_state: nil,
+            # Call Control App ID (formerly Telnyx connection ID) used in the call.
+            connection_id: nil,
+            # Number or SIP URI placing the call.
+            from: nil,
+            # Destination number or SIP URI of the call.
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_id: String,
+                call_leg_id: String,
+                call_session_id: String,
+                client_state: String,
+                connection_id: String,
+                from: String,
+                to: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Identifies the type of the resource.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallMachinePremiumDetectionStartedWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_machine_premium_greeting_ended.rbi

@@ -193,7 +193,9 @@ module Telnyx
         sig { params(from: String).void }
         attr_writer :from
 
-        # Premium Answering Machine Greeting Ended result.
+        # Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+        # when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+        # the iOS call-screening prompt ends without a beep.
         sig do
           returns(
             T.nilable(
@@ -246,7 +248,9 @@ module Telnyx
           connection_id: nil,
           # Number or SIP URI placing the call.
           from: nil,
-          # Premium Answering Machine Greeting Ended result.
+          # Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+          # when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+          # the iOS call-screening prompt ends without a beep.
           result: nil,
           # Destination number or SIP URI of the call.
           to: nil
@@ -271,7 +275,9 @@ module Telnyx
         def to_hash
         end
 
-        # Premium Answering Machine Greeting Ended result.
+        # Premium Answering Machine Greeting Ended result. `prompt_ended` is only sent
+        # when `answering_machine_detection` is `premium_ios_call_screening_detection` and
+        # the iOS call-screening prompt ends without a beep.
         module Result
           extend Telnyx::Internal::Type::Enum
 
@@ -294,6 +300,11 @@ module Telnyx
               :no_beep_detected,
               Telnyx::CallMachinePremiumGreetingEnded::Payload::Result::TaggedSymbol
             )
+          PROMPT_ENDED =
+            T.let(
+              :prompt_ended,
+              Telnyx::CallMachinePremiumGreetingEnded::Payload::Result::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/calls/action_answer_params.rbi

@@ -15,9 +15,11 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :call_control_id
 
-        # AI Assistant configuration. All fields except `id` are optional — the
-        # assistant's stored configuration will be used as fallback for any omitted
-        # fields.
+        # AI Assistant configuration and per-call overrides. All fields except `id` are
+        # optional. Omitted assistant fields use the stored configuration. Supplied
+        # `voice_settings` and `transcription` objects replace their stored objects rather
+        # than merging individual settings; include every setting you want to retain.
+        # `dynamic_variables` are merged, with request values taking precedence.
         sig { returns(T.nilable(Telnyx::CallAssistantRequest)) }
         attr_reader :assistant
 
@@ -317,7 +319,9 @@ module Telnyx
         sig { params(stream_url: String).void }
         attr_writer :stream_url
 
-        # Enable transcription upon call answer. The default value is false.
+        # Enable standalone call transcription upon call answer. The default value is
+        # false. Configure this feature with `transcription_config`. To configure speech
+        # recognition for an AI assistant, use `assistant.transcription` instead.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :transcription
 
@@ -473,9 +477,11 @@ module Telnyx
         end
         def self.new(
           call_control_id:,
-          # AI Assistant configuration. All fields except `id` are optional — the
-          # assistant's stored configuration will be used as fallback for any omitted
-          # fields.
+          # AI Assistant configuration and per-call overrides. All fields except `id` are
+          # optional. Omitted assistant fields use the stored configuration. Supplied
+          # `voice_settings` and `transcription` objects replace their stored objects rather
+          # than merging individual settings; include every setting you want to retain.
+          # `dynamic_variables` are merged, with request values taking precedence.
           assistant: nil,
           # Use this field to set the Billing Group ID for the call. Must be a valid and
           # existing Billing Group ID.
@@ -551,7 +557,9 @@ module Telnyx
           stream_track: nil,
           # The destination WebSocket address where the stream is going to be delivered.
           stream_url: nil,
-          # Enable transcription upon call answer. The default value is false.
+          # Enable standalone call transcription upon call answer. The default value is
+          # false. Configure this feature with `transcription_config`. To configure speech
+          # recognition for an AI assistant, use `assistant.transcription` instead.
           transcription: nil,
           transcription_config: nil,
           # A map of event types to retry policies. Each retry policy contains an array of

data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi

@@ -161,10 +161,10 @@ module Telnyx
         #   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
         #   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
         #   for compatibility.
-        # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-        #   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-        #   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-        #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+        # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+        #   `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+        #   `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+        #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
         # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
         #   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
         #   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
@@ -320,10 +320,10 @@ module Telnyx
           #   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
           #   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
           #   for compatibility.
-          # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-          #   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-          #   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-          #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+          # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+          #   `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+          #   `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+          #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
           # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
           #   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
           #   ElevenLabs, you must provide your ElevenLabs API key as an integration secret

data/rbi/telnyx/models/calls/action_pay_params.rbi

@@ -92,6 +92,17 @@ module Telnyx
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # Minimum number of digits the caller must enter when collecting a credit-card
+        # billing postal code. Applies only when `postal_code` is `true` or `"true"` and
+        # no `payment_token` is supplied. The default is 1. The maximum number of digits
+        # collected is the greater of 10 and this value. This does not validate the length
+        # of a postal code supplied directly in `postal_code`.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_postal_code_length
+
+        sig { params(min_postal_code_length: Integer).void }
+        attr_writer :min_postal_code_length
+
         # Additional parameters forwarded to the Pay connector.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :parameters
@@ -122,6 +133,28 @@ module Telnyx
         sig { params(payment_token: String).void }
         attr_writer :payment_token
 
+        # Controls billing postal code collection for credit-card payments when no
+        # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+        # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+        # to skip the postal code prompt without supplying a postal code to the payment
+        # connector. Supply any other non-empty string, such as `"90210"`, to use that
+        # postal code without prompting. Empty or whitespace-only strings are rejected.
+        # This option does not affect ACH debit payments or payments using an existing
+        # token.
+        sig do
+          returns(
+            T.nilable(Telnyx::Calls::ActionPayParams::PostalCode::Variants)
+          )
+        end
+        attr_reader :postal_code
+
+        sig do
+          params(
+            postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants
+          ).void
+        end
+        attr_writer :postal_code
+
         # Custom text-to-speech prompts keyed by payment collection step.
         sig { returns(T.nilable(Telnyx::Calls::ActionPayParams::Prompts)) }
         attr_reader :prompts
@@ -206,10 +239,12 @@ module Telnyx
             language: String,
             max_attempts: Integer,
             metadata: T::Hash[Symbol, T.anything],
+            min_postal_code_length: Integer,
             parameters: T::Hash[Symbol, T.anything],
             payment_method:
               Telnyx::Calls::ActionPayParams::PaymentMethod::OrSymbol,
             payment_token: String,
+            postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants,
             prompts: Telnyx::Calls::ActionPayParams::Prompts::OrHash,
             service_level: String,
             timeout_millis: Integer,
@@ -244,12 +279,27 @@ module Telnyx
           max_attempts: nil,
           # Metadata forwarded to the Pay connector.
           metadata: nil,
+          # Minimum number of digits the caller must enter when collecting a credit-card
+          # billing postal code. Applies only when `postal_code` is `true` or `"true"` and
+          # no `payment_token` is supplied. The default is 1. The maximum number of digits
+          # collected is the greater of 10 and this value. This does not validate the length
+          # of a postal code supplied directly in `postal_code`.
+          min_postal_code_length: nil,
           # Additional parameters forwarded to the Pay connector.
           parameters: nil,
           # Payment method to collect.
           payment_method: nil,
           # Existing payment token. When supplied, payment-detail collection is skipped.
           payment_token: nil,
+          # Controls billing postal code collection for credit-card payments when no
+          # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+          # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+          # to skip the postal code prompt without supplying a postal code to the payment
+          # connector. Supply any other non-empty string, such as `"90210"`, to use that
+          # postal code without prompting. Empty or whitespace-only strings are rejected.
+          # This option does not affect ACH debit payments or payments using an existing
+          # token.
+          postal_code: nil,
           # Custom text-to-speech prompts keyed by payment collection step.
           prompts: nil,
           # Speech synthesis service level used for payment prompts. Pay defaults to
@@ -287,10 +337,12 @@ module Telnyx
               language: String,
               max_attempts: Integer,
               metadata: T::Hash[Symbol, T.anything],
+              min_postal_code_length: Integer,
               parameters: T::Hash[Symbol, T.anything],
               payment_method:
                 Telnyx::Calls::ActionPayParams::PaymentMethod::OrSymbol,
               payment_token: String,
+              postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants,
               prompts: Telnyx::Calls::ActionPayParams::Prompts,
               service_level: String,
               timeout_millis: Integer,
@@ -364,6 +416,28 @@ module Telnyx
           end
         end
 
+        # Controls billing postal code collection for credit-card payments when no
+        # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+        # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+        # to skip the postal code prompt without supplying a postal code to the payment
+        # connector. Supply any other non-empty string, such as `"90210"`, to use that
+        # postal code without prompting. Empty or whitespace-only strings are rejected.
+        # This option does not affect ACH debit payments or payments using an existing
+        # token.
+        module PostalCode
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Calls::ActionPayParams::PostalCode::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
         class Prompts < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/telnyx/models/calls/action_reject_params.rbi

@@ -15,7 +15,10 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :call_control_id
 
-        # Cause for call rejection.
+        # Cause for call rejection. The cause sets the SIP response the caller receives:
+        # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+        # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+        # Unavailable.
         sig { returns(Telnyx::Calls::ActionRejectParams::Cause::OrSymbol) }
         attr_accessor :cause
 
@@ -46,7 +49,10 @@ module Telnyx
         end
         def self.new(
           call_control_id:,
-          # Cause for call rejection.
+          # Cause for call rejection. The cause sets the SIP response the caller receives:
+          # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+          # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+          # Unavailable.
           cause:,
           # Use this field to add state to every subsequent webhook. It must be a valid
           # Base-64 encoded string.
@@ -72,7 +78,10 @@ module Telnyx
         def to_hash
         end
 
-        # Cause for call rejection.
+        # Cause for call rejection. The cause sets the SIP response the caller receives:
+        # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+        # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+        # Unavailable.
         module Cause
           extend Telnyx::Internal::Type::Enum
 
@@ -87,6 +96,16 @@ module Telnyx
               :CALL_REJECTED,
               Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
             )
+          NOT_FOUND =
+            T.let(
+              :NOT_FOUND,
+              Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
+            )
+          TEMPORARILY_UNAVAILABLE =
+            T.let(
+              :TEMPORARILY_UNAVAILABLE,
+              Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
+            )
           USER_BUSY =
             T.let(
               :USER_BUSY,

data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi

@@ -18,9 +18,11 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :call_control_id
 
-        # AI Assistant configuration. All fields except `id` are optional — the
-        # assistant's stored configuration will be used as fallback for any omitted
-        # fields.
+        # AI Assistant configuration and per-call overrides. All fields except `id` are
+        # optional. Omitted assistant fields use the stored configuration. Supplied
+        # `voice_settings` and `transcription` objects replace their stored objects rather
+        # than merging individual settings; include every setting you want to retain.
+        # `dynamic_variables` are merged, with request values taking precedence.
         sig { returns(T.nilable(Telnyx::CallAssistantRequest)) }
         attr_reader :assistant
 
@@ -163,9 +165,11 @@ module Telnyx
         end
         def self.new(
           call_control_id:,
-          # AI Assistant configuration. All fields except `id` are optional — the
-          # assistant's stored configuration will be used as fallback for any omitted
-          # fields.
+          # AI Assistant configuration and per-call overrides. All fields except `id` are
+          # optional. Omitted assistant fields use the stored configuration. Supplied
+          # `voice_settings` and `transcription` objects replace their stored objects rather
+          # than merging individual settings; include every setting you want to retain.
+          # `dynamic_variables` are merged, with request values taking precedence.
           assistant: nil,
           # Use this field to add state to every subsequent webhook. It must be a valid
           # Base-64 encoded string.