telnyx 5.168.0 → 5.169.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 (267) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +40 -0
  5. data/lib/telnyx/internal/type/union.rb +6 -6
  6. data/lib/telnyx/models/ai/assistant_create_params.rb +6 -6
  7. data/lib/telnyx/models/ai/assistant_tool.rb +285 -12
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +20 -9
  9. data/lib/telnyx/models/ai/assistants/update_assistant.rb +20 -9
  10. data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
  11. data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
  12. data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
  13. data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
  14. data/lib/telnyx/models/ai/flow_node.rb +2 -2
  15. data/lib/telnyx/models/ai/inference_embedding.rb +13 -10
  16. data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
  17. data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +21 -1
  18. data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
  19. data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
  20. data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
  21. data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
  22. data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
  23. data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
  24. data/lib/telnyx/models/ai/tool_node.rb +2 -2
  25. data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
  26. data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
  27. data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +268 -0
  28. data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +222 -0
  29. data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
  30. data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
  31. data/lib/telnyx/models/bot_session_list_params.rb +34 -0
  32. data/lib/telnyx/models/bot_session_list_response.rb +32 -0
  33. data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
  34. data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
  35. data/lib/telnyx/models/call_dial_params.rb +75 -7
  36. data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
  37. data/lib/telnyx/models/calls/transcription_config.rb +14 -3
  38. data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
  39. data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
  40. data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
  41. data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
  42. data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
  43. data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
  44. data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
  45. data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
  46. data/lib/telnyx/models/detail_record_list_params.rb +19 -2
  47. data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
  48. data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
  49. data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
  50. data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
  51. data/lib/telnyx/models/message_retrieve_response.rb +4 -4
  52. data/lib/telnyx/models/message_schedule_response.rb +3 -3
  53. data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
  54. data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
  55. data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
  56. data/lib/telnyx/models/message_send_response.rb +3 -3
  57. data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
  58. data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
  59. data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
  60. data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
  61. data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
  62. data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
  63. data/lib/telnyx/models/number_order_status_update.rb +15 -3
  64. data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
  65. data/lib/telnyx/models/outbound_message.rb +1 -0
  66. data/lib/telnyx/models/outbound_message_payload.rb +45 -5
  67. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
  68. data/lib/telnyx/models/success_response.rb +27 -0
  69. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
  70. data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
  71. data/lib/telnyx/models/texml/call_create_params.rb +78 -0
  72. data/lib/telnyx/models/texml/call_create_response.rb +55 -0
  73. data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
  74. data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
  75. data/lib/telnyx/models.rb +18 -0
  76. data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
  77. data/lib/telnyx/resources/ai/assistants.rb +2 -2
  78. data/lib/telnyx/resources/ai/audio.rb +2 -2
  79. data/lib/telnyx/resources/ai/typesafe/v1.rb +62 -0
  80. data/lib/telnyx/resources/ai/typesafe.rb +22 -0
  81. data/lib/telnyx/resources/ai.rb +4 -0
  82. data/lib/telnyx/resources/bot_challenge.rb +53 -0
  83. data/lib/telnyx/resources/bot_sessions.rb +57 -0
  84. data/lib/telnyx/resources/bot_signup.rb +97 -0
  85. data/lib/telnyx/resources/calls/actions.rb +1 -1
  86. data/lib/telnyx/resources/calls.rb +1 -1
  87. data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
  88. data/lib/telnyx/resources/compute/funcs.rb +4 -0
  89. data/lib/telnyx/resources/connections.rb +20 -0
  90. data/lib/telnyx/resources/detail_records.rb +1 -1
  91. data/lib/telnyx/resources/email_messages.rb +5 -3
  92. data/lib/telnyx/resources/machine_payments.rb +73 -0
  93. data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
  94. data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
  95. data/lib/telnyx/resources/texml/calls.rb +57 -0
  96. data/lib/telnyx/resources/texml.rb +20 -1
  97. data/lib/telnyx/resources/voice_clones.rb +4 -2
  98. data/lib/telnyx/version.rb +1 -1
  99. data/lib/telnyx.rb +33 -0
  100. data/rbi/telnyx/client.rbi +35 -0
  101. data/rbi/telnyx/models/ai/assistant_create_params.rbi +16 -12
  102. data/rbi/telnyx/models/ai/assistant_tool.rbi +423 -20
  103. data/rbi/telnyx/models/ai/assistant_update_params.rbi +42 -16
  104. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +42 -16
  105. data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
  106. data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
  107. data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
  108. data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
  109. data/rbi/telnyx/models/ai/flow_node.rbi +4 -2
  110. data/rbi/telnyx/models/ai/inference_embedding.rbi +24 -16
  111. data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
  112. data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +29 -3
  113. data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
  114. data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
  115. data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
  116. data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
  117. data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
  118. data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
  119. data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
  120. data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
  121. data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
  122. data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +504 -0
  123. data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +348 -0
  124. data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
  125. data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
  126. data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
  127. data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
  128. data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
  129. data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
  130. data/rbi/telnyx/models/call_dial_params.rbi +111 -10
  131. data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
  132. data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
  133. data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
  134. data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
  135. data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
  136. data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
  137. data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
  138. data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
  139. data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
  140. data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
  141. data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
  142. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
  143. data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
  144. data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
  145. data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
  146. data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
  147. data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
  148. data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
  149. data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
  150. data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
  151. data/rbi/telnyx/models/message_send_response.rbi +4 -6
  152. data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
  153. data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
  154. data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
  155. data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
  156. data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
  157. data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
  158. data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
  159. data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
  160. data/rbi/telnyx/models/outbound_message.rbi +5 -0
  161. data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
  162. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
  163. data/rbi/telnyx/models/success_response.rbi +36 -0
  164. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
  165. data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
  166. data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
  167. data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
  168. data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
  169. data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
  170. data/rbi/telnyx/models.rbi +21 -0
  171. data/rbi/telnyx/resources/ai/assistants/versions.rbi +19 -7
  172. data/rbi/telnyx/resources/ai/assistants.rbi +25 -12
  173. data/rbi/telnyx/resources/ai/audio.rbi +20 -9
  174. data/rbi/telnyx/resources/ai/typesafe/v1.rbi +61 -0
  175. data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
  176. data/rbi/telnyx/resources/ai.rbi +3 -0
  177. data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
  178. data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
  179. data/rbi/telnyx/resources/bot_signup.rbi +87 -0
  180. data/rbi/telnyx/resources/calls/actions.rbi +6 -5
  181. data/rbi/telnyx/resources/calls.rbi +6 -5
  182. data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
  183. data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
  184. data/rbi/telnyx/resources/connections.rbi +11 -0
  185. data/rbi/telnyx/resources/detail_records.rbi +12 -1
  186. data/rbi/telnyx/resources/email_messages.rbi +5 -3
  187. data/rbi/telnyx/resources/machine_payments.rbi +64 -0
  188. data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
  189. data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
  190. data/rbi/telnyx/resources/texml/calls.rbi +50 -0
  191. data/rbi/telnyx/resources/texml.rbi +36 -0
  192. data/rbi/telnyx/resources/voice_clones.rbi +4 -2
  193. data/sig/telnyx/client.rbs +10 -0
  194. data/sig/telnyx/models/ai/assistant_tool.rbs +162 -23
  195. data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
  196. data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
  197. data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
  198. data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
  199. data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
  200. data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +10 -3
  201. data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
  202. data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
  203. data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
  204. data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
  205. data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
  206. data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +195 -0
  207. data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +141 -0
  208. data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
  209. data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
  210. data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
  211. data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
  212. data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
  213. data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
  214. data/sig/telnyx/models/call_dial_params.rbs +49 -0
  215. data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
  216. data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
  217. data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
  218. data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
  219. data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
  220. data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
  221. data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
  222. data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
  223. data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
  224. data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
  225. data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
  226. data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
  227. data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
  228. data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
  229. data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
  230. data/sig/telnyx/models/message_schedule_response.rbs +6 -7
  231. data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
  232. data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
  233. data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
  234. data/sig/telnyx/models/message_send_response.rbs +6 -7
  235. data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
  236. data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
  237. data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
  238. data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
  239. data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
  240. data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
  241. data/sig/telnyx/models/number_order_status_update.rbs +14 -4
  242. data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
  243. data/sig/telnyx/models/outbound_message.rbs +2 -1
  244. data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
  245. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
  246. data/sig/telnyx/models/success_response.rbs +15 -0
  247. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
  248. data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
  249. data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
  250. data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
  251. data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
  252. data/sig/telnyx/models.rbs +18 -0
  253. data/sig/telnyx/resources/ai/typesafe/v1.rbs +17 -0
  254. data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
  255. data/sig/telnyx/resources/ai.rbs +2 -0
  256. data/sig/telnyx/resources/bot_challenge.rbs +14 -0
  257. data/sig/telnyx/resources/bot_sessions.rbs +13 -0
  258. data/sig/telnyx/resources/bot_signup.rbs +24 -0
  259. data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
  260. data/sig/telnyx/resources/compute/funcs.rbs +2 -0
  261. data/sig/telnyx/resources/connections.rbs +4 -0
  262. data/sig/telnyx/resources/machine_payments.rbs +12 -0
  263. data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
  264. data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
  265. data/sig/telnyx/resources/texml/calls.rbs +19 -0
  266. data/sig/telnyx/resources/texml.rbs +9 -0
  267. metadata +101 -2
