telnyx 5.161.0 → 5.163.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 (785) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/internal/cloudfs_cursor_pagination.rb +114 -0
  5. data/lib/telnyx/internal/email_bracket_cursor_pagination.rb +104 -0
  6. data/lib/telnyx/internal/email_cursor_pagination.rb +103 -0
  7. data/lib/telnyx/models/ai/assistant_clone_params.rb +7 -1
  8. data/lib/telnyx/models/ai/assistant_create_params.rb +8 -1
  9. data/lib/telnyx/models/ai/assistant_imports_params.rb +8 -1
  10. data/lib/telnyx/models/ai/assistant_send_sms_params.rb +7 -1
  11. data/lib/telnyx/models/ai/assistants/canary_deploy_create_params.rb +7 -1
  12. data/lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb +8 -1
  13. data/lib/telnyx/models/ai/assistants/test_create_params.rb +8 -1
  14. data/lib/telnyx/models/ai/assistants/tests/run_trigger_params.rb +8 -1
  15. data/lib/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rb +8 -1
  16. data/lib/telnyx/models/ai/collection_retrieve_documents_response.rb +83 -154
  17. data/lib/telnyx/models/ai/conversation_add_message_params.rb +8 -1
  18. data/lib/telnyx/models/ai/conversation_create_params.rb +8 -1
  19. data/lib/telnyx/models/ai/conversation_flow.rb +55 -0
  20. data/lib/telnyx/models/ai/conversation_flow_req.rb +6 -327
  21. data/lib/telnyx/models/ai/conversations/insight_create_params.rb +8 -1
  22. data/lib/telnyx/models/ai/conversations/insight_group_insight_groups_params.rb +7 -1
  23. data/lib/telnyx/models/ai/conversations/message_list_response.rb +43 -1
  24. data/lib/telnyx/models/ai/embedding_create_params.rb +8 -1
  25. data/lib/telnyx/models/ai/embedding_url_params.rb +8 -1
  26. data/lib/telnyx/models/ai/flow_edge.rb +5 -5
  27. data/lib/telnyx/models/ai/flow_node.rb +189 -0
  28. data/lib/telnyx/models/ai/flow_node_req.rb +184 -0
  29. data/lib/telnyx/models/ai/inference_embedding.rb +3 -384
  30. data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +84 -1
  31. data/lib/telnyx/models/ai/mcp_server_create_params.rb +7 -1
  32. data/lib/telnyx/models/ai/speak_node.rb +74 -0
  33. data/lib/telnyx/models/ai/speak_node_req.rb +79 -0
  34. data/lib/telnyx/models/ai/tool_create_params.rb +8 -1
  35. data/lib/telnyx/models/ai/tool_node.rb +84 -0
  36. data/lib/telnyx/models/ai/tool_node_req.rb +79 -0
  37. data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +112 -177
  38. data/lib/telnyx/models/ai_summarize_params.rb +8 -1
  39. data/lib/telnyx/models/call_answered.rb +3 -35
  40. data/lib/telnyx/models/call_dial_params.rb +27 -1
  41. data/lib/telnyx/models/call_hangup.rb +3 -35
  42. data/lib/telnyx/models/call_initiated.rb +3 -35
  43. data/lib/telnyx/models/call_payment_completed_webhook_event.rb +5 -2
  44. data/lib/telnyx/models/call_payment_progress_webhook_event.rb +4 -0
  45. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +3 -5
  46. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +3 -8
  47. data/lib/telnyx/models/calls/action_pay_params.rb +44 -15
  48. data/lib/telnyx/models/calls/action_speak_params.rb +3 -8
  49. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +4 -6
  50. data/lib/telnyx/models/calls/action_transfer_params.rb +27 -1
  51. data/lib/telnyx/models/calls/pay_prompt_value.rb +19 -22
  52. data/lib/telnyx/models/calls/transcription_engine_humain_config.rb +80 -0
  53. data/lib/telnyx/models/calls/transcription_engine_reson8_config.rb +87 -0
  54. data/lib/telnyx/models/calls/transcription_start_request.rb +5 -162
  55. data/lib/telnyx/models/conferences/action_speak_params.rb +3 -8
  56. data/lib/telnyx/models/conversation_relay_embedded_config.rb +3 -5
  57. data/lib/telnyx/models/conversation_relay_language.rb +3 -5
  58. data/lib/telnyx/models/custom_storage_configuration.rb +4 -63
  59. data/lib/telnyx/models/dir/email_verification_status.rb +87 -0
  60. data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +3 -84
  61. data/lib/telnyx/models/doc_service_document.rb +6 -9
  62. data/lib/telnyx/models/document_link_list_response.rb +1 -9
  63. data/lib/telnyx/models/email_block_retrieve_events_response.rb +69 -86
  64. data/lib/telnyx/models/email_blocks/email_block_import.rb +171 -0
  65. data/lib/telnyx/models/email_blocks/email_block_import_response.rb +4 -167
  66. data/lib/telnyx/models/email_blocks/import_create_params.rb +1 -1
  67. data/lib/telnyx/models/email_blocks/import_retrieve_params.rb +1 -1
  68. data/lib/telnyx/models/email_domain_list_params.rb +12 -4
  69. data/lib/telnyx/models/email_event_list_response.rb +73 -115
  70. data/lib/telnyx/models/email_inbox.rb +1 -0
  71. data/lib/telnyx/models/email_inboxes/email_draft.rb +8 -6
  72. data/lib/telnyx/models/email_inboxes/email_draft_request.rb +7 -6
  73. data/lib/telnyx/models/email_inboxes/email_message_response.rb +3 -39
  74. data/lib/telnyx/models/email_inboxes/filter_add_response.rb +3 -36
  75. data/lib/telnyx/models/email_inboxes/filter_delete_all_response.rb +3 -37
  76. data/lib/telnyx/models/email_inboxes/filter_list_response.rb +3 -36
  77. data/lib/telnyx/models/email_inboxes/filter_replace_response.rb +3 -36
  78. data/lib/telnyx/models/email_inboxes/inbound_thread.rb +1 -0
  79. data/lib/telnyx/models/email_inboxes/inbound_thread_list_response.rb +0 -1
  80. data/lib/telnyx/models/email_inboxes/inbox_filters.rb +39 -0
  81. data/lib/telnyx/models/email_inboxes/message_update_params.rb +11 -22
  82. data/lib/telnyx/models/email_inboxes/messages/action_forward_params.rb +9 -9
  83. data/lib/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rb +3 -3
  84. data/lib/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rb +3 -3
  85. data/lib/telnyx/models/email_message_batch_params.rb +1 -1
  86. data/lib/telnyx/models/email_message_create_params.rb +1 -1
  87. data/lib/telnyx/models/email_messages/email_recipient.rb +1 -0
  88. data/lib/telnyx/models/email_template.rb +1 -0
  89. data/lib/telnyx/models/email_unsubscribe_group_delete_params.rb +12 -15
  90. data/lib/telnyx/models/email_validation_checks.rb +51 -0
  91. data/lib/telnyx/models/email_validation_create_response.rb +3 -50
  92. data/lib/telnyx/models/email_validations/batch_retrieve_response.rb +3 -50
  93. data/lib/telnyx/models/enterprise_create_params.rb +3 -3
  94. data/lib/telnyx/models/enterprise_public.rb +3 -3
  95. data/lib/telnyx/models/enterprise_update_params.rb +3 -3
  96. data/lib/telnyx/models/enterprises/reputation/remediation_per_number_results.rb +47 -0
  97. data/lib/telnyx/models/enterprises/reputation/remediation_request.rb +116 -0
  98. data/lib/telnyx/models/enterprises/reputation/remediation_request_wrapped.rb +3 -152
  99. data/lib/telnyx/models/inbound_message.rb +1 -31
  100. data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -594
  101. data/lib/telnyx/models/inbound_sip_header.rb +37 -0
  102. data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb +4 -4
  103. data/lib/telnyx/models/message_event.rb +1 -0
  104. data/lib/telnyx/models/message_retrieve_response.rb +4 -594
  105. data/lib/telnyx/models/messaging_10dlc_get_enum_response.rb +3 -2
  106. data/lib/telnyx/models/messaging_error_0b38e7044b.rb +3 -3
  107. data/lib/telnyx/models/messaging_inbound_message_payload.rb +589 -0
  108. data/lib/telnyx/models/numbers_sub_number_order.rb +301 -0
  109. data/lib/telnyx/models/{transcribe_client_event.rb → oauth_retrieve_authorize_response.rb} +1 -1
  110. data/lib/telnyx/models/pricing/product_retrieve_params.rb +6 -1
  111. data/lib/telnyx/models/pricing/product_retrieve_response.rb +163 -180
  112. data/lib/telnyx/models/rcs/agent_configuration.rb +9 -9
  113. data/lib/telnyx/models/rcs/agent_launch_params.rb +1 -25
  114. data/lib/telnyx/models/rcs/brand_address.rb +53 -0
  115. data/lib/telnyx/models/rcs/brand_create_params.rb +4 -65
  116. data/lib/telnyx/models/rcs/brand_identifier.rb +20 -0
  117. data/lib/telnyx/models/rcs/brand_response.rb +4 -62
  118. data/lib/telnyx/models/rcs/brand_update_params.rb +4 -65
  119. data/lib/telnyx/models/s3_generic_configuration_data.rb +75 -0
  120. data/lib/telnyx/models/storage/bucket_create_presigned_url_params.rb +16 -9
  121. data/lib/telnyx/models/storage/cloudf_list_response.rb +70 -144
  122. data/lib/telnyx/models/storage/cloudfs_filesystem.rb +111 -0
  123. data/lib/telnyx/models/storage/cloudfs_filesystem_detail.rb +109 -0
  124. data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb +3 -107
  125. data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb +3 -109
  126. data/lib/telnyx/models/storage/sqldbs/action_query_params.rb +1 -3
  127. data/lib/telnyx/models/sub_number_order_cancel_response.rb +3 -3
  128. data/lib/telnyx/models/sub_number_order_list_params.rb +15 -3
  129. data/lib/telnyx/models/sub_number_order_list_response.rb +3 -3
  130. data/lib/telnyx/models/sub_number_order_retrieve_response.rb +3 -3
  131. data/lib/telnyx/models/sub_number_order_update_response.rb +3 -3
  132. data/lib/telnyx/models/suppressed_recipient.rb +40 -0
  133. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +96 -3
  134. data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +30 -1
  135. data/lib/telnyx/models/texml_initiate_ai_call_params.rb +28 -1
  136. data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +10 -58
  137. data/lib/telnyx/models/text_to_speech_list_voices_params.rb +0 -1
  138. data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +13 -16
  139. data/lib/telnyx/models/voice_sdk_call_report.rb +7 -6
  140. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rb +3 -55
  141. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rb +3 -56
  142. data/lib/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rb +60 -0
  143. data/lib/telnyx/models/wireguard_interface_create_params.rb +4 -28
  144. data/lib/telnyx/models.rb +12 -8
  145. data/lib/telnyx/resources/addresses.rb +6 -3
  146. data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +11 -4
  147. data/lib/telnyx/resources/ai/assistants/scheduled_events.rb +19 -14
  148. data/lib/telnyx/resources/ai/assistants/tags.rb +2 -1
  149. data/lib/telnyx/resources/ai/assistants/tests/runs.rb +8 -4
  150. data/lib/telnyx/resources/ai/assistants/tests/test_suites/runs.rb +8 -4
  151. data/lib/telnyx/resources/ai/assistants/tests.rb +14 -10
  152. data/lib/telnyx/resources/ai/assistants/tools.rb +5 -2
  153. data/lib/telnyx/resources/ai/assistants.rb +72 -47
  154. data/lib/telnyx/resources/ai/collections/sources.rb +3 -1
  155. data/lib/telnyx/resources/ai/collections.rb +2 -1
  156. data/lib/telnyx/resources/ai/conversations/insight_groups/insights.rb +3 -2
  157. data/lib/telnyx/resources/ai/conversations/insight_groups.rb +25 -10
  158. data/lib/telnyx/resources/ai/conversations/insights.rb +21 -11
  159. data/lib/telnyx/resources/ai/conversations.rb +28 -16
  160. data/lib/telnyx/resources/ai/embeddings/buckets.rb +2 -1
  161. data/lib/telnyx/resources/ai/embeddings.rb +25 -11
  162. data/lib/telnyx/resources/ai/fine_tuning/jobs.rb +5 -3
  163. data/lib/telnyx/resources/ai/integrations/connections.rb +3 -2
  164. data/lib/telnyx/resources/ai/integrations.rb +4 -2
  165. data/lib/telnyx/resources/ai/mcp_servers.rb +25 -11
  166. data/lib/telnyx/resources/ai/missions/knowledge_bases.rb +7 -4
  167. data/lib/telnyx/resources/ai/missions/mcp_servers.rb +9 -5
  168. data/lib/telnyx/resources/ai/missions/runs/events.rb +7 -3
  169. data/lib/telnyx/resources/ai/missions/runs/plan.rb +10 -4
  170. data/lib/telnyx/resources/ai/missions/runs/telnyx_agents.rb +4 -2
  171. data/lib/telnyx/resources/ai/missions/runs.rb +18 -8
  172. data/lib/telnyx/resources/ai/missions/tools.rb +8 -5
  173. data/lib/telnyx/resources/ai/missions.rb +14 -6
  174. data/lib/telnyx/resources/ai/tools.rb +21 -14
  175. data/lib/telnyx/resources/ai.rb +14 -6
  176. data/lib/telnyx/resources/authentication_providers.rb +2 -1
  177. data/lib/telnyx/resources/bundle_pricing/billing_bundles.rb +4 -2
  178. data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +5 -3
  179. data/lib/telnyx/resources/call_control_applications.rb +4 -2
  180. data/lib/telnyx/resources/calls/actions.rb +19 -11
  181. data/lib/telnyx/resources/conferences/actions.rb +5 -3
  182. data/lib/telnyx/resources/conferences.rb +3 -2
  183. data/lib/telnyx/resources/country_coverage.rb +4 -2
  184. data/lib/telnyx/resources/credential_connections.rb +2 -1
  185. data/lib/telnyx/resources/custom_storage_credentials.rb +2 -2
  186. data/lib/telnyx/resources/customer_service_records.rb +4 -2
  187. data/lib/telnyx/resources/dialogflow_connections.rb +3 -2
  188. data/lib/telnyx/resources/documents.rb +4 -3
  189. data/lib/telnyx/resources/dynamic_emergency_addresses.rb +2 -1
  190. data/lib/telnyx/resources/dynamic_emergency_endpoints.rb +2 -1
  191. data/lib/telnyx/resources/email_blocks/{import.rb → imports.rb} +1 -1
  192. data/lib/telnyx/resources/email_blocks.rb +5 -4
  193. data/lib/telnyx/resources/email_domains.rb +7 -4
  194. data/lib/telnyx/resources/email_events.rb +2 -1
  195. data/lib/telnyx/resources/email_inboxes/drafts.rb +9 -8
  196. data/lib/telnyx/resources/email_inboxes/messages/actions.rb +3 -3
  197. data/lib/telnyx/resources/email_inboxes/messages.rb +6 -8
  198. data/lib/telnyx/resources/email_inboxes/threads.rb +3 -2
  199. data/lib/telnyx/resources/email_inboxes.rb +3 -2
  200. data/lib/telnyx/resources/email_messages/recipients.rb +3 -2
  201. data/lib/telnyx/resources/email_messages.rb +6 -4
  202. data/lib/telnyx/resources/email_templates.rb +5 -3
  203. data/lib/telnyx/resources/email_threads.rb +3 -2
  204. data/lib/telnyx/resources/email_unsubscribe_groups.rb +1 -1
  205. data/lib/telnyx/resources/enterprises.rb +2 -2
  206. data/lib/telnyx/resources/faxes.rb +1 -1
  207. data/lib/telnyx/resources/fqdn_connections.rb +3 -2
  208. data/lib/telnyx/resources/fqdns.rb +3 -3
  209. data/lib/telnyx/resources/global_ip_allowed_ports.rb +2 -1
  210. data/lib/telnyx/resources/global_ip_assignments.rb +11 -5
  211. data/lib/telnyx/resources/global_ip_health_check_types.rb +2 -1
  212. data/lib/telnyx/resources/global_ip_health_checks.rb +9 -4
  213. data/lib/telnyx/resources/global_ip_protocols.rb +2 -1
  214. data/lib/telnyx/resources/global_ips.rb +8 -4
  215. data/lib/telnyx/resources/invoices.rb +1 -1
  216. data/lib/telnyx/resources/ip_connections.rb +5 -3
  217. data/lib/telnyx/resources/ips.rb +4 -3
  218. data/lib/telnyx/resources/legacy/reporting/usage_reports/messaging.rb +2 -1
  219. data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb +2 -1
  220. data/lib/telnyx/resources/legacy/reporting/usage_reports/voice.rb +2 -1
  221. data/lib/telnyx/resources/managed_accounts.rb +2 -1
  222. data/lib/telnyx/resources/media.rb +5 -4
  223. data/lib/telnyx/resources/messaging_10dlc/brand.rb +2 -1
  224. data/lib/telnyx/resources/messaging_10dlc.rb +1 -1
  225. data/lib/telnyx/resources/messaging_optouts.rb +2 -1
  226. data/lib/telnyx/resources/messaging_profiles.rb +1 -1
  227. data/lib/telnyx/resources/mobile_push_credentials.rb +4 -2
  228. data/lib/telnyx/resources/mobile_voice_connections.rb +2 -1
  229. data/lib/telnyx/resources/networks/default_gateway.rb +4 -3
  230. data/lib/telnyx/resources/networks.rb +9 -6
  231. data/lib/telnyx/resources/notification_channels.rb +8 -5
  232. data/lib/telnyx/resources/notification_profiles.rb +5 -4
  233. data/lib/telnyx/resources/notification_settings.rb +7 -4
  234. data/lib/telnyx/resources/number_block_orders.rb +2 -1
  235. data/lib/telnyx/resources/number_orders.rb +8 -4
  236. data/lib/telnyx/resources/number_reservations.rb +2 -1
  237. data/lib/telnyx/resources/oauth.rb +5 -3
  238. data/lib/telnyx/resources/oauth_clients.rb +6 -4
  239. data/lib/telnyx/resources/oauth_grants.rb +3 -2
  240. data/lib/telnyx/resources/organizations/users/actions.rb +2 -1
  241. data/lib/telnyx/resources/organizations/users.rb +2 -1
  242. data/lib/telnyx/resources/outbound_voice_profiles.rb +2 -1
  243. data/lib/telnyx/resources/porting/events.rb +6 -3
  244. data/lib/telnyx/resources/porting/loa_configurations.rb +13 -6
  245. data/lib/telnyx/resources/porting/reports.rb +2 -1
  246. data/lib/telnyx/resources/porting.rb +2 -1
  247. data/lib/telnyx/resources/porting_orders/actions.rb +3 -2
  248. data/lib/telnyx/resources/porting_orders/activation_jobs.rb +2 -1
  249. data/lib/telnyx/resources/porting_orders/phone_number_blocks.rb +3 -2
  250. data/lib/telnyx/resources/porting_orders/phone_number_extensions.rb +3 -2
  251. data/lib/telnyx/resources/porting_orders.rb +7 -3
  252. data/lib/telnyx/resources/portouts/comments.rb +2 -1
  253. data/lib/telnyx/resources/portouts/events.rb +5 -3
  254. data/lib/telnyx/resources/portouts/reports.rb +2 -1
  255. data/lib/telnyx/resources/portouts.rb +2 -1
  256. data/lib/telnyx/resources/pricing/products.rb +6 -2
  257. data/lib/telnyx/resources/private_wireless_gateways.rb +1 -1
  258. data/lib/telnyx/resources/public_internet_gateways.rb +8 -4
  259. data/lib/telnyx/resources/queues.rb +5 -3
  260. data/lib/telnyx/resources/rcs/brands.rb +2 -2
  261. data/lib/telnyx/resources/recordings.rb +4 -2
  262. data/lib/telnyx/resources/reports/mdr_usage_reports.rb +1 -1
  263. data/lib/telnyx/resources/reports.rb +4 -2
  264. data/lib/telnyx/resources/requirement_types.rb +2 -1
  265. data/lib/telnyx/resources/requirements.rb +3 -1
  266. data/lib/telnyx/resources/room_recordings.rb +2 -1
  267. data/lib/telnyx/resources/rooms.rb +4 -2
  268. data/lib/telnyx/resources/sim_card_groups.rb +4 -3
  269. data/lib/telnyx/resources/sim_card_order_preview.rb +2 -1
  270. data/lib/telnyx/resources/sim_card_orders.rb +3 -2
  271. data/lib/telnyx/resources/sim_cards.rb +1 -1
  272. data/lib/telnyx/resources/siprec_connectors.rb +1 -1
  273. data/lib/telnyx/resources/speech_to_text.rb +1 -8
  274. data/lib/telnyx/resources/storage/buckets.rb +3 -3
  275. data/lib/telnyx/resources/storage/cloudfs.rb +2 -1
  276. data/lib/telnyx/resources/storage/migrations/actions.rb +2 -1
  277. data/lib/telnyx/resources/sub_number_orders.rb +3 -2
  278. data/lib/telnyx/resources/telephony_credentials.rb +7 -4
  279. data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +12 -6
  280. data/lib/telnyx/resources/texml/accounts/conferences.rb +6 -4
  281. data/lib/telnyx/resources/texml/accounts/queues.rb +7 -5
  282. data/lib/telnyx/resources/texml.rb +3 -1
  283. data/lib/telnyx/resources/texml_applications.rb +3 -2
  284. data/lib/telnyx/resources/text_to_speech.rb +10 -12
  285. data/lib/telnyx/resources/traffic_policy_profiles.rb +2 -2
  286. data/lib/telnyx/resources/uac_connections.rb +1 -1
  287. data/lib/telnyx/resources/user_addresses.rb +4 -2
  288. data/lib/telnyx/resources/user_tags.rb +2 -1
  289. data/lib/telnyx/resources/verify_profiles.rb +2 -1
  290. data/lib/telnyx/resources/virtual_cross_connects.rb +4 -3
  291. data/lib/telnyx/resources/wireguard_interfaces.rb +4 -3
  292. data/lib/telnyx/resources/wireguard_peers.rb +4 -4
  293. data/lib/telnyx/resources/wireless/detail_records_reports.rb +3 -2
  294. data/lib/telnyx/resources/wireless_blocklists.rb +3 -2
  295. data/lib/telnyx/version.rb +1 -1
  296. data/lib/telnyx.rb +31 -17
  297. data/rbi/telnyx/internal/cloudfs_cursor_pagination.rbi +59 -0
  298. data/rbi/telnyx/internal/email_bracket_cursor_pagination.rbi +40 -0
  299. data/rbi/telnyx/internal/email_cursor_pagination.rbi +40 -0
  300. data/rbi/telnyx/models/ai/assistant_clone_params.rbi +13 -2
  301. data/rbi/telnyx/models/ai/assistant_create_params.rbi +9 -0
  302. data/rbi/telnyx/models/ai/assistant_imports_params.rbi +9 -0
  303. data/rbi/telnyx/models/ai/assistant_send_sms_params.rbi +9 -0
  304. data/rbi/telnyx/models/ai/assistants/canary_deploy_create_params.rbi +13 -2
  305. data/rbi/telnyx/models/ai/assistants/scheduled_event_create_params.rbi +9 -0
  306. data/rbi/telnyx/models/ai/assistants/test_create_params.rbi +9 -0
  307. data/rbi/telnyx/models/ai/assistants/tests/run_trigger_params.rbi +9 -0
  308. data/rbi/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rbi +9 -0
  309. data/rbi/telnyx/models/ai/collection_retrieve_documents_response.rbi +96 -271
  310. data/rbi/telnyx/models/ai/conversation_add_message_params.rbi +9 -0
  311. data/rbi/telnyx/models/ai/conversation_create_params.rbi +9 -0
  312. data/rbi/telnyx/models/ai/conversation_flow.rbi +88 -0
  313. data/rbi/telnyx/models/ai/conversation_flow_req.rbi +12 -648
  314. data/rbi/telnyx/models/ai/conversations/insight_create_params.rbi +9 -0
  315. data/rbi/telnyx/models/ai/conversations/insight_group_insight_groups_params.rbi +9 -0
  316. data/rbi/telnyx/models/ai/conversations/message_list_response.rbi +85 -0
  317. data/rbi/telnyx/models/ai/embedding_create_params.rbi +9 -0
  318. data/rbi/telnyx/models/ai/embedding_url_params.rbi +9 -0
  319. data/rbi/telnyx/models/ai/flow_edge.rbi +6 -6
  320. data/rbi/telnyx/models/ai/flow_node.rbi +348 -0
  321. data/rbi/telnyx/models/ai/flow_node_req.rbi +301 -0
  322. data/rbi/telnyx/models/ai/inference_embedding.rbi +4 -843
  323. data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +173 -0
  324. data/rbi/telnyx/models/ai/mcp_server_create_params.rbi +9 -0
  325. data/rbi/telnyx/models/ai/speak_node.rbi +114 -0
  326. data/rbi/telnyx/models/ai/speak_node_req.rbi +119 -0
  327. data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
  328. data/rbi/telnyx/models/ai/tool_node.rbi +167 -0
  329. data/rbi/telnyx/models/ai/tool_node_req.rbi +119 -0
  330. data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +121 -250
  331. data/rbi/telnyx/models/ai_summarize_params.rbi +9 -0
  332. data/rbi/telnyx/models/call_answered.rbi +4 -90
  333. data/rbi/telnyx/models/call_dial_params.rbi +65 -0
  334. data/rbi/telnyx/models/call_hangup.rbi +4 -88
  335. data/rbi/telnyx/models/call_initiated.rbi +4 -92
  336. data/rbi/telnyx/models/call_payment_completed_webhook_event.rbi +16 -1
  337. data/rbi/telnyx/models/call_payment_progress_webhook_event.rbi +20 -0
  338. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +0 -5
  339. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +0 -11
  340. data/rbi/telnyx/models/calls/action_pay_params.rbi +100 -2
  341. data/rbi/telnyx/models/calls/action_speak_params.rbi +0 -11
  342. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +0 -5
  343. data/rbi/telnyx/models/calls/action_transfer_params.rbi +65 -0
  344. data/rbi/telnyx/models/calls/pay_prompt_value.rbi +57 -40
  345. data/rbi/telnyx/models/calls/transcription_engine_humain_config.rbi +214 -0
  346. data/rbi/telnyx/models/calls/transcription_engine_reson8_config.rbi +249 -0
  347. data/rbi/telnyx/models/calls/transcription_start_request.rbi +10 -459
  348. data/rbi/telnyx/models/conferences/action_speak_params.rbi +0 -11
  349. data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +0 -5
  350. data/rbi/telnyx/models/conversation_relay_language.rbi +0 -5
  351. data/rbi/telnyx/models/custom_storage_configuration.rbi +2 -85
  352. data/rbi/telnyx/models/dir/email_verification_status.rbi +155 -0
  353. data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +6 -171
  354. data/rbi/telnyx/models/doc_service_document.rbi +0 -11
  355. data/rbi/telnyx/models/document_link_list_response.rbi +3 -14
  356. data/rbi/telnyx/models/email_block_retrieve_events_response.rbi +118 -165
  357. data/rbi/telnyx/models/email_blocks/email_block_import.rbi +307 -0
  358. data/rbi/telnyx/models/email_blocks/email_block_import_response.rbi +6 -324
  359. data/rbi/telnyx/models/email_domain_list_params.rbi +10 -0
  360. data/rbi/telnyx/models/email_event_list_response.rbi +96 -197
  361. data/rbi/telnyx/models/email_inboxes/email_draft.rbi +8 -8
  362. data/rbi/telnyx/models/email_inboxes/email_draft_request.rbi +8 -8
  363. data/rbi/telnyx/models/email_inboxes/email_message_response.rbi +4 -78
  364. data/rbi/telnyx/models/email_inboxes/filter_add_response.rbi +6 -90
  365. data/rbi/telnyx/models/email_inboxes/filter_delete_all_response.rbi +6 -96
  366. data/rbi/telnyx/models/email_inboxes/filter_list_response.rbi +6 -90
  367. data/rbi/telnyx/models/email_inboxes/filter_replace_response.rbi +6 -94
  368. data/rbi/telnyx/models/email_inboxes/inbox_filters.rbi +75 -0
  369. data/rbi/telnyx/models/email_inboxes/message_update_params.rbi +41 -46
  370. data/rbi/telnyx/models/email_inboxes/messages/action_forward_params.rbi +25 -25
  371. data/rbi/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbi +3 -3
  372. data/rbi/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbi +3 -3
  373. data/rbi/telnyx/models/email_unsubscribe_group_delete_params.rbi +39 -22
  374. data/rbi/telnyx/models/email_validation_checks.rbi +96 -0
  375. data/rbi/telnyx/models/email_validation_create_response.rbi +4 -118
  376. data/rbi/telnyx/models/email_validations/batch_retrieve_response.rbi +4 -124
  377. data/rbi/telnyx/models/enterprise_create_params.rbi +4 -4
  378. data/rbi/telnyx/models/enterprise_public.rbi +4 -4
  379. data/rbi/telnyx/models/enterprise_update_params.rbi +4 -4
  380. data/rbi/telnyx/models/enterprises/reputation/remediation_per_number_results.rbi +84 -0
  381. data/rbi/telnyx/models/enterprises/reputation/remediation_request.rbi +159 -0
  382. data/rbi/telnyx/models/enterprises/reputation/remediation_request_wrapped.rbi +4 -237
  383. data/rbi/telnyx/models/inbound_message.rbi +3 -69
  384. data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -1433
  385. data/rbi/telnyx/models/inbound_sip_header.rbi +64 -0
  386. data/rbi/telnyx/models/meeting_sessions/action_accepted_response.rbi +1 -1
  387. data/rbi/telnyx/models/message_retrieve_response.rbi +3 -1437
  388. data/rbi/telnyx/models/messaging_10dlc_get_enum_response.rbi +4 -2
  389. data/rbi/telnyx/models/messaging_error_0b38e7044b.rbi +4 -4
  390. data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +1333 -0
  391. data/rbi/telnyx/models/numbers_sub_number_order.rbi +625 -0
  392. data/rbi/telnyx/models/oauth_retrieve_authorize_response.rbi +7 -0
  393. data/rbi/telnyx/models/pricing/product_retrieve_params.rbi +4 -0
  394. data/rbi/telnyx/models/pricing/product_retrieve_response.rbi +180 -232
  395. data/rbi/telnyx/models/rcs/agent_configuration.rbi +18 -18
  396. data/rbi/telnyx/models/rcs/agent_launch_params.rbi +3 -43
  397. data/rbi/telnyx/models/rcs/brand_address.rbi +69 -0
  398. data/rbi/telnyx/models/rcs/brand_create_params.rbi +6 -133
  399. data/rbi/telnyx/models/rcs/brand_identifier.rbi +25 -0
  400. data/rbi/telnyx/models/rcs/brand_response.rbi +5 -98
  401. data/rbi/telnyx/models/rcs/brand_update_params.rbi +7 -137
  402. data/rbi/telnyx/models/s3_generic_configuration_data.rbi +110 -0
  403. data/rbi/telnyx/models/storage/bucket_create_presigned_url_params.rbi +43 -14
  404. data/rbi/telnyx/models/storage/cloudf_list_response.rbi +89 -270
  405. data/rbi/telnyx/models/storage/cloudfs_filesystem.rbi +176 -0
  406. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail.rbi +174 -0
  407. data/rbi/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbi +4 -186
  408. data/rbi/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbi +6 -192
  409. data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi +1 -2
  410. data/rbi/telnyx/models/sub_number_order.rbi +4 -6
  411. data/rbi/telnyx/models/sub_number_order_cancel_response.rbi +6 -4
  412. data/rbi/telnyx/models/sub_number_order_list_params.rbi +16 -3
  413. data/rbi/telnyx/models/sub_number_order_list_response.rbi +4 -4
  414. data/rbi/telnyx/models/sub_number_order_retrieve_response.rbi +6 -4
  415. data/rbi/telnyx/models/sub_number_order_update_response.rbi +6 -4
  416. data/rbi/telnyx/models/suppressed_recipient.rbi +61 -0
  417. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +204 -0
  418. data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +68 -0
  419. data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +68 -0
  420. data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +13 -110
  421. data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +0 -5
  422. data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +20 -28
  423. data/rbi/telnyx/models/voice_sdk_call_report.rbi +5 -5
  424. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbi +4 -128
  425. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbi +4 -128
  426. data/rbi/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rbi +133 -0
  427. data/rbi/telnyx/models/wireguard_interface_create_params.rbi +6 -59
  428. data/rbi/telnyx/models.rbi +13 -8
  429. data/rbi/telnyx/resources/addresses.rbi +6 -3
  430. data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +12 -1
  431. data/rbi/telnyx/resources/ai/assistants/scheduled_events.rbi +31 -15
  432. data/rbi/telnyx/resources/ai/assistants/tags.rbi +2 -1
  433. data/rbi/telnyx/resources/ai/assistants/tests/runs.rbi +14 -4
  434. data/rbi/telnyx/resources/ai/assistants/tests/test_suites/runs.rbi +14 -4
  435. data/rbi/telnyx/resources/ai/assistants/tests.rbi +26 -16
  436. data/rbi/telnyx/resources/ai/assistants/tools.rbi +5 -2
  437. data/rbi/telnyx/resources/ai/assistants.rbi +109 -48
  438. data/rbi/telnyx/resources/ai/collections/sources.rbi +3 -1
  439. data/rbi/telnyx/resources/ai/collections.rbi +5 -1
  440. data/rbi/telnyx/resources/ai/conversations/insight_groups/insights.rbi +3 -2
  441. data/rbi/telnyx/resources/ai/conversations/insight_groups.rbi +22 -5
  442. data/rbi/telnyx/resources/ai/conversations/insights.rbi +22 -6
  443. data/rbi/telnyx/resources/ai/conversations.rbi +34 -4
  444. data/rbi/telnyx/resources/ai/embeddings/buckets.rbi +2 -1
  445. data/rbi/telnyx/resources/ai/embeddings.rbi +28 -4
  446. data/rbi/telnyx/resources/ai/fine_tuning/jobs.rbi +5 -3
  447. data/rbi/telnyx/resources/ai/integrations/connections.rbi +3 -2
  448. data/rbi/telnyx/resources/ai/integrations.rbi +4 -2
  449. data/rbi/telnyx/resources/ai/mcp_servers.rbi +21 -4
  450. data/rbi/telnyx/resources/ai/missions/knowledge_bases.rbi +7 -4
  451. data/rbi/telnyx/resources/ai/missions/mcp_servers.rbi +9 -5
  452. data/rbi/telnyx/resources/ai/missions/runs/events.rbi +7 -3
  453. data/rbi/telnyx/resources/ai/missions/runs/plan.rbi +10 -4
  454. data/rbi/telnyx/resources/ai/missions/runs/telnyx_agents.rbi +4 -2
  455. data/rbi/telnyx/resources/ai/missions/runs.rbi +18 -8
  456. data/rbi/telnyx/resources/ai/missions/tools.rbi +8 -5
  457. data/rbi/telnyx/resources/ai/missions.rbi +14 -6
  458. data/rbi/telnyx/resources/ai/tools.rbi +22 -2
  459. data/rbi/telnyx/resources/ai.rbi +18 -4
  460. data/rbi/telnyx/resources/authentication_providers.rbi +2 -1
  461. data/rbi/telnyx/resources/bundle_pricing/billing_bundles.rbi +4 -2
  462. data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +5 -3
  463. data/rbi/telnyx/resources/call_control_applications.rbi +4 -2
  464. data/rbi/telnyx/resources/calls/actions.rbi +20 -17
  465. data/rbi/telnyx/resources/conferences/actions.rbi +4 -6
  466. data/rbi/telnyx/resources/conferences.rbi +3 -2
  467. data/rbi/telnyx/resources/country_coverage.rbi +4 -2
  468. data/rbi/telnyx/resources/credential_connections.rbi +2 -1
  469. data/rbi/telnyx/resources/custom_storage_credentials.rbi +2 -2
  470. data/rbi/telnyx/resources/customer_service_records.rbi +4 -2
  471. data/rbi/telnyx/resources/dialogflow_connections.rbi +3 -2
  472. data/rbi/telnyx/resources/documents.rbi +4 -3
  473. data/rbi/telnyx/resources/dynamic_emergency_addresses.rbi +2 -1
  474. data/rbi/telnyx/resources/dynamic_emergency_endpoints.rbi +2 -1
  475. data/rbi/telnyx/resources/email_blocks/{import.rbi → imports.rbi} +1 -1
  476. data/rbi/telnyx/resources/email_blocks.rbi +7 -3
  477. data/rbi/telnyx/resources/email_domains.rbi +5 -0
  478. data/rbi/telnyx/resources/email_events.rbi +5 -1
  479. data/rbi/telnyx/resources/email_inboxes/drafts.rbi +11 -7
  480. data/rbi/telnyx/resources/email_inboxes/messages/actions.rbi +6 -6
  481. data/rbi/telnyx/resources/email_inboxes/messages.rbi +11 -10
  482. data/rbi/telnyx/resources/email_inboxes/threads.rbi +5 -1
  483. data/rbi/telnyx/resources/email_inboxes.rbi +1 -1
  484. data/rbi/telnyx/resources/email_messages/recipients.rbi +5 -1
  485. data/rbi/telnyx/resources/email_messages.rbi +6 -2
  486. data/rbi/telnyx/resources/email_templates.rbi +5 -2
  487. data/rbi/telnyx/resources/email_threads.rbi +5 -1
  488. data/rbi/telnyx/resources/email_unsubscribe_groups.rbi +1 -1
  489. data/rbi/telnyx/resources/enterprises.rbi +2 -2
  490. data/rbi/telnyx/resources/faxes.rbi +1 -1
  491. data/rbi/telnyx/resources/fqdn_connections.rbi +3 -2
  492. data/rbi/telnyx/resources/fqdns.rbi +3 -3
  493. data/rbi/telnyx/resources/global_ip_allowed_ports.rbi +2 -1
  494. data/rbi/telnyx/resources/global_ip_assignments.rbi +11 -5
  495. data/rbi/telnyx/resources/global_ip_health_check_types.rbi +2 -1
  496. data/rbi/telnyx/resources/global_ip_health_checks.rbi +9 -4
  497. data/rbi/telnyx/resources/global_ip_protocols.rbi +2 -1
  498. data/rbi/telnyx/resources/global_ips.rbi +8 -4
  499. data/rbi/telnyx/resources/invoices.rbi +1 -1
  500. data/rbi/telnyx/resources/ip_connections.rbi +5 -3
  501. data/rbi/telnyx/resources/ips.rbi +4 -3
  502. data/rbi/telnyx/resources/legacy/reporting/usage_reports/messaging.rbi +2 -1
  503. data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi +2 -1
  504. data/rbi/telnyx/resources/legacy/reporting/usage_reports/voice.rbi +2 -1
  505. data/rbi/telnyx/resources/managed_accounts.rbi +2 -1
  506. data/rbi/telnyx/resources/media.rbi +5 -4
  507. data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +2 -1
  508. data/rbi/telnyx/resources/messaging_optouts.rbi +2 -1
  509. data/rbi/telnyx/resources/messaging_profiles.rbi +1 -1
  510. data/rbi/telnyx/resources/mobile_push_credentials.rbi +4 -2
  511. data/rbi/telnyx/resources/mobile_voice_connections.rbi +2 -1
  512. data/rbi/telnyx/resources/networks/default_gateway.rbi +4 -3
  513. data/rbi/telnyx/resources/networks.rbi +9 -6
  514. data/rbi/telnyx/resources/notification_channels.rbi +8 -5
  515. data/rbi/telnyx/resources/notification_profiles.rbi +5 -4
  516. data/rbi/telnyx/resources/notification_settings.rbi +7 -4
  517. data/rbi/telnyx/resources/number_block_orders.rbi +2 -1
  518. data/rbi/telnyx/resources/number_orders.rbi +8 -4
  519. data/rbi/telnyx/resources/number_reservations.rbi +2 -1
  520. data/rbi/telnyx/resources/oauth.rbi +3 -2
  521. data/rbi/telnyx/resources/oauth_clients.rbi +6 -4
  522. data/rbi/telnyx/resources/oauth_grants.rbi +3 -2
  523. data/rbi/telnyx/resources/organizations/users/actions.rbi +2 -1
  524. data/rbi/telnyx/resources/organizations/users.rbi +2 -1
  525. data/rbi/telnyx/resources/outbound_voice_profiles.rbi +2 -1
  526. data/rbi/telnyx/resources/porting/events.rbi +6 -3
  527. data/rbi/telnyx/resources/porting/loa_configurations.rbi +13 -6
  528. data/rbi/telnyx/resources/porting/reports.rbi +2 -1
  529. data/rbi/telnyx/resources/porting.rbi +2 -1
  530. data/rbi/telnyx/resources/porting_orders/actions.rbi +3 -2
  531. data/rbi/telnyx/resources/porting_orders/activation_jobs.rbi +2 -1
  532. data/rbi/telnyx/resources/porting_orders/phone_number_blocks.rbi +3 -2
  533. data/rbi/telnyx/resources/porting_orders/phone_number_extensions.rbi +3 -2
  534. data/rbi/telnyx/resources/porting_orders.rbi +7 -3
  535. data/rbi/telnyx/resources/portouts/comments.rbi +2 -1
  536. data/rbi/telnyx/resources/portouts/events.rbi +5 -3
  537. data/rbi/telnyx/resources/portouts/reports.rbi +2 -1
  538. data/rbi/telnyx/resources/portouts.rbi +2 -1
  539. data/rbi/telnyx/resources/pricing/products.rbi +7 -1
  540. data/rbi/telnyx/resources/private_wireless_gateways.rbi +1 -1
  541. data/rbi/telnyx/resources/public_internet_gateways.rbi +8 -4
  542. data/rbi/telnyx/resources/queues.rbi +5 -3
  543. data/rbi/telnyx/resources/rcs/brands.rbi +2 -4
  544. data/rbi/telnyx/resources/recordings.rbi +4 -2
  545. data/rbi/telnyx/resources/reports/mdr_usage_reports.rbi +1 -1
  546. data/rbi/telnyx/resources/reports.rbi +4 -2
  547. data/rbi/telnyx/resources/requirement_types.rbi +2 -1
  548. data/rbi/telnyx/resources/requirements.rbi +3 -1
  549. data/rbi/telnyx/resources/room_recordings.rbi +2 -1
  550. data/rbi/telnyx/resources/rooms.rbi +4 -2
  551. data/rbi/telnyx/resources/sim_card_groups.rbi +4 -3
  552. data/rbi/telnyx/resources/sim_card_order_preview.rbi +2 -1
  553. data/rbi/telnyx/resources/sim_card_orders.rbi +3 -2
  554. data/rbi/telnyx/resources/sim_cards.rbi +1 -1
  555. data/rbi/telnyx/resources/siprec_connectors.rbi +1 -1
  556. data/rbi/telnyx/resources/storage/buckets.rbi +3 -3
  557. data/rbi/telnyx/resources/storage/cloudfs.rbi +5 -1
  558. data/rbi/telnyx/resources/storage/migrations/actions.rbi +2 -1
  559. data/rbi/telnyx/resources/sub_number_orders.rbi +4 -3
  560. data/rbi/telnyx/resources/telephony_credentials.rbi +7 -4
  561. data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +16 -5
  562. data/rbi/telnyx/resources/texml/accounts/conferences.rbi +6 -4
  563. data/rbi/telnyx/resources/texml/accounts/queues.rbi +7 -5
  564. data/rbi/telnyx/resources/texml.rbi +7 -0
  565. data/rbi/telnyx/resources/texml_applications.rbi +3 -2
  566. data/rbi/telnyx/resources/text_to_speech.rbi +21 -26
  567. data/rbi/telnyx/resources/traffic_policy_profiles.rbi +2 -2
  568. data/rbi/telnyx/resources/uac_connections.rbi +1 -1
  569. data/rbi/telnyx/resources/user_addresses.rbi +4 -2
  570. data/rbi/telnyx/resources/user_tags.rbi +2 -1
  571. data/rbi/telnyx/resources/verify_profiles.rbi +2 -1
  572. data/rbi/telnyx/resources/virtual_cross_connects.rbi +4 -3
  573. data/rbi/telnyx/resources/wireguard_interfaces.rbi +4 -3
  574. data/rbi/telnyx/resources/wireguard_peers.rbi +4 -4
  575. data/rbi/telnyx/resources/wireless/detail_records_reports.rbi +3 -2
  576. data/rbi/telnyx/resources/wireless_blocklists.rbi +3 -2
  577. data/sig/telnyx/internal/cloudfs_cursor_pagination.rbs +36 -0
  578. data/sig/telnyx/internal/email_bracket_cursor_pagination.rbs +24 -0
  579. data/sig/telnyx/internal/email_cursor_pagination.rbs +24 -0
  580. data/sig/telnyx/models/ai/assistant_clone_params.rbs +8 -1
  581. data/sig/telnyx/models/ai/assistant_create_params.rbs +8 -1
  582. data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
  583. data/sig/telnyx/models/ai/assistant_send_sms_params.rbs +8 -1
  584. data/sig/telnyx/models/ai/assistants/canary_deploy_create_params.rbs +8 -1
  585. data/sig/telnyx/models/ai/assistants/scheduled_event_create_params.rbs +8 -1
  586. data/sig/telnyx/models/ai/assistants/test_create_params.rbs +8 -1
  587. data/sig/telnyx/models/ai/assistants/tests/run_trigger_params.rbs +11 -1
  588. data/sig/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rbs +11 -1
  589. data/sig/telnyx/models/ai/collection_retrieve_documents_response.rbs +69 -167
  590. data/sig/telnyx/models/ai/conversation_add_message_params.rbs +8 -1
  591. data/sig/telnyx/models/ai/conversation_create_params.rbs +11 -1
  592. data/sig/telnyx/models/ai/conversation_flow.rbs +45 -0
  593. data/sig/telnyx/models/ai/conversation_flow_req.rbs +3 -262
  594. data/sig/telnyx/models/ai/conversations/insight_create_params.rbs +8 -1
  595. data/sig/telnyx/models/ai/conversations/insight_group_insight_groups_params.rbs +12 -1
  596. data/sig/telnyx/models/ai/conversations/message_list_response.rbs +31 -0
  597. data/sig/telnyx/models/ai/embedding_create_params.rbs +8 -1
  598. data/sig/telnyx/models/ai/embedding_url_params.rbs +7 -1
  599. data/sig/telnyx/models/ai/flow_edge.rbs +3 -3
  600. data/sig/telnyx/models/ai/flow_node.rbs +155 -0
  601. data/sig/telnyx/models/ai/flow_node_req.rbs +148 -0
  602. data/sig/telnyx/models/ai/inference_embedding.rbs +6 -325
  603. data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +71 -0
  604. data/sig/telnyx/models/ai/mcp_server_create_params.rbs +8 -1
  605. data/sig/telnyx/models/ai/speak_node.rbs +60 -0
  606. data/sig/telnyx/models/ai/speak_node_req.rbs +60 -0
  607. data/sig/telnyx/models/ai/tool_create_params.rbs +8 -1
  608. data/sig/telnyx/models/ai/tool_node.rbs +69 -0
  609. data/sig/telnyx/models/ai/tool_node_req.rbs +60 -0
  610. data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +68 -122
  611. data/sig/telnyx/models/ai_summarize_params.rbs +12 -1
  612. data/sig/telnyx/models/call_answered.rbs +6 -39
  613. data/sig/telnyx/models/call_dial_params.rbs +20 -0
  614. data/sig/telnyx/models/call_hangup.rbs +6 -39
  615. data/sig/telnyx/models/call_initiated.rbs +6 -39
  616. data/sig/telnyx/models/call_payment_completed_webhook_event.rbs +13 -2
  617. data/sig/telnyx/models/call_payment_progress_webhook_event.rbs +14 -1
  618. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +0 -1
  619. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +0 -1
  620. data/sig/telnyx/models/calls/action_pay_params.rbs +38 -2
  621. data/sig/telnyx/models/calls/action_speak_params.rbs +0 -1
  622. data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +0 -1
  623. data/sig/telnyx/models/calls/action_transfer_params.rbs +20 -0
  624. data/sig/telnyx/models/calls/pay_prompt_value.rbs +32 -19
  625. data/sig/telnyx/models/calls/transcription_engine_humain_config.rbs +77 -0
  626. data/sig/telnyx/models/calls/transcription_engine_reson8_config.rbs +85 -0
  627. data/sig/telnyx/models/calls/transcription_start_request.rbs +2 -154
  628. data/sig/telnyx/models/conferences/action_speak_params.rbs +0 -1
  629. data/sig/telnyx/models/conversation_relay_embedded_config.rbs +0 -1
  630. data/sig/telnyx/models/conversation_relay_language.rbs +0 -1
  631. data/sig/telnyx/models/custom_storage_configuration.rbs +1 -43
  632. data/sig/telnyx/models/dir/email_verification_status.rbs +64 -0
  633. data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +4 -67
  634. data/sig/telnyx/models/doc_service_document.rbs +0 -7
  635. data/sig/telnyx/models/document_link_list_response.rbs +3 -10
  636. data/sig/telnyx/models/email_block_retrieve_events_response.rbs +50 -72
  637. data/sig/telnyx/models/email_blocks/email_block_import.rbs +150 -0
  638. data/sig/telnyx/models/email_blocks/email_block_import_response.rbs +4 -151
  639. data/sig/telnyx/models/email_event_list_response.rbs +59 -110
  640. data/sig/telnyx/models/email_inboxes/email_draft.rbs +12 -10
  641. data/sig/telnyx/models/email_inboxes/email_draft_request.rbs +12 -10
  642. data/sig/telnyx/models/email_inboxes/email_message_response.rbs +6 -33
  643. data/sig/telnyx/models/email_inboxes/filter_add_response.rbs +4 -46
  644. data/sig/telnyx/models/email_inboxes/filter_delete_all_response.rbs +4 -45
  645. data/sig/telnyx/models/email_inboxes/filter_list_response.rbs +4 -46
  646. data/sig/telnyx/models/email_inboxes/filter_replace_response.rbs +4 -45
  647. data/sig/telnyx/models/email_inboxes/inbox_filters.rbs +42 -0
  648. data/sig/telnyx/models/email_inboxes/message_update_params.rbs +17 -7
  649. data/sig/telnyx/models/email_inboxes/messages/action_forward_params.rbs +3 -3
  650. data/sig/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbs +3 -3
  651. data/sig/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbs +3 -3
  652. data/sig/telnyx/models/email_unsubscribe_group_delete_params.rbs +14 -4
  653. data/sig/telnyx/models/email_validation_checks.rbs +52 -0
  654. data/sig/telnyx/models/email_validation_create_response.rbs +4 -53
  655. data/sig/telnyx/models/email_validations/batch_retrieve_response.rbs +4 -53
  656. data/sig/telnyx/models/enterprise_create_params.rbs +4 -4
  657. data/sig/telnyx/models/enterprise_public.rbs +5 -5
  658. data/sig/telnyx/models/enterprise_update_params.rbs +5 -5
  659. data/sig/telnyx/models/enterprises/reputation/remediation_per_number_results.rbs +54 -0
  660. data/sig/telnyx/models/enterprises/reputation/remediation_request.rbs +84 -0
  661. data/sig/telnyx/models/enterprises/reputation/remediation_request_wrapped.rbs +4 -130
  662. data/sig/telnyx/models/inbound_message.rbs +3 -45
  663. data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -613
  664. data/sig/telnyx/models/inbound_sip_header.rbs +33 -0
  665. data/sig/telnyx/models/meeting_sessions/action_accepted_response.rbs +4 -4
  666. data/sig/telnyx/models/message_retrieve_response.rbs +1 -608
  667. data/sig/telnyx/models/messaging_10dlc_get_enum_response.rbs +1 -1
  668. data/sig/telnyx/models/messaging_error_0b38e7044b.rbs +5 -5
  669. data/sig/telnyx/models/messaging_inbound_message_payload.rbs +595 -0
  670. data/sig/telnyx/models/numbers_sub_number_order.rbs +316 -0
  671. data/sig/telnyx/models/oauth_retrieve_authorize_response.rbs +5 -0
  672. data/sig/telnyx/models/pricing/product_retrieve_response.rbs +96 -118
  673. data/sig/telnyx/models/rcs/agent_configuration.rbs +9 -9
  674. data/sig/telnyx/models/rcs/agent_launch_params.rbs +3 -39
  675. data/sig/telnyx/models/rcs/brand_address.rbs +47 -0
  676. data/sig/telnyx/models/rcs/brand_create_params.rbs +7 -72
  677. data/sig/telnyx/models/rcs/brand_identifier.rbs +15 -0
  678. data/sig/telnyx/models/rcs/brand_response.rbs +8 -60
  679. data/sig/telnyx/models/rcs/brand_update_params.rbs +9 -74
  680. data/sig/telnyx/models/s3_generic_configuration_data.rbs +55 -0
  681. data/sig/telnyx/models/storage/bucket_create_presigned_url_params.rbs +23 -5
  682. data/sig/telnyx/models/storage/cloudf_list_response.rbs +51 -132
  683. data/sig/telnyx/models/storage/cloudfs_filesystem.rbs +96 -0
  684. data/sig/telnyx/models/storage/cloudfs_filesystem_detail.rbs +96 -0
  685. data/sig/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rbs +6 -99
  686. data/sig/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rbs +6 -101
  687. data/sig/telnyx/models/storage/sqldbs/action_query_params.rbs +1 -1
  688. data/sig/telnyx/models/sub_number_order_cancel_response.rbs +8 -5
  689. data/sig/telnyx/models/sub_number_order_list_params.rbs +7 -0
  690. data/sig/telnyx/models/sub_number_order_list_response.rbs +9 -6
  691. data/sig/telnyx/models/sub_number_order_retrieve_response.rbs +8 -5
  692. data/sig/telnyx/models/sub_number_order_update_response.rbs +8 -5
  693. data/sig/telnyx/models/suppressed_recipient.rbs +30 -0
  694. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +60 -0
  695. data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +20 -0
  696. data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +20 -0
  697. data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +0 -47
  698. data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +0 -2
  699. data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +0 -2
  700. data/sig/telnyx/models/voice_sdk_call_report.rbs +3 -3
  701. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbs +6 -64
  702. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbs +6 -64
  703. data/sig/telnyx/models/whatsapp/phone_numbers/whatsapp_conversational_component.rbs +65 -0
  704. data/sig/telnyx/models/wireguard_interface_create_params.rbs +6 -48
  705. data/sig/telnyx/models.rbs +12 -8
  706. data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +1 -0
  707. data/sig/telnyx/resources/ai/assistants/scheduled_events.rbs +1 -0
  708. data/sig/telnyx/resources/ai/assistants/tests/runs.rbs +1 -0
  709. data/sig/telnyx/resources/ai/assistants/tests/test_suites/runs.rbs +1 -0
  710. data/sig/telnyx/resources/ai/assistants/tests.rbs +1 -0
  711. data/sig/telnyx/resources/ai/assistants.rbs +4 -0
  712. data/sig/telnyx/resources/ai/collections.rbs +1 -1
  713. data/sig/telnyx/resources/ai/conversations/insight_groups.rbs +1 -0
  714. data/sig/telnyx/resources/ai/conversations/insights.rbs +1 -0
  715. data/sig/telnyx/resources/ai/conversations.rbs +2 -0
  716. data/sig/telnyx/resources/ai/embeddings.rbs +2 -0
  717. data/sig/telnyx/resources/ai/mcp_servers.rbs +1 -0
  718. data/sig/telnyx/resources/ai/tools.rbs +1 -0
  719. data/sig/telnyx/resources/ai.rbs +2 -1
  720. data/sig/telnyx/resources/calls/actions.rbs +1 -0
  721. data/sig/telnyx/resources/email_blocks/{import.rbs → imports.rbs} +1 -1
  722. data/sig/telnyx/resources/email_blocks.rbs +2 -2
  723. data/sig/telnyx/resources/email_events.rbs +1 -1
  724. data/sig/telnyx/resources/email_inboxes/drafts.rbs +7 -7
  725. data/sig/telnyx/resources/email_inboxes/messages.rbs +4 -4
  726. data/sig/telnyx/resources/email_inboxes/threads.rbs +1 -1
  727. data/sig/telnyx/resources/email_inboxes.rbs +1 -1
  728. data/sig/telnyx/resources/email_messages/recipients.rbs +1 -1
  729. data/sig/telnyx/resources/email_messages.rbs +2 -2
  730. data/sig/telnyx/resources/email_templates.rbs +1 -1
  731. data/sig/telnyx/resources/email_threads.rbs +1 -1
  732. data/sig/telnyx/resources/enterprises.rbs +2 -2
  733. data/sig/telnyx/resources/oauth.rbs +1 -1
  734. data/sig/telnyx/resources/pricing/products.rbs +1 -1
  735. data/sig/telnyx/resources/rcs/brands.rbs +2 -2
  736. data/sig/telnyx/resources/storage/buckets.rbs +1 -1
  737. data/sig/telnyx/resources/storage/cloudfs.rbs +1 -1
  738. data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +1 -0
  739. data/sig/telnyx/resources/texml.rbs +1 -0
  740. data/sig/telnyx/resources/text_to_speech.rbs +0 -1
  741. metadata +92 -50
  742. data/lib/telnyx/models/billing_address.rb +0 -52
  743. data/lib/telnyx/models/email_inbox_list_response.rb +0 -41
  744. data/lib/telnyx/models/email_inboxes/draft_list_response.rb +0 -24
  745. data/lib/telnyx/models/email_inboxes/message_list_response.rb +0 -24
  746. data/lib/telnyx/models/email_message_list_response.rb +0 -22
  747. data/lib/telnyx/models/email_message_retrieve_events_response.rb +0 -22
  748. data/lib/telnyx/models/email_messages/recipient_list_response.rb +0 -43
  749. data/lib/telnyx/models/email_template_list_response.rb +0 -22
  750. data/lib/telnyx/models/rime_voice_settings.rb +0 -36
  751. data/lib/telnyx/models/speech_to_text_transcribe_params.rb +0 -14
  752. data/lib/telnyx/models/stream_client_event.rb +0 -42
  753. data/lib/telnyx/models/stream_server_event.rb +0 -200
  754. data/lib/telnyx/models/text_to_speech_stream_params.rb +0 -14
  755. data/lib/telnyx/models/transcribe_server_event.rb +0 -84
  756. data/rbi/telnyx/models/billing_address.rbi +0 -69
  757. data/rbi/telnyx/models/email_inbox_list_response.rbi +0 -82
  758. data/rbi/telnyx/models/email_inboxes/draft_list_response.rbi +0 -48
  759. data/rbi/telnyx/models/email_inboxes/message_list_response.rbi +0 -48
  760. data/rbi/telnyx/models/email_message_list_response.rbi +0 -46
  761. data/rbi/telnyx/models/email_message_retrieve_events_response.rbi +0 -46
  762. data/rbi/telnyx/models/email_messages/recipient_list_response.rbi +0 -91
  763. data/rbi/telnyx/models/email_template_list_response.rbi +0 -46
  764. data/rbi/telnyx/models/rime_voice_settings.rbi +0 -67
  765. data/rbi/telnyx/models/speech_to_text_transcribe_params.rbi +0 -27
  766. data/rbi/telnyx/models/stream_client_event.rbi +0 -70
  767. data/rbi/telnyx/models/stream_server_event.rbi +0 -411
  768. data/rbi/telnyx/models/text_to_speech_stream_params.rbi +0 -27
  769. data/rbi/telnyx/models/transcribe_client_event.rbi +0 -7
  770. data/rbi/telnyx/models/transcribe_server_event.rbi +0 -127
  771. data/sig/telnyx/models/billing_address.rbs +0 -45
  772. data/sig/telnyx/models/email_inbox_list_response.rbs +0 -39
  773. data/sig/telnyx/models/email_inboxes/draft_list_response.rbs +0 -27
  774. data/sig/telnyx/models/email_inboxes/message_list_response.rbs +0 -27
  775. data/sig/telnyx/models/email_message_list_response.rbs +0 -25
  776. data/sig/telnyx/models/email_message_retrieve_events_response.rbs +0 -25
  777. data/sig/telnyx/models/email_messages/recipient_list_response.rbs +0 -39
  778. data/sig/telnyx/models/email_template_list_response.rbs +0 -25
  779. data/sig/telnyx/models/rime_voice_settings.rbs +0 -34
  780. data/sig/telnyx/models/speech_to_text_transcribe_params.rbs +0 -15
  781. data/sig/telnyx/models/stream_client_event.rbs +0 -30
  782. data/sig/telnyx/models/stream_server_event.rbs +0 -180
  783. data/sig/telnyx/models/text_to_speech_stream_params.rbs +0 -15
  784. data/sig/telnyx/models/transcribe_client_event.rbs +0 -5
  785. data/sig/telnyx/models/transcribe_server_event.rbs +0 -61
