telnyx 5.156.0 → 5.157.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 (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +209 -0
  5. data/lib/telnyx/models/ai/anthropic/v1_messages_response.rb +12 -0
  6. data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
  7. data/lib/telnyx/models/ai/assistant_tool.rb +25 -1
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
  9. data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
  10. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rb +103 -0
  11. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rb +54 -0
  12. data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
  13. data/lib/telnyx/models/ai/pay_tool_params.rb +46 -0
  14. data/lib/telnyx/models/ai/tool_create_params.rb +7 -1
  15. data/lib/telnyx/models/ai/tool_update_params.rb +7 -1
  16. data/lib/telnyx/models/ai/transcription_settings.rb +3 -3
  17. data/lib/telnyx/models/call_dial_params.rb +13 -1
  18. data/lib/telnyx/models/calls/transcription_config.rb +8 -4
  19. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
  20. data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
  21. data/lib/telnyx/models/inbound_message.rb +278 -28
  22. data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
  23. data/lib/telnyx/models/managed_account_list_params.rb +45 -3
  24. data/lib/telnyx/models/requirement_list_params.rb +10 -1
  25. data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
  26. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
  27. data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
  28. data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
  29. data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
  30. data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
  31. data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
  32. data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
  33. data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
  34. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
  35. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
  36. data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
  37. data/lib/telnyx/models/verify_profile.rb +2 -2
  38. data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
  39. data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
  40. data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
  41. data/lib/telnyx/resources/ai/anthropic.rb +20 -0
  42. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  43. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  44. data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
  45. data/lib/telnyx/resources/ai/conversations.rb +5 -0
  46. data/lib/telnyx/resources/ai/tools.rb +5 -2
  47. data/lib/telnyx/resources/ai.rb +4 -0
  48. data/lib/telnyx/resources/calls.rb +3 -1
  49. data/lib/telnyx/resources/requirements.rb +13 -3
  50. data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
  51. data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
  52. data/lib/telnyx/resources/storage.rb +6 -0
  53. data/lib/telnyx/version.rb +1 -1
  54. data/lib/telnyx.rb +20 -0
  55. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
  56. data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
  57. data/rbi/telnyx/models/ai/assistant_create_params.rbi +8 -4
  58. data/rbi/telnyx/models/ai/assistant_tool.rbi +37 -1
  59. data/rbi/telnyx/models/ai/assistant_update_params.rbi +8 -4
  60. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +8 -4
  61. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
  62. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
  63. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -6
  64. data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
  65. data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
  66. data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
  67. data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
  68. data/rbi/telnyx/models/call_dial_params.rbi +19 -0
  69. data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
  70. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
  71. data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
  72. data/rbi/telnyx/models/inbound_message.rbi +324 -58
  73. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
  74. data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
  75. data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
  76. data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
  77. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
  78. data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
  79. data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
  80. data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
  81. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
  82. data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
  83. data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
  84. data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
  85. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
  86. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
  87. data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
  88. data/rbi/telnyx/models/verify_profile.rbi +2 -2
  89. data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
  90. data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
  91. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
  92. data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
  93. data/rbi/telnyx/resources/ai/assistants/versions.rbi +2 -1
  94. data/rbi/telnyx/resources/ai/assistants.rbi +4 -2
  95. data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
  96. data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
  97. data/rbi/telnyx/resources/ai/tools.rbi +4 -0
  98. data/rbi/telnyx/resources/ai.rbi +3 -0
  99. data/rbi/telnyx/resources/calls.rbi +7 -0
  100. data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
  101. data/rbi/telnyx/resources/requirements.rbi +8 -0
  102. data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
  103. data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
  104. data/rbi/telnyx/resources/storage.rbi +5 -0
  105. data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
  106. data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
  107. data/sig/telnyx/models/ai/assistant_tool.rbs +13 -0
  108. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
  109. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
  110. data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
  111. data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
  112. data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
  113. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
  114. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  115. data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
  116. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
  117. data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
  118. data/sig/telnyx/models/inbound_message.rbs +204 -35
  119. data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
  120. data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
  121. data/sig/telnyx/models/requirement_list_params.rbs +8 -1
  122. data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
  123. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
  124. data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
  125. data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
  126. data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
  127. data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
  128. data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
  129. data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
  130. data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
  131. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
  132. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
  133. data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
  134. data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
  135. data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
  136. data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
  137. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  138. data/sig/telnyx/resources/ai/tools.rbs +2 -0
  139. data/sig/telnyx/resources/ai.rbs +2 -0
  140. data/sig/telnyx/resources/calls.rbs +1 -0
  141. data/sig/telnyx/resources/requirements.rbs +2 -0
  142. data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
  143. data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
  144. data/sig/telnyx/resources/storage.rbs +2 -0
  145. metadata +62 -2
@@ -38,6 +38,11 @@ module Telnyx
38
38
  # @return [Hash{Symbol=>Object}, nil]
39
39
  optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
40
40
 
41
+ # @!attribute pay
42
+ #
43
+ # @return [Telnyx::Models::AI::PayToolParams, nil]
44
+ optional :pay, -> { Telnyx::AI::PayToolParams }
45
+
41
46
  # @!attribute retrieval
42
47
  #
43
48
  # @return [Hash{Symbol=>Object}, nil]
@@ -53,13 +58,14 @@ module Telnyx
53
58
  # @return [Hash{Symbol=>Object}, nil]
54
59
  optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
55
60
 
56
- # @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
61
+ # @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
57
62
  # @param display_name [String]
58
63
  # @param type [String]
59
64
  # @param client_side_tool [Hash{Symbol=>Object}]
60
65
  # @param function [Hash{Symbol=>Object}]
61
66
  # @param handoff [Hash{Symbol=>Object}]
62
67
  # @param invite [Hash{Symbol=>Object}]
68
+ # @param pay [Telnyx::Models::AI::PayToolParams]
63
69
  # @param retrieval [Hash{Symbol=>Object}]
64
70
  # @param timeout_ms [Integer]
65
71
  # @param webhook [Hash{Symbol=>Object}]
@@ -38,6 +38,11 @@ module Telnyx
38
38
  # @return [Hash{Symbol=>Object}, nil]
39
39
  optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
40
40
 
41
+ # @!attribute pay
42
+ #
43
+ # @return [Telnyx::Models::AI::PayToolParams, nil]
44
+ optional :pay, -> { Telnyx::AI::PayToolParams }
45
+
41
46
  # @!attribute retrieval
42
47
  #
43
48
  # @return [Hash{Symbol=>Object}, nil]
@@ -58,13 +63,14 @@ module Telnyx
58
63
  # @return [Hash{Symbol=>Object}, nil]
59
64
  optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
60
65
 
61
- # @!method initialize(tool_id:, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
66
+ # @!method initialize(tool_id:, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
62
67
  # @param tool_id [String]
63
68
  # @param client_side_tool [Hash{Symbol=>Object}]
64
69
  # @param display_name [String]
65
70
  # @param function [Hash{Symbol=>Object}]
66
71
  # @param handoff [Hash{Symbol=>Object}]
67
72
  # @param invite [Hash{Symbol=>Object}]
73
+ # @param pay [Telnyx::Models::AI::PayToolParams]
68
74
  # @param retrieval [Hash{Symbol=>Object}]
69
75
  # @param timeout_ms [Integer]
70
76
  # @param type [String]
@@ -36,7 +36,7 @@ module Telnyx
36
36
  # - `xai/grok-stt` is a multilingual Grok STT model.
37
37
  # - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
38
38
  # detection and configurable endpointing.
39
- # - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
39
+ # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
40
40
  # language detection.
41
41
  #
42
42
  # @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
@@ -80,7 +80,7 @@ module Telnyx
80
80
  # - `xai/grok-stt` is a multilingual Grok STT model.
81
81
  # - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
82
82
  # detection and configurable endpointing.
83
- # - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
83
+ # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
84
84
  # language detection.
85
85
  #
86
86
  # @see Telnyx::Models::AI::TranscriptionSettings#model
@@ -94,7 +94,7 @@ module Telnyx
94
94
  ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
95
95
  XAI_GROK_STT = :"xai/grok-stt"
96
96
  SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
97
- PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
97
+ NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
98
98
  DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
99
99
  OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
100
100
 
@@ -288,6 +288,16 @@ module Telnyx
288
288
  # @return [Symbol, Telnyx::Models::CallDialParams::RecordTrim, nil]
289
289
  optional :record_trim, enum: -> { Telnyx::CallDialParams::RecordTrim }
290
290
 
291
+ # @!attribute retry_on_timeout
292
+ # Whether to keep trying the remaining routing paths (e.g. alternate
293
+ # providers/gateways) for the same destination after `timeout_secs` is reached for
294
+ # the current attempt. When set to `false`, reaching `timeout_secs` aborts the
295
+ # entire dial attempt and the `call.hangup` webhook reports a `hangup_cause` of
296
+ # `no_answer` instead of `timeout`.
297
+ #
298
+ # @return [Boolean, nil]
299
+ optional :retry_on_timeout, Telnyx::Internal::Type::Boolean
300
+
291
301
  # @!attribute send_digits_on_answer
292
302
  # DTMF digits to send automatically after the called party answers. Useful for
293
303
  # reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once the
@@ -486,7 +496,7 @@ module Telnyx
486
496
  # @return [Symbol, Telnyx::Models::CallDialParams::WebhookURLsMethod, nil]
487
497
  optional :webhook_urls_method, enum: -> { Telnyx::CallDialParams::WebhookURLsMethod }
488
498
 
489
- # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
499
+ # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, retry_on_timeout: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
490
500
  # Some parameter documentations has been truncated, see
491
501
  # {Telnyx::Models::CallDialParams} for more details.
492
502
  #
@@ -558,6 +568,8 @@ module Telnyx
558
568
  #
559
569
  # @param record_trim [Symbol, Telnyx::Models::CallDialParams::RecordTrim] When set to `trim-silence`, silence will be removed from the beginning and end o
560
570
  #
571
+ # @param retry_on_timeout [Boolean] Whether to keep trying the remaining routing paths (e.g. alternate providers/gat
572
+ #
561
573
  # @param send_digits_on_answer [String] DTMF digits to send automatically after the called party answers. Useful for rea
562
574
  #
563
575
  # @param send_silence_when_idle [Boolean] Generate silence RTP packets when no transmission available.
@@ -12,7 +12,11 @@ module Telnyx
12
12
  # controls the language hint), `multi` (no language hint), and language-specific
13
13
  # hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
14
14
  # `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
15
- # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language.
15
+ # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language. For
16
+ # `assemblyai/universal-streaming`, `auto` (or unset) enables native multilingual
17
+ # code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
18
+ # `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
19
+ # that language.
16
20
  #
17
21
  # @return [String, nil]
18
22
  optional :language, String
@@ -29,7 +33,7 @@ module Telnyx
29
33
  # - `xai/grok-stt` for live streaming transcription.
30
34
  # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
31
35
  # automatic language detection.
32
- # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
36
+ # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
33
37
  # detection.
34
38
  # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
35
39
  # unsupported regions require `api_key_ref`.
@@ -66,7 +70,7 @@ module Telnyx
66
70
  # - `xai/grok-stt` for live streaming transcription.
67
71
  # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
68
72
  # automatic language detection.
69
- # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
73
+ # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
70
74
  # detection.
71
75
  # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
72
76
  # unsupported regions require `api_key_ref`.
@@ -89,7 +93,7 @@ module Telnyx
89
93
  ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
90
94
  XAI_GROK_STT = :"xai/grok-stt"
91
95
  SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
92
- PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
96
+ NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
93
97
  AZURE_FAST = :"azure/fast"
94
98
  AZURE_REALTIME = :"azure/realtime"
95
99
  GOOGLE_LATEST_LONG = :"google/latest_long"
@@ -53,7 +53,7 @@ module Telnyx
53
53
  module TranscriptionModel
54
54
  extend Telnyx::Internal::Type::Enum
55
55
 
56
- PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
56
+ NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
57
57
 
58
58
  # @!method self.values
59
59
  # @return [Array<Symbol>]
@@ -43,26 +43,45 @@ module Telnyx
43
43
  # @return [String, nil]
44
44
  optional :created_at, String
45
45
 
46
+ # @!attribute effective_end_at
47
+ # When this version was superseded. NULL means this is the active or pending
48
+ # version.
49
+ #
50
+ # @return [Time, nil]
51
+ optional :effective_end_at, Time, nil?: true
52
+
53
+ # @!attribute effective_start_at
54
+ # When this version became (or will become) active.
55
+ #
56
+ # @return [Time, nil]
57
+ optional :effective_start_at, Time, nil?: true
58
+
46
59
  # @!attribute record_type
47
60
  # Identifies the type of the resource.
48
61
  #
49
62
  # @return [String, nil]
50
63
  optional :record_type, String
51
64
 
52
- # @!attribute requirements_types
65
+ # @!attribute requirement_types
53
66
  # Lists the requirement types necessary to fulfill this requirement
54
67
  #
55
68
  # @return [Array<Telnyx::Models::DocReqsRequirementType>, nil]
56
- optional :requirements_types, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DocReqsRequirementType] }
69
+ optional :requirement_types, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DocReqsRequirementType] }
57
70
 
