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
@@ -56,8 +56,8 @@ module Telnyx
56
56
  Telnyx::Calls::TranscriptionEngineAzureConfig,
57
57
  Telnyx::Calls::TranscriptionEngineXaiConfig,
58
58
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
59
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
60
- Telnyx::Calls::TranscriptionEngineSonioxConfig,
59
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics,
60
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox,
61
61
  Telnyx::Calls::TranscriptionEngineAConfig,
62
62
  Telnyx::Calls::TranscriptionEngineBConfig,
63
63
  Telnyx::Calls::DeepgramNova2Config,
@@ -77,8 +77,8 @@ module Telnyx
77
77
  Telnyx::Calls::TranscriptionEngineAzureConfig::OrHash,
78
78
  Telnyx::Calls::TranscriptionEngineXaiConfig::OrHash,
79
79
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
80
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
81
- Telnyx::Calls::TranscriptionEngineSonioxConfig::OrHash,
80
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::OrHash,
81
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::OrHash,
82
82
  Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
83
83
  Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
84
84
  Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -110,8 +110,8 @@ module Telnyx
110
110
  Telnyx::Calls::TranscriptionEngineAzureConfig::OrHash,
111
111
  Telnyx::Calls::TranscriptionEngineXaiConfig::OrHash,
112
112
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
113
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
114
- Telnyx::Calls::TranscriptionEngineSonioxConfig::OrHash,
113
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::OrHash,
114
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::OrHash,
115
115
  Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
116
116
  Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
117
117
  Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -152,8 +152,8 @@ module Telnyx
152
152
  Telnyx::Calls::TranscriptionEngineAzureConfig,
153
153
  Telnyx::Calls::TranscriptionEngineXaiConfig,
154
154
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
155
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
156
- Telnyx::Calls::TranscriptionEngineSonioxConfig,
155
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics,
156
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox,
157
157
  Telnyx::Calls::TranscriptionEngineAConfig,
158
158
  Telnyx::Calls::TranscriptionEngineBConfig,
159
159
  Telnyx::Calls::DeepgramNova2Config,
@@ -253,8 +253,8 @@ module Telnyx
253
253
  Telnyx::Calls::TranscriptionEngineAzureConfig,
254
254
  Telnyx::Calls::TranscriptionEngineXaiConfig,
255
255
  Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
256
- Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
257
- Telnyx::Calls::TranscriptionEngineSonioxConfig,
256
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics,
257
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox,
258
258
  Telnyx::Calls::TranscriptionEngineAConfig,
259
259
  Telnyx::Calls::TranscriptionEngineBConfig,
260
260
  Telnyx::Calls::DeepgramNova2Config,
@@ -262,6 +262,429 @@ module Telnyx
262
262
  )
263
263
  end
264
264
 
