telnyx 5.123.0 → 5.124.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.
Files changed (122) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +5 -0
  5. data/lib/telnyx/models/ai/assistant_create_params.rb +780 -1
  6. data/lib/telnyx/models/ai/assistant_update_params.rb +780 -1
  7. data/lib/telnyx/models/ai/assistants/update_assistant.rb +785 -1
  8. data/lib/telnyx/models/ai/inference_embedding.rb +767 -1
  9. data/lib/telnyx/models/{ai_create_response_params.rb → ai_create_response_deprecated_params.rb} +2 -2
  10. data/lib/telnyx/models/{ai_create_response_response.rb → ai_create_response_deprecated_response.rb} +1 -1
  11. data/lib/telnyx/models/call_dial_params.rb +276 -10
  12. data/lib/telnyx/models/calls/action_answer_params.rb +278 -10
  13. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +15 -4
  14. data/lib/telnyx/models/calls/action_speak_params.rb +15 -4
  15. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +431 -13
  16. data/lib/telnyx/models/calls/transcription_start_request.rb +173 -5
  17. data/lib/telnyx/models/conferences/action_speak_params.rb +15 -4
  18. data/lib/telnyx/models/messaging_profile_update_params.rb +9 -1
  19. data/lib/telnyx/models/sip_registration_status_retrieve_params.rb +45 -0
  20. data/lib/telnyx/models/sip_registration_status_retrieve_response.rb +160 -0
  21. data/lib/telnyx/models/speech_to_text_list_providers_params.rb +16 -5
  22. data/lib/telnyx/models/speech_to_text_list_providers_response.rb +55 -23
  23. data/lib/telnyx/models/voice_sdk_call_report_list_response.rb +114 -9
  24. data/lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb +116 -9
  25. data/lib/telnyx/models/whatsapp/user_data_retrieve_response.rb +44 -3
  26. data/lib/telnyx/models/whatsapp/user_data_update_response.rb +44 -3
  27. data/lib/telnyx/models.rb +3 -9
  28. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
  29. data/lib/telnyx/resources/ai/assistants.rb +6 -2
  30. data/lib/telnyx/resources/ai.rb +4 -4
  31. data/lib/telnyx/resources/calls/actions.rb +6 -6
  32. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  33. data/lib/telnyx/resources/messaging_profiles.rb +3 -1
  34. data/lib/telnyx/resources/sip_registration_status.rb +45 -0
  35. data/lib/telnyx/resources/speech_to_text.rb +6 -5
  36. data/lib/telnyx/version.rb +1 -1
  37. data/lib/telnyx.rb +5 -9
  38. data/rbi/telnyx/client.rbi +4 -0
  39. data/rbi/telnyx/models/ai/assistant_create_params.rbi +1411 -0
  40. data/rbi/telnyx/models/ai/assistant_update_params.rbi +1411 -0
  41. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +1417 -0
  42. data/rbi/telnyx/models/ai/inference_embedding.rbi +1454 -0
  43. data/rbi/telnyx/models/{ai_create_response_params.rbi → ai_create_response_deprecated_params.rbi} +5 -2
  44. data/rbi/telnyx/models/{ai_create_response_response.rbi → ai_create_response_deprecated_response.rbi} +1 -1
  45. data/rbi/telnyx/models/call_dial_params.rbi +661 -13
  46. data/rbi/telnyx/models/calls/action_answer_params.rbi +659 -13
  47. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +30 -5
  48. data/rbi/telnyx/models/calls/action_speak_params.rbi +30 -5
  49. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +1016 -17
  50. data/rbi/telnyx/models/calls/transcription_start_request.rbi +433 -10
  51. data/rbi/telnyx/models/conferences/action_speak_params.rbi +30 -5
  52. data/rbi/telnyx/models/messaging_profile_update_params.rbi +8 -0
  53. data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi +93 -0
  54. data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi +343 -0
  55. data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +27 -7
  56. data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi +107 -43
  57. data/rbi/telnyx/models/voice_sdk_call_report_list_response.rbi +294 -9
  58. data/rbi/telnyx/models/voice_sdk_call_report_retrieve_response.rbi +294 -9
  59. data/rbi/telnyx/models/whatsapp/user_data_retrieve_response.rbi +96 -6
  60. data/rbi/telnyx/models/whatsapp/user_data_update_response.rbi +94 -6
  61. data/rbi/telnyx/models.rbi +5 -10
  62. data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
  63. data/rbi/telnyx/resources/ai/assistants.rbi +16 -0
  64. data/rbi/telnyx/resources/ai.rbi +1 -1
  65. data/rbi/telnyx/resources/calls/actions.rbi +10 -7
  66. data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
  67. data/rbi/telnyx/resources/messaging_profiles.rbi +3 -0
  68. data/rbi/telnyx/resources/sip_registration_status.rbi +34 -0
  69. data/rbi/telnyx/resources/speech_to_text.rbi +11 -5
  70. data/sig/telnyx/client.rbs +2 -0
  71. data/sig/telnyx/models/ai/assistant_create_params.rbs +508 -0
  72. data/sig/telnyx/models/ai/assistant_update_params.rbs +508 -0
  73. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +511 -0
  74. data/sig/telnyx/models/ai/inference_embedding.rbs +526 -0
  75. data/sig/telnyx/models/{ai_create_response_params.rbs → ai_create_response_deprecated_params.rbs} +2 -2
  76. data/sig/telnyx/models/ai_create_response_deprecated_response.rbs +7 -0
  77. data/sig/telnyx/models/call_dial_params.rbs +236 -13
  78. data/sig/telnyx/models/calls/action_answer_params.rbs +236 -13
  79. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +11 -1
  80. data/sig/telnyx/models/calls/action_speak_params.rbs +11 -1
  81. data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +370 -19
  82. data/sig/telnyx/models/calls/transcription_start_request.rbs +175 -2
  83. data/sig/telnyx/models/conferences/action_speak_params.rbs +11 -1
  84. data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
  85. data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs +41 -0
  86. data/sig/telnyx/models/sip_registration_status_retrieve_response.rbs +164 -0
  87. data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +4 -4
  88. data/sig/telnyx/models/speech_to_text_list_providers_response.rbs +33 -16
  89. data/sig/telnyx/models/voice_sdk_call_report_list_response.rbs +121 -8
  90. data/sig/telnyx/models/voice_sdk_call_report_retrieve_response.rbs +121 -8
  91. data/sig/telnyx/models/whatsapp/user_data_retrieve_response.rbs +57 -6
  92. data/sig/telnyx/models/whatsapp/user_data_update_response.rbs +57 -6
  93. data/sig/telnyx/models.rbs +3 -9
  94. data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
  95. data/sig/telnyx/resources/ai/assistants.rbs +2 -0
  96. data/sig/telnyx/resources/ai.rbs +2 -2
  97. data/sig/telnyx/resources/calls/actions.rbs +2 -2
  98. data/sig/telnyx/resources/messaging_profiles.rbs +1 -0
  99. data/sig/telnyx/resources/sip_registration_status.rbs +13 -0
  100. metadata +17 -29
  101. data/lib/telnyx/models/calls/transcription_engine_soniox_config.rb +0 -91
  102. data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +0 -100
  103. data/lib/telnyx/models/conversation_relay_interruption_settings.rb +0 -105
  104. data/lib/telnyx/models/conversation_relay_language.rb +0 -141
  105. data/lib/telnyx/models/inworld_voice_settings.rb +0 -28
  106. data/lib/telnyx/models/voice_sdk_call_report_log_entry.rb +0 -57
  107. data/lib/telnyx/models/whatsapp/whatsapp_user_data.rb +0 -49
  108. data/rbi/telnyx/models/calls/transcription_engine_soniox_config.rbi +0 -184
  109. data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +0 -289
  110. data/rbi/telnyx/models/conversation_relay_interruption_settings.rbi +0 -271
  111. data/rbi/telnyx/models/conversation_relay_language.rbi +0 -309
  112. data/rbi/telnyx/models/inworld_voice_settings.rbi +0 -53
  113. data/rbi/telnyx/models/voice_sdk_call_report_log_entry.rbi +0 -108
  114. data/rbi/telnyx/models/whatsapp/whatsapp_user_data.rbi +0 -82
  115. data/sig/telnyx/models/ai_create_response_response.rbs +0 -7
  116. data/sig/telnyx/models/calls/transcription_engine_soniox_config.rbs +0 -79
  117. data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +0 -114
  118. data/sig/telnyx/models/conversation_relay_interruption_settings.rbs +0 -88
  119. data/sig/telnyx/models/conversation_relay_language.rbs +0 -121
  120. data/sig/telnyx/models/inworld_voice_settings.rbs +0 -26
  121. data/sig/telnyx/models/voice_sdk_call_report_log_entry.rbs +0 -58
  122. data/sig/telnyx/models/whatsapp/whatsapp_user_data.rbs +0 -54
