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
@@ -15,9 +15,9 @@ module Telnyx
15
15
  greeting: String,
16
16
  interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible,
17
17
  interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting,
18
- interruption_settings: Telnyx::ConversationRelayInterruptionSettings,
18
+ interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
19
19
  language: String,
20
- languages: ::Array[Telnyx::ConversationRelayLanguage],
20
+ languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
21
21
  provider: String,
22
22
  structured_provider: ::Hash[Symbol, top],
23
23
  transcription: ::Hash[Symbol, top],
@@ -88,21 +88,21 @@ module Telnyx
88
88
  Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting
89
89
  ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting
90
90
 
91
- attr_reader interruption_settings: Telnyx::ConversationRelayInterruptionSettings?
91
+ attr_reader interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings?
92
92
 
93
93
  def interruption_settings=: (
94
- Telnyx::ConversationRelayInterruptionSettings
95
- ) -> Telnyx::ConversationRelayInterruptionSettings
94
+ Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings
95
+ ) -> Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings
96
96
 
97
97
  attr_reader language: String?
98
98
 
99
99
  def language=: (String) -> String
100
100
 
101
- attr_reader languages: ::Array[Telnyx::ConversationRelayLanguage]?
101
+ attr_reader languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]?
102
102
 
103
103
  def languages=: (
104
- ::Array[Telnyx::ConversationRelayLanguage]
105
- ) -> ::Array[Telnyx::ConversationRelayLanguage]
104
+ ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]
105
+ ) -> ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language]
106
106
 
107
107
  attr_reader provider: String?
108
108
 
@@ -159,9 +159,9 @@ module Telnyx
159
159
  ?greeting: String,
160
160
  ?interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible,
161
161
  ?interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting,
162
- ?interruption_settings: Telnyx::ConversationRelayInterruptionSettings,
162
+ ?interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
163
163
  ?language: String,
164
- ?languages: ::Array[Telnyx::ConversationRelayLanguage],
164
+ ?languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
165
165
  ?provider: String,
166
166
  ?structured_provider: ::Hash[Symbol, top],
167
167
  ?transcription: ::Hash[Symbol, top],
@@ -187,9 +187,9 @@ module Telnyx
187
187
  greeting: String,
188
188
  interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible,
189
189
  interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting,
190
- interruption_settings: Telnyx::ConversationRelayInterruptionSettings,
190
+ interruption_settings: Telnyx::Calls::ActionStartConversationRelayParams::InterruptionSettings,
191
191
  language: String,
192
- languages: ::Array[Telnyx::ConversationRelayLanguage],
192
+ languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::Language],
193
193
  provider: String,
194
194
  structured_provider: ::Hash[Symbol, top],
195
195
  transcription: ::Hash[Symbol, top],
@@ -222,7 +222,7 @@ module Telnyx
222
222
  dtmf_detection: bool,
223
223
  interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
224
224
  interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
225
- languages: ::Array[Telnyx::ConversationRelayLanguage]
225
+ languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
226
226
  }
227
227
 
228
228
  class ConversationRelaySettings < Telnyx::Internal::Type::BaseModel
@@ -244,18 +244,18 @@ module Telnyx
244
244
  Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting
245
245
  ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting
246
246
 
247
- attr_reader languages: ::Array[Telnyx::ConversationRelayLanguage]?
247
+ attr_reader languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]?
248
248
 
249
249
  def languages=: (
250
- ::Array[Telnyx::ConversationRelayLanguage]
251
- ) -> ::Array[Telnyx::ConversationRelayLanguage]
250
+ ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
251
+ ) -> ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
252
252
 
253
253
  def initialize: (
254
254
  url: String,
255
255
  ?dtmf_detection: bool,
256
256
  ?interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
257
257
  ?interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
258
- ?languages: ::Array[Telnyx::ConversationRelayLanguage]
258
+ ?languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
259
259
  ) -> void
260
260
 
261
261
  def to_hash: -> {
@@ -263,7 +263,7 @@ module Telnyx
263
263
  dtmf_detection: bool,
264
264
  interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible,
265
265
  interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting,
266
- languages: ::Array[Telnyx::ConversationRelayLanguage]
266
+ languages: ::Array[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language]
267
267
  }
268
268
 
269
269
  type interruptible = :none | :any | :speech | :dtmf
@@ -291,6 +291,134 @@ module Telnyx
291
291
 