@@ -0,0 +1,222 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ module Typesafe
7
+ # @see Telnyx::Resources::AI::Typesafe::V1#systemone
8
+ class V1SystemoneResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute answers
10
+ # Answers keyed by exactly the question IDs in the request. Each answer type
11
+ # matches its question.
12
+ #
13
+ # @return [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}]
14
+ required :answers,
15
+ -> { Telnyx::Internal::Type::HashOf[union: Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer] }
16
+
17
+ # @!attribute usage
18
+ # Token usage for the completed evaluation.
19
+ #
20
+ # @return [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage]
21
+ required :usage, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage }
22
+
23
+ response_only do
24
+ # @!attribute model
25
+ # Opaque Telnyx-controlled identifier retained for TypeSafe SDK response
26
+ # compatibility. It is not a selectable model name or a guarantee of a particular
27
+ # underlying model.
28
+ #
29
+ # @return [String]
30
+ required :model, String
31
+ end
32
+
33
+ # @!method initialize(answers:, model:, usage:)
34
+ # Some parameter documentations has been truncated, see
35
+ # {Telnyx::Models::AI::Typesafe::V1SystemoneResponse} for more details.
36
+ #
37
+ # A complete synchronous evaluation. Answers are returned directly without a data
38
+ # wrapper.
39
+ #
40
+ # @param answers [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}] Answers keyed by exactly the question IDs in the request. Each answer type match
41
+ #
42
+ # @param model [String] Opaque Telnyx-controlled identifier retained for TypeSafe SDK response compatibi
43
+ #
44
+ # @param usage [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage] Token usage for the completed evaluation.
45
+
46
+ # An answer whose type matches its question.
47
+ module Answer
48
+ extend Telnyx::Internal::Type::Union
49
+
50
+ discriminator :type
51
+
52
+ # A selected option and the distribution across all supplied option keys.
53
+ variant :choice, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice }
54
+
55
+ # A yes/no score with no separate confidence or probabilities fields.
56
+ variant :noul, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul }
57
+
58
+ # An expected rating over the ordered criteria.
59
+ variant :score, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score }
60
+
61
+ class Choice < Telnyx::Internal::Type::BaseModel
62
+ # @!attribute choice
63
+ # The option key with the highest relative score. Ties favor the first option in
64
+ # request order.
65
+ #
66
+ # @return [String]
67
+ required :choice, String
68
+
69
+ # @!attribute confidence
70
+ # Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
71
+ # and N is the number of options. Zero indicates a uniform distribution; one
72
+ # indicates concentration on one option. This is neither the winning probability
73
+ # nor calibrated correctness.
74
+ #
75
+ # @return [Float]
76
+ required :confidence, Float
77
+
78
+ # @!attribute probabilities
79
+ # Relative scores normalized across the supplied options, summing approximately
80
+ # to 1. These are not calibrated probabilities of correctness.
81
+ #
82
+ # @return [Hash{Symbol=>Float}]
83
+ required :probabilities, Telnyx::Internal::Type::HashOf[Float]
84
+
85
+ # @!attribute type
86
+ # Answer type.
87
+ #
88
+ # @return [Symbol, :choice]
89
+ required :type, const: :choice
90
+
91
+ # @!method initialize(choice:, confidence:, probabilities:, type: :choice)
92
+ # Some parameter documentations has been truncated, see
93
+ # {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice} for more
94
+ # details.
95
+ #
96
+ # A selected option and the distribution across all supplied option keys.
97
+ #
98
+ # @param choice [String] The option key with the highest relative score. Ties favor the first option in r
99
+ #
100
+ # @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
101
+ # an
102
+ #
103
+ # @param probabilities [Hash{Symbol=>Float}] Relative scores normalized across the supplied options, summing approximately to
104
+ #
105
+ # @param type [Symbol, :choice] Answer type.
106
+ end
107
+
108
+ class Noul < Telnyx::Internal::Type::BaseModel
109
+ # @!attribute noul
110
+ # Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
111
+ # This is a number, not a Boolean, and is not calibrated correctness.
112
+ #
113
+ # @return [Float]
114
+ required :noul, Float
115
+
116
+ # @!attribute type
117
+ # Answer type.
118
+ #
119
+ # @return [Symbol, :noul]
120
+ required :type, const: :noul
121
+
122
+ # @!method initialize(noul:, type: :noul)
123
+ # Some parameter documentations has been truncated, see
124
+ # {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul} for more
125
+ # details.
126
+ #
127
+ # A yes/no score with no separate confidence or probabilities fields.
128
+ #
129
+ # @param noul [Float] Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
130
+ #
131
+ # @param type [Symbol, :noul] Answer type.
132
+ end
133
+
134
+ class Score < Telnyx::Internal::Type::BaseModel
135
+ # @!attribute confidence
136
+ # Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
137
+ # and N is the number of options. Zero indicates a uniform distribution; one
138
+ # indicates concentration on one option. This is neither the winning probability
139
+ # nor calibrated correctness.
140
+ #
141
+ # @return [Float]
142
+ required :confidence, Float
143
+
144
+ # @!attribute legend
145
+ # Criterion descriptions keyed by stringified zero-based indices, such as "0",
146
+ # "1", and "2".
147
+ #
148
+ # @return [Hash{Symbol=>String}]
149
+ required :legend, Telnyx::Internal::Type::HashOf[String]
150
+
151
+ # @!attribute probabilities
152
+ # Relative scores keyed by the same stringified indices as legend.
153
+ #
154
+ # @return [Hash{Symbol=>Float}]
155
+ required :probabilities, Telnyx::Internal::Type::HashOf[Float]
156
+
157
+ # @!attribute score
158
+ # Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
159
+ # N-1 for N criteria; fractional values are valid.
160
+ #
161
+ # @return [Float]
162
+ required :score, Float
163
+
164
+ # @!attribute type
165
+ # Answer type.
166
+ #
167
+ # @return [Symbol, :score]
168
+ required :type, const: :score
169
+
170
+ # @!method initialize(confidence:, legend:, probabilities:, score:, type: :score)
171
+ # Some parameter documentations has been truncated, see
172
+ # {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score} for more
173
+ # details.
174
+ #
175
+ # An expected rating over the ordered criteria.
176
+ #
177
+ # @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
178
+ # an
179
+ #
180
+ # @param legend [Hash{Symbol=>String}] Criterion descriptions keyed by stringified zero-based indices, such as "0", "1"
181
+ #
182
+ # @param probabilities [Hash{Symbol=>Float}] Relative scores keyed by the same stringified indices as legend.
183
+ #
184
+ # @param score [Float] Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
185
+ #
186
+ # @param type [Symbol, :score] Answer type.
187
+ end
188
+
189
+ # @!method self.variants
190
+ # @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score)]
191
+ end
192
+
193
+ # @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#usage
194
+ class Usage < Telnyx::Internal::Type::BaseModel
195
+ # @!attribute input_tokens
196
+ # Input tokens processed, including shared-context preparation and question
197
+ # evaluation. This can exceed the token count of the unique input text.
198
+ #
199
+ # @return [Integer]
200
+ required :input_tokens, Integer
201
+
202
+ # @!attribute output_tokens
203
+ # Output tokens used for the evaluation, including shared-context preparation.
204
+ #
205
+ # @return [Integer]
206
+ required :output_tokens, Integer
207
+
208
+ # @!method initialize(input_tokens:, output_tokens:)
209
+ # Some parameter documentations has been truncated, see
210
+ # {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage} for more details.
211
+ #
212
+ # Token usage for the completed evaluation.
213
+ #
214
+ # @param input_tokens [Integer] Input tokens processed, including shared-context preparation and question evalua
215
+ #
216
+ # @param output_tokens [Integer] Output tokens used for the evaluation, including shared-context preparation.
217
+ end
218
+ end
219
+ end
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotChallenge#create
6
+ class BotChallengeCreateParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute llm_model_name
11
+ # Name of the LLM the client is using.
12
+ #
13
+ # @return [String, nil]
14
+ optional :llm_model_name, String
15
+
16
+ # @!attribute llm_parameter_count
17
+ # Parameter count of the client LLM.
18
+ #
19
+ # @return [String, nil]
20
+ optional :llm_parameter_count, String
21
+
22
+ # @!attribute llm_quantization
23
+ # Quantization of the client LLM.
24
+ #
25
+ # @return [String, nil]
26
+ optional :llm_quantization, String
27
+
28
+ # @!method initialize(llm_model_name: nil, llm_parameter_count: nil, llm_quantization: nil, request_options: {})
29
+ # @param llm_model_name [String] Name of the LLM the client is using.
30
+ #
31
+ # @param llm_parameter_count [String] Parameter count of the client LLM.
32
+ #
33
+ # @param llm_quantization [String] Quantization of the client LLM.
34
+ #
35
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotChallenge#create
6
+ class BotChallengeCreateResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Telnyx::Models::BotChallengeCreateResponse::Data]
10
+ required :data, -> { Telnyx::Models::BotChallengeCreateResponse::Data }
11
+
12
+ # @!method initialize(data:)
13
+ # @param data [Telnyx::Models::BotChallengeCreateResponse::Data]
14
+
15
+ # @see Telnyx::Models::BotChallengeCreateResponse#data
16
+ class Data < Telnyx::Internal::Type::BaseModel
17
+ # @!attribute challenge_type
18
+ # Type of challenge.
19
+ #
20
+ # @return [Symbol, Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType]
21
+ required :challenge_type, enum: -> { Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType }
22
+
23
+ # @!attribute nonce
24
+ # Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
25
+ # signup request.
26
+ #
27
+ # @return [String]
28
+ required :nonce, String
29
+
30
+ # @!attribute privacy_policy_url
31
+ # Current privacy-policy URL. Echo this back on the signup request.
32
+ #
33
+ # @return [String]
34
+ required :privacy_policy_url, String
35
+
36
+ # @!attribute problem
37
+ # Problem text to solve. Math problems are obfuscated and end with an unobfuscated
38
+ # rounding instruction; string and binary problems are returned as-is.
39
+ #
40
+ # @return [String]
41
+ required :problem, String
42
+
43
+ # @!attribute terms_and_conditions_url
44
+ # Current terms-and-conditions URL. Echo this back on the signup request.
45
+ #
46
+ # @return [String]
47
+ required :terms_and_conditions_url, String
48
+
49
+ # @!attribute precision
50
+ # Decimal places expected in the answer. Present only for math challenges.
51
+ #
52
+ # @return [Integer, nil]
53
+ optional :precision, Integer
54
+
55
+ # @!method initialize(challenge_type:, nonce:, privacy_policy_url:, problem:, terms_and_conditions_url:, precision: nil)
56
+ # Some parameter documentations has been truncated, see
57
+ # {Telnyx::Models::BotChallengeCreateResponse::Data} for more details.
58
+ #
59
+ # @param challenge_type [Symbol, Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType] Type of challenge.
60
+ #
61
+ # @param nonce [String] Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the signu
62
+ #
63
+ # @param privacy_policy_url [String] Current privacy-policy URL. Echo this back on the signup request.
64
+ #
65
+ # @param problem [String] Problem text to solve. Math problems are obfuscated and end with an unobfuscated
66
+ #
67
+ # @param terms_and_conditions_url [String] Current terms-and-conditions URL. Echo this back on the signup request.
68
+ #
69
+ # @param precision [Integer] Decimal places expected in the answer. Present only for math challenges.
70
+
71
+ # Type of challenge.
72
+ #
73
+ # @see Telnyx::Models::BotChallengeCreateResponse::Data#challenge_type
74
+ module ChallengeType
75
+ extend Telnyx::Internal::Type::Enum
76
+
77
+ MATH = :math
78
+ STRING = :string
79
+ BINARY = :binary
80
+
81
+ # @!method self.values
82
+ # @return [Array<Symbol>]
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotSessions#list
6
+ class BotSessionListParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute email
11
+ # Email address associated with the magic link token.
12
+ #
13
+ # @return [String]
14
+ required :email, String
15
+
16
+ # @!attribute portal_redirect_token
17
+ # Single-use portal redirect (magic link) token, a UUIDv7 sent to the account
18
+ # owner's email.
19
+ #
20
+ # @return [String]
21
+ required :portal_redirect_token, String
22
+
23
+ # @!method initialize(email:, portal_redirect_token:, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Telnyx::Models::BotSessionListParams} for more details.
26
+ #
27
+ # @param email [String] Email address associated with the magic link token.
28
+ #
29
+ # @param portal_redirect_token [String] Single-use portal redirect (magic link) token, a UUIDv7 sent to the account owne
30
+ #
31
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotSessions#list
6
+ class BotSessionListResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Telnyx::Models::BotSessionListResponse::Data]
10
+ required :data, -> { Telnyx::Models::BotSessionListResponse::Data }
11
+
12
+ # @!method initialize(data:)
13
+ # @param data [Telnyx::Models::BotSessionListResponse::Data]
14
+
15
+ # @see Telnyx::Models::BotSessionListResponse#data
16
+ class Data < Telnyx::Internal::Type::BaseModel
17
+ # @!attribute api_v2_token
18
+ # API v2 session token for the signed-in user. Use it as a bearer token on
19
+ # authenticated endpoints.
20
+ #
21
+ # @return [String]
22
+ required :api_v2_token, String
23
+
24
+ # @!method initialize(api_v2_token:)
25
+ # Some parameter documentations has been truncated, see
26
+ # {Telnyx::Models::BotSessionListResponse::Data} for more details.
27
+ #
28
+ # @param api_v2_token [String] API v2 session token for the signed-in user. Use it as a bearer token on authent
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotSignup#create
6
+ class BotSignupCreateParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute bot_challenge_answer
11
+ # Answer to the issued bot challenge.
12
+ #
13
+ # @return [String]
14
+ required :bot_challenge_answer, String
15
+
16
+ # @!attribute bot_challenge_nonce
17
+ # Nonce from a previously issued bot challenge.
18
+ #
19
+ # @return [String]
20
+ required :bot_challenge_nonce, String
21
+
22
+ # @!attribute privacy_policy_url
23
+ # Must exactly match the privacy-policy URL returned by the challenge endpoint.
24
+ #
25
+ # @return [String]
26
+ required :privacy_policy_url, String
27
+
28
+ # @!attribute terms_and_conditions_url
29
+ # Must exactly match the terms-and-conditions URL returned by the challenge
30
+ # endpoint.
31
+ #
32
+ # @return [String]
33
+ required :terms_and_conditions_url, String
34
+
35
+ # @!attribute terms_of_service
36
+ # Must be true to accept the terms of service.
37
+ #
38
+ # @return [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfService]
39
+ required :terms_of_service, enum: -> { Telnyx::BotSignupCreateParams::TermsOfService }
40
+
41
+ # @!attribute email
42
+ # Email address for the new account. The magic link is sent here. May only be
43
+ # omitted when placeholder-email registration is enabled server-side.
44
+ #
45
+ # @return [String, nil]
46
+ optional :email, String
47
+
48
+ # @!attribute terms_and_conditions_eu_url
49
+ # EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
50
+ #
51
+ # @return [String, nil]
52
+ optional :terms_and_conditions_eu_url, String
53
+
54
+ # @!attribute terms_of_service_eu
55
+ # EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
56
+ #
57
+ # @return [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfServiceEu, nil]
58
+ optional :terms_of_service_eu, enum: -> { Telnyx::BotSignupCreateParams::TermsOfServiceEu }
59
+
60
+ # @!method initialize(bot_challenge_answer:, bot_challenge_nonce:, privacy_policy_url:, terms_and_conditions_url:, terms_of_service:, email: nil, terms_and_conditions_eu_url: nil, terms_of_service_eu: nil, request_options: {})
61
+ # Some parameter documentations has been truncated, see
62
+ # {Telnyx::Models::BotSignupCreateParams} for more details.
63
+ #
64
+ # @param bot_challenge_answer [String] Answer to the issued bot challenge.
65
+ #
66
+ # @param bot_challenge_nonce [String] Nonce from a previously issued bot challenge.
67
+ #
68
+ # @param privacy_policy_url [String] Must exactly match the privacy-policy URL returned by the challenge endpoint.
69
+ #
70
+ # @param terms_and_conditions_url [String] Must exactly match the terms-and-conditions URL returned by the challenge endpoi
71
+ #
72
+ # @param terms_of_service [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfService] Must be true to accept the terms of service.
73
+ #
74
+ # @param email [String] Email address for the new account. The magic link is sent here. May only be omit
75
+ #
76
+ # @param terms_and_conditions_eu_url [String] EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
77
+ #
78
+ # @param terms_of_service_eu [Boolean, Telnyx::Models::BotSignupCreateParams::TermsOfServiceEu] EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
79
+ #
80
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
81
+
82
+ # Must be true to accept the terms of service.
83
+ module TermsOfService
84
+ extend Telnyx::Internal::Type::Enum
85
+
86
+ TRUE = true
87
+
88
+ # @!method self.values
89
+ # @return [Array<Boolean>]
90
+ end
91
+
92
+ # EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
93
+ module TermsOfServiceEu
94
+ extend Telnyx::Internal::Type::Enum
95
+
96
+ TRUE = true
97
+
98
+ # @!method self.values
99
+ # @return [Array<Boolean>]
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::BotSignup#resend_magic_link
6
+ class BotSignupResendMagicLinkParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute email
11
+ # Email address of the bot signup account to resend the magic link to.
12
+ #
13
+ # @return [String]
14
+ required :email, String
15
+
16
+ # @!method initialize(email:, request_options: {})
17
+ # @param email [String] Email address of the bot signup account to resend the magic link to.
18
+ #
19
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -159,11 +159,12 @@ module Telnyx
159
159
  optional :dialogflow_config, -> { Telnyx::DialogflowConfig }
