mailslurp_client 15.19.22 → 15.21.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 (401) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/lib/mailslurp_client/api/alias_controller_api.rb +10 -10
  5. data/lib/mailslurp_client/api/attachment_controller_api.rb +28 -6
  6. data/lib/mailslurp_client/api/bounce_controller_api.rb +80 -1
  7. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
  8. data/lib/mailslurp_client/api/common_actions_controller_api.rb +5 -5
  9. data/lib/mailslurp_client/api/connector_controller_api.rb +1250 -122
  10. data/lib/mailslurp_client/api/consent_controller_api.rb +269 -0
  11. data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
  12. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  13. data/lib/mailslurp_client/api/email_controller_api.rb +471 -12
  14. data/lib/mailslurp_client/api/email_verification_controller_api.rb +9 -1
  15. data/lib/mailslurp_client/api/expired_controller_api.rb +4 -1
  16. data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
  17. data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
  18. data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
  19. data/lib/mailslurp_client/api/guest_portal_controller_api.rb +569 -0
  20. data/lib/mailslurp_client/api/imap_controller_api.rb +1 -1
  21. data/lib/mailslurp_client/api/inbox_controller_api.rb +929 -115
  22. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +13 -11
  23. data/lib/mailslurp_client/api/inbox_replier_controller_api.rb +82 -1
  24. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +1 -1
  25. data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
  26. data/lib/mailslurp_client/api/missed_email_controller_api.rb +1 -1
  27. data/lib/mailslurp_client/api/o_auth_connection_api.rb +170 -0
  28. data/lib/mailslurp_client/api/phone_controller_api.rb +962 -20
  29. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
  30. data/lib/mailslurp_client/api/sms_controller_api.rb +494 -44
  31. data/lib/mailslurp_client/api/sse_controller_api.rb +81 -0
  32. data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
  33. data/lib/mailslurp_client/api/tools_controller_api.rb +192 -1
  34. data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
  35. data/lib/mailslurp_client/api/user_controller_api.rb +268 -1
  36. data/lib/mailslurp_client/api/wait_for_controller_api.rb +1 -1
  37. data/lib/mailslurp_client/api/webhook_controller_api.rb +274 -12
  38. data/lib/mailslurp_client/api_client.rb +1 -1
  39. data/lib/mailslurp_client/api_error.rb +1 -1
  40. data/lib/mailslurp_client/configuration.rb +1 -1
  41. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
  42. data/lib/mailslurp_client/models/account_bounce_block_dto.rb +16 -2
  43. data/lib/mailslurp_client/models/alias_dto.rb +1 -1
  44. data/lib/mailslurp_client/models/alias_projection.rb +38 -38
  45. data/lib/mailslurp_client/models/{thread_projection.rb → alias_thread_projection.rb} +52 -52
  46. data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_entity_dto.rb} +26 -14
  47. data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
  48. data/lib/mailslurp_client/models/attachment_projection.rb +45 -20
  49. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  50. data/lib/mailslurp_client/models/bounce_projection.rb +16 -16
  51. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +11 -11
  52. data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
  53. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
  54. data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
  55. data/lib/mailslurp_client/models/can_send_email_results.rb +1 -1
  56. data/lib/mailslurp_client/models/check_email_body_feature_support_results.rb +1 -1
  57. data/lib/mailslurp_client/models/check_email_body_results.rb +1 -1
  58. data/lib/mailslurp_client/models/check_email_client_support_options.rb +1 -1
  59. data/lib/mailslurp_client/models/check_email_client_support_results.rb +1 -1
  60. data/lib/mailslurp_client/models/check_email_features_client_support_options.rb +1 -1
  61. data/lib/mailslurp_client/models/check_email_features_client_support_results.rb +1 -1
  62. data/lib/mailslurp_client/models/complaint.rb +1 -1
  63. data/lib/mailslurp_client/models/condition_option.rb +1 -1
  64. data/lib/mailslurp_client/models/connector_dto.rb +12 -98
  65. data/lib/mailslurp_client/models/connector_event_dto.rb +354 -0
  66. data/lib/mailslurp_client/models/{connector_sync_event_projection.rb → connector_event_projection.rb} +72 -37
  67. data/lib/mailslurp_client/models/connector_imap_connection_dto.rb +83 -2
  68. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause.rb → connector_imap_connection_test_result.rb} +33 -19
  69. data/lib/mailslurp_client/models/connector_projection.rb +29 -90
  70. data/lib/mailslurp_client/models/connector_provider_settings_dto.rb +225 -0
  71. data/lib/mailslurp_client/models/connector_smtp_connection_dto.rb +96 -2
  72. data/lib/mailslurp_client/models/{connector_sync_request_result_exception.rb → connector_smtp_connection_test_result.rb} +29 -35
  73. data/lib/mailslurp_client/models/connector_sync_request_result.rb +2 -2
  74. data/lib/mailslurp_client/models/connector_sync_result.rb +20 -9
  75. data/lib/mailslurp_client/models/{connector_sync_event_dto.rb → connector_sync_settings_dto.rb} +50 -53
  76. data/lib/mailslurp_client/models/consent_status_dto.rb +211 -0
  77. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  78. data/lib/mailslurp_client/models/contact_projection.rb +11 -11
  79. data/lib/mailslurp_client/models/content_match_options.rb +1 -1
  80. data/lib/mailslurp_client/models/count_dto.rb +1 -1
  81. data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
  82. data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb +93 -7
  83. data/lib/mailslurp_client/models/create_connector_options.rb +2 -69
  84. data/lib/mailslurp_client/models/create_connector_smtp_connection_options.rb +94 -5
  85. data/lib/mailslurp_client/models/create_connector_sync_settings_options.rb +265 -0
  86. data/lib/mailslurp_client/models/create_connector_with_options.rb +239 -0
  87. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  88. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  89. data/lib/mailslurp_client/models/create_emergency_address_options.rb +3 -3
  90. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  91. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  92. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
  93. data/lib/mailslurp_client/models/create_inbox_replier_options.rb +2 -6
  94. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
  95. data/lib/mailslurp_client/models/create_o_auth_connection_result.rb +211 -0
  96. data/lib/mailslurp_client/models/create_o_auth_exchange_result.rb +229 -0
  97. data/lib/mailslurp_client/models/create_phone_number_options.rb +284 -0
  98. data/lib/mailslurp_client/models/create_portal_options.rb +233 -0
  99. data/lib/mailslurp_client/models/create_portal_user_options.rb +251 -0
  100. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  101. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
  102. data/lib/mailslurp_client/models/create_webhook_options.rb +21 -8
  103. data/lib/mailslurp_client/models/delivery_status_dto.rb +1 -1
  104. data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
  105. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
  106. data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
  107. data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
  108. data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
  109. data/lib/mailslurp_client/models/dns_lookups_options.rb +1 -1
  110. data/lib/mailslurp_client/models/domain_dto.rb +28 -2
  111. data/lib/mailslurp_client/models/domain_group.rb +1 -1
  112. data/lib/mailslurp_client/models/domain_groups_dto.rb +1 -1
  113. data/lib/mailslurp_client/models/domain_information.rb +1 -1
  114. data/lib/mailslurp_client/models/domain_issues_dto.rb +1 -1
  115. data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
  116. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  117. data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
  118. data/lib/mailslurp_client/models/email.rb +68 -2
  119. data/lib/mailslurp_client/models/email_analysis.rb +1 -1
  120. data/lib/mailslurp_client/models/email_available_result.rb +1 -1
  121. data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
  122. data/lib/mailslurp_client/models/email_content_part_result.rb +1 -1
  123. data/lib/mailslurp_client/models/email_feature_category_name.rb +1 -1
  124. data/lib/mailslurp_client/models/email_feature_family_name.rb +1 -1
  125. data/lib/mailslurp_client/models/email_feature_family_statistics.rb +1 -1
  126. data/lib/mailslurp_client/models/email_feature_names.rb +1 -1
  127. data/lib/mailslurp_client/models/email_feature_overview.rb +1 -1
  128. data/lib/mailslurp_client/models/email_feature_platform_name.rb +1 -1
  129. data/lib/mailslurp_client/models/email_feature_platform_statistics.rb +1 -1
  130. data/lib/mailslurp_client/models/email_feature_support_flags.rb +1 -1
  131. data/lib/mailslurp_client/models/email_feature_support_result.rb +1 -1
  132. data/lib/mailslurp_client/models/email_feature_support_status_percentage.rb +1 -1
  133. data/lib/mailslurp_client/models/email_feature_version_statistics.rb +1 -1
  134. data/lib/mailslurp_client/models/email_html_dto.rb +1 -1
  135. data/lib/mailslurp_client/models/email_links_result.rb +1 -1
  136. data/lib/mailslurp_client/models/email_preview.rb +112 -6
  137. data/lib/mailslurp_client/models/email_preview_urls.rb +1 -1
  138. data/lib/mailslurp_client/models/email_projection.rb +134 -42
  139. data/lib/mailslurp_client/models/email_recipients.rb +1 -1
  140. data/lib/mailslurp_client/models/email_recipients_projection.rb +231 -0
  141. data/lib/mailslurp_client/models/email_screenshot_result.rb +1 -1
  142. data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
  143. data/lib/mailslurp_client/models/email_thread_dto.rb +348 -0
  144. data/lib/mailslurp_client/models/email_thread_item.rb +429 -0
  145. data/lib/mailslurp_client/models/email_thread_items_dto.rb +213 -0
  146. data/lib/mailslurp_client/models/email_thread_projection.rb +441 -0
  147. data/lib/mailslurp_client/models/email_validation_request_dto.rb +1 -1
  148. data/lib/mailslurp_client/models/email_verification_result.rb +1 -1
  149. data/lib/mailslurp_client/models/emergency_address.rb +8 -3
  150. data/lib/mailslurp_client/models/emergency_address_dto.rb +3 -3
  151. data/lib/mailslurp_client/models/empty_response_dto.rb +1 -1
  152. data/lib/mailslurp_client/models/entity_automation_item_projection.rb +295 -0
  153. data/lib/mailslurp_client/models/entity_event_item_projection.rb +303 -0
  154. data/lib/mailslurp_client/models/entity_favourite_item_projection.rb +296 -0
  155. data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
  156. data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
  157. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +20 -20
  158. data/lib/mailslurp_client/models/export_link.rb +1 -1
  159. data/lib/mailslurp_client/models/export_options.rb +1 -1
  160. data/lib/mailslurp_client/models/fake_email_dto.rb +49 -5
  161. data/lib/mailslurp_client/models/fake_email_preview.rb +16 -2
  162. data/lib/mailslurp_client/models/fake_email_result.rb +1 -1
  163. data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb +1 -1
  164. data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb +1 -1
  165. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +1 -1
  166. data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
  167. data/lib/mailslurp_client/models/generate_bimi_record_options.rb +1 -1
  168. data/lib/mailslurp_client/models/generate_bimi_record_results.rb +1 -1
  169. data/lib/mailslurp_client/models/generate_dmarc_record_options.rb +1 -1
  170. data/lib/mailslurp_client/models/generate_dmarc_record_results.rb +1 -1
  171. data/lib/mailslurp_client/models/generate_mta_sts_record_options.rb +1 -1
  172. data/lib/mailslurp_client/models/generate_mta_sts_record_results.rb +1 -1
  173. data/lib/mailslurp_client/models/generate_tls_reporting_record_options.rb +1 -1
  174. data/lib/mailslurp_client/models/generate_tls_reporting_record_results.rb +1 -1
  175. data/lib/mailslurp_client/models/get_email_screenshot_options.rb +1 -1
  176. data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
  177. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  178. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  179. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  180. data/lib/mailslurp_client/models/guest_portal_dto.rb +303 -0
  181. data/lib/mailslurp_client/models/guest_portal_user_create_dto.rb +225 -0
  182. data/lib/mailslurp_client/models/guest_portal_user_dto.rb +322 -0
  183. data/lib/mailslurp_client/models/guest_portal_user_projection.rb +309 -0
  184. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  185. data/lib/mailslurp_client/models/image_issue.rb +1 -1
  186. data/lib/mailslurp_client/models/imap_access_details.rb +1 -1
  187. data/lib/mailslurp_client/models/imap_email_projection.rb +1 -1
  188. data/lib/mailslurp_client/models/imap_flag_operation_options.rb +1 -1
  189. data/lib/mailslurp_client/models/imap_mailbox_status.rb +1 -1
  190. data/lib/mailslurp_client/models/imap_server_fetch_item.rb +1 -1
  191. data/lib/mailslurp_client/models/imap_server_fetch_result.rb +1 -1
  192. data/lib/mailslurp_client/models/imap_server_get_result.rb +1 -1
  193. data/lib/mailslurp_client/models/imap_server_list_options.rb +1 -1
  194. data/lib/mailslurp_client/models/imap_server_list_result.rb +1 -1
  195. data/lib/mailslurp_client/models/imap_server_mailbox_result.rb +1 -1
  196. data/lib/mailslurp_client/models/imap_server_search_options.rb +1 -1
  197. data/lib/mailslurp_client/models/imap_server_search_result.rb +1 -1
  198. data/lib/mailslurp_client/models/imap_server_status_options.rb +1 -1
  199. data/lib/mailslurp_client/models/imap_server_status_result.rb +1 -1
  200. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +17 -2
  201. data/lib/mailslurp_client/models/imap_smtp_access_servers.rb +1 -1
  202. data/lib/mailslurp_client/models/imap_update_flags_options.rb +1 -1
  203. data/lib/mailslurp_client/models/inbox_by_email_address_result.rb +1 -1
  204. data/lib/mailslurp_client/models/inbox_by_name_result.rb +1 -1
  205. data/lib/mailslurp_client/models/inbox_dto.rb +54 -9
  206. data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
  207. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +2 -6
  208. data/lib/mailslurp_client/models/inbox_forwarder_event_dto.rb +12 -2
  209. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +25 -15
  210. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  211. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
  212. data/lib/mailslurp_client/models/inbox_id_item.rb +1 -1
  213. data/lib/mailslurp_client/models/inbox_ids_result.rb +1 -1
  214. data/lib/mailslurp_client/models/inbox_preview.rb +54 -9
  215. data/lib/mailslurp_client/models/inbox_replier_dto.rb +2 -6
  216. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +28 -28
  217. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
  218. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  219. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
  220. data/lib/mailslurp_client/models/inline_object.rb +2 -12
  221. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  222. data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
  223. data/lib/mailslurp_client/models/link_issue.rb +1 -1
  224. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +16 -16
  225. data/lib/mailslurp_client/models/lookup_bimi_domain_options.rb +1 -1
  226. data/lib/mailslurp_client/models/lookup_bimi_domain_results.rb +1 -1
  227. data/lib/mailslurp_client/models/lookup_dmarc_domain_options.rb +1 -1
  228. data/lib/mailslurp_client/models/lookup_dmarc_domain_results.rb +1 -1
  229. data/lib/mailslurp_client/models/lookup_mta_sts_domain_options.rb +1 -1
  230. data/lib/mailslurp_client/models/lookup_mta_sts_domain_results.rb +1 -1
  231. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_options.rb +1 -1
  232. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_results.rb +1 -1
  233. data/lib/mailslurp_client/models/match_option.rb +1 -1
  234. data/lib/mailslurp_client/models/match_options.rb +1 -1
  235. data/lib/mailslurp_client/models/missed_email_dto.rb +1 -1
  236. data/lib/mailslurp_client/models/missed_email_projection.rb +11 -11
  237. data/lib/mailslurp_client/models/name_server_record.rb +1 -1
  238. data/lib/mailslurp_client/models/new_fake_email_address_result.rb +1 -1
  239. data/lib/mailslurp_client/models/opt_in_consent_options.rb +229 -0
  240. data/lib/mailslurp_client/models/opt_in_consent_send_result.rb +211 -0
  241. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause_stack_trace.rb → opt_in_identity_projection.rb} +54 -61
  242. data/lib/mailslurp_client/models/opt_in_sending_consent_dto.rb +239 -0
  243. data/lib/mailslurp_client/models/optional_connector_dto.rb +220 -0
  244. data/lib/mailslurp_client/models/optional_connector_imap_connection_dto.rb +220 -0
  245. data/lib/mailslurp_client/models/optional_connector_smtp_connection_dto.rb +220 -0
  246. data/lib/mailslurp_client/models/optional_connector_sync_settings_dto.rb +220 -0
  247. data/lib/mailslurp_client/models/organization_inbox_projection.rb +68 -8
  248. data/lib/mailslurp_client/models/page_alias.rb +16 -16
  249. data/lib/mailslurp_client/models/{page_connector_sync_events.rb → page_alias_thread_projection.rb} +21 -21
  250. data/lib/mailslurp_client/models/page_attachment_entity.rb +16 -16
  251. data/lib/mailslurp_client/models/page_bounced_email.rb +16 -16
  252. data/lib/mailslurp_client/models/page_bounced_recipients.rb +16 -16
  253. data/lib/mailslurp_client/models/page_complaint.rb +16 -16
  254. data/lib/mailslurp_client/models/page_connector.rb +16 -16
  255. data/lib/mailslurp_client/models/page_connector_events.rb +309 -0
  256. data/lib/mailslurp_client/models/page_contact_projection.rb +16 -16
  257. data/lib/mailslurp_client/models/page_delivery_status.rb +16 -16
  258. data/lib/mailslurp_client/models/page_email_preview.rb +16 -16
  259. data/lib/mailslurp_client/models/page_email_projection.rb +16 -16
  260. data/lib/mailslurp_client/models/page_email_thread_projection.rb +309 -0
  261. data/lib/mailslurp_client/models/page_email_validation_request.rb +16 -16
  262. data/lib/mailslurp_client/models/page_entity_automation_items.rb +309 -0
  263. data/lib/mailslurp_client/models/{page_thread_projection.rb → page_entity_event_items.rb} +21 -21
  264. data/lib/mailslurp_client/models/page_entity_favourite_items.rb +309 -0
  265. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +16 -16
  266. data/lib/mailslurp_client/models/page_group_projection.rb +16 -16
  267. data/lib/mailslurp_client/models/page_guest_portal_users.rb +309 -0
  268. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +16 -16
  269. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +16 -16
  270. data/lib/mailslurp_client/models/page_inbox_projection.rb +16 -16
  271. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +16 -16
  272. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +16 -16
  273. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +16 -16
  274. data/lib/mailslurp_client/models/page_inbox_tags.rb +309 -0
  275. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +16 -16
  276. data/lib/mailslurp_client/models/page_missed_email_projection.rb +16 -16
  277. data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +309 -0
  278. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +16 -16
  279. data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +309 -0
  280. data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +309 -0
  281. data/lib/mailslurp_client/models/page_phone_number_projection.rb +16 -16
  282. data/lib/mailslurp_client/models/page_plus_address_projection.rb +309 -0
  283. data/lib/mailslurp_client/models/page_reputation_items.rb +309 -0
  284. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +16 -16
  285. data/lib/mailslurp_client/models/page_sent_email_projection.rb +16 -16
  286. data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +16 -16
  287. data/lib/mailslurp_client/models/page_sent_sms_projection.rb +309 -0
  288. data/lib/mailslurp_client/models/page_sms_projection.rb +16 -16
  289. data/lib/mailslurp_client/models/page_template_projection.rb +16 -16
  290. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +16 -16
  291. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +16 -16
  292. data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +309 -0
  293. data/lib/mailslurp_client/models/page_webhook_projection.rb +16 -16
  294. data/lib/mailslurp_client/models/page_webhook_result.rb +16 -16
  295. data/lib/mailslurp_client/models/pageable_object.rb +20 -20
  296. data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +315 -0
  297. data/lib/mailslurp_client/models/phone_message_thread_projection.rb +315 -0
  298. data/lib/mailslurp_client/models/phone_number_dto.rb +39 -7
  299. data/lib/mailslurp_client/models/phone_number_projection.rb +27 -18
  300. data/lib/mailslurp_client/models/phone_number_validation_dto.rb +254 -0
  301. data/lib/mailslurp_client/models/phone_plan_availability.rb +213 -0
  302. data/lib/mailslurp_client/models/phone_plan_availability_item.rb +271 -0
  303. data/lib/mailslurp_client/models/phone_plan_dto.rb +3 -3
  304. data/lib/mailslurp_client/models/plus_address_dto.rb +295 -0
  305. data/lib/mailslurp_client/models/plus_address_projection.rb +295 -0
  306. data/lib/mailslurp_client/models/provider_settings.rb +347 -0
  307. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  308. data/lib/mailslurp_client/models/recipient.rb +1 -1
  309. data/lib/mailslurp_client/models/recipient_projection.rb +234 -0
  310. data/lib/mailslurp_client/models/reply_for_sms.rb +1 -1
  311. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
  312. data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
  313. data/lib/mailslurp_client/models/reputation_item_projection.rb +317 -0
  314. data/lib/mailslurp_client/models/scheduled_job.rb +1 -1
  315. data/lib/mailslurp_client/models/scheduled_job_dto.rb +1 -1
  316. data/lib/mailslurp_client/models/search_emails_options.rb +1 -1
  317. data/lib/mailslurp_client/models/search_inboxes_options.rb +3 -3
  318. data/lib/mailslurp_client/models/send_email_body_part.rb +1 -1
  319. data/lib/mailslurp_client/models/send_email_options.rb +13 -2
  320. data/lib/mailslurp_client/models/send_opt_in_consent_email_options.rb +234 -0
  321. data/lib/mailslurp_client/models/send_smtp_envelope_options.rb +1 -1
  322. data/lib/mailslurp_client/models/send_with_queue_result.rb +1 -1
  323. data/lib/mailslurp_client/models/sender.rb +1 -1
  324. data/lib/mailslurp_client/models/sender_projection.rb +235 -0
  325. data/lib/mailslurp_client/models/sent_email_dto.rb +103 -2
  326. data/lib/mailslurp_client/models/sent_email_projection.rb +113 -44
  327. data/lib/mailslurp_client/models/sent_sms_dto.rb +1 -11
  328. data/lib/mailslurp_client/models/sent_sms_projection.rb +305 -0
  329. data/lib/mailslurp_client/models/server_endpoints.rb +1 -1
  330. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  331. data/lib/mailslurp_client/models/set_phone_favourited_options.rb +213 -0
  332. data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
  333. data/lib/mailslurp_client/models/sms_dto.rb +25 -2
  334. data/lib/mailslurp_client/models/sms_match_option.rb +1 -1
  335. data/lib/mailslurp_client/models/sms_preview.rb +16 -2
  336. data/lib/mailslurp_client/models/sms_projection.rb +16 -16
  337. data/lib/mailslurp_client/models/sms_reply_options.rb +1 -1
  338. data/lib/mailslurp_client/models/sms_send_options.rb +225 -0
  339. data/lib/mailslurp_client/models/smtp_access_details.rb +1 -1
  340. data/lib/mailslurp_client/models/sort_object.rb +1 -1
  341. data/lib/mailslurp_client/models/spelling_issue.rb +1 -1
  342. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  343. data/lib/mailslurp_client/models/template_preview.rb +1 -1
  344. data/lib/mailslurp_client/models/template_projection.rb +16 -16
  345. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  346. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_options.rb +1 -1
  347. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_result.rb +1 -1
  348. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_options.rb +1 -1
  349. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_result.rb +1 -1
  350. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  351. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  352. data/lib/mailslurp_client/models/test_phone_number_options.rb +1 -1
  353. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
  354. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +22 -22
  355. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +1 -1
  356. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  357. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
  358. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  359. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  360. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  361. data/lib/mailslurp_client/models/update_imap_access_options.rb +1 -1
  362. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  363. data/lib/mailslurp_client/models/update_inbox_replier_options.rb +1 -1
  364. data/lib/mailslurp_client/models/update_phone_number_options.rb +215 -0
  365. data/lib/mailslurp_client/models/update_smtp_access_options.rb +1 -1
  366. data/lib/mailslurp_client/models/upload_attachment_options.rb +1 -1
  367. data/lib/mailslurp_client/models/user_info_dto.rb +1 -1
  368. data/lib/mailslurp_client/models/validate_email_address_list_options.rb +1 -1
  369. data/lib/mailslurp_client/models/validate_email_address_list_result.rb +1 -1
  370. data/lib/mailslurp_client/models/validate_phone_number_options.rb +211 -0
  371. data/lib/mailslurp_client/models/validation_dto.rb +1 -1
  372. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  373. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  374. data/lib/mailslurp_client/models/verify_webhook_signature_options.rb +1 -1
  375. data/lib/mailslurp_client/models/verify_webhook_signature_results.rb +1 -1
  376. data/lib/mailslurp_client/models/wait_for_conditions.rb +1 -1
  377. data/lib/mailslurp_client/models/wait_for_single_sms_options.rb +1 -1
  378. data/lib/mailslurp_client/models/wait_for_sms_conditions.rb +2 -2
  379. data/lib/mailslurp_client/models/webhook_bounce_payload.rb +3 -3
  380. data/lib/mailslurp_client/models/webhook_bounce_recipient_payload.rb +3 -3
  381. data/lib/mailslurp_client/models/webhook_delivery_status_payload.rb +3 -3
  382. data/lib/mailslurp_client/models/webhook_dto.rb +31 -8
  383. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
  384. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +3 -3
  385. data/lib/mailslurp_client/models/webhook_endpoint_projection.rb +259 -0
  386. data/lib/mailslurp_client/models/webhook_header_name_value.rb +1 -1
  387. data/lib/mailslurp_client/models/webhook_headers.rb +1 -1
  388. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
  389. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
  390. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +3 -3
  391. data/lib/mailslurp_client/models/webhook_new_sms_payload.rb +3 -3
  392. data/lib/mailslurp_client/models/webhook_projection.rb +78 -25
  393. data/lib/mailslurp_client/models/webhook_redrive_all_result.rb +1 -1
  394. data/lib/mailslurp_client/models/webhook_redrive_result.rb +1 -1
  395. data/lib/mailslurp_client/models/webhook_result_dto.rb +3 -3
  396. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  397. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  398. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  399. data/lib/mailslurp_client/version.rb +2 -2
  400. data/lib/mailslurp_client.rb +74 -10
  401. metadata +75 -11
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #MailSlurp API
3
3
 
