telnyx 5.119.0 → 5.121.0

data/sig/telnyx/models/calls/action_answer_params.rbs

@@ -8,6 +8,7 @@ module Telnyx
           billing_group_id: String,
           client_state: String,
           command_id: String,
+          conversation_relay_config: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig,
           custom_headers: ::Array[Telnyx::CustomSipHeader],
           deepfake_detection: Telnyx::Calls::ActionAnswerParams::DeepfakeDetection,
           preferred_codecs: Telnyx::Models::Calls::ActionAnswerParams::preferred_codecs,
@@ -62,6 +63,12 @@ module Telnyx
 
         def command_id=: (String) -> String
 
+        attr_reader conversation_relay_config: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig?
+
+        def conversation_relay_config=: (
+          Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig
+        ) -> Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig
+
         attr_reader custom_headers: ::Array[Telnyx::CustomSipHeader]?
 
         def custom_headers=: (
@@ -214,6 +221,7 @@ module Telnyx
           ?billing_group_id: String,
           ?client_state: String,
           ?command_id: String,
+          ?conversation_relay_config: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig,
           ?custom_headers: ::Array[Telnyx::CustomSipHeader],
           ?deepfake_detection: Telnyx::Calls::ActionAnswerParams::DeepfakeDetection,
           ?preferred_codecs: Telnyx::Models::Calls::ActionAnswerParams::preferred_codecs,
@@ -250,6 +258,7 @@ module Telnyx
           billing_group_id: String,
           client_state: String,
           command_id: String,
+          conversation_relay_config: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig,
           custom_headers: ::Array[Telnyx::CustomSipHeader],
           deepfake_detection: Telnyx::Calls::ActionAnswerParams::DeepfakeDetection,
           preferred_codecs: Telnyx::Models::Calls::ActionAnswerParams::preferred_codecs,
@@ -280,6 +289,437 @@ module Telnyx
           request_options: Telnyx::RequestOptions
         }
 