@@ -36,65 +36,68 @@ module Telnyx
36
36
  # Some parameter documentations has been truncated, see
37
37
  # {Telnyx::Models::AI::AssistantCreateParams} for more details.
38
38
  #
39
- # Create a new AI Assistant.
39
+ # Creates a new AI assistant from the provided configuration, including its model,
40
+ # instructions, and attached tools, and returns the created assistant.
40
41
  #
41
- # @overload create(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
42
+ # @overload create(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
42
43
  #
43
- # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
44
+ # @param instructions [String] Body param: System instructions for the assistant. These may be templated with [
44
45
  #
45
- # @param name [String]
46
+ # @param name [String] Body param
46
47
  #
47
- # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Conversation flow as supplied by API clients (create / update).
48
+ # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Body param: Conversation flow as supplied by API clients (create / update).
48
49
  #
49
- # @param description [String]
50
+ # @param description [String] Body param
50
51
  #
51
- # @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
52
+ # @param dynamic_variables [Hash{Symbol=>Object}] Body param: Map of dynamic variables and their default values
52
53
  #
53
- # @param dynamic_variables_webhook_timeout_ms [Integer] Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and
54
+ # @param dynamic_variables_webhook_timeout_ms [Integer] Body param: Timeout in milliseconds for the dynamic variables webhook. Must be b
54
55
  #
