telnyx 5.0.0 → 5.2.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 (289) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +46 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +4 -0
  5. data/lib/telnyx/internal/type/union.rb +1 -1
  6. data/lib/telnyx/models/ai/assistant.rb +39 -4
  7. data/lib/telnyx/models/ai/assistant_create_params.rb +17 -6
  8. data/lib/telnyx/models/ai/assistant_imports_params.rb +10 -1
  9. data/lib/telnyx/models/ai/assistant_tool.rb +400 -3
  10. data/lib/telnyx/models/ai/assistant_update_params.rb +17 -6
  11. data/lib/telnyx/models/ai/assistants/update_assistant.rb +17 -6
  12. data/lib/telnyx/models/ai/audio_visualizer_config.rb +43 -0
  13. data/lib/telnyx/models/ai/bucket_ids.rb +7 -1
  14. data/lib/telnyx/models/ai/chat_create_completion_params.rb +4 -4
  15. data/lib/telnyx/models/ai/inference_embedding.rb +17 -6
  16. data/lib/telnyx/models/ai/messaging_settings.rb +10 -1
  17. data/lib/telnyx/models/ai/retrieval_tool.rb +3 -3
  18. data/lib/telnyx/models/ai/telephony_settings.rb +142 -1
  19. data/lib/telnyx/models/ai/transfer_tool.rb +46 -3
  20. data/lib/telnyx/models/ai/voice_settings.rb +1 -1
  21. data/lib/telnyx/models/ai/webhook_tool.rb +256 -3
  22. data/lib/telnyx/models/ai/widget_settings.rb +138 -0
  23. data/lib/telnyx/models/call_control_application_list_params.rb +16 -18
  24. data/lib/telnyx/models/call_event_list_params.rb +16 -18
  25. data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +289 -0
  26. data/lib/telnyx/models/calls/action_add_ai_assistant_messages_response.rb +18 -0
  27. data/lib/telnyx/models/calls/action_start_noise_suppression_params.rb +7 -4
  28. data/lib/telnyx/models/conference_list_params.rb +16 -18
  29. data/lib/telnyx/models/conference_list_participants_params.rb +16 -18
  30. data/lib/telnyx/models/connection_list_active_calls_params.rb +16 -18
  31. data/lib/telnyx/models/connection_noise_suppression_details.rb +61 -0
  32. data/lib/telnyx/models/credential_connection.rb +3 -61
  33. data/lib/telnyx/models/credential_connection_create_params.rb +3 -61
  34. data/lib/telnyx/models/credential_connection_update_params.rb +3 -61
  35. data/lib/telnyx/models/fax_create_params.rb +10 -1
  36. data/lib/telnyx/models/fqdn_connection.rb +3 -60
  37. data/lib/telnyx/models/fqdn_connection_create_params.rb +3 -60
  38. data/lib/telnyx/models/fqdn_connection_update_params.rb +3 -60
  39. data/lib/telnyx/models/ip_connection.rb +3 -60
  40. data/lib/telnyx/models/ip_connection_create_params.rb +3 -60
  41. data/lib/telnyx/models/ip_connection_update_params.rb +3 -60
  42. data/lib/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rb +1 -9
  43. data/lib/telnyx/models/messaging_profile.rb +11 -1
  44. data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
  45. data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
  46. data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +14 -1
  47. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +17 -1
  48. data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +17 -1
  49. data/lib/telnyx/models/organizations/user_get_groups_report_params.rb +32 -0
  50. data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +110 -0
  51. data/lib/telnyx/models/organizations/user_group_reference.rb +28 -0
  52. data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
  53. data/lib/telnyx/models/organizations/user_list_response.rb +96 -0
  54. data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
  55. data/lib/telnyx/models/organizations/user_retrieve_response.rb +107 -0
  56. data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
  57. data/lib/telnyx/models/organizations/users/action_remove_response.rb +111 -0
  58. data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
  59. data/lib/telnyx/models/queues/call_list_params.rb +16 -18
  60. data/lib/telnyx/models/sim_card_list_params.rb +11 -3
  61. data/lib/telnyx/models/texml/accounts/queue_list_params.rb +64 -0
  62. data/lib/telnyx/models/texml/accounts/queue_list_response.rb +155 -0
  63. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +1 -7
  64. data/lib/telnyx/models/unwrap_webhook_event.rb +1 -7
  65. data/lib/telnyx/models.rb +4 -6
  66. data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
  67. data/lib/telnyx/resources/ai/assistants/versions.rb +18 -16
  68. data/lib/telnyx/resources/ai/assistants.rb +15 -9
  69. data/lib/telnyx/resources/ai/clusters.rb +1 -1
  70. data/lib/telnyx/resources/ai/embeddings.rb +1 -1
  71. data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +1 -1
  72. data/lib/telnyx/resources/call_control_applications.rb +8 -4
  73. data/lib/telnyx/resources/call_events.rb +8 -4
  74. data/lib/telnyx/resources/calls/actions.rb +31 -0
  75. data/lib/telnyx/resources/conferences.rb +16 -8
  76. data/lib/telnyx/resources/connections.rb +8 -4
  77. data/lib/telnyx/resources/credential_connections.rb +2 -2
  78. data/lib/telnyx/resources/faxes.rb +3 -1
  79. data/lib/telnyx/resources/fqdn_connections.rb +2 -2
  80. data/lib/telnyx/resources/ip_connections.rb +2 -2
  81. data/lib/telnyx/resources/messages.rb +1 -1
  82. data/lib/telnyx/resources/messaging_10dlc/brand.rb +10 -14
  83. data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +6 -6
  84. data/lib/telnyx/resources/messaging_profiles.rb +6 -2
  85. data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +6 -2
  86. data/lib/telnyx/resources/operator_connect/actions.rb +1 -1
  87. data/lib/telnyx/resources/organizations/users/actions.rb +38 -0
  88. data/lib/telnyx/resources/organizations/users.rb +114 -0
  89. data/lib/telnyx/resources/organizations.rb +18 -0
  90. data/lib/telnyx/resources/phone_numbers/jobs.rb +1 -1
  91. data/lib/telnyx/resources/queues/calls.rb +8 -4
  92. data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
  93. data/lib/telnyx/resources/texml/accounts/calls/recordings.rb +1 -1
  94. data/lib/telnyx/resources/texml/accounts/queues.rb +41 -0
  95. data/lib/telnyx/resources/usage_reports.rb +2 -2
  96. data/lib/telnyx/resources/webhooks.rb +2 -2
  97. data/lib/telnyx/version.rb +1 -1
  98. data/lib/telnyx.rb +19 -69
  99. data/rbi/telnyx/client.rbi +3 -0
  100. data/rbi/telnyx/models/ai/assistant.rbi +91 -5
  101. data/rbi/telnyx/models/ai/assistant_create_params.rbi +31 -14
  102. data/rbi/telnyx/models/ai/assistant_imports_params.rbi +13 -0
  103. data/rbi/telnyx/models/ai/assistant_tool.rbi +910 -2
  104. data/rbi/telnyx/models/ai/assistant_update_params.rbi +31 -14
  105. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +36 -17
  106. data/rbi/telnyx/models/ai/audio_visualizer_config.rbi +107 -0
  107. data/rbi/telnyx/models/ai/bucket_ids.rbi +6 -0
  108. data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +6 -13
  109. data/rbi/telnyx/models/ai/inference_embedding.rbi +30 -13
  110. data/rbi/telnyx/models/ai/messaging_settings.rbi +13 -0
  111. data/rbi/telnyx/models/ai/retrieval_tool.rbi +4 -8
  112. data/rbi/telnyx/models/ai/telephony_settings.rbi +347 -3
  113. data/rbi/telnyx/models/ai/transfer_tool.rbi +87 -6
  114. data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
  115. data/rbi/telnyx/models/ai/webhook_tool.rbi +584 -8
  116. data/rbi/telnyx/models/ai/widget_settings.rbi +225 -0
  117. data/rbi/telnyx/models/call_control_application_list_params.rbi +23 -35
  118. data/rbi/telnyx/models/call_event_list_params.rbi +23 -35
  119. data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +583 -0
  120. data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_response.rbi +39 -0
  121. data/rbi/telnyx/models/calls/action_start_noise_suppression_params.rbi +14 -6
  122. data/rbi/telnyx/models/conference_list_params.rbi +23 -35
  123. data/rbi/telnyx/models/conference_list_participants_params.rbi +23 -35
  124. data/rbi/telnyx/models/connection_list_active_calls_params.rbi +23 -35
  125. data/rbi/telnyx/models/connection_noise_suppression_details.rbi +141 -0
  126. data/rbi/telnyx/models/credential_connection.rbi +4 -152
  127. data/rbi/telnyx/models/credential_connection_create_params.rbi +4 -154
  128. data/rbi/telnyx/models/credential_connection_update_params.rbi +4 -154
  129. data/rbi/telnyx/models/fax_create_params.rbi +13 -0
  130. data/rbi/telnyx/models/fqdn_connection.rbi +4 -150
  131. data/rbi/telnyx/models/fqdn_connection_create_params.rbi +4 -152
  132. data/rbi/telnyx/models/fqdn_connection_update_params.rbi +4 -152
  133. data/rbi/telnyx/models/ip_connection.rbi +4 -148
  134. data/rbi/telnyx/models/ip_connection_create_params.rbi +4 -152
  135. data/rbi/telnyx/models/ip_connection_update_params.rbi +4 -152
  136. data/rbi/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbi +5 -21
  137. data/rbi/telnyx/models/messaging_profile.rbi +15 -0
  138. data/rbi/telnyx/models/messaging_profile_create_params.rbi +15 -0
  139. data/rbi/telnyx/models/messaging_profile_update_params.rbi +15 -0
  140. data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +12 -0
  141. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +10 -0
  142. data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +10 -0
  143. data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi +93 -0
  144. data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +210 -0
  145. data/rbi/telnyx/models/organizations/user_group_reference.rbi +39 -0
  146. data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
  147. data/rbi/telnyx/models/organizations/user_list_response.rbi +188 -0
  148. data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
  149. data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +232 -0
  150. data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
  151. data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +239 -0
  152. data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
  153. data/rbi/telnyx/models/queues/call_list_params.rbi +23 -35
  154. data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
  155. data/rbi/telnyx/models/texml/accounts/queue_list_params.rbi +103 -0
  156. data/rbi/telnyx/models/texml/accounts/queue_list_response.rbi +269 -0
  157. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +0 -3
  158. data/rbi/telnyx/models/unwrap_webhook_event.rbi +0 -3
  159. data/rbi/telnyx/models.rbi +5 -6
  160. data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
  161. data/rbi/telnyx/resources/ai/assistants/versions.rbi +25 -19
  162. data/rbi/telnyx/resources/ai/assistants.rbi +30 -14
  163. data/rbi/telnyx/resources/ai/chat.rbi +1 -1
  164. data/rbi/telnyx/resources/ai/clusters.rbi +1 -1
  165. data/rbi/telnyx/resources/ai/embeddings.rbi +1 -1
  166. data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +1 -1
  167. data/rbi/telnyx/resources/call_control_applications.rbi +7 -1
  168. data/rbi/telnyx/resources/call_events.rbi +5 -1
  169. data/rbi/telnyx/resources/calls/actions.rbi +37 -2
  170. data/rbi/telnyx/resources/conferences.rbi +10 -2
  171. data/rbi/telnyx/resources/connections.rbi +5 -1
  172. data/rbi/telnyx/resources/credential_connections.rbi +2 -2
  173. data/rbi/telnyx/resources/faxes.rbi +4 -0
  174. data/rbi/telnyx/resources/fqdn_connections.rbi +2 -2
  175. data/rbi/telnyx/resources/ip_connections.rbi +2 -2
  176. data/rbi/telnyx/resources/messages.rbi +1 -1
  177. data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +8 -11
  178. data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +6 -6
  179. data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
  180. data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +10 -0
  181. data/rbi/telnyx/resources/operator_connect/actions.rbi +1 -1
  182. data/rbi/telnyx/resources/organizations/users/actions.rbi +32 -0
  183. data/rbi/telnyx/resources/organizations/users.rbi +88 -0
  184. data/rbi/telnyx/resources/organizations.rbi +15 -0
  185. data/rbi/telnyx/resources/phone_numbers/jobs.rbi +1 -1
  186. data/rbi/telnyx/resources/queues/calls.rbi +5 -1
  187. data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
  188. data/rbi/telnyx/resources/sim_cards.rbi +1 -1
  189. data/rbi/telnyx/resources/texml/accounts/calls/recordings.rbi +1 -1
  190. data/rbi/telnyx/resources/texml/accounts/queues.rbi +32 -0
  191. data/rbi/telnyx/resources/usage_reports.rbi +2 -2
  192. data/rbi/telnyx/resources/webhooks.rbi +0 -6
  193. data/sig/telnyx/client.rbs +2 -0
  194. data/sig/telnyx/models/ai/assistant.rbs +44 -1
  195. data/sig/telnyx/models/ai/assistant_create_params.rbs +10 -1
  196. data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
  197. data/sig/telnyx/models/ai/assistant_tool.rbs +367 -2
  198. data/sig/telnyx/models/ai/assistant_update_params.rbs +10 -1
  199. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +12 -3
  200. data/sig/telnyx/models/ai/audio_visualizer_config.rbs +48 -0
  201. data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
  202. data/sig/telnyx/models/ai/inference_embedding.rbs +12 -3
  203. data/sig/telnyx/models/ai/messaging_settings.rbs +7 -0
  204. data/sig/telnyx/models/ai/retrieval_tool.rbs +4 -4
  205. data/sig/telnyx/models/ai/telephony_settings.rbs +133 -4
  206. data/sig/telnyx/models/ai/transfer_tool.rbs +42 -4
  207. data/sig/telnyx/models/ai/webhook_tool.rbs +241 -4
  208. data/sig/telnyx/models/ai/widget_settings.rbs +127 -0
  209. data/sig/telnyx/models/call_control_application_list_params.rbs +17 -26
  210. data/sig/telnyx/models/call_event_list_params.rbs +18 -27
  211. data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +240 -0
  212. data/sig/telnyx/models/calls/action_add_ai_assistant_messages_response.rbs +20 -0
  213. data/sig/telnyx/models/calls/action_start_noise_suppression_params.rbs +2 -1
  214. data/sig/telnyx/models/conference_list_params.rbs +17 -26
  215. data/sig/telnyx/models/conference_list_participants_params.rbs +17 -26
  216. data/sig/telnyx/models/connection_list_active_calls_params.rbs +20 -27
  217. data/sig/telnyx/models/connection_noise_suppression_details.rbs +54 -0
  218. data/sig/telnyx/models/credential_connection.rbs +6 -57
  219. data/sig/telnyx/models/credential_connection_create_params.rbs +6 -57
  220. data/sig/telnyx/models/credential_connection_update_params.rbs +6 -57
  221. data/sig/telnyx/models/fax_create_params.rbs +7 -0
  222. data/sig/telnyx/models/fqdn_connection.rbs +6 -57
  223. data/sig/telnyx/models/fqdn_connection_create_params.rbs +6 -57
  224. data/sig/telnyx/models/fqdn_connection_update_params.rbs +6 -57
  225. data/sig/telnyx/models/ip_connection.rbs +6 -57
  226. data/sig/telnyx/models/ip_connection_create_params.rbs +6 -57
  227. data/sig/telnyx/models/ip_connection_update_params.rbs +6 -57
  228. data/sig/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbs +3 -13
  229. data/sig/telnyx/models/messaging_profile.rbs +7 -0
  230. data/sig/telnyx/models/messaging_profile_create_params.rbs +7 -0
  231. data/sig/telnyx/models/messaging_profile_update_params.rbs +7 -0
  232. data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -0
  233. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +5 -0
  234. data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +5 -0
  235. data/sig/telnyx/models/organizations/user_get_groups_report_params.rbs +43 -0
  236. data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +92 -0
  237. data/sig/telnyx/models/organizations/user_group_reference.rbs +17 -0
  238. data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
  239. data/sig/telnyx/models/organizations/user_list_response.rbs +87 -0
  240. data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
  241. data/sig/telnyx/models/organizations/user_retrieve_response.rbs +106 -0
  242. data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
  243. data/sig/telnyx/models/organizations/users/action_remove_response.rbs +110 -0
  244. data/sig/telnyx/models/queues/call_list_params.rbs +20 -27
  245. data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
  246. data/sig/telnyx/models/texml/accounts/queue_list_params.rbs +60 -0
  247. data/sig/telnyx/models/texml/accounts/queue_list_response.rbs +152 -0
  248. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +0 -3
  249. data/sig/telnyx/models/unwrap_webhook_event.rbs +0 -3
  250. data/sig/telnyx/models.rbs +4 -6
  251. data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
  252. data/sig/telnyx/resources/ai/assistants.rbs +3 -0
  253. data/sig/telnyx/resources/call_control_applications.rbs +3 -1
  254. data/sig/telnyx/resources/call_events.rbs +3 -1
  255. data/sig/telnyx/resources/calls/actions.rbs +8 -0
  256. data/sig/telnyx/resources/conferences.rbs +6 -2
  257. data/sig/telnyx/resources/connections.rbs +3 -1
  258. data/sig/telnyx/resources/credential_connections.rbs +2 -2
  259. data/sig/telnyx/resources/faxes.rbs +1 -0
  260. data/sig/telnyx/resources/fqdn_connections.rbs +2 -2
  261. data/sig/telnyx/resources/ip_connections.rbs +2 -2
  262. data/sig/telnyx/resources/messaging_10dlc/brand.rbs +1 -2
  263. data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
  264. data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -0
  265. data/sig/telnyx/resources/organizations/users/actions.rbs +16 -0
  266. data/sig/telnyx/resources/organizations/users.rbs +31 -0
  267. data/sig/telnyx/resources/organizations.rbs +9 -0
  268. data/sig/telnyx/resources/queues/calls.rbs +3 -1
  269. data/sig/telnyx/resources/texml/accounts/queues.rbs +10 -0
  270. data/sig/telnyx/resources/webhooks.rbs +0 -6
  271. metadata +59 -20
  272. data/lib/telnyx/models/ai/inference_embedding_bucket_ids.rb +0 -31
  273. data/lib/telnyx/models/ai/inference_embedding_transfer_tool_params.rb +0 -93
  274. data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +0 -265
  275. data/lib/telnyx/models/streaming_failed_webhook_event.rb +0 -15
  276. data/lib/telnyx/models/streaming_started_webhook_event.rb +0 -15
  277. data/lib/telnyx/models/streaming_stopped_webhook_event.rb +0 -15
  278. data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi +0 -54
  279. data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi +0 -185
  280. data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +0 -621
  281. data/rbi/telnyx/models/streaming_failed_webhook_event.rbi +0 -30
  282. data/rbi/telnyx/models/streaming_started_webhook_event.rbi +0 -30
  283. data/rbi/telnyx/models/streaming_stopped_webhook_event.rbi +0 -30
  284. data/sig/telnyx/models/ai/inference_embedding_bucket_ids.rbs +0 -26
  285. data/sig/telnyx/models/ai/inference_embedding_transfer_tool_params.rbs +0 -75
  286. data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +0 -242
  287. data/sig/telnyx/models/streaming_failed_webhook_event.rbs +0 -15
  288. data/sig/telnyx/models/streaming_started_webhook_event.rbs +0 -16
  289. data/sig/telnyx/models/streaming_stopped_webhook_event.rbs +0 -16
