telnyx 5.155.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 (211) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +1 -0
  5. data/lib/telnyx/internal/type/union.rb +4 -4
  6. data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +209 -0
  7. data/lib/telnyx/models/ai/anthropic/v1_messages_response.rb +12 -0
  8. data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
  9. data/lib/telnyx/models/ai/assistant_tool.rb +118 -1
  10. data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
  11. data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
  12. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rb +103 -0
  13. data/lib/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rb +54 -0
  14. data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
  15. data/lib/telnyx/models/ai/pay_tool_params.rb +46 -0
  16. data/lib/telnyx/models/ai/tool_create_params.rb +13 -1
  17. data/lib/telnyx/models/ai/tool_update_params.rb +13 -1
  18. data/lib/telnyx/models/ai/transcription_settings.rb +3 -3
  19. data/lib/telnyx/models/call_dial_params.rb +13 -1
  20. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +3 -0
  21. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +6 -0
  22. data/lib/telnyx/models/calls/action_speak_params.rb +6 -0
  23. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +3 -0
  24. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +3 -0
  25. data/lib/telnyx/models/calls/telnyx_voice_settings.rb +2 -1
  26. data/lib/telnyx/models/calls/transcription_config.rb +8 -4
  27. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -1
  28. data/lib/telnyx/models/conferences/action_speak_params.rb +6 -0
  29. data/lib/telnyx/models/conversation_relay_embedded_config.rb +3 -0
  30. data/lib/telnyx/models/doc_reqs_requirement.rb +29 -4
  31. data/lib/telnyx/models/inbound_message.rb +278 -28
  32. data/lib/telnyx/models/inbound_message_webhook_event.rb +70 -3
  33. data/lib/telnyx/models/managed_account_list_params.rb +45 -3
  34. data/lib/telnyx/models/models_response.rb +0 -1
  35. data/lib/telnyx/models/phone_number_delete_response.rb +12 -1
  36. data/lib/telnyx/models/phone_number_detailed.rb +12 -1
  37. data/lib/telnyx/models/phone_number_slim_list_response.rb +12 -1
  38. data/lib/telnyx/models/requirement_list_params.rb +10 -1
  39. data/lib/telnyx/models/requirement_retrieve_params.rb +14 -1
  40. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -1
  41. data/lib/telnyx/models/storage/cloudf_create_params.rb +56 -0
  42. data/lib/telnyx/models/storage/cloudf_delete_params.rb +22 -0
  43. data/lib/telnyx/models/storage/cloudf_list_params.rb +109 -0
  44. data/lib/telnyx/models/storage/cloudf_list_response.rb +165 -0
  45. data/lib/telnyx/models/storage/cloudf_retrieve_params.rb +22 -0
  46. data/lib/telnyx/models/storage/cloudf_update_params.rb +36 -0
  47. data/lib/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rb +30 -0
  48. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +129 -0
  49. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +129 -0
  50. data/lib/telnyx/models/storage/cloudfs_filesystem_status.rb +28 -0
  51. data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +13 -8
  52. data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +4 -4
  53. data/lib/telnyx/models/verify_profile.rb +2 -2
  54. data/lib/telnyx/models/verify_profile_create_params.rb +2 -2
  55. data/lib/telnyx/models/verify_profile_update_params.rb +2 -2
  56. data/lib/telnyx/models.rb +0 -6
  57. data/lib/telnyx/resources/ai/anthropic/v1.rb +91 -0
  58. data/lib/telnyx/resources/ai/anthropic.rb +20 -0
  59. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  60. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  61. data/lib/telnyx/resources/ai/chat.rb +0 -81
  62. data/lib/telnyx/resources/ai/conversations/conversation_insights.rb +55 -0
  63. data/lib/telnyx/resources/ai/conversations.rb +5 -0
  64. data/lib/telnyx/resources/ai/tools.rb +8 -2
  65. data/lib/telnyx/resources/ai.rb +3 -56
  66. data/lib/telnyx/resources/calls.rb +3 -1
  67. data/lib/telnyx/resources/messages.rb +1 -32
  68. data/lib/telnyx/resources/requirements.rb +13 -3
  69. data/lib/telnyx/resources/storage/cloudfs/actions.rb +54 -0
  70. data/lib/telnyx/resources/storage/cloudfs.rb +187 -0
  71. data/lib/telnyx/resources/storage.rb +6 -0
  72. data/lib/telnyx/version.rb +1 -1
  73. data/lib/telnyx.rb +20 -7
  74. data/rbi/telnyx/client.rbi +1 -0
  75. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +314 -0
  76. data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi +15 -0
  77. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -4
  78. data/rbi/telnyx/models/ai/assistant_tool.rbi +258 -1
  79. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -4
  80. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -4
  81. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbi +188 -0
  82. data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi +94 -0
  83. data/rbi/telnyx/models/ai/inference_embedding.rbi +18 -6
  84. data/rbi/telnyx/models/ai/pay_tool_params.rbi +71 -0
  85. data/rbi/telnyx/models/ai/tool_create_params.rbi +18 -0
  86. data/rbi/telnyx/models/ai/tool_update_params.rbi +18 -0
  87. data/rbi/telnyx/models/ai/transcription_settings.rbi +5 -5
  88. data/rbi/telnyx/models/call_dial_params.rbi +19 -0
  89. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +6 -0
  90. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +12 -0
  91. data/rbi/telnyx/models/calls/action_speak_params.rbi +12 -0
  92. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +6 -0
  93. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +6 -0
  94. data/rbi/telnyx/models/calls/telnyx_voice_settings.rbi +4 -2
  95. data/rbi/telnyx/models/calls/transcription_config.rbi +15 -7
  96. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +2 -2
  97. data/rbi/telnyx/models/conferences/action_speak_params.rbi +12 -0
  98. data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +6 -0
  99. data/rbi/telnyx/models/doc_reqs_requirement.rbi +38 -9
  100. data/rbi/telnyx/models/inbound_message.rbi +324 -58
  101. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +173 -4
  102. data/rbi/telnyx/models/managed_account_list_params.rbi +130 -6
  103. data/rbi/telnyx/models/phone_number_delete_response.rbi +14 -0
  104. data/rbi/telnyx/models/phone_number_detailed.rbi +14 -0
  105. data/rbi/telnyx/models/phone_number_slim_list_response.rbi +14 -0
  106. data/rbi/telnyx/models/requirement_list_params.rbi +13 -0
  107. data/rbi/telnyx/models/requirement_retrieve_params.rbi +21 -2
  108. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +2 -2
  109. data/rbi/telnyx/models/storage/cloudf_create_params.rbi +103 -0
  110. data/rbi/telnyx/models/storage/cloudf_delete_params.rbi +40 -0
  111. data/rbi/telnyx/models/storage/cloudf_list_params.rbi +232 -0
  112. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +327 -0
  113. data/rbi/telnyx/models/storage/cloudf_retrieve_params.rbi +40 -0
  114. data/rbi/telnyx/models/storage/cloudf_update_params.rbi +61 -0
  115. data/rbi/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbi +50 -0
  116. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +229 -0
  117. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +227 -0
  118. data/rbi/telnyx/models/storage/cloudfs_filesystem_status.rbi +57 -0
  119. data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +21 -13
  120. data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +8 -8
  121. data/rbi/telnyx/models/verify_profile.rbi +2 -2
  122. data/rbi/telnyx/models/verify_profile_create_params.rbi +2 -2
  123. data/rbi/telnyx/models/verify_profile_update_params.rbi +2 -2
  124. data/rbi/telnyx/models.rbi +0 -7
  125. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +106 -0
  126. data/rbi/telnyx/resources/ai/anthropic.rbi +17 -0
  127. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -1
  128. data/rbi/telnyx/resources/ai/assistants.rbi +6 -2
  129. data/rbi/telnyx/resources/ai/chat.rbi +0 -129
  130. data/rbi/telnyx/resources/ai/conversations/conversation_insights.rbi +68 -0
  131. data/rbi/telnyx/resources/ai/conversations.rbi +6 -0
  132. data/rbi/telnyx/resources/ai/tools.rbi +8 -0
  133. data/rbi/telnyx/resources/ai.rbi +2 -32
  134. data/rbi/telnyx/resources/calls/actions.rbi +21 -0
  135. data/rbi/telnyx/resources/calls.rbi +7 -0
  136. data/rbi/telnyx/resources/conferences/actions.rbi +6 -0
  137. data/rbi/telnyx/resources/managed_accounts.rbi +1 -1
  138. data/rbi/telnyx/resources/messages.rbi +1 -28
  139. data/rbi/telnyx/resources/requirements.rbi +8 -0
  140. data/rbi/telnyx/resources/storage/cloudfs/actions.rbi +46 -0
  141. data/rbi/telnyx/resources/storage/cloudfs.rbi +152 -0
  142. data/rbi/telnyx/resources/storage.rbi +5 -0
  143. data/rbi/telnyx/resources/text_to_speech.rbi +11 -9
  144. data/sig/telnyx/models/ai/anthropic/v1_messages_params.rbs +175 -0
  145. data/sig/telnyx/models/ai/anthropic/v1_messages_response.rbs +11 -0
  146. data/sig/telnyx/models/ai/assistant_tool.rbs +108 -0
  147. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_params.rbs +74 -0
  148. data/sig/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbs +34 -0
  149. data/sig/telnyx/models/ai/pay_tool_params.rbs +41 -0
  150. data/sig/telnyx/models/ai/tool_create_params.rbs +14 -0
  151. data/sig/telnyx/models/ai/tool_update_params.rbs +14 -0
  152. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -2
  153. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  154. data/sig/telnyx/models/calls/transcription_config.rbs +2 -2
  155. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +2 -2
  156. data/sig/telnyx/models/doc_reqs_requirement.rbs +25 -8
  157. data/sig/telnyx/models/inbound_message.rbs +204 -35
  158. data/sig/telnyx/models/inbound_message_webhook_event.rbs +81 -5
  159. data/sig/telnyx/models/managed_account_list_params.rbs +47 -3
  160. data/sig/telnyx/models/phone_number_delete_response.rbs +5 -0
  161. data/sig/telnyx/models/phone_number_detailed.rbs +5 -0
  162. data/sig/telnyx/models/phone_number_slim_list_response.rbs +5 -0
  163. data/sig/telnyx/models/requirement_list_params.rbs +8 -1
  164. data/sig/telnyx/models/requirement_retrieve_params.rbs +12 -2
  165. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -2
  166. data/sig/telnyx/models/storage/cloudf_create_params.rbs +50 -0
  167. data/sig/telnyx/models/storage/cloudf_delete_params.rbs +22 -0
  168. data/sig/telnyx/models/storage/cloudf_list_params.rbs +112 -0
  169. data/sig/telnyx/models/storage/cloudf_list_response.rbs +163 -0
  170. data/sig/telnyx/models/storage/cloudf_retrieve_params.rbs +22 -0
  171. data/sig/telnyx/models/storage/cloudf_update_params.rbs +32 -0
  172. data/sig/telnyx/models/storage/cloudfs/action_rotate_meta_token_params.rbs +32 -0
  173. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +115 -0
  174. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +115 -0
  175. data/sig/telnyx/models/storage/cloudfs_filesystem_status.rbs +21 -0
  176. data/sig/telnyx/models.rbs +0 -6
  177. data/sig/telnyx/resources/ai/anthropic/v1.rbs +35 -0
  178. data/sig/telnyx/resources/ai/anthropic.rbs +11 -0
  179. data/sig/telnyx/resources/ai/chat.rbs +0 -30
  180. data/sig/telnyx/resources/ai/conversations/conversation_insights.rbs +20 -0
  181. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  182. data/sig/telnyx/resources/ai/tools.rbs +4 -0
  183. data/sig/telnyx/resources/ai.rbs +1 -8
  184. data/sig/telnyx/resources/calls.rbs +1 -0
  185. data/sig/telnyx/resources/messages.rbs +0 -10
  186. data/sig/telnyx/resources/requirements.rbs +2 -0
  187. data/sig/telnyx/resources/storage/cloudfs/actions.rbs +17 -0
  188. data/sig/telnyx/resources/storage/cloudfs.rbs +45 -0
  189. data/sig/telnyx/resources/storage.rbs +2 -0
  190. metadata +62 -23
  191. data/lib/telnyx/models/ai/chat_create_completion_params.rb +0 -16
  192. data/lib/telnyx/models/ai/chat_create_completion_response.rb +0 -10
  193. data/lib/telnyx/models/ai_create_response_deprecated_params.rb +0 -20
  194. data/lib/telnyx/models/ai_create_response_deprecated_response.rb +0 -8
  195. data/lib/telnyx/models/ai_retrieve_models_params.rb +0 -14
  196. data/lib/telnyx/models/message_send_whatsapp_params.rb +0 -71
  197. data/lib/telnyx/models/message_send_whatsapp_response.rb +0 -178
  198. data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +0 -32
  199. data/rbi/telnyx/models/ai/chat_create_completion_response.rbi +0 -13
  200. data/rbi/telnyx/models/ai_create_response_deprecated_params.rbi +0 -41
  201. data/rbi/telnyx/models/ai_create_response_deprecated_response.rbi +0 -11
  202. data/rbi/telnyx/models/ai_retrieve_models_params.rbi +0 -27
  203. data/rbi/telnyx/models/message_send_whatsapp_params.rbi +0 -124
  204. data/rbi/telnyx/models/message_send_whatsapp_response.rbi +0 -379
  205. data/sig/telnyx/models/ai/chat_create_completion_params.rbs +0 -17
  206. data/sig/telnyx/models/ai/chat_create_completion_response.rbs +0 -9
  207. data/sig/telnyx/models/ai_create_response_deprecated_params.rbs +0 -24
  208. data/sig/telnyx/models/ai_create_response_deprecated_response.rbs +0 -7
  209. data/sig/telnyx/models/ai_retrieve_models_params.rbs +0 -15
  210. data/sig/telnyx/models/message_send_whatsapp_params.rbs +0 -69
  211. data/sig/telnyx/models/message_send_whatsapp_response.rbs +0 -191
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Conversations
7
+ # @see Telnyx::Resources::AI::Conversations::ConversationInsights#retrieve_aggregates
8
+ class ConversationInsightRetrieveAggregatesResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ # Aggregation result rows. Each row contains the grouped field values and a
11
+ # `record_count`.
12
+ #
13
+ # @return [Array<Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data>]
14
+ required :data,
15
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data] }
16
+
17
+ # @!method initialize(data:)
18
+ # Some parameter documentations has been truncated, see
19
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse}
20
+ # for more details.
21
+ #
22
+ # Aggregated conversation insight counts grouped by the specified fields. Each
23
+ # item in `data` contains the grouped field values and a `record_count` indicating
24
+ # how many conversation insights match that combination.
25
+ #
26
+ # @param data [Array<Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data>] Aggregation result rows. Each row contains the grouped field values and a `recor
27
+
28
+ class Data < Telnyx::Internal::Type::BaseModel
29
+ # @!attribute record_count
30
+ # Number of conversation insights that match this combination of grouped field
31
+ # values.
32
+ #
33
+ # @return [Integer]
34
+ required :record_count, Integer
35
+
36
+ # @!method initialize(record_count:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data}
39
+ # for more details.
40
+ #
41
+ # An aggregation row. Contains the grouped field values (keyed by the group_by
42
+ # field names) and a `record_count` integer. For example, when grouping by
43
+ # `score`, each row has a `score` value and a `record_count` of conversations with
44
+ # that score. When also splitting by `metadata.assistant_version_id`, each row
45
+ # includes both `score` and `metadata.assistant_version_id` plus their combined
46
+ # `record_count`.
47
+ #
48
+ # @param record_count [Integer] Number of conversation insights that match this combination of grouped field val
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -199,7 +199,7 @@ module Telnyx
199
199
  # assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