58
71
  # @!attribute updated_at
59
72
  # ISO 8601 formatted date-time indicating when the resource was last updated.
60
73
  #
61
74
  # @return [String, nil]
62
75
  optional :updated_at, String
76
+
77
+ # @!attribute version
78
+ # Version number. Increments with each new version. Defaults to 1.
79
+ #
80
+ # @return [Integer, nil]
81
+ optional :version, Integer
63
82
  end
64
83
 
65
- # @!method initialize(id: nil, action: nil, country_code: nil, created_at: nil, locality: nil, phone_number_type: nil, record_type: nil, requirements_types: nil, updated_at: nil)
84
+ # @!method initialize(id: nil, action: nil, country_code: nil, created_at: nil, effective_end_at: nil, effective_start_at: nil, locality: nil, phone_number_type: nil, record_type: nil, requirement_types: nil, updated_at: nil, version: nil)
66
85
  # Some parameter documentations has been truncated, see
67
86
  # {Telnyx::Models::DocReqsRequirement} for more details.
68
87
  #
@@ -74,15 +93,21 @@ module Telnyx
74
93
  #
75
94
  # @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
76
95
  #
96
+ # @param effective_end_at [Time, nil] When this version was superseded. NULL means this is the active or pending versi
97
+ #
98
+ # @param effective_start_at [Time, nil] When this version became (or will become) active.
99
+ #
77
100
  # @param locality [String] The locality where this requirement applies
