telnyx 5.112.0 → 5.113.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 (261) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
  5. data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
  6. data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
  7. data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +9 -178
  9. data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
  10. data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
  11. data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
  12. data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
  13. data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
  14. data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
  15. data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
  16. data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -179
  17. data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
  18. data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
  19. data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
  20. data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
  21. data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
  22. data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
  23. data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
  24. data/lib/telnyx/models/ai_create_response_params.rb +4 -4
  25. data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
  26. data/lib/telnyx/models/call_conversation_ended.rb +13 -1
  27. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
  28. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
  29. data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
  30. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
  31. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +169 -118
  32. data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
  33. data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
  34. data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
  35. data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
  36. data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
  37. data/lib/telnyx/models/fax.rb +7 -5
  38. data/lib/telnyx/models/fax_create_params.rb +7 -5
  39. data/lib/telnyx/models/fax_delivered.rb +3 -2
  40. data/lib/telnyx/models/fax_failed.rb +3 -2
  41. data/lib/telnyx/models/fax_media_processed.rb +3 -2
  42. data/lib/telnyx/models/fax_queued.rb +3 -2
  43. data/lib/telnyx/models/fax_sending_started.rb +3 -2
  44. data/lib/telnyx/models/model_metadata.rb +212 -0
  45. data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
  46. data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
  47. data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
  48. data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
  49. data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
  50. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
  51. data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
  52. data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
  53. data/lib/telnyx/models/uac_connection.rb +412 -0
  54. data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
  55. data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
  56. data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
  57. data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
  58. data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
  59. data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
  60. data/lib/telnyx/models/uac_external_settings.rb +101 -0
  61. data/lib/telnyx/models/uac_inbound.rb +210 -0
  62. data/lib/telnyx/models/uac_internal_settings.rb +25 -0
  63. data/lib/telnyx/models/uac_outbound.rb +131 -0
  64. data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
  65. data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
  66. data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
  67. data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
  68. data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
  69. data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
  70. data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
  71. data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
  72. data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
  73. data/lib/telnyx/models/xai_voice_settings.rb +36 -0
  74. data/lib/telnyx/models.rb +20 -0
  75. data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
  76. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  77. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  78. data/lib/telnyx/resources/ai/openai.rb +1 -1
  79. data/lib/telnyx/resources/ai.rb +3 -3
  80. data/lib/telnyx/resources/calls/actions.rb +15 -17
  81. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  82. data/lib/telnyx/resources/faxes.rb +13 -1
  83. data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
  84. data/lib/telnyx/resources/texml.rb +4 -2
  85. data/lib/telnyx/resources/uac_connections.rb +8 -8
  86. data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
  87. data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
  88. data/lib/telnyx/version.rb +1 -1
  89. data/lib/telnyx.rb +23 -4
  90. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
  91. data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
  92. data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
  93. data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
  94. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -352
  95. data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
  96. data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
  97. data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
  98. data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
  99. data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
  100. data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
  101. data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
  102. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -366
  103. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
  104. data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
  105. data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
  106. data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
  107. data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
  108. data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
  109. data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
  110. data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
  111. data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
  112. data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
  113. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
  114. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
  115. data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
  116. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
  117. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +371 -254
  118. data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
  119. data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
  120. data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
  121. data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
  122. data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
  123. data/rbi/telnyx/models/fax.rbi +12 -8
  124. data/rbi/telnyx/models/fax_create_params.rbi +12 -8
  125. data/rbi/telnyx/models/fax_delivered.rbi +6 -4
  126. data/rbi/telnyx/models/fax_failed.rbi +6 -4
  127. data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
  128. data/rbi/telnyx/models/fax_queued.rbi +6 -4
  129. data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
  130. data/rbi/telnyx/models/model_metadata.rbi +272 -0
  131. data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
  132. data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
  133. data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
  134. data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
  135. data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
  136. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
  137. data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
  138. data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
  139. data/rbi/telnyx/models/uac_connection.rbi +684 -0
  140. data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
  141. data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
  142. data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
  143. data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
  144. data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
  145. data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
  146. data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
  147. data/rbi/telnyx/models/uac_inbound.rbi +410 -0
  148. data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
  149. data/rbi/telnyx/models/uac_outbound.rbi +224 -0
  150. data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
  151. data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
  152. data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
  153. data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
  154. data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
  155. data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
  156. data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
  157. data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
  158. data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
  159. data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
  160. data/rbi/telnyx/models.rbi +20 -0
  161. data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
  162. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
  163. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  164. data/rbi/telnyx/resources/ai/openai.rbi +1 -1
  165. data/rbi/telnyx/resources/ai.rbi +2 -2
  166. data/rbi/telnyx/resources/calls/actions.rbi +24 -24
  167. data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
  168. data/rbi/telnyx/resources/faxes.rbi +18 -4
  169. data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
  170. data/rbi/telnyx/resources/texml.rbi +7 -1
  171. data/rbi/telnyx/resources/uac_connections.rbi +7 -13
  172. data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
  173. data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
  174. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -149
  175. data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
  176. data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
  177. data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
  178. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -149
  179. data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
  180. data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
  181. data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
  182. data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
  183. data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
  184. data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
  185. data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
  186. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -152
  187. data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
  188. data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
  189. data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
  190. data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
  191. data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
  192. data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
  193. data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
  194. data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
  195. data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
  196. data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
  197. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
  198. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
  199. data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
  200. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
  201. data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +141 -102
  202. data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
  203. data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
  204. data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
  205. data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
  206. data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
  207. data/sig/telnyx/models/model_metadata.rbs +142 -0
  208. data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
  209. data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
  210. data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
  211. data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
  212. data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
  213. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
  214. data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
  215. data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
  216. data/sig/telnyx/models/uac_connection.rbs +338 -0
  217. data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
  218. data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
  219. data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
  220. data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
  221. data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
  222. data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
  223. data/sig/telnyx/models/uac_external_settings.rbs +73 -0
  224. data/sig/telnyx/models/uac_inbound.rbs +190 -0
  225. data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
  226. data/sig/telnyx/models/uac_outbound.rbs +113 -0
  227. data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
  228. data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
  229. data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
  230. data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
  231. data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
  232. data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
  233. data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
  234. data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
  235. data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
  236. data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
  237. data/sig/telnyx/models.rbs +20 -0
  238. data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
  239. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  240. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  241. data/sig/telnyx/resources/ai/openai.rbs +1 -1
  242. data/sig/telnyx/resources/ai.rbs +1 -1
  243. data/sig/telnyx/resources/calls/actions.rbs +2 -4
  244. data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
  245. data/sig/telnyx/resources/texml.rbs +1 -0
  246. data/sig/telnyx/resources/uac_connections.rbs +7 -7
  247. data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
  248. data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
  249. metadata +71 -14
  250. data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
  251. data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
  252. data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
  253. data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
  254. data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
  255. data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
  256. data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
  257. data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
  258. data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
  259. data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
  260. data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
  261. data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Calls