200
200
  # endpoints.
201
201
  #
202
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
202
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
203
203
  optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
204
204
 
205
205
  # @!attribute transcription
@@ -295,7 +295,7 @@ module Telnyx
295
295
  #
296
296
  # @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
297
297
  #
298
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
298
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
299
299
  #
300
300
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
301
301
  #
@@ -430,7 +430,7 @@ module Telnyx
430
430
  # follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
431
431
  # configure a node's tools.
432
432
  #
433
- # @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>, nil]
433
+ # @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>>, nil]
434
434
  optional :tools,
435
435
  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool]] }
436
436
 
@@ -486,7 +486,7 @@ module Telnyx
486
486
  #
487
487
  # @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
488
488
  #
489
- # @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
489
+ # @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
490
490
  #
491
491
  # @param tools_mode [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
492
492
  #
@@ -576,7 +576,7 @@ module Telnyx
576
576
  # responses so clients can render the node without a follow-up fetch. Ignored on
577
577
  # input — set `shared_tool_id`.
578
578
  #
579
- # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
579
+ # @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>, nil]
580
580
  optional :tool, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
581
581
 
582
582
  # @!attribute type
@@ -600,7 +600,7 @@ module Telnyx
600
600
  #
601
601
  # @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
602
602
  #
603
- # @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
603
+ # @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
604
604
  #
