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
@@ -27,6 +27,8 @@ module Telnyx
27
27
  module Params
28
28
  extend Telnyx::Internal::Type::Union
29
29
 
30
+ discriminator :Url
31
+
30
32
  variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL }
31
33
 
32
34
  variant -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml }
@@ -137,7 +139,9 @@ module Telnyx
137
139
  optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
138
140
 
139
141
  # @!attribute detection_mode
140
- # Allows you to chose between Premium and Standard detections.
142
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
143
+ # detections. See
144
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
141
145
  #
142
146
  # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode, nil]
143
147
  optional :detection_mode,
@@ -168,6 +172,15 @@ module Telnyx
168
172
  },
169
173
  api_name: :MachineDetection
170
174
 
175
+ # @!attribute machine_detection_prompt_end_timeout
176
+ # Silence duration threshold after a call screening prompt before ending prompt
177
+ # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
178
+ #
179
+ # @return [Integer, nil]
180
+ optional :machine_detection_prompt_end_timeout,
181
+ Integer,
182
+ api_name: :MachineDetectionPromptEndTimeout
183
+
171
184
  # @!attribute machine_detection_silence_timeout
172
185
  # If initial silence duration is greater than this value, consider it a machine.
173
186
  # Ignored when `premium` detection is used.
@@ -393,7 +406,7 @@ module Telnyx
393
406
  enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
394
407
  api_name: :UrlMethod
395
408
 
396
- # @!method initialize(url:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url_method: nil)
409
+ # @!method initialize(url:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url_method: nil)
397
410
  # Some parameter documentations has been truncated, see
398
411
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL} for more
399
412
  # details.
@@ -422,7 +435,7 @@ module Telnyx
422
435
  #
423
436
  # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
424
437
  #
425
- # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to chose between Premium and Standard detections.
438
+ # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
426
439
  #
427
440
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
428
441
  #
@@ -430,6 +443,8 @@ module Telnyx
430
443
  #
431
444
  # @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::MachineDetection] Enables Answering Machine Detection.
432
445
  #
446
+ # @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
447
+ #
433
448
  # @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
434
449
  #
435
450
  # @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
@@ -546,7 +561,9 @@ module Telnyx
546
561
  # @return [Array<Symbol>]
547
562
  end
548
563
 
549
- # Allows you to chose between Premium and Standard detections.
564
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
565
+ # detections. See
566
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
550
567
  #
551
568
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#detection_mode
552
569
  module DetectionMode
@@ -554,6 +571,7 @@ module Telnyx
554
571
 
555
572
  PREMIUM = :Premium
556
573
  REGULAR = :Regular
574
+ PREMIUM_CALL_SCREENING = :PremiumCallScreening
557
575
 
558
576
  # @!method self.values
559
577
  # @return [Array<Symbol>]
@@ -825,7 +843,9 @@ module Telnyx
825
843
  optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
826
844
 
827
845
  # @!attribute detection_mode
828
- # Allows you to chose between Premium and Standard detections.
846
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
847
+ # detections. See
848
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
829
849
  #
830
850
  # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode, nil]
831
851
  optional :detection_mode,
@@ -858,6 +878,15 @@ module Telnyx
858
878
  },
859
879
  api_name: :MachineDetection
860
880
 
881
+ # @!attribute machine_detection_prompt_end_timeout
882
+ # Silence duration threshold after a call screening prompt before ending prompt
883
+ # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
884
+ #
885
+ # @return [Integer, nil]
886
+ optional :machine_detection_prompt_end_timeout,
887
+ Integer,
888
+ api_name: :MachineDetectionPromptEndTimeout
889
+
861
890
  # @!attribute machine_detection_silence_timeout
862
891
  # If initial silence duration is greater than this value, consider it a machine.
863
892
  # Ignored when `premium` detection is used.
@@ -1085,7 +1114,7 @@ module Telnyx
1085
1114
  enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod },
1086
1115
  api_name: :UrlMethod
1087
1116
 
1088
- # @!method initialize(texml:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1117
+ # @!method initialize(texml:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1089
1118
  # Some parameter documentations has been truncated, see
1090
1119
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml} for more
1091
1120
  # details.
@@ -1114,7 +1143,7 @@ module Telnyx
1114
1143
  #
1115
1144
  # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
1116
1145
  #