6
+ class TranscriptionEngineSpeechmaticsConfig < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute interim_results
8
+ # Whether to send also interim results. If set to false, only final results will
9
+ # be sent.
10
+ #
11
+ # @return [Boolean, nil]
12
+ optional :interim_results, Telnyx::Internal::Type::Boolean
13
+
14
+ # @!attribute language
15
+ # Language to use for speech recognition
16
+ #
17
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language, nil]
18
+ optional :language, enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language }
19
+
20
+ # @!attribute transcription_engine
21
+ # Engine identifier for Speechmatics transcription service
22
+ #
23
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine, nil]
24
+ optional :transcription_engine,
25
+ enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine }
26
+
27
+ # @!attribute transcription_model
28
+ # The model to use for transcription.
29
+ #
30
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel, nil]
31
+ optional :transcription_model,
32
+ enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel }
33
+
34
+ # @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
35
+ # Some parameter documentations has been truncated, see
36
+ # {Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig} for more details.
37
+ #
38
+ # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
39
+ #
40
+ # @param language [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language] Language to use for speech recognition
41
+ #
42
+ # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine] Engine identifier for Speechmatics transcription service
43
+ #
44
+ # @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel] The model to use for transcription.
45
+
46
+ # Language to use for speech recognition
47
+ #
48
+ # @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#language
49
+ module Language
50
+ extend Telnyx::Internal::Type::Enum
51
+
52
+ EN = :en
53
+ BA = :ba
54
+ EU = :eu
55
+ GL = :gl
56
+ GA = :ga
57
+ MT = :mt
58
+ MN = :mn
59
+ SW = :sw
60
+ UG = :ug
61
+ CY = :cy
62
+ AR_EN = :ar_en
63
+ CMN_EN = :cmn_en
64
+ EN_MS = :en_ms
65
+ EN_TA = :en_ta
66
+ TL = :tl
67
+ ES_BILINGUAL_EN = :"es-bilingual-en"
68
+ CMN_EN_MS_TA = :cmn_en_ms_ta
69
+
70
+ # @!method self.values
71
+ # @return [Array<Symbol>]
72
+ end
73
+
74
+ # Engine identifier for Speechmatics transcription service
75
+ #
76
+ # @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_engine
77
+ module TranscriptionEngine
78
+ extend Telnyx::Internal::Type::Enum
79
+
80
+ SPEECHMATICS = :Speechmatics
81
+
82
+ # @!method self.values
83
+ # @return [Array<Symbol>]
84
+ end
85
+
86
+ # The model to use for transcription.
87
+ #
88
+ # @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_model
89
+ module TranscriptionModel
90
+ extend Telnyx::Internal::Type::Enum
91
+
92
+ SPEECHMATICS_STANDARD = :"speechmatics/standard"
93
+
94
+ # @!method self.values
95
+ # @return [Array<Symbol>]
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,108 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Calls
6
+ class TranscriptionEngineXaiConfig < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute interim_results
8
+ # Whether to send also interim results. If set to false, only final results will
9
+ # be sent.
10
+ #
11
+ # @return [Boolean, nil]
12
+ optional :interim_results, Telnyx::Internal::Type::Boolean
13
+
14
+ # @!attribute language
15
+ # Language to use for speech recognition
16
+ #
17
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::Language, nil]
18
+ optional :language, enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::Language }
19
+
20
+ # @!attribute transcription_engine
21
+ # Engine identifier for xAI transcription service
22
+ #
23
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine, nil]
24
+ optional :transcription_engine,
25
+ enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine }
26
+
27
+ # @!attribute transcription_model
28
+ # The model to use for transcription.
29
+ #
30
+ # @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionModel, nil]
31
+ optional :transcription_model,
32
+ enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::TranscriptionModel }
33
+
34
+ # @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
35
+ # Some parameter documentations has been truncated, see
36
+ # {Telnyx::Models::Calls::TranscriptionEngineXaiConfig} for more details.
37
+ #
38
+ # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
39
+ #
40
+ # @param language [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::Language] Language to use for speech recognition
41
+ #
42
+ # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine] Engine identifier for xAI transcription service
43
+ #
44
+ # @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionModel] The model to use for transcription.
45
+
46
+ # Language to use for speech recognition
47
+ #
48
+ # @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#language
49
+ module Language
50
+ extend Telnyx::Internal::Type::Enum
51
+
52
+ AR = :ar
53
+ CS = :cs
54
+ DA = :da
55
+ DE = :de
56
+ EN = :en
57
+ ES = :es
58
+ FA = :fa
59
+ FIL = :fil
60
+ FR = :fr
61
+ HI = :hi
62
+ ID = :id
63
+ IT = :it
64
+ JA = :ja
65
+ KO = :ko
66
+ MK = :mk
67
+ MS = :ms
68
+ NL = :nl
69
+ PL = :pl
70
+ PT = :pt
71
+ RO = :ro
72
+ RU = :ru
73
+ SV = :sv
74
+ TH = :th
75
+ TR = :tr
76
+ VI = :vi
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+
82
+ # Engine identifier for xAI transcription service
83
+ #
84
+ # @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#transcription_engine
85
+ module TranscriptionEngine
86
+ extend Telnyx::Internal::Type::Enum
87
+
88
+ X_AI = :xAI
89
+
90
+ # @!method self.values
91
+ # @return [Array<Symbol>]
92
+ end
93
+
94
+ # The model to use for transcription.
95
+ #
96
+ # @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#transcription_model
97
+ module TranscriptionModel
98
+ extend Telnyx::Internal::Type::Enum
99
+
100
+ XAI_GROK_STT = :"xai/grok-stt"
101
+
102
+ # @!method self.values
103
+ # @return [Array<Symbol>]
104
+ end
105
+ end
106
+ end
107
+ end
108
+ end
@@ -27,7 +27,7 @@ module Telnyx
27
27
 
