telnyx 5.111.0 → 5.113.0

data/sig/telnyx/models/ai/openai_create_response_params.rbs

@@ -4,7 +4,7 @@ module Telnyx
       type openai_create_response_params =
         {
           conversation: String,
-          input: top,
+          input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
           stream: bool
@@ -19,9 +19,9 @@ module Telnyx
 
         def conversation=: (String) -> String
 
-        attr_reader input: top?
+        attr_reader input: ::Hash[Symbol, top]?
 
-        def input=: (top) -> top
+        def input=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
         attr_reader instructions: String?
 
@@ -37,7 +37,7 @@ module Telnyx
 
         def initialize: (
           ?conversation: String,
-          ?input: top,
+          ?input: ::Hash[Symbol, top],
           ?instructions: String,
           ?model: String,
           ?stream: bool,
@@ -46,7 +46,7 @@ module Telnyx
 
         def to_hash: -> {
           conversation: String,
-          input: top,
+          input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
           stream: bool,

data/sig/telnyx/models/ai_create_response_params.rbs

@@ -1,21 +1,22 @@
 module Telnyx
   module Models
     type ai_create_response_params =
-      { body: ::Hash[Symbol, top] } & Telnyx::Internal::Type::request_parameters
+      { params: ::Hash[Symbol, top] }
+      & Telnyx::Internal::Type::request_parameters
 
     class AICreateResponseParams < Telnyx::Internal::Type::BaseModel
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      attr_accessor body: ::Hash[Symbol, top]
+      attr_accessor params: ::Hash[Symbol, top]
 
       def initialize: (
-        body: ::Hash[Symbol, top],
+        params: ::Hash[Symbol, top],
         ?request_options: Telnyx::request_opts
       ) -> void
 
       def to_hash: -> {
-        body: ::Hash[Symbol, top],
+        params: ::Hash[Symbol, top],
         request_options: Telnyx::RequestOptions
       }
     end

data/sig/telnyx/models/call_conversation_ended.rbs

@@ -82,6 +82,7 @@ module Telnyx
           duration_sec: Integer,
           from: String,
           llm_model: String,
+          reason: String?,
           stt_model: String,
           to: String,
           tts_model_id: String,
@@ -136,6 +137,8 @@ module Telnyx
 
         def llm_model=: (String) -> String
 
+        attr_accessor reason: String?
+
         attr_reader stt_model: String?
 
         def stt_model=: (String) -> String
@@ -168,6 +171,7 @@ module Telnyx
           ?duration_sec: Integer,
           ?from: String,
           ?llm_model: String,
+          ?reason: String?,
           ?stt_model: String,
           ?to: String,
           ?tts_model_id: String,
@@ -187,6 +191,7 @@ module Telnyx
           duration_sec: Integer,
           from: String,
           llm_model: String,
+          reason: String?,
           stt_model: String,
           to: String,
           tts_model_id: String,

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

@@ -0,0 +1,455 @@
+module Telnyx
+  module Models
+    module Calls
+      type action_start_conversation_relay_params =
+        {
+          call_control_id: String,
+          assistant: Telnyx::Calls::ActionStartConversationRelayParams::Assistant,
+          client_state: String,
+          command_id: String,
+          conversation_relay_dtmf_detection: bool,
+          conversation_relay_settings: Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings,
+          conversation_relay_url: String,
+          greeting: String,
+          interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
+          language: String,
+          languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
+          transcription: Telnyx::Calls::ActionStartConversationRelayParams::Transcription,
+          transcription_language: String,
+          tts_language: String,
+          voice: String,
+          voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ActionStartConversationRelayParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor call_control_id: String
+
+        attr_reader assistant: Telnyx::Calls::ActionStartConversationRelayParams::Assistant?
+
+        def assistant=: (
+          Telnyx::Calls::ActionStartConversationRelayParams::Assistant
+        ) -> Telnyx::Calls::ActionStartConversationRelayParams::Assistant
+
+        attr_reader client_state: String?
+
+        def client_state=: (String) -> String
+
+        attr_reader command_id: String?
+
+        def command_id=: (String) -> String
+
+        attr_reader conversation_relay_dtmf_detection: bool?
+
+        def conversation_relay_dtmf_detection=: (bool) -> bool
+
+        attr_reader conversation_relay_settings: Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings?
+
+        def conversation_relay_settings=: (
+          Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings
+        ) -> Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings
+
+        attr_reader conversation_relay_url: String?
+
+        def conversation_relay_url=: (String) -> String
+
+        attr_reader greeting: String?
+
+        def greeting=: (String) -> String
+
+        attr_reader interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings?
+
+        def interruption_settings=: (
+          Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings
+        ) -> Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings
+
+        attr_reader language: String?
+
+        def language=: (String) -> String
+
+        attr_reader languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]?
+
+        def languages=: (
+          ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]
+        ) -> ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]
+
+        attr_reader transcription: Telnyx::Calls::ActionStartConversationRelayParams::Transcription?
+
+        def transcription=: (
+          Telnyx::Calls::ActionStartConversationRelayParams::Transcription
+        ) -> Telnyx::Calls::ActionStartConversationRelayParams::Transcription
+
+        attr_reader transcription_language: String?
+
+        def transcription_language=: (String) -> String
+
+        attr_reader tts_language: String?
+
+        def tts_language=: (String) -> String
+
+        attr_reader voice: String?
+
+        def voice=: (String) -> String
+
+        attr_reader voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings?
+
+        def voice_settings=: (
+          Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings
+        ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings
+
+        def initialize: (
+          call_control_id: String,
+          ?assistant: Telnyx::Calls::ActionStartConversationRelayParams::Assistant,
+          ?client_state: String,
+          ?command_id: String,
+          ?conversation_relay_dtmf_detection: bool,
+          ?conversation_relay_settings: Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings,
+          ?conversation_relay_url: String,
+          ?greeting: String,
+          ?interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
+          ?language: String,
+          ?languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
+          ?transcription: Telnyx::Calls::ActionStartConversationRelayParams::Transcription,
+          ?transcription_language: String,
+          ?tts_language: String,
+          ?voice: String,
+          ?voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          call_control_id: String,
+          assistant: Telnyx::Calls::ActionStartConversationRelayParams::Assistant,
+          client_state: String,
+          command_id: String,
+          conversation_relay_dtmf_detection: bool,
+          conversation_relay_settings: Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings,
+          conversation_relay_url: String,
+          greeting: String,
+          interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
+          language: String,
+          languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
+          transcription: Telnyx::Calls::ActionStartConversationRelayParams::Transcription,
+          transcription_language: String,
+          tts_language: String,
+          voice: String,
+          voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings,
+          request_options: Telnyx::RequestOptions
+        }
+
+        type assistant = { dynamic_variables: ::Hash[Symbol, String] }
+
+        class Assistant < Telnyx::Internal::Type::BaseModel
+          attr_reader dynamic_variables: ::Hash[Symbol, String]?
+
+          def dynamic_variables=: (
+            ::Hash[Symbol, String]
+          ) -> ::Hash[Symbol, String]
+
+          def initialize: (?dynamic_variables: ::Hash[Symbol, String]) -> void
+
+          def to_hash: -> { dynamic_variables: ::Hash[Symbol, String] }
+        end
+
+        type conversation_relay_settings =
+          {
+            url: String,
+            dtmf_detection: bool,
+            interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
+            languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
+          }
+
+        class ConversationRelaySettings < Telnyx::Internal::Type::BaseModel
+          attr_accessor url: String
+
+          attr_reader dtmf_detection: bool?
+
+          def dtmf_detection=: (bool) -> bool
+
+          attr_reader interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible?
+
+          def interruptible=: (
+            Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible
+          ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible
+
+          attr_reader interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting?
+
+          def interruptible_greeting=: (
+            Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting
+          ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting
+
+          attr_reader languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]?
+
+          def languages=: (
+            ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
+          ) -> ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
+
+          def initialize: (
+            url: String,
+            ?dtmf_detection: bool,
+            ?interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
+            ?interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
+            ?languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
+          ) -> void
+
+          def to_hash: -> {
+            url: String,
+            dtmf_detection: bool,
+            interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
+            languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
+          }
+
+          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::ActionStartConversationRelayParams::ConversationRelaySettings::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::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting]
+          end
+
+          type language =
+            {
+              code: String,
+              speech_model: String,
+              transcription_provider: String,
+              tts_provider: String,
+              voice: String
+            }
+
+          class Language < Telnyx::Internal::Type::BaseModel
+            attr_reader code: String?
+
+            def code=: (String) -> String
+
+            attr_reader speech_model: String?
+
+            def speech_model=: (String) -> String
+
+            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
+
+            def initialize: (
+              ?code: String,
+              ?speech_model: String,
+              ?transcription_provider: String,
+              ?tts_provider: String,
+              ?voice: String
+            ) -> void
+
+            def to_hash: -> {
+              code: String,
+              speech_model: String,
+              transcription_provider: String,
+              tts_provider: String,
+              voice: String
+            }
+          end
+        end
+
+        type interruption_settings =
+          {
+            enable: bool,
+            interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
+            welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
+          }
+
+        class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+          attr_reader enable: bool?
+
+          def enable=: (bool) -> bool
+
+          attr_reader interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible?
+
+          def interruptible=: (
+            Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible
+          ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible
+
+          attr_reader interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting?
+
+          def interruptible_greeting=: (
+            Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting
+          ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting
+
+          attr_reader welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible?
+
+          def welcome_greeting_interruptible=: (
+            Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
+          ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
+
+          def initialize: (
+            ?enable: bool,
+            ?interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
+            ?interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
+            ?welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
+          ) -> void
+
+          def to_hash: -> {
+            enable: bool,
+            interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
+            interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
+            welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::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::ActionStartConversationRelayParams::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::ActionStartConversationRelayParams::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::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible]
+          end
+        end
+
+        type language =
+          {
+            code: String,
+            speech_model: String,
+            transcription_provider: String,
+            tts_provider: String,
+            voice: String
+          }
+
+        class Language < Telnyx::Internal::Type::BaseModel
+          attr_reader code: String?
+
+          def code=: (String) -> String
+
+          attr_reader speech_model: String?
+
+          def speech_model=: (String) -> String
+
+          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
+
+          def initialize: (
+            ?code: String,
+            ?speech_model: String,
+            ?transcription_provider: String,
+            ?tts_provider: String,
+            ?voice: String
+          ) -> void
+
+          def to_hash: -> {
+            code: String,
+            speech_model: String,
+            transcription_provider: String,
+            tts_provider: String,
+            voice: String
+          }
+        end
+
+        type transcription =
+          { language: String, model: String, provider: String }
+
+        class Transcription < Telnyx::Internal::Type::BaseModel
+          attr_reader language: String?
+
+          def language=: (String) -> String
+
+          attr_reader model: String?
+
+          def model=: (String) -> String
+
+          attr_reader provider: String?
+
+          def provider=: (String) -> String
+
+          def initialize: (
+            ?language: String,
+            ?model: String,
+            ?provider: String
+          ) -> void
+
+          def to_hash: -> { language: String, model: String, provider: String }
+        end
+
+        type voice_settings =
+          Telnyx::Calls::ElevenLabsVoiceSettings
+          | Telnyx::Calls::TelnyxVoiceSettings
+          | Telnyx::Calls::AwsVoiceSettings
+          | Telnyx::AzureVoiceSettings
+          | Telnyx::RimeVoiceSettings
+          | Telnyx::ResembleVoiceSettings
+          | Telnyx::XaiVoiceSettings
+
+        module VoiceSettings
+          extend Telnyx::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Telnyx
+  module Models
+    module Calls
+      type action_start_conversation_relay_response =
+        {
+          data: Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+        }
+
+      class ActionStartConversationRelayResponse < Telnyx::Internal::Type::BaseModel
+        attr_reader data: Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data?
+
+        def data=: (
+          Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+        ) -> Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+
+        def initialize: (
+          ?data: Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+        ) -> void
+
+        def to_hash: -> {
+          data: Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+        }
+
+        type data = { conversation_relay_id: String, result: String }
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          attr_reader conversation_relay_id: String?
+
+          def conversation_relay_id=: (String) -> String
+
+          attr_reader result: String?
+
+          def result=: (String) -> String
+
+          def initialize: (
+            ?conversation_relay_id: String,
+            ?result: String
+          ) -> void
+
+          def to_hash: -> { conversation_relay_id: String, result: String }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Telnyx
+  module Models
+    module Calls
+      type action_stop_conversation_relay_params =
+        { call_control_id: String, client_state: String, command_id: String }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ActionStopConversationRelayParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor call_control_id: String
+
+        attr_reader client_state: String?
+
+        def client_state=: (String) -> String
+
+        attr_reader command_id: String?
+
+        def command_id=: (String) -> String
+
+        def initialize: (
+          call_control_id: String,
+          ?client_state: String,
+          ?command_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          call_control_id: String,
+          client_state: String,
+          command_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    module Calls
+      type action_stop_conversation_relay_response =
+        { data: Telnyx::Calls::CallControlCommandResult }
+
+      class ActionStopConversationRelayResponse < Telnyx::Internal::Type::BaseModel
+        attr_reader data: Telnyx::Calls::CallControlCommandResult?
+
+        def data=: (
+          Telnyx::Calls::CallControlCommandResult
+        ) -> Telnyx::Calls::CallControlCommandResult
+
+        def initialize: (?data: Telnyx::Calls::CallControlCommandResult) -> void
+
+        def to_hash: -> { data: Telnyx::Calls::CallControlCommandResult }
+      end
+    end
+  end
+end