605
605
  # @param type [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Tool::Type] Node kind discriminator. Always `tool` for a tool node.
606
606
 
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ class PayToolParams < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute connector_name
8
+ # The name of the pay connector configured in the Telnyx API. Must reference an
9
+ # existing pay connector for this organization.
10
+ #
11
+ # @return [String]
12
+ required :connector_name, String
13
+
14
+ # @!attribute currency
15
+ # Default currency for payments processed by this tool.
16
+ #
17
+ # @return [String, nil]
18
+ optional :currency, String
19
+
20
+ # @!attribute description
21
+ # Optional description of the pay tool that will be passed to the assistant.
22
+ #
23
+ # @return [String, nil]
24
+ optional :description, String, nil?: true
25
+
26
+ # @!attribute payment_method
27
+ # Default payment method for payments processed by this tool.
28
+ #
29
+ # @return [String, nil]
30
+ optional :payment_method, String
31
+
32
+ # @!method initialize(connector_name:, currency: nil, description: nil, payment_method: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {Telnyx::Models::AI::PayToolParams} for more details.
35
+ #
36
+ # @param connector_name [String] The name of the pay connector configured in the Telnyx API. Must reference an ex
37
+ #
38
+ # @param currency [String] Default currency for payments processed by this tool.
39
+ #
40
+ # @param description [String, nil] Optional description of the pay tool that will be passed to the assistant.
41
+ #
42
+ # @param payment_method [String] Default payment method for payments processed by this tool.
43
+ end
44
+ end
45
+ end
46
+ end
@@ -18,6 +18,11 @@ module Telnyx
18
18
  # @return [String]