+        type conversation_relay_config =
+          {
+            url: String,
+            custom_parameters: ::Hash[Symbol, top],
+            dtmf_detection: bool,
+            greeting: String,
+            interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting,
+            interruption_settings: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings,
+            language: String,
+            languages: ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language],
+            provider: String,
+            structured_provider: ::Hash[Symbol, top],
+            transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine,
+            transcription_engine_config: ::Hash[Symbol, top],
+            tts_provider: String,
+            voice: String,
+            voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings
+          }
+
+        class ConversationRelayConfig < Telnyx::Internal::Type::BaseModel
+          attr_accessor url: String
+
+          attr_reader custom_parameters: ::Hash[Symbol, top]?
+
+          def custom_parameters=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader dtmf_detection: bool?
+
+          def dtmf_detection=: (bool) -> bool
+
+          attr_reader greeting: String?
+
+          def greeting=: (String) -> String
+
+          attr_reader interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible?
+
+          def interruptible=: (
+            Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible
+          ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible
+
+          attr_reader interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting?
+
+          def interruptible_greeting=: (
+            Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting
+          ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting
+
+          attr_reader interruption_settings: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings?
+
+          def interruption_settings=: (
+            Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings
+          ) -> Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings
+
+          attr_reader language: String?
+
+          def language=: (String) -> String
+
+          attr_reader languages: ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language]?
+
+          def languages=: (
+            ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language]
+          ) -> ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language]
+
+          attr_reader provider: String?
+
+          def provider=: (String) -> String
+
+          attr_reader structured_provider: ::Hash[Symbol, top]?
+
+          def structured_provider=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine?
+
+          def transcription_engine=: (
+            Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine
+          ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine
+
+          attr_reader transcription_engine_config: ::Hash[Symbol, top]?
+
+          def transcription_engine_config=: (
+            ::Hash[Symbol, top]
+          ) -> ::Hash[Symbol, top]
+
+          attr_reader tts_provider: String?
+
+          def tts_provider=: (String) -> String
+
+          attr_reader voice: String?
+
+          def voice=: (String) -> String
+
+          attr_reader voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings?
+
+          def voice_settings=: (
+            Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings
+          ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings
+
+          def initialize: (
+            url: String,
+            ?custom_parameters: ::Hash[Symbol, top],
+            ?dtmf_detection: bool,
+            ?greeting: String,
+            ?interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible,
+            ?interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting,
+            ?interruption_settings: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings,
+            ?language: String,
+            ?languages: ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language],
+            ?provider: String,
+            ?structured_provider: ::Hash[Symbol, top],
+            ?transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine,
+            ?transcription_engine_config: ::Hash[Symbol, top],
+            ?tts_provider: String,
+            ?voice: String,
+            ?voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings
+          ) -> void
+
+          def to_hash: -> {
+            url: String,
+            custom_parameters: ::Hash[Symbol, top],
+            dtmf_detection: bool,
+            greeting: String,
+            interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting,
+            interruption_settings: Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings,
+            language: String,
+            languages: ::Array[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language],
+            provider: String,
+            structured_provider: ::Hash[Symbol, top],
+            transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine,
+            transcription_engine_config: ::Hash[Symbol, top],
+            tts_provider: String,
+            voice: String,
+            voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings
+          }
+
+          type interruptible = :none | :any | :speech | :dtmf
+
+          module Interruptible
+            extend Telnyx::Internal::Type::Enum
+
+            NONE: :none
+            ANY: :any
+            SPEECH: :speech
+            DTMF: :dtmf
+
+            def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible]
+          end
+
+          type interruptible_greeting = :none | :any | :speech | :dtmf
+
+          module InterruptibleGreeting
+            extend Telnyx::Internal::Type::Enum
+
+            NONE: :none
+            ANY: :any
+            SPEECH: :speech
+            DTMF: :dtmf
+
+            def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::interruptible_greeting]
+          end
+
+          type interruption_settings =
+            {
+              enable: bool,
+              interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible,
+              interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting,
+              welcome_greeting_interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible
+            }
+
+          class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+            attr_reader enable: bool?
+
+            def enable=: (bool) -> bool
+
+            attr_reader interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible?
+
+            def interruptible=: (
+              Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible
+            ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible
+
+            attr_reader interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting?
+
+            def interruptible_greeting=: (
+              Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting
+            ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting
+
+            attr_reader welcome_greeting_interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible?
+
+            def welcome_greeting_interruptible=: (
+              Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible
+            ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible
+
+            def initialize: (
+              ?enable: bool,
+              ?interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible,
+              ?interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting,
+              ?welcome_greeting_interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible
+            ) -> void
+
+            def to_hash: -> {
+              enable: bool,
+              interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible,
+              interruptible_greeting: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting,
+              welcome_greeting_interruptible: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible
+            }
+
+            type interruptible = :none | :any | :speech | :dtmf
+
+            module Interruptible
+              extend Telnyx::Internal::Type::Enum
+
+              NONE: :none
+              ANY: :any
+              SPEECH: :speech
+              DTMF: :dtmf
+
+              def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible]
+            end
+
+            type interruptible_greeting = :none | :any | :speech | :dtmf
+
+            module InterruptibleGreeting
+              extend Telnyx::Internal::Type::Enum
+
+              NONE: :none
+              ANY: :any
+              SPEECH: :speech
+              DTMF: :dtmf
+
+              def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::interruptible_greeting]
+            end
+
+            type welcome_greeting_interruptible = :none | :any | :speech | :dtmf
+
+            module WelcomeGreetingInterruptible
+              extend Telnyx::Internal::Type::Enum
+
+              NONE: :none
+              ANY: :any
+              SPEECH: :speech
+              DTMF: :dtmf
+
+              def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::welcome_greeting_interruptible]
+            end
+          end
+
+          type language =
+            {
+              language: String,
+              speech_model: String,
+              transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine,
+              transcription_engine_config: ::Hash[Symbol, top],
+              transcription_provider: String,
+              tts_provider: String,
+              voice: String,
+              voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings
+            }
+
+          class Language < Telnyx::Internal::Type::BaseModel
+            attr_accessor language: String
+
+            attr_reader speech_model: String?
+
+            def speech_model=: (String) -> String
+
+            attr_reader transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine?
+
+            def transcription_engine=: (
+              Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine
+            ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine
+
+            attr_reader transcription_engine_config: ::Hash[Symbol, top]?
+
+            def transcription_engine_config=: (
+              ::Hash[Symbol, top]
+            ) -> ::Hash[Symbol, top]
+
+            attr_reader transcription_provider: String?
+
+            def transcription_provider=: (String) -> String
+
+            attr_reader tts_provider: String?
+
+            def tts_provider=: (String) -> String
+
+            attr_reader voice: String?
+
+            def voice=: (String) -> String
+
+            attr_reader voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings?
+
+            def voice_settings=: (
+              Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings
+            ) -> Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings
+
+            def initialize: (
+              language: String,
+              ?speech_model: String,
+              ?transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine,
+              ?transcription_engine_config: ::Hash[Symbol, top],
+              ?transcription_provider: String,
+              ?tts_provider: String,
+              ?voice: String,
+              ?voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings
+            ) -> void
+
+            def to_hash: -> {
+              language: String,
+              speech_model: String,
+              transcription_engine: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine,
+              transcription_engine_config: ::Hash[Symbol, top],
+              transcription_provider: String,
+              tts_provider: String,
+              voice: String,
+              voice_settings: Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings
+            }
+
+            type transcription_engine =
+              :Google
+              | :Telnyx
+              | :Deepgram
+              | :Azure
+              | :xAI
+              | :AssemblyAI
+              | :Speechmatics
+              | :Soniox
+              | :A
+              | :B
+
+            module TranscriptionEngine
+              extend Telnyx::Internal::Type::Enum
+
+              GOOGLE: :Google
+              TELNYX: :Telnyx
+              DEEPGRAM: :Deepgram
+              AZURE: :Azure
+              X_AI: :xAI
+              ASSEMBLY_AI: :AssemblyAI
+              SPEECHMATICS: :Speechmatics
+              SONIOX: :Soniox
+              A: :A
+              B: :B
+
+              def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::transcription_engine]
+            end
+
+            type voice_settings =
+              Telnyx::Calls::ElevenLabsVoiceSettings
+              | Telnyx::Calls::TelnyxVoiceSettings
+              | Telnyx::Calls::AwsVoiceSettings
+              | Telnyx::MinimaxVoiceSettings
+              | Telnyx::AzureVoiceSettings
+              | Telnyx::RimeVoiceSettings
+              | Telnyx::ResembleVoiceSettings
+              | Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings::Inworld
+              | Telnyx::XaiVoiceSettings
+
+            module VoiceSettings
+              extend Telnyx::Internal::Type::Union
+
+              type inworld = { type: :inworld }
+
+              class Inworld < Telnyx::Internal::Type::BaseModel
+                attr_accessor type: :inworld
+
+                def initialize: (?type: :inworld) -> void
+
+                def to_hash: -> { type: :inworld }
+              end
+
+              def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::voice_settings]
+            end
+          end
+
+          type transcription_engine =
+            :Google
+            | :Telnyx
+            | :Deepgram
+            | :Azure
+            | :xAI
+            | :AssemblyAI
+            | :Speechmatics
+            | :Soniox
+            | :A
+            | :B
+
+          module TranscriptionEngine
+            extend Telnyx::Internal::Type::Enum
+
+            GOOGLE: :Google
+            TELNYX: :Telnyx
+            DEEPGRAM: :Deepgram
+            AZURE: :Azure
+            X_AI: :xAI
+            ASSEMBLY_AI: :AssemblyAI
+            SPEECHMATICS: :Speechmatics
+            SONIOX: :Soniox
+            A: :A
+            B: :B
+
+            def self?.values: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::transcription_engine]
+          end
+
+          type voice_settings =
+            Telnyx::Calls::ElevenLabsVoiceSettings
+            | Telnyx::Calls::TelnyxVoiceSettings
+            | Telnyx::Calls::AwsVoiceSettings
+            | Telnyx::MinimaxVoiceSettings
+            | Telnyx::AzureVoiceSettings
+            | Telnyx::RimeVoiceSettings
+            | Telnyx::ResembleVoiceSettings
+            | Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings::Inworld
+            | Telnyx::XaiVoiceSettings
+
+          module VoiceSettings
+            extend Telnyx::Internal::Type::Union
+
+            type inworld = { type: :inworld }
+
+            class Inworld < Telnyx::Internal::Type::BaseModel
+              attr_accessor type: :inworld
+
+              def initialize: (?type: :inworld) -> void
+
+              def to_hash: -> { type: :inworld }
+            end
+
+            def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::voice_settings]
+          end
+        end
+
         type deepfake_detection =
           { enabled: bool, rtp_timeout: Integer, timeout: Integer }