265
+ class Speechmatics < Telnyx::Internal::Type::BaseModel
266
+ OrHash =
267
+ T.type_alias do
268
+ T.any(
269
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics,
270
+ Telnyx::Internal::AnyHash
271
+ )
272
+ end
273
+
274
+ # Whether to send also interim results. If set to false, only final results will
275
+ # be sent.
276
+ sig { returns(T.nilable(T::Boolean)) }
277
+ attr_reader :interim_results
278
+
279
+ sig { params(interim_results: T::Boolean).void }
280
+ attr_writer :interim_results
281
+
282
+ # Language to use for speech recognition
283
+ sig do
284
+ returns(
285
+ T.nilable(
286
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::OrSymbol
287
+ )
288
+ )
289
+ end
290
+ attr_reader :language
291
+
292
+ sig do
293
+ params(
294
+ language:
295
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::OrSymbol
296
+ ).void
297
+ end
298
+ attr_writer :language
299
+
300
+ # Engine identifier for Speechmatics transcription service
301
+ sig do
302
+ returns(
303
+ T.nilable(
304
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::OrSymbol
305
+ )
306
+ )
307
+ end
308
+ attr_reader :transcription_engine
309
+
310
+ sig do
311
+ params(
312
+ transcription_engine:
313
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::OrSymbol
314
+ ).void
315
+ end
316
+ attr_writer :transcription_engine
317
+
318
+ # The model to use for transcription.
319
+ sig do
320
+ returns(
321
+ T.nilable(
322
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::OrSymbol
323
+ )
324
+ )
325
+ end
326
+ attr_reader :transcription_model
327
+
328
+ sig do
329
+ params(
330
+ transcription_model:
331
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::OrSymbol
332
+ ).void
333
+ end
334
+ attr_writer :transcription_model
335
+
336
+ sig do
337
+ params(
338
+ interim_results: T::Boolean,
339
+ language:
340
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::OrSymbol,
341
+ transcription_engine:
342
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::OrSymbol,
343
+ transcription_model:
344
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::OrSymbol
345
+ ).returns(T.attached_class)
346
+ end
347
+ def self.new(
348
+ # Whether to send also interim results. If set to false, only final results will
349
+ # be sent.
350
+ interim_results: nil,
351
+ # Language to use for speech recognition
352
+ language: nil,
353
+ # Engine identifier for Speechmatics transcription service
354
+ transcription_engine: nil,
355
+ # The model to use for transcription.
356
+ transcription_model: nil
357
+ )
358
+ end
359
+
360
+ sig do
361
+ override.returns(
362
+ {
363
+ interim_results: T::Boolean,
364
+ language:
365
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::OrSymbol,
366
+ transcription_engine:
367
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::OrSymbol,
368
+ transcription_model:
369
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::OrSymbol
370
+ }
371
+ )
372
+ end
373
+ def to_hash
374
+ end
375
+
376
+ # Language to use for speech recognition
377
+ module Language
378
+ extend Telnyx::Internal::Type::Enum
379
+
380
+ TaggedSymbol =
381
+ T.type_alias do
382
+ T.all(
383
+ Symbol,
384
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language
385
+ )
386
+ end
387
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
388
+
389
+ EN =
390
+ T.let(
391
+ :en,
392
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
393
+ )
394
+ BA =
395
+ T.let(
396
+ :ba,
397
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
398
+ )
399
+ EU =
400
+ T.let(
401
+ :eu,
402
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
403
+ )
404
+ GL =
405
+ T.let(
406
+ :gl,
407
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
408
+ )
409
+ GA =
410
+ T.let(
411
+ :ga,
412
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
413
+ )
414
+ MT =
415
+ T.let(
416
+ :mt,
417
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
418
+ )
419
+ MN =
420
+ T.let(
421
+ :mn,
422
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
423
+ )
424
+ SW =
425
+ T.let(
426
+ :sw,
427
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
428
+ )
429
+ UG =
430
+ T.let(
431
+ :ug,
432
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
433
+ )
434
+ CY =
435
+ T.let(
436
+ :cy,
437
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
438
+ )
439
+ AR_EN =
440
+ T.let(
441
+ :ar_en,
442
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
443
+ )
444
+ CMN_EN =
445
+ T.let(
446
+ :cmn_en,
447
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
448
+ )
449
+ EN_MS =
450
+ T.let(
451
+ :en_ms,
452
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
453
+ )
454
+ EN_TA =
455
+ T.let(
456
+ :en_ta,
457
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
458
+ )
459
+ TL =
460
+ T.let(
461
+ :tl,
462
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
463
+ )
464
+ ES_BILINGUAL_EN =
465
+ T.let(
466
+ :"es-bilingual-en",
467
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
468
+ )
469
+ CMN_EN_MS_TA =
470
+ T.let(
471
+ :cmn_en_ms_ta,
472
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
473
+ )
474
+
475
+ sig do
476
+ override.returns(
477
+ T::Array[
478
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language::TaggedSymbol
479
+ ]
480
+ )
481
+ end
482
+ def self.values
483
+ end
484
+ end
485
+
486
+ # Engine identifier for Speechmatics transcription service
487
+ module TranscriptionEngine
488
+ extend Telnyx::Internal::Type::Enum
489
+
490
+ TaggedSymbol =
491
+ T.type_alias do
492
+ T.all(
493
+ Symbol,
494
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine
495
+ )
496
+ end
497
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
498
+
499
+ SPEECHMATICS =
500
+ T.let(
501
+ :Speechmatics,
502
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::TaggedSymbol
503
+ )
504
+
505
+ sig do
506
+ override.returns(
507
+ T::Array[
508
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine::TaggedSymbol
509
+ ]
510
+ )
511
+ end
512
+ def self.values
513
+ end
514
+ end
515
+
516
+ # The model to use for transcription.
517
+ module TranscriptionModel
518
+ extend Telnyx::Internal::Type::Enum
519
+
520
+ TaggedSymbol =
521
+ T.type_alias do
522
+ T.all(
523
+ Symbol,
524
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel
525
+ )
526
+ end
527
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
528
+
529
+ SPEECHMATICS_STANDARD =
530
+ T.let(
531
+ :"speechmatics/standard",
532
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::TaggedSymbol
533
+ )
534
+
535
+ sig do
536
+ override.returns(
537
+ T::Array[
538
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel::TaggedSymbol
539
+ ]
540
+ )
541
+ end
542
+ def self.values
543
+ end
544
+ end
545
+ end
546
+
547
+ class Soniox < Telnyx::Internal::Type::BaseModel
548
+ OrHash =
549
+ T.type_alias do
550
+ T.any(
551
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox,
552
+ Telnyx::Internal::AnyHash
553
+ )
554
+ end
555
+
556
+ # Engine identifier for Soniox transcription service
557
+ sig { returns(Symbol) }
558
+ attr_accessor :transcription_engine
559
+
560
+ # When true, Soniox emits end-of-utterance events at the cadence configured by
561
+ # `max_endpoint_delay_ms`.
562
+ sig { returns(T.nilable(T::Boolean)) }
563
+ attr_reader :enable_endpoint_detection
564
+
565
+ sig { params(enable_endpoint_detection: T::Boolean).void }
566
+ attr_writer :enable_endpoint_detection
567
+
568
+ # Whether to send also interim results. If set to false, only final results will
569
+ # be sent.
570
+ sig { returns(T.nilable(T::Boolean)) }
571
+ attr_reader :interim_results
572
+
573
+ sig { params(interim_results: T::Boolean).void }
574
+ attr_writer :interim_results
575
+
576
+ # ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
577
+ # Soniox auto-detect supported languages multilingually.
578
+ sig { returns(T.nilable(String)) }
579
+ attr_reader :language
580
+
581
+ sig { params(language: String).void }
582
+ attr_writer :language
583
+
584
+ # Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
585
+ # Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
586
+ sig { returns(T.nilable(Integer)) }
587
+ attr_reader :max_endpoint_delay_ms
588
+
589
+ sig { params(max_endpoint_delay_ms: Integer).void }
590
+ attr_writer :max_endpoint_delay_ms
591
+
592
+ # The model to use for transcription.
593
+ sig do
594
+ returns(
595
+ T.nilable(
596
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::OrSymbol
597
+ )
598
+ )
599
+ end
600
+ attr_reader :transcription_model
601
+
602
+ sig do
603
+ params(
604
+ transcription_model:
605
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::OrSymbol
606
+ ).void
607
+ end
608
+ attr_writer :transcription_model
609
+
610
+ sig do
611
+ params(
612
+ enable_endpoint_detection: T::Boolean,
613
+ interim_results: T::Boolean,
614
+ language: String,
615
+ max_endpoint_delay_ms: Integer,
616
+ transcription_model:
617
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::OrSymbol,
618
+ transcription_engine: Symbol
619
+ ).returns(T.attached_class)
620
+ end
621
+ def self.new(
622
+ # When true, Soniox emits end-of-utterance events at the cadence configured by
623
+ # `max_endpoint_delay_ms`.
624
+ enable_endpoint_detection: nil,
625
+ # Whether to send also interim results. If set to false, only final results will
626
+ # be sent.
627
+ interim_results: nil,
628
+ # ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
629
+ # Soniox auto-detect supported languages multilingually.
630
+ language: nil,
631
+ # Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
632
+ # Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
633
+ max_endpoint_delay_ms: nil,
634
+ # The model to use for transcription.
635
+ transcription_model: nil,
636
+ # Engine identifier for Soniox transcription service
637
+ transcription_engine: :Soniox
638
+ )
639
+ end
640
+
641
+ sig do
642
+ override.returns(
643
+ {
644
+ transcription_engine: Symbol,
645
+ enable_endpoint_detection: T::Boolean,
646
+ interim_results: T::Boolean,
647
+ language: String,
648
+ max_endpoint_delay_ms: Integer,
649
+ transcription_model:
650
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::OrSymbol
651
+ }
652
+ )
653
+ end
654
+ def to_hash
655
+ end
656
+
657
+ # The model to use for transcription.
658
+ module TranscriptionModel
659
+ extend Telnyx::Internal::Type::Enum
660
+
661
+ TaggedSymbol =
662
+ T.type_alias do
663
+ T.all(
664
+ Symbol,
665
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel
666
+ )
667
+ end
668
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
669
+
670
+ SONIOX_STT_RT_V4 =
671
+ T.let(
672
+ :"soniox/stt-rt-v4",
673
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::TaggedSymbol
674
+ )
675
+
676
+ sig do
677
+ override.returns(
678
+ T::Array[
679
+ Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel::TaggedSymbol
680
+ ]
681
+ )
682
+ end
683
+ def self.values
684
+ end
685
+ end
686
+ end
687
+
265
688
  sig do