78
101
  #
79
102
  # @param phone_number_type [Symbol, Telnyx::Models::DocReqsRequirement::PhoneNumberType] Indicates the phone_number_type this requirement applies to. Leave blank if this
80
103
  #
81
104
  # @param record_type [String] Identifies the type of the resource.
82
105
  #
83
- # @param requirements_types [Array<Telnyx::Models::DocReqsRequirementType>] Lists the requirement types necessary to fulfill this requirement
106
+ # @param requirement_types [Array<Telnyx::Models::DocReqsRequirementType>] Lists the requirement types necessary to fulfill this requirement
84
107
  #
85
108
  # @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was last updated.
109
+ #
110
+ # @param version [Integer] Version number. Increments with each new version. Defaults to 1.
86
111
 
87
112
  # Indicates whether this requirement applies to branded_calling, ordering,
88
113
  # porting, or both ordering and porting
@@ -4,68 +4,318 @@ module Telnyx
4
4
  module Models
5
5
  class InboundMessage < Telnyx::Internal::Type::BaseModel
6
6
  # @!attribute id
7
- # Identifies the type of resource.
7
+ #
8
+ # @return [String]
9
+ required :id, String
10
+
11
+ # @!attribute attachments
12
+ #
13
+ # @return [Array<Hash{Symbol=>Object}>]
14
+ required :attachments,
15
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
16
+
17
+ # @!attribute bcc
18
+ #
19
+ # @return [Array<Telnyx::Models::InboundMessage::Bcc>]
20
+ required :bcc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Bcc] }
21
+
22
+ # @!attribute cc
23
+ #
24
+ # @return [Array<Telnyx::Models::InboundMessage::Cc>]
25
+ required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Cc] }
26
+
27
+ # @!attribute created_at
28
+ #
29
+ # @return [Time]
30
+ required :created_at, Time
31
+
32
+ # @!attribute direction
33
+ #
34
+ # @return [Symbol, Telnyx::Models::InboundMessage::Direction]
35
+ required :direction, enum: -> { Telnyx::InboundMessage::Direction }
36
+
37
+ # @!attribute from
38
+ #
39
+ # @return [Telnyx::Models::InboundMessage::From]
40
+ required :from, -> { Telnyx::InboundMessage::From }
41
+
42
+ # @!attribute has_quoted_text
43
+ # Whether conservative plain-text extraction detected a quoted tail. False does
44
+ # not prove that the source contains no quoted content.
45
+ #
46
+ # @return [Boolean]
47
+ required :has_quoted_text, Telnyx::Internal::Type::Boolean
48
+
49
+ # @!attribute headers
50
+ #
51
+ # @return [Hash{Symbol=>Object}]
52
+ required :headers, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
53
+
54
+ # @!attribute html_body_url
55
+ # URL for an offloaded HTML body. Null means the body is not offloaded to a URL;
56
+ # an inline HTML body may still exist but is not returned on list reads.
57
+ # `reply_text` and `has_quoted_text` are computed from the inline plain-text body
58
+ # when present.
8
59
  #