@@ -49,7 +49,10 @@ module Telnyx
49
49
 
50
50
  # Text that the assistant will use to start the conversation. This may be
51
51
  # templated with
52
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
52
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
53
+ # Use an empty string to have the assistant wait for the user to speak first. Use
54
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
55
+ # have the assistant generate the greeting based on the system instructions.
53
56
  sig { returns(T.nilable(String)) }
54
57
  attr_reader :greeting
55
58
 
@@ -74,7 +77,7 @@ module Telnyx
74
77
 
75
78
  # This is only needed when using third-party inference providers. The `identifier`
76
79
  # for an integration secret
77
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
80
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
78
81
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
79
82
  # work with this integration.
80
83
  sig { returns(T.nilable(String)) }
@@ -92,7 +95,7 @@ module Telnyx
92
95
  attr_writer :messaging_settings
93
96
 
94
97
  # ID of the model to use. You can use the
95
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
98
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
96
99
  # to see all of your available models,
97
100
  sig { returns(T.nilable(String)) }
98
101
  attr_reader :model
@@ -137,11 +140,11 @@ module Telnyx
137
140
  T.nilable(
138
141
  T::Array[
139
142
  T.any(
140
- Telnyx::AI::WebhookTool,
143
+ Telnyx::AI::AssistantTool::Webhook,
141
144
  Telnyx::AI::RetrievalTool,
142
145
  Telnyx::AI::AssistantTool::Handoff,
143
146
  Telnyx::AI::HangupTool,
144
- Telnyx::AI::TransferTool,
147
+ Telnyx::AI::AssistantTool::Transfer,
145
148
  Telnyx::AI::AssistantTool::Refer,
146
149
  Telnyx::AI::AssistantTool::SendDtmf,
147
150
  Telnyx::AI::AssistantTool::SendMessage
@@ -157,11 +160,11 @@ module Telnyx
157
160
  tools:
158
161
  T::Array[
159
162
  T.any(
160
- Telnyx::AI::WebhookTool::OrHash,
163
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
161
164
  Telnyx::AI::RetrievalTool::OrHash,
162
165
  Telnyx::AI::AssistantTool::Handoff::OrHash,
163
166
  Telnyx::AI::HangupTool::OrHash,
164
- Telnyx::AI::TransferTool::OrHash,
167
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
165
168
  Telnyx::AI::AssistantTool::Refer::OrHash,
166
169
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
167
170
  Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -185,6 +188,13 @@ module Telnyx
185
188
  sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
186
189
  attr_writer :voice_settings
187
190
 
191
+ # Configuration settings for the assistant's web widget.
192
+ sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
193
+ attr_reader :widget_settings
194
+
195
+ sig { params(widget_settings: Telnyx::AI::WidgetSettings::OrHash).void }
196
+ attr_writer :widget_settings
197
+
188
198
  sig do
189
199
  params(
190
200
  description: String,
@@ -204,11 +214,11 @@ module Telnyx
204
214
  tools:
205
215
  T::Array[
206
216
  T.any(
207
- Telnyx::AI::WebhookTool::OrHash,
217
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
208
218
  Telnyx::AI::RetrievalTool::OrHash,
209
219
  Telnyx::AI::AssistantTool::Handoff::OrHash,
210
220
  Telnyx::AI::HangupTool::OrHash,
211
- Telnyx::AI::TransferTool::OrHash,
221
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
212
222
  Telnyx::AI::AssistantTool::Refer::OrHash,
213
223
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
214
224
  Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -216,6 +226,7 @@ module Telnyx
216
226
  ],
217
227
  transcription: Telnyx::AI::TranscriptionSettings::OrHash,
218
228
  voice_settings: Telnyx::AI::VoiceSettings::OrHash,
229
+ widget_settings: Telnyx::AI::WidgetSettings::OrHash,
219
230
  request_options: Telnyx::RequestOptions::OrHash
220
231
  ).returns(T.attached_class)
221
232
  end
@@ -231,7 +242,10 @@ module Telnyx
231
242
  enabled_features: nil,
232
243
  # Text that the assistant will use to start the conversation. This may be
233
244
  # templated with
234
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
245
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
246
+ # Use an empty string to have the assistant wait for the user to speak first. Use
247
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
248
+ # have the assistant generate the greeting based on the system instructions.
235
249
  greeting: nil,
236
250
  insight_settings: nil,
237
251
  # System instructions for the assistant. These may be templated with
@@ -239,13 +253,13 @@ module Telnyx
239
253
  instructions: nil,
240
254
  # This is only needed when using third-party inference providers. The `identifier`
241
255
  # for an integration secret
242
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
256
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
243
257
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
244
258
  # work with this integration.
245
259
  llm_api_key_ref: nil,
246
260
  messaging_settings: nil,
247
261
  # ID of the model to use. You can use the
248
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
262
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
249
263
  # to see all of your available models,
250
264
  model: nil,
251
265
  name: nil,
@@ -259,6 +273,8 @@ module Telnyx
259
273
  tools: nil,
260
274
  transcription: nil,
261
275
  voice_settings: nil,
276
+ # Configuration settings for the assistant's web widget.
277
+ widget_settings: nil,
262
278
  request_options: {}
263
279
  )
264
280
  end
@@ -283,11 +299,11 @@ module Telnyx
283
299
  tools:
284
300
  T::Array[
285
301
  T.any(
286
- Telnyx::AI::WebhookTool,
302
+ Telnyx::AI::AssistantTool::Webhook,
287
303
  Telnyx::AI::RetrievalTool,
288
304
  Telnyx::AI::AssistantTool::Handoff,
289
305
  Telnyx::AI::HangupTool,
290
- Telnyx::AI::TransferTool,
306
+ Telnyx::AI::AssistantTool::Transfer,
291
307
  Telnyx::AI::AssistantTool::Refer,
292
308
  Telnyx::AI::AssistantTool::SendDtmf,
293
309
  Telnyx::AI::AssistantTool::SendMessage
@@ -295,6 +311,7 @@ module Telnyx
295
311
  ],
296
312
  transcription: Telnyx::AI::TranscriptionSettings,
297
313
  voice_settings: Telnyx::AI::VoiceSettings,
314
+ widget_settings: Telnyx::AI::WidgetSettings,
298
315
  request_options: Telnyx::RequestOptions
299
316
  }
300
317
  )
@@ -52,7 +52,10 @@ module Telnyx
52
52
 
53
53
  # Text that the assistant will use to start the conversation. This may be
54
54
  # templated with
55
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
55
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
56
+ # Use an empty string to have the assistant wait for the user to speak first. Use
57
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
58
+ # have the assistant generate the greeting based on the system instructions.
56
59
  sig { returns(T.nilable(String)) }
57
60
  attr_reader :greeting
58
61
 
@@ -77,7 +80,7 @@ module Telnyx
77
80
 
78
81
  # This is only needed when using third-party inference providers. The `identifier`
79
82
  # for an integration secret
80
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
83
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
81
84
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
82
85
  # work with this integration.
83
86
  sig { returns(T.nilable(String)) }
@@ -97,7 +100,7 @@ module Telnyx
97
100
  attr_writer :messaging_settings
98
101
 
99
102
  # ID of the model to use. You can use the
100
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
103
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
101
104
  # to see all of your available models,
102
105
  sig { returns(T.nilable(String)) }
103
106
  attr_reader :model
@@ -136,11 +139,11 @@ module Telnyx
136
139
  T.nilable(
137
140
  T::Array[
138
141
  T.any(
139
- Telnyx::AI::WebhookTool,
142
+ Telnyx::AI::AssistantTool::Webhook,
140
143
  Telnyx::AI::RetrievalTool,
141
144
  Telnyx::AI::AssistantTool::Handoff,
142
145
  Telnyx::AI::HangupTool,
143
- Telnyx::AI::TransferTool,
146
+ Telnyx::AI::AssistantTool::Transfer,
144
147
  Telnyx::AI::AssistantTool::Refer,
145
148
  Telnyx::AI::AssistantTool::SendDtmf,
146
149
  Telnyx::AI::AssistantTool::SendMessage
@@ -156,11 +159,11 @@ module Telnyx
156
159
  tools:
157
160
  T::Array[
158
161
  T.any(
159
- Telnyx::AI::WebhookTool::OrHash,
162
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
160
163
  Telnyx::AI::RetrievalTool::OrHash,
161
164
  Telnyx::AI::AssistantTool::Handoff::OrHash,
162
165
  Telnyx::AI::HangupTool::OrHash,
163
- Telnyx::AI::TransferTool::OrHash,
166
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
164
167
  Telnyx::AI::AssistantTool::Refer::OrHash,
165
168
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
166
169
  Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -186,6 +189,15 @@ module Telnyx
186
189
  sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
187
190
  attr_writer :voice_settings
188
191
 
192
+ # Configuration settings for the assistant's web widget.
193
+ sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
194
+ attr_reader :widget_settings
195
+
196
+ sig do
197
+ params(widget_settings: Telnyx::AI::WidgetSettings::OrHash).void
198
+ end
199
+ attr_writer :widget_settings
200
+
189
201
  sig do
190
202
  params(
191
203
  description: String,
@@ -204,18 +216,19 @@ module Telnyx
204
216
  tools:
205
217
  T::Array[
206
218
  T.any(
207
- Telnyx::AI::WebhookTool::OrHash,
219
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
208
220
  Telnyx::AI::RetrievalTool::OrHash,
209
221
  Telnyx::AI::AssistantTool::Handoff::OrHash,
210
222
  Telnyx::AI::HangupTool::OrHash,
211
- Telnyx::AI::TransferTool::OrHash,
223
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
212
224
  Telnyx::AI::AssistantTool::Refer::OrHash,
213
225
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
214
226
  Telnyx::AI::AssistantTool::SendMessage::OrHash
215
227
  )
216
228
  ],
217
229
  transcription: Telnyx::AI::TranscriptionSettings::OrHash,
218
- voice_settings: Telnyx::AI::VoiceSettings::OrHash
230
+ voice_settings: Telnyx::AI::VoiceSettings::OrHash,
231
+ widget_settings: Telnyx::AI::WidgetSettings::OrHash
219
232
  ).returns(T.attached_class)
220
233
  end
221
234
  def self.new(
@@ -230,7 +243,10 @@ module Telnyx
230
243
  enabled_features: nil,
231
244
  # Text that the assistant will use to start the conversation. This may be
232
245
  # templated with
233
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
246
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
247
+ # Use an empty string to have the assistant wait for the user to speak first. Use
248
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
249
+ # have the assistant generate the greeting based on the system instructions.
234
250
  greeting: nil,
235
251
  insight_settings: nil,
236
252
  # System instructions for the assistant. These may be templated with
@@ -238,13 +254,13 @@ module Telnyx
238
254
  instructions: nil,
239
255
  # This is only needed when using third-party inference providers. The `identifier`
240
256
  # for an integration secret
241
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
257
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
242
258
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
243
259
  # work with this integration.
244
260
  llm_api_key_ref: nil,
245
261
  messaging_settings: nil,
246
262
  # ID of the model to use. You can use the
247
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
263
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
248
264
  # to see all of your available models,
249
265
  model: nil,
250
266
  name: nil,
@@ -254,7 +270,9 @@ module Telnyx
254
270
  # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
255
271
  tools: nil,
256
272
  transcription: nil,
257
- voice_settings: nil
273
+ voice_settings: nil,
274
+ # Configuration settings for the assistant's web widget.
275
+ widget_settings: nil
258
276
  )
259
277
  end
260
278
 
@@ -278,18 +296,19 @@ module Telnyx
278
296
  tools:
279
297
  T::Array[
280
298
  T.any(
281
- Telnyx::AI::WebhookTool,
299
+ Telnyx::AI::AssistantTool::Webhook,
282
300
  Telnyx::AI::RetrievalTool,
283
301
  Telnyx::AI::AssistantTool::Handoff,
284
302
  Telnyx::AI::HangupTool,
285
- Telnyx::AI::TransferTool,
303
+ Telnyx::AI::AssistantTool::Transfer,
286
304
  Telnyx::AI::AssistantTool::Refer,
287
305
  Telnyx::AI::AssistantTool::SendDtmf,
288
306
  Telnyx::AI::AssistantTool::SendMessage
289
307
  )
290
308
  ],
291
309
  transcription: Telnyx::AI::TranscriptionSettings,
292
- voice_settings: Telnyx::AI::VoiceSettings
310
+ voice_settings: Telnyx::AI::VoiceSettings,
311
+ widget_settings: Telnyx::AI::WidgetSettings
293
312
  }
294
313
  )
295
314
  end
@@ -0,0 +1,107 @@
1
+ # typed: strong
2
+
3
+ module Telnyx
4
+ module Models
5
+ module AI
6
+ class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(Telnyx::AI::AudioVisualizerConfig, Telnyx::Internal::AnyHash)
10
+ end
11
+
12
+ # The color theme for the audio visualizer.
13
+ sig do
14
+ returns(T.nilable(Telnyx::AI::AudioVisualizerConfig::Color::OrSymbol))
15
+ end
16
+ attr_reader :color
17
+
18
+ sig do
19
+ params(color: Telnyx::AI::AudioVisualizerConfig::Color::OrSymbol).void
20
+ end
21
+ attr_writer :color
22
+
23
+ # The preset style for the audio visualizer.
24
+ sig { returns(T.nilable(String)) }
25
+ attr_reader :preset
26
+
27
+ sig { params(preset: String).void }
28
+ attr_writer :preset
29
+
30
+ sig do
31
+ params(
32
+ color: Telnyx::AI::AudioVisualizerConfig::Color::OrSymbol,
33
+ preset: String
34
+ ).returns(T.attached_class)
35
+ end
36
+ def self.new(
37
+ # The color theme for the audio visualizer.
38
+ color: nil,
39
+ # The preset style for the audio visualizer.
40
+ preset: nil
41
+ )
42
+ end
43
+
44
+ sig do
45
+ override.returns(
46
+ {
47
+ color: Telnyx::AI::AudioVisualizerConfig::Color::OrSymbol,
48
+ preset: String
49
+ }
50
+ )
51
+ end
52
+ def to_hash
53
+ end
54
+
55
+ # The color theme for the audio visualizer.
56
+ module Color
57
+ extend Telnyx::Internal::Type::Enum
58
+
59
+ TaggedSymbol =
60
+ T.type_alias do
61
+ T.all(Symbol, Telnyx::AI::AudioVisualizerConfig::Color)
62
+ end
63
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
64
+
65
+ VERDANT =
66
+ T.let(
67
+ :verdant,
68
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
69
+ )
70
+ TWILIGHT =
71
+ T.let(
72
+ :twilight,
73
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
74
+ )
75
+ BLOOM =
76
+ T.let(
77
+ :bloom,
78
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
79
+ )
80
+ MYSTIC =
81
+ T.let(
82
+ :mystic,
83
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
84
+ )
85
+ FLARE =
86
+ T.let(
87
+ :flare,
88
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
89
+ )
90
+ GLACIER =
91
+ T.let(
92
+ :glacier,
93
+ Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol
94
+ )
95
+
96
+ sig do
97
+ override.returns(
98
+ T::Array[Telnyx::AI::AudioVisualizerConfig::Color::TaggedSymbol]
99
+ )
100
+ end
101
+ def self.values
102
+ end
103
+ end
104
+ end
105
+ end
106
+ end
107
+ end
@@ -9,6 +9,9 @@ module Telnyx
9
9
  T.any(Telnyx::AI::BucketIDs, Telnyx::Internal::AnyHash)
10
10
  end
11
11
 
12
+ # List of
13
+ # [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
14
+ # to use for retrieval-augmented generation.
12
15
  sig { returns(T::Array[String]) }
13
16
  attr_accessor :bucket_ids
14
17
 
@@ -26,6 +29,9 @@ module Telnyx
26
29
  ).returns(T.attached_class)
27
30
  end
28
31
  def self.new(
32
+ # List of
33
+ # [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
34
+ # to use for retrieval-augmented generation.
29
35
  bucket_ids:,
30
36
  # The maximum number of results to retrieve as context for the language model.
31
37
  max_num_results: nil
@@ -183,7 +183,7 @@ module Telnyx
183
183
  # The `function` tool type follows the same schema as the
184
184
  # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
185
185
  # The `retrieval` tool type is unique to Telnyx. You may pass a list of
186
- # [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)
186
+ # [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
187
187
  # for retrieval-augmented generation.
188
188
  sig do
189
189
  returns(
@@ -330,7 +330,7 @@ module Telnyx
330
330
  # The `function` tool type follows the same schema as the
331
331
  # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
332
332
  # The `retrieval` tool type is unique to Telnyx. You may pass a list of
333
- # [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)
333
+ # [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
334
334
  # for retrieval-augmented generation.
335
335
  tools: nil,
336
336
  # This is used with `logprobs`. An integer between 0 and 20 specifying the number
@@ -827,14 +827,10 @@ module Telnyx
827
827
  )
828
828
  end
829
829
 
830
- sig { returns(Telnyx::AI::InferenceEmbeddingBucketIDs) }
830
+ sig { returns(Telnyx::AI::BucketIDs) }
831
831
  attr_reader :retrieval
832
832
 
833
- sig do
834
- params(
835
- retrieval: Telnyx::AI::InferenceEmbeddingBucketIDs::OrHash
836
- ).void
837
- end
833
+ sig { params(retrieval: Telnyx::AI::BucketIDs::OrHash).void }
838
834
  attr_writer :retrieval
839
835
 
840
836
  sig { returns(Symbol) }
@@ -842,7 +838,7 @@ module Telnyx
842
838
 
843
839
  sig do
844
840
  params(
845
- retrieval: Telnyx::AI::InferenceEmbeddingBucketIDs::OrHash,
841
+ retrieval: Telnyx::AI::BucketIDs::OrHash,
846
842
  type: Symbol
847
843
  ).returns(T.attached_class)
848
844
  end
@@ -851,10 +847,7 @@ module Telnyx
851
847
 
852
848
  sig do
853
849
  override.returns(
854
- {
855
- retrieval: Telnyx::AI::InferenceEmbeddingBucketIDs,
856
- type: Symbol
857
- }
850
+ { retrieval: Telnyx::AI::BucketIDs, type: Symbol }
858
851
  )
859
852
  end
860
853
  def to_hash
@@ -21,7 +21,7 @@ module Telnyx
21
21
  attr_accessor :instructions
22
22
 
23
23
  # ID of the model to use. You can use the
24
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
24
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
25
25
  # to see all of your available models,
26
26
  sig { returns(String) }
27
27
  attr_accessor :model
@@ -68,7 +68,10 @@ module Telnyx
68
68
 
69
69
  # Text that the assistant will use to start the conversation. This may be
70
70
  # templated with
71
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
71
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
72
+ # Use an empty string to have the assistant wait for the user to speak first. Use
73
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
74
+ # have the assistant generate the greeting based on the system instructions.
72
75
  sig { returns(T.nilable(String)) }
73
76
  attr_reader :greeting
74
77
 
@@ -91,7 +94,7 @@ module Telnyx
91
94
 
92
95
  # This is only needed when using third-party inference providers. The `identifier`
93
96
  # for an integration secret
94
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
97
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
95
98
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
96
99
  # work with this integration.
97
100
  sig { returns(T.nilable(String)) }
@@ -136,11 +139,11 @@ module Telnyx
136
139
  tools:
137
140
  T::Array[
138
141
  T.any(
139
- Telnyx::AI::WebhookTool::OrHash,
142
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
140
143
  Telnyx::AI::RetrievalTool::OrHash,
141
144
  Telnyx::AI::AssistantTool::Handoff::OrHash,
142
145
  Telnyx::AI::HangupTool::OrHash,
143
- Telnyx::AI::TransferTool::OrHash,
146
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
144
147
  Telnyx::AI::AssistantTool::Refer::OrHash,
145
148
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
146
149
  Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -164,6 +167,13 @@ module Telnyx
164
167
  sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
165
168
  attr_writer :voice_settings
166
169
 
170
+ # Configuration settings for the assistant's web widget.
171
+ sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
172
+ attr_reader :widget_settings
173
+
174
+ sig { params(widget_settings: Telnyx::AI::WidgetSettings::OrHash).void }
175
+ attr_writer :widget_settings
176
+
167
177
  sig do
168
178
  params(
169
179
  id: String,
@@ -185,18 +195,19 @@ module Telnyx
185
195
  tools:
186
196
  T::Array[
187
197
  T.any(
188
- Telnyx::AI::WebhookTool::OrHash,
198
+ Telnyx::AI::AssistantTool::Webhook::OrHash,
189
199
  Telnyx::AI::RetrievalTool::OrHash,
190
200
  Telnyx::AI::AssistantTool::Handoff::OrHash,
191
201
  Telnyx::AI::HangupTool::OrHash,
192
- Telnyx::AI::TransferTool::OrHash,
202
+ Telnyx::AI::AssistantTool::Transfer::OrHash,
193
203
  Telnyx::AI::AssistantTool::Refer::OrHash,
194
204
  Telnyx::AI::AssistantTool::SendDtmf::OrHash,
195
205
  Telnyx::AI::AssistantTool::SendMessage::OrHash
196
206
  )
197
207
  ],
198
208
  transcription: Telnyx::AI::TranscriptionSettings::OrHash,
199
- voice_settings: Telnyx::AI::VoiceSettings::OrHash
209
+ voice_settings: Telnyx::AI::VoiceSettings::OrHash,
210
+ widget_settings: Telnyx::AI::WidgetSettings::OrHash
200
211
  ).returns(T.attached_class)
201
212
  end
202
213
  def self.new(
@@ -206,7 +217,7 @@ module Telnyx
206
217
  # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
207
218
  instructions:,
208
219
  # ID of the model to use. You can use the
209
- # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
220
+ # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
210
221
  # to see all of your available models,
211
222
  model:,
212
223
  name:,
@@ -221,13 +232,16 @@ module Telnyx
221
232
  enabled_features: nil,
222
233
  # Text that the assistant will use to start the conversation. This may be
223
234
  # templated with
224
- # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
235
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
236
+ # Use an empty string to have the assistant wait for the user to speak first. Use
237
+ # the special value `<assistant-speaks-first-with-model-generated-message>` to
238
+ # have the assistant generate the greeting based on the system instructions.
225
239
  greeting: nil,
226
240
  import_metadata: nil,
227
241
  insight_settings: nil,
228
242
  # This is only needed when using third-party inference providers. The `identifier`
229
243
  # for an integration secret
230
- # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
244
+ # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
231
245
  # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
232
246
  # work with this integration.
233
247
  llm_api_key_ref: nil,
@@ -238,7 +252,9 @@ module Telnyx
238
252
  # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
239
253
  tools: nil,
240
254
  transcription: nil,
241
- voice_settings: nil
255
+ voice_settings: nil,
256
+ # Configuration settings for the assistant's web widget.
257
+ widget_settings: nil
242
258
  )
243
259
  end
244
260
 
@@ -264,7 +280,8 @@ module Telnyx
264
280
  telephony_settings: Telnyx::AI::TelephonySettings,
265
281
  tools: T::Array[Telnyx::AI::AssistantTool::Variants],
266
282
  transcription: Telnyx::AI::TranscriptionSettings,
267
- voice_settings: Telnyx::AI::VoiceSettings
283
+ voice_settings: Telnyx::AI::VoiceSettings,
284
+ widget_settings: Telnyx::AI::WidgetSettings
268
285
  }
269
286
  )
270
287
  end
@@ -9,6 +9,14 @@ module Telnyx
9
9
  T.any(Telnyx::AI::MessagingSettings, Telnyx::Internal::AnyHash)
10
10
  end
11
11
 
12
+ # If more than this many minutes have passed since the last message, the assistant
13
+ # will start a new conversation instead of continuing the existing one.
14
+ sig { returns(T.nilable(Integer)) }
15
+ attr_reader :conversation_inactivity_minutes
16
+
17
+ sig { params(conversation_inactivity_minutes: Integer).void }
18
+ attr_writer :conversation_inactivity_minutes
19
+
12
20
  # Default Messaging Profile used for messaging exchanges with your assistant. This
13
21
  # will be created automatically on assistant creation.
14
22
  sig { returns(T.nilable(String)) }
@@ -27,11 +35,15 @@ module Telnyx
27
35
 
28
36
  sig do
29
37
  params(
38
+ conversation_inactivity_minutes: Integer,
30
39
  default_messaging_profile_id: String,
31
40
  delivery_status_webhook_url: String
32
41
  ).returns(T.attached_class)
33
42
  end
34
43
  def self.new(
44
+ # If more than this many minutes have passed since the last message, the assistant
45
+ # will start a new conversation instead of continuing the existing one.
46
+ conversation_inactivity_minutes: nil,
35
47
  # Default Messaging Profile used for messaging exchanges with your assistant. This
36
48
  # will be created automatically on assistant creation.
37
49
  default_messaging_profile_id: nil,
@@ -44,6 +56,7 @@ module Telnyx
44
56
  sig do
45
57
  override.returns(
46
58
  {
59
+ conversation_inactivity_minutes: Integer,
47
60
  default_messaging_profile_id: String,
48
61
  delivery_status_webhook_url: String
49
62
  }