55
- # @param dynamic_variables_webhook_url [String] If `dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this U
56
+ # @param dynamic_variables_webhook_url [String] Body param: If `dynamic_variables_webhook_url` is set, Telnyx sends a POST reque
56
57
  #
57
- # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
58
+ # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>] Body param
58
59
  #
59
- # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
60
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq] Body param
60
61
  #
61
- # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
62
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq] Body param
62
63
  #
63
- # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
64
+ # @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
64
65
  #
65
- # @param insight_settings [Telnyx::Models::AI::InsightSettings]
66
+ # @param insight_settings [Telnyx::Models::AI::InsightSettings] Body param
66
67
  #
67
- # @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
68
+ # @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Body param: Connected integrations attached to the assistant. The catalog of ava
68
69
  #
69
- # @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
70
+ # @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Body param: Settings for interruptions and how the assistant decides the user ha
70
71
  #
71
- # @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
72
+ # @param llm_api_key_ref [String] Body param: This is only needed when using third-party inference providers selec
72
73
  #
73
- # @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
74
+ # @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] Body param: MCP servers attached to the assistant. Create MCP servers with `/ai/
74
75
  #
75
- # @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
76
+ # @param messaging_settings [Telnyx::Models::AI::MessagingSettings] Body param
76
77
  #