9
60
  # @return [String, nil]
10
- optional :id, String
61
+ required :html_body_url, String, nil?: true
62
+
63
+ # @!attribute in_reply_to
64
+ #
65
+ # @return [String, nil]
66
+ required :in_reply_to, String, nil?: true
67
+
68
+ # @!attribute inbox_id
69
+ #
70
+ # @return [String]
71
+ required :inbox_id, String
72
+
73
+ # @!attribute inline_files
74
+ #
75
+ # @return [Array<Hash{Symbol=>Object}>]
76
+ required :inline_files,
77
+ Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
11
78
 
12
- # @!attribute event_type
13
- # The type of event being delivered.
79
+ # @!attribute message_id
80
+ # RFC Message-ID header.
14
81
  #
15
- # @return [Symbol, Telnyx::Models::InboundMessage::EventType, nil]
16
- optional :event_type, enum: -> { Telnyx::InboundMessage::EventType }
82
+ # @return [String]
83
+ required :message_id, String
17
84
 
18
- # @!attribute occurred_at
19
- # ISO 8601 formatted date indicating when the resource was created.
85
+ # @!attribute read_at
20
86
  #
21
87
  # @return [Time, nil]
22
- optional :occurred_at, Time
88
+ required :read_at, Time, nil?: true
23
89
 