160
160
 
161
161
  # @!attribute diversion
162
- # The number the inbound call being transferred was originally received on, in
163
- # +E164 format. Supplying it lets an unverified non-Telnyx `from` be used as the
164
- # caller id, provided that number is still on an active inbound call to this
165
- # `diversion` number for your account. The `diversion` number itself must be one
166
- # you own or have verified.
162
+ # The `to` number of an active inbound call, in +E164 format. Telnyx checks
163
+ # whether there is currently an active inbound call where `to` matches this
164
+ # `diversion` value and `from` matches the `from` number supplied for this
165
+ # request. If such a call exists, the `from` number is treated as verified (since
166
+ # it is already on an active inbound call to you) and can be used as the caller id
167
+ # for this outbound call.
167
168
  #
168
169
  # @return [String, nil]
169
170
  optional :diversion, String
@@ -555,7 +556,7 @@ module Telnyx
555
556
  #
556
557
  # @param dialogflow_config [Telnyx::Models::DialogflowConfig]
557
558
  #
558
- # @param diversion [String] The number the inbound call being transferred was originally received on, in +E1
559
+ # @param diversion [String] The `to` number of an active inbound call, in +E164 format. Telnyx checks whethe
559
560
  #
560
561
  # @param enable_dialogflow [Boolean] Enables Dialogflow for the current call. The default value is false.