28
28
  # @!attribute transcription_engine_config
29
29
  #
30
- # @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
30
+ # @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
31
31
  optional :transcription_engine_config,
32
32
  union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
33
33
 
@@ -49,7 +49,7 @@ module Telnyx
49
49
  #
50
50
  # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
51
51
  #
52
- # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
52
+ # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
53
53
  #
54
54
  # @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
55
55
 
@@ -66,6 +66,7 @@ module Telnyx
66
66
  AZURE = :Azure
67
67
  X_AI = :xAI
68
68
  ASSEMBLY_AI = :AssemblyAI
69
+ SPEECHMATICS = :Speechmatics
69
70
  A = :A
70
71
  B = :B
71
72
 
@@ -85,10 +86,11 @@ module Telnyx
85
86
 
86
87
  variant :Azure, -> { Telnyx::Calls::TranscriptionEngineAzureConfig }
87
88
 
88
- variant :xAI, -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI }
89
+ variant :xAI, -> { Telnyx::Calls::TranscriptionEngineXaiConfig }
89
90
 
90
- variant :AssemblyAI,
91
- -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI }
91
+ variant :AssemblyAI, -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig }
92
+
93
+ variant :Speechmatics, -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig }
92
94
 
93
95
  variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
94
96
 
@@ -98,169 +100,8 @@ module Telnyx
98
100
 