77
- # @param model [String] ID of the model to use when `external_llm` is not set. You can use the [Get mode
78
+ # @param model [String] Body param: ID of the model to use when `external_llm` is not set. You can use t
78
79
  #
79
- # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
80
+ # @param observability_settings [Telnyx::Models::AI::ObservabilityReq] Body param
80
81
  #
81
- # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
82
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Body param: Configuration for post-conversation processing. When enabled, the as
82
83
  #
83
- # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
84
+ # @param privacy_settings [Telnyx::Models::AI::PrivacySettings] Body param
84
85
  #
85
- # @param tags [Array<String>] Tags associated with the assistant. Tags can also be managed with the assistant
86
+ # @param tags [Array<String>] Body param: Tags associated with the assistant. Tags can also be managed with th
86
87
  #
87
- # @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
88
+ # @param telephony_settings [Telnyx::Models::AI::TelephonySettings] Body param
88
89
  #
89
- # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
90
+ # @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
90
91
  #
91
- # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
92
+ # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
92
93
  #
93
- # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
94
+ # @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
94
95
  #
95
- # @param voice_settings [Telnyx::Models::AI::VoiceSettings]
96
+ # @param voice_settings [Telnyx::Models::AI::VoiceSettings] Body param
96
97
  #
97
- # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
98
+ # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Body param: Configuration settings for the assistant's web widget.
99
+ #
100
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
98
101
  #