292
292
  def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::interruptible_greeting]
293
293
  end
294
+
295
+ type language =
296
+ {
297
+ language: String,
298
+ speech_model: String,
299
+ transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine,
300
+ transcription_engine_config: ::Hash[Symbol, top],
301
+ transcription_provider: String,
302
+ tts_provider: String,
303
+ voice: String,
304
+ voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings
305
+ }
306
+
307
+ class Language < Telnyx::Internal::Type::BaseModel
308
+ attr_accessor language: String
309
+
310
+ attr_reader speech_model: String?
311
+
312
+ def speech_model=: (String) -> String
313
+
314
+ attr_reader transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine?
315
+
316
+ def transcription_engine=: (
317
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine
318
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine
319
+
320
+ attr_reader transcription_engine_config: ::Hash[Symbol, top]?
321
+
322
+ def transcription_engine_config=: (
323
+ ::Hash[Symbol, top]
324
+ ) -> ::Hash[Symbol, top]
325
+
326
+ attr_reader transcription_provider: String?
327
+
328
+ def transcription_provider=: (String) -> String
329
+
330
+ attr_reader tts_provider: String?
331
+
332
+ def tts_provider=: (String) -> String
333
+
334
+ attr_reader voice: String?
335
+
336
+ def voice=: (String) -> String
337
+
338
+ attr_reader voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings?
339
+
340
+ def voice_settings=: (
341
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings
342
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings
343
+
344
+ def initialize: (
345
+ language: String,
346
+ ?speech_model: String,
347
+ ?transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine,
348
+ ?transcription_engine_config: ::Hash[Symbol, top],
349
+ ?transcription_provider: String,
350
+ ?tts_provider: String,
351
+ ?voice: String,
352
+ ?voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings
353
+ ) -> void
354
+
355
+ def to_hash: -> {
356
+ language: String,
357
+ speech_model: String,
358
+ transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine,
359
+ transcription_engine_config: ::Hash[Symbol, top],
360
+ transcription_provider: String,
361
+ tts_provider: String,
362
+ voice: String,
363
+ voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings
364
+ }
365
+
366
+ type transcription_engine =
367
+ :Google
368
+ | :Telnyx
369
+ | :Deepgram
370
+ | :Azure
371
+ | :xAI
372
+ | :AssemblyAI
373
+ | :Speechmatics
374
+ | :Soniox
375
+ | :A
376
+ | :B
377
+
378
+ module TranscriptionEngine
379
+ extend Telnyx::Internal::Type::Enum
380
+
381
+ GOOGLE: :Google
382
+ TELNYX: :Telnyx
383
+ DEEPGRAM: :Deepgram
384
+ AZURE: :Azure
385
+ X_AI: :xAI
386
+ ASSEMBLY_AI: :AssemblyAI
387
+ SPEECHMATICS: :Speechmatics
388
+ SONIOX: :Soniox
389
+ A: :A
390
+ B: :B
391
+
392
+ def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::transcription_engine]
393
+ end
394
+
395
+ type voice_settings =
396
+ Telnyx::Calls::ElevenLabsVoiceSettings
397
+ | Telnyx::Calls::TelnyxVoiceSettings
398
+ | Telnyx::Calls::AwsVoiceSettings
399
+ | Telnyx::MinimaxVoiceSettings
400
+ | Telnyx::AzureVoiceSettings
401
+ | Telnyx::RimeVoiceSettings
402
+ | Telnyx::ResembleVoiceSettings
403
+ | Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::VoiceSettings::Inworld
404
+ | Telnyx::XaiVoiceSettings
405
+
406
+ module VoiceSettings
407
+ extend Telnyx::Internal::Type::Union
408
+
409
+ type inworld = { type: :inworld }
410
+
411
+ class Inworld < Telnyx::Internal::Type::BaseModel
412
+ attr_accessor type: :inworld
413
+
414
+ def initialize: (?type: :inworld) -> void
415
+
416
+ def to_hash: -> { type: :inworld }
417
+ end
418
+
419
+ def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language::voice_settings]
420
+ end
421
+ end
294
422
  end
295
423
 
296
424
  type interruptible = :none | :any | :speech | :dtmf
@@ -319,6 +447,219 @@ module Telnyx
319
447
  def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::interruptible_greeting]
320
448
  end
321
449
 