266
689
  override.returns(
267
690
  T::Array[
@@ -151,7 +151,7 @@ module Telnyx
151
151
  Telnyx::AzureVoiceSettings,
152
152
  Telnyx::RimeVoiceSettings,
153
153
  Telnyx::ResembleVoiceSettings,
154
- Telnyx::InworldVoiceSettings,
154
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld,
155
155
  Telnyx::XaiVoiceSettings
156
156
  )
157
157
  )
@@ -170,7 +170,7 @@ module Telnyx
170
170
  Telnyx::AzureVoiceSettings::OrHash,
171
171
  Telnyx::RimeVoiceSettings::OrHash,
172
172
  Telnyx::ResembleVoiceSettings::OrHash,
173
- Telnyx::InworldVoiceSettings::OrHash,
173
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
174
174
  Telnyx::XaiVoiceSettings::OrHash
175
175
  )
176
176
  ).void
@@ -198,7 +198,7 @@ module Telnyx
198
198
  Telnyx::AzureVoiceSettings::OrHash,
199
199
  Telnyx::RimeVoiceSettings::OrHash,
200
200
  Telnyx::ResembleVoiceSettings::OrHash,
201
- Telnyx::InworldVoiceSettings::OrHash,
201
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
202
202
  Telnyx::XaiVoiceSettings::OrHash