4
- #MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
4
+ #MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
  Contact: contact@mailslurp.dev
@@ -797,6 +797,60 @@ module MailSlurpClient
797
797
  return data, status_code, headers
798
798
  end
799
799
 
800
+ # Does inbox have automations
801
+ # Check if an inbox has automations.
802
+ # @param [Hash] opts the optional parameters
803
+ # @return [nil]
804
+ def does_inbox_have_automations(opts = {})
805
+ does_inbox_have_automations_with_http_info(opts)
806
+ nil
807
+ end
808
+
809
+ # Does inbox have automations
810
+ # Check if an inbox has automations.
811
+ # @param [Hash] opts the optional parameters
812
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
813
+ def does_inbox_have_automations_with_http_info(opts = {})
814
+ if @api_client.config.debugging
815
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.does_inbox_have_automations ...'
816
+ end
817
+ # resource path
818
+ local_var_path = '/inboxes/automations'
819
+
820
+ # query parameters
821
+ query_params = opts[:query_params] || {}
822
+
823
+ # header parameters
824
+ header_params = opts[:header_params] || {}
825
+
826
+ # form parameters
827
+ form_params = opts[:form_params] || {}
828
+
829
+ # http body (model)
830
+ post_body = opts[:body]
831
+
832
+ # return_type
833
+ return_type = opts[:return_type]
834
+
835
+ # auth_names
836
+ auth_names = opts[:auth_names] || ['API_KEY']
837
+
838
+ new_options = opts.merge(
839
+ :header_params => header_params,
840
+ :query_params => query_params,
841
+ :form_params => form_params,
842
+ :body => post_body,
843
+ :auth_names => auth_names,
844
+ :return_type => return_type
845
+ )
846
+
847
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
848
+ if @api_client.config.debugging
849
+ @api_client.config.logger.debug "API called: InboxControllerApi#does_inbox_have_automations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
850
+ end
851
+ return data, status_code, headers
852
+ end
853
+
800
854
  # Remove expired inboxes