@@ -34,6 +34,8 @@ module Telnyx
34
34
  params(
35
35
  instructions: String,
36
36
  name: String,
37
+ conversation_flow:
38
+ Telnyx::AI::AssistantCreateParams::ConversationFlow::OrHash,
37
39
  description: String,
38
40
  dynamic_variables: T::Hash[Symbol, T.anything],
39
41
  dynamic_variables_webhook_timeout_ms: Integer,
@@ -83,6 +85,12 @@ module Telnyx
83
85
  # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
84
86
  instructions:,
85
87
  name:,
88
+ # Conversation flow as supplied by API clients (create / update).
89
+ #
90
+ # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
91
+ # unique node/edge IDs, that `start_node_id` references a real node, and that
92
+ # every edge's endpoints reference real nodes.
93
+ conversation_flow: nil,
86
94
  description: nil,
87
95
  # Map of dynamic variables and their default values
88
96
  dynamic_variables: nil,
@@ -193,6 +201,8 @@ module Telnyx
193
201
  sig do
194
202
  params(
195
203
  assistant_id: String,
204
+ conversation_flow:
205
+ Telnyx::AI::AssistantUpdateParams::ConversationFlow::OrHash,
196
206
  description: String,
197
207
  dynamic_variables: T::Hash[Symbol, T.anything],
198
208
  dynamic_variables_webhook_timeout_ms: Integer,
@@ -243,6 +253,12 @@ module Telnyx
243
253
  end
244
254
  def update(
245
255
  assistant_id,
256
+ # Conversation flow as supplied by API clients (create / update).
257
+ #
258
+ # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
259
+ # unique node/edge IDs, that `start_node_id` references a real node, and that
260
+ # every edge's endpoints reference real nodes.
261
+ conversation_flow: nil,
246
262
  description: nil,
247
263
  # Map of dynamic variables and their default values
248
264
  dynamic_variables: nil,
@@ -58,7 +58,7 @@ module Telnyx
58
58
  request_options: Telnyx::RequestOptions::OrHash
59
59
  ).returns(T::Hash[Symbol, T.anything])
60
60
  end
61
- def create_response(body:, request_options: {})
61
+ def create_response_deprecated(body:, request_options: {})
62
62
  end
63
63
 
64
64
  # **Deprecated**: Use `GET /v2/ai/openai/models` instead.
@@ -670,7 +670,7 @@ module Telnyx
670
670
  Telnyx::AzureVoiceSettings::OrHash,
671
671
  Telnyx::RimeVoiceSettings::OrHash,
672
672
  Telnyx::ResembleVoiceSettings::OrHash,
673
- Telnyx::InworldVoiceSettings::OrHash,
673
+ Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld::OrHash,
674
674
  Telnyx::XaiVoiceSettings::OrHash
675
675
  ),
676
676
  request_options: Telnyx::RequestOptions::OrHash
@@ -1083,7 +1083,7 @@ module Telnyx
1083
1083
  Telnyx::AzureVoiceSettings::OrHash,
1084
1084
  Telnyx::RimeVoiceSettings::OrHash,
1085
1085
  Telnyx::ResembleVoiceSettings::OrHash,
1086
- Telnyx::InworldVoiceSettings::OrHash,
1086
+ Telnyx::Calls::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
1087
1087
  Telnyx::XaiVoiceSettings::OrHash
1088
1088
  ),