450
+ type interruption_settings =
451
+ {
452
+ enable: bool,
453
+ interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
454
+ interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
455
+ welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
456
+ }
457
+
458
+ class InterruptionSettings < Telnyx::Internal::Type::BaseModel
459
+ attr_reader enable: bool?
460
+
461
+ def enable=: (bool) -> bool
462
+
463
+ attr_reader interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible?
464
+
465
+ def interruptible=: (
466
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible
467
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible
468
+
469
+ attr_reader interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting?
470
+
471
+ def interruptible_greeting=: (
472
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting
473
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting
474
+
475
+ attr_reader welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible?
476
+
477
+ def welcome_greeting_interruptible=: (
478
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
479
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
480
+
481
+ def initialize: (
482
+ ?enable: bool,
483
+ ?interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
484
+ ?interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
485
+ ?welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
486
+ ) -> void
487
+
488
+ def to_hash: -> {
489
+ enable: bool,
490
+ interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible,
491
+ interruptible_greeting: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting,
492
+ welcome_greeting_interruptible: Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible
493
+ }
494
+
495
+ type interruptible = :none | :any | :speech | :dtmf
496
+
497
+ module Interruptible
498
+ extend Telnyx::Internal::Type::Enum
499
+
500
+ NONE: :none
501
+ ANY: :any
502
+ SPEECH: :speech
503
+ DTMF: :dtmf
504
+
505
+ def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible]
506
+ end
507
+
508
+ type interruptible_greeting = :none | :any | :speech | :dtmf
509
+
510
+ module InterruptibleGreeting
511
+ extend Telnyx::Internal::Type::Enum
512
+
513
+ NONE: :none
514
+ ANY: :any
515
+ SPEECH: :speech
516
+ DTMF: :dtmf
517
+
518
+ def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::interruptible_greeting]
519
+ end
520
+
521
+ type welcome_greeting_interruptible = :none | :any | :speech | :dtmf
522
+
523
+ module WelcomeGreetingInterruptible
524
+ extend Telnyx::Internal::Type::Enum
525
+
526
+ NONE: :none
527
+ ANY: :any
528
+ SPEECH: :speech
529
+ DTMF: :dtmf
530
+
531
+ def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings::welcome_greeting_interruptible]
532
+ end
533
+ end
534
+
535
+ type language =
536
+ {
537
+ language: String,
538
+ speech_model: String,
539
+ transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine,
540
+ transcription_engine_config: ::Hash[Symbol, top],
541
+ transcription_provider: String,
542
+ tts_provider: String,
543
+ voice: String,
544
+ voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings
545
+ }
546
+
547
+ class Language < Telnyx::Internal::Type::BaseModel
548
+ attr_accessor language: String
549
+
550
+ attr_reader speech_model: String?
551
+
552
+ def speech_model=: (String) -> String
553
+
554
+ attr_reader transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine?
555
+
556
+ def transcription_engine=: (
557
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine
558
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine
559
+
560
+ attr_reader transcription_engine_config: ::Hash[Symbol, top]?
561
+
562
+ def transcription_engine_config=: (
563
+ ::Hash[Symbol, top]
564
+ ) -> ::Hash[Symbol, top]
565
+
566
+ attr_reader transcription_provider: String?
567
+
568
+ def transcription_provider=: (String) -> String
569
+
570
+ attr_reader tts_provider: String?
571
+
572
+ def tts_provider=: (String) -> String
573
+
574
+ attr_reader voice: String?
575
+
576
+ def voice=: (String) -> String
577
+
578
+ attr_reader voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings?
579
+
580
+ def voice_settings=: (
581
+ Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings
582
+ ) -> Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings
583
+
584
+ def initialize: (
585
+ language: String,
586
+ ?speech_model: String,
587
+ ?transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine,
588
+ ?transcription_engine_config: ::Hash[Symbol, top],
589
+ ?transcription_provider: String,
590
+ ?tts_provider: String,
591
+ ?voice: String,
592
+ ?voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings
593
+ ) -> void
594
+
595
+ def to_hash: -> {
596
+ language: String,
597
+ speech_model: String,
598
+ transcription_engine: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine,
599
+ transcription_engine_config: ::Hash[Symbol, top],
600
+ transcription_provider: String,
601
+ tts_provider: String,
602
+ voice: String,
603
+ voice_settings: Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings
604
+ }
605
+
606
+ type transcription_engine =
607
+ :Google
608
+ | :Telnyx
609
+ | :Deepgram
610
+ | :Azure
611
+ | :xAI
612
+ | :AssemblyAI
613
+ | :Speechmatics
614
+ | :Soniox
615
+ | :A
616
+ | :B
617
+
618
+ module TranscriptionEngine
619
+ extend Telnyx::Internal::Type::Enum
620
+
621
+ GOOGLE: :Google
622
+ TELNYX: :Telnyx
623
+ DEEPGRAM: :Deepgram
624
+ AZURE: :Azure
625
+ X_AI: :xAI
626
+ ASSEMBLY_AI: :AssemblyAI
627
+ SPEECHMATICS: :Speechmatics
628
+ SONIOX: :Soniox
629
+ A: :A
630
+ B: :B
631
+
632
+ def self?.values: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::transcription_engine]
633
+ end
634
+
635
+ type voice_settings =
636
+ Telnyx::Calls::ElevenLabsVoiceSettings
637
+ | Telnyx::Calls::TelnyxVoiceSettings
638
+ | Telnyx::Calls::AwsVoiceSettings
639
+ | Telnyx::MinimaxVoiceSettings
640
+ | Telnyx::AzureVoiceSettings
641
+ | Telnyx::RimeVoiceSettings
642
+ | Telnyx::ResembleVoiceSettings
643
+ | Telnyx::Calls::ActionStartConversationRelayParams::Language::VoiceSettings::Inworld
644
+ | Telnyx::XaiVoiceSettings
645
+
646
+ module VoiceSettings
647
+ extend Telnyx::Internal::Type::Union
648
+
649
+ type inworld = { type: :inworld }
650
+
651
+ class Inworld < Telnyx::Internal::Type::BaseModel
652
+ attr_accessor type: :inworld
653
+
654
+ def initialize: (?type: :inworld) -> void
655
+
656
+ def to_hash: -> { type: :inworld }
657
+ end
658
+
659
+ def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::Language::voice_settings]
660
+ end
661
+ end
662
+
322
663
  type transcription_engine =