801
855
  # Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
802
856
  # @param [Hash] opts the optional parameters
@@ -905,7 +959,7 @@ module MailSlurpClient
905
959
  if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
906
960
  fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
907
961
  end
908
- allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"]
962
+ allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR", "ACCOUNT", "GUEST", "OAUTH_CONNECTION_GMAIL"]
909
963
  if @api_client.config.client_side_validation && opts[:'inbox_function'] && !allowable_values.include?(opts[:'inbox_function'])
910
964
  fail ArgumentError, "invalid value for \"inbox_function\", must be one of #{allowable_values}"
911
965
  end
@@ -1009,7 +1063,7 @@ module MailSlurpClient
1009
1063
  if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
1010
1064
  fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
1011
1065
  end
1012
- allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"]
1066
+ allowable_values = ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR", "ACCOUNT", "GUEST", "OAUTH_CONNECTION_GMAIL"]
1013
1067
  if @api_client.config.client_side_validation && opts[:'inbox_function'] && !allowable_values.include?(opts[:'inbox_function'])
1014
1068
  fail ArgumentError, "invalid value for \"inbox_function\", must be one of #{allowable_values}"
1015
1069
  end
@@ -1064,6 +1118,78 @@ module MailSlurpClient
1064
1118
  return data, status_code, headers