1089
1089
  request_options: Telnyx::RequestOptions::OrHash
@@ -1309,9 +1309,12 @@ module Telnyx
1309
1309
  interruptible_greeting:
1310
1310
  Telnyx::Calls::ActionStartConversationRelayParams::InterruptibleGreeting::OrSymbol,
1311
1311
  interruption_settings:
1312
- Telnyx::ConversationRelayInterruptionSettings::OrHash,
1312
+ Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings::OrHash,
1313
1313
  language: String,
1314
- languages: T::Array[Telnyx::ConversationRelayLanguage::OrHash],
1314
+ languages:
1315
+ T::Array[
1316
+ Telnyx::Calls::ActionStartConversationRelayParams::Language::OrHash
1317
+ ],
1315
1318
  provider: String,
1316
1319
  structured_provider: T::Hash[Symbol, T.anything],
1317
1320
  transcription: T::Hash[Symbol, T.anything],
@@ -1330,7 +1333,7 @@ module Telnyx
1330
1333
  Telnyx::AzureVoiceSettings::OrHash,
1331
1334
  Telnyx::RimeVoiceSettings::OrHash,
1332
1335
  Telnyx::ResembleVoiceSettings::OrHash,
1333
- Telnyx::InworldVoiceSettings::OrHash,
1336
+ Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings::Inworld::OrHash,
1334
1337
  Telnyx::XaiVoiceSettings::OrHash
1335
1338
  ),
1336
1339
  request_options: Telnyx::RequestOptions::OrHash
@@ -1833,8 +1836,8 @@ module Telnyx
1833
1836
  Telnyx::Calls::TranscriptionEngineAzureConfig::OrHash,
1834
1837
  Telnyx::Calls::TranscriptionEngineXaiConfig::OrHash,