99
101
  variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
100
102
 
101
- class XAI < Telnyx::Internal::Type::BaseModel
102
- # @!attribute interim_results
103
- # Whether to send also interim results. If set to false, only final results will
104
- # be sent.
105
- #
106
- # @return [Boolean, nil]
107
- optional :interim_results, Telnyx::Internal::Type::Boolean
108
-
109
- # @!attribute language
110
- # Language to use for speech recognition
111
- #
112
- # @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language, nil]
113
- optional :language,
114
- enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language }
115
-
116
- # @!attribute transcription_engine
117
- # Engine identifier for xAI transcription service
118
- #
119
- # @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine, nil]
120
- optional :transcription_engine,
121
- enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine }
122
-
123
- # @!attribute transcription_model
124
- # The model to use for transcription.
125
- #
126
- # @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel, nil]
127
- optional :transcription_model,
128
- enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel }
129
-
130
- # @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
131
- # Some parameter documentations has been truncated, see
132
- # {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI}
133
- # for more details.
134
- #
135
- # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
136
- #
137
- # @param language [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language] Language to use for speech recognition
138
- #
139
- # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine] Engine identifier for xAI transcription service
140
- #
141
- # @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel] The model to use for transcription.
142
-
143
- # Language to use for speech recognition
144
- #
145
- # @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#language
146
- module Language
147
- extend Telnyx::Internal::Type::Enum
148
-
149
- AR = :ar
150
- CS = :cs
151
- DA = :da
152
- DE = :de
153
- EN = :en
154
- ES = :es
155
- FA = :fa
156
- FIL = :fil
157
- FR = :fr
158
- HI = :hi
159
- ID = :id
160
- IT = :it
161
- JA = :ja
162
- KO = :ko
163
- MK = :mk
164
- MS = :ms
165
- NL = :nl
166
- PL = :pl
167
- PT = :pt
168
- RO = :ro
169
- RU = :ru
170
- SV = :sv
171
- TH = :th
172
- TR = :tr
173
- VI = :vi
174
-
175
- # @!method self.values
176
- # @return [Array<Symbol>]
177
- end
178
-
179
- # Engine identifier for xAI transcription service
180
- #
181
- # @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#transcription_engine
182
- module TranscriptionEngine
183
- extend Telnyx::Internal::Type::Enum
184
-
185
- X_AI = :xAI
186
-
187
- # @!method self.values
188
- # @return [Array<Symbol>]
189
- end
190
-
191
- # The model to use for transcription.
192
- #
193
- # @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#transcription_model
194
- module TranscriptionModel
195
- extend Telnyx::Internal::Type::Enum
196
-
197
- XAI_GROK_STT = :"xai/grok-stt"
198
-
199
- # @!method self.values
200
- # @return [Array<Symbol>]
201
- end
202
- end
203
-
204
- class AssemblyAI < Telnyx::Internal::Type::BaseModel
205
- # @!attribute interim_results
206
- # Whether to send also interim results. If set to false, only final results will
207
- # be sent.
208
- #
209
- # @return [Boolean, nil]
210
- optional :interim_results, Telnyx::Internal::Type::Boolean
211
-
212
- # @!attribute transcription_engine
213
- # Engine identifier for AssemblyAI transcription service
214
- #
215
- # @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine, nil]
216
- optional :transcription_engine,
217
- enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine }
218
-
219
- # @!attribute transcription_model
220
- # The model to use for transcription.
221
- #
222
- # @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel, nil]
223
- optional :transcription_model,
224
- enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel }
225
-
226
- # @!method initialize(interim_results: nil, transcription_engine: nil, transcription_model: nil)
227
- # Some parameter documentations has been truncated, see
228
- # {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI}
229
- # for more details.
230
- #
231
- # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
232
- #
233
- # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine] Engine identifier for AssemblyAI transcription service
234
- #
235
- # @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel] The model to use for transcription.
236
-
237
- # Engine identifier for AssemblyAI transcription service
238
- #
239
- # @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI#transcription_engine
240
- module TranscriptionEngine
241
- extend Telnyx::Internal::Type::Enum
242
-
243
- ASSEMBLY_AI = :AssemblyAI
244
-
245
- # @!method self.values
246
- # @return [Array<Symbol>]
247
- end
248
-
249
- # The model to use for transcription.
250
- #
251
- # @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI#transcription_model
252
- module TranscriptionModel
253
- extend Telnyx::Internal::Type::Enum
254
-
255
- ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
256
-
257
- # @!method self.values
258
- # @return [Array<Symbol>]
259
- end
260
- end
261
-
262
103
  # @!method self.variants