1065
1119
  end
1066
1120
 
1121
+ # Get all sub address plus address aliases for an inbox
1122
+ # Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.
1123
+ # @param [Hash] opts the optional parameters
1124
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
1125
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
1126
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1127
+ # @option opts [String] :inbox_id Optional inboxId filter
1128
+ # @return [PagePlusAddressProjection]
1129
+ def get_all_plus_addresses(opts = {})
1130
+ data, _status_code, _headers = get_all_plus_addresses_with_http_info(opts)
1131
+ data
1132
+ end
1133
+
1134
+ # Get all sub address plus address aliases for an inbox
1135
+ # Returns paginated list of all plus alias addresses found for in account based on received emails that used the inbox address with a +xyz alias.
1136
+ # @param [Hash] opts the optional parameters
1137
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
1138
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
1139
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1140
+ # @option opts [String] :inbox_id Optional inboxId filter
1141
+ # @return [Array<(PagePlusAddressProjection, Integer, Hash)>] PagePlusAddressProjection data, response status code and response headers
1142
+ def get_all_plus_addresses_with_http_info(opts = {})
1143
+ if @api_client.config.debugging
1144
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_all_plus_addresses ...'
1145
+ end
1146
+ allowable_values = ["ASC", "DESC"]
1147
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1148
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1149
+ end
1150
+ # resource path
1151
+ local_var_path = '/inboxes/plus-addresses'
1152
+
1153
+ # query parameters
1154
+ query_params = opts[:query_params] || {}
1155
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1156
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1157
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1158
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
1159
+
1160
+ # header parameters
1161
+ header_params = opts[:header_params] || {}
1162
+ # HTTP header 'Accept' (if needed)
1163
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1164
+
1165
+ # form parameters
1166
+ form_params = opts[:form_params] || {}
1167
+
1168
+ # http body (model)
1169
+ post_body = opts[:body]
1170
+
1171
+ # return_type
1172
+ return_type = opts[:return_type] || 'PagePlusAddressProjection'
1173
+
1174
+ # auth_names
1175
+ auth_names = opts[:auth_names] || ['API_KEY']
1176
+
1177
+ new_options = opts.merge(
1178
+ :header_params => header_params,
1179
+ :query_params => query_params,
1180
+ :form_params => form_params,
1181
+ :body => post_body,
1182
+ :auth_names => auth_names,
1183
+ :return_type => return_type
1184
+ )
1185
+
1186
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1187
+ if @api_client.config.debugging
1188
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_all_plus_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1189
+ end
1190
+ return data, status_code, headers
1191
+ end
1192
+
1067
1193
  # Get all scheduled email sending jobs for account
1068
1194
  # Schedule sending of emails using scheduled jobs. These can be inbox or account level.
1069
1195
  # @param [Hash] opts the optional parameters
@@ -1072,6 +1198,7 @@ module MailSlurpClient
1072
1198
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1073
1199
  # @option opts [DateTime] :since Filter by created at after the given timestamp
1074
1200
  # @option opts [DateTime] :before Filter by created at before the given timestamp
1201
+ # @option opts [String] :inbox_id
1075
1202
  # @return [PageScheduledJobs]
1076
1203
  def get_all_scheduled_jobs(opts = {})
1077
1204
  data, _status_code, _headers = get_all_scheduled_jobs_with_http_info(opts)
@@ -1086,6 +1213,7 @@ module MailSlurpClient
1086
1213
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1087
1214
  # @option opts [DateTime] :since Filter by created at after the given timestamp
1088
1215
  # @option opts [DateTime] :before Filter by created at before the given timestamp
1216
+ # @option opts [String] :inbox_id
1089
1217
  # @return [Array<(PageScheduledJobs, Integer, Hash)>] PageScheduledJobs data, response status code and response headers
1090
1218
  def get_all_scheduled_jobs_with_http_info(opts = {})
1091
1219
  if @api_client.config.debugging
@@ -1105,6 +1233,7 @@ module MailSlurpClient
1105
1233
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1106
1234
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1107
1235
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1236
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
1108
1237
 
1109
1238
  # header parameters
1110
1239
  header_params = opts[:header_params] || {}
@@ -1855,6 +1984,7 @@ module MailSlurpClient
1855
1984
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1856
1985
  # @option opts [DateTime] :since Optional filter by received after given date time
1857
1986
  # @option opts [DateTime] :before Optional filter by received before given date time
1987
+ # @option opts [Boolean] :sync_connectors Sync connectors before fetching emails
1858
1988
  # @return [PageEmailPreview]
1859
1989
  def get_inbox_emails_paginated(inbox_id, opts = {})
1860
1990
  data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(inbox_id, opts)
@@ -1870,6 +2000,7 @@ module MailSlurpClient
1870
2000
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1871
2001
  # @option opts [DateTime] :since Optional filter by received after given date time
1872
2002
  # @option opts [DateTime] :before Optional filter by received before given date time
2003
+ # @option opts [Boolean] :sync_connectors Sync connectors before fetching emails
1873
2004
  # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
1874
2005
  def get_inbox_emails_paginated_with_http_info(inbox_id, opts = {})
1875
2006
  if @api_client.config.debugging
@@ -1893,6 +2024,7 @@ module MailSlurpClient
1893
2024
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1894
2025
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1895
2026
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2027
+ query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
1896
2028
 
1897
2029
  # header parameters
1898
2030
  header_params = opts[:header_params] || {}
@@ -1983,56 +2115,40 @@ module MailSlurpClient
1983
2115
  return data, status_code, headers
1984
2116
  end
1985
2117
 
1986
- # Get Inbox Sent Emails
1987
- # Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
1988
- # @param inbox_id [String]
2118
+ # Get sub address plus address for an inbox
2119
+ # Returns a plus address object based on emails that used the inbox address with a +xyz alias.
2120
+ # @param plus_address_id [String] ID of the plus address you want to fetch
2121
+ # @param inbox_id [String] ID of the inbox you want to fetch
1989
2122
  # @param [Hash] opts the optional parameters
1990
- # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
1991
- # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
1992
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1993
- # @option opts [String] :search_filter Optional sent email search
1994
- # @option opts [DateTime] :since Optional filter by sent after given date time
1995
- # @option opts [DateTime] :before Optional filter by sent before given date time
1996
- # @return [PageSentEmailProjection]
1997
- def get_inbox_sent_emails(inbox_id, opts = {})
1998
- data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts)
2123
+ # @return [PlusAddressDto]
2124
+ def get_inbox_plus_address(plus_address_id, inbox_id, opts = {})
2125
+ data, _status_code, _headers = get_inbox_plus_address_with_http_info(plus_address_id, inbox_id, opts)
1999
2126
  data
2000
2127
  end
2001
2128
 
2002
- # Get Inbox Sent Emails
2003
- # Returns an inbox&#39;s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
2004
- # @param inbox_id [String]
2129
+ # Get sub address plus address for an inbox
2130
+ # Returns a plus address object based on emails that used the inbox address with a +xyz alias.
2131
+ # @param plus_address_id [String] ID of the plus address you want to fetch
2132
+ # @param inbox_id [String] ID of the inbox you want to fetch
2005
2133
  # @param [Hash] opts the optional parameters
2006
- # @option opts [Integer] :page Optional page index in inbox sent email list pagination
2007
- # @option opts [Integer] :size Optional page size in inbox sent email list pagination
2008
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2009
- # @option opts [String] :search_filter Optional sent email search
2010
- # @option opts [DateTime] :since Optional filter by sent after given date time
2011
- # @option opts [DateTime] :before Optional filter by sent before given date time
2012
- # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
2013
- def get_inbox_sent_emails_with_http_info(inbox_id, opts = {})
2134
+ # @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
2135
+ def get_inbox_plus_address_with_http_info(plus_address_id, inbox_id, opts = {})
2014
2136
  if @api_client.config.debugging
2015
- @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_emails ...'
2137
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address ...'
2138
+ end
2139
+ # verify the required parameter 'plus_address_id' is set
2140
+ if @api_client.config.client_side_validation && plus_address_id.nil?
2141
+ fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address"
2016
2142
  end
2017
2143
  # verify the required parameter 'inbox_id' is set
2018
2144
  if @api_client.config.client_side_validation && inbox_id.nil?
2019
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_emails"
2020
- end
2021
- allowable_values = ["ASC", "DESC"]
2022
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2023
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2145
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address"
2024
2146
  end
2025
2147
  # resource path
2026
- local_var_path = '/inboxes/{inboxId}/sent'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2148
+ local_var_path = '/inboxes/{inboxId}/plus-addresses/{plusAddressId}'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s)).sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2027
2149
 
2028
2150
  # query parameters
2029
2151
  query_params = opts[:query_params] || {}
2030
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2031
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2032
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2033
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2034
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2035
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2036
2152
 
2037
2153
  # header parameters