99
102
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
100
103
  #
@@ -103,10 +106,12 @@ module Telnyx
103
106
  # @see Telnyx::Models::AI::AssistantCreateParams
104
107
  def create(params)
105
108
  parsed, options = Telnyx::AI::AssistantCreateParams.dump_request(params)
109
+ header_params = {idempotency_key: "idempotency-key"}
106
110
  @client.request(
107
111
  method: :post,
108
112
  path: "ai/assistants",
109
- body: parsed,
113
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
114
+ body: parsed.except(*header_params.keys),
110
115
  model: Telnyx::AI::InferenceEmbedding,
111
116
  options: options
112
117
  )
@@ -146,7 +151,9 @@ module Telnyx
146
151
  # Some parameter documentations has been truncated, see
147
152
  # {Telnyx::Models::AI::AssistantUpdateParams} for more details.
148
153
  #
149
- # Update an AI Assistant's attributes.
154
+ # Updates the specified AI assistant's attributes and returns the updated
155
+ # assistant. The request can also control how the change is promoted across
156
+ # assistant versions.
150
157
  #
151
158
  # @overload update(assistant_id, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
152
159
  #
@@ -306,23 +313,30 @@ module Telnyx
306
313
  )
307
314
  end
308
315
 
316
+ # Some parameter documentations has been truncated, see
317
+ # {Telnyx::Models::AI::AssistantCloneParams} for more details.
318
+ #
309
319
  # Clone an existing assistant, excluding telephony and messaging settings.
