telnyx 5.112.0 → 5.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
- data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +9 -178
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
- data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
- data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
- data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
- data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -179
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
- data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
- data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
- data/lib/telnyx/models/ai_create_response_params.rb +4 -4
- data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
- data/lib/telnyx/models/call_conversation_ended.rb +13 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +169 -118
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
- data/lib/telnyx/models/fax.rb +7 -5
- data/lib/telnyx/models/fax_create_params.rb +7 -5
- data/lib/telnyx/models/fax_delivered.rb +3 -2
- data/lib/telnyx/models/fax_failed.rb +3 -2
- data/lib/telnyx/models/fax_media_processed.rb +3 -2
- data/lib/telnyx/models/fax_queued.rb +3 -2
- data/lib/telnyx/models/fax_sending_started.rb +3 -2
- data/lib/telnyx/models/model_metadata.rb +212 -0
- data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection.rb +412 -0
- data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
- data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
- data/lib/telnyx/models/uac_external_settings.rb +101 -0
- data/lib/telnyx/models/uac_inbound.rb +210 -0
- data/lib/telnyx/models/uac_internal_settings.rb +25 -0
- data/lib/telnyx/models/uac_outbound.rb +131 -0
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
- data/lib/telnyx/models/xai_voice_settings.rb +36 -0
- data/lib/telnyx/models.rb +20 -0
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +15 -17
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/faxes.rb +13 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/texml.rb +4 -2
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +23 -4
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
- data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -366
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
- data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +371 -254
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/fax.rbi +12 -8
- data/rbi/telnyx/models/fax_create_params.rbi +12 -8
- data/rbi/telnyx/models/fax_delivered.rbi +6 -4
- data/rbi/telnyx/models/fax_failed.rbi +6 -4
- data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
- data/rbi/telnyx/models/fax_queued.rbi +6 -4
- data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
- data/rbi/telnyx/models/model_metadata.rbi +272 -0
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection.rbi +684 -0
- data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
- data/rbi/telnyx/models/uac_inbound.rbi +410 -0
- data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
- data/rbi/telnyx/models/uac_outbound.rbi +224 -0
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
- data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
- data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
- data/rbi/telnyx/resources/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +24 -24
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/faxes.rbi +18 -4
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/texml.rbi +7 -1
- data/rbi/telnyx/resources/uac_connections.rbi +7 -13
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -149
- data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -149
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
- data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -152
- data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
- data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +141 -102
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/model_metadata.rbs +142 -0
- data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection.rbs +338 -0
- data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
- data/sig/telnyx/models/uac_external_settings.rbs +73 -0
- data/sig/telnyx/models/uac_inbound.rbs +190 -0
- data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
- data/sig/telnyx/models/uac_outbound.rbs +113 -0
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
- data/sig/telnyx/models.rbs +20 -0
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- data/sig/telnyx/resources/calls/actions.rbs +2 -4
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/texml.rbs +1 -0
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +71 -14
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
- data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
- data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
- data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
- data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
|
@@ -18,11 +18,6 @@ module Telnyx
|
|
|
18
18
|
sig { returns(String) }
|
|
19
19
|
attr_accessor :call_control_id
|
|
20
20
|
|
|
21
|
-
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
22
|
-
# `wss://`.
|
|
23
|
-
sig { returns(String) }
|
|
24
|
-
attr_accessor :conversation_relay_url
|
|
25
|
-
|
|
26
21
|
# Custom parameters for the Conversation Relay session. Pass key-value data as
|
|
27
22
|
# `assistant.dynamic_variables` to make it available to the relay session.
|
|
28
23
|
sig do
|
|
@@ -65,6 +60,37 @@ module Telnyx
|
|
|
65
60
|
sig { params(conversation_relay_dtmf_detection: T::Boolean).void }
|
|
66
61
|
attr_writer :conversation_relay_dtmf_detection
|
|
67
62
|
|
|
63
|
+
# Conversation Relay connection settings. This object is used by TeXML Call
|
|
64
|
+
# Scripting's `<ConversationRelay>` verb. The `interruptible` and
|
|
65
|
+
# `interruptible_greeting` fields are shorthand for
|
|
66
|
+
# `interruption_settings.interruptible` and
|
|
67
|
+
# `interruption_settings.interruptible_greeting`; use top-level
|
|
68
|
+
# `interruption_settings` for the full interruption settings shape.
|
|
69
|
+
sig do
|
|
70
|
+
returns(
|
|
71
|
+
T.nilable(
|
|
72
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings
|
|
73
|
+
)
|
|
74
|
+
)
|
|
75
|
+
end
|
|
76
|
+
attr_reader :conversation_relay_settings
|
|
77
|
+
|
|
78
|
+
sig do
|
|
79
|
+
params(
|
|
80
|
+
conversation_relay_settings:
|
|
81
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::OrHash
|
|
82
|
+
).void
|
|
83
|
+
end
|
|
84
|
+
attr_writer :conversation_relay_settings
|
|
85
|
+
|
|
86
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
87
|
+
# `wss://`.
|
|
88
|
+
sig { returns(T.nilable(String)) }
|
|
89
|
+
attr_reader :conversation_relay_url
|
|
90
|
+
|
|
91
|
+
sig { params(conversation_relay_url: String).void }
|
|
92
|
+
attr_writer :conversation_relay_url
|
|
93
|
+
|
|
68
94
|
# Text played when the relay session starts.
|
|
69
95
|
sig { returns(T.nilable(String)) }
|
|
70
96
|
attr_reader :greeting
|
|
@@ -122,35 +148,6 @@ module Telnyx
|
|
|
122
148
|
end
|
|
123
149
|
attr_writer :languages
|
|
124
150
|
|
|
125
|
-
# Participants to add to the conversation.
|
|
126
|
-
sig do
|
|
127
|
-
returns(
|
|
128
|
-
T.nilable(
|
|
129
|
-
T::Array[
|
|
130
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant
|
|
131
|
-
]
|
|
132
|
-
)
|
|
133
|
-
)
|
|
134
|
-
end
|
|
135
|
-
attr_reader :participants
|
|
136
|
-
|
|
137
|
-
sig do
|
|
138
|
-
params(
|
|
139
|
-
participants:
|
|
140
|
-
T::Array[
|
|
141
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OrHash
|
|
142
|
-
]
|
|
143
|
-
).void
|
|
144
|
-
end
|
|
145
|
-
attr_writer :participants
|
|
146
|
-
|
|
147
|
-
# When true, sends message history update webhooks.
|
|
148
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
149
|
-
attr_reader :send_message_history_updates
|
|
150
|
-
|
|
151
|
-
sig { params(send_message_history_updates: T::Boolean).void }
|
|
152
|
-
attr_writer :send_message_history_updates
|
|
153
|
-
|
|
154
151
|
# Speech-to-text settings for Conversation Relay.
|
|
155
152
|
sig do
|
|
156
153
|
returns(
|
|
@@ -184,13 +181,6 @@ module Telnyx
|
|
|
184
181
|
sig { params(tts_language: String).void }
|
|
185
182
|
attr_writer :tts_language
|
|
186
183
|
|
|
187
|
-
# Time in milliseconds to wait for caller input before timing out.
|
|
188
|
-
sig { returns(T.nilable(Integer)) }
|
|
189
|
-
attr_reader :user_response_timeout_ms
|
|
190
|
-
|
|
191
|
-
sig { params(user_response_timeout_ms: Integer).void }
|
|
192
|
-
attr_writer :user_response_timeout_ms
|
|
193
|
-
|
|
194
184
|
# The voice to be used by the voice assistant. Currently we support ElevenLabs,
|
|
195
185
|
# Telnyx and AWS voices.
|
|
196
186
|
#
|
|
@@ -234,7 +224,7 @@ module Telnyx
|
|
|
234
224
|
Telnyx::AzureVoiceSettings,
|
|
235
225
|
Telnyx::RimeVoiceSettings,
|
|
236
226
|
Telnyx::ResembleVoiceSettings,
|
|
237
|
-
Telnyx::
|
|
227
|
+
Telnyx::XaiVoiceSettings
|
|
238
228
|
)
|
|
239
229
|
)
|
|
240
230
|
)
|
|
@@ -251,7 +241,7 @@ module Telnyx
|
|
|
251
241
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
252
242
|
Telnyx::RimeVoiceSettings::OrHash,
|
|
253
243
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
254
|
-
Telnyx::
|
|
244
|
+
Telnyx::XaiVoiceSettings::OrHash
|
|
255
245
|
)
|
|
256
246
|
).void
|
|
257
247
|
end
|
|
@@ -260,12 +250,14 @@ module Telnyx
|
|
|
260
250
|
sig do
|
|
261
251
|
params(
|
|
262
252
|
call_control_id: String,
|
|
263
|
-
conversation_relay_url: String,
|
|
264
253
|
assistant:
|
|
265
254
|
Telnyx::Calls::ActionStartConversationRelayParams::Assistant::OrHash,
|
|
266
255
|
client_state: String,
|
|
267
256
|
command_id: String,
|
|
268
257
|
conversation_relay_dtmf_detection: T::Boolean,
|
|
258
|
+
conversation_relay_settings:
|
|
259
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::OrHash,
|
|
260
|
+
conversation_relay_url: String,
|
|
269
261
|
greeting: String,
|
|
270
262
|
interruption_settings:
|
|
271
263
|
Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings::OrHash,
|
|
@@ -274,16 +266,10 @@ module Telnyx
|
|
|
274
266
|
T::Array[
|
|
275
267
|
Telnyx::Calls::ActionStartConversationRelayParams::Language::OrHash
|
|
276
268
|
],
|
|
277
|
-
participants:
|
|
278
|
-
T::Array[
|
|
279
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OrHash
|
|
280
|
-
],
|
|
281
|
-
send_message_history_updates: T::Boolean,
|
|
282
269
|
transcription:
|
|
283
270
|
Telnyx::Calls::ActionStartConversationRelayParams::Transcription::OrHash,
|
|
284
271
|
transcription_language: String,
|
|
285
272
|
tts_language: String,
|
|
286
|
-
user_response_timeout_ms: Integer,
|
|
287
273
|
voice: String,
|
|
288
274
|
voice_settings:
|
|
289
275
|
T.any(
|
|
@@ -293,16 +279,13 @@ module Telnyx
|
|
|
293
279
|
Telnyx::AzureVoiceSettings::OrHash,
|
|
294
280
|
Telnyx::RimeVoiceSettings::OrHash,
|
|
295
281
|
Telnyx::ResembleVoiceSettings::OrHash,
|
|
296
|
-
Telnyx::
|
|
282
|
+
Telnyx::XaiVoiceSettings::OrHash
|
|
297
283
|
),
|
|
298
284
|
request_options: Telnyx::RequestOptions::OrHash
|
|
299
285
|
).returns(T.attached_class)
|
|
300
286
|
end
|
|
301
287
|
def self.new(
|
|
302
288
|
call_control_id:,
|
|
303
|
-
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
304
|
-
# `wss://`.
|
|
305
|
-
conversation_relay_url:,
|
|
306
289
|
# Custom parameters for the Conversation Relay session. Pass key-value data as
|
|
307
290
|
# `assistant.dynamic_variables` to make it available to the relay session.
|
|
308
291
|
assistant: nil,
|
|
@@ -314,6 +297,16 @@ module Telnyx
|
|
|
314
297
|
command_id: nil,
|
|
315
298
|
# Enable DTMF detection for the relay session.
|
|
316
299
|
conversation_relay_dtmf_detection: nil,
|
|
300
|
+
# Conversation Relay connection settings. This object is used by TeXML Call
|
|
301
|
+
# Scripting's `<ConversationRelay>` verb. The `interruptible` and
|
|
302
|
+
# `interruptible_greeting` fields are shorthand for
|
|
303
|
+
# `interruption_settings.interruptible` and
|
|
304
|
+
# `interruption_settings.interruptible_greeting`; use top-level
|
|
305
|
+
# `interruption_settings` for the full interruption settings shape.
|
|
306
|
+
conversation_relay_settings: nil,
|
|
307
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
308
|
+
# `wss://`.
|
|
309
|
+
conversation_relay_url: nil,
|
|
317
310
|
# Text played when the relay session starts.
|
|
318
311
|
greeting: nil,
|
|
319
312
|
# Settings for handling caller interruptions during Conversation Relay speech.
|
|
@@ -325,10 +318,6 @@ module Telnyx
|
|
|
325
318
|
# Language-specific TTS and transcription settings. Use this when the relay
|
|
326
319
|
# session needs per-language provider, voice, or speech model configuration.
|
|
327
320
|
languages: nil,
|
|
328
|
-
# Participants to add to the conversation.
|
|
329
|
-
participants: nil,
|
|
330
|
-
# When true, sends message history update webhooks.
|
|
331
|
-
send_message_history_updates: nil,
|
|
332
321
|
# Speech-to-text settings for Conversation Relay.
|
|
333
322
|
transcription: nil,
|
|
334
323
|
# Language to use for speech recognition. Overrides `language` for transcription
|
|
@@ -336,8 +325,6 @@ module Telnyx
|
|
|
336
325
|
transcription_language: nil,
|
|
337
326
|
# Language to use for text-to-speech. Overrides `language` for TTS when provided.
|
|
338
327
|
tts_language: nil,
|
|
339
|
-
# Time in milliseconds to wait for caller input before timing out.
|
|
340
|
-
user_response_timeout_ms: nil,
|
|
341
328
|
# The voice to be used by the voice assistant. Currently we support ElevenLabs,
|
|
342
329
|
# Telnyx and AWS voices.
|
|
343
330
|
#
|
|
@@ -375,12 +362,14 @@ module Telnyx
|
|
|
375
362
|
override.returns(
|
|
376
363
|
{
|
|
377
364
|
call_control_id: String,
|
|
378
|
-
conversation_relay_url: String,
|
|
379
365
|
assistant:
|
|
380
366
|
Telnyx::Calls::ActionStartConversationRelayParams::Assistant,
|
|
381
367
|
client_state: String,
|
|
382
368
|
command_id: String,
|
|
383
369
|
conversation_relay_dtmf_detection: T::Boolean,
|
|
370
|
+
conversation_relay_settings:
|
|
371
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings,
|
|
372
|
+
conversation_relay_url: String,
|
|
384
373
|
greeting: String,
|
|
385
374
|
interruption_settings:
|
|
386
375
|
Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
|
|
@@ -389,16 +378,10 @@ module Telnyx
|
|
|
389
378
|
T::Array[
|
|
390
379
|
Telnyx::Calls::ActionStartConversationRelayParams::Language
|
|
391
380
|
],
|
|
392
|
-
participants:
|
|
393
|
-
T::Array[
|
|
394
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant
|
|
395
|
-
],
|
|
396
|
-
send_message_history_updates: T::Boolean,
|
|
397
381
|
transcription:
|
|
398
382
|
Telnyx::Calls::ActionStartConversationRelayParams::Transcription,
|
|
399
383
|
transcription_language: String,
|
|
400
384
|
tts_language: String,
|
|
401
|
-
user_response_timeout_ms: Integer,
|
|
402
385
|
voice: String,
|
|
403
386
|
voice_settings:
|
|
404
387
|
T.any(
|
|
@@ -408,7 +391,7 @@ module Telnyx
|
|
|
408
391
|
Telnyx::AzureVoiceSettings,
|
|
409
392
|
Telnyx::RimeVoiceSettings,
|
|
410
393
|
Telnyx::ResembleVoiceSettings,
|
|
411
|
-
Telnyx::
|
|
394
|
+
Telnyx::XaiVoiceSettings
|
|
412
395
|
),
|
|
413
396
|
request_options: Telnyx::RequestOptions
|
|
414
397
|
}
|
|
@@ -453,6 +436,325 @@ module Telnyx
|
|
|
453
436
|
end
|
|
454
437
|
end
|
|
455
438
|
|
|
439
|
+
class ConversationRelaySettings < Telnyx::Internal::Type::BaseModel
|
|
440
|
+
OrHash =
|
|
441
|
+
T.type_alias do
|
|
442
|
+
T.any(
|
|
443
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings,
|
|
444
|
+
Telnyx::Internal::AnyHash
|
|
445
|
+
)
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
449
|
+
# `wss://`.
|
|
450
|
+
sig { returns(String) }
|
|
451
|
+
attr_accessor :url
|
|
452
|
+
|
|
453
|
+
# Whether to enable DTMF detection during the relay session.
|
|
454
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
455
|
+
attr_reader :dtmf_detection
|
|
456
|
+
|
|
457
|
+
sig { params(dtmf_detection: T::Boolean).void }
|
|
458
|
+
attr_writer :dtmf_detection
|
|
459
|
+
|
|
460
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
461
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
462
|
+
# only; `dtmf` allows DTMF only.
|
|
463
|
+
sig do
|
|
464
|
+
returns(
|
|
465
|
+
T.nilable(
|
|
466
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::OrSymbol
|
|
467
|
+
)
|
|
468
|
+
)
|
|
469
|
+
end
|
|
470
|
+
attr_reader :interruptible
|
|
471
|
+
|
|
472
|
+
sig do
|
|
473
|
+
params(
|
|
474
|
+
interruptible:
|
|
475
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::OrSymbol
|
|
476
|
+
).void
|
|
477
|
+
end
|
|
478
|
+
attr_writer :interruptible
|
|
479
|
+
|
|
480
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
481
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
482
|
+
# only; `dtmf` allows DTMF only.
|
|
483
|
+
sig do
|
|
484
|
+
returns(
|
|
485
|
+
T.nilable(
|
|
486
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::OrSymbol
|
|
487
|
+
)
|
|
488
|
+
)
|
|
489
|
+
end
|
|
490
|
+
attr_reader :interruptible_greeting
|
|
491
|
+
|
|
492
|
+
sig do
|
|
493
|
+
params(
|
|
494
|
+
interruptible_greeting:
|
|
495
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::OrSymbol
|
|
496
|
+
).void
|
|
497
|
+
end
|
|
498
|
+
attr_writer :interruptible_greeting
|
|
499
|
+
|
|
500
|
+
# Language-specific TTS and transcription settings.
|
|
501
|
+
sig do
|
|
502
|
+
returns(
|
|
503
|
+
T.nilable(
|
|
504
|
+
T::Array[
|
|
505
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language
|
|
506
|
+
]
|
|
507
|
+
)
|
|
508
|
+
)
|
|
509
|
+
end
|
|
510
|
+
attr_reader :languages
|
|
511
|
+
|
|
512
|
+
sig do
|
|
513
|
+
params(
|
|
514
|
+
languages:
|
|
515
|
+
T::Array[
|
|
516
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::OrHash
|
|
517
|
+
]
|
|
518
|
+
).void
|
|
519
|
+
end
|
|
520
|
+
attr_writer :languages
|
|
521
|
+
|
|
522
|
+
# Conversation Relay connection settings. This object is used by TeXML Call
|
|
523
|
+
# Scripting's `<ConversationRelay>` verb. The `interruptible` and
|
|
524
|
+
# `interruptible_greeting` fields are shorthand for
|
|
525
|
+
# `interruption_settings.interruptible` and
|
|
526
|
+
# `interruption_settings.interruptible_greeting`; use top-level
|
|
527
|
+
# `interruption_settings` for the full interruption settings shape.
|
|
528
|
+
sig do
|
|
529
|
+
params(
|
|
530
|
+
url: String,
|
|
531
|
+
dtmf_detection: T::Boolean,
|
|
532
|
+
interruptible:
|
|
533
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::OrSymbol,
|
|
534
|
+
interruptible_greeting:
|
|
535
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::OrSymbol,
|
|
536
|
+
languages:
|
|
537
|
+
T::Array[
|
|
538
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::OrHash
|
|
539
|
+
]
|
|
540
|
+
).returns(T.attached_class)
|
|
541
|
+
end
|
|
542
|
+
def self.new(
|
|
543
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
544
|
+
# `wss://`.
|
|
545
|
+
url:,
|
|
546
|
+
# Whether to enable DTMF detection during the relay session.
|
|
547
|
+
dtmf_detection: nil,
|
|
548
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
549
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
550
|
+
# only; `dtmf` allows DTMF only.
|
|
551
|
+
interruptible: nil,
|
|
552
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
553
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
554
|
+
# only; `dtmf` allows DTMF only.
|
|
555
|
+
interruptible_greeting: nil,
|
|
556
|
+
# Language-specific TTS and transcription settings.
|
|
557
|
+
languages: nil
|
|
558
|
+
)
|
|
559
|
+
end
|
|
560
|
+
|
|
561
|
+
sig do
|
|
562
|
+
override.returns(
|
|
563
|
+
{
|
|
564
|
+
url: String,
|
|
565
|
+
dtmf_detection: T::Boolean,
|
|
566
|
+
interruptible:
|
|
567
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::OrSymbol,
|
|
568
|
+
interruptible_greeting:
|
|
569
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::OrSymbol,
|
|
570
|
+
languages:
|
|
571
|
+
T::Array[
|
|
572
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language
|
|
573
|
+
]
|
|
574
|
+
}
|
|
575
|
+
)
|
|
576
|
+
end
|
|
577
|
+
def to_hash
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
581
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
582
|
+
# only; `dtmf` allows DTMF only.
|
|
583
|
+
module Interruptible
|
|
584
|
+
extend Telnyx::Internal::Type::Enum
|
|
585
|
+
|
|
586
|
+
TaggedSymbol =
|
|
587
|
+
T.type_alias do
|
|
588
|
+
T.all(
|
|
589
|
+
Symbol,
|
|
590
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible
|
|
591
|
+
)
|
|
592
|
+
end
|
|
593
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
594
|
+
|
|
595
|
+
NONE =
|
|
596
|
+
T.let(
|
|
597
|
+
:none,
|
|
598
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::TaggedSymbol
|
|
599
|
+
)
|
|
600
|
+
ANY =
|
|
601
|
+
T.let(
|
|
602
|
+
:any,
|
|
603
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::TaggedSymbol
|
|
604
|
+
)
|
|
605
|
+
SPEECH =
|
|
606
|
+
T.let(
|
|
607
|
+
:speech,
|
|
608
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::TaggedSymbol
|
|
609
|
+
)
|
|
610
|
+
DTMF =
|
|
611
|
+
T.let(
|
|
612
|
+
:dtmf,
|
|
613
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::TaggedSymbol
|
|
614
|
+
)
|
|
615
|
+
|
|
616
|
+
sig do
|
|
617
|
+
override.returns(
|
|
618
|
+
T::Array[
|
|
619
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible::TaggedSymbol
|
|
620
|
+
]
|
|
621
|
+
)
|
|
622
|
+
end
|
|
623
|
+
def self.values
|
|
624
|
+
end
|
|
625
|
+
end
|
|
626
|
+
|
|
627
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
628
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
629
|
+
# only; `dtmf` allows DTMF only.
|
|
630
|
+
module InterruptibleGreeting
|
|
631
|
+
extend Telnyx::Internal::Type::Enum
|
|
632
|
+
|
|
633
|
+
TaggedSymbol =
|
|
634
|
+
T.type_alias do
|
|
635
|
+
T.all(
|
|
636
|
+
Symbol,
|
|
637
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting
|
|
638
|
+
)
|
|
639
|
+
end
|
|
640
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
641
|
+
|
|
642
|
+
NONE =
|
|
643
|
+
T.let(
|
|
644
|
+
:none,
|
|
645
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::TaggedSymbol
|
|
646
|
+
)
|
|
647
|
+
ANY =
|
|
648
|
+
T.let(
|
|
649
|
+
:any,
|
|
650
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::TaggedSymbol
|
|
651
|
+
)
|
|
652
|
+
SPEECH =
|
|
653
|
+
T.let(
|
|
654
|
+
:speech,
|
|
655
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::TaggedSymbol
|
|
656
|
+
)
|
|
657
|
+
DTMF =
|
|
658
|
+
T.let(
|
|
659
|
+
:dtmf,
|
|
660
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::TaggedSymbol
|
|
661
|
+
)
|
|
662
|
+
|
|
663
|
+
sig do
|
|
664
|
+
override.returns(
|
|
665
|
+
T::Array[
|
|
666
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting::TaggedSymbol
|
|
667
|
+
]
|
|
668
|
+
)
|
|
669
|
+
end
|
|
670
|
+
def self.values
|
|
671
|
+
end
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
class Language < Telnyx::Internal::Type::BaseModel
|
|
675
|
+
OrHash =
|
|
676
|
+
T.type_alias do
|
|
677
|
+
T.any(
|
|
678
|
+
Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language,
|
|
679
|
+
Telnyx::Internal::AnyHash
|
|
680
|
+
)
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
# BCP 47 language code.
|
|
684
|
+
sig { returns(T.nilable(String)) }
|
|
685
|
+
attr_reader :code
|
|
686
|
+
|
|
687
|
+
sig { params(code: String).void }
|
|
688
|
+
attr_writer :code
|
|
689
|
+
|
|
690
|
+
# Speech recognition model for this language.
|
|
691
|
+
sig { returns(T.nilable(String)) }
|
|
692
|
+
attr_reader :speech_model
|
|
693
|
+
|
|
694
|
+
sig { params(speech_model: String).void }
|
|
695
|
+
attr_writer :speech_model
|
|
696
|
+
|
|
697
|
+
# Speech-to-text provider for this language.
|
|
698
|
+
sig { returns(T.nilable(String)) }
|
|
699
|
+
attr_reader :transcription_provider
|
|
700
|
+
|
|
701
|
+
sig { params(transcription_provider: String).void }
|
|
702
|
+
attr_writer :transcription_provider
|
|
703
|
+
|
|
704
|
+
# Text-to-speech provider for this language.
|
|
705
|
+
sig { returns(T.nilable(String)) }
|
|
706
|
+
attr_reader :tts_provider
|
|
707
|
+
|
|
708
|
+
sig { params(tts_provider: String).void }
|
|
709
|
+
attr_writer :tts_provider
|
|
710
|
+
|
|
711
|
+
# Voice identifier for this language.
|
|
712
|
+
sig { returns(T.nilable(String)) }
|
|
713
|
+
attr_reader :voice
|
|
714
|
+
|
|
715
|
+
sig { params(voice: String).void }
|
|
716
|
+
attr_writer :voice
|
|
717
|
+
|
|
718
|
+
# Language-specific speech and transcription settings for Conversation Relay.
|
|
719
|
+
sig do
|
|
720
|
+
params(
|
|
721
|
+
code: String,
|
|
722
|
+
speech_model: String,
|
|
723
|
+
transcription_provider: String,
|
|
724
|
+
tts_provider: String,
|
|
725
|
+
voice: String
|
|
726
|
+
).returns(T.attached_class)
|
|
727
|
+
end
|
|
728
|
+
def self.new(
|
|
729
|
+
# BCP 47 language code.
|
|
730
|
+
code: nil,
|
|
731
|
+
# Speech recognition model for this language.
|
|
732
|
+
speech_model: nil,
|
|
733
|
+
# Speech-to-text provider for this language.
|
|
734
|
+
transcription_provider: nil,
|
|
735
|
+
# Text-to-speech provider for this language.
|
|
736
|
+
tts_provider: nil,
|
|
737
|
+
# Voice identifier for this language.
|
|
738
|
+
voice: nil
|
|
739
|
+
)
|
|
740
|
+
end
|
|
741
|
+
|
|
742
|
+
sig do
|
|
743
|
+
override.returns(
|
|
744
|
+
{
|
|
745
|
+
code: String,
|
|
746
|
+
speech_model: String,
|
|
747
|
+
transcription_provider: String,
|
|
748
|
+
tts_provider: String,
|
|
749
|
+
voice: String
|
|
750
|
+
}
|
|
751
|
+
)
|
|
752
|
+
end
|
|
753
|
+
def to_hash
|
|
754
|
+
end
|
|
755
|
+
end
|
|
756
|
+
end
|
|
757
|
+
|
|
456
758
|
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
457
759
|
OrHash =
|
|
458
760
|
T.type_alias do
|
|
@@ -802,155 +1104,6 @@ module Telnyx
|
|
|
802
1104
|
end
|
|
803
1105
|
end
|
|
804
1106
|
|
|
805
|
-
class Participant < Telnyx::Internal::Type::BaseModel
|
|
806
|
-
OrHash =
|
|
807
|
-
T.type_alias do
|
|
808
|
-
T.any(
|
|
809
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant,
|
|
810
|
-
Telnyx::Internal::AnyHash
|
|
811
|
-
)
|
|
812
|
-
end
|
|
813
|
-
|
|
814
|
-
# The call_control_id of the participant to add to the conversation.
|
|
815
|
-
sig { returns(String) }
|
|
816
|
-
attr_accessor :id
|
|
817
|
-
|
|
818
|
-
# The role of the participant in the conversation.
|
|
819
|
-
sig do
|
|
820
|
-
returns(
|
|
821
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role::OrSymbol
|
|
822
|
-
)
|
|
823
|
-
end
|
|
824
|
-
attr_accessor :role
|
|
825
|
-
|
|
826
|
-
# Display name for the participant.
|
|
827
|
-
sig { returns(T.nilable(String)) }
|
|
828
|
-
attr_reader :name
|
|
829
|
-
|
|
830
|
-
sig { params(name: String).void }
|
|
831
|
-
attr_writer :name
|
|
832
|
-
|
|
833
|
-
# Determines what happens to the conversation when this participant hangs up.
|
|
834
|
-
sig do
|
|
835
|
-
returns(
|
|
836
|
-
T.nilable(
|
|
837
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::OrSymbol
|
|
838
|
-
)
|
|
839
|
-
)
|
|
840
|
-
end
|
|
841
|
-
attr_reader :on_hangup
|
|
842
|
-
|
|
843
|
-
sig do
|
|
844
|
-
params(
|
|
845
|
-
on_hangup:
|
|
846
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::OrSymbol
|
|
847
|
-
).void
|
|
848
|
-
end
|
|
849
|
-
attr_writer :on_hangup
|
|
850
|
-
|
|
851
|
-
sig do
|
|
852
|
-
params(
|
|
853
|
-
id: String,
|
|
854
|
-
role:
|
|
855
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role::OrSymbol,
|
|
856
|
-
name: String,
|
|
857
|
-
on_hangup:
|
|
858
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::OrSymbol
|
|
859
|
-
).returns(T.attached_class)
|
|
860
|
-
end
|
|
861
|
-
def self.new(
|
|
862
|
-
# The call_control_id of the participant to add to the conversation.
|
|
863
|
-
id:,
|
|
864
|
-
# The role of the participant in the conversation.
|
|
865
|
-
role:,
|
|
866
|
-
# Display name for the participant.
|
|
867
|
-
name: nil,
|
|
868
|
-
# Determines what happens to the conversation when this participant hangs up.
|
|
869
|
-
on_hangup: nil
|
|
870
|
-
)
|
|
871
|
-
end
|
|
872
|
-
|
|
873
|
-
sig do
|
|
874
|
-
override.returns(
|
|
875
|
-
{
|
|
876
|
-
id: String,
|
|
877
|
-
role:
|
|
878
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role::OrSymbol,
|
|
879
|
-
name: String,
|
|
880
|
-
on_hangup:
|
|
881
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::OrSymbol
|
|
882
|
-
}
|
|
883
|
-
)
|
|
884
|
-
end
|
|
885
|
-
def to_hash
|
|
886
|
-
end
|
|
887
|
-
|
|
888
|
-
# The role of the participant in the conversation.
|
|
889
|
-
module Role
|
|
890
|
-
extend Telnyx::Internal::Type::Enum
|
|
891
|
-
|
|
892
|
-
TaggedSymbol =
|
|
893
|
-
T.type_alias do
|
|
894
|
-
T.all(
|
|
895
|
-
Symbol,
|
|
896
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role
|
|
897
|
-
)
|
|
898
|
-
end
|
|
899
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
900
|
-
|
|
901
|
-
USER =
|
|
902
|
-
T.let(
|
|
903
|
-
:user,
|
|
904
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role::TaggedSymbol
|
|
905
|
-
)
|
|
906
|
-
|
|
907
|
-
sig do
|
|
908
|
-
override.returns(
|
|
909
|
-
T::Array[
|
|
910
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role::TaggedSymbol
|
|
911
|
-
]
|
|
912
|
-
)
|
|
913
|
-
end
|
|
914
|
-
def self.values
|
|
915
|
-
end
|
|
916
|
-
end
|
|
917
|
-
|
|
918
|
-
# Determines what happens to the conversation when this participant hangs up.
|
|
919
|
-
module OnHangup
|
|
920
|
-
extend Telnyx::Internal::Type::Enum
|
|
921
|
-
|
|
922
|
-
TaggedSymbol =
|
|
923
|
-
T.type_alias do
|
|
924
|
-
T.all(
|
|
925
|
-
Symbol,
|
|
926
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup
|
|
927
|
-
)
|
|
928
|
-
end
|
|
929
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
930
|
-
|
|
931
|
-
CONTINUE_CONVERSATION =
|
|
932
|
-
T.let(
|
|
933
|
-
:continue_conversation,
|
|
934
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::TaggedSymbol
|
|
935
|
-
)
|
|
936
|
-
END_CONVERSATION =
|
|
937
|
-
T.let(
|
|
938
|
-
:end_conversation,
|
|
939
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::TaggedSymbol
|
|
940
|
-
)
|
|
941
|
-
|
|
942
|
-
sig do
|
|
943
|
-
override.returns(
|
|
944
|
-
T::Array[
|
|
945
|
-
Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup::TaggedSymbol
|
|
946
|
-
]
|
|
947
|
-
)
|
|
948
|
-
end
|
|
949
|
-
def self.values
|
|
950
|
-
end
|
|
951
|
-
end
|
|
952
|
-
end
|
|
953
|
-
|
|
954
1107
|
class Transcription < Telnyx::Internal::Type::BaseModel
|
|
955
1108
|
OrHash =
|
|
956
1109
|
T.type_alias do
|
|
@@ -1019,46 +1172,10 @@ module Telnyx
|
|
|
1019
1172
|
Telnyx::AzureVoiceSettings,
|
|
1020
1173
|
Telnyx::RimeVoiceSettings,
|
|
1021
1174
|
Telnyx::ResembleVoiceSettings,
|
|
1022
|
-
Telnyx::
|
|
1175
|
+
Telnyx::XaiVoiceSettings
|
|
1023
1176
|
)
|
|
1024
1177
|
end
|
|
1025
1178
|
|
|
1026
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
1027
|
-
OrHash =
|
|
1028
|
-
T.type_alias do
|
|
1029
|
-
T.any(
|
|
1030
|
-
Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings::Xai,
|
|
1031
|
-
Telnyx::Internal::AnyHash
|
|
1032
|
-
)
|
|
1033
|
-
end
|
|
1034
|
-
|
|
1035
|
-
# Voice settings provider type
|
|
1036
|
-
sig { returns(Symbol) }
|
|
1037
|
-
attr_accessor :type
|
|
1038
|
-
|
|
1039
|
-
# Language code, or `auto` to detect automatically.
|
|
1040
|
-
sig { returns(T.nilable(String)) }
|
|
1041
|
-
attr_reader :language
|
|
1042
|
-
|
|
1043
|
-
sig { params(language: String).void }
|
|
1044
|
-
attr_writer :language
|
|
1045
|
-
|
|
1046
|
-
sig do
|
|
1047
|
-
params(language: String, type: Symbol).returns(T.attached_class)
|
|
1048
|
-
end
|
|
1049
|
-
def self.new(
|
|
1050
|
-
# Language code, or `auto` to detect automatically.
|
|
1051
|
-
language: nil,
|
|
1052
|
-
# Voice settings provider type
|
|
1053
|
-
type: :xai
|
|
1054
|
-
)
|
|
1055
|
-
end
|
|
1056
|
-
|
|
1057
|
-
sig { override.returns({ type: Symbol, language: String }) }
|
|
1058
|
-
def to_hash
|
|
1059
|
-
end
|
|
1060
|
-
end
|
|
1061
|
-
|
|
1062
1179
|
sig do
|
|
1063
1180
|
override.returns(
|
|
1064
1181
|
T::Array[
|