telnyx 5.170.0 → 5.171.0

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

@@ -4,6 +4,8 @@ module Telnyx
       type transcription_settings =
         {
           api_key_ref: String,
+          challenger: Telnyx::AI::TranscriptionSettings::Challenger?,
+          fallback_models: ::Array[Telnyx::AI::TranscriptionSettings::FallbackModel]?,
           language: String,
           model: Telnyx::Models::AI::TranscriptionSettings::model,
           region: String,
@@ -15,6 +17,10 @@ module Telnyx
 
         def api_key_ref=: (String) -> String
 
+        attr_accessor challenger: Telnyx::AI::TranscriptionSettings::Challenger?
+
+        attr_accessor fallback_models: ::Array[Telnyx::AI::TranscriptionSettings::FallbackModel]?
+
         attr_reader language: String?
 
         def language=: (String) -> String
@@ -37,6 +43,8 @@ module Telnyx
 
         def initialize: (
           ?api_key_ref: String,
+          ?challenger: Telnyx::AI::TranscriptionSettings::Challenger?,
+          ?fallback_models: ::Array[Telnyx::AI::TranscriptionSettings::FallbackModel]?,
           ?language: String,
           ?model: Telnyx::Models::AI::TranscriptionSettings::model,
           ?region: String,
@@ -45,12 +53,161 @@ module Telnyx
 
         def to_hash: -> {
           api_key_ref: String,
+          challenger: Telnyx::AI::TranscriptionSettings::Challenger?,
+          fallback_models: ::Array[Telnyx::AI::TranscriptionSettings::FallbackModel]?,
           language: String,
           model: Telnyx::Models::AI::TranscriptionSettings::model,
           region: String,
           settings: Telnyx::AI::TranscriptionSettingsConfig
         }
 
+        type challenger =
+          {
+            model: Telnyx::Models::AI::TranscriptionSettings::Challenger::model,
+            language: String?,
+            rule: Telnyx::Models::AI::TranscriptionSettings::Challenger::rule,
+            settings: Telnyx::AI::TranscriptionSettingsConfig?
+          }
+
+        class Challenger < Telnyx::Internal::Type::BaseModel
+          attr_accessor model: Telnyx::Models::AI::TranscriptionSettings::Challenger::model
+
+          attr_accessor language: String?
+
+          attr_reader rule: Telnyx::Models::AI::TranscriptionSettings::Challenger::rule?
+
+          def rule=: (
+            Telnyx::Models::AI::TranscriptionSettings::Challenger::rule
+          ) -> Telnyx::Models::AI::TranscriptionSettings::Challenger::rule
+
+          attr_accessor settings: Telnyx::AI::TranscriptionSettingsConfig?
+
+          def initialize: (
+            model: Telnyx::Models::AI::TranscriptionSettings::Challenger::model,
+            ?language: String?,
+            ?rule: Telnyx::Models::AI::TranscriptionSettings::Challenger::rule,
+            ?settings: Telnyx::AI::TranscriptionSettingsConfig?
+          ) -> void
+
+          def to_hash: -> {
+            model: Telnyx::Models::AI::TranscriptionSettings::Challenger::model,
+            language: String?,
+            rule: Telnyx::Models::AI::TranscriptionSettings::Challenger::rule,
+            settings: Telnyx::AI::TranscriptionSettingsConfig?
+          }
+
+          type model =
+            :"deepgram/flux"
+            | :"deepgram/nova-3"
+            | :"deepgram/nova-2"
+            | :"azure/fast"
+            | :"assemblyai/universal-3-5-pro"
+            | :"assemblyai/universal-streaming"
+            | :"xai/grok-stt"
+            | :"soniox/stt-rt-v4"
+            | :"soniox/stt-rt-v5"
+            | :"nvidia/parakeet-v3"
+            | :"omi-health/omi-med-stt-v1"
+            | :"humain/realtime"
+            | :"reson8/turns"
+            | :"cohere/ar-stt"
+            | :"telnyx/basira"
+            | :"distil-whisper/distil-large-v2"
+            | :"openai/whisper-large-v3-turbo"
+
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            DEEPGRAM_FLUX: :"deepgram/flux"
+            DEEPGRAM_NOVA_3: :"deepgram/nova-3"
+            DEEPGRAM_NOVA_2: :"deepgram/nova-2"
+            AZURE_FAST: :"azure/fast"
+            ASSEMBLYAI_UNIVERSAL_3_5_PRO: :"assemblyai/universal-3-5-pro"
+            ASSEMBLYAI_UNIVERSAL_STREAMING: :"assemblyai/universal-streaming"
+            XAI_GROK_STT: :"xai/grok-stt"
+            SONIOX_STT_RT_V4: :"soniox/stt-rt-v4"
+            SONIOX_STT_RT_V5: :"soniox/stt-rt-v5"
+            NVIDIA_PARAKEET_V3: :"nvidia/parakeet-v3"
+            OMI_HEALTH_OMI_MED_STT_V1: :"omi-health/omi-med-stt-v1"
+            HUMAIN_REALTIME: :"humain/realtime"
+            RESON8_TURNS: :"reson8/turns"
+            COHERE_AR_STT: :"cohere/ar-stt"
+            TELNYX_BASIRA: :"telnyx/basira"
+            DISTIL_WHISPER_DISTIL_LARGE_V2: :"distil-whisper/distil-large-v2"
+            OPENAI_WHISPER_LARGE_V3_TURBO: :"openai/whisper-large-v3-turbo"
+
+            def self?.values: -> ::Array[Telnyx::Models::AI::TranscriptionSettings::Challenger::model]
+          end
+
+          type rule = :best_turn | :best_engine | :merge_words
+
+          module Rule
+            extend Telnyx::Internal::Type::Enum
+
+            BEST_TURN: :best_turn
+            BEST_ENGINE: :best_engine
+            MERGE_WORDS: :merge_words
+
+            def self?.values: -> ::Array[Telnyx::Models::AI::TranscriptionSettings::Challenger::rule]
+          end
+        end
+
+        type fallback_model =
+          {
+            model: Telnyx::Models::AI::TranscriptionSettings::FallbackModel::model,
+            language: String?,
+            settings: Telnyx::AI::TranscriptionSettingsConfig?
+          }
+
+        class FallbackModel < Telnyx::Internal::Type::BaseModel
+          attr_accessor model: Telnyx::Models::AI::TranscriptionSettings::FallbackModel::model
+
+          attr_accessor language: String?
+
+          attr_accessor settings: Telnyx::AI::TranscriptionSettingsConfig?
+
+          def initialize: (
+            model: Telnyx::Models::AI::TranscriptionSettings::FallbackModel::model,
+            ?language: String?,
+            ?settings: Telnyx::AI::TranscriptionSettingsConfig?
+          ) -> void
+
+          def to_hash: -> {
+            model: Telnyx::Models::AI::TranscriptionSettings::FallbackModel::model,
+            language: String?,
+            settings: Telnyx::AI::TranscriptionSettingsConfig?
+          }
+
+          type model =
+            :"deepgram/flux"
+            | :"deepgram/nova-3"
+            | :"deepgram/nova-2"
+            | :"assemblyai/universal-3-5-pro"
+            | :"assemblyai/universal-streaming"
+            | :"xai/grok-stt"
+            | :"soniox/stt-rt-v4"
+            | :"soniox/stt-rt-v5"
+            | :"humain/realtime"
+            | :"reson8/turns"
+
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            DEEPGRAM_FLUX: :"deepgram/flux"
+            DEEPGRAM_NOVA_3: :"deepgram/nova-3"
+            DEEPGRAM_NOVA_2: :"deepgram/nova-2"
+            ASSEMBLYAI_UNIVERSAL_3_5_PRO: :"assemblyai/universal-3-5-pro"
+            ASSEMBLYAI_UNIVERSAL_STREAMING: :"assemblyai/universal-streaming"
+            XAI_GROK_STT: :"xai/grok-stt"
+            SONIOX_STT_RT_V4: :"soniox/stt-rt-v4"
+            SONIOX_STT_RT_V5: :"soniox/stt-rt-v5"
+            HUMAIN_REALTIME: :"humain/realtime"
+            RESON8_TURNS: :"reson8/turns"
+
+            def self?.values: -> ::Array[Telnyx::Models::AI::TranscriptionSettings::FallbackModel::model]
+          end
+        end
+
         type model =
           :"deepgram/flux"
           | :"deepgram/nova-3"
@@ -66,6 +223,7 @@ module Telnyx
           | :"humain/realtime"
           | :"reson8/turns"
           | :"cohere/ar-stt"
+          | :"telnyx/basira"
           | :"distil-whisper/distil-large-v2"
           | :"openai/whisper-large-v3-turbo"
 
@@ -86,6 +244,7 @@ module Telnyx
           HUMAIN_REALTIME: :"humain/realtime"
           RESON8_TURNS: :"reson8/turns"
           COHERE_AR_STT: :"cohere/ar-stt"
+          TELNYX_BASIRA: :"telnyx/basira"
           DISTIL_WHISPER_DISTIL_LARGE_V2: :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO: :"openai/whisper-large-v3-turbo"
 

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

@@ -0,0 +1,29 @@
+module Telnyx
+  module Models
+    module AI
+      type websocket_settings = { auth_ref: String, enabled: bool, url: String }
+
+      class WebsocketSettings < Telnyx::Internal::Type::BaseModel
+        attr_reader auth_ref: String?
+
+        def auth_ref=: (String) -> String
+
+        attr_reader enabled: bool?
+
+        def enabled=: (bool) -> bool
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        def initialize: (
+          ?auth_ref: String,
+          ?enabled: bool,
+          ?url: String
+        ) -> void
+
+        def to_hash: -> { auth_ref: String, enabled: bool, url: String }
+      end
+    end
+  end
+end

data/sig/telnyx/models/bpo_authorization_input.rbs

@@ -0,0 +1,19 @@
+module Telnyx
+  module Models
+    type bpo_authorization_input =
+      { bpo_enterprise_id: String, loa_document_id: String }
+
+    class BpoAuthorizationInput < Telnyx::Internal::Type::BaseModel
+      attr_accessor bpo_enterprise_id: String
+
+      attr_accessor loa_document_id: String
+
+      def initialize: (
+        bpo_enterprise_id: String,
+        loa_document_id: String
+      ) -> void
+
+      def to_hash: -> { bpo_enterprise_id: String, loa_document_id: String }
+    end
+  end
+end

data/sig/telnyx/models/call_assistant_request.rbs

@@ -15,6 +15,7 @@ module Telnyx
         observability_settings: ::Hash[Symbol, top],
         openai_api_key_ref: String,
         tools: ::Array[Telnyx::Models::CallAssistantRequest::tool],
+        transcription: Telnyx::Calls::TranscriptionConfig,
         voice_settings: Telnyx::AI::VoiceSettings
       }
 
@@ -79,6 +80,12 @@ module Telnyx
         ::Array[Telnyx::Models::CallAssistantRequest::tool]
       ) -> ::Array[Telnyx::Models::CallAssistantRequest::tool]
 