561
562
  #
@@ -727,6 +728,59 @@ module Telnyx
727
728
  optional :beep_detection_profile,
728
729
  enum: -> { Telnyx::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile }
729
730
 
731
+ # @!attribute beep_max_frequency_hz
732
+ # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
733
+ # Only used when beep detection is active.
734
+ #
735
+ # @return [Integer, nil]
736
+ optional :beep_max_frequency_hz, Integer
737
+
738
+ # @!attribute beep_min_frequency_hz
739
+ # Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
740
+ # it above 480 excludes North American ringback (440 + 480 Hz), which can
741
+ # otherwise be reported as a beep when the `freq_only` profile is in use. Only
742
+ # used when beep detection is active.
743
+ #
744
+ # @return [Integer, nil]
745
+ optional :beep_min_frequency_hz, Integer
746
+
747
+ # @!attribute beep_min_tone_duration_millis
748
+ # Shortest tone, in milliseconds, that can be treated as a beep. Raising it
749
+ # rejects brief tones such as call-progress blips. Only used when beep detection
750
+ # is active.
751
+ #
752
+ # @return [Integer, nil]
753
+ optional :beep_min_tone_duration_millis, Integer
754
+
755
+ # @!attribute beep_spectral_confirmation
756
+ # When enabled, a candidate beep must pass an additional spectral check before it
757
+ # is reported. Only used when beep detection is active.
758
+ #
759
+ # @return [Boolean, nil]
760
+ optional :beep_spectral_confirmation, Telnyx::Internal::Type::Boolean
761
+
762
+ # @!attribute beep_spectral_min_purity
763
+ # Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
764
+ # Raising it rejects mixed tones such as ringback, which combines two frequencies.
765
+ # Only used when beep detection is active.
766
+ #
767
+ # @return [Float, nil]
768
+ optional :beep_spectral_min_purity, Float
769
+
770
+ # @!attribute beep_spectral_reject_fax_cng
771
+ # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
772
+ # used when beep detection is active.
773
+ #
774
+ # @return [Boolean, nil]
775
+ optional :beep_spectral_reject_fax_cng, Telnyx::Internal::Type::Boolean
776
+
777
+ # @!attribute beep_spectral_window_millis
778
+ # Length of the spectral confirmation window, in milliseconds. Only used when beep
779
+ # detection is active.
780
+ #
781
+ # @return [Integer, nil]
782
+ optional :beep_spectral_window_millis, Integer
783
+
730
784
  # @!attribute between_words_silence_millis