1117
- # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to chose between Premium and Standard detections.
1146
+ # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
1118
1147
  #
1119
1148
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
1120
1149
  #
@@ -1122,6 +1151,8 @@ module Telnyx
1122
1151
  #
1123
1152
  # @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::MachineDetection] Enables Answering Machine Detection.
1124
1153
  #
1154
+ # @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
1155
+ #
1125
1156
  # @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
1126
1157
  #
1127
1158
  # @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
@@ -1238,7 +1269,9 @@ module Telnyx
1238
1269
  # @return [Array<Symbol>]
1239
1270
  end
1240
1271
 
1241
- # Allows you to chose between Premium and Standard detections.
1272
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
1273
+ # detections. See
1274
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
1242
1275
  #
1243
1276
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#detection_mode
1244
1277
  module DetectionMode
@@ -1246,6 +1279,7 @@ module Telnyx
1246
1279
 
1247
1280
  PREMIUM = :Premium
1248
1281
  REGULAR = :Regular
1282
+ PREMIUM_CALL_SCREENING = :PremiumCallScreening
1249
1283
 
1250
1284
  # @!method self.values
1251
1285
  # @return [Array<Symbol>]
@@ -1510,7 +1544,9 @@ module Telnyx
1510
1544
  optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
1511
1545
 
1512
1546
  # @!attribute detection_mode
1513
- # Allows you to chose between Premium and Standard detections.
1547
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
1548
+ # detections. See
1549
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
1514
1550
  #
1515
1551
  # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode, nil]
1516
1552
  optional :detection_mode,
@@ -1543,6 +1579,15 @@ module Telnyx
1543
1579
  },
1544
1580
  api_name: :MachineDetection
1545
1581
 
1582
+ # @!attribute machine_detection_prompt_end_timeout
1583
+ # Silence duration threshold after a call screening prompt before ending prompt
1584
+ # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
1585
+ #
1586
+ # @return [Integer, nil]
1587
+ optional :machine_detection_prompt_end_timeout,
1588
+ Integer,
1589
+ api_name: :MachineDetectionPromptEndTimeout
1590
+
1546
1591
  # @!attribute machine_detection_silence_timeout
1547
1592
  # If initial silence duration is greater than this value, consider it a machine.
1548
1593
  # Ignored when `premium` detection is used.
@@ -1781,7 +1826,7 @@ module Telnyx
1781
1826
  },
1782
1827
  api_name: :UrlMethod
1783
1828
 
1784
- # @!method initialize(application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1829
+ # @!method initialize(application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1785
1830
  # Some parameter documentations has been truncated, see
1786
1831
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault}
1787
1832
  # for more details.
@@ -1808,7 +1853,7 @@ module Telnyx
1808
1853
  #
1809
1854
  # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
1810
1855
  #
1811
- # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to chose between Premium and Standard detections.
1856
+ # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
1812
1857
  #
1813
1858
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
1814
1859
  #
@@ -1816,6 +1861,8 @@ module Telnyx
1816
1861
  #
1817
1862
  # @param machine_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::MachineDetection] Enables Answering Machine Detection.
1818
1863
  #
1864
+ # @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
1865
+ #
1819
1866
  # @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
1820
1867
  #
1821
1868
  # @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
@@ -1934,7 +1981,9 @@ module Telnyx
1934
1981
  # @return [Array<Symbol>]
1935
1982
  end
1936
1983
 
1937
- # Allows you to chose between Premium and Standard detections.
1984
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
1985
+ # detections. See
1986
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
1938
1987
  #
1939
1988
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#detection_mode
1940
1989
  module DetectionMode
@@ -1942,6 +1991,7 @@ module Telnyx
1942
1991
 
1943
1992
  PREMIUM = :Premium
1944
1993
  REGULAR = :Regular
1994
+ PREMIUM_CALL_SCREENING = :PremiumCallScreening
1945
1995
 
1946
1996
  # @!method self.values
1947
1997
  # @return [Array<Symbol>]
@@ -110,7 +110,9 @@ module Telnyx
110
110
  api_name: :CustomHeaders
111
111
 
112
112
  # @!attribute detection_mode
113
- # Allows you to choose between Premium and Standard detections.
113
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
114
+ # detections. See
115
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
114
116
  #
115
117
  # @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode, nil]
116
118
  optional :detection_mode,