263
- # @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
104
+ # @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
264
105
  end
265
106
  end
266
107
  end
@@ -107,7 +107,7 @@ module Telnyx
107
107
  # @!attribute voice_settings
108
108
  # The settings associated with the voice selected
109
109
  #
110
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Xai, nil]
110
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
111
111
  optional :voice_settings, union: -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings }
112
112
 
113
113
  # @!method initialize(id:, payload:, voice:, call_control_ids: nil, command_id: nil, language: nil, payload_type: nil, region: nil, voice_settings: nil, request_options: {})
@@ -130,7 +130,7 @@ module Telnyx
130
130
  #
131
131
  # @param region [Symbol, Telnyx::Models::Conferences::ActionSpeakParams::Region] Region where the conference data is located. Defaults to the region defined in u
132
132
  #
133
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Xai] The settings associated with the voice selected
133
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
134
134
  #
135
135
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
136
136
 
@@ -221,7 +221,7 @@ module Telnyx
221
221
 
222
222
  variant :inworld, -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld }
223
223
 
224
- variant :xai, -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Xai }
224
+ variant :xai, -> { Telnyx::XaiVoiceSettings }
225
225
 
226
226
  class Inworld < Telnyx::Internal::Type::BaseModel
227
227
  # @!attribute type
@@ -234,27 +234,8 @@ module Telnyx
234
234
  # @param type [Symbol, :inworld] Voice settings provider type
235
235
  end
236
236
 
237
- class Xai < Telnyx::Internal::Type::BaseModel
238
- # @!attribute type
239
- # Voice settings provider type
240
- #
241
- # @return [Symbol, :xai]
242
- required :type, const: :xai
243
-
244
- # @!attribute language
245
- # Language code, or `auto` to detect automatically.
246
- #
247
- # @return [String, nil]
248
- optional :language, String
249
-
250
- # @!method initialize(language: nil, type: :xai)
251
- # @param language [String] Language code, or `auto` to detect automatically.
252
- #
253
- # @param type [Symbol, :xai] Voice settings provider type
254
- end
255
-
256
237
  # @!method self.variants
257
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Xai)]
238
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
258
239
  end