2038
2154
  header_params = opts[:header_params] || {}
@@ -2046,7 +2162,7 @@ module MailSlurpClient
2046
2162
  post_body = opts[:body]
2047
2163
 
2048
2164
  # return_type
2049
- return_type = opts[:return_type] || 'PageSentEmailProjection'
2165
+ return_type = opts[:return_type] || 'PlusAddressDto'
2050
2166
 
2051
2167
  # auth_names
2052
2168
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -2062,33 +2178,42 @@ module MailSlurpClient
2062
2178
 
2063
2179
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2064
2180
  if @api_client.config.debugging
2065
- @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2181
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2066
2182
  end
2067
2183
  return data, status_code, headers
2068
2184
  end
2069
2185
 
2070
- # Get inbox tags
2071
- # Get all inbox tags
2186
+ # Get sub address plus address by ID
2187
+ # Returns a plus address object based on emails that used the inbox address with a +xyz alias.
2188
+ # @param plus_address_id [String] ID of the plus address you want to fetch
2072
2189
  # @param [Hash] opts the optional parameters
2073
- # @return [Array<String>]
2074
- def get_inbox_tags(opts = {})
2075
- data, _status_code, _headers = get_inbox_tags_with_http_info(opts)
2190
+ # @option opts [String] :inbox_id ID of the inbox you want to filter for
2191
+ # @return [PlusAddressDto]
2192
+ def get_inbox_plus_address_by_id(plus_address_id, opts = {})
2193
+ data, _status_code, _headers = get_inbox_plus_address_by_id_with_http_info(plus_address_id, opts)
2076
2194
  data
2077
2195
  end
2078
2196
 
2079
- # Get inbox tags
2080
- # Get all inbox tags
2197
+ # Get sub address plus address by ID
2198
+ # Returns a plus address object based on emails that used the inbox address with a +xyz alias.
2199
+ # @param plus_address_id [String] ID of the plus address you want to fetch
2081
2200
  # @param [Hash] opts the optional parameters
2082
- # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
2083
- def get_inbox_tags_with_http_info(opts = {})
2201
+ # @option opts [String] :inbox_id ID of the inbox you want to filter for
2202
+ # @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
2203
+ def get_inbox_plus_address_by_id_with_http_info(plus_address_id, opts = {})
2084
2204
  if @api_client.config.debugging
2085
- @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags ...'
2205
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_by_id ...'
2206
+ end
2207
+ # verify the required parameter 'plus_address_id' is set
2208
+ if @api_client.config.client_side_validation && plus_address_id.nil?
2209
+ fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address_by_id"
2086
2210
  end
2087
2211
  # resource path
2088
- local_var_path = '/inboxes/tags'
2212
+ local_var_path = '/inboxes/plus-addresses/{plusAddressId}'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s))
2089
2213
 
2090
2214
  # query parameters
2091
2215
  query_params = opts[:query_params] || {}
2216
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
2092
2217
 
2093
2218
  # header parameters
2094
2219
  header_params = opts[:header_params] || {}
@@ -2102,7 +2227,7 @@ module MailSlurpClient
2102
2227
  post_body = opts[:body]
2103
2228
 
2104
2229
  # return_type
2105
- return_type = opts[:return_type] || 'Array<String>'
2230
+ return_type = opts[:return_type] || 'PlusAddressDto'
2106
2231
 
2107
2232
  # auth_names
2108
2233
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -2118,55 +2243,64 @@ module MailSlurpClient
2118
2243
 
2119
2244
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2120
2245
  if @api_client.config.debugging
2121
- @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2246
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2122
2247
  end
2123
2248
  return data, status_code, headers
2124
2249
  end
2125
2250
 
2126
- # List Inboxes and email addresses
2127
- # List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
2251
+ # Get emails for a given inbox plus address
2252
+ # Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2253
+ # @param plus_address [String] The plus address to fetch emails for. If your inbox address is &#x60;123@test.com&#x60; and the email was sent to &#x60;123+abc@test.com&#x60; then the plus address is &#x60;abc&#x60;
2254
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2128
2255
  # @param [Hash] opts the optional parameters
2129
- # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
2256
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
2257
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
2130
2258
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2131
2259
  # @option opts [DateTime] :since Optional filter by created after given date time
2132
- # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
2133
2260
  # @option opts [DateTime] :before Optional filter by created before given date time
2134
- # @return [Array<InboxDto>]
2135
- def get_inboxes(opts = {})
2136
- data, _status_code, _headers = get_inboxes_with_http_info(opts)
2261
+ # @return [PageEmailPreview]
2262
+ def get_inbox_plus_address_emails(plus_address, inbox_id, opts = {})
2263
+ data, _status_code, _headers = get_inbox_plus_address_emails_with_http_info(plus_address, inbox_id, opts)
2137
2264
  data
2138
2265
  end
2139
2266
 
2140
- # List Inboxes and email addresses
2141
- # List the inboxes you have created. Note use of the more advanced &#x60;getAllInboxes&#x60; is recommended and allows paginated access using a limit and sort parameter.
2267
+ # Get emails for a given inbox plus address
2268
+ # Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2269
+ # @param plus_address [String] The plus address to fetch emails for. If your inbox address is &#x60;123@test.com&#x60; and the email was sent to &#x60;123+abc@test.com&#x60; then the plus address is &#x60;abc&#x60;
2270
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2142
2271
  # @param [Hash] opts the optional parameters
2143
- # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
2272
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
2273
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
2144
2274
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2145
2275
  # @option opts [DateTime] :since Optional filter by created after given date time
2146
- # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
2147
2276
  # @option opts [DateTime] :before Optional filter by created before given date time
2148
- # @return [Array<(Array<InboxDto>, Integer, Hash)>] Array<InboxDto> data, response status code and response headers
2149
- def get_inboxes_with_http_info(opts = {})
2277
+ # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
2278
+ def get_inbox_plus_address_emails_with_http_info(plus_address, inbox_id, opts = {})
2150
2279
  if @api_client.config.debugging
2151
- @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
2280
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_emails ...'
2152
2281
  end
2153
- if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
2154
- fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_inboxes, must be smaller than or equal to 100.'
2282
+ # verify the required parameter 'plus_address' is set
2283
+ if @api_client.config.client_side_validation && plus_address.nil?
2284
+ fail ArgumentError, "Missing the required parameter 'plus_address' when calling InboxControllerApi.get_inbox_plus_address_emails"
2285
+ end
2286
+ # verify the required parameter 'inbox_id' is set
2287
+ if @api_client.config.client_side_validation && inbox_id.nil?
2288
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address_emails"
2155
2289
  end
2156
-
2157
2290
  allowable_values = ["ASC", "DESC"]
2158
2291
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2159
2292
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2160
2293
  end
2161
2294
  # resource path
2162
- local_var_path = '/inboxes'
2295
+ local_var_path = '/inboxes/{inboxId}/plus-addresses/emails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2163
2296
 
2164
2297
  # query parameters
2165
2298
  query_params = opts[:query_params] || {}
2299
+ query_params[:'plusAddress'] = plus_address
2300
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2166
2301
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2167
2302
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2168
2303
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2169
- query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil?
2170
2304
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2171
2305
 
2172
2306
  # header parameters
@@ -2181,7 +2315,7 @@ module MailSlurpClient
2181
2315
  post_body = opts[:body]
2182
2316
 
2183
2317
  # return_type
2184
- return_type = opts[:return_type] || 'Array<InboxDto>'
2318
+ return_type = opts[:return_type] || 'PageEmailPreview'
2185
2319
 
2186
2320
  # auth_names
2187
2321
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -2197,47 +2331,64 @@ module MailSlurpClient
2197
2331
 
2198
2332
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2199
2333
  if @api_client.config.debugging
2200
- @api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2334
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2201
2335
  end
2202
2336
  return data, status_code, headers
2203
2337
  end
2204
2338
 
2205
- # Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
2206
- # Get the newest email in an inbox or wait for one to arrive
2207
- # @param inbox_id [String] ID of the inbox you want to get the latest email from
2208
- # @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
2339
+ # Get emails for a given inbox plus address
2340
+ # Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2341
+ # @param plus_address_id [String] The plus address ID to fetch emails for.
2342
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2209
2343
  # @param [Hash] opts the optional parameters
2210
- # @return [Email]
2211
- def get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {})
2212
- data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts)
2344
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
2345
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
2346
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2347
+ # @option opts [DateTime] :since Optional filter by created after given date time
2348
+ # @option opts [DateTime] :before Optional filter by created before given date time
2349
+ # @return [PageEmailPreview]
2350
+ def get_inbox_plus_address_emails_for_plus_address_id(plus_address_id, inbox_id, opts = {})
2351
+ data, _status_code, _headers = get_inbox_plus_address_emails_for_plus_address_id_with_http_info(plus_address_id, inbox_id, opts)
2213
2352
  data
2214
2353
  end
2215
2354
 
2216
- # Get latest email in an inbox. Use &#x60;WaitForController&#x60; to get emails that may not have arrived yet.
2217
- # Get the newest email in an inbox or wait for one to arrive
2218
- # @param inbox_id [String] ID of the inbox you want to get the latest email from
2219
- # @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
2355
+ # Get emails for a given inbox plus address
2356
+ # Returns paginated list of all emails for a given plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2357
+ # @param plus_address_id [String] The plus address ID to fetch emails for.
2358
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2220
2359
  # @param [Hash] opts the optional parameters
2221
- # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
2222
- def get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {})
2360
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
2361
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
2362
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2363
+ # @option opts [DateTime] :since Optional filter by created after given date time
2364
+ # @option opts [DateTime] :before Optional filter by created before given date time
2365
+ # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
2366
+ def get_inbox_plus_address_emails_for_plus_address_id_with_http_info(plus_address_id, inbox_id, opts = {})
2223
2367
  if @api_client.config.debugging