731
785
  # Maximum threshold for silence between words.
732
786
  #
@@ -784,7 +838,7 @@ module Telnyx
784
838
  # @return [Integer, nil]
785
839
  optional :total_analysis_time_millis, Integer
786
840
 
787
- # @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
841
+ # @!method initialize(after_greeting_silence_millis: nil, beep_detection_profile: nil, beep_max_frequency_hz: nil, beep_min_frequency_hz: nil, beep_min_tone_duration_millis: nil, beep_spectral_confirmation: nil, beep_spectral_min_purity: nil, beep_spectral_reject_fax_cng: nil, beep_spectral_window_millis: nil, between_words_silence_millis: nil, greeting_duration_millis: nil, greeting_silence_duration_millis: nil, greeting_total_analysis_time_millis: nil, initial_silence_millis: nil, maximum_number_of_words: nil, maximum_word_length_millis: nil, silence_threshold: nil, total_analysis_time_millis: nil)
788
842
  # Some parameter documentations has been truncated, see
789
843
  # {Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig} for more
790
844
  # details.
@@ -798,6 +852,20 @@ module Telnyx
798
852
  #
799
853
  # @param beep_detection_profile [Symbol, Telnyx::Models::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile] Selects which detectors must validate a beep. `both` requires the amplitude and
800
854
  #
855
+ # @param beep_max_frequency_hz [Integer] Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
856
+ #
857
+ # @param beep_min_frequency_hz [Integer] Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
858
+ #
859
+ # @param beep_min_tone_duration_millis [Integer] Shortest tone, in milliseconds, that can be treated as a beep. Raising it reject
860
+ #
861
+ # @param beep_spectral_confirmation [Boolean] When enabled, a candidate beep must pass an additional spectral check before it
862
+ #
863
+ # @param beep_spectral_min_purity [Float] Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep. Raisin
864
+ #
865
+ # @param beep_spectral_reject_fax_cng [Boolean] When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
866
+ #
867
+ # @param beep_spectral_window_millis [Integer] Length of the spectral confirmation window, in milliseconds. Only used when beep
868
+ #
801
869
  # @param between_words_silence_millis [Integer] Maximum threshold for silence between words.
802
870
  #
803
871
  # @param greeting_duration_millis [Integer] Maximum threshold of a human greeting. If greeting longer than this value, consi