19
19
  required :type, String
20
20
 
21
+ # @!attribute client_side_tool
22
+ #
23
+ # @return [Hash{Symbol=>Object}, nil]
24
+ optional :client_side_tool, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
25
+
21
26
  # @!attribute function
22
27
  #
23
28
  # @return [Hash{Symbol=>Object}, nil]
@@ -33,6 +38,11 @@ module Telnyx
33
38
  # @return [Hash{Symbol=>Object}, nil]
34
39
  optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
35
40
 
41
+ # @!attribute pay
42
+ #
43
+ # @return [Telnyx::Models::AI::PayToolParams, nil]
44
+ optional :pay, -> { Telnyx::AI::PayToolParams }
45
+
36
46
  # @!attribute retrieval
37
47
  #
38
48
  # @return [Hash{Symbol=>Object}, nil]
@@ -48,12 +58,14 @@ module Telnyx
48
58
  # @return [Hash{Symbol=>Object}, nil]
49
59
  optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
50
60
 
51
- # @!method initialize(display_name:, type:, 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: {})
52
62
  # @param display_name [String]
53
63
  # @param type [String]
64
+ # @param client_side_tool [Hash{Symbol=>Object}]
54
65
  # @param function [Hash{Symbol=>Object}]
55
66
  # @param handoff [Hash{Symbol=>Object}]