203
203
  ),
204
204
  request_options: Telnyx::RequestOptions::OrHash
@@ -297,7 +297,7 @@ module Telnyx
297
297
  Telnyx::AzureVoiceSettings,
298
298
  Telnyx::RimeVoiceSettings,
299
299
  Telnyx::ResembleVoiceSettings,
300
- Telnyx::InworldVoiceSettings,
300
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld,
301
301
  Telnyx::XaiVoiceSettings
302
302
  ),
303
303
  request_options: Telnyx::RequestOptions
@@ -565,11 +565,36 @@ module Telnyx
565
565
  Telnyx::AzureVoiceSettings,
566
566
  Telnyx::RimeVoiceSettings,
567
567
  Telnyx::ResembleVoiceSettings,
568
- Telnyx::InworldVoiceSettings,
568
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld,
569
569
  Telnyx::XaiVoiceSettings
570
570
  )
571
571
  end
572
572
 
573
+ class Inworld < Telnyx::Internal::Type::BaseModel
574
+ OrHash =
575
+ T.type_alias do
576
+ T.any(
577
+ Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld,
578
+ Telnyx::Internal::AnyHash
579
+ )
580
+ end
581
+
582
+ # Voice settings provider type
583
+ sig { returns(Symbol) }
584
+ attr_accessor :type
585
+
586
+ sig { params(type: Symbol).returns(T.attached_class) }
587
+ def self.new(
588
+ # Voice settings provider type
589
+ type: :inworld
590
+ )
591
+ end
592
+
593
+ sig { override.returns({ type: Symbol }) }
594
+ def to_hash
595
+ end
596
+ end
597
+
573
598
  sig do