24
- # @!attribute payload
90
+ # @!attribute received_at
25
91
  #
26
- # @return [Telnyx::Models::InboundMessagePayload, nil]
27
- optional :payload, -> { Telnyx::InboundMessagePayload }
92
+ # @return [Time]
93
+ required :received_at, Time
28
94
 
29
95
  # @!attribute record_type
30
- # Identifies the type of the resource.
31
96
  #
32
- # @return [Symbol, Telnyx::Models::InboundMessage::RecordType, nil]
33
- optional :record_type, enum: -> { Telnyx::InboundMessage::RecordType }
97
+ # @return [Symbol, Telnyx::Models::InboundMessage::RecordType]
98
+ required :record_type, enum: -> { Telnyx::InboundMessage::RecordType }
99
+
100
+ # @!attribute references
101
+ # Ordered RFC Message-ID values from the References header.
102
+ #
103
+ # @return [Array<String>]
104
+ required :references, Telnyx::Internal::Type::ArrayOf[String]
105
+
106
+ # @!attribute reply_text
107
+ # Conservatively extracted new-reply content from the available plain-text body.
108
+ # Null means no plain-text body was available because it was absent or offloaded;
109
+ # HTML bodies are not parsed.
110
+ #
111
+ # @return [String, nil]
112
+ required :reply_text, String, nil?: true
113
+
114
+ # @!attribute reply_to
115
+ #
116
+ # @return [Array<Telnyx::Models::InboundMessage::ReplyTo>]
117
+ required :reply_to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::ReplyTo] }
118
+
119
+ # @!attribute status
120
+ #
121
+ # @return [Symbol, Telnyx::Models::InboundMessage::Status]
122
+ required :status, enum: -> { Telnyx::InboundMessage::Status }
123
+
124
+ # @!attribute subject
125
+ #
126
+ # @return [String, nil]
127
+ required :subject, String, nil?: true
34
128
 