1835
1838
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
1836
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
1837
- Telnyx::Calls::TranscriptionEngineSonioxConfig::OrHash,
1839
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::OrHash,
1840
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::OrHash,
1838
1841
  Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
1839
1842
  Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
1840
1843
  Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -534,7 +534,7 @@ module Telnyx
534
534
  Telnyx::AzureVoiceSettings::OrHash,
535
535
  Telnyx::RimeVoiceSettings::OrHash,
536
536
  Telnyx::ResembleVoiceSettings::OrHash,
537
- Telnyx::InworldVoiceSettings::OrHash,
537
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
538
538
  Telnyx::XaiVoiceSettings::OrHash
539
539
  ),
540
540
  request_options: Telnyx::RequestOptions::OrHash
@@ -113,6 +113,7 @@ module Telnyx
113
113
  sig do
114
114
  params(
115
115
  messaging_profile_id: String,
116
+ ai_assistant_id: T.nilable(String),
116
117
  alpha_sender: T.nilable(String),
117
118
  daily_spend_limit: String,
118
119
  daily_spend_limit_enabled: T::Boolean,
@@ -137,6 +138,8 @@ module Telnyx
137
138
  def update(
138
139
  # The id of the messaging profile to retrieve
139
140
  messaging_profile_id,
141
+ # The ID of the AI assistant associated with this messaging profile.
142
+ ai_assistant_id: nil,
140
143
  # The alphanumeric sender ID to use when sending to destinations that require an
141
144
  # alphanumeric sender ID.
142
145
  alpha_sender: nil,
@@ -0,0 +1,34 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Resources
5
+ # UAC connection operations
6
+ class SipRegistrationStatus
7
+ # Returns the live SIP registration state of a UAC connection: whether it is
8
+ # currently registered, when it last registered, and the last response Telnyx
9
+ # received from the registrar. Only `uac_external_credential` is supported today.
10
+ sig do
11
+ params(
12
+ connection_id: String,
13
+ credential_type:
14
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
15
+ request_options: Telnyx::RequestOptions::OrHash
16
+ ).returns(Telnyx::Models::SipRegistrationStatusRetrieveResponse)
17
+ end
18
+ def retrieve(
19
+ # Identifier of the UAC connection to look up.
20
+ connection_id:,
21
+ # The kind of credential to look up. Only `uac_external_credential` is supported
22
+ # today.
23
+ credential_type:,
24
+ request_options: {}
25
+ )
26
+ end
27
+
28
+ # @api private
29
+ sig { params(client: Telnyx::Client).returns(T.attached_class) }
30
+ def self.new(client:)
31
+ end
32
+ end
33
+ end
34
+ end
@@ -11,10 +11,11 @@ module Telnyx
11
11
  #
12
12
  # - `streaming` — standalone WebSocket transcription via
13
13
  # `/speech-to-text/transcription`.
14
- # - `file_transcription` — file-based transcription via
15
- # `/ai/audio/transcriptions`.
16
- # - `in_call_transcription` — live call transcription via Call Control
17
- # `transcription_start`.
14
+ # - `file_based` — file-based transcription via `/ai/audio/transcriptions`.
15
+ # - `in_call` — live call transcription via Call Control `transcription_start`.
16
+ # - `ai_assistant` — STT configured on a Call Control AI Assistant via
17
+ # voice-assistant `TranscriptionConfig` (covers both live-streaming and
18
+ # non-streaming/batch models).
18
19
  #
19
20
  # Use this endpoint to discover which (provider, model) combinations are available
20
21
  # for the surface you need, and which language codes each accepts. `auto` in a
@@ -34,7 +35,12 @@ module Telnyx
34
35
  # models currently registered for any service type will return an empty `data`
35
36
  # array rather than an error.
36
37
  provider: nil,
37
- # Filter to entries that support the given service type.
38
+ # Filter to entries that support the given service type. For backward
39
+ # compatibility with the values that briefly shipped before the product-aligned
40
+ # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
41
+ # `ai_assistant_transcription` are silently accepted and normalized to
42
+ # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
43
+ # emits the canonical (post-rename) values.
38
44
  service_type: nil,
39
45
  request_options: {}
40
46
  )
@@ -344,6 +344,8 @@ module Telnyx
344
344
 
345
345
  attr_reader uac_connections: Telnyx::Resources::UacConnections
346
346
 
347
+ attr_reader sip_registration_status: Telnyx::Resources::SipRegistrationStatus
348
+
347
349
  attr_reader speech_to_text: Telnyx::Resources::SpeechToText
348
350
 
349
351
  attr_reader voice_sdk_call_reports: Telnyx::Resources::VoiceSDKCallReports