310
320
  #
311
- # @overload clone_(assistant_id, request_options: {})
321
+ # @overload clone_(assistant_id, idempotency_key: nil, request_options: {})
312
322
  #
313
323
  # @param assistant_id [String] Unique identifier of the assistant.
314
324
  #
325
+ # @param idempotency_key [String] Optional opaque, unquoted key for safely retrying the same logical request. Keys
326
+ #
315
327
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
316
328
  #
317
329
  # @return [Telnyx::Models::AI::InferenceEmbedding]
318
330
  #
319
331
  # @see Telnyx::Models::AI::AssistantCloneParams
320
332
  def clone_(assistant_id, params = {})
333
+ parsed, options = Telnyx::AI::AssistantCloneParams.dump_request(params)
321
334
  @client.request(
322
335
  method: :post,
323
336
  path: ["ai/assistants/%1$s/clone", assistant_id],
337
+ headers: parsed.transform_keys(idempotency_key: "idempotency-key"),
324
338
  model: Telnyx::AI::InferenceEmbedding,
325
- options: params[:request_options]
339
+ options: options
326
340
  )
327
341
  end
328
342
 
@@ -353,13 +367,15 @@ module Telnyx
353
367
  # imported will be overwritten with its latest version from the importing
354
368
  # provider.
355
369
  #
