telnyx 5.158.0 → 5.159.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 (771) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +51 -0
  5. data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb +4 -2
  6. data/lib/telnyx/models/ai/assistant_chat_params.rb +16 -1
  7. data/lib/telnyx/models/ai/chat_completion_request.rb +11 -1
  8. data/lib/telnyx/models/ai/openai_create_response_params.rb +11 -1
  9. data/lib/telnyx/models/ai/transcription_settings.rb +17 -1
  10. data/lib/telnyx/models/attachment_request.rb +52 -0
  11. data/lib/telnyx/models/call_assistant_request.rb +8 -1
  12. data/lib/telnyx/models/call_dial_params.rb +14 -1
  13. data/lib/telnyx/models/call_payment_completed_webhook_event.rb +344 -0
  14. data/lib/telnyx/models/call_payment_progress_webhook_event.rb +338 -0
  15. data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +11 -1
  16. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -0
  17. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -0
  18. data/lib/telnyx/models/calls/action_pay_params.rb +268 -0
  19. data/lib/telnyx/models/calls/action_pay_response.rb +18 -0
  20. data/lib/telnyx/models/calls/action_speak_params.rb +4 -0
  21. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +1 -70
  22. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +4 -0
  23. data/lib/telnyx/models/calls/action_transfer_params.rb +14 -1
  24. data/lib/telnyx/models/calls/pay_prompt_value.rb +104 -0
  25. data/lib/telnyx/models/calls/transcription_config.rb +17 -1
  26. data/lib/telnyx/models/calls/transcription_start_request.rb +166 -3
  27. data/lib/telnyx/models/conferences/action_speak_params.rb +4 -0
  28. data/lib/telnyx/models/conversation_relay_embedded_config.rb +4 -0
  29. data/lib/telnyx/models/custom_storage_configuration.rb +65 -3
  30. data/lib/telnyx/models/dir/email_verification_status_wrapped.rb +19 -1
  31. data/lib/telnyx/models/dir/reference.rb +5 -3
  32. data/lib/telnyx/models/dir/reference_create_params.rb +8 -2
  33. data/lib/telnyx/models/dns_record.rb +101 -0
  34. data/lib/telnyx/models/domains_tracking_settings.rb +37 -0
  35. data/lib/telnyx/models/email_address_input.rb +16 -0
  36. data/lib/telnyx/models/email_block.rb +174 -0
  37. data/lib/telnyx/models/email_block_create_params.rb +45 -0
  38. data/lib/telnyx/models/email_block_delete_params.rb +20 -0
  39. data/lib/telnyx/models/email_block_list_params.rb +118 -0
  40. data/lib/telnyx/models/email_block_response.rb +21 -0
  41. data/lib/telnyx/models/email_block_retrieve_events_params.rb +37 -0
  42. data/lib/telnyx/models/email_block_retrieve_events_response.rb +112 -0
  43. data/lib/telnyx/models/email_block_retrieve_export_params.rb +100 -0
  44. data/lib/telnyx/models/email_block_retrieve_export_response.rb +7 -0
  45. data/lib/telnyx/models/email_block_retrieve_params.rb +20 -0
  46. data/lib/telnyx/models/email_blocks/email_block_import_response.rb +188 -0
  47. data/lib/telnyx/models/email_blocks/import_create_params.rb +36 -0
  48. data/lib/telnyx/models/email_blocks/import_retrieve_params.rb +22 -0
  49. data/lib/telnyx/models/email_dmarc_policy.rb +77 -0
  50. data/lib/telnyx/models/email_domain.rb +257 -0
  51. data/lib/telnyx/models/email_domain_create_params.rb +51 -0
  52. data/lib/telnyx/models/email_domain_delete_params.rb +29 -0
  53. data/lib/telnyx/models/email_domain_list_params.rb +111 -0
  54. data/lib/telnyx/models/email_domain_response.rb +16 -0
  55. data/lib/telnyx/models/email_domain_retrieve_dns_records_params.rb +20 -0
  56. data/lib/telnyx/models/email_domain_retrieve_dns_records_response.rb +16 -0
  57. data/lib/telnyx/models/email_domain_retrieve_health_params.rb +20 -0
  58. data/lib/telnyx/models/email_domain_retrieve_health_response.rb +104 -0
  59. data/lib/telnyx/models/email_domain_retrieve_params.rb +20 -0
  60. data/lib/telnyx/models/email_domain_status.rb +19 -0
  61. data/lib/telnyx/models/email_domain_type.rb +16 -0
  62. data/lib/telnyx/models/email_domain_update_params.rb +51 -0
  63. data/lib/telnyx/models/email_domain_verification.rb +101 -0
  64. data/lib/telnyx/models/email_domain_verify_params.rb +20 -0
  65. data/lib/telnyx/models/email_domains/email_webhook.rb +76 -0
  66. data/lib/telnyx/models/email_domains/email_webhook_event.rb +37 -0
  67. data/lib/telnyx/models/email_domains/email_webhook_response.rb +18 -0
  68. data/lib/telnyx/models/email_domains/offset_pagination_meta.rb +35 -0
  69. data/lib/telnyx/models/email_domains/webhook_create_params.rb +39 -0
  70. data/lib/telnyx/models/email_domains/webhook_delete_params.rb +28 -0
  71. data/lib/telnyx/models/email_domains/webhook_list_params.rb +58 -0
  72. data/lib/telnyx/models/email_domains/webhook_retrieve_params.rb +28 -0
  73. data/lib/telnyx/models/email_domains/webhook_update_params.rb +40 -0
  74. data/lib/telnyx/models/email_event_list_params.rb +87 -0
  75. data/lib/telnyx/models/email_event_list_response.rb +147 -0
  76. data/lib/telnyx/models/email_event_retrieve_stats_params.rb +34 -0
  77. data/lib/telnyx/models/email_event_retrieve_stats_response.rb +198 -0
  78. data/lib/telnyx/models/email_event_type.rb +29 -0
  79. data/lib/telnyx/models/email_inbox.rb +93 -0
  80. data/lib/telnyx/models/email_inbox_create_params.rb +36 -0
  81. data/lib/telnyx/models/email_inbox_delete_params.rb +20 -0
  82. data/lib/telnyx/models/email_inbox_list_params.rb +30 -0
  83. data/lib/telnyx/models/email_inbox_list_response.rb +41 -0
  84. data/lib/telnyx/models/email_inbox_response.rb +16 -0
  85. data/lib/telnyx/models/email_inbox_retrieve_params.rb +20 -0
  86. data/lib/telnyx/models/email_inboxes/draft_create_params.rb +22 -0
  87. data/lib/telnyx/models/email_inboxes/draft_delete_params.rb +28 -0
  88. data/lib/telnyx/models/email_inboxes/draft_list_params.rb +59 -0
  89. data/lib/telnyx/models/email_inboxes/draft_list_response.rb +24 -0
  90. data/lib/telnyx/models/email_inboxes/draft_patch_params.rb +28 -0
  91. data/lib/telnyx/models/email_inboxes/draft_retrieve_params.rb +28 -0
  92. data/lib/telnyx/models/email_inboxes/draft_send_params.rb +28 -0
  93. data/lib/telnyx/models/email_inboxes/draft_update_params.rb +28 -0
  94. data/lib/telnyx/models/email_inboxes/email_address.rb +23 -0
  95. data/lib/telnyx/models/email_inboxes/email_draft.rb +219 -0
  96. data/lib/telnyx/models/email_inboxes/email_draft_request.rb +128 -0
  97. data/lib/telnyx/models/email_inboxes/email_draft_response.rb +19 -0
  98. data/lib/telnyx/models/email_inboxes/email_message.rb +252 -0
  99. data/lib/telnyx/models/email_inboxes/email_message_response.rb +66 -0
  100. data/lib/telnyx/models/email_inboxes/email_pagination_meta.rb +25 -0
  101. data/lib/telnyx/models/email_inboxes/filter_add_params.rb +22 -0
  102. data/lib/telnyx/models/email_inboxes/filter_add_response.rb +51 -0
  103. data/lib/telnyx/models/email_inboxes/filter_delete_all_params.rb +22 -0
  104. data/lib/telnyx/models/email_inboxes/filter_delete_all_response.rb +52 -0
  105. data/lib/telnyx/models/email_inboxes/filter_list_params.rb +22 -0
  106. data/lib/telnyx/models/email_inboxes/filter_list_response.rb +51 -0
  107. data/lib/telnyx/models/email_inboxes/filter_replace_params.rb +34 -0
  108. data/lib/telnyx/models/email_inboxes/filter_replace_response.rb +51 -0
  109. data/lib/telnyx/models/email_inboxes/inbound_email_address.rb +23 -0
  110. data/lib/telnyx/models/email_inboxes/inbound_thread.rb +112 -0
  111. data/lib/telnyx/models/email_inboxes/inbound_thread_detail.rb +17 -0
  112. data/lib/telnyx/models/email_inboxes/inbound_thread_list_response.rb +24 -0
  113. data/lib/telnyx/models/email_inboxes/message_drafts_params.rb +28 -0
  114. data/lib/telnyx/models/email_inboxes/message_list_params.rb +109 -0
  115. data/lib/telnyx/models/email_inboxes/message_list_response.rb +24 -0
  116. data/lib/telnyx/models/email_inboxes/message_update_params.rb +65 -0
  117. data/lib/telnyx/models/email_inboxes/message_update_response.rb +18 -0
  118. data/lib/telnyx/models/email_inboxes/messages/action_forward_params.rb +117 -0
  119. data/lib/telnyx/models/email_inboxes/messages/action_reply_all_params.rb +30 -0
  120. data/lib/telnyx/models/email_inboxes/messages/action_reply_params.rb +30 -0
  121. data/lib/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rb +38 -0
  122. data/lib/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rb +46 -0
  123. data/lib/telnyx/models/email_inboxes/messages/label_create_params.rb +30 -0
  124. data/lib/telnyx/models/email_inboxes/messages/label_create_response.rb +20 -0
  125. data/lib/telnyx/models/email_inboxes/messages/label_delete_all_params.rb +30 -0
  126. data/lib/telnyx/models/email_inboxes/messages/label_delete_all_response.rb +20 -0
  127. data/lib/telnyx/models/email_inboxes/messages/label_mutation_request.rb +28 -0
  128. data/lib/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rb +32 -0
  129. data/lib/telnyx/models/email_inboxes/mutate_inbox_filters_request.rb +38 -0
  130. data/lib/telnyx/models/email_inboxes/thread_list_params.rb +51 -0
  131. data/lib/telnyx/models/email_inboxes/thread_message.rb +255 -0
  132. data/lib/telnyx/models/email_inboxes/thread_retrieve_params.rb +46 -0
  133. data/lib/telnyx/models/email_inboxes/thread_retrieve_response.rb +24 -0
  134. data/lib/telnyx/models/email_inboxes/threads/label_create_params.rb +30 -0
  135. data/lib/telnyx/models/email_inboxes/threads/label_create_response.rb +60 -0
  136. data/lib/telnyx/models/email_inboxes/threads/label_delete_all_params.rb +30 -0
  137. data/lib/telnyx/models/email_inboxes/threads/label_delete_all_response.rb +60 -0
  138. data/lib/telnyx/models/email_message_batch_params.rb +239 -0
  139. data/lib/telnyx/models/email_message_batch_response.rb +95 -0
  140. data/lib/telnyx/models/email_message_create_params.rb +257 -0
  141. data/lib/telnyx/models/email_message_delete_all_params.rb +25 -0
  142. data/lib/telnyx/models/email_message_delete_params.rb +20 -0
  143. data/lib/telnyx/models/email_message_delete_schedule_params.rb +20 -0
  144. data/lib/telnyx/models/email_message_list_params.rb +34 -0
  145. data/lib/telnyx/models/email_message_list_response.rb +22 -0
  146. data/lib/telnyx/models/email_message_retrieve_events_params.rb +41 -0
  147. data/lib/telnyx/models/email_message_retrieve_events_response.rb +22 -0
  148. data/lib/telnyx/models/email_message_retrieve_params.rb +20 -0
  149. data/lib/telnyx/models/email_message_retrieve_response.rb +36 -0
  150. data/lib/telnyx/models/email_messages/email_recipient.rb +143 -0
  151. data/lib/telnyx/models/email_messages/recipient_list_params.rb +89 -0
  152. data/lib/telnyx/models/email_messages/recipient_list_response.rb +43 -0
  153. data/lib/telnyx/models/email_messages/recipient_retrieve_params.rb +28 -0
  154. data/lib/telnyx/models/email_messages/recipient_retrieve_response.rb +18 -0
  155. data/lib/telnyx/models/email_template.rb +73 -0
  156. data/lib/telnyx/models/email_template_create_params.rb +61 -0
  157. data/lib/telnyx/models/email_template_delete_params.rb +20 -0
  158. data/lib/telnyx/models/email_template_list_params.rb +34 -0
  159. data/lib/telnyx/models/email_template_list_response.rb +22 -0
  160. data/lib/telnyx/models/email_template_render_params.rb +33 -0
  161. data/lib/telnyx/models/email_template_render_response.rb +30 -0
  162. data/lib/telnyx/models/email_template_replace_params.rb +20 -0
  163. data/lib/telnyx/models/email_template_response.rb +16 -0
  164. data/lib/telnyx/models/email_template_retrieve_params.rb +20 -0
  165. data/lib/telnyx/models/email_template_update_params.rb +20 -0
  166. data/lib/telnyx/models/email_thread_list_params.rb +54 -0
  167. data/lib/telnyx/models/email_thread_retrieve_params.rb +45 -0
  168. data/lib/telnyx/models/email_thread_retrieve_response.rb +22 -0
  169. data/lib/telnyx/models/email_unsubscribe_group_create_params.rb +26 -0
  170. data/lib/telnyx/models/email_unsubscribe_group_delete_params.rb +59 -0
  171. data/lib/telnyx/models/email_unsubscribe_group_list_params.rb +30 -0
  172. data/lib/telnyx/models/email_unsubscribe_group_retrieve_params.rb +20 -0
  173. data/lib/telnyx/models/email_unsubscribe_group_update_params.rb +32 -0
  174. data/lib/telnyx/models/email_unsubscribe_groups/suppression_create_params.rb +28 -0
  175. data/lib/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rb +28 -0
  176. data/lib/telnyx/models/email_unsubscribe_groups/suppression_list_params.rb +39 -0
  177. data/lib/telnyx/models/email_validation_check.rb +23 -0
  178. data/lib/telnyx/models/email_validation_create_params.rb +33 -0
  179. data/lib/telnyx/models/email_validation_create_response.rb +120 -0
  180. data/lib/telnyx/models/email_validations/batch_create_params.rb +42 -0
  181. data/lib/telnyx/models/email_validations/batch_create_response.rb +73 -0
  182. data/lib/telnyx/models/email_validations/batch_retrieve_params.rb +22 -0
  183. data/lib/telnyx/models/email_validations/batch_retrieve_response.rb +173 -0
  184. data/lib/telnyx/models/email_validations/email_validation_batch_status.rb +21 -0
  185. data/lib/telnyx/models/fax.rb +36 -1
  186. data/lib/telnyx/models/fax_failed.rb +15 -17
  187. data/lib/telnyx/models/group_list_meta.rb +35 -0
  188. data/lib/telnyx/models/inbound_message.rb +6 -288
  189. data/lib/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rb +17 -1
  190. data/lib/telnyx/models/legacy/reporting/usage_reports/telco_data_usage_report_response.rb +1 -0
  191. data/lib/telnyx/models/message_event.rb +27 -0
  192. data/lib/telnyx/models/messaging_10dlc/phone_number_campaign.rb +17 -1
  193. data/lib/telnyx/models/model_metadata.rb +22 -1
  194. data/lib/telnyx/models/offset_meta.rb +33 -0
  195. data/lib/telnyx/models/phone_numbers/action_change_bundle_status_params.rb +3 -3
  196. data/lib/telnyx/models/pricing/pricing_pagination_meta.rb +37 -0
  197. data/lib/telnyx/models/pricing/pricing_tier.rb +55 -0
  198. data/lib/telnyx/models/pricing/product_list_params.rb +32 -0
  199. data/lib/telnyx/models/pricing/product_list_response.rb +35 -0
  200. data/lib/telnyx/models/pricing/product_retrieve_params.rb +39 -0
  201. data/lib/telnyx/models/pricing/product_retrieve_response.rb +192 -0
  202. data/lib/telnyx/models/s3_configuration_data.rb +17 -17
  203. data/lib/telnyx/models/short_code.rb +2 -1
  204. data/lib/telnyx/models/short_code_update_params.rb +2 -1
  205. data/lib/telnyx/models/speech_to_text_list_providers_params.rb +2 -0
  206. data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +4 -0
  207. data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +52 -1
  208. data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
  209. data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +1 -0
  210. data/lib/telnyx/models/time_range.rb +21 -0
  211. data/lib/telnyx/models/tracking_settings.rb +27 -0
  212. data/lib/telnyx/models/uac_external_settings.rb +10 -1
  213. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
  214. data/lib/telnyx/models/unsubscribe_group.rb +65 -0
  215. data/lib/telnyx/models/unsubscribe_group_response.rb +16 -0
  216. data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
  217. data/lib/telnyx/models/update_email_template_request.rb +46 -0
  218. data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb +2 -2
  219. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rb +24 -0
  220. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rb +72 -0
  221. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rb +58 -0
  222. data/lib/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rb +73 -0
  223. data/lib/telnyx/models.rb +156 -0
  224. data/lib/telnyx/resources/ai/anthropic/v1.rb +1 -1
  225. data/lib/telnyx/resources/ai/assistants.rb +6 -1
  226. data/lib/telnyx/resources/ai/openai/chat.rb +3 -1
  227. data/lib/telnyx/resources/ai/openai.rb +3 -1
  228. data/lib/telnyx/resources/calls/actions.rb +87 -8
  229. data/lib/telnyx/resources/calls.rb +3 -1
  230. data/lib/telnyx/resources/custom_storage_credentials.rb +2 -2
  231. data/lib/telnyx/resources/dir/references.rb +31 -9
  232. data/lib/telnyx/resources/dir.rb +3 -2
  233. data/lib/telnyx/resources/email_blocks/import.rb +79 -0
  234. data/lib/telnyx/resources/email_blocks.rb +249 -0
  235. data/lib/telnyx/resources/email_domains/webhooks.rb +162 -0
  236. data/lib/telnyx/resources/email_domains.rb +245 -0
  237. data/lib/telnyx/resources/email_events.rb +81 -0
  238. data/lib/telnyx/resources/email_inboxes/drafts.rb +329 -0
  239. data/lib/telnyx/resources/email_inboxes/filters.rb +122 -0
  240. data/lib/telnyx/resources/email_inboxes/messages/actions.rb +149 -0
  241. data/lib/telnyx/resources/email_inboxes/messages/labels.rb +98 -0
  242. data/lib/telnyx/resources/email_inboxes/messages.rb +191 -0
  243. data/lib/telnyx/resources/email_inboxes/threads/labels.rb +93 -0
  244. data/lib/telnyx/resources/email_inboxes/threads.rb +97 -0
  245. data/lib/telnyx/resources/email_inboxes.rb +136 -0
  246. data/lib/telnyx/resources/email_messages/recipients.rb +84 -0
  247. data/lib/telnyx/resources/email_messages.rb +294 -0
  248. data/lib/telnyx/resources/email_templates.rb +213 -0
  249. data/lib/telnyx/resources/email_threads.rb +91 -0
  250. data/lib/telnyx/resources/email_unsubscribe_groups/suppressions.rb +111 -0
  251. data/lib/telnyx/resources/email_unsubscribe_groups.rb +151 -0
  252. data/lib/telnyx/resources/email_validations/batch.rb +69 -0
  253. data/lib/telnyx/resources/email_validations.rb +49 -0
  254. data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb +12 -4
  255. data/lib/telnyx/resources/phone_numbers/actions.rb +1 -1
  256. data/lib/telnyx/resources/pricing/products.rb +76 -0
  257. data/lib/telnyx/resources/pricing.rb +19 -0
  258. data/lib/telnyx/resources/short_codes.rb +1 -1
  259. data/lib/telnyx/resources/speech_to_text.rb +1 -1
  260. data/lib/telnyx/resources/text_to_speech.rb +5 -3
  261. data/lib/telnyx/resources/webhooks.rb +2 -2
  262. data/lib/telnyx/resources/whatsapp/phone_numbers/conversational_components.rb +66 -0
  263. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +6 -0
  264. data/lib/telnyx/version.rb +1 -1
  265. data/lib/telnyx.rb +200 -1
  266. data/rbi/telnyx/client.rbi +41 -0
  267. data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi +6 -2
  268. data/rbi/telnyx/models/ai/assistant_chat_params.rbi +19 -0
  269. data/rbi/telnyx/models/ai/chat_completion_request.rbi +15 -0
  270. data/rbi/telnyx/models/ai/openai_create_response_params.rbi +15 -0
  271. data/rbi/telnyx/models/ai/transcription_settings.rbi +36 -2
  272. data/rbi/telnyx/models/attachment_request.rbi +83 -0
  273. data/rbi/telnyx/models/call_assistant_request.rbi +12 -3
  274. data/rbi/telnyx/models/call_dial_params.rbi +21 -0
  275. data/rbi/telnyx/models/call_payment_completed_webhook_event.rbi +724 -0
  276. data/rbi/telnyx/models/call_payment_progress_webhook_event.rbi +793 -0
  277. data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +15 -0
  278. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +8 -0
  279. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +8 -0
  280. data/rbi/telnyx/models/calls/action_pay_params.rbi +484 -0
  281. data/rbi/telnyx/models/calls/action_pay_response.rbi +39 -0
  282. data/rbi/telnyx/models/calls/action_speak_params.rbi +8 -0
  283. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +0 -153
  284. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +8 -0
  285. data/rbi/telnyx/models/calls/action_transfer_params.rbi +21 -0
  286. data/rbi/telnyx/models/calls/pay_prompt_value.rbi +252 -0
  287. data/rbi/telnyx/models/calls/transcription_config.rbi +36 -2
  288. data/rbi/telnyx/models/calls/transcription_start_request.rbi +469 -0
  289. data/rbi/telnyx/models/conferences/action_speak_params.rbi +8 -0
  290. data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +8 -0
  291. data/rbi/telnyx/models/custom_storage_configuration.rbi +90 -0
  292. data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi +23 -3
  293. data/rbi/telnyx/models/dir/reference.rbi +8 -4
  294. data/rbi/telnyx/models/dir/reference_create_params.rbi +14 -2
  295. data/rbi/telnyx/models/dns_record.rbi +139 -0
  296. data/rbi/telnyx/models/domains_tracking_settings.rbi +66 -0
  297. data/rbi/telnyx/models/email_address_input.rbi +16 -0
  298. data/rbi/telnyx/models/email_block.rbi +218 -0
  299. data/rbi/telnyx/models/email_block_create_params.rbi +65 -0
  300. data/rbi/telnyx/models/email_block_delete_params.rbi +35 -0
  301. data/rbi/telnyx/models/email_block_list_params.rbi +217 -0
  302. data/rbi/telnyx/models/email_block_response.rbi +32 -0
  303. data/rbi/telnyx/models/email_block_retrieve_events_params.rbi +66 -0
  304. data/rbi/telnyx/models/email_block_retrieve_events_response.rbi +223 -0
  305. data/rbi/telnyx/models/email_block_retrieve_export_params.rbi +216 -0
  306. data/rbi/telnyx/models/email_block_retrieve_export_response.rbi +7 -0
  307. data/rbi/telnyx/models/email_block_retrieve_params.rbi +35 -0
  308. data/rbi/telnyx/models/email_blocks/email_block_import_response.rbi +363 -0
  309. data/rbi/telnyx/models/email_blocks/import_create_params.rbi +61 -0
  310. data/rbi/telnyx/models/email_blocks/import_retrieve_params.rbi +40 -0
  311. data/rbi/telnyx/models/email_dmarc_policy.rbi +113 -0
  312. data/rbi/telnyx/models/email_domain.rbi +376 -0
  313. data/rbi/telnyx/models/email_domain_create_params.rbi +80 -0
  314. data/rbi/telnyx/models/email_domain_delete_params.rbi +52 -0
  315. data/rbi/telnyx/models/email_domain_list_params.rbi +177 -0
  316. data/rbi/telnyx/models/email_domain_response.rbi +28 -0
  317. data/rbi/telnyx/models/email_domain_retrieve_dns_records_params.rbi +38 -0
  318. data/rbi/telnyx/models/email_domain_retrieve_dns_records_response.rbi +30 -0
  319. data/rbi/telnyx/models/email_domain_retrieve_health_params.rbi +38 -0
  320. data/rbi/telnyx/models/email_domain_retrieve_health_response.rbi +224 -0
  321. data/rbi/telnyx/models/email_domain_retrieve_params.rbi +35 -0
  322. data/rbi/telnyx/models/email_domain_status.rbi +25 -0
  323. data/rbi/telnyx/models/email_domain_type.rbi +21 -0
  324. data/rbi/telnyx/models/email_domain_update_params.rbi +80 -0
  325. data/rbi/telnyx/models/email_domain_verification.rbi +195 -0
  326. data/rbi/telnyx/models/email_domain_verify_params.rbi +35 -0
  327. data/rbi/telnyx/models/email_domains/email_webhook.rbi +114 -0
  328. data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +124 -0
  329. data/rbi/telnyx/models/email_domains/email_webhook_response.rbi +35 -0
  330. data/rbi/telnyx/models/email_domains/offset_pagination_meta.rbi +53 -0
  331. data/rbi/telnyx/models/email_domains/webhook_create_params.rbi +65 -0
  332. data/rbi/telnyx/models/email_domains/webhook_delete_params.rbi +48 -0
  333. data/rbi/telnyx/models/email_domains/webhook_list_params.rbi +119 -0
  334. data/rbi/telnyx/models/email_domains/webhook_retrieve_params.rbi +48 -0
  335. data/rbi/telnyx/models/email_domains/webhook_update_params.rbi +81 -0
  336. data/rbi/telnyx/models/email_event_list_params.rbi +140 -0
  337. data/rbi/telnyx/models/email_event_list_response.rbi +272 -0
  338. data/rbi/telnyx/models/email_event_retrieve_stats_params.rbi +58 -0
  339. data/rbi/telnyx/models/email_event_retrieve_stats_response.rbi +339 -0
  340. data/rbi/telnyx/models/email_event_type.rbi +34 -0
  341. data/rbi/telnyx/models/email_inbox.rbi +119 -0
  342. data/rbi/telnyx/models/email_inbox_create_params.rbi +63 -0
  343. data/rbi/telnyx/models/email_inbox_delete_params.rbi +35 -0
  344. data/rbi/telnyx/models/email_inbox_list_params.rbi +57 -0
  345. data/rbi/telnyx/models/email_inbox_list_response.rbi +82 -0
  346. data/rbi/telnyx/models/email_inbox_response.rbi +26 -0
  347. data/rbi/telnyx/models/email_inbox_retrieve_params.rbi +35 -0
  348. data/rbi/telnyx/models/email_inboxes/draft_create_params.rbi +40 -0
  349. data/rbi/telnyx/models/email_inboxes/draft_delete_params.rbi +48 -0
  350. data/rbi/telnyx/models/email_inboxes/draft_list_params.rbi +129 -0
  351. data/rbi/telnyx/models/email_inboxes/draft_list_response.rbi +48 -0
  352. data/rbi/telnyx/models/email_inboxes/draft_patch_params.rbi +48 -0
  353. data/rbi/telnyx/models/email_inboxes/draft_retrieve_params.rbi +48 -0
  354. data/rbi/telnyx/models/email_inboxes/draft_send_params.rbi +48 -0
  355. data/rbi/telnyx/models/email_inboxes/draft_update_params.rbi +48 -0
  356. data/rbi/telnyx/models/email_inboxes/email_address.rbi +31 -0
  357. data/rbi/telnyx/models/email_inboxes/email_draft.rbi +296 -0
  358. data/rbi/telnyx/models/email_inboxes/email_draft_request.rbi +233 -0
  359. data/rbi/telnyx/models/email_inboxes/email_draft_response.rbi +39 -0
  360. data/rbi/telnyx/models/email_inboxes/email_message.rbi +391 -0
  361. data/rbi/telnyx/models/email_inboxes/email_message_response.rbi +132 -0
  362. data/rbi/telnyx/models/email_inboxes/email_pagination_meta.rbi +43 -0
  363. data/rbi/telnyx/models/email_inboxes/filter_add_params.rbi +40 -0
  364. data/rbi/telnyx/models/email_inboxes/filter_add_response.rbi +119 -0
  365. data/rbi/telnyx/models/email_inboxes/filter_delete_all_params.rbi +40 -0
  366. data/rbi/telnyx/models/email_inboxes/filter_delete_all_response.rbi +125 -0
  367. data/rbi/telnyx/models/email_inboxes/filter_list_params.rbi +40 -0
  368. data/rbi/telnyx/models/email_inboxes/filter_list_response.rbi +119 -0
  369. data/rbi/telnyx/models/email_inboxes/filter_replace_params.rbi +64 -0
  370. data/rbi/telnyx/models/email_inboxes/filter_replace_response.rbi +123 -0
  371. data/rbi/telnyx/models/email_inboxes/inbound_email_address.rbi +34 -0
  372. data/rbi/telnyx/models/email_inboxes/inbound_thread.rbi +146 -0
  373. data/rbi/telnyx/models/email_inboxes/inbound_thread_detail.rbi +36 -0
  374. data/rbi/telnyx/models/email_inboxes/inbound_thread_list_response.rbi +48 -0
  375. data/rbi/telnyx/models/email_inboxes/message_drafts_params.rbi +48 -0
  376. data/rbi/telnyx/models/email_inboxes/message_list_params.rbi +162 -0
  377. data/rbi/telnyx/models/email_inboxes/message_list_response.rbi +48 -0
  378. data/rbi/telnyx/models/email_inboxes/message_update_params.rbi +124 -0
  379. data/rbi/telnyx/models/email_inboxes/message_update_response.rbi +33 -0
  380. data/rbi/telnyx/models/email_inboxes/messages/action_forward_params.rbi +312 -0
  381. data/rbi/telnyx/models/email_inboxes/messages/action_reply_all_params.rbi +50 -0
  382. data/rbi/telnyx/models/email_inboxes/messages/action_reply_params.rbi +50 -0
  383. data/rbi/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbi +62 -0
  384. data/rbi/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbi +74 -0
  385. data/rbi/telnyx/models/email_inboxes/messages/label_create_params.rbi +50 -0
  386. data/rbi/telnyx/models/email_inboxes/messages/label_create_response.rbi +37 -0
  387. data/rbi/telnyx/models/email_inboxes/messages/label_delete_all_params.rbi +50 -0
  388. data/rbi/telnyx/models/email_inboxes/messages/label_delete_all_response.rbi +37 -0
  389. data/rbi/telnyx/models/email_inboxes/messages/label_mutation_request.rbi +40 -0
  390. data/rbi/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rbi +49 -0
  391. data/rbi/telnyx/models/email_inboxes/mutate_inbox_filters_request.rbi +89 -0
  392. data/rbi/telnyx/models/email_inboxes/thread_list_params.rbi +81 -0
  393. data/rbi/telnyx/models/email_inboxes/thread_message.rbi +318 -0
  394. data/rbi/telnyx/models/email_inboxes/thread_retrieve_params.rbi +74 -0
  395. data/rbi/telnyx/models/email_inboxes/thread_retrieve_response.rbi +53 -0
  396. data/rbi/telnyx/models/email_inboxes/threads/label_create_params.rbi +50 -0
  397. data/rbi/telnyx/models/email_inboxes/threads/label_create_response.rbi +138 -0
  398. data/rbi/telnyx/models/email_inboxes/threads/label_delete_all_params.rbi +50 -0
  399. data/rbi/telnyx/models/email_inboxes/threads/label_delete_all_response.rbi +138 -0
  400. data/rbi/telnyx/models/email_message_batch_params.rbi +386 -0
  401. data/rbi/telnyx/models/email_message_batch_response.rbi +206 -0
  402. data/rbi/telnyx/models/email_message_create_params.rbi +391 -0
  403. data/rbi/telnyx/models/email_message_delete_all_params.rbi +40 -0
  404. data/rbi/telnyx/models/email_message_delete_params.rbi +35 -0
  405. data/rbi/telnyx/models/email_message_delete_schedule_params.rbi +38 -0
  406. data/rbi/telnyx/models/email_message_list_params.rbi +59 -0
  407. data/rbi/telnyx/models/email_message_list_response.rbi +46 -0
  408. data/rbi/telnyx/models/email_message_retrieve_events_params.rbi +68 -0
  409. data/rbi/telnyx/models/email_message_retrieve_events_response.rbi +46 -0
  410. data/rbi/telnyx/models/email_message_retrieve_params.rbi +35 -0
  411. data/rbi/telnyx/models/email_message_retrieve_response.rbi +81 -0
  412. data/rbi/telnyx/models/email_messages/email_recipient.rbi +260 -0
  413. data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +218 -0
  414. data/rbi/telnyx/models/email_messages/recipient_list_response.rbi +91 -0
  415. data/rbi/telnyx/models/email_messages/recipient_retrieve_params.rbi +48 -0
  416. data/rbi/telnyx/models/email_messages/recipient_retrieve_response.rbi +37 -0
  417. data/rbi/telnyx/models/email_template.rbi +103 -0
  418. data/rbi/telnyx/models/email_template_create_params.rbi +87 -0
  419. data/rbi/telnyx/models/email_template_delete_params.rbi +35 -0
  420. data/rbi/telnyx/models/email_template_list_params.rbi +59 -0
  421. data/rbi/telnyx/models/email_template_list_response.rbi +46 -0
  422. data/rbi/telnyx/models/email_template_render_params.rbi +54 -0
  423. data/rbi/telnyx/models/email_template_render_response.rbi +70 -0
  424. data/rbi/telnyx/models/email_template_replace_params.rbi +35 -0
  425. data/rbi/telnyx/models/email_template_response.rbi +28 -0
  426. data/rbi/telnyx/models/email_template_retrieve_params.rbi +35 -0
  427. data/rbi/telnyx/models/email_template_update_params.rbi +35 -0
  428. data/rbi/telnyx/models/email_thread_list_params.rbi +89 -0
  429. data/rbi/telnyx/models/email_thread_retrieve_params.rbi +71 -0
  430. data/rbi/telnyx/models/email_thread_retrieve_response.rbi +51 -0
  431. data/rbi/telnyx/models/email_unsubscribe_group_create_params.rbi +46 -0
  432. data/rbi/telnyx/models/email_unsubscribe_group_delete_params.rbi +121 -0
  433. data/rbi/telnyx/models/email_unsubscribe_group_list_params.rbi +60 -0
  434. data/rbi/telnyx/models/email_unsubscribe_group_retrieve_params.rbi +38 -0
  435. data/rbi/telnyx/models/email_unsubscribe_group_update_params.rbi +54 -0
  436. data/rbi/telnyx/models/email_unsubscribe_groups/suppression_create_params.rbi +44 -0
  437. data/rbi/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rbi +48 -0
  438. data/rbi/telnyx/models/email_unsubscribe_groups/suppression_list_params.rbi +68 -0
  439. data/rbi/telnyx/models/email_validation_check.rbi +36 -0
  440. data/rbi/telnyx/models/email_validation_create_params.rbi +54 -0
  441. data/rbi/telnyx/models/email_validation_create_response.rbi +261 -0
  442. data/rbi/telnyx/models/email_validations/batch_create_params.rbi +68 -0
  443. data/rbi/telnyx/models/email_validations/batch_create_response.rbi +161 -0
  444. data/rbi/telnyx/models/email_validations/batch_retrieve_params.rbi +40 -0
  445. data/rbi/telnyx/models/email_validations/batch_retrieve_response.rbi +386 -0
  446. data/rbi/telnyx/models/email_validations/email_validation_batch_status.rbi +50 -0
  447. data/rbi/telnyx/models/fax.rbi +54 -0
  448. data/rbi/telnyx/models/fax_failed.rbi +21 -46
  449. data/rbi/telnyx/models/group_list_meta.rbi +47 -0
  450. data/rbi/telnyx/models/inbound_message.rbi +17 -329
  451. data/rbi/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rbi +33 -5
  452. data/rbi/telnyx/models/message_event.rbi +44 -0
  453. data/rbi/telnyx/models/messaging_10dlc/phone_number_campaign.rbi +25 -3
  454. data/rbi/telnyx/models/model_metadata.rbi +46 -0
  455. data/rbi/telnyx/models/offset_meta.rbi +46 -0
  456. data/rbi/telnyx/models/phone_numbers/action_change_bundle_status_params.rbi +3 -3
  457. data/rbi/telnyx/models/pricing/pricing_pagination_meta.rbi +55 -0
  458. data/rbi/telnyx/models/pricing/pricing_tier.rbi +75 -0
  459. data/rbi/telnyx/models/pricing/product_list_params.rbi +59 -0
  460. data/rbi/telnyx/models/pricing/product_list_response.rbi +50 -0
  461. data/rbi/telnyx/models/pricing/product_retrieve_params.rbi +68 -0
  462. data/rbi/telnyx/models/pricing/product_retrieve_response.rbi +312 -0
  463. data/rbi/telnyx/models/s3_configuration_data.rbi +19 -31
  464. data/rbi/telnyx/models/short_code.rbi +2 -0
  465. data/rbi/telnyx/models/short_code_update_params.rbi +2 -0
  466. data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +10 -0
  467. data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +20 -0
  468. data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +136 -0
  469. data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
  470. data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +5 -0
  471. data/rbi/telnyx/models/time_range.rbi +28 -0
  472. data/rbi/telnyx/models/tracking_settings.rbi +49 -0
  473. data/rbi/telnyx/models/uac_external_settings.rbi +10 -0
  474. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +2 -0
  475. data/rbi/telnyx/models/unsubscribe_group.rbi +92 -0
  476. data/rbi/telnyx/models/unsubscribe_group_response.rbi +28 -0
  477. data/rbi/telnyx/models/unwrap_webhook_event.rbi +2 -0
  478. data/rbi/telnyx/models/update_email_template_request.rbi +71 -0
  479. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbi +3 -6
  480. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rbi +42 -0
  481. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbi +180 -0
  482. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rbi +125 -0
  483. data/rbi/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbi +180 -0
  484. data/rbi/telnyx/models.rbi +169 -0
  485. data/rbi/telnyx/resources/ai/anthropic/v1.rbi +3 -1
  486. data/rbi/telnyx/resources/ai/assistants.rbi +7 -0
  487. data/rbi/telnyx/resources/ai/openai/chat.rbi +5 -0
  488. data/rbi/telnyx/resources/ai/openai.rbi +5 -0
  489. data/rbi/telnyx/resources/calls/actions.rbi +124 -44
  490. data/rbi/telnyx/resources/calls.rbi +8 -0
  491. data/rbi/telnyx/resources/conferences/actions.rbi +4 -0
  492. data/rbi/telnyx/resources/custom_storage_credentials.rbi +2 -0
  493. data/rbi/telnyx/resources/dir/references.rbi +41 -10
  494. data/rbi/telnyx/resources/dir.rbi +3 -2
  495. data/rbi/telnyx/resources/email_blocks/import.rbi +61 -0
  496. data/rbi/telnyx/resources/email_blocks.rbi +198 -0
  497. data/rbi/telnyx/resources/email_domains/webhooks.rbi +122 -0
  498. data/rbi/telnyx/resources/email_domains.rbi +180 -0
  499. data/rbi/telnyx/resources/email_events.rbi +67 -0
  500. data/rbi/telnyx/resources/email_inboxes/drafts.rbi +319 -0
  501. data/rbi/telnyx/resources/email_inboxes/filters.rbi +94 -0
  502. data/rbi/telnyx/resources/email_inboxes/messages/actions.rbi +155 -0
  503. data/rbi/telnyx/resources/email_inboxes/messages/labels.rbi +80 -0
  504. data/rbi/telnyx/resources/email_inboxes/messages.rbi +185 -0
  505. data/rbi/telnyx/resources/email_inboxes/threads/labels.rbi +75 -0
  506. data/rbi/telnyx/resources/email_inboxes/threads.rbi +70 -0
  507. data/rbi/telnyx/resources/email_inboxes.rbi +100 -0
  508. data/rbi/telnyx/resources/email_messages/recipients.rbi +66 -0
  509. data/rbi/telnyx/resources/email_messages.rbi +299 -0
  510. data/rbi/telnyx/resources/email_templates.rbi +167 -0
  511. data/rbi/telnyx/resources/email_threads.rbi +74 -0
  512. data/rbi/telnyx/resources/email_unsubscribe_groups/suppressions.rbi +83 -0
  513. data/rbi/telnyx/resources/email_unsubscribe_groups.rbi +110 -0
  514. data/rbi/telnyx/resources/email_validations/batch.rbi +59 -0
  515. data/rbi/telnyx/resources/email_validations.rbi +42 -0
  516. data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi +15 -3
  517. data/rbi/telnyx/resources/phone_numbers/actions.rbi +1 -1
  518. data/rbi/telnyx/resources/pricing/products.rbi +62 -0
  519. data/rbi/telnyx/resources/pricing.rbi +16 -0
  520. data/rbi/telnyx/resources/short_codes.rbi +1 -0
  521. data/rbi/telnyx/resources/speech_to_text.rbi +1 -1
  522. data/rbi/telnyx/resources/text_to_speech.rbi +7 -2
  523. data/rbi/telnyx/resources/webhooks.rbi +4 -0
  524. data/rbi/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbi +58 -0
  525. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +8 -0
  526. data/sig/telnyx/client.rbs +20 -0
  527. data/sig/telnyx/models/ai/assistant_chat_params.rbs +8 -1
  528. data/sig/telnyx/models/ai/chat_completion_request.rbs +7 -0
  529. data/sig/telnyx/models/ai/openai_create_response_params.rbs +7 -0
  530. data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
  531. data/sig/telnyx/models/attachment_request.rbs +48 -0
  532. data/sig/telnyx/models/call_assistant_request.rbs +12 -3
  533. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  534. data/sig/telnyx/models/call_payment_completed_webhook_event.rbs +337 -0
  535. data/sig/telnyx/models/call_payment_progress_webhook_event.rbs +349 -0
  536. data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +8 -1
  537. data/sig/telnyx/models/calls/action_pay_params.rbs +261 -0
  538. data/sig/telnyx/models/calls/action_pay_response.rbs +20 -0
  539. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -32
  540. data/sig/telnyx/models/calls/action_transfer_params.rbs +7 -0
  541. data/sig/telnyx/models/calls/pay_prompt_value.rbs +99 -0
  542. data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
  543. data/sig/telnyx/models/calls/transcription_start_request.rbs +158 -0
  544. data/sig/telnyx/models/custom_storage_configuration.rbs +45 -1
  545. data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs +13 -3
  546. data/sig/telnyx/models/dns_record.rbs +98 -0
  547. data/sig/telnyx/models/domains_tracking_settings.rbs +32 -0
  548. data/sig/telnyx/models/email_address_input.rbs +11 -0
  549. data/sig/telnyx/models/email_block.rbs +142 -0
  550. data/sig/telnyx/models/email_block_create_params.rbs +36 -0
  551. data/sig/telnyx/models/email_block_delete_params.rbs +20 -0
  552. data/sig/telnyx/models/email_block_list_params.rbs +114 -0
  553. data/sig/telnyx/models/email_block_response.rbs +13 -0
  554. data/sig/telnyx/models/email_block_retrieve_events_params.rbs +36 -0
  555. data/sig/telnyx/models/email_block_retrieve_events_response.rbs +100 -0
  556. data/sig/telnyx/models/email_block_retrieve_export_params.rbs +100 -0
  557. data/sig/telnyx/models/email_block_retrieve_export_response.rbs +5 -0
  558. data/sig/telnyx/models/email_block_retrieve_params.rbs +20 -0
  559. data/sig/telnyx/models/email_blocks/email_block_import_response.rbs +165 -0
  560. data/sig/telnyx/models/email_blocks/import_create_params.rbs +32 -0
  561. data/sig/telnyx/models/email_blocks/import_retrieve_params.rbs +22 -0
  562. data/sig/telnyx/models/email_dmarc_policy.rbs +65 -0
  563. data/sig/telnyx/models/email_domain.rbs +216 -0
  564. data/sig/telnyx/models/email_domain_create_params.rbs +47 -0
  565. data/sig/telnyx/models/email_domain_delete_params.rbs +29 -0
  566. data/sig/telnyx/models/email_domain_list_params.rbs +117 -0
  567. data/sig/telnyx/models/email_domain_response.rbs +13 -0
  568. data/sig/telnyx/models/email_domain_retrieve_dns_records_params.rbs +23 -0
  569. data/sig/telnyx/models/email_domain_retrieve_dns_records_response.rbs +14 -0
  570. data/sig/telnyx/models/email_domain_retrieve_health_params.rbs +20 -0
  571. data/sig/telnyx/models/email_domain_retrieve_health_response.rbs +91 -0
  572. data/sig/telnyx/models/email_domain_retrieve_params.rbs +20 -0
  573. data/sig/telnyx/models/email_domain_status.rbs +19 -0
  574. data/sig/telnyx/models/email_domain_type.rbs +15 -0
  575. data/sig/telnyx/models/email_domain_update_params.rbs +47 -0
  576. data/sig/telnyx/models/email_domain_verification.rbs +102 -0
  577. data/sig/telnyx/models/email_domain_verify_params.rbs +23 -0
  578. data/sig/telnyx/models/email_domains/email_webhook.rbs +62 -0
  579. data/sig/telnyx/models/email_domains/email_webhook_event.rbs +52 -0
  580. data/sig/telnyx/models/email_domains/email_webhook_response.rbs +15 -0
  581. data/sig/telnyx/models/email_domains/offset_pagination_meta.rbs +37 -0
  582. data/sig/telnyx/models/email_domains/webhook_create_params.rbs +38 -0
  583. data/sig/telnyx/models/email_domains/webhook_delete_params.rbs +30 -0
  584. data/sig/telnyx/models/email_domains/webhook_list_params.rbs +62 -0
  585. data/sig/telnyx/models/email_domains/webhook_retrieve_params.rbs +30 -0
  586. data/sig/telnyx/models/email_domains/webhook_update_params.rbs +49 -0
  587. data/sig/telnyx/models/email_event_list_params.rbs +75 -0
  588. data/sig/telnyx/models/email_event_list_response.rbs +149 -0
  589. data/sig/telnyx/models/email_event_retrieve_stats_params.rbs +31 -0
  590. data/sig/telnyx/models/email_event_retrieve_stats_response.rbs +164 -0
  591. data/sig/telnyx/models/email_event_type.rbs +44 -0
  592. data/sig/telnyx/models/email_inbox.rbs +81 -0
  593. data/sig/telnyx/models/email_inbox_create_params.rbs +32 -0
  594. data/sig/telnyx/models/email_inbox_delete_params.rbs +20 -0
  595. data/sig/telnyx/models/email_inbox_list_params.rbs +32 -0
  596. data/sig/telnyx/models/email_inbox_list_response.rbs +39 -0
  597. data/sig/telnyx/models/email_inbox_response.rbs +13 -0
  598. data/sig/telnyx/models/email_inbox_retrieve_params.rbs +20 -0
  599. data/sig/telnyx/models/email_inboxes/draft_create_params.rbs +27 -0
  600. data/sig/telnyx/models/email_inboxes/draft_delete_params.rbs +30 -0
  601. data/sig/telnyx/models/email_inboxes/draft_list_params.rbs +63 -0
  602. data/sig/telnyx/models/email_inboxes/draft_list_response.rbs +27 -0
  603. data/sig/telnyx/models/email_inboxes/draft_patch_params.rbs +34 -0
  604. data/sig/telnyx/models/email_inboxes/draft_retrieve_params.rbs +30 -0
  605. data/sig/telnyx/models/email_inboxes/draft_send_params.rbs +30 -0
  606. data/sig/telnyx/models/email_inboxes/draft_update_params.rbs +34 -0
  607. data/sig/telnyx/models/email_inboxes/email_address.rbs +19 -0
  608. data/sig/telnyx/models/email_inboxes/email_draft.rbs +185 -0
  609. data/sig/telnyx/models/email_inboxes/email_draft_request.rbs +135 -0
  610. data/sig/telnyx/models/email_inboxes/email_draft_response.rbs +15 -0
  611. data/sig/telnyx/models/email_inboxes/email_message.rbs +213 -0
  612. data/sig/telnyx/models/email_inboxes/email_message_response.rbs +58 -0
  613. data/sig/telnyx/models/email_inboxes/email_pagination_meta.rbs +19 -0
  614. data/sig/telnyx/models/email_inboxes/filter_add_params.rbs +27 -0
  615. data/sig/telnyx/models/email_inboxes/filter_add_response.rbs +57 -0
  616. data/sig/telnyx/models/email_inboxes/filter_delete_all_params.rbs +27 -0
  617. data/sig/telnyx/models/email_inboxes/filter_delete_all_response.rbs +57 -0
  618. data/sig/telnyx/models/email_inboxes/filter_list_params.rbs +25 -0
  619. data/sig/telnyx/models/email_inboxes/filter_list_response.rbs +57 -0
  620. data/sig/telnyx/models/email_inboxes/filter_replace_params.rbs +42 -0
  621. data/sig/telnyx/models/email_inboxes/filter_replace_response.rbs +57 -0
  622. data/sig/telnyx/models/email_inboxes/inbound_email_address.rbs +19 -0
  623. data/sig/telnyx/models/email_inboxes/inbound_thread.rbs +87 -0
  624. data/sig/telnyx/models/email_inboxes/inbound_thread_detail.rbs +24 -0
  625. data/sig/telnyx/models/email_inboxes/inbound_thread_list_response.rbs +27 -0
  626. data/sig/telnyx/models/email_inboxes/message_drafts_params.rbs +34 -0
  627. data/sig/telnyx/models/email_inboxes/message_list_params.rbs +98 -0
  628. data/sig/telnyx/models/email_inboxes/message_list_response.rbs +27 -0
  629. data/sig/telnyx/models/email_inboxes/message_update_params.rbs +48 -0
  630. data/sig/telnyx/models/email_inboxes/message_update_response.rbs +15 -0
  631. data/sig/telnyx/models/email_inboxes/messages/action_forward_params.rbs +99 -0
  632. data/sig/telnyx/models/email_inboxes/messages/action_reply_all_params.rbs +36 -0
  633. data/sig/telnyx/models/email_inboxes/messages/action_reply_params.rbs +36 -0
  634. data/sig/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rbs +31 -0
  635. data/sig/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rbs +34 -0
  636. data/sig/telnyx/models/email_inboxes/messages/label_create_params.rbs +36 -0
  637. data/sig/telnyx/models/email_inboxes/messages/label_create_response.rbs +17 -0
  638. data/sig/telnyx/models/email_inboxes/messages/label_delete_all_params.rbs +36 -0
  639. data/sig/telnyx/models/email_inboxes/messages/label_delete_all_response.rbs +17 -0
  640. data/sig/telnyx/models/email_inboxes/messages/label_mutation_request.rbs +17 -0
  641. data/sig/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rbs +23 -0
  642. data/sig/telnyx/models/email_inboxes/mutate_inbox_filters_request.rbs +38 -0
  643. data/sig/telnyx/models/email_inboxes/thread_list_params.rbs +49 -0
  644. data/sig/telnyx/models/email_inboxes/thread_message.rbs +178 -0
  645. data/sig/telnyx/models/email_inboxes/thread_retrieve_params.rbs +47 -0
  646. data/sig/telnyx/models/email_inboxes/thread_retrieve_response.rbs +27 -0
  647. data/sig/telnyx/models/email_inboxes/threads/label_create_params.rbs +36 -0
  648. data/sig/telnyx/models/email_inboxes/threads/label_create_response.rbs +68 -0
  649. data/sig/telnyx/models/email_inboxes/threads/label_delete_all_params.rbs +36 -0
  650. data/sig/telnyx/models/email_inboxes/threads/label_delete_all_response.rbs +68 -0
  651. data/sig/telnyx/models/email_message_batch_params.rbs +208 -0
  652. data/sig/telnyx/models/email_message_batch_response.rbs +98 -0
  653. data/sig/telnyx/models/email_message_create_params.rbs +199 -0
  654. data/sig/telnyx/models/email_message_delete_all_params.rbs +23 -0
  655. data/sig/telnyx/models/email_message_delete_params.rbs +20 -0
  656. data/sig/telnyx/models/email_message_delete_schedule_params.rbs +23 -0
  657. data/sig/telnyx/models/email_message_list_params.rbs +32 -0
  658. data/sig/telnyx/models/email_message_list_response.rbs +25 -0
  659. data/sig/telnyx/models/email_message_retrieve_events_params.rbs +36 -0
  660. data/sig/telnyx/models/email_message_retrieve_events_response.rbs +25 -0
  661. data/sig/telnyx/models/email_message_retrieve_params.rbs +20 -0
  662. data/sig/telnyx/models/email_message_retrieve_response.rbs +34 -0
  663. data/sig/telnyx/models/email_messages/email_recipient.rbs +126 -0
  664. data/sig/telnyx/models/email_messages/recipient_list_params.rbs +99 -0
  665. data/sig/telnyx/models/email_messages/recipient_list_response.rbs +39 -0
  666. data/sig/telnyx/models/email_messages/recipient_retrieve_params.rbs +30 -0
  667. data/sig/telnyx/models/email_messages/recipient_retrieve_response.rbs +16 -0
  668. data/sig/telnyx/models/email_template.rbs +70 -0
  669. data/sig/telnyx/models/email_template_create_params.rbs +55 -0
  670. data/sig/telnyx/models/email_template_delete_params.rbs +20 -0
  671. data/sig/telnyx/models/email_template_list_params.rbs +32 -0
  672. data/sig/telnyx/models/email_template_list_response.rbs +25 -0
  673. data/sig/telnyx/models/email_template_render_params.rbs +30 -0
  674. data/sig/telnyx/models/email_template_render_response.rbs +26 -0
  675. data/sig/telnyx/models/email_template_replace_params.rbs +22 -0
  676. data/sig/telnyx/models/email_template_response.rbs +13 -0
  677. data/sig/telnyx/models/email_template_retrieve_params.rbs +20 -0
  678. data/sig/telnyx/models/email_template_update_params.rbs +22 -0
  679. data/sig/telnyx/models/email_thread_list_params.rbs +49 -0
  680. data/sig/telnyx/models/email_thread_retrieve_params.rbs +45 -0
  681. data/sig/telnyx/models/email_thread_retrieve_response.rbs +25 -0
  682. data/sig/telnyx/models/email_unsubscribe_group_create_params.rbs +28 -0
  683. data/sig/telnyx/models/email_unsubscribe_group_delete_params.rbs +46 -0
  684. data/sig/telnyx/models/email_unsubscribe_group_list_params.rbs +32 -0
  685. data/sig/telnyx/models/email_unsubscribe_group_retrieve_params.rbs +20 -0
  686. data/sig/telnyx/models/email_unsubscribe_group_update_params.rbs +34 -0
  687. data/sig/telnyx/models/email_unsubscribe_groups/suppression_create_params.rbs +29 -0
  688. data/sig/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rbs +30 -0
  689. data/sig/telnyx/models/email_unsubscribe_groups/suppression_list_params.rbs +38 -0
  690. data/sig/telnyx/models/email_validation_check.rbs +17 -0
  691. data/sig/telnyx/models/email_validation_create_params.rbs +30 -0
  692. data/sig/telnyx/models/email_validation_create_response.rbs +121 -0
  693. data/sig/telnyx/models/email_validations/batch_create_params.rbs +42 -0
  694. data/sig/telnyx/models/email_validations/batch_create_response.rbs +74 -0
  695. data/sig/telnyx/models/email_validations/batch_retrieve_params.rbs +22 -0
  696. data/sig/telnyx/models/email_validations/batch_retrieve_response.rbs +173 -0
  697. data/sig/telnyx/models/email_validations/email_validation_batch_status.rbs +21 -0
  698. data/sig/telnyx/models/fax.rbs +10 -0
  699. data/sig/telnyx/models/fax_failed.rbs +12 -17
  700. data/sig/telnyx/models/group_list_meta.rbs +35 -0
  701. data/sig/telnyx/models/inbound_message.rbs +13 -205
  702. data/sig/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_params.rbs +20 -3
  703. data/sig/telnyx/models/message_event.rbs +32 -0
  704. data/sig/telnyx/models/messaging_10dlc/phone_number_campaign.rbs +17 -3
  705. data/sig/telnyx/models/model_metadata.rbs +21 -0
  706. data/sig/telnyx/models/offset_meta.rbs +35 -0
  707. data/sig/telnyx/models/phone_numbers/action_change_bundle_status_params.rbs +4 -4
  708. data/sig/telnyx/models/pricing/pricing_pagination_meta.rbs +39 -0
  709. data/sig/telnyx/models/pricing/pricing_tier.rbs +42 -0
  710. data/sig/telnyx/models/pricing/product_list_params.rbs +34 -0
  711. data/sig/telnyx/models/pricing/product_list_response.rbs +24 -0
  712. data/sig/telnyx/models/pricing/product_retrieve_params.rbs +38 -0
  713. data/sig/telnyx/models/pricing/product_retrieve_response.rbs +164 -0
  714. data/sig/telnyx/models/s3_configuration_data.rbs +11 -19
  715. data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +4 -0
  716. data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +8 -0
  717. data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +56 -0
  718. data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +2 -0
  719. data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +2 -0
  720. data/sig/telnyx/models/time_range.rbs +15 -0
  721. data/sig/telnyx/models/tracking_settings.rbs +19 -0
  722. data/sig/telnyx/models/uac_external_settings.rbs +5 -0
  723. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
  724. data/sig/telnyx/models/unsubscribe_group.rbs +55 -0
  725. data/sig/telnyx/models/unsubscribe_group_response.rbs +13 -0
  726. data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
  727. data/sig/telnyx/models/update_email_template_request.rbs +44 -0
  728. data/sig/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rbs +4 -6
  729. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_params.rbs +27 -0
  730. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_list_response.rbs +86 -0
  731. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_params.rbs +62 -0
  732. data/sig/telnyx/models/whatsapp/phone_numbers/conversational_component_patch_all_response.rbs +86 -0
  733. data/sig/telnyx/models.rbs +156 -0
  734. data/sig/telnyx/resources/ai/assistants.rbs +1 -0
  735. data/sig/telnyx/resources/ai/openai/chat.rbs +1 -0
  736. data/sig/telnyx/resources/ai/openai.rbs +1 -0
  737. data/sig/telnyx/resources/calls/actions.rbs +25 -2
  738. data/sig/telnyx/resources/calls.rbs +1 -0
  739. data/sig/telnyx/resources/email_blocks/import.rbs +20 -0
  740. data/sig/telnyx/resources/email_blocks.rbs +58 -0
  741. data/sig/telnyx/resources/email_domains/webhooks.rbs +44 -0
  742. data/sig/telnyx/resources/email_domains.rbs +66 -0
  743. data/sig/telnyx/resources/email_events.rbs +23 -0
  744. data/sig/telnyx/resources/email_inboxes/drafts.rbs +100 -0
  745. data/sig/telnyx/resources/email_inboxes/filters.rbs +35 -0
  746. data/sig/telnyx/resources/email_inboxes/messages/actions.rbs +38 -0
  747. data/sig/telnyx/resources/email_inboxes/messages/labels.rbs +25 -0
  748. data/sig/telnyx/resources/email_inboxes/messages.rbs +57 -0
  749. data/sig/telnyx/resources/email_inboxes/threads/labels.rbs +25 -0
  750. data/sig/telnyx/resources/email_inboxes/threads.rbs +27 -0
  751. data/sig/telnyx/resources/email_inboxes.rbs +34 -0
  752. data/sig/telnyx/resources/email_messages/recipients.rbs +24 -0
  753. data/sig/telnyx/resources/email_messages.rbs +76 -0
  754. data/sig/telnyx/resources/email_templates.rbs +56 -0
  755. data/sig/telnyx/resources/email_threads.rbs +23 -0
  756. data/sig/telnyx/resources/email_unsubscribe_groups/suppressions.rbs +28 -0
  757. data/sig/telnyx/resources/email_unsubscribe_groups.rbs +39 -0
  758. data/sig/telnyx/resources/email_validations/batch.rbs +21 -0
  759. data/sig/telnyx/resources/email_validations.rbs +15 -0
  760. data/sig/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbs +3 -1
  761. data/sig/telnyx/resources/phone_numbers/actions.rbs +1 -1
  762. data/sig/telnyx/resources/pricing/products.rbs +22 -0
  763. data/sig/telnyx/resources/pricing.rbs +9 -0
  764. data/sig/telnyx/resources/text_to_speech.rbs +1 -0
  765. data/sig/telnyx/resources/webhooks.rbs +4 -0
  766. data/sig/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbs +23 -0
  767. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +2 -0
  768. metadata +602 -5
  769. data/lib/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rb +0 -29
  770. data/rbi/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rbi +0 -87
  771. data/sig/telnyx/models/legacy/reporting/usage_reports/number_lookup_list_response.rbs +0 -39
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class EmailInboxes
6
+ class Messages
7
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
8
+ # reply to or forward messages.
9
+ class Labels
10
+ # Some parameter documentations has been truncated, see
11
+ # {Telnyx::Models::EmailInboxes::Messages::LabelCreateParams} for more details.
12
+ #
13
+ # Adds one or more mutable labels to a message. Labels carry agent workflow state
14
+ # such as `spam`, `needs_review`, or `processed`.
15
+ #
16
+ # Labels are **not** the same as the send-time `tags` on outbound messages: `tags`
17
+ # are immutable and propagate to Email Detail Records and Mission Control for
18
+ # billing attribution, while labels are mailbox state that never reaches the
19
+ # reporting contract.
20
+ #
21
+ # The operation is an idempotent set union — adding a label the message already
22
+ # carries is a no-op and still returns 200. Labels are case-sensitive, and message
23
+ # labels are independent of thread labels.
24
+ #
25
+ # @overload create(message_id, inbox_id:, labels:, request_options: {})
26
+ #
27
+ # @param message_id [String] Path param: Inbound message UUID.
28
+ #
29
+ # @param inbox_id [String] Path param: Email inbox UUID.
30
+ #
31
+ # @param labels [Array<String>] Body param: One or more labels. Each label is a freeform, case-sensitive string
32
+ #
33
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
34
+ #
35
+ # @return [Telnyx::Models::EmailInboxes::Messages::LabelCreateResponse]
36
+ #
37
+ # @see Telnyx::Models::EmailInboxes::Messages::LabelCreateParams
38
+ def create(message_id, params)
39
+ parsed, options = Telnyx::EmailInboxes::Messages::LabelCreateParams.dump_request(params)
40
+ inbox_id =
41
+ parsed.delete(:inbox_id) do
42
+ raise ArgumentError.new("missing required path argument #{_1}")
43
+ end
44
+ @client.request(
45
+ method: :post,
46
+ path: ["email_inboxes/%1$s/messages/%2$s/labels", inbox_id, message_id],
47
+ body: parsed,
48
+ model: Telnyx::Models::EmailInboxes::Messages::LabelCreateResponse,
49
+ options: options
50
+ )
51
+ end
52
+
53
+ # Some parameter documentations has been truncated, see
54
+ # {Telnyx::Models::EmailInboxes::Messages::LabelDeleteAllParams} for more details.
55
+ #
56
+ # Removes one or more labels from a message. Idempotent — removing a label the
57
+ # message does not carry is a no-op and still returns 200. Removal is
58
+ # case-sensitive.
59
+ #
60
+ # @overload delete_all(message_id, inbox_id:, labels:, request_options: {})
61
+ #
62
+ # @param message_id [String] Path param: Inbound message UUID.
63
+ #
64
+ # @param inbox_id [String] Path param: Email inbox UUID.
65
+ #
66
+ # @param labels [Array<String>] Body param: One or more labels. Each label is a freeform, case-sensitive string
67
+ #
68
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
69
+ #
70
+ # @return [Telnyx::Models::EmailInboxes::Messages::LabelDeleteAllResponse]
71
+ #
72
+ # @see Telnyx::Models::EmailInboxes::Messages::LabelDeleteAllParams
73
+ def delete_all(message_id, params)
74
+ parsed, options = Telnyx::EmailInboxes::Messages::LabelDeleteAllParams.dump_request(params)
75
+ inbox_id =
76
+ parsed.delete(:inbox_id) do
77
+ raise ArgumentError.new("missing required path argument #{_1}")
78
+ end
79
+ @client.request(
80
+ method: :delete,
81
+ path: ["email_inboxes/%1$s/messages/%2$s/labels", inbox_id, message_id],
82
+ body: parsed,
83
+ model: Telnyx::Models::EmailInboxes::Messages::LabelDeleteAllResponse,
84
+ options: options
85
+ )
86
+ end
87
+
88
+ # @api private
89
+ #
90
+ # @param client [Telnyx::Client]
91
+ def initialize(client:)
92
+ @client = client
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,191 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class EmailInboxes
6
+ class Messages
7
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
8
+ # reply to or forward messages.
9
+ # @return [Telnyx::Resources::EmailInboxes::Messages::Actions]
10
+ attr_reader :actions
11
+
12
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
13
+ # reply to or forward messages.
14
+ # @return [Telnyx::Resources::EmailInboxes::Messages::Labels]
15
+ attr_reader :labels
16
+
17
+ # Some parameter documentations has been truncated, see
18
+ # {Telnyx::Models::EmailInboxes::MessageUpdateParams} for more details.
19
+ #
20
+ # Updates the explicit read state of an account-scoped inbound message. Set
21
+ # `read_at` to `true` to mark the message read at the server's current time, to an
22
+ # ISO 8601 timestamp to use that timestamp, or to `null` to mark the message
23
+ # unread. Repeating the same update is idempotent.
24
+ #
25
+ # @overload update(message_id, inbox_id:, read_at:, request_options: {})
26
+ #
27
+ # @param message_id [String] Path param: Inbound email message UUID.
28
+ #
29
+ # @param inbox_id [String] Path param: Email inbox UUID.
30
+ #
31
+ # @param read_at [Boolean, Time, Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt, nil] Body param: Set to `true` for server time, an ISO 8601 timestamp for an explicit
32
+ #
33
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
34
+ #
35
+ # @return [Telnyx::Models::EmailInboxes::MessageUpdateResponse]
36
+ #
37
+ # @see Telnyx::Models::EmailInboxes::MessageUpdateParams
38
+ def update(message_id, params)
39
+ parsed, options = Telnyx::EmailInboxes::MessageUpdateParams.dump_request(params)
40
+ inbox_id =
41
+ parsed.delete(:inbox_id) do
42
+ raise ArgumentError.new("missing required path argument #{_1}")
43
+ end
44
+ @client.request(
45
+ method: :patch,
46
+ path: ["email_inboxes/%1$s/messages/%2$s", inbox_id, message_id],
47
+ body: parsed,
48
+ model: Telnyx::Models::EmailInboxes::MessageUpdateResponse,
49
+ options: options
50
+ )
51
+ end
52
+
53
+ # Some parameter documentations has been truncated, see
54
+ # {Telnyx::Models::EmailInboxes::MessageListParams} for more details.
55
+ #
56
+ # Lists inbound messages newest first. All access is scoped to the authenticated
57
+ # account. `filter[search]` performs PostgreSQL full-text search over the subject,
58
+ # plain-text body, and HTML body. Filters compose with stable cursor pagination.
59
+ #
60
+ # @overload list(inbox_id, filter_from: nil, filter_label: nil, filter_read: nil, filter_received_after: nil, filter_received_before: nil, filter_search: nil, filter_subject: nil, filter_unread: nil, page_after: nil, page_size: nil, request_options: {})
61
+ #
62
+ # @param inbox_id [String] Email inbox UUID.
63
+ #
64
+ # @param filter_from [String] Case-insensitive literal substring of the sender address.
65
+ #
66
+ # @param filter_label [String] Returns only messages carrying this label. Matching is exact and case-sensitive.
67
+ #
68
+ # @param filter_read [Boolean] Whether the message has a read timestamp.
69
+ #
70
+ # @param filter_received_after [Time] Inclusive ISO 8601 lower bound for the received timestamp.
71
+ #
72
+ # @param filter_received_before [Time] Inclusive ISO 8601 upper bound for the received timestamp.
73
+ #
74
+ # @param filter_search [String] Full-text query over subject and body, up to 500 characters.
75
+ #
76
+ # @param filter_subject [String] Case-insensitive literal substring of the subject.
77
+ #
78
+ # @param filter_unread [Boolean] Whether the message has no read timestamp. Set to `true` to return only unread m
79
+ #
80
+ # @param page_after [String] Opaque cursor returned by the previous page.
81
+ #
82
+ # @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100.
83
+ #
84
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
85
+ #
86
+ # @return [Telnyx::Models::EmailInboxes::MessageListResponse]
87
+ #
88
+ # @see Telnyx::Models::EmailInboxes::MessageListParams
89
+ def list(inbox_id, params = {})
90
+ parsed, options = Telnyx::EmailInboxes::MessageListParams.dump_request(params)
91
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
92
+ @client.request(
93
+ method: :get,
94
+ path: ["email_inboxes/%1$s/messages", inbox_id],
95
+ query: query.transform_keys(
96
+ filter_from: "filter[from]",
97
+ filter_label: "filter[label]",
98
+ filter_read: "filter[read]",
99
+ filter_received_after: "filter[received_after]",
100
+ filter_received_before: "filter[received_before]",
101
+ filter_search: "filter[search]",
102
+ filter_subject: "filter[subject]",
103
+ filter_unread: "filter[unread]",
104
+ page_after: "page[after]",
105
+ page_size: "page[size]"
106
+ ),
107
+ model: Telnyx::Models::EmailInboxes::MessageListResponse,
108
+ options: options
109
+ )
110
+ end
111
+
112
+ # Creates an unsent reply draft for an inbound message. Unlike the
113
+ # `/actions/reply` endpoint, which sends immediately, this stores a draft that can
114
+ # be reviewed and edited before sending.
115
+ #
116
+ # `reply_to_message_id` and `thread_id` are inherited from the parent message and
117
+ # cannot be set by the caller. The recipient, `Re:` subject and
118
+ # `In-Reply-To`/`References` headers are pre-filled from the parent using the same
119
+ # rules as a live reply, so sending the draft threads identically. Supplying `to`
120
+ # or `subject` explicitly overrides the pre-filled value.
121
+ #
122
+ # @overload drafts(message_id, inbox_id:, attachments: nil, bcc: nil, cc: nil, from_email: nil, from_name: nil, headers: nil, html: nil, html_body: nil, labels: nil, metadata: nil, reply_to: nil, subject: nil, tags: nil, text: nil, text_body: nil, to: nil, request_options: {})
123
+ #
124
+ # @param message_id [String] Path param: Inbound message UUID to reply to.
125
+ #
126
+ # @param inbox_id [String] Path param: Email inbox UUID.
127
+ #
128
+ # @param attachments [Array<Object>] Body param
129
+ #
130
+ # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
131
+ #
132
+ # @param cc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
133
+ #
134
+ # @param from_email [String] Body param
135
+ #
136
+ # @param from_name [String] Body param
137
+ #
138
+ # @param headers [Hash{Symbol=>String}] Body param
139
+ #
140
+ # @param html [String] Body param: Alias for `html_body`, matching the send endpoint.
141
+ #
142
+ # @param html_body [String] Body param
143
+ #
144
+ # @param labels [Array<String>] Body param
145
+ #
146
+ # @param metadata [Object] Body param
147
+ #
148
+ # @param reply_to [String] Body param
149
+ #
150
+ # @param subject [String] Body param
151
+ #
152
+ # @param tags [Array<String>] Body param
153
+ #
154
+ # @param text [String] Body param: Alias for `text_body`, matching the send endpoint.
155
+ #
156
+ # @param text_body [String] Body param
157
+ #
158
+ # @param to [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
159
+ #
160
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
161
+ #
162
+ # @return [Telnyx::Models::EmailInboxes::EmailDraftResponse]
163
+ #
164
+ # @see Telnyx::Models::EmailInboxes::MessageDraftsParams
165
+ def drafts(message_id, params)
166
+ parsed, options = Telnyx::EmailInboxes::MessageDraftsParams.dump_request(params)
167
+ inbox_id =
168
+ parsed.delete(:inbox_id) do
169
+ raise ArgumentError.new("missing required path argument #{_1}")
170
+ end
171
+ @client.request(
172
+ method: :post,
173
+ path: ["email_inboxes/%1$s/messages/%2$s/drafts", inbox_id, message_id],
174
+ body: parsed,
175
+ model: Telnyx::EmailInboxes::EmailDraftResponse,
176
+ options: options
177
+ )
178
+ end
179
+
180
+ # @api private
181
+ #
182
+ # @param client [Telnyx::Client]
183
+ def initialize(client:)
184
+ @client = client
185
+ @actions = Telnyx::Resources::EmailInboxes::Messages::Actions.new(client: client)
186
+ @labels = Telnyx::Resources::EmailInboxes::Messages::Labels.new(client: client)
187
+ end
188
+ end
189
+ end
190
+ end
191
+ end
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class EmailInboxes
6
+ class Threads
7
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
8
+ # reply to or forward messages.
9
+ class Labels
10
+ # Some parameter documentations has been truncated, see
11
+ # {Telnyx::Models::EmailInboxes::Threads::LabelCreateParams} for more details.
12
+ #
13
+ # Adds one or more mutable labels to a thread, letting an agent mark a whole
14
+ # conversation (for example `needs_review`) without labelling each message
15
+ # individually.
16
+ #
17
+ # Thread labels are independent of message labels: labelling a thread does not
18
+ # label its messages, and labelling a message does not label its thread.
19
+ # Idempotent and case-sensitive.
20
+ #
21
+ # @overload create(thread_id, inbox_id:, labels:, request_options: {})
22
+ #
23
+ # @param thread_id [String] Path param: Thread UUID.
24
+ #
25
+ # @param inbox_id [String] Path param: Email inbox UUID.
26
+ #
27
+ # @param labels [Array<String>] Body param: One or more labels. Each label is a freeform, case-sensitive string
28
+ #
29
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
30
+ #
31
+ # @return [Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse]
32
+ #
33
+ # @see Telnyx::Models::EmailInboxes::Threads::LabelCreateParams
34
+ def create(thread_id, params)
35
+ parsed, options = Telnyx::EmailInboxes::Threads::LabelCreateParams.dump_request(params)
36
+ inbox_id =
37
+ parsed.delete(:inbox_id) do
38
+ raise ArgumentError.new("missing required path argument #{_1}")
39
+ end
40
+ @client.request(
41
+ method: :post,
42
+ path: ["email_inboxes/%1$s/threads/%2$s/labels", inbox_id, thread_id],
43
+ body: parsed,
44
+ model: Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse,
45
+ options: options
46
+ )
47
+ end
48
+
49
+ # Some parameter documentations has been truncated, see
50
+ # {Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllParams} for more details.
51
+ #
52
+ # Removes one or more labels from a thread. Idempotent — removing a label the
53
+ # thread does not carry is a no-op and still returns 200.
54
+ #
55
+ # @overload delete_all(thread_id, inbox_id:, labels:, request_options: {})
56
+ #
57
+ # @param thread_id [String] Path param: Thread UUID.
58
+ #
59
+ # @param inbox_id [String] Path param: Email inbox UUID.
60
+ #
61
+ # @param labels [Array<String>] Body param: One or more labels. Each label is a freeform, case-sensitive string
62
+ #
63
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
64
+ #
65
+ # @return [Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse]
66
+ #
67
+ # @see Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllParams
68
+ def delete_all(thread_id, params)
69
+ parsed, options = Telnyx::EmailInboxes::Threads::LabelDeleteAllParams.dump_request(params)
70
+ inbox_id =
71
+ parsed.delete(:inbox_id) do
72
+ raise ArgumentError.new("missing required path argument #{_1}")
73
+ end
74
+ @client.request(
75
+ method: :delete,
76
+ path: ["email_inboxes/%1$s/threads/%2$s/labels", inbox_id, thread_id],
77
+ body: parsed,
78
+ model: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse,
79
+ options: options
80
+ )
81
+ end
82
+
83
+ # @api private
84
+ #
85
+ # @param client [Telnyx::Client]
86
+ def initialize(client:)
87
+ @client = client
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,97 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class EmailInboxes
6
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
7
+ # reply to or forward messages.
8
+ class Threads
9
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
10
+ # reply to or forward messages.
11
+ # @return [Telnyx::Resources::EmailInboxes::Threads::Labels]
12
+ attr_reader :labels
13
+
14
+ # Some parameter documentations has been truncated, see
15
+ # {Telnyx::Models::EmailInboxes::ThreadRetrieveParams} for more details.
16
+ #
17
+ # Returns a bounded page of inbound and outbound thread messages interleaved in
18
+ # chronological order using stable cursor pagination.
19
+ #
20
+ # @overload retrieve(thread_id, inbox_id:, page_after: nil, page_size: nil, request_options: {})
21
+ #
22
+ # @param thread_id [String] Path param: Email thread UUID.
23
+ #
24
+ # @param inbox_id [String] Path param: Email inbox UUID.
25
+ #
26
+ # @param page_after [String] Query param: Opaque message cursor returned by the previous thread-detail page.
27
+ #
28
+ # @param page_size [Integer] Query param: Number of thread messages to return. Defaults to 25; maximum is 100
29
+ #
30
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
31
+ #
32
+ # @return [Telnyx::Models::EmailInboxes::ThreadRetrieveResponse]
33
+ #
34
+ # @see Telnyx::Models::EmailInboxes::ThreadRetrieveParams
35
+ def retrieve(thread_id, params)
36
+ parsed, options = Telnyx::EmailInboxes::ThreadRetrieveParams.dump_request(params)
37
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
38
+ inbox_id =
39
+ parsed.delete(:inbox_id) do
40
+ raise ArgumentError.new("missing required path argument #{_1}")
41
+ end
42
+ @client.request(
43
+ method: :get,
44
+ path: ["email_inboxes/%1$s/threads/%2$s", inbox_id, thread_id],
45
+ query: query.transform_keys(page_after: "page[after]", page_size: "page[size]"),
46
+ model: Telnyx::Models::EmailInboxes::ThreadRetrieveResponse,
47
+ options: options
48
+ )
49
+ end
50
+
51
+ # Some parameter documentations has been truncated, see
52
+ # {Telnyx::Models::EmailInboxes::ThreadListParams} for more details.
53
+ #
54
+ # Lists thread summaries newest first using stable cursor pagination.
55
+ #
56
+ # @overload list(inbox_id, filter_label: nil, page_after: nil, page_size: nil, request_options: {})
57
+ #
58
+ # @param inbox_id [String] Email inbox UUID.
59
+ #
60
+ # @param filter_label [String] Returns only threads carrying this label. Thread labels are independent of the l
61
+ #
62
+ # @param page_after [String] Opaque cursor returned by the previous page.
63
+ #
64
+ # @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100.
65
+ #
66
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
67
+ #
68
+ # @return [Telnyx::Models::EmailInboxes::InboundThreadListResponse]
69
+ #
70
+ # @see Telnyx::Models::EmailInboxes::ThreadListParams
71
+ def list(inbox_id, params = {})
72
+ parsed, options = Telnyx::EmailInboxes::ThreadListParams.dump_request(params)
73
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
74
+ @client.request(
75
+ method: :get,
76
+ path: ["email_inboxes/%1$s/threads", inbox_id],
77
+ query: query.transform_keys(
78
+ filter_label: "filter[label]",
79
+ page_after: "page[after]",
80
+ page_size: "page[size]"
81
+ ),
82
+ model: Telnyx::EmailInboxes::InboundThreadListResponse,
83
+ options: options
84
+ )
85
+ end
86
+
87
+ # @api private
88
+ #
89
+ # @param client [Telnyx::Client]
90
+ def initialize(client:)
91
+ @client = client
92
+ @labels = Telnyx::Resources::EmailInboxes::Threads::Labels.new(client: client)
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,136 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
6
+ # reply to or forward messages.
7
+ class EmailInboxes
8
+ # Create, list, retrieve, update, delete, and send unsent draft messages belonging
9
+ # to an agent inbox.
10
+ # @return [Telnyx::Resources::EmailInboxes::Drafts]
11
+ attr_reader :drafts
12
+
13
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
14
+ # reply to or forward messages.
15
+ # @return [Telnyx::Resources::EmailInboxes::Filters]
16
+ attr_reader :filters
17
+
18
+ # @return [Telnyx::Resources::EmailInboxes::Messages]
19
+ attr_reader :messages
20
+
21
+ # Create and manage agent inboxes, retrieve inbound messages and threads, and
22
+ # reply to or forward messages.
23
+ # @return [Telnyx::Resources::EmailInboxes::Threads]
24
+ attr_reader :threads
25
+
26
+ # Some parameter documentations has been truncated, see
27
+ # {Telnyx::Models::EmailInboxCreateParams} for more details.
28
+ #
29
+ # Creates an inbox on an inbound-enabled domain. When `domain_id` is omitted,
30
+ # Telnyx allocates the account's shared inbound subdomain so the inbox is
31
+ # immediately usable without customer DNS setup. When `username` is omitted, a
32
+ # unique username is generated.
33
+ #
34
+ # @overload create(domain_id: nil, username: nil, request_options: {})
35
+ #
36
+ # @param domain_id [String] Account-owned, inbound-enabled domain UUID. The account's shared inbound subdoma
37
+ #
38
+ # @param username [String] Inbox local part. Trimmed and lowercased before validation; the normalized value
39
+ #
40
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
41
+ #
42
+ # @return [Telnyx::Models::EmailInboxResponse]
43
+ #
44
+ # @see Telnyx::Models::EmailInboxCreateParams
45
+ def create(params = {})
46
+ parsed, options = Telnyx::EmailInboxCreateParams.dump_request(params)
47
+ @client.request(
48
+ method: :post,
49
+ path: "email_inboxes",
50
+ body: parsed,
51
+ model: Telnyx::EmailInboxResponse,
52
+ options: options
53
+ )
54
+ end
55
+
56
+ # Returns an account-scoped, non-deleted inbox. Missing and foreign inboxes are
57
+ # indistinguishable.
58
+ #
59
+ # @overload retrieve(id, request_options: {})
60
+ #
61
+ # @param id [String] Email inbox UUID.
62
+ #
63
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
64
+ #
65
+ # @return [Telnyx::Models::EmailInboxResponse]
66
+ #
67
+ # @see Telnyx::Models::EmailInboxRetrieveParams
68
+ def retrieve(id, params = {})
69
+ @client.request(
70
+ method: :get,
71
+ path: ["email_inboxes/%1$s", id],
72
+ model: Telnyx::EmailInboxResponse,
73
+ options: params[:request_options]
74
+ )
75
+ end
76
+
77
+ # Lists the account's non-deleted inboxes newest first using stable cursor
78
+ # pagination.
79
+ #
80
+ # @overload list(page_cursor: nil, page_size: nil, request_options: {})
81
+ #
82
+ # @param page_cursor [String] Opaque cursor returned by the previous inbox page.
83
+ #
84
+ # @param page_size [Integer] Number of results to return. Defaults to 20; maximum is 250.
85
+ #
86
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
87
+ #
88
+ # @return [Telnyx::Models::EmailInboxListResponse]
89
+ #
90
+ # @see Telnyx::Models::EmailInboxListParams
91
+ def list(params = {})
92
+ parsed, options = Telnyx::EmailInboxListParams.dump_request(params)
93
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
94
+ @client.request(
95
+ method: :get,
96
+ path: "email_inboxes",
97
+ query: query,
98
+ model: Telnyx::Models::EmailInboxListResponse,
99
+ options: options
100
+ )
101
+ end
102
+
103
+ # Soft-deletes an account-scoped inbox. Its address remains reserved and the inbox
104
+ # is no longer returned by list or get operations.
105
+ #
106
+ # @overload delete(id, request_options: {})
107
+ #
108
+ # @param id [String] Email inbox UUID.
109
+ #
110
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
111
+ #
112
+ # @return [nil]
113
+ #
114
+ # @see Telnyx::Models::EmailInboxDeleteParams
115
+ def delete(id, params = {})
116
+ @client.request(
117
+ method: :delete,
118
+ path: ["email_inboxes/%1$s", id],
119
+ model: NilClass,
120
+ options: params[:request_options]
121
+ )
122
+ end
123
+
124
+ # @api private
125
+ #
126
+ # @param client [Telnyx::Client]
127
+ def initialize(client:)
128
+ @client = client
129
+ @drafts = Telnyx::Resources::EmailInboxes::Drafts.new(client: client)
130
+ @filters = Telnyx::Resources::EmailInboxes::Filters.new(client: client)
131
+ @messages = Telnyx::Resources::EmailInboxes::Messages.new(client: client)
132
+ @threads = Telnyx::Resources::EmailInboxes::Threads.new(client: client)
133
+ end
134
+ end
135
+ end
136
+ end