2224
- @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_latest_email_in_inbox ...'
2368
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id ...'
2369
+ end
2370
+ # verify the required parameter 'plus_address_id' is set
2371
+ if @api_client.config.client_side_validation && plus_address_id.nil?
2372
+ fail ArgumentError, "Missing the required parameter 'plus_address_id' when calling InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id"
2225
2373
  end
2226
2374
  # verify the required parameter 'inbox_id' is set
2227
2375
  if @api_client.config.client_side_validation && inbox_id.nil?
2228
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_latest_email_in_inbox"
2376
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_address_emails_for_plus_address_id"
2229
2377
  end
2230
- # verify the required parameter 'timeout_millis' is set
2231
- if @api_client.config.client_side_validation && timeout_millis.nil?
2232
- fail ArgumentError, "Missing the required parameter 'timeout_millis' when calling InboxControllerApi.get_latest_email_in_inbox"
2378
+ allowable_values = ["ASC", "DESC"]
2379
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2380
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2233
2381
  end
2234
2382
  # resource path
2235
- local_var_path = '/inboxes/getLatestEmail'
2383
+ local_var_path = '/inboxes/{inboxId}/plus-addresses/{plusAddressId}/emails'.sub('{' + 'plusAddressId' + '}', CGI.escape(plus_address_id.to_s)).sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2236
2384
 
2237
2385
  # query parameters
2238
2386
  query_params = opts[:query_params] || {}
2239
- query_params[:'inboxId'] = inbox_id
2240
- query_params[:'timeoutMillis'] = timeout_millis
2387
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2388
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2389
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2390
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2391
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2241
2392
 
2242
2393
  # header parameters
2243
2394
  header_params = opts[:header_params] || {}
@@ -2251,7 +2402,7 @@ module MailSlurpClient
2251
2402
  post_body = opts[:body]
2252
2403
 
2253
2404
  # return_type
2254
- return_type = opts[:return_type] || 'Email'
2405
+ return_type = opts[:return_type] || 'PageEmailPreview'
2255
2406
 
2256
2407
  # auth_names
2257
2408
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -2267,32 +2418,626 @@ module MailSlurpClient
2267
2418
 
2268
2419
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2269
2420
  if @api_client.config.debugging
2270
- @api_client.config.logger.debug "API called: InboxControllerApi#get_latest_email_in_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2421
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_address_emails_for_plus_address_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2271
2422
  end
2272
2423
  return data, status_code, headers
2273
2424
  end
2274
2425
 
2275
- # List Organization Inboxes Paginated
2276
- # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
2426
+ # Get sub address plus address aliases for an inbox
2427
+ # Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2428
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2277
2429
  # @param [Hash] opts the optional parameters
2278
- # @option opts [Integer] :page Optional page index in list pagination (default to 0)
2279
- # @option opts [Integer] :size Optional page size in list pagination (default to 20)
2430
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
2431
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
2280
2432
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2281
- # @option opts [String] :search_filter Optional search filter
2282
- # @option opts [DateTime] :since Optional filter by created after given date time
2283
- # @option opts [DateTime] :before Optional filter by created before given date time
2284
- # @return [PageOrganizationInboxProjection]
2285
- def get_organization_inboxes(opts = {})
2286
- data, _status_code, _headers = get_organization_inboxes_with_http_info(opts)
2433
+ # @return [PagePlusAddressProjection]
2434
+ def get_inbox_plus_addresses(inbox_id, opts = {})
2435
+ data, _status_code, _headers = get_inbox_plus_addresses_with_http_info(inbox_id, opts)
2287
2436
  data
2288
2437
  end
2289
2438
 
2290
- # List Organization Inboxes Paginated
2291
- # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
2439
+ # Get sub address plus address aliases for an inbox
2440
+ # Returns paginated list of all plus alias addresses found for an inbox based on received emails that used the inbox address with a +xyz alias.
2441
+ # @param inbox_id [String] ID of the inbox you want to send the email from
2292
2442
  # @param [Hash] opts the optional parameters