@@ -125,6 +127,13 @@ module Telnyx
125
127
  enum: -> { Telnyx::TexmlInitiateAICallParams::MachineDetection },
126
128
  api_name: :MachineDetection
127
129
 
130
+ # @!attribute machine_detection_prompt_end_timeout
131
+ # Silence duration threshold after a call screening prompt before ending prompt
132
+ # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
133
+ #
134
+ # @return [Integer, nil]
135
+ optional :machine_detection_prompt_end_timeout, Integer, api_name: :MachineDetectionPromptEndTimeout
136
+
128
137
  # @!attribute machine_detection_silence_timeout
129
138
  # If initial silence duration is greater than this value, consider it a machine.
130
139
  # Ignored when `premium` detection is used.
@@ -298,7 +307,7 @@ module Telnyx
298
307
  # @return [Symbol, Telnyx::Models::TexmlInitiateAICallParams::Trim, nil]
299
308
  optional :trim, enum: -> { Telnyx::TexmlInitiateAICallParams::Trim }, api_name: :Trim
300
309
 
301
- # @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
310
+ # @!method initialize(connection_id:, ai_assistant_id:, from:, to:, ai_assistant_dynamic_variables: nil, ai_assistant_version: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, conversation_callback: nil, conversation_callback_method: nil, conversation_callbacks: nil, custom_headers: nil, detection_mode: nil, machine_detection: nil, machine_detection_prompt_end_timeout: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, passports: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, status_callbacks: nil, time_limit: nil, timeout_seconds: nil, trim: nil, request_options: {})
302
311
  # Some parameter documentations has been truncated, see
303
312
  # {Telnyx::Models::TexmlInitiateAICallParams} for more details.
304
313
  #
@@ -330,10 +339,12 @@ module Telnyx
330
339
  #
331
340
  # @param custom_headers [Array<Telnyx::Models::TexmlInitiateAICallParams::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
332
341
  #
333
- # @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Premium and Standard detections.
342
+ # @param detection_mode [Symbol, Telnyx::Models::TexmlInitiateAICallParams::DetectionMode] Allows you to choose between Regular, Premium, and PremiumCallScreening detectio
334
343
  #
335
344
  # @param machine_detection [Symbol, Telnyx::Models::TexmlInitiateAICallParams::MachineDetection] Enables Answering Machine Detection.
336
345
  #
346
+ # @param machine_detection_prompt_end_timeout [Integer] Silence duration threshold after a call screening prompt before ending prompt de
347
+ #
337
348
  # @param machine_detection_silence_timeout [Integer] If initial silence duration is greater than this value, consider it a machine. I
338
349
  #
339
350
  # @param machine_detection_speech_end_threshold [Integer] Silence duration threshold after a greeting message or voice for it be considere
@@ -425,12 +436,15 @@ module Telnyx
425
436
  # @param value [String] The value of the custom header
426
437
  end
427
438
 
428
- # Allows you to choose between Premium and Standard detections.
439
+ # Allows you to choose between Regular, Premium, and PremiumCallScreening
440
+ # detections. See
441
+ # https://developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection
429
442
  module DetectionMode
430
443
  extend Telnyx::Internal::Type::Enum
431
444
 
432
445
  PREMIUM = :Premium
433
446
  REGULAR = :Regular
447
+ PREMIUM_CALL_SCREENING = :PremiumCallScreening
434
448
 
435
449
  # @!method self.values
436
450
  # @return [Array<Symbol>]
@@ -622,12 +622,12 @@ module Telnyx
622
622
  module SampleRate
623
623
  extend ::Telnyx::Internal::Type::Enum
624
624
 
625
- SAMPLE_RATE_8000 = 8000
626
- SAMPLE_RATE_16000 = 16_000
627
- SAMPLE_RATE_22050 = 22_050
628
- SAMPLE_RATE_24000 = 24_000
629
- SAMPLE_RATE_44100 = 44_100
630
- SAMPLE_RATE_48000 = 48_000
625
+ RATE_8000 = 8000
626
+ RATE_16000 = 16_000
627
+ RATE_22050 = 22_050
628
+ RATE_24000 = 24_000
629
+ RATE_44100 = 44_100
630
+ RATE_48000 = 48_000
631
631
 
632
632
  # @!method self.values
633
633
  # @return [Array<Integer>]