telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/models/ai/assistant_tool.rbi

@@ -24,6 +24,7 @@ module Telnyx
               Telnyx::AI::AssistantTool::SendDtmf,
               Telnyx::AI::AssistantTool::SendMessage,
               Telnyx::AI::AssistantTool::SkipTurn,
+              Telnyx::AI::AssistantTool::Vision,
               Telnyx::AI::AssistantTool::Pay,
               Telnyx::AI::AssistantTool::UpdateDynamicVariables
             )
@@ -719,6 +720,27 @@ module Telnyx
             end
             attr_accessor :targets
 
+            # Plays a short beep once the transfer completes and the calls are bridged, so the
+            # transfer destination knows the caller is now on the line. The warm transfer
+            # message plays before the bridge; this marks the moment the caller actually
+            # joins. Works with and without `warm_transfer_acceptance`.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep
+                )
+              )
+            end
+            attr_reader :bridge_beep
+
+            sig do
+              params(
+                bridge_beep:
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::OrHash
+              ).void
+            end
+            attr_writer :bridge_beep
+
             # Custom headers to be added to the SIP INVITE for the transfer command.
             sig do
               returns(
@@ -832,6 +854,8 @@ module Telnyx
                 from: String,
                 targets:
                   Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::Variants,
+                bridge_beep:
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::OrHash,
                 custom_headers:
                   T::Array[
                     Telnyx::AI::AssistantTool::Transfer::Transfer::CustomHeader::OrHash
@@ -854,6 +878,11 @@ module Telnyx
               # variable string like `{{ targets }}` where `targets` is returned by the dynamic
               # variables webhook and resolves to an array of target objects at runtime.
               targets:,
+              # Plays a short beep once the transfer completes and the calls are bridged, so the
+              # transfer destination knows the caller is now on the line. The warm transfer
+              # message plays before the bridge; this marks the moment the caller actually
+              # joins. Works with and without `warm_transfer_acceptance`.
+              bridge_beep: nil,
               # Custom headers to be added to the SIP INVITE for the transfer command.
               custom_headers: nil,
               # A description of the transfer tool. By default, Telnyx generates this
@@ -902,6 +931,8 @@ module Telnyx
                   from: String,
                   targets:
                     Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::Variants,
+                  bridge_beep:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep,
                   custom_headers:
                     T::Array[
                       Telnyx::AI::AssistantTool::Transfer::Transfer::CustomHeader
@@ -1062,6 +1093,110 @@ module Telnyx
                 )
             end
 
+            class BridgeBeep < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Whether to play the beep when the calls are bridged.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :enabled
+
+              sig { params(enabled: T::Boolean).void }
+              attr_writer :enabled
+
+              # Who hears the beep. `self` plays it to the transfer destination only; `both`
+              # plays it to the destination and the original caller.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::OrSymbol
+                  )
+                )
+              end
+              attr_reader :target_legs
+
+              sig do
+                params(
+                  target_legs:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::OrSymbol
+                ).void
+              end
+              attr_writer :target_legs
+
+              # Plays a short beep once the transfer completes and the calls are bridged, so the
+              # transfer destination knows the caller is now on the line. The warm transfer
+              # message plays before the bridge; this marks the moment the caller actually
+              # joins. Works with and without `warm_transfer_acceptance`.
+              sig do
+                params(
+                  enabled: T::Boolean,
+                  target_legs:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Whether to play the beep when the calls are bridged.
+                enabled: nil,
+                # Who hears the beep. `self` plays it to the transfer destination only; `both`
+                # plays it to the destination and the original caller.
+                target_legs: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    enabled: T::Boolean,
+                    target_legs:
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::OrSymbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Who hears the beep. `self` plays it to the transfer destination only; `both`
+              # plays it to the destination and the original caller.
+              module TargetLegs
+                extend Telnyx::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                SELF =
+                  T.let(
+                    :self,
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::TaggedSymbol
+                  )
+                BOTH =
+                  T.let(
+                    :both,
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::BridgeBeep::TargetLegs::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
             class CustomHeader < Telnyx::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do
@@ -1659,6 +1794,36 @@ module Telnyx
               end
               attr_writer :end_user_target_context_mode
 
+              # Fail closed when the acceptance consult cannot run. Off by default: if the
+              # consult cannot be set up for any reason — including where acceptance is
+              # unavailable at all (`gather_using_ai`, Conversation Relay or web calls, a
+              # conference, or additional invited participants) — the transfer degrades to a
+              # plain warm transfer (the warm transfer message is played to the destination as
+              # audio and the calls are bridged anyway). Set to true to treat those paths as a
+              # decline instead: the destination is disconnected without being asked, the
+              # assistant returns to the caller, and no bridge happens without an acceptance.
+              # Only consult-setup failures are affected; the destination must still explicitly
+              # accept on every consult that does run.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :require_acceptance
+
+              sig { params(require_acceptance: T::Boolean).void }
+              attr_writer :require_acceptance
+
+              # How long, in seconds, the destination has to accept the transfer, counted from
+              # when the private consult starts (right after the destination answers, or after
+              # `warm_message_delay_ms`). The caller keeps hearing ringback the whole time. If
+              # no acceptance arrives in time, the destination is hung up and the assistant
+              # returns to the caller (the transfer fails as a timeout). Raise it for
+              # destinations that answer before a human is on the line, such as a call-center
+              # queue/ACD or an IVR playing hold audio; keep it as short as practical, since the
+              # caller waits on ringback until it expires.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :timeout_secs
+
+              sig { params(timeout_secs: Integer).void }
+              attr_writer :timeout_secs
+
               # Requires the transfer destination to accept the call before the caller is
               # bridged. When enabled, the assistant speaks privately with the destination after
               # they answer — delivering the warm transfer message and asking whether they take
@@ -1674,7 +1839,9 @@ module Telnyx
                 params(
                   enabled: T::Boolean,
                   end_user_target_context_mode:
-                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol,
+                  require_acceptance: T::Boolean,
+                  timeout_secs: Integer
                 ).returns(T.attached_class)
               end
               def self.new(
@@ -1685,7 +1852,27 @@ module Telnyx
                 # exchange never reaches the conversation history, AI conversations, webhooks or
                 # insights, and the transfer tool result is rewritten with the outcome only. With
                 # `shared` the exchange stays in the conversation like any other messages.
-                end_user_target_context_mode: nil
+                end_user_target_context_mode: nil,
+                # Fail closed when the acceptance consult cannot run. Off by default: if the
+                # consult cannot be set up for any reason — including where acceptance is
+                # unavailable at all (`gather_using_ai`, Conversation Relay or web calls, a
+                # conference, or additional invited participants) — the transfer degrades to a
+                # plain warm transfer (the warm transfer message is played to the destination as
+                # audio and the calls are bridged anyway). Set to true to treat those paths as a
+                # decline instead: the destination is disconnected without being asked, the
+                # assistant returns to the caller, and no bridge happens without an acceptance.
+                # Only consult-setup failures are affected; the destination must still explicitly
+                # accept on every consult that does run.
+                require_acceptance: nil,
+                # How long, in seconds, the destination has to accept the transfer, counted from
+                # when the private consult starts (right after the destination answers, or after
+                # `warm_message_delay_ms`). The caller keeps hearing ringback the whole time. If
+                # no acceptance arrives in time, the destination is hung up and the assistant
+                # returns to the caller (the transfer fails as a timeout). Raise it for
+                # destinations that answer before a human is on the line, such as a call-center
+                # queue/ACD or an IVR playing hold audio; keep it as short as practical, since the
+                # caller waits on ringback until it expires.
+                timeout_secs: nil
               )
               end
 
@@ -1694,7 +1881,9 @@ module Telnyx
                   {
                     enabled: T::Boolean,
                     end_user_target_context_mode:
-                      Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol,
+                    require_acceptance: T::Boolean,
+                    timeout_secs: Integer
                   }
                 )
               end
@@ -2898,6 +3087,76 @@ module Telnyx
           end
         end
 
+        class Vision < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::AssistantTool::Vision,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          sig { returns(T.nilable(Telnyx::AI::VisionToolParams)) }
+          attr_reader :vision
+
+          sig { params(vision: Telnyx::AI::VisionToolParams::OrHash).void }
+          attr_writer :vision
+
+          # Whether this tool comes from the shared Tools Library. Responses merge shared
+          # tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+          # Read-only: set by the server, not accepted in requests. When updating an
+          # assistant, omit `shared: true` tools from the request `tools` array and manage
+          # them through `tool_ids` instead — re-sending their definitions creates an inline
+          # duplicate (rejected with error code 10015 when the type allows only one instance
+          # per assistant).
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :shared
+
+          sig { params(shared: T::Boolean).void }
+          attr_writer :shared
+
+          # (BETA) Lets the assistant look at recent image frames the client sent into the
+          # conversation (for example webcam or screen-share frames). Frames are sent with
+          # `conversation.item.create` and `item.buffer: true`; they never trigger a
+          # response on their own. The assistant decides when to look and which frames it
+          # needs. Requires a model that supports image input.
+          sig do
+            params(
+              shared: T::Boolean,
+              vision: Telnyx::AI::VisionToolParams::OrHash,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether this tool comes from the shared Tools Library. Responses merge shared
+            # tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+            # Read-only: set by the server, not accepted in requests. When updating an
+            # assistant, omit `shared: true` tools from the request `tools` array and manage
+            # them through `tool_ids` instead — re-sending their definitions creates an inline
+            # duplicate (rejected with error code 10015 when the type allows only one instance
+            # per assistant).
+            shared: nil,
+            vision: nil,
+            type: :vision
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                type: Symbol,
+                shared: T::Boolean,
+                vision: Telnyx::AI::VisionToolParams
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class Pay < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/telnyx/models/ai/assistant_update_params.rbi

@@ -34,6 +34,21 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+        # avatar or an organization-owned custom avatar returned by the Avatars API.
+        # Discover the available stock catalog with GET /v2/ai/avatars and
+        # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+        sig { returns(T.nilable(Telnyx::AI::AvatarSettingsRequest)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as supplied by API clients (create / update).
         #
         # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
@@ -49,6 +64,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -320,6 +352,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage,
                   Telnyx::AI::AssistantTool::SkipTurn,
+                  Telnyx::AI::AssistantTool::Vision,
                   Telnyx::AI::AssistantTool::Pay,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables
                 )
@@ -346,6 +379,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
@@ -379,6 +413,19 @@ module Telnyx
         end
         attr_writer :voice_settings
 
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -390,7 +437,10 @@ module Telnyx
           params(
             assistant_id: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -432,6 +482,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
@@ -439,6 +490,7 @@ module Telnyx
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             version_name: String,
             voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -455,12 +507,25 @@ module Telnyx
           # capability for the conversation; it does not fail the call. Omit this field to
           # leave the assistant's agents unchanged; send an empty array to remove them all.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+          # avatar or an organization-owned custom avatar returned by the Avatars API.
+          # Discover the available stock catalog with GET /v2/ai/avatars and
+          # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+          avatar_settings: nil,
           # Conversation flow as supplied by API clients (create / update).
           #
           # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
           # unique node/edge IDs, that `start_node_id` references a real node, and that
           # every edge's endpoints reference real nodes.
           conversation_flow: nil,
+          # Splits the conversation between a frontend model that talks to the caller and a
+          # backend model that does the work. On the GPT-Live route the frontend model
+          # cannot call tools at all — when it needs something done it raises a delegation
+          # and waits. On the chat completion route the frontend keeps a single `delegate`
+          # tool that returns immediately, so the conversation carries on while the backend
+          # works. Either way the backend's answer is spoken as commentary or kept as silent
+          # context, depending on `speak_results`. Beta feature.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their default values
           dynamic_variables: nil,
@@ -560,6 +625,12 @@ module Telnyx
           # Human-readable name for the assistant version.
           version_name: nil,
           voice_settings: nil,
+          # Streams conversation and telephony events to a WebSocket server you host, and
+          # accepts messages injected back into the conversation. Telnyx opens the
+          # connection as a client, once per conversation. Delivery is best effort
+          # throughout: while the connection is down events are dropped rather than queued,
+          # and no socket failure is ever allowed to affect the call. Beta feature.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil,
           request_options: {}
@@ -571,7 +642,9 @@ module Telnyx
             {
               assistant_id: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::AvatarSettingsRequest),
               conversation_flow: Telnyx::AI::ConversationFlowReq,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -613,6 +686,7 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
                     Telnyx::AI::AssistantTool::SkipTurn,
+                    Telnyx::AI::AssistantTool::Vision,
                     Telnyx::AI::AssistantTool::Pay,
                     Telnyx::AI::AssistantTool::UpdateDynamicVariables
                   )
@@ -620,6 +694,7 @@ module Telnyx
               transcription: Telnyx::AI::TranscriptionSettings,
               version_name: String,
               voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings,
               request_options: Telnyx::RequestOptions
             }