323
664
  :Google
324
665
  | :Telnyx
@@ -356,12 +697,22 @@ module Telnyx
356
697
  | Telnyx::AzureVoiceSettings
357
698
  | Telnyx::RimeVoiceSettings
358
699
  | Telnyx::ResembleVoiceSettings
359
- | Telnyx::InworldVoiceSettings
700
+ | Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings::Inworld
360
701
  | Telnyx::XaiVoiceSettings
361
702
 
362
703
  module VoiceSettings
363
704
  extend Telnyx::Internal::Type::Union
364
705
 
706
+ type inworld = { type: :inworld }
707
+
708
+ class Inworld < Telnyx::Internal::Type::BaseModel
709
+ attr_accessor type: :inworld
710
+
711
+ def initialize: (?type: :inworld) -> void
712
+
713
+ def to_hash: -> { type: :inworld }
714
+ end
715
+
365
716
  def self?.variants: -> ::Array[Telnyx::Models::Calls::ActionStartConversationRelayParams::voice_settings]
366
717
  end
367
718
  end
@@ -86,8 +86,8 @@ module Telnyx
86
86
  | Telnyx::Calls::TranscriptionEngineAzureConfig
87
87
  | Telnyx::Calls::TranscriptionEngineXaiConfig
88
88
  | Telnyx::Calls::TranscriptionEngineAssemblyaiConfig
89
- | Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig
90
- | Telnyx::Calls::TranscriptionEngineSonioxConfig
89
+ | Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics
90
+ | Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox
91
91
  | Telnyx::Calls::TranscriptionEngineAConfig
92
92
  | Telnyx::Calls::TranscriptionEngineBConfig
93
93
  | Telnyx::Calls::DeepgramNova2Config
@@ -96,6 +96,179 @@ module Telnyx
96
96
  module TranscriptionEngineConfig
97
97
  extend Telnyx::Internal::Type::Union
98
98
 
