telnyx 5.123.0 → 5.124.0

data/lib/telnyx/models/{ai_create_response_params.rb → ai_create_response_deprecated_params.rb}

@@ -2,8 +2,8 @@
 
 module Telnyx
   module Models
-    # @see Telnyx::Resources::AI#create_response
-    class AICreateResponseParams < Telnyx::Internal::Type::BaseModel
+    # @see Telnyx::Resources::AI#create_response_deprecated
+    class AICreateResponseDeprecatedParams < Telnyx::Internal::Type::BaseModel
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 

data/lib/telnyx/models/{ai_create_response_response.rb → ai_create_response_deprecated_response.rb}

@@ -3,6 +3,6 @@
 module Telnyx
   module Models
     # @type [Telnyx::Internal::Type::Converter]
-    AICreateResponseResponse = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+    AICreateResponseDeprecatedResponse = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
   end
 end

data/lib/telnyx/models/call_dial_params.rb

@@ -997,8 +997,9 @@ module Telnyx
         # @!attribute interruption_settings
         #   Settings for handling caller interruptions during Conversation Relay speech.
         #
-        #   @return [Telnyx::Models::ConversationRelayInterruptionSettings, nil]
-        optional :interruption_settings, -> { Telnyx::ConversationRelayInterruptionSettings }
+        #   @return [Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings, nil]
+        optional :interruption_settings,
+                 -> { Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings }
 
         # @!attribute language
         #   Default language for both text-to-speech and speech recognition.
@@ -1009,8 +1010,9 @@ module Telnyx
         # @!attribute languages
         #   Per-language TTS and transcription settings.
         #
-        #   @return [Array<Telnyx::Models::ConversationRelayLanguage>, nil]
-        optional :languages, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ConversationRelayLanguage] }
+        #   @return [Array<Telnyx::Models::CallDialParams::ConversationRelayConfig::Language>, nil]
+        optional :languages,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallDialParams::ConversationRelayConfig::Language] }
 
         # @!attribute provider
         #   Structured voice provider. Must be supplied together with `structured_provider`.
@@ -1086,7 +1088,7 @@ module Telnyx
         # @!attribute voice_settings
         #   The settings associated with the voice selected
         #
-        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
+        #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
         optional :voice_settings, union: -> { Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings }
 
         # @!method initialize(url:, custom_parameters: nil, dtmf_detection: nil, greeting: nil, interruptible: nil, interruptible_greeting: nil, interruption_settings: nil, language: nil, languages: nil, provider: nil, structured_provider: nil, transcription_engine: nil, transcription_engine_config: nil, tts_provider: nil, voice: nil, voice_settings: nil)
@@ -1112,11 +1114,11 @@ module Telnyx
         #
         #   @param interruptible_greeting [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
         #
-        #   @param interruption_settings [Telnyx::Models::ConversationRelayInterruptionSettings] Settings for handling caller interruptions during Conversation Relay speech.
+        #   @param interruption_settings [Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings] Settings for handling caller interruptions during Conversation Relay speech.
         #
         #   @param language [String] Default language for both text-to-speech and speech recognition.
         #
-        #   @param languages [Array<Telnyx::Models::ConversationRelayLanguage>] Per-language TTS and transcription settings.
+        #   @param languages [Array<Telnyx::Models::CallDialParams::ConversationRelayConfig::Language>] Per-language TTS and transcription settings.
         #
         #   @param provider [String] Structured voice provider. Must be supplied together with `structured_provider`.
         #
@@ -1130,7 +1132,7 @@ module Telnyx
         #
         #   @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
         #
-        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
 
         # Controls when caller input can interrupt assistant speech. `any` allows speech
         # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
@@ -1166,6 +1168,259 @@ module Telnyx
           #   @return [Array<Symbol>]
         end
 