35
- # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
36
- # @param id [String] Identifies the type of resource.
129
+ # @!attribute text_body_url
130
+ # URL for an offloaded plain-text body. Null means the body is not offloaded to a
131
+ # URL; an inline plain-text body may still exist but is not returned on list
132
+ # reads. `reply_text` and `has_quoted_text` are computed from the inline
133
+ # plain-text body when present.
37
134
  #
38
- # @param event_type [Symbol, Telnyx::Models::InboundMessage::EventType] The type of event being delivered.
135
+ # @return [String, nil]
136
+ required :text_body_url, String, nil?: true
137
+
138
+ # @!attribute thread_id
39
139
  #
40
- # @param occurred_at [Time] ISO 8601 formatted date indicating when the resource was created.
140
+ # @return [String]
141
+ required :thread_id, String
142
+
143
+ # @!attribute to
41
144
  #
42
- # @param payload [Telnyx::Models::InboundMessagePayload]
145
+ # @return [Array<Telnyx::Models::InboundMessage::To>]
146
+ required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::To] }
147
+
148
+ # @!attribute updated_at
43
149
  #
44
- # @param record_type [Symbol, Telnyx::Models::InboundMessage::RecordType] Identifies the type of the resource.
150
+ # @return [Time]
151
+ required :updated_at, Time
45
152
 
46
- # The type of event being delivered.
153
+ # @!method initialize(id:, attachments:, bcc:, cc:, created_at:, direction:, from:, has_quoted_text:, headers:, html_body_url:, in_reply_to:, inbox_id:, inline_files:, message_id:, read_at:, received_at:, record_type:, references:, reply_text:, reply_to:, status:, subject:, text_body_url:, thread_id:, to:, updated_at:)
154
+ # Some parameter documentations has been truncated, see
155
+ # {Telnyx::Models::InboundMessage} for more details.
156
+ #
157
+ # @param id [String]
158
+ #
159
+ # @param attachments [Array<Hash{Symbol=>Object}>]
160
+ #
161
+ # @param bcc [Array<Telnyx::Models::InboundMessage::Bcc>]
162
+ #
163
+ # @param cc [Array<Telnyx::Models::InboundMessage::Cc>]
164
+ #
165
+ # @param created_at [Time]
166
+ #
167
+ # @param direction [Symbol, Telnyx::Models::InboundMessage::Direction]
168
+ #
169
+ # @param from [Telnyx::Models::InboundMessage::From]
47
170
  #