56
67
  # @param invite [Hash{Symbol=>Object}]
68
+ # @param pay [Telnyx::Models::AI::PayToolParams]
57
69
  # @param retrieval [Hash{Symbol=>Object}]
58
70
  # @param timeout_ms [Integer]
59
71
  # @param webhook [Hash{Symbol=>Object}]
@@ -13,6 +13,11 @@ module Telnyx
13
13
  # @return [String]
14
14
  required :tool_id, String
15
15
 
16
+ # @!attribute client_side_tool
17
+ #
18
+ # @return [Hash{Symbol=>Object}, nil]
19
+ optional :client_side_tool, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
20
+
16
21
  # @!attribute display_name
17
22
  #
18
23
  # @return [String, nil]
@@ -33,6 +38,11 @@ module Telnyx
33
38
  # @return [Hash{Symbol=>Object}, nil]
34
39
  optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
35
40
 
41
+ # @!attribute pay
42
+ #
43
+ # @return [Telnyx::Models::AI::PayToolParams, nil]
44
+ optional :pay, -> { Telnyx::AI::PayToolParams }
45
+
36
46
  # @!attribute retrieval
37
47
  #
38
48
  # @return [Hash{Symbol=>Object}, nil]
@@ -53,12 +63,14 @@ module Telnyx
53
63
  # @return [Hash{Symbol=>Object}, nil]