356
- # @overload imports(api_key_ref:, provider:, import_ids: nil, request_options: {})
370
+ # @overload imports(api_key_ref:, provider:, import_ids: nil, idempotency_key: nil, request_options: {})
357
371
  #
358
- # @param api_key_ref [String] Integration secret pointer that refers to the API key for the external provider.
372
+ # @param api_key_ref [String] Body param: Integration secret pointer that refers to the API key for the extern
359
373
  #
360
- # @param provider [Symbol, Telnyx::Models::AI::AssistantImportsParams::Provider] The external provider to import assistants from.
374
+ # @param provider [Symbol, Telnyx::Models::AI::AssistantImportsParams::Provider] Body param: The external provider to import assistants from.
361
375
  #
362
- # @param import_ids [Array<String>] Optional list of assistant IDs to import from the external provider. If not prov
376
+ # @param import_ids [Array<String>] Body param: Optional list of assistant IDs to import from the external provider.
377
+ #
378
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
363
379
  #
364
380
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
365
381
  #
@@ -368,15 +384,20 @@ module Telnyx
368
384
  # @see Telnyx::Models::AI::AssistantImportsParams
369
385
  def imports(params)
370
386
  parsed, options = Telnyx::AI::AssistantImportsParams.dump_request(params)
387
+ header_params = {idempotency_key: "idempotency-key"}
371
388
  @client.request(
372
389
  method: :post,
373
390
  path: "ai/assistants/import",
374
- body: parsed,
391
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
392
+ body: parsed.except(*header_params.keys),
375
393
  model: Telnyx::AI::AssistantsList,
376
394
  options: options
377
395
  )
378
396
  end
379
397
 
398
+ # Some parameter documentations has been truncated, see
399
+ # {Telnyx::Models::AI::AssistantSendSMSParams} for more details.
400
+ #
380
401
  # Send an SMS message for an assistant. This endpoint:
381
402
  #
382
403
  # 1. Validates the assistant exists and has messaging profile configured
@@ -389,19 +410,21 @@ module Telnyx
389
410
  # 4. Updates conversation metadata if provided
390
411
  # 5. Returns the conversation ID
391
412
  #
392
- # @overload send_sms(assistant_id, from:, to:, conversation_metadata: nil, should_create_conversation: nil, text: nil, request_options: {})
413
+ # @overload send_sms(assistant_id, from:, to:, conversation_metadata: nil, should_create_conversation: nil, text: nil, idempotency_key: nil, request_options: {})
393
414
  #
394
- # @param assistant_id [String] Unique identifier of the assistant.
415
+ # @param assistant_id [String] Path param: Unique identifier of the assistant.
395
416
  #
396
- # @param from [String]
417
+ # @param from [String] Body param
397
418
  #
398
- # @param to [String]
419
+ # @param to [String] Body param
399
420
  #
400
- # @param conversation_metadata [Hash{Symbol=>String, Integer, Boolean}]
421
+ # @param conversation_metadata [Hash{Symbol=>String, Integer, Boolean}] Body param
401
422
  #
402
- # @param should_create_conversation [Boolean]
423
+ # @param should_create_conversation [Boolean] Body param
403
424
  #
404
- # @param text [String]
425
+ # @param text [String] Body param
426
+ #
427
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
405
428
  #
406
429
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
407
430
  #
@@ -410,10 +433,12 @@ module Telnyx
410
433
  # @see Telnyx::Models::AI::AssistantSendSMSParams
411
434
  def send_sms(assistant_id, params)
412
435
  parsed, options = Telnyx::AI::AssistantSendSMSParams.dump_request(params)
436
+ header_params = {idempotency_key: "idempotency-key"}
413
437
  @client.request(
414
438
  method: :post,
415
439
  path: ["ai/assistants/%1$s/chat/sms", assistant_id],
416
- body: parsed,
440
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
441
+ body: parsed.except(*header_params.keys),
417
442
  model: Telnyx::Models::AI::AssistantSendSMSResponse,
418
443
  options: options
419
444
  )
@@ -10,7 +10,9 @@ module Telnyx
10
10
  # Some parameter documentations has been truncated, see
11
11
  # {Telnyx::Models::AI::Collections::SourceCreateParams} for more details.
12
12
  #
13
- # Attaches a new source to a collection.
13
+ # Attaches a new content source to the specified collection and returns the
14
+ # created source. The source's content is ingested and embedded so it becomes
15
+ # searchable within the collection.
14
16
  #
15
17
  # @overload create(uuid, source_type:, bucket_id: nil, request_options: {})
16
18
  #
@@ -215,7 +215,7 @@ module Telnyx
215
215
  #
216
216
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
217
217
  #
218
- # @return [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse]
218
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse>]
219
219
  #
220
220
  # @see Telnyx::Models::AI::CollectionRetrieveDocumentsParams
221
221
  def retrieve_documents(slug, params = {})
@@ -225,6 +225,7 @@ module Telnyx
225
225
  method: :get,
226
226
  path: ["ai/collections/%1$s/documents", slug],
227
227
  query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
228
+ page: Telnyx::Internal::DefaultFlatPagination,
228
229
  model: Telnyx::Models::AI::CollectionRetrieveDocumentsResponse,
229
230
  options: options
230
231
  )
@@ -7,7 +7,7 @@ module Telnyx
7
7
  class InsightGroups
8
8
  # Manage historical AI assistant conversations
9
9
  class Insights
10
- # Assign an insight to a group
10
+ # Assigns the specified insight template to the specified insight template group.
11
11
  #
12
12
  # @overload assign(insight_id, group_id:, request_options: {})
13
13
  #
@@ -34,7 +34,8 @@ module Telnyx
34
34
  )
35
35
  end
36
36
 
37
- # Remove an insight from a group
37
+ # Removes the specified insight template from the specified group. The insight
38
+ # template itself is not deleted.
38
39
  #
39
40
  # @overload delete_unassign(insight_id, group_id:, request_options: {})
40
41
  #
@@ -10,7 +10,8 @@ module Telnyx
10
10
  # @return [Telnyx::Resources::AI::Conversations::InsightGroups::Insights]
11
11
  attr_reader :insights
12
12
 
13
- # Get insight group by ID
13
+ # Returns the details of a single insight template group, including the insight
14
+ # templates assigned to it.
14
15
  #
15
16
  # @overload retrieve(group_id, request_options: {})
16
17
  #
@@ -30,7 +31,7 @@ module Telnyx
30
31
  )
31
32
  end
32
33
 
33
- # Update an insight template group
34
+ # Updates the specified insight template group and returns the updated group.
34
35
  #
35
36
  # @overload update(group_id, description: nil, name: nil, webhook: nil, request_options: {})
36
37
  #
@@ -58,7 +59,7 @@ module Telnyx
58
59
  )
59
60
  end
60
61
 
61
- # Delete insight group by ID
62
+ # Permanently deletes the specified insight template group by its ID.
62
63
  #
63
64
  # @overload delete(group_id, request_options: {})
64
65
  #
@@ -78,13 +79,23 @@ module Telnyx
78
79
  )
79
80
  end
80
81
 
81
- # Create a new insight group
82
+ # Some parameter documentations has been truncated, see
83
+ # {Telnyx::Models::AI::Conversations::InsightGroupInsightGroupsParams} for more
84
+ # details.
82
85
  #
83
- # @overload insight_groups(name:, description: nil, webhook: nil, request_options: {})
86
+ # Creates a new insight template group for organizing related insight templates,
87
+ # and returns the created group.
88
+ #
89
+ # @overload insight_groups(name:, description: nil, webhook: nil, idempotency_key: nil, request_options: {})
90
+ #
91
+ # @param name [String] Body param
92
+ #
93
+ # @param description [String] Body param
94
+ #
95
+ # @param webhook [String] Body param
96
+ #
97
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
84
98
  #
85
- # @param name [String]
86
- # @param description [String]
87
- # @param webhook [String]
88
99
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
89
100
  #
90
101
  # @return [Telnyx::Models::AI::Conversations::InsightTemplateGroupDetail]
@@ -92,16 +103,20 @@ module Telnyx
92
103
  # @see Telnyx::Models::AI::Conversations::InsightGroupInsightGroupsParams
93
104
  def insight_groups(params)
94
105
  parsed, options = Telnyx::AI::Conversations::InsightGroupInsightGroupsParams.dump_request(params)
106
+ header_params = {idempotency_key: "idempotency-key"}
95
107
  @client.request(
96
108
  method: :post,
97
109
  path: "ai/conversations/insight-groups",
98
- body: parsed,
110
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
111
+ body: parsed.except(*header_params.keys),
99
112
  model: Telnyx::AI::Conversations::InsightTemplateGroupDetail,
100
113
  options: options
101
114
  )
102
115
  end
103
116
 
104
- # Get all insight groups
117
+ # Returns a paginated list of your insight template groups. Groups organize
118
+ # related insight templates that are applied together when analyzing
119
+ # conversations.
105
120
  #
106
121
  # @overload retrieve_insight_groups(page_number: nil, page_size: nil, request_options: {})
107
122
  #
@@ -6,17 +6,23 @@ module Telnyx
6
6
  class Conversations
7
7
  # Manage historical AI assistant conversations
8
8
  class Insights
9
- # Create a new insight
9
+ # Some parameter documentations has been truncated, see
10
+ # {Telnyx::Models::AI::Conversations::InsightCreateParams} for more details.
10
11
  #
11
- # @overload create(instructions:, name:, json_schema: nil, webhook: nil, request_options: {})
12
+ # Creates a new insight template defining an analysis to run over conversations,
13
+ # and returns the created template.
12
14
  #
13
- # @param instructions [String]
15
+ # @overload create(instructions:, name:, json_schema: nil, webhook: nil, idempotency_key: nil, request_options: {})
14
16
  #
15
- # @param name [String]
17
+ # @param instructions [String] Body param
16
18
  #
17
- # @param json_schema [String, Hash{Symbol=>Object}] If specified, the output will follow the JSON schema.
19
+ # @param name [String] Body param
18
20
  #
19
- # @param webhook [String]
21
+ # @param json_schema [String, Hash{Symbol=>Object}] Body param: If specified, the output will follow the JSON schema.
22
+ #
23
+ # @param webhook [String] Body param
24
+ #
25
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
20
26
  #