48
- # @see Telnyx::Models::InboundMessage#event_type
49
- module EventType
171
+ # @param has_quoted_text [Boolean] Whether conservative plain-text extraction detected a quoted tail. False does no
172
+ #
173
+ # @param headers [Hash{Symbol=>Object}]
174
+ #
175
+ # @param html_body_url [String, nil] URL for an offloaded HTML body. Null means the body is not offloaded to a URL; a
176
+ #
177
+ # @param in_reply_to [String, nil]
178
+ #
179
+ # @param inbox_id [String]
180
+ #
181
+ # @param inline_files [Array<Hash{Symbol=>Object}>]
182
+ #
183
+ # @param message_id [String] RFC Message-ID header.
184
+ #
185
+ # @param read_at [Time, nil]
186
+ #
187
+ # @param received_at [Time]
188
+ #
189
+ # @param record_type [Symbol, Telnyx::Models::InboundMessage::RecordType]
190
+ #
191
+ # @param references [Array<String>] Ordered RFC Message-ID values from the References header.
192
+ #
193
+ # @param reply_text [String, nil] Conservatively extracted new-reply content from the available plain-text body. N
194
+ #
195
+ # @param reply_to [Array<Telnyx::Models::InboundMessage::ReplyTo>]
196
+ #
197
+ # @param status [Symbol, Telnyx::Models::InboundMessage::Status]
198
+ #
199
+ # @param subject [String, nil]
200
+ #
201
+ # @param text_body_url [String, nil] URL for an offloaded plain-text body. Null means the body is not offloaded to a
202
+ #
203
+ # @param thread_id [String]
204
+ #
205
+ # @param to [Array<Telnyx::Models::InboundMessage::To>]
206
+ #
207
+ # @param updated_at [Time]
208
+
209
+ class Bcc < Telnyx::Internal::Type::BaseModel
210
+ # @!attribute email
211
+ #
212
+ # @return [String]
213
+ required :email, String
214
+
215
+ # @!attribute name
216
+ #
217
+ # @return [String, nil]
218
+ optional :name, String
219
+
220
+ # @!method initialize(email:, name: nil)
221
+ # @param email [String]
222
+ # @param name [String]
223
+ end
224
+
225
+ class Cc < Telnyx::Internal::Type::BaseModel
226
+ # @!attribute email
227
+ #
228
+ # @return [String]
229
+ required :email, String
230
+
231
+ # @!attribute name
232
+ #
233
+ # @return [String, nil]
234
+ optional :name, String
235
+
236
+ # @!method initialize(email:, name: nil)
237
+ # @param email [String]
238
+ # @param name [String]
239
+ end
240
+
241
+ # @see Telnyx::Models::InboundMessage#direction
242
+ module Direction
50
243
  extend Telnyx::Internal::Type::Enum
51
244
 
52
- MESSAGE_RECEIVED = :"message.received"
245
+ INBOUND = :inbound
53
246
 
54
247
  # @!method self.values
55
248
  # @return [Array<Symbol>]
56
249
  end
57
250
 
58
- # Identifies the type of the resource.
59
- #
251
+ # @see Telnyx::Models::InboundMessage#from
252
+ class From < Telnyx::Internal::Type::BaseModel
253
+ # @!attribute email
254
+ #
255
+ # @return [String]
256
+ required :email, String
257
+
258
+ # @!attribute name
259
+ #
260
+ # @return [String, nil]
261
+ optional :name, String
262
+
263
+ # @!method initialize(email:, name: nil)
264
+ # @param email [String]
265
+ # @param name [String]
266
+ end
267
+
60
268
  # @see Telnyx::Models::InboundMessage#record_type
61
269
  module RecordType
62
270
  extend Telnyx::Internal::Type::Enum
63
271
 
64
- EVENT = :event
272
+ EMAIL_MESSAGE = :email_message
65
273
 
66
274
  # @!method self.values
67
275
  # @return [Array<Symbol>]
68
276
  end