259
240
  end
260
241
  end
@@ -49,15 +49,17 @@ module Telnyx
49
49
 
50
50
  # @!attribute media_name
51
51
  # The media_name used for the fax's media. Must point to a file previously
52
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
53
- # and media_url/contents can't be submitted together.
52
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
53
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
54
+ # media_url/contents can't be submitted together.
54
55
  #
55
56
  # @return [String, nil]
56
57
  optional :media_name, String
57
58
 
58
59
  # @!attribute media_url
59
- # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
60
- # media_name/contents can't be submitted together.
60
+ # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
61
+ # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
62
+ # submitted together.
61
63
  #
62
64
  # @return [String, nil]
63
65
  optional :media_url, String
@@ -147,7 +149,7 @@ module Telnyx
147
149
  #
148
150
  # @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
149
151
  #
150
- # @param media_url [String] The URL (or list of URLs) to the PDF used for the fax's media. media_url and med
152
+ # @param media_url [String] The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPE
151
153
  #
152
154
  # @param preview_url [String] If `store_preview` was set to `true`, this is a link to temporary location. Link
153
155
  #
@@ -51,15 +51,17 @@ module Telnyx
51
51
 
52
52
  # @!attribute media_name
53
53
  # The media_name used for the fax's media. Must point to a file previously
54
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
55
- # and media_url/contents can't be submitted together.
54
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
55
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
56
+ # media_url/contents can't be submitted together.
56
57
  #
57
58
  # @return [String, nil]
58
59
  optional :media_name, String
59
60
 
60
61
  # @!attribute media_url
61
- # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
62
- # media_name/contents can't be submitted together.
62
+ # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
63
+ # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
64
+ # submitted together.
63
65
  #
64
66
  # @return [String, nil]
65
67
  optional :media_url, String
@@ -128,7 +130,7 @@ module Telnyx
128
130
  #
129
131
  # @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
130
132
  #
131
- # @param media_url [String] The URL (or list of URLs) to the PDF used for the fax's media. media_url and med
133
+ # @param media_url [String] The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPE
132
134
  #
133
135
  # @param monochrome [Boolean] The flag to enable monochrome, true black and white fax results.
134
136
  #
@@ -113,8 +113,9 @@ module Telnyx
113
113
 
114
114
  # @!attribute media_name
115
115
  # The media_name used for the fax's media. Must point to a file previously
116
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
117
- # and media_url/contents can't be submitted together.
116
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
117
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
118
+ # media_url/contents can't be submitted together.
118
119
  #
119
120
  # @return [String, nil]
120
121
  optional :media_name, String
@@ -113,8 +113,9 @@ module Telnyx
113
113
 
114
114
  # @!attribute media_name
115
115
  # The media_name used for the fax's media. Must point to a file previously
116
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
117
- # and media_url/contents can't be submitted together.
116
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
117
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
118
+ # media_url/contents can't be submitted together.
118
119
  #
119
120
  # @return [String, nil]
120
121
  optional :media_name, String
@@ -107,8 +107,9 @@ module Telnyx
107
107
 
108
108
  # @!attribute media_name
109
109
  # The media_name used for the fax's media. Must point to a file previously
110
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
111
- # and media_url/contents can't be submitted together.
110
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
111
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
112
+ # media_url/contents can't be submitted together.
112
113
  #
113
114
  # @return [String, nil]
114
115
  optional :media_name, String
@@ -107,8 +107,9 @@ module Telnyx
107
107
 
108
108
  # @!attribute media_name
109
109
  # The media_name used for the fax's media. Must point to a file previously
110
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
111
- # and media_url/contents can't be submitted together.
110
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
111
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
112
+ # media_url/contents can't be submitted together.
112
113
  #
113
114
  # @return [String, nil]
114
115
  optional :media_name, String
@@ -107,8 +107,9 @@ module Telnyx
107
107
 
108
108
  # @!attribute media_name
109
109
  # The media_name used for the fax's media. Must point to a file previously
110
- # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
111
- # and media_url/contents can't be submitted together.
110
+ # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
111
+ # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
112
+ # media_url/contents can't be submitted together.
112
113
  #
113
114
  # @return [String, nil]
114
115
  optional :media_name, String