21
27
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
22
28
  #
@@ -25,16 +31,19 @@ module Telnyx
25
31
  # @see Telnyx::Models::AI::Conversations::InsightCreateParams
26
32
  def create(params)
27
33
  parsed, options = Telnyx::AI::Conversations::InsightCreateParams.dump_request(params)
34
+ header_params = {idempotency_key: "idempotency-key"}
28
35
  @client.request(
29
36
  method: :post,
30
37
  path: "ai/conversations/insights",
31
- body: parsed,
38
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
39
+ body: parsed.except(*header_params.keys),
32
40
  model: Telnyx::AI::Conversations::InsightTemplateDetail,
33
41
  options: options
34
42
  )
35
43
  end
36
44
 
37
- # Get insight by ID
45
+ # Returns the details of a single insight template by its ID, including its
46
+ # configuration.
38
47
  #
39
48
  # @overload retrieve(insight_id, request_options: {})
40
49
  #
@@ -54,7 +63,7 @@ module Telnyx
54
63
  )
55
64
  end
56
65
 
57
- # Update an insight template
66
+ # Updates the specified insight template and returns the updated template.
58
67
  #
59
68
  # @overload update(insight_id, instructions: nil, json_schema: nil, name: nil, webhook: nil, request_options: {})
60
69
  #
@@ -84,7 +93,8 @@ module Telnyx
84
93
  )
85
94
  end
86
95
 
87
- # Get all insights
96
+ # Returns a paginated list of your insight templates. Insight templates define
97
+ # analyses that run over AI conversations to extract structured findings.
88
98
  #
89
99
  # @overload list(page_number: nil, page_size: nil, request_options: {})
90
100
  #
@@ -108,7 +118,7 @@ module Telnyx
108
118
  )
109
119
  end
110
120
 
111
- # Delete insight by ID
121
+ # Permanently deletes the specified insight template by its ID.
112
122
  #
113
123
  # @overload delete(insight_id, request_options: {})
114
124
  #
@@ -24,13 +24,16 @@ module Telnyx
24
24
  # Some parameter documentations has been truncated, see
25
25
  # {Telnyx::Models::AI::ConversationCreateParams} for more details.
26
26
  #
27
- # Create a new AI Conversation.
27
+ # Creates a new AI conversation, the container for messages exchanged with an
28
+ # assistant, and returns the created conversation.
28
29
  #
29
- # @overload create(metadata: nil, name: nil, request_options: {})
30
+ # @overload create(metadata: nil, name: nil, idempotency_key: nil, request_options: {})
30
31
  #
31
- # @param metadata [Hash{Symbol=>String}] Metadata associated with the conversation. Set `ai_disabled` to `true` to create
32
+ # @param metadata [Hash{Symbol=>String}] Body param: Metadata associated with the conversation. Set `ai_disabled` to `tru
32
33
  #
33
- # @param name [String]
34
+ # @param name [String] Body param
35
+ #
36
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
34
37
  #
35
38
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
36
39
  #
@@ -39,10 +42,12 @@ module Telnyx
39
42
  # @see Telnyx::Models::AI::ConversationCreateParams
40
43
  def create(params = {})
41
44
  parsed, options = Telnyx::AI::ConversationCreateParams.dump_request(params)
45
+ header_params = {idempotency_key: "idempotency-key"}
42
46
  @client.request(
43
47
  method: :post,
44
48
  path: "ai/conversations",
45
- body: parsed,
49
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
50
+ body: parsed.except(*header_params.keys),
46
51
  model: Telnyx::AI::Conversation,
47
52
  options: options
48
53
  )
@@ -174,28 +179,33 @@ module Telnyx
174
179
  )
175
180
  end
176
181
 
182
+ # Some parameter documentations has been truncated, see
183
+ # {Telnyx::Models::AI::ConversationAddMessageParams} for more details.
184
+ #
177
185
  # Add a new message to the conversation. Used to insert a new messages to a
178
186
  # conversation manually ( without using chat endpoint )
179
187
  #
180
- # @overload add_message(conversation_id, role:, content: nil, metadata: nil, name: nil, sent_at: nil, tool_call_id: nil, tool_calls: nil, tool_choice: nil, request_options: {})
188
+ # @overload add_message(conversation_id, role:, content: nil, metadata: nil, name: nil, sent_at: nil, tool_call_id: nil, tool_calls: nil, tool_choice: nil, idempotency_key: nil, request_options: {})
189
+ #
190
+ # @param conversation_id [String] Path param: The ID of the conversation
181
191
  #
182
- # @param conversation_id [String] The ID of the conversation
192
+ # @param role [String] Body param
183
193
  #
184
- # @param role [String]
194
+ # @param content [String] Body param
185
195
  #
186
- # @param content [String]
196
+ # @param metadata [Hash{Symbol=>String, Integer, Boolean, Array<String, Integer, Boolean>}] Body param
187
197
  #
188
- # @param metadata [Hash{Symbol=>String, Integer, Boolean, Array<String, Integer, Boolean>}]
198
+ # @param name [String] Body param
189
199
  #
190
- # @param name [String]
200
+ # @param sent_at [Time] Body param
191
201
  #
192
- # @param sent_at [Time]
202
+ # @param tool_call_id [String] Body param
193
203
  #
194
- # @param tool_call_id [String]
204
+ # @param tool_calls [Array<Hash{Symbol=>Object}>] Body param
195
205
  #
196
- # @param tool_calls [Array<Hash{Symbol=>Object}>]
206
+ # @param tool_choice [String, Hash{Symbol=>Object}] Body param
197
207
  #
198
- # @param tool_choice [String, Hash{Symbol=>Object}]
208
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
199
209
  #
200
210
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
201
211
  #
@@ -204,10 +214,12 @@ module Telnyx
204
214
  # @see Telnyx::Models::AI::ConversationAddMessageParams
205
215
  def add_message(conversation_id, params)
206
216
  parsed, options = Telnyx::AI::ConversationAddMessageParams.dump_request(params)
217
+ header_params = {idempotency_key: "idempotency-key"}
207
218
  @client.request(
208
219
  method: :post,
209
220
  path: ["ai/conversations/%1$s/message", conversation_id],
210
- body: parsed,
221
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
222
+ body: parsed.except(*header_params.keys),
211
223
  model: NilClass,
212
224
  options: options
213
225
  )
@@ -27,7 +27,8 @@ module Telnyx
27
27
  )
28
28
  end
29
29
 
30
- # Get all embedding buckets for a user.
30
+ # Returns the list of storage buckets that have been embedded for your account,
31
+ # for use with similarity search.
31
32
  #
32
33
  # @overload list(request_options: {})
33
34
  #
@@ -9,6 +9,9 @@ module Telnyx
9
9
  # @return [Telnyx::Resources::AI::Embeddings::Buckets]
10
10
  attr_reader :buckets
11
11
 
12
+ # Some parameter documentations has been truncated, see
13
+ # {Telnyx::Models::AI::EmbeddingCreateParams} for more details.
14
+ #
12
15
  # Perform embedding on a Telnyx Storage Bucket using the a embedding model. The
13
16
  # current supported file types are:
14
17
  #
@@ -39,17 +42,19 @@ module Telnyx
39
42
  # values will be returned by the `/v2/ai/embeddings/similarity-search` endpoint in
40
43
  # the `loader_metadata` field.
41
44
  #
42
- # @overload create(bucket_name:, document_chunk_overlap_size: nil, document_chunk_size: nil, embedding_model: nil, loader: nil, request_options: {})
45
+ # @overload create(bucket_name:, document_chunk_overlap_size: nil, document_chunk_size: nil, embedding_model: nil, loader: nil, idempotency_key: nil, request_options: {})
43
46
  #
44
- # @param bucket_name [String]
47
+ # @param bucket_name [String] Body param
45
48
  #
46
- # @param document_chunk_overlap_size [Integer]
49
+ # @param document_chunk_overlap_size [Integer] Body param
47
50
  #
48
- # @param document_chunk_size [Integer]
51
+ # @param document_chunk_size [Integer] Body param
49
52
  #
50
- # @param embedding_model [Symbol, Telnyx::Models::AI::EmbeddingCreateParams::EmbeddingModel] Supported models to vectorize and embed documents.
53
+ # @param embedding_model [Symbol, Telnyx::Models::AI::EmbeddingCreateParams::EmbeddingModel] Body param: Supported models to vectorize and embed documents.
51
54
  #
52
- # @param loader [Symbol, Telnyx::Models::AI::EmbeddingCreateParams::Loader] Supported types of custom document loaders for embeddings.
55
+ # @param loader [Symbol, Telnyx::Models::AI::EmbeddingCreateParams::Loader] Body param: Supported types of custom document loaders for embeddings.
56
+ #
57
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
53
58
  #
54
59
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
55
60
  #
@@ -58,10 +63,12 @@ module Telnyx
58
63
  # @see Telnyx::Models::AI::EmbeddingCreateParams
59
64
  def create(params)
60
65
  parsed, options = Telnyx::AI::EmbeddingCreateParams.dump_request(params)
66
+ header_params = {idempotency_key: "idempotency-key"}
61
67
  @client.request(
62
68
  method: :post,
63
69
  path: "ai/embeddings",
64
- body: parsed,
70
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
71
+ body: parsed.except(*header_params.keys),
65
72
  model: Telnyx::AI::EmbeddingResponse,
66
73
  options: options
67
74
  )
@@ -154,6 +161,9 @@ module Telnyx
154
161
  )
155
162
  end
156
163
 
164
+ # Some parameter documentations has been truncated, see
165
+ # {Telnyx::Models::AI::EmbeddingURLParams} for more details.
166
+ #
157
167
  # Embed website content from a specified URL, including child pages up to 5 levels
158
168
  # deep within the same domain. The process crawls and loads content from the main
159
169
  # URL and its linked pages into a Telnyx Cloud Storage bucket. As soon as each
@@ -162,11 +172,13 @@ module Telnyx
162
172
  # [similarity search](https://developers.telnyx.com/api-reference/embeddings/search-for-documents)
163
173
  # and [clustering](https://developers.telnyx.com/docs/inference/clusters).
164
174
  #
165
- # @overload url(bucket_name:, url:, request_options: {})
175
+ # @overload url(bucket_name:, url:, idempotency_key: nil, request_options: {})
176
+ #
177
+ # @param bucket_name [String] Body param: Name of the bucket to store the embeddings. This bucket must already
166
178
  #
167
- # @param bucket_name [String] Name of the bucket to store the embeddings. This bucket must already exist.
179
+ # @param url [String] Body param: The URL of the webpage to embed
168
180
  #
169
- # @param url [String] The URL of the webpage to embed
181
+ # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
170
182
  #
171
183
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
172
184
  #
@@ -175,10 +187,12 @@ module Telnyx
175
187
  # @see Telnyx::Models::AI::EmbeddingURLParams
176
188
  def url(params)
177
189
  parsed, options = Telnyx::AI::EmbeddingURLParams.dump_request(params)
190
+ header_params = {idempotency_key: "idempotency-key"}
178
191
  @client.request(
179
192
  method: :post,
180
193
  path: "ai/embeddings/url",
181
- body: parsed,
194
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
195
+ body: parsed.except(*header_params.keys),
182
196
  model: Telnyx::AI::EmbeddingResponse,
183
197
  options: options
184
198
  )