+      attr_reader transcription: Telnyx::Calls::TranscriptionConfig?
+
+      def transcription=: (
+        Telnyx::Calls::TranscriptionConfig
+      ) -> Telnyx::Calls::TranscriptionConfig
+
       attr_reader voice_settings: Telnyx::AI::VoiceSettings?
 
       def voice_settings=: (
@@ -99,6 +106,7 @@ module Telnyx
         ?observability_settings: ::Hash[Symbol, top],
         ?openai_api_key_ref: String,
         ?tools: ::Array[Telnyx::Models::CallAssistantRequest::tool],
+        ?transcription: Telnyx::Calls::TranscriptionConfig,
         ?voice_settings: Telnyx::AI::VoiceSettings
       ) -> void
 
@@ -116,6 +124,7 @@ module Telnyx
         observability_settings: ::Hash[Symbol, top],
         openai_api_key_ref: String,
         tools: ::Array[Telnyx::Models::CallAssistantRequest::tool],
+        transcription: Telnyx::Calls::TranscriptionConfig,
         voice_settings: Telnyx::AI::VoiceSettings
       }
 

data/sig/telnyx/models/call_conversation_created_webhook_event.rbs

@@ -0,0 +1,190 @@
+module Telnyx
+  module Models
+    type call_conversation_created_webhook_event =
+      { data: Telnyx::CallConversationCreatedWebhookEvent::Data }
+
+    class CallConversationCreatedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::CallConversationCreatedWebhookEvent::Data?
+
+      def data=: (
+        Telnyx::CallConversationCreatedWebhookEvent::Data
+      ) -> Telnyx::CallConversationCreatedWebhookEvent::Data
+
+      def initialize: (
+        ?data: Telnyx::CallConversationCreatedWebhookEvent::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::CallConversationCreatedWebhookEvent::Data
+      }
+
+      type data =
+        {
+          id: String,
+          created_at: Time,
+          event_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallConversationCreatedWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader created_at: Time?
+
+        def created_at=: (Time) -> Time
+
+        attr_reader event_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type?
+
+        def event_type=: (
+          Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type
+        ) -> Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type
+
+        attr_reader occurred_at: Time?
+
+        def occurred_at=: (Time) -> Time
+
+        attr_reader payload: Telnyx::CallConversationCreatedWebhookEvent::Data::Payload?
+
+        def payload=: (
+          Telnyx::CallConversationCreatedWebhookEvent::Data::Payload
+        ) -> Telnyx::CallConversationCreatedWebhookEvent::Data::Payload
+
+        attr_reader record_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type?
+
+        def record_type=: (
+          Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type
+        ) -> Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type
+
+        def initialize: (
+          ?id: String,
+          ?created_at: Time,
+          ?event_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type,
+          ?occurred_at: Time,
+          ?payload: Telnyx::CallConversationCreatedWebhookEvent::Data::Payload,
+          ?record_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          event_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallConversationCreatedWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type
+        }
+
+        type event_type = :"call.conversation.created"
+
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_CONVERSATION_CREATED: :"call.conversation.created"
+
+          def self?.values: -> ::Array[Telnyx::Models::CallConversationCreatedWebhookEvent::Data::event_type]
+        end
+
+        type payload =
+          {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            calling_party_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type,
+            client_state: String,
+            connection_id: String,
+            conversation_id: String,
+            from: String,
+            to: String
+          }
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          attr_reader call_control_id: String?
+
+          def call_control_id=: (String) -> String
+
+          attr_reader call_leg_id: String?
+
+          def call_leg_id=: (String) -> String
+
+          attr_reader call_session_id: String?
+
+          def call_session_id=: (String) -> String
+
+          attr_reader calling_party_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type?
+
+          def calling_party_type=: (
+            Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type
+          ) -> Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type
+
+          attr_reader client_state: String?
+
+          def client_state=: (String) -> String
+
+          attr_reader connection_id: String?
+
+          def connection_id=: (String) -> String
+
+          attr_reader conversation_id: String?
+
+          def conversation_id=: (String) -> String
+
+          attr_reader from: String?
+
+          def from=: (String) -> String
+
+          attr_reader to: String?
+
+          def to=: (String) -> String
+
+          def initialize: (
+            ?call_control_id: String,
+            ?call_leg_id: String,
+            ?call_session_id: String,
+            ?calling_party_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type,
+            ?client_state: String,
+            ?connection_id: String,
+            ?conversation_id: String,
+            ?from: String,
+            ?to: String
+          ) -> void
+
+          def to_hash: -> {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            calling_party_type: Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type,
+            client_state: String,
+            connection_id: String,
+            conversation_id: String,
+            from: String,
+            to: String
+          }
+
+          type calling_party_type = :pstn | :sip
+
+          module CallingPartyType
+            extend Telnyx::Internal::Type::Enum
+
+            PSTN: :pstn
+            SIP: :sip
+
+            def self?.values: -> ::Array[Telnyx::Models::CallConversationCreatedWebhookEvent::Data::Payload::calling_party_type]
+          end
+        end
+
+        type record_type = :event
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT: :event
+
+          def self?.values: -> ::Array[Telnyx::Models::CallConversationCreatedWebhookEvent::Data::record_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/call_conversation_ended.rbs

@@ -82,6 +82,7 @@ module Telnyx
           duration_sec: Integer,
           from: String,
           llm_model: String,
+          messages: ::Array[Telnyx::CallConversationEnded::Payload::Message],
           reason: String?,
           stt_model: String,
           to: String,
@@ -137,6 +138,12 @@ module Telnyx
 
         def llm_model=: (String) -> String
 
+        attr_reader messages: ::Array[Telnyx::CallConversationEnded::Payload::Message]?
+
+        def messages=: (
+          ::Array[Telnyx::CallConversationEnded::Payload::Message]
+        ) -> ::Array[Telnyx::CallConversationEnded::Payload::Message]
+
         attr_accessor reason: String?
 
         attr_reader stt_model: String?
@@ -171,6 +178,7 @@ module Telnyx
           ?duration_sec: Integer,
           ?from: String,
           ?llm_model: String,
+          ?messages: ::Array[Telnyx::CallConversationEnded::Payload::Message],
           ?reason: String?,
           ?stt_model: String,
           ?to: String,
@@ -191,6 +199,7 @@ module Telnyx
           duration_sec: Integer,
           from: String,
           llm_model: String,
+          messages: ::Array[Telnyx::CallConversationEnded::Payload::Message],
           reason: String?,
           stt_model: String,
           to: String,
@@ -209,6 +218,134 @@ module Telnyx
 
           def self?.values: -> ::Array[Telnyx::Models::CallConversationEnded::Payload::calling_party_type]
         end
+
+        type message =
+          {
+            content: String,
+            role: Telnyx::Models::CallConversationEnded::Payload::Message::role,
+            timestamp: Time,
+            tool_call_id: String,
+            tool_calls: ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]
+          }
+
+        class Message < Telnyx::Internal::Type::BaseModel
+          attr_reader content: String?
+
+          def content=: (String) -> String
+
+          attr_reader role: Telnyx::Models::CallConversationEnded::Payload::Message::role?
+
+          def role=: (
+            Telnyx::Models::CallConversationEnded::Payload::Message::role
+          ) -> Telnyx::Models::CallConversationEnded::Payload::Message::role
+
+          attr_reader timestamp: Time?
+
+          def timestamp=: (Time) -> Time
+
+          attr_reader tool_call_id: String?
+
+          def tool_call_id=: (String) -> String
+
+          attr_reader tool_calls: ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]?
+
+          def tool_calls=: (
+            ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]
+          ) -> ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]
+
+          def initialize: (
+            ?content: String,
+            ?role: Telnyx::Models::CallConversationEnded::Payload::Message::role,
+            ?timestamp: Time,
+            ?tool_call_id: String,
+            ?tool_calls: ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]
+          ) -> void
+
+          def to_hash: -> {
+            content: String,
+            role: Telnyx::Models::CallConversationEnded::Payload::Message::role,
+            timestamp: Time,
+            tool_call_id: String,
+            tool_calls: ::Array[Telnyx::CallConversationEnded::Payload::Message::ToolCall]
+          }
+
+          type role = :user | :assistant | :tool | :system | :developer
+
+          module Role
+            extend Telnyx::Internal::Type::Enum
+
+            USER: :user
+            ASSISTANT: :assistant
+            TOOL: :tool
+            SYSTEM: :system
+            DEVELOPER: :developer
+
+            def self?.values: -> ::Array[Telnyx::Models::CallConversationEnded::Payload::Message::role]
+          end
+
+          type tool_call =
+            {
+              id: String,
+              function: Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function,
+              type: Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_
+            }
+
+          class ToolCall < Telnyx::Internal::Type::BaseModel
+            attr_reader id: String?
+
+            def id=: (String) -> String
+
+            attr_reader function: Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function?
+
+            def function=: (
+              Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function
+            ) -> Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function
+
+            attr_reader type: Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_?
+
+            def type=: (
+              Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_
+            ) -> Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_
+
+            def initialize: (
+              ?id: String,
+              ?function: Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function,
+              ?type: Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              function: Telnyx::CallConversationEnded::Payload::Message::ToolCall::Function,
+              type: Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_
+            }
+
+            type function = { arguments: String, name: String }
+
+            class Function < Telnyx::Internal::Type::BaseModel
+              attr_reader arguments: String?
+
+              def arguments=: (String) -> String
+
+              attr_reader name: String?
+
+              def name=: (String) -> String
+
+              def initialize: (?arguments: String, ?name: String) -> void
+
+              def to_hash: -> { arguments: String, name: String }
+            end
+
+            type type_ = :function
+
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              FUNCTION: :function
+
+              def self?.values: -> ::Array[Telnyx::Models::CallConversationEnded::Payload::Message::ToolCall::type_]
+            end
+          end
+        end
       end
 
       type record_type = :event