+        # @see Telnyx::Models::CallDialParams::ConversationRelayConfig#interruption_settings
+        class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+          # @!attribute enable
+          #   Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
+          #   equivalent to `interruptible=none`.
+          #
+          #   @return [Boolean, nil]
+          optional :enable, Telnyx::Internal::Type::Boolean
+
+          # @!attribute interruptible
+          #   Controls when caller input can interrupt assistant speech. `any` allows speech
+          #   or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          #   only; `dtmf` allows DTMF only.
+          #
+          #   @return [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible, nil]
+          optional :interruptible,
+                   enum: -> { Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible }
+
+          # @!attribute interruptible_greeting
+          #   Controls when caller input can interrupt assistant speech. `any` allows speech
+          #   or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          #   only; `dtmf` allows DTMF only.
+          #
+          #   @return [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting, nil]
+          optional :interruptible_greeting,
+                   enum: -> { Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting }
+
+          # @!attribute welcome_greeting_interruptible
+          #   Controls when caller input can interrupt assistant speech. `any` allows speech
+          #   or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          #   only; `dtmf` allows DTMF only.
+          #
+          #   @return [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible, nil]
+          optional :welcome_greeting_interruptible,
+                   enum: -> { Telnyx::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible }
+
+          # @!method initialize(enable: nil, interruptible: nil, interruptible_greeting: nil, welcome_greeting_interruptible: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings}
+          #   for more details.
+          #
+          #   Settings for handling caller interruptions during Conversation Relay speech.
+          #
+          #   @param enable [Boolean] Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is equ
+          #
+          #   @param interruptible [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::Interruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
+          #
+          #   @param interruptible_greeting [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
+          #
+          #   @param welcome_greeting_interruptible [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          #
+          # @see Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings#interruptible
+          module Interruptible
+            extend Telnyx::Internal::Type::Enum
+
+            NONE = :none
+            ANY = :any
+            SPEECH = :speech
+            DTMF = :dtmf
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          #
+          # @see Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings#interruptible_greeting
+          module InterruptibleGreeting
+            extend Telnyx::Internal::Type::Enum
+
+            NONE = :none
+            ANY = :any
+            SPEECH = :speech
+            DTMF = :dtmf
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Controls when caller input can interrupt assistant speech. `any` allows speech
+          # or DTMF interruptions; `none` disables interruptions; `speech` allows speech
+          # only; `dtmf` allows DTMF only.
+          #
+          # @see Telnyx::Models::CallDialParams::ConversationRelayConfig::InterruptionSettings#welcome_greeting_interruptible
+          module WelcomeGreetingInterruptible
+            extend Telnyx::Internal::Type::Enum
+
+            NONE = :none
+            ANY = :any
+            SPEECH = :speech
+            DTMF = :dtmf
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Language < Telnyx::Internal::Type::BaseModel
+          # @!attribute language
+          #   BCP 47 language tag for this language configuration.
+          #
+          #   @return [String]
+          required :language, String
+
+          # @!attribute speech_model
+          #   Conversation Relay speech model. Prefer
+          #   `transcription_engine_config.transcription_model` when configuring
+          #   speech-to-text.
+          #
+          #   @return [String, nil]
+          optional :speech_model, String
+
+          # @!attribute transcription_engine
+          #   Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          #   `Telnyx` are supported for backward compatibility. When provided in a
+          #   Conversation Relay language entry, Telnyx derives `transcription_provider` and
+          #   `speech_model` for that language.
+          #
+          #   @return [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine, nil]
+          optional :transcription_engine,
+                   enum: -> { Telnyx::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine }
+
+          # @!attribute transcription_engine_config
+          #   Engine-specific transcription settings for Conversation Relay. This accepts the
+          #   same provider-specific options used by the Call Transcription Start command,
+          #   such as `transcription_model`, without requiring the engine discriminator to be
+          #   repeated inside this object.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute transcription_provider
+          #   Conversation Relay transcription provider name. Prefer `transcription_engine`
+          #   when configuring speech-to-text.
+          #
+          #   @return [String, nil]
+          optional :transcription_provider, String
+
+          # @!attribute tts_provider
+          #   Text-to-speech provider for this language. If omitted and `voice` is provided,
+          #   Telnyx derives the provider from the voice identifier.
+          #
+          #   @return [String, nil]
+          optional :tts_provider, String
+
+          # @!attribute voice
+          #   Voice identifier for this language.
+          #
+          #   @return [String, nil]
+          optional :voice, String
+
+          # @!attribute voice_settings
+          #   The settings associated with the voice selected
+          #
+          #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
+          optional :voice_settings,
+                   union: -> { Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings }
+
+          # @!method initialize(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallDialParams::ConversationRelayConfig::Language} for more
+          #   details.
+          #
+          #   Language-specific TTS and transcription settings for Conversation Relay.
+          #
+          #   @param language [String] BCP 47 language tag for this language configuration.
+          #
+          #   @param speech_model [String] Conversation Relay speech model. Prefer `transcription_engine_config.transcripti
+          #
+          #   @param transcription_engine [Symbol, Telnyx::Models::CallDialParams::ConversationRelayConfig::Language::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
+          #
+          #   @param transcription_engine_config [Hash{Symbol=>Object}] Engine-specific transcription settings for Conversation Relay. This accepts the
+          #
+          #   @param transcription_provider [String] Conversation Relay transcription provider name. Prefer `transcription_engine` wh
+          #
+          #   @param tts_provider [String] Text-to-speech provider for this language. If omitted and `voice` is provided, T
+          #
+          #   @param voice [String] Voice identifier for this language.
+          #
+          #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+
+          # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+          # `Telnyx` are supported for backward compatibility. When provided in a
+          # Conversation Relay language entry, Telnyx derives `transcription_provider` and
+          # `speech_model` for that language.
+          #
+          # @see Telnyx::Models::CallDialParams::ConversationRelayConfig::Language#transcription_engine
+          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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The settings associated with the voice selected
+          #
+          # @see Telnyx::Models::CallDialParams::ConversationRelayConfig::Language#voice_settings
+          module VoiceSettings
+            extend Telnyx::Internal::Type::Union
+
+            discriminator :type
+
+            variant :elevenlabs, -> { Telnyx::Calls::ElevenLabsVoiceSettings }
+
+            variant :telnyx, -> { Telnyx::Calls::TelnyxVoiceSettings }
+
+            variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
+
+            variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
+
+            variant :azure, -> { Telnyx::AzureVoiceSettings }
+
+            variant :rime, -> { Telnyx::RimeVoiceSettings }
+
+            variant :resemble, -> { Telnyx::ResembleVoiceSettings }
+
+            variant :inworld, -> { Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld }
+
+            variant :xai, -> { Telnyx::XaiVoiceSettings }
+
+            class Inworld < Telnyx::Internal::Type::BaseModel
+              # @!attribute type
+              #   Voice settings provider type
+              #
+              #   @return [Symbol, :inworld]
+              required :type, const: :inworld
+
+              # @!method initialize(type: :inworld)
+              #   @param type [Symbol, :inworld] Voice settings provider type
+            end
+
+            # @!method self.variants
+            #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
+          end
+        end
+
         # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
         # `Telnyx` are supported for backward compatibility. For Conversation Relay, use
         # this field with `transcription_engine_config`; the `transcription` object is not
@@ -1212,12 +1467,23 @@ module Telnyx
 
           variant :resemble, -> { Telnyx::ResembleVoiceSettings }
 
-          variant :inworld, -> { Telnyx::InworldVoiceSettings }
+          variant :inworld, -> { Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld }
 
           variant :xai, -> { Telnyx::XaiVoiceSettings }
 
+          class Inworld < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #   Voice settings provider type
+            #
+            #   @return [Symbol, :inworld]
+            required :type, const: :inworld
+
+            # @!method initialize(type: :inworld)
+            #   @param type [Symbol, :inworld] Voice settings provider type
+          end
+
           # @!method self.variants
-          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
+          #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
         end
       end