data/rbi/telnyx/models/ai/assistant_whatsapp_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantWhatsappParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::AssistantWhatsappParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
+        # Instruction for the assistant, including the values for the template variables,
+        # e.g. `Send the login verification code 482913 to the customer.`
+        sig { returns(String) }
+        attr_accessor :content
+
+        # WhatsApp number on your account to send from, in E.164 format. Its messaging
+        # profile must have this assistant configured.
+        sig { returns(String) }
+        attr_accessor :from
+
+        # Customer to message, as an E.164 phone number or a WhatsApp business-scoped user
+        # ID (BSUID).
+        sig { returns(String) }
+        attr_accessor :to
+
+        # Metadata stored on the conversation. Keys starting with `telnyx_` and the
+        # `assistant_id` key are reserved.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+            )
+          )
+        end
+        attr_reader :conversation_metadata
+
+        sig do
+          params(
+            conversation_metadata:
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+          ).void
+        end
+        attr_writer :conversation_metadata
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig do
+          params(
+            assistant_id: String,
+            content: String,
+            from: String,
+            to: String,
+            conversation_metadata:
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ],
+            idempotency_key: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          assistant_id:,
+          # Instruction for the assistant, including the values for the template variables,
+          # e.g. `Send the login verification code 482913 to the customer.`
+          content:,
+          # WhatsApp number on your account to send from, in E.164 format. Its messaging
+          # profile must have this assistant configured.
+          from:,
+          # Customer to message, as an E.164 phone number or a WhatsApp business-scoped user
+          # ID (BSUID).
+          to:,
+          # Metadata stored on the conversation. Keys starting with `telnyx_` and the
+          # `assistant_id` key are reserved.
+          conversation_metadata: nil,
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              assistant_id: String,
+              content: String,
+              from: String,
+              to: String,
+              conversation_metadata:
+                T::Hash[
+                  Symbol,
+                  Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+                ],
+              idempotency_key: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ConversationMetadata
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Integer, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistant_whatsapp_response.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantWhatsappResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::AssistantWhatsappResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # ID of the conversation created for this WhatsApp chat.
+        sig { returns(String) }
+        attr_accessor :conversation_id
+
+        # ID of the WhatsApp template message that was sent.
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        sig do
+          params(conversation_id: String, message_id: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # ID of the conversation created for this WhatsApp chat.
+          conversation_id:,
+          # ID of the WhatsApp template message that was sent.
+          message_id:
+        )
+        end
+
+        sig do
+          override.returns({ conversation_id: String, message_id: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end