2293
- # @option opts [Integer] :page Optional page index in list pagination
2294
- # @option opts [Integer] :size Optional page size in list pagination
2295
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2443
+ # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
2444
+ # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
2445
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2446
+ # @return [Array<(PagePlusAddressProjection, Integer, Hash)>] PagePlusAddressProjection data, response status code and response headers
2447
+ def get_inbox_plus_addresses_with_http_info(inbox_id, opts = {})
2448
+ if @api_client.config.debugging
2449
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_plus_addresses ...'
2450
+ end
2451
+ # verify the required parameter 'inbox_id' is set
2452
+ if @api_client.config.client_side_validation && inbox_id.nil?
2453
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_plus_addresses"
2454
+ end
2455
+ allowable_values = ["ASC", "DESC"]
2456
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2457
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2458
+ end
2459
+ # resource path
2460
+ local_var_path = '/inboxes/{inboxId}/plus-addresses'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2461
+
2462
+ # query parameters
2463
+ query_params = opts[:query_params] || {}
2464
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2465
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2466
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2467
+
2468
+ # header parameters
2469
+ header_params = opts[:header_params] || {}
2470
+ # HTTP header 'Accept' (if needed)
2471
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2472
+
2473
+ # form parameters
2474
+ form_params = opts[:form_params] || {}
2475
+
2476
+ # http body (model)
2477
+ post_body = opts[:body]
2478
+
2479
+ # return_type
2480
+ return_type = opts[:return_type] || 'PagePlusAddressProjection'
2481
+
2482
+ # auth_names
2483
+ auth_names = opts[:auth_names] || ['API_KEY']
2484
+
2485
+ new_options = opts.merge(
2486
+ :header_params => header_params,
2487
+ :query_params => query_params,
2488
+ :form_params => form_params,
2489
+ :body => post_body,
2490
+ :auth_names => auth_names,
2491
+ :return_type => return_type
2492
+ )
2493
+
2494
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2495
+ if @api_client.config.debugging
2496
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_plus_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2497
+ end
2498
+ return data, status_code, headers
2499
+ end
2500
+
2501
+ # Get sent email count in inbox
2502
+ # @param inbox_id [String] Id of inbox that emails were sent from
2503
+ # @param [Hash] opts the optional parameters
2504
+ # @return [CountDto]
2505
+ def get_inbox_sent_count(inbox_id, opts = {})
2506
+ data, _status_code, _headers = get_inbox_sent_count_with_http_info(inbox_id, opts)
2507
+ data
2508
+ end
2509
+
2510
+ # Get sent email count in inbox
2511
+ # @param inbox_id [String] Id of inbox that emails were sent from
2512
+ # @param [Hash] opts the optional parameters
2513
+ # @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
2514
+ def get_inbox_sent_count_with_http_info(inbox_id, opts = {})
2515
+ if @api_client.config.debugging
2516
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_count ...'
2517
+ end
2518
+ # verify the required parameter 'inbox_id' is set
2519
+ if @api_client.config.client_side_validation && inbox_id.nil?
2520
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_count"
2521
+ end
2522
+ # resource path
2523
+ local_var_path = '/inboxes/{inboxId}/sent/count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2524
+
2525
+ # query parameters
2526
+ query_params = opts[:query_params] || {}
2527
+
2528
+ # header parameters
2529
+ header_params = opts[:header_params] || {}
2530
+ # HTTP header 'Accept' (if needed)
2531
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2532
+
2533
+ # form parameters
2534
+ form_params = opts[:form_params] || {}
2535
+
2536
+ # http body (model)
2537
+ post_body = opts[:body]
2538
+
2539
+ # return_type
2540
+ return_type = opts[:return_type] || 'CountDto'
2541
+
2542
+ # auth_names
2543
+ auth_names = opts[:auth_names] || ['API_KEY']
2544
+
2545
+ new_options = opts.merge(
2546
+ :header_params => header_params,
2547
+ :query_params => query_params,
2548
+ :form_params => form_params,
2549
+ :body => post_body,
2550
+ :auth_names => auth_names,
2551
+ :return_type => return_type
2552
+ )
2553
+
2554
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2555
+ if @api_client.config.debugging
2556
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2557
+ end
2558
+ return data, status_code, headers
2559
+ end
2560
+
2561
+ # Get Inbox Sent Emails
2562
+ # Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
2563
+ # @param inbox_id [String]
2564
+ # @param [Hash] opts the optional parameters
2565
+ # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
2566
+ # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
2567
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2568
+ # @option opts [String] :search_filter Optional sent email search
2569
+ # @option opts [DateTime] :since Optional filter by sent after given date time
2570
+ # @option opts [DateTime] :before Optional filter by sent before given date time
2571
+ # @return [PageSentEmailProjection]
2572
+ def get_inbox_sent_emails(inbox_id, opts = {})
2573
+ data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts)
2574
+ data
2575
+ end
2576
+
2577
+ # Get Inbox Sent Emails
2578
+ # Returns an inbox&#39;s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
2579
+ # @param inbox_id [String]
2580
+ # @param [Hash] opts the optional parameters
2581
+ # @option opts [Integer] :page Optional page index in inbox sent email list pagination
2582
+ # @option opts [Integer] :size Optional page size in inbox sent email list pagination
2583
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2584
+ # @option opts [String] :search_filter Optional sent email search
2585
+ # @option opts [DateTime] :since Optional filter by sent after given date time
2586
+ # @option opts [DateTime] :before Optional filter by sent before given date time
2587
+ # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
2588
+ def get_inbox_sent_emails_with_http_info(inbox_id, opts = {})
2589
+ if @api_client.config.debugging
2590
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_emails ...'
2591
+ end
2592
+ # verify the required parameter 'inbox_id' is set
2593
+ if @api_client.config.client_side_validation && inbox_id.nil?
2594
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_emails"
2595
+ end
2596
+ allowable_values = ["ASC", "DESC"]
2597
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2598
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2599
+ end
2600
+ # resource path
2601
+ local_var_path = '/inboxes/{inboxId}/sent'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
2602
+
2603
+ # query parameters
2604
+ query_params = opts[:query_params] || {}
2605
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2606
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2607
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2608
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2609
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2610
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2611
+
2612
+ # header parameters
2613
+ header_params = opts[:header_params] || {}
2614
+ # HTTP header 'Accept' (if needed)
2615
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2616
+
2617
+ # form parameters
2618
+ form_params = opts[:form_params] || {}
2619
+
2620
+ # http body (model)
2621
+ post_body = opts[:body]
2622
+
2623
+ # return_type
2624
+ return_type = opts[:return_type] || 'PageSentEmailProjection'
2625
+
2626
+ # auth_names
2627
+ auth_names = opts[:auth_names] || ['API_KEY']
2628
+
2629
+ new_options = opts.merge(
2630
+ :header_params => header_params,
2631
+ :query_params => query_params,
2632
+ :form_params => form_params,
2633
+ :body => post_body,
2634
+ :auth_names => auth_names,
2635
+ :return_type => return_type
2636
+ )
2637
+
2638
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2639
+ if @api_client.config.debugging
2640
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2641
+ end
2642
+ return data, status_code, headers
2643
+ end
2644
+
2645
+ # Get inbox tags
2646
+ # Get all inbox tags
2647
+ # @param [Hash] opts the optional parameters
2648
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
2649
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
2650
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2651
+ # @option opts [String] :search_filter Optional search filter
2652
+ # @return [Array<String>]
2653
+ def get_inbox_tags(opts = {})
2654
+ data, _status_code, _headers = get_inbox_tags_with_http_info(opts)
2655
+ data
2656
+ end
2657
+
2658
+ # Get inbox tags
2659
+ # Get all inbox tags
2660
+ # @param [Hash] opts the optional parameters
2661
+ # @option opts [Integer] :page Optional page index in list pagination
2662
+ # @option opts [Integer] :size Optional page size in list pagination
2663
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2664
+ # @option opts [String] :search_filter Optional search filter
2665
+ # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
2666
+ def get_inbox_tags_with_http_info(opts = {})
2667
+ if @api_client.config.debugging
2668
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags ...'
2669
+ end
2670
+ allowable_values = ["ASC", "DESC"]
2671
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2672
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2673
+ end
2674
+ # resource path
2675
+ local_var_path = '/inboxes/tags'
2676
+
2677
+ # query parameters
2678
+ query_params = opts[:query_params] || {}
2679
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2680
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2681
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2682
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2683
+
2684
+ # header parameters
2685
+ header_params = opts[:header_params] || {}
2686
+ # HTTP header 'Accept' (if needed)
2687
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2688
+
2689
+ # form parameters
2690
+ form_params = opts[:form_params] || {}
2691
+
2692
+ # http body (model)
2693
+ post_body = opts[:body]
2694
+
2695
+ # return_type
2696
+ return_type = opts[:return_type] || 'Array<String>'
2697
+
2698
+ # auth_names
2699
+ auth_names = opts[:auth_names] || ['API_KEY']
2700
+
2701
+ new_options = opts.merge(
2702
+ :header_params => header_params,
2703
+ :query_params => query_params,
2704
+ :form_params => form_params,
2705
+ :body => post_body,
2706
+ :auth_names => auth_names,
2707
+ :return_type => return_type
2708
+ )
2709
+
2710
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2711
+ if @api_client.config.debugging
2712
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2713
+ end
2714
+ return data, status_code, headers
2715
+ end
2716
+
2717
+ # Get inbox tags paginated
2718
+ # Get all inbox tags paginated
2719
+ # @param [Hash] opts the optional parameters
2720
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
2721
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
2722
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2723
+ # @option opts [String] :search_filter Optional search filter
2724
+ # @return [PageInboxTags]
2725
+ def get_inbox_tags_paginated(opts = {})
2726
+ data, _status_code, _headers = get_inbox_tags_paginated_with_http_info(opts)
2727
+ data
2728
+ end
2729
+
2730
+ # Get inbox tags paginated
2731
+ # Get all inbox tags paginated
2732
+ # @param [Hash] opts the optional parameters
2733
+ # @option opts [Integer] :page Optional page index in list pagination
2734
+ # @option opts [Integer] :size Optional page size in list pagination
2735
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2736
+ # @option opts [String] :search_filter Optional search filter
2737
+ # @return [Array<(PageInboxTags, Integer, Hash)>] PageInboxTags data, response status code and response headers
2738
+ def get_inbox_tags_paginated_with_http_info(opts = {})
2739
+ if @api_client.config.debugging
2740
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags_paginated ...'
2741
+ end
2742
+ allowable_values = ["ASC", "DESC"]
2743
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2744
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2745
+ end
2746
+ # resource path
2747
+ local_var_path = '/inboxes/tags/paginated'
2748
+
2749
+ # query parameters
2750
+ query_params = opts[:query_params] || {}
2751
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2752
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2753
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2754
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2755
+
2756
+ # header parameters
2757
+ header_params = opts[:header_params] || {}
2758
+ # HTTP header 'Accept' (if needed)
2759
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2760
+
2761
+ # form parameters
2762
+ form_params = opts[:form_params] || {}
2763
+
2764
+ # http body (model)
2765
+ post_body = opts[:body]
2766
+
2767
+ # return_type
2768
+ return_type = opts[:return_type] || 'PageInboxTags'
2769
+
2770
+ # auth_names
2771
+ auth_names = opts[:auth_names] || ['API_KEY']
2772
+
2773
+ new_options = opts.merge(
2774
+ :header_params => header_params,
2775
+ :query_params => query_params,
2776
+ :form_params => form_params,
2777
+ :body => post_body,
2778
+ :auth_names => auth_names,
2779
+ :return_type => return_type
2780
+ )
2781
+
2782
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2783
+ if @api_client.config.debugging
2784
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2785
+ end
2786
+ return data, status_code, headers
2787
+ end
2788
+
2789
+ # List Inboxes and email addresses
2790
+ # List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
2791
+ # @param [Hash] opts the optional parameters
2792
+ # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
2793
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2794
+ # @option opts [DateTime] :since Optional filter by created after given date time
2795
+ # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
2796
+ # @option opts [DateTime] :before Optional filter by created before given date time
2797
+ # @option opts [Array<String>] :include Optional inboxIds to include in result
2798
+ # @return [Array<InboxDto>]
2799
+ def get_inboxes(opts = {})
2800
+ data, _status_code, _headers = get_inboxes_with_http_info(opts)
2801
+ data
2802
+ end
2803
+
2804
+ # List Inboxes and email addresses
2805
+ # List the inboxes you have created. Note use of the more advanced &#x60;getAllInboxes&#x60; is recommended and allows paginated access using a limit and sort parameter.
2806
+ # @param [Hash] opts the optional parameters
2807
+ # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
2808
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2809
+ # @option opts [DateTime] :since Optional filter by created after given date time
2810
+ # @option opts [Boolean] :exclude_catch_all_inboxes Optional exclude catch all inboxes
2811
+ # @option opts [DateTime] :before Optional filter by created before given date time
2812
+ # @option opts [Array<String>] :include Optional inboxIds to include in result
2813
+ # @return [Array<(Array<InboxDto>, Integer, Hash)>] Array<InboxDto> data, response status code and response headers
2814
+ def get_inboxes_with_http_info(opts = {})
2815
+ if @api_client.config.debugging
2816
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
2817
+ end
2818
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
2819
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_inboxes, must be smaller than or equal to 100.'
2820
+ end
2821
+
2822
+ allowable_values = ["ASC", "DESC"]
2823
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2824
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2825
+ end
2826
+ # resource path
2827
+ local_var_path = '/inboxes'
2828
+
2829
+ # query parameters
2830
+ query_params = opts[:query_params] || {}
2831
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2832
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2833
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2834
+ query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil?
2835
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2836
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
2837
+
2838
+ # header parameters
2839
+ header_params = opts[:header_params] || {}
2840
+ # HTTP header 'Accept' (if needed)
2841
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2842
+
2843
+ # form parameters
2844
+ form_params = opts[:form_params] || {}
2845
+
2846
+ # http body (model)
2847
+ post_body = opts[:body]
2848
+
2849
+ # return_type
2850
+ return_type = opts[:return_type] || 'Array<InboxDto>'
2851
+
2852
+ # auth_names
2853
+ auth_names = opts[:auth_names] || ['API_KEY']
2854
+
2855
+ new_options = opts.merge(
2856
+ :header_params => header_params,
2857
+ :query_params => query_params,
2858
+ :form_params => form_params,
2859
+ :body => post_body,
2860
+ :auth_names => auth_names,
2861
+ :return_type => return_type
2862
+ )
2863
+
2864
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2865
+ if @api_client.config.debugging
2866
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2867
+ end
2868
+ return data, status_code, headers
2869
+ end
2870
+
2871
+ # Get inboxes for a tag
2872
+ # Get all inboxes for a given inbox tag
2873
+ # @param tag [String] Tag to filter by
2874
+ # @param [Hash] opts the optional parameters
2875
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
2876
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
2877
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2878
+ # @option opts [String] :search_filter Optional search filter
2879
+ # @return [PageInboxProjection]
2880
+ def get_inboxes_by_tag(tag, opts = {})
2881
+ data, _status_code, _headers = get_inboxes_by_tag_with_http_info(tag, opts)
2882
+ data
2883
+ end
2884
+
2885
+ # Get inboxes for a tag
2886
+ # Get all inboxes for a given inbox tag
2887
+ # @param tag [String] Tag to filter by
2888
+ # @param [Hash] opts the optional parameters
2889
+ # @option opts [Integer] :page Optional page index in list pagination
2890
+ # @option opts [Integer] :size Optional page size in list pagination
2891
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2892
+ # @option opts [String] :search_filter Optional search filter
2893
+ # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
2894
+ def get_inboxes_by_tag_with_http_info(tag, opts = {})
2895
+ if @api_client.config.debugging
2896
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes_by_tag ...'
2897
+ end
2898
+ # verify the required parameter 'tag' is set
2899
+ if @api_client.config.client_side_validation && tag.nil?
2900
+ fail ArgumentError, "Missing the required parameter 'tag' when calling InboxControllerApi.get_inboxes_by_tag"
2901
+ end
2902
+ allowable_values = ["ASC", "DESC"]
2903
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2904
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2905
+ end
2906
+ # resource path
2907
+ local_var_path = '/inboxes/tags/inboxes'
2908
+
2909
+ # query parameters
2910
+ query_params = opts[:query_params] || {}
2911
+ query_params[:'tag'] = tag
2912
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2913
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2914
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2915
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2916
+
2917
+ # header parameters
2918
+ header_params = opts[:header_params] || {}
2919
+ # HTTP header 'Accept' (if needed)
2920
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2921
+
2922
+ # form parameters
2923
+ form_params = opts[:form_params] || {}
2924
+
2925
+ # http body (model)
2926
+ post_body = opts[:body]
2927
+
2928
+ # return_type
2929
+ return_type = opts[:return_type] || 'PageInboxProjection'
2930
+
2931
+ # auth_names
2932
+ auth_names = opts[:auth_names] || ['API_KEY']
2933
+
2934
+ new_options = opts.merge(
2935
+ :header_params => header_params,
2936
+ :query_params => query_params,
2937
+ :form_params => form_params,
2938
+ :body => post_body,
2939
+ :auth_names => auth_names,
2940
+ :return_type => return_type
2941
+ )
2942
+
2943
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2944
+ if @api_client.config.debugging
2945
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2946
+ end
2947
+ return data, status_code, headers
2948
+ end
2949
+
2950
+ # Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
2951
+ # Get the newest email in an inbox or wait for one to arrive
2952
+ # @param inbox_id [String] ID of the inbox you want to get the latest email from
2953
+ # @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
2954
+ # @param [Hash] opts the optional parameters
2955
+ # @return [Email]
2956
+ def get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {})
2957
+ data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts)
2958
+ data
2959
+ end
2960
+
2961
+ # Get latest email in an inbox. Use &#x60;WaitForController&#x60; to get emails that may not have arrived yet.
2962
+ # Get the newest email in an inbox or wait for one to arrive
2963
+ # @param inbox_id [String] ID of the inbox you want to get the latest email from
2964
+ # @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
2965
+ # @param [Hash] opts the optional parameters
2966
+ # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
2967
+ def get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {})
2968
+ if @api_client.config.debugging
2969
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_latest_email_in_inbox ...'
2970
+ end
2971
+ # verify the required parameter 'inbox_id' is set
2972
+ if @api_client.config.client_side_validation && inbox_id.nil?
2973
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_latest_email_in_inbox"
2974
+ end
2975
+ # verify the required parameter 'timeout_millis' is set
2976
+ if @api_client.config.client_side_validation && timeout_millis.nil?
2977
+ fail ArgumentError, "Missing the required parameter 'timeout_millis' when calling InboxControllerApi.get_latest_email_in_inbox"
2978
+ end
2979
+ # resource path
2980
+ local_var_path = '/inboxes/getLatestEmail'
2981
+
2982
+ # query parameters
2983
+ query_params = opts[:query_params] || {}
2984
+ query_params[:'inboxId'] = inbox_id
2985
+ query_params[:'timeoutMillis'] = timeout_millis
2986
+
2987
+ # header parameters
2988
+ header_params = opts[:header_params] || {}
2989
+ # HTTP header 'Accept' (if needed)
2990
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2991
+
2992
+ # form parameters
2993
+ form_params = opts[:form_params] || {}
2994
+
2995
+ # http body (model)
2996
+ post_body = opts[:body]
2997
+
2998
+ # return_type
2999
+ return_type = opts[:return_type] || 'Email'
3000
+
3001
+ # auth_names
3002
+ auth_names = opts[:auth_names] || ['API_KEY']
3003
+
3004
+ new_options = opts.merge(
3005
+ :header_params => header_params,
3006
+ :query_params => query_params,
3007
+ :form_params => form_params,
3008
+ :body => post_body,
3009
+ :auth_names => auth_names,
3010
+ :return_type => return_type
3011
+ )
3012
+
3013
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3014
+ if @api_client.config.debugging
3015
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_latest_email_in_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3016
+ end
3017
+ return data, status_code, headers
3018
+ end
3019
+
3020
+ # List Organization Inboxes Paginated
3021
+ # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
3022
+ # @param [Hash] opts the optional parameters
3023
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
3024
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
3025
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
3026
+ # @option opts [String] :search_filter Optional search filter
3027
+ # @option opts [DateTime] :since Optional filter by created after given date time
3028
+ # @option opts [DateTime] :before Optional filter by created before given date time
3029
+ # @return [PageOrganizationInboxProjection]
3030
+ def get_organization_inboxes(opts = {})
3031
+ data, _status_code, _headers = get_organization_inboxes_with_http_info(opts)
3032
+ data
3033
+ end
3034
+
3035
+ # List Organization Inboxes Paginated
3036
+ # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
3037
+ # @param [Hash] opts the optional parameters
3038
+ # @option opts [Integer] :page Optional page index in list pagination
3039
+ # @option opts [Integer] :size Optional page size in list pagination
3040
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2296
3041
  # @option opts [String] :search_filter Optional search filter