54
64
  optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
55
65
 
56
- # @!method initialize(tool_id:, 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: {})
57
67
  # @param tool_id [String]
68
+ # @param client_side_tool [Hash{Symbol=>Object}]
58
69
  # @param display_name [String]
59
70
  # @param function [Hash{Symbol=>Object}]
60
71
  # @param handoff [Hash{Symbol=>Object}]
61
72
  # @param invite [Hash{Symbol=>Object}]
73
+ # @param pay [Telnyx::Models::AI::PayToolParams]
62
74
  # @param retrieval [Hash{Symbol=>Object}]
63
75
  # @param timeout_ms [Integer]
64
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.
@@ -136,6 +136,9 @@ module Telnyx
136
136
  # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
137
137
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
138
138
  # `Max`, `TTS2`.
139
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
140
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
141
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
139
142
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
140
143
  # `ara`, `rex`, `sal`, `leo`.
141
144
  #
@@ -47,6 +47,9 @@ module Telnyx
47
47
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
48
48
  # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
49
49
  # Use `voice_settings` to configure voice_speed and other synthesis parameters.
50
+ # `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
51
+ # `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
52
+ # (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
50
53
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
51
54
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
52
55
  # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
@@ -61,6 +64,9 @@ module Telnyx
61
64
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
62
65
  # `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
63
66
  # `BALANCED`, `CREATIVE`), supported by `TTS2` only.
67
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
68
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
69
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
64
70
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
65
71
  # `ara`, `rex`, `sal`, `leo`.
66
72
  #
@@ -47,6 +47,9 @@ module Telnyx
47
47
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
48
48
  # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
49
49
  # Use `voice_settings` to configure voice_speed and other synthesis parameters.
50
+ # `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
51
+ # `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
52
+ # (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
50
53
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
51
54
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
52
55
  # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
@@ -61,6 +64,9 @@ module Telnyx
61
64
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
62
65
  # `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
63
66
  # `BALANCED`, `CREATIVE`), supported by `TTS2` only.
67
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
68
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
69
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
64
70
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
65
71
  # `ara`, `rex`, `sal`, `leo`.
66
72
  #
@@ -105,6 +105,9 @@ module Telnyx
105
105
  # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
106
106
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
107
107
  # `Max`, `TTS2`.
108
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
109
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
110
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
108
111
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
109
112
  # `ara`, `rex`, `sal`, `leo`.
110
113
  #
@@ -194,6 +194,9 @@ module Telnyx
194
194
  # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
195
195
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
196
196
  # `Max`, `TTS2`.
197
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
198
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
199
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
197
200
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
198
201
  # `ara`, `rex`, `sal`, `leo`.
199
202
  #
@@ -12,7 +12,8 @@ module Telnyx
12
12
 
13
13
  # @!attribute voice_speed
14
14
  # The voice speed to be used for the voice. The voice speed must be between 0.1
15
- # and 2.0. Default value is 1.0.
15
+ # and 2.0. Default value is 1.0. Not supported for `Telnyx.Bayan.*` or
16
+ # `Telnyx.Sukhan.*` voices.
16
17
  #
17
18
  # @return [Float, nil]
18
19
  optional :voice_speed, Float
@@ -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>]
@@ -47,6 +47,9 @@ module Telnyx
47
47
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
48
48
  # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
49
49
  # Use `voice_settings` to configure voice_speed and other synthesis parameters.
50
+ # `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
51
+ # `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
52
+ # (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
50
53
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
51
54
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
52
55
  # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
@@ -61,6 +64,9 @@ module Telnyx
61
64
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
62
65
  # `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
63
66
  # `BALANCED`, `CREATIVE`), supported by `TTS2` only.
67
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
68
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
69
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
64
70
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
65
71
  # `ara`, `rex`, `sal`, `leo`.
66
72
  #
@@ -128,6 +128,9 @@ module Telnyx
128
128
  # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
129
129
  # `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
130
130
  # `Max`, `TTS2`.
131
+ # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
132
+ # `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
133
+ # `s1`. `VoiceId` is a Fish Voice-Library reference ID.
131
134
  # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
132
135
  # `ara`, `rex`, `sal`, `leo`.
133
136
  #
@@ -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