574
599
  override.returns(
575
600
  T::Array[
@@ -14,6 +14,10 @@ module Telnyx
14
14
  sig { returns(String) }
15
15
  attr_accessor :messaging_profile_id
16
16
 
17
+ # The ID of the AI assistant associated with this messaging profile.
18
+ sig { returns(T.nilable(String)) }
19
+ attr_accessor :ai_assistant_id
20
+
17
21
  # The alphanumeric sender ID to use when sending to destinations that require an
18
22
  # alphanumeric sender ID.
19
23
  sig { returns(T.nilable(String)) }
@@ -160,6 +164,7 @@ module Telnyx
160
164
  sig do
161
165
  params(
162
166
  messaging_profile_id: String,
167
+ ai_assistant_id: T.nilable(String),
163
168
  alpha_sender: T.nilable(String),
164
169
  daily_spend_limit: String,
165
170
  daily_spend_limit_enabled: T::Boolean,
@@ -183,6 +188,8 @@ module Telnyx
183
188
  end
184
189
  def self.new(
185
190
  messaging_profile_id:,
191
+ # The ID of the AI assistant associated with this messaging profile.
192
+ ai_assistant_id: nil,
186
193
  # The alphanumeric sender ID to use when sending to destinations that require an
187
194
  # alphanumeric sender ID.
188
195
  alpha_sender: nil,
@@ -243,6 +250,7 @@ module Telnyx
243
250
  override.returns(
244
251
  {
245
252
  messaging_profile_id: String,
253
+ ai_assistant_id: T.nilable(String),
246
254
  alpha_sender: T.nilable(String),
247
255
  daily_spend_limit: String,
248
256
  daily_spend_limit_enabled: T::Boolean,
@@ -0,0 +1,93 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Models
5
+ class SipRegistrationStatusRetrieveParams < Telnyx::Internal::Type::BaseModel
6
+ extend Telnyx::Internal::Type::RequestParameters::Converter
7
+ include Telnyx::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Telnyx::SipRegistrationStatusRetrieveParams,
13
+ Telnyx::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Identifier of the UAC connection to look up.
18
+ sig { returns(String) }
19
+ attr_accessor :connection_id
20
+
21
+ # The kind of credential to look up. Only `uac_external_credential` is supported
22
+ # today.
23
+ sig do
24
+ returns(
25
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol
26
+ )
27
+ end
28
+ attr_accessor :credential_type
29
+
30
+ sig do
31
+ params(
32
+ connection_id: String,
33
+ credential_type:
34
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
35
+ request_options: Telnyx::RequestOptions::OrHash
36
+ ).returns(T.attached_class)
37
+ end
38
+ def self.new(
39
+ # Identifier of the UAC connection to look up.
40
+ connection_id:,
41
+ # The kind of credential to look up. Only `uac_external_credential` is supported
42
+ # today.
43
+ credential_type:,
44
+ request_options: {}
45
+ )
46
+ end
47
+
48
+ sig do
49
+ override.returns(
50
+ {
51
+ connection_id: String,
52
+ credential_type:
53
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::OrSymbol,
54
+ request_options: Telnyx::RequestOptions
55
+ }
56
+ )
57
+ end
58
+ def to_hash
59
+ end
60
+
61
+ # The kind of credential to look up. Only `uac_external_credential` is supported
62
+ # today.
63
+ module CredentialType
64
+ extend Telnyx::Internal::Type::Enum
65
+
66
+ TaggedSymbol =
67
+ T.type_alias do
68
+ T.all(
69
+ Symbol,
70
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType
71
+ )
72
+ end
73
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
74
+
75
+ UAC_EXTERNAL_CREDENTIAL =
76
+ T.let(
77
+ :uac_external_credential,
78
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
79
+ )
80
+
81
+ sig do
82
+ override.returns(
83
+ T::Array[
84
+ Telnyx::SipRegistrationStatusRetrieveParams::CredentialType::TaggedSymbol
85
+ ]
86
+ )
87
+ end
88
+ def self.values
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end