2297
3042
  # @option opts [DateTime] :since Optional filter by created after given date time
2298
3043
  # @option opts [DateTime] :before Optional filter by created before given date time
@@ -2350,6 +3095,75 @@ module MailSlurpClient
2350
3095
  return data, status_code, headers
2351
3096
  end
2352
3097
 
3098
+ # List all inboxes with sent emails
3099
+ # List inboxes that have sent emails
3100
+ # @param [Hash] opts the optional parameters
3101
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
3102
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
3103
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
3104
+ # @return [PageInboxProjection]
3105
+ def get_outboxes(opts = {})
3106
+ data, _status_code, _headers = get_outboxes_with_http_info(opts)
3107
+ data
3108
+ end
3109
+
3110
+ # List all inboxes with sent emails
3111
+ # List inboxes that have sent emails
3112
+ # @param [Hash] opts the optional parameters
3113
+ # @option opts [Integer] :page Optional page index in list pagination
3114
+ # @option opts [Integer] :size Optional page size in list pagination
3115
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
3116
+ # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
3117
+ def get_outboxes_with_http_info(opts = {})
3118
+ if @api_client.config.debugging
3119
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_outboxes ...'
3120
+ end
3121
+ allowable_values = ["ASC", "DESC"]
3122
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
3123
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
3124
+ end
3125
+ # resource path
3126
+ local_var_path = '/inboxes/outboxes'
3127
+
3128
+ # query parameters
3129
+ query_params = opts[:query_params] || {}
3130
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
3131
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
3132
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
3133
+
3134
+ # header parameters
3135
+ header_params = opts[:header_params] || {}
3136
+ # HTTP header 'Accept' (if needed)
3137
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
3138
+
3139
+ # form parameters
3140
+ form_params = opts[:form_params] || {}
3141
+
3142
+ # http body (model)
3143
+ post_body = opts[:body]
3144
+
3145
+ # return_type
3146
+ return_type = opts[:return_type] || 'PageInboxProjection'
3147
+
3148
+ # auth_names
3149
+ auth_names = opts[:auth_names] || ['API_KEY']
3150
+
3151
+ new_options = opts.merge(
3152
+ :header_params => header_params,
3153
+ :query_params => query_params,
3154
+ :form_params => form_params,
3155
+ :body => post_body,
3156
+ :auth_names => auth_names,
3157
+ :return_type => return_type
3158
+ )
3159
+
3160
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3161
+ if @api_client.config.debugging
3162
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_outboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3163
+ end
3164
+ return data, status_code, headers
3165
+ end
3166
+
2353
3167
  # Get a scheduled email job
2354
3168
  # Get a scheduled email job details.
2355
3169
  # @param job_id [String]
@@ -3268,7 +4082,7 @@ module MailSlurpClient
3268
4082
  end
3269
4083
 
3270
4084
  # Set inbox favourited state
3271
- # Set and return new favourite state for an inbox
4085
+ # Set and return new favorite state for an inbox
3272
4086
  # @param inbox_id [String] ID of inbox to set favourite state
3273
4087
  # @param set_inbox_favourited_options [SetInboxFavouritedOptions]
3274
4088
  # @param [Hash] opts the optional parameters
@@ -3279,7 +4093,7 @@ module MailSlurpClient
3279
4093
  end
3280
4094
 
3281
4095
  # Set inbox favourited state
3282
- # Set and return new favourite state for an inbox
4096
+ # Set and return new favorite state for an inbox
3283
4097
  # @param inbox_id [String] ID of inbox to set favourite state
3284
4098
  # @param set_inbox_favourited_options [SetInboxFavouritedOptions]
3285
4099
  # @param [Hash] opts the optional parameters