99
+ type speechmatics =
100
+ {
101
+ interim_results: bool,
102
+ language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language,
103
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine,
104
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model
105
+ }
106
+
107
+ class Speechmatics < Telnyx::Internal::Type::BaseModel
108
+ attr_reader interim_results: bool?
109
+
110
+ def interim_results=: (bool) -> bool
111
+
112
+ attr_reader language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language?
113
+
114
+ def language=: (
115
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language
116
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language
117
+
118
+ attr_reader transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine?
119
+
120
+ def transcription_engine=: (
121
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine
122
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine
123
+
124
+ attr_reader transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model?
125
+
126
+ def transcription_model=: (
127
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model
128
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model
129
+
130
+ def initialize: (
131
+ ?interim_results: bool,
132
+ ?language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language,
133
+ ?transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine,
134
+ ?transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model
135
+ ) -> void
136
+
137
+ def to_hash: -> {
138
+ interim_results: bool,
139
+ language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language,
140
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine,
141
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model
142
+ }
143
+
144
+ type language =
145
+ :en
146
+ | :ba
147
+ | :eu
148
+ | :gl
149
+ | :ga
150
+ | :mt
151
+ | :mn
152
+ | :sw
153
+ | :ug
154
+ | :cy
155
+ | :ar_en
156
+ | :cmn_en
157
+ | :en_ms
158
+ | :en_ta
159
+ | :tl
160
+ | :"es-bilingual-en"
161
+ | :cmn_en_ms_ta
162
+
163
+ module Language
164
+ extend Telnyx::Internal::Type::Enum
165
+
166
+ EN: :en
167
+ BA: :ba
168
+ EU: :eu
169
+ GL: :gl
170
+ GA: :ga
171
+ MT: :mt
172
+ MN: :mn
173
+ SW: :sw
174
+ UG: :ug
175
+ CY: :cy
176
+ AR_EN: :ar_en
177
+ CMN_EN: :cmn_en
178
+ EN_MS: :en_ms
179
+ EN_TA: :en_ta
180
+ TL: :tl
181
+ ES_BILINGUAL_EN: :"es-bilingual-en"
182
+ CMN_EN_MS_TA: :cmn_en_ms_ta
183
+
184
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::language]
185
+ end
186
+
187
+ type transcription_engine = :Speechmatics
188
+
189
+ module TranscriptionEngine
190
+ extend Telnyx::Internal::Type::Enum
191
+
192
+ SPEECHMATICS: :Speechmatics
193
+
194
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_engine]
195
+ end
196
+
197
+ type transcription_model = :"speechmatics/standard"
198
+
199
+ module TranscriptionModel
200
+ extend Telnyx::Internal::Type::Enum
201
+
202
+ SPEECHMATICS_STANDARD: :"speechmatics/standard"
203
+
204
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::transcription_model]
205
+ end
206
+ end
207
+
208
+ type soniox =
209
+ {
210
+ transcription_engine: :Soniox,
211
+ enable_endpoint_detection: bool,
212
+ interim_results: bool,
213
+ language: String,
214
+ max_endpoint_delay_ms: Integer,
215
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model
216
+ }
217
+
218
+ class Soniox < Telnyx::Internal::Type::BaseModel
219
+ attr_accessor transcription_engine: :Soniox
220
+
221
+ attr_reader enable_endpoint_detection: bool?
222
+
223
+ def enable_endpoint_detection=: (bool) -> bool
224
+
225
+ attr_reader interim_results: bool?
226
+
227
+ def interim_results=: (bool) -> bool
228
+
229
+ attr_reader language: String?
230
+
231
+ def language=: (String) -> String
232
+
233
+ attr_reader max_endpoint_delay_ms: Integer?
234
+
235
+ def max_endpoint_delay_ms=: (Integer) -> Integer
236
+
237
+ attr_reader transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model?
238
+
239
+ def transcription_model=: (
240
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model
241
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model
242
+
243
+ def initialize: (
244
+ ?enable_endpoint_detection: bool,
245
+ ?interim_results: bool,
246
+ ?language: String,
247
+ ?max_endpoint_delay_ms: Integer,
248
+ ?transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model,
249
+ ?transcription_engine: :Soniox
250
+ ) -> void
251
+
252
+ def to_hash: -> {
253
+ transcription_engine: :Soniox,
254
+ enable_endpoint_detection: bool,
255
+ interim_results: bool,
256
+ language: String,
257
+ max_endpoint_delay_ms: Integer,
258
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model
259
+ }
260
+
261
+ type transcription_model = :"soniox/stt-rt-v4"
262
+
263
+ module TranscriptionModel
264
+ extend Telnyx::Internal::Type::Enum
265
+
266
+ SONIOX_STT_RT_V4: :"soniox/stt-rt-v4"
267
+
268
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::transcription_model]
269
+ end
270
+ end
271
+
99
272
  def self?.variants: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::transcription_engine_config]
100
273
  end
101
274
  end