277
+
278
+ class ReplyTo < Telnyx::Internal::Type::BaseModel
279
+ # @!attribute email
280
+ #
281
+ # @return [String]
282
+ required :email, String
283
+
284
+ # @!attribute name
285
+ #
286
+ # @return [String, nil]
287
+ optional :name, String
288
+
289
+ # @!method initialize(email:, name: nil)
290
+ # @param email [String]
291
+ # @param name [String]
292
+ end
293
+
294
+ # @see Telnyx::Models::InboundMessage#status
295
+ module Status
296
+ extend Telnyx::Internal::Type::Enum
297
+
298
+ RECEIVED = :received
299
+
300
+ # @!method self.values
301
+ # @return [Array<Symbol>]
302
+ end
303
+
304
+ class To < Telnyx::Internal::Type::BaseModel
305
+ # @!attribute email
306
+ #
307
+ # @return [String]
308
+ required :email, String
309
+
310
+ # @!attribute name
311
+ #
312
+ # @return [String, nil]
313
+ optional :name, String
314
+
315
+ # @!method initialize(email:, name: nil)
316
+ # @param email [String]
317
+ # @param name [String]
318
+ end
69
319
  end
70
320
  end
71
321
  end
@@ -5,11 +5,78 @@ module Telnyx
5
5
  class InboundMessageWebhookEvent < Telnyx::Internal::Type::BaseModel
6
6
  # @!attribute data
7
7
  #
8
- # @return [Telnyx::Models::InboundMessage, nil]
9
- optional :data, -> { Telnyx::InboundMessage }
8
+ # @return [Telnyx::Models::InboundMessageWebhookEvent::Data, nil]
9
+ optional :data, -> { Telnyx::InboundMessageWebhookEvent::Data }
10
10
 
11
11
  # @!method initialize(data: nil)
12
- # @param data [Telnyx::Models::InboundMessage]
12
+ # @param data [Telnyx::Models::InboundMessageWebhookEvent::Data]
13
+
14
+ # @see Telnyx::Models::InboundMessageWebhookEvent#data
15
+ class Data < Telnyx::Internal::Type::BaseModel
16
+ # @!attribute id
17
+ # Identifies the type of resource.
18
+ #
19
+ # @return [String, nil]
20
+ optional :id, String
21
+
22
+ # @!attribute event_type
23
+ # The type of event being delivered.
24
+ #
25
+ # @return [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::EventType, nil]
26
+ optional :event_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::EventType }
27
+
28
+ # @!attribute occurred_at
29
+ # ISO 8601 formatted date indicating when the resource was created.
30
+ #
31
+ # @return [Time, nil]
32
+ optional :occurred_at, Time
33
+
34
+ # @!attribute payload
35
+ #
36
+ # @return [Telnyx::Models::InboundMessagePayload, nil]
37
+ optional :payload, -> { Telnyx::InboundMessagePayload }
38
+
39
+ # @!attribute record_type
40
+ # Identifies the type of the resource.
41
+ #
42
+ # @return [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::RecordType, nil]
43
+ optional :record_type, enum: -> { Telnyx::InboundMessageWebhookEvent::Data::RecordType }
44
+
45
+ # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
46
+ # @param id [String] Identifies the type of resource.
47
+ #
48
+ # @param event_type [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::EventType] The type of event being delivered.
49
+ #
50
+ # @param occurred_at [Time] ISO 8601 formatted date indicating when the resource was created.
51
+ #
52
+ # @param payload [Telnyx::Models::InboundMessagePayload]
53
+ #
54
+ # @param record_type [Symbol, Telnyx::Models::InboundMessageWebhookEvent::Data::RecordType] Identifies the type of the resource.
55
+
56
+ # The type of event being delivered.
57
+ #
58
+ # @see Telnyx::Models::InboundMessageWebhookEvent::Data#event_type
59
+ module EventType
60
+ extend Telnyx::Internal::Type::Enum
61
+
62
+ MESSAGE_RECEIVED = :"message.received"
63
+
64
+ # @!method self.values
65
+ # @return [Array<Symbol>]
66
+ end
67
+
68
+ # Identifies the type of the resource.
69
+ #
70
+ # @see Telnyx::Models::InboundMessageWebhookEvent::Data#record_type
71
+ module RecordType
72
+ extend Telnyx::Internal::Type::Enum
73
+
74
+ EVENT = :event
75
+
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
78
+ end
79
+ end
13
80
  end
14
81
  end
15
82
  end