mailslurp_client 15.19.22 → 15.20.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 (385) 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 +22 -6
  6. data/lib/mailslurp_client/api/bounce_controller_api.rb +1 -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 +886 -126
  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/phone_controller_api.rb +675 -1
  28. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
  29. data/lib/mailslurp_client/api/sms_controller_api.rb +494 -44
  30. data/lib/mailslurp_client/api/sse_controller_api.rb +81 -0
  31. data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
  32. data/lib/mailslurp_client/api/tools_controller_api.rb +192 -1
  33. data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
  34. data/lib/mailslurp_client/api/user_controller_api.rb +1 -1
  35. data/lib/mailslurp_client/api/wait_for_controller_api.rb +1 -1
  36. data/lib/mailslurp_client/api/webhook_controller_api.rb +274 -12
  37. data/lib/mailslurp_client/api_client.rb +1 -1
  38. data/lib/mailslurp_client/api_error.rb +1 -1
  39. data/lib/mailslurp_client/configuration.rb +1 -1
  40. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
  41. data/lib/mailslurp_client/models/account_bounce_block_dto.rb +16 -2
  42. data/lib/mailslurp_client/models/alias_dto.rb +1 -1
  43. data/lib/mailslurp_client/models/alias_projection.rb +20 -20
  44. data/lib/mailslurp_client/models/{thread_projection.rb → alias_thread_projection.rb} +42 -42
  45. data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_entity_dto.rb} +26 -14
  46. data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
  47. data/lib/mailslurp_client/models/attachment_projection.rb +27 -2
  48. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  49. data/lib/mailslurp_client/models/bounce_projection.rb +12 -12
  50. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +1 -1
  51. data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
  52. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
  53. data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
  54. data/lib/mailslurp_client/models/can_send_email_results.rb +1 -1
  55. data/lib/mailslurp_client/models/check_email_body_feature_support_results.rb +1 -1
  56. data/lib/mailslurp_client/models/check_email_body_results.rb +1 -1
  57. data/lib/mailslurp_client/models/check_email_client_support_options.rb +1 -1
  58. data/lib/mailslurp_client/models/check_email_client_support_results.rb +1 -1
  59. data/lib/mailslurp_client/models/check_email_features_client_support_options.rb +1 -1
  60. data/lib/mailslurp_client/models/check_email_features_client_support_results.rb +1 -1
  61. data/lib/mailslurp_client/models/complaint.rb +1 -1
  62. data/lib/mailslurp_client/models/condition_option.rb +1 -1
  63. data/lib/mailslurp_client/models/connector_dto.rb +12 -98
  64. data/lib/mailslurp_client/models/connector_event_dto.rb +354 -0
  65. data/lib/mailslurp_client/models/{connector_sync_event_projection.rb → connector_event_projection.rb} +72 -37
  66. data/lib/mailslurp_client/models/connector_imap_connection_dto.rb +83 -2
  67. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause.rb → connector_imap_connection_test_result.rb} +33 -19
  68. data/lib/mailslurp_client/models/connector_projection.rb +22 -83
  69. data/lib/mailslurp_client/models/connector_provider_settings_dto.rb +225 -0
  70. data/lib/mailslurp_client/models/connector_smtp_connection_dto.rb +96 -2
  71. data/lib/mailslurp_client/models/{connector_sync_request_result_exception.rb → connector_smtp_connection_test_result.rb} +29 -35
  72. data/lib/mailslurp_client/models/connector_sync_request_result.rb +2 -2
  73. data/lib/mailslurp_client/models/connector_sync_result.rb +20 -9
  74. data/lib/mailslurp_client/models/{connector_sync_event_dto.rb → connector_sync_settings_dto.rb} +50 -53
  75. data/lib/mailslurp_client/models/consent_status_dto.rb +211 -0
  76. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  77. data/lib/mailslurp_client/models/contact_projection.rb +1 -1
  78. data/lib/mailslurp_client/models/content_match_options.rb +1 -1
  79. data/lib/mailslurp_client/models/count_dto.rb +1 -1
  80. data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
  81. data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb +93 -7
  82. data/lib/mailslurp_client/models/create_connector_options.rb +2 -69
  83. data/lib/mailslurp_client/models/create_connector_smtp_connection_options.rb +94 -5
  84. data/lib/mailslurp_client/models/create_connector_sync_settings_options.rb +265 -0
  85. data/lib/mailslurp_client/models/create_connector_with_options.rb +239 -0
  86. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  87. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  88. data/lib/mailslurp_client/models/create_emergency_address_options.rb +1 -1
  89. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  90. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  91. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
  92. data/lib/mailslurp_client/models/create_inbox_replier_options.rb +2 -6
  93. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
  94. data/lib/mailslurp_client/models/create_portal_options.rb +233 -0
  95. data/lib/mailslurp_client/models/create_portal_user_options.rb +251 -0
  96. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  97. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
  98. data/lib/mailslurp_client/models/create_webhook_options.rb +21 -8
  99. data/lib/mailslurp_client/models/delivery_status_dto.rb +1 -1
  100. data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
  101. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
  102. data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
  103. data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
  104. data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
  105. data/lib/mailslurp_client/models/dns_lookups_options.rb +1 -1
  106. data/lib/mailslurp_client/models/domain_dto.rb +1 -1
  107. data/lib/mailslurp_client/models/domain_group.rb +1 -1
  108. data/lib/mailslurp_client/models/domain_groups_dto.rb +1 -1
  109. data/lib/mailslurp_client/models/domain_information.rb +1 -1
  110. data/lib/mailslurp_client/models/domain_issues_dto.rb +1 -1
  111. data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
  112. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  113. data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
  114. data/lib/mailslurp_client/models/email.rb +57 -2
  115. data/lib/mailslurp_client/models/email_analysis.rb +1 -1
  116. data/lib/mailslurp_client/models/email_available_result.rb +1 -1
  117. data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
  118. data/lib/mailslurp_client/models/email_content_part_result.rb +1 -1
  119. data/lib/mailslurp_client/models/email_feature_category_name.rb +1 -1
  120. data/lib/mailslurp_client/models/email_feature_family_name.rb +1 -1
  121. data/lib/mailslurp_client/models/email_feature_family_statistics.rb +1 -1
  122. data/lib/mailslurp_client/models/email_feature_names.rb +1 -1
  123. data/lib/mailslurp_client/models/email_feature_overview.rb +1 -1
  124. data/lib/mailslurp_client/models/email_feature_platform_name.rb +1 -1
  125. data/lib/mailslurp_client/models/email_feature_platform_statistics.rb +1 -1
  126. data/lib/mailslurp_client/models/email_feature_support_flags.rb +1 -1
  127. data/lib/mailslurp_client/models/email_feature_support_result.rb +1 -1
  128. data/lib/mailslurp_client/models/email_feature_support_status_percentage.rb +1 -1
  129. data/lib/mailslurp_client/models/email_feature_version_statistics.rb +1 -1
  130. data/lib/mailslurp_client/models/email_html_dto.rb +1 -1
  131. data/lib/mailslurp_client/models/email_links_result.rb +1 -1
  132. data/lib/mailslurp_client/models/email_preview.rb +102 -6
  133. data/lib/mailslurp_client/models/email_preview_urls.rb +1 -1
  134. data/lib/mailslurp_client/models/email_projection.rb +123 -41
  135. data/lib/mailslurp_client/models/email_recipients.rb +1 -1
  136. data/lib/mailslurp_client/models/email_recipients_projection.rb +231 -0
  137. data/lib/mailslurp_client/models/email_screenshot_result.rb +1 -1
  138. data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
  139. data/lib/mailslurp_client/models/email_thread_dto.rb +348 -0
  140. data/lib/mailslurp_client/models/email_thread_item.rb +429 -0
  141. data/lib/mailslurp_client/models/email_thread_items_dto.rb +213 -0
  142. data/lib/mailslurp_client/models/email_thread_projection.rb +441 -0
  143. data/lib/mailslurp_client/models/email_validation_request_dto.rb +1 -1
  144. data/lib/mailslurp_client/models/email_verification_result.rb +1 -1
  145. data/lib/mailslurp_client/models/emergency_address.rb +6 -1
  146. data/lib/mailslurp_client/models/emergency_address_dto.rb +1 -1
  147. data/lib/mailslurp_client/models/empty_response_dto.rb +1 -1
  148. data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
  149. data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
  150. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +16 -16
  151. data/lib/mailslurp_client/models/export_link.rb +1 -1
  152. data/lib/mailslurp_client/models/export_options.rb +1 -1
  153. data/lib/mailslurp_client/models/fake_email_dto.rb +49 -5
  154. data/lib/mailslurp_client/models/fake_email_preview.rb +16 -2
  155. data/lib/mailslurp_client/models/fake_email_result.rb +1 -1
  156. data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb +1 -1
  157. data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb +1 -1
  158. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +1 -1
  159. data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
  160. data/lib/mailslurp_client/models/generate_bimi_record_options.rb +1 -1
  161. data/lib/mailslurp_client/models/generate_bimi_record_results.rb +1 -1
  162. data/lib/mailslurp_client/models/generate_dmarc_record_options.rb +1 -1
  163. data/lib/mailslurp_client/models/generate_dmarc_record_results.rb +1 -1
  164. data/lib/mailslurp_client/models/generate_mta_sts_record_options.rb +1 -1
  165. data/lib/mailslurp_client/models/generate_mta_sts_record_results.rb +1 -1
  166. data/lib/mailslurp_client/models/generate_tls_reporting_record_options.rb +1 -1
  167. data/lib/mailslurp_client/models/generate_tls_reporting_record_results.rb +1 -1
  168. data/lib/mailslurp_client/models/get_email_screenshot_options.rb +1 -1
  169. data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
  170. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  171. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  172. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  173. data/lib/mailslurp_client/models/guest_portal_dto.rb +303 -0
  174. data/lib/mailslurp_client/models/guest_portal_user_create_dto.rb +225 -0
  175. data/lib/mailslurp_client/models/guest_portal_user_dto.rb +322 -0
  176. data/lib/mailslurp_client/models/guest_portal_user_projection.rb +309 -0
  177. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  178. data/lib/mailslurp_client/models/image_issue.rb +1 -1
  179. data/lib/mailslurp_client/models/imap_access_details.rb +1 -1
  180. data/lib/mailslurp_client/models/imap_email_projection.rb +1 -1
  181. data/lib/mailslurp_client/models/imap_flag_operation_options.rb +1 -1
  182. data/lib/mailslurp_client/models/imap_mailbox_status.rb +1 -1
  183. data/lib/mailslurp_client/models/imap_server_fetch_item.rb +1 -1
  184. data/lib/mailslurp_client/models/imap_server_fetch_result.rb +1 -1
  185. data/lib/mailslurp_client/models/imap_server_get_result.rb +1 -1
  186. data/lib/mailslurp_client/models/imap_server_list_options.rb +1 -1
  187. data/lib/mailslurp_client/models/imap_server_list_result.rb +1 -1
  188. data/lib/mailslurp_client/models/imap_server_mailbox_result.rb +1 -1
  189. data/lib/mailslurp_client/models/imap_server_search_options.rb +1 -1
  190. data/lib/mailslurp_client/models/imap_server_search_result.rb +1 -1
  191. data/lib/mailslurp_client/models/imap_server_status_options.rb +1 -1
  192. data/lib/mailslurp_client/models/imap_server_status_result.rb +1 -1
  193. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +17 -2
  194. data/lib/mailslurp_client/models/imap_smtp_access_servers.rb +1 -1
  195. data/lib/mailslurp_client/models/imap_update_flags_options.rb +1 -1
  196. data/lib/mailslurp_client/models/inbox_by_email_address_result.rb +1 -1
  197. data/lib/mailslurp_client/models/inbox_by_name_result.rb +1 -1
  198. data/lib/mailslurp_client/models/inbox_dto.rb +54 -9
  199. data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
  200. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +2 -6
  201. data/lib/mailslurp_client/models/inbox_forwarder_event_dto.rb +12 -2
  202. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +19 -9
  203. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  204. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
  205. data/lib/mailslurp_client/models/inbox_id_item.rb +1 -1
  206. data/lib/mailslurp_client/models/inbox_ids_result.rb +1 -1
  207. data/lib/mailslurp_client/models/inbox_preview.rb +54 -9
  208. data/lib/mailslurp_client/models/inbox_replier_dto.rb +2 -6
  209. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +22 -22
  210. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
  211. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  212. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
  213. data/lib/mailslurp_client/models/inline_object.rb +2 -12
  214. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  215. data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
  216. data/lib/mailslurp_client/models/link_issue.rb +1 -1
  217. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +1 -1
  218. data/lib/mailslurp_client/models/lookup_bimi_domain_options.rb +1 -1
  219. data/lib/mailslurp_client/models/lookup_bimi_domain_results.rb +1 -1
  220. data/lib/mailslurp_client/models/lookup_dmarc_domain_options.rb +1 -1
  221. data/lib/mailslurp_client/models/lookup_dmarc_domain_results.rb +1 -1
  222. data/lib/mailslurp_client/models/lookup_mta_sts_domain_options.rb +1 -1
  223. data/lib/mailslurp_client/models/lookup_mta_sts_domain_results.rb +1 -1
  224. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_options.rb +1 -1
  225. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_results.rb +1 -1
  226. data/lib/mailslurp_client/models/match_option.rb +1 -1
  227. data/lib/mailslurp_client/models/match_options.rb +1 -1
  228. data/lib/mailslurp_client/models/missed_email_dto.rb +1 -1
  229. data/lib/mailslurp_client/models/missed_email_projection.rb +12 -12
  230. data/lib/mailslurp_client/models/name_server_record.rb +1 -1
  231. data/lib/mailslurp_client/models/new_fake_email_address_result.rb +1 -1
  232. data/lib/mailslurp_client/models/opt_in_consent_options.rb +229 -0
  233. data/lib/mailslurp_client/models/opt_in_consent_send_result.rb +211 -0
  234. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause_stack_trace.rb → opt_in_identity_projection.rb} +54 -61
  235. data/lib/mailslurp_client/models/opt_in_sending_consent_dto.rb +239 -0
  236. data/lib/mailslurp_client/models/optional_connector_dto.rb +220 -0
  237. data/lib/mailslurp_client/models/optional_connector_imap_connection_dto.rb +220 -0
  238. data/lib/mailslurp_client/models/optional_connector_smtp_connection_dto.rb +220 -0
  239. data/lib/mailslurp_client/models/optional_connector_sync_settings_dto.rb +220 -0
  240. data/lib/mailslurp_client/models/organization_inbox_projection.rb +68 -8
  241. data/lib/mailslurp_client/models/page_alias.rb +16 -16
  242. data/lib/mailslurp_client/models/{page_connector_sync_events.rb → page_alias_thread_projection.rb} +21 -21
  243. data/lib/mailslurp_client/models/page_attachment_entity.rb +16 -16
  244. data/lib/mailslurp_client/models/page_bounced_email.rb +16 -16
  245. data/lib/mailslurp_client/models/page_bounced_recipients.rb +16 -16
  246. data/lib/mailslurp_client/models/page_complaint.rb +16 -16
  247. data/lib/mailslurp_client/models/page_connector.rb +16 -16
  248. data/lib/mailslurp_client/models/page_connector_events.rb +309 -0
  249. data/lib/mailslurp_client/models/page_contact_projection.rb +16 -16
  250. data/lib/mailslurp_client/models/page_delivery_status.rb +16 -16
  251. data/lib/mailslurp_client/models/page_email_preview.rb +16 -16
  252. data/lib/mailslurp_client/models/page_email_projection.rb +16 -16
  253. data/lib/mailslurp_client/models/page_email_thread_projection.rb +309 -0
  254. data/lib/mailslurp_client/models/page_email_validation_request.rb +16 -16
  255. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +16 -16
  256. data/lib/mailslurp_client/models/page_group_projection.rb +16 -16
  257. data/lib/mailslurp_client/models/{page_thread_projection.rb → page_guest_portal_users.rb} +21 -21
  258. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +16 -16
  259. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +16 -16
  260. data/lib/mailslurp_client/models/page_inbox_projection.rb +16 -16
  261. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +16 -16
  262. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +16 -16
  263. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +16 -16
  264. data/lib/mailslurp_client/models/page_inbox_tags.rb +309 -0
  265. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +16 -16
  266. data/lib/mailslurp_client/models/page_missed_email_projection.rb +16 -16
  267. data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +309 -0
  268. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +16 -16
  269. data/lib/mailslurp_client/models/page_phone_number_projection.rb +16 -16
  270. data/lib/mailslurp_client/models/page_plus_address_projection.rb +309 -0
  271. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +16 -16
  272. data/lib/mailslurp_client/models/page_sent_email_projection.rb +16 -16
  273. data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +16 -16
  274. data/lib/mailslurp_client/models/page_sent_sms_projection.rb +309 -0
  275. data/lib/mailslurp_client/models/page_sms_projection.rb +16 -16
  276. data/lib/mailslurp_client/models/page_template_projection.rb +16 -16
  277. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +16 -16
  278. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +16 -16
  279. data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +309 -0
  280. data/lib/mailslurp_client/models/page_webhook_projection.rb +16 -16
  281. data/lib/mailslurp_client/models/page_webhook_result.rb +16 -16
  282. data/lib/mailslurp_client/models/pageable_object.rb +20 -20
  283. data/lib/mailslurp_client/models/phone_number_dto.rb +37 -5
  284. data/lib/mailslurp_client/models/phone_number_projection.rb +11 -2
  285. data/lib/mailslurp_client/models/phone_number_validation_dto.rb +254 -0
  286. data/lib/mailslurp_client/models/phone_plan_availability.rb +213 -0
  287. data/lib/mailslurp_client/models/phone_plan_availability_item.rb +271 -0
  288. data/lib/mailslurp_client/models/phone_plan_dto.rb +1 -1
  289. data/lib/mailslurp_client/models/plus_address_dto.rb +295 -0
  290. data/lib/mailslurp_client/models/plus_address_projection.rb +295 -0
  291. data/lib/mailslurp_client/models/provider_settings.rb +347 -0
  292. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  293. data/lib/mailslurp_client/models/recipient.rb +1 -1
  294. data/lib/mailslurp_client/models/recipient_projection.rb +234 -0
  295. data/lib/mailslurp_client/models/reply_for_sms.rb +1 -1
  296. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
  297. data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
  298. data/lib/mailslurp_client/models/scheduled_job.rb +1 -1
  299. data/lib/mailslurp_client/models/scheduled_job_dto.rb +1 -1
  300. data/lib/mailslurp_client/models/search_emails_options.rb +1 -1
  301. data/lib/mailslurp_client/models/search_inboxes_options.rb +3 -3
  302. data/lib/mailslurp_client/models/send_email_body_part.rb +1 -1
  303. data/lib/mailslurp_client/models/send_email_options.rb +13 -2
  304. data/lib/mailslurp_client/models/send_opt_in_consent_email_options.rb +234 -0
  305. data/lib/mailslurp_client/models/send_smtp_envelope_options.rb +1 -1
  306. data/lib/mailslurp_client/models/send_with_queue_result.rb +1 -1
  307. data/lib/mailslurp_client/models/sender.rb +1 -1
  308. data/lib/mailslurp_client/models/sender_projection.rb +235 -0
  309. data/lib/mailslurp_client/models/sent_email_dto.rb +92 -2
  310. data/lib/mailslurp_client/models/sent_email_projection.rb +110 -41
  311. data/lib/mailslurp_client/models/sent_sms_dto.rb +1 -11
  312. data/lib/mailslurp_client/models/sent_sms_projection.rb +305 -0
  313. data/lib/mailslurp_client/models/server_endpoints.rb +1 -1
  314. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  315. data/lib/mailslurp_client/models/set_phone_favourited_options.rb +213 -0
  316. data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
  317. data/lib/mailslurp_client/models/sms_dto.rb +25 -2
  318. data/lib/mailslurp_client/models/sms_match_option.rb +1 -1
  319. data/lib/mailslurp_client/models/sms_preview.rb +1 -1
  320. data/lib/mailslurp_client/models/sms_projection.rb +1 -1
  321. data/lib/mailslurp_client/models/sms_reply_options.rb +1 -1
  322. data/lib/mailslurp_client/models/sms_send_options.rb +225 -0
  323. data/lib/mailslurp_client/models/smtp_access_details.rb +1 -1
  324. data/lib/mailslurp_client/models/sort_object.rb +1 -1
  325. data/lib/mailslurp_client/models/spelling_issue.rb +1 -1
  326. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  327. data/lib/mailslurp_client/models/template_preview.rb +1 -1
  328. data/lib/mailslurp_client/models/template_projection.rb +1 -1
  329. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  330. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_options.rb +1 -1
  331. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_result.rb +1 -1
  332. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_options.rb +1 -1
  333. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_result.rb +1 -1
  334. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  335. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  336. data/lib/mailslurp_client/models/test_phone_number_options.rb +1 -1
  337. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
  338. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +11 -11
  339. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +11 -11
  340. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  341. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
  342. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  343. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  344. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  345. data/lib/mailslurp_client/models/update_imap_access_options.rb +1 -1
  346. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  347. data/lib/mailslurp_client/models/update_inbox_replier_options.rb +1 -1
  348. data/lib/mailslurp_client/models/update_phone_number_options.rb +215 -0
  349. data/lib/mailslurp_client/models/update_smtp_access_options.rb +1 -1
  350. data/lib/mailslurp_client/models/upload_attachment_options.rb +1 -1
  351. data/lib/mailslurp_client/models/user_info_dto.rb +1 -1
  352. data/lib/mailslurp_client/models/validate_email_address_list_options.rb +1 -1
  353. data/lib/mailslurp_client/models/validate_email_address_list_result.rb +1 -1
  354. data/lib/mailslurp_client/models/validate_phone_number_options.rb +211 -0
  355. data/lib/mailslurp_client/models/validation_dto.rb +1 -1
  356. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  357. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  358. data/lib/mailslurp_client/models/verify_webhook_signature_options.rb +1 -1
  359. data/lib/mailslurp_client/models/verify_webhook_signature_results.rb +1 -1
  360. data/lib/mailslurp_client/models/wait_for_conditions.rb +1 -1
  361. data/lib/mailslurp_client/models/wait_for_single_sms_options.rb +1 -1
  362. data/lib/mailslurp_client/models/wait_for_sms_conditions.rb +1 -1
  363. data/lib/mailslurp_client/models/webhook_bounce_payload.rb +3 -3
  364. data/lib/mailslurp_client/models/webhook_bounce_recipient_payload.rb +3 -3
  365. data/lib/mailslurp_client/models/webhook_delivery_status_payload.rb +3 -3
  366. data/lib/mailslurp_client/models/webhook_dto.rb +31 -8
  367. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
  368. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +3 -3
  369. data/lib/mailslurp_client/models/webhook_endpoint_projection.rb +259 -0
  370. data/lib/mailslurp_client/models/webhook_header_name_value.rb +1 -1
  371. data/lib/mailslurp_client/models/webhook_headers.rb +1 -1
  372. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
  373. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
  374. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +3 -3
  375. data/lib/mailslurp_client/models/webhook_new_sms_payload.rb +3 -3
  376. data/lib/mailslurp_client/models/webhook_projection.rb +60 -7
  377. data/lib/mailslurp_client/models/webhook_redrive_all_result.rb +1 -1
  378. data/lib/mailslurp_client/models/webhook_redrive_result.rb +1 -1
  379. data/lib/mailslurp_client/models/webhook_result_dto.rb +3 -3
  380. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  381. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  382. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  383. data/lib/mailslurp_client/version.rb +2 -2
  384. data/lib/mailslurp_client.rb +58 -10
  385. metadata +59 -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
@@ -867,7 +867,6 @@ module MailSlurpClient
867
867
  # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
868
868
  # @param email_id [String]
869
869
  # @param [Hash] opts the optional parameters
870
- # @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (default to false)
871
870
  # @return [Email]
872
871
  def get_email(email_id, opts = {})
873
872
  data, _status_code, _headers = get_email_with_http_info(email_id, opts)
@@ -878,7 +877,6 @@ module MailSlurpClient
878
877
  # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
879
878
  # @param email_id [String]
880
879
  # @param [Hash] opts the optional parameters
881
- # @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
882
880
  # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
883
881
  def get_email_with_http_info(email_id, opts = {})
884
882
  if @api_client.config.debugging
@@ -893,12 +891,11 @@ module MailSlurpClient
893
891
 
894
892
  # query parameters
895
893
  query_params = opts[:query_params] || {}
896
- query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
897
894
 
898
895
  # header parameters
899
896
  header_params = opts[:header_params] || {}
900
897
  # HTTP header 'Accept' (if needed)
901
- header_params['Accept'] = @api_client.select_header_accept(['*/*'])
898
+ header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8', 'application/xml;charset=UTF-8', 'application/json; charset=UTF-8', 'application/xml; charset=UTF-8'])
902
899
 
903
900
  # form parameters
904
901
  form_params = opts[:form_params] || {}
@@ -1065,6 +1062,8 @@ module MailSlurpClient
1065
1062
  # @param email_id [String] ID of email to match against
1066
1063
  # @param content_type [String] Content type
1067
1064
  # @param [Hash] opts the optional parameters
1065
+ # @option opts [Boolean] :strict Strict content type match
1066
+ # @option opts [Integer] :index Index of content type part if multiple
1068
1067
  # @return [EmailContentPartResult]
1069
1068
  def get_email_content_part(email_id, content_type, opts = {})
1070
1069
  data, _status_code, _headers = get_email_content_part_with_http_info(email_id, content_type, opts)
@@ -1076,6 +1075,8 @@ module MailSlurpClient
1076
1075
  # @param email_id [String] ID of email to match against
1077
1076
  # @param content_type [String] Content type
1078
1077
  # @param [Hash] opts the optional parameters
1078
+ # @option opts [Boolean] :strict Strict content type match
1079
+ # @option opts [Integer] :index Index of content type part if multiple
1079
1080
  # @return [Array<(EmailContentPartResult, Integer, Hash)>] EmailContentPartResult data, response status code and response headers
1080
1081
  def get_email_content_part_with_http_info(email_id, content_type, opts = {})
1081
1082
  if @api_client.config.debugging
@@ -1095,11 +1096,13 @@ module MailSlurpClient
1095
1096
  # query parameters
1096
1097
  query_params = opts[:query_params] || {}
1097
1098
  query_params[:'contentType'] = content_type
1099
+ query_params[:'strict'] = opts[:'strict'] if !opts[:'strict'].nil?
1100
+ query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
1098
1101
 
1099
1102
  # header parameters
1100
1103
  header_params = opts[:header_params] || {}
1101
1104
  # HTTP header 'Accept' (if needed)
1102
- header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1105
+ header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8', 'application/xml;charset=UTF-8', 'application/json; charset=UTF-8', 'application/xml; charset=UTF-8'])
1103
1106
 
1104
1107
  # form parameters
1105
1108
  form_params = opts[:form_params] || {}
@@ -1129,6 +1132,81 @@ module MailSlurpClient
1129
1132
  return data, status_code, headers
1130
1133
  end
1131
1134
 
1135
+ # Get email content part by content type raw response
1136
+ # Get email body content parts from a multipart email message for a given content type and return as response
1137
+ # @param email_id [String] ID of email to match against
1138
+ # @param content_type [String] Content type
1139
+ # @param [Hash] opts the optional parameters
1140
+ # @option opts [Boolean] :strict Strict content type match
1141
+ # @option opts [Integer] :index Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message.
1142
+ # @return [String]
1143
+ def get_email_content_part_content(email_id, content_type, opts = {})
1144
+ data, _status_code, _headers = get_email_content_part_content_with_http_info(email_id, content_type, opts)
1145
+ data
1146
+ end
1147
+
1148
+ # Get email content part by content type raw response
1149
+ # Get email body content parts from a multipart email message for a given content type and return as response
1150
+ # @param email_id [String] ID of email to match against
1151
+ # @param content_type [String] Content type
1152
+ # @param [Hash] opts the optional parameters
1153
+ # @option opts [Boolean] :strict Strict content type match
1154
+ # @option opts [Integer] :index Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message.
1155
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1156
+ def get_email_content_part_content_with_http_info(email_id, content_type, opts = {})
1157
+ if @api_client.config.debugging
1158
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_content_part_content ...'
1159
+ end
1160
+ # verify the required parameter 'email_id' is set
1161
+ if @api_client.config.client_side_validation && email_id.nil?
1162
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_content_part_content"
1163
+ end
1164
+ # verify the required parameter 'content_type' is set
1165
+ if @api_client.config.client_side_validation && content_type.nil?
1166
+ fail ArgumentError, "Missing the required parameter 'content_type' when calling EmailControllerApi.get_email_content_part_content"
1167
+ end
1168
+ # resource path
1169
+ local_var_path = '/emails/{emailId}/contentPart/raw'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
1170
+
1171
+ # query parameters
1172
+ query_params = opts[:query_params] || {}
1173
+ query_params[:'contentType'] = content_type
1174
+ query_params[:'strict'] = opts[:'strict'] if !opts[:'strict'].nil?
1175
+ query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
1176
+
1177
+ # header parameters
1178
+ header_params = opts[:header_params] || {}
1179
+ # HTTP header 'Accept' (if needed)
1180
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1181
+
1182
+ # form parameters
1183
+ form_params = opts[:form_params] || {}
1184
+
1185
+ # http body (model)
1186
+ post_body = opts[:body]
1187
+
1188
+ # return_type
1189
+ return_type = opts[:return_type] || 'String'
1190
+
1191
+ # auth_names
1192
+ auth_names = opts[:auth_names] || ['API_KEY']
1193
+
1194
+ new_options = opts.merge(
1195
+ :header_params => header_params,
1196
+ :query_params => query_params,
1197
+ :form_params => form_params,
1198
+ :body => post_body,
1199
+ :auth_names => auth_names,
1200
+ :return_type => return_type
1201
+ )
1202
+
1203
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1204
+ if @api_client.config.debugging
1205
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_content_part_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1206
+ end
1207
+ return data, status_code, headers
1208
+ end
1209
+
1132
1210
  # Get email count
1133
1211
  # @param [Hash] opts the optional parameters
1134
1212
  # @option opts [String] :inbox_id
@@ -1190,7 +1268,6 @@ module MailSlurpClient
1190
1268
  # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method.
1191
1269
  # @param email_id [String]
1192
1270
  # @param [Hash] opts the optional parameters
1193
- # @option opts [Boolean] :decode (default to false)
1194
1271
  # @option opts [Boolean] :replace_cid_images (default to false)
1195
1272
  # @return [String]
1196
1273
  def get_email_html(email_id, opts = {})
@@ -1202,7 +1279,6 @@ module MailSlurpClient
1202
1279
  # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: &#x60;?apiKey&#x3D;xxx&#x60;. Returns content-type &#x60;text/html;charset&#x3D;utf-8&#x60; so you must call expecting that content response not JSON. For JSON response see the &#x60;getEmailHTMLJson&#x60; method.
1203
1280
  # @param email_id [String]
1204
1281
  # @param [Hash] opts the optional parameters
1205
- # @option opts [Boolean] :decode
1206
1282
  # @option opts [Boolean] :replace_cid_images
1207
1283
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1208
1284
  def get_email_html_with_http_info(email_id, opts = {})
@@ -1218,7 +1294,6 @@ module MailSlurpClient
1218
1294
 
1219
1295
  # query parameters
1220
1296
  query_params = opts[:query_params] || {}
1221
- query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
1222
1297
  query_params[:'replaceCidImages'] = opts[:'replace_cid_images'] if !opts[:'replace_cid_images'].nil?
1223
1298
 
1224
1299
  # header parameters
@@ -1258,7 +1333,6 @@ module MailSlurpClient
1258
1333
  # Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON.
1259
1334
  # @param email_id [String]
1260
1335
  # @param [Hash] opts the optional parameters
1261
- # @option opts [Boolean] :decode (default to false)
1262
1336
  # @option opts [Boolean] :replace_cid_images (default to false)
1263
1337
  # @return [EmailHtmlDto]
1264
1338
  def get_email_html_json(email_id, opts = {})
@@ -1270,7 +1344,6 @@ module MailSlurpClient
1270
1344
  # Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type &#x60;application/json;charset&#x3D;utf-8&#x60; so you must call expecting that content response not JSON.
1271
1345
  # @param email_id [String]
1272
1346
  # @param [Hash] opts the optional parameters
1273
- # @option opts [Boolean] :decode
1274
1347
  # @option opts [Boolean] :replace_cid_images
1275
1348
  # @return [Array<(EmailHtmlDto, Integer, Hash)>] EmailHtmlDto data, response status code and response headers
1276
1349
  def get_email_html_json_with_http_info(email_id, opts = {})
@@ -1286,7 +1359,6 @@ module MailSlurpClient
1286
1359
 
1287
1360
  # query parameters
1288
1361
  query_params = opts[:query_params] || {}
1289
- query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
1290
1362
  query_params[:'replaceCidImages'] = opts[:'replace_cid_images'] if !opts[:'replace_cid_images'].nil?
1291
1363
 
1292
1364
  # header parameters
@@ -1395,6 +1467,7 @@ module MailSlurpClient
1395
1467
  # HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
1396
1468
  # @param email_id [String] ID of email to fetch text for
1397
1469
  # @param [Hash] opts the optional parameters
1470
+ # @option opts [String] :selector Optional HTML query selector for links
1398
1471
  # @return [EmailLinksResult]
1399
1472
  def get_email_links(email_id, opts = {})
1400
1473
  data, _status_code, _headers = get_email_links_with_http_info(email_id, opts)
@@ -1405,6 +1478,7 @@ module MailSlurpClient
1405
1478
  # HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
1406
1479
  # @param email_id [String] ID of email to fetch text for
1407
1480
  # @param [Hash] opts the optional parameters
1481
+ # @option opts [String] :selector Optional HTML query selector for links
1408
1482
  # @return [Array<(EmailLinksResult, Integer, Hash)>] EmailLinksResult data, response status code and response headers
1409
1483
  def get_email_links_with_http_info(email_id, opts = {})
1410
1484
  if @api_client.config.debugging
@@ -1419,6 +1493,7 @@ module MailSlurpClient
1419
1493
 
1420
1494
  # query parameters
1421
1495
  query_params = opts[:query_params] || {}
1496
+ query_params[:'selector'] = opts[:'selector'] if !opts[:'selector'].nil?
1422
1497
 
1423
1498
  # header parameters
1424
1499
  header_params = opts[:header_params] || {}
@@ -1653,6 +1728,71 @@ module MailSlurpClient
1653
1728
  return data, status_code, headers
1654
1729
  end
1655
1730
 
1731
+ # Get email data including headers but not body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
1732
+ # Returns a email summary object with headers. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints
1733
+ # @param email_id [String]
1734
+ # @param [Hash] opts the optional parameters
1735
+ # @option opts [Boolean] :decode
1736
+ # @return [EmailPreview]
1737
+ def get_email_summary(email_id, opts = {})
1738
+ data, _status_code, _headers = get_email_summary_with_http_info(email_id, opts)
1739
+ data
1740
+ end
1741
+
1742
+ # Get email data including headers but not body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
1743
+ # Returns a email summary object with headers. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints
1744
+ # @param email_id [String]
1745
+ # @param [Hash] opts the optional parameters
1746
+ # @option opts [Boolean] :decode
1747
+ # @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
1748
+ def get_email_summary_with_http_info(email_id, opts = {})
1749
+ if @api_client.config.debugging
1750
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_summary ...'
1751
+ end
1752
+ # verify the required parameter 'email_id' is set
1753
+ if @api_client.config.client_side_validation && email_id.nil?
1754
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_summary"
1755
+ end
1756
+ # resource path
1757
+ local_var_path = '/emails/{emailId}/summary'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
1758
+
1759
+ # query parameters
1760
+ query_params = opts[:query_params] || {}
1761
+ query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
1762
+
1763
+ # header parameters
1764
+ header_params = opts[:header_params] || {}
1765
+ # HTTP header 'Accept' (if needed)
1766
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1767
+
1768
+ # form parameters
1769
+ form_params = opts[:form_params] || {}
1770
+
1771
+ # http body (model)
1772
+ post_body = opts[:body]
1773
+
1774
+ # return_type
1775
+ return_type = opts[:return_type] || 'EmailPreview'
1776
+
1777
+ # auth_names
1778
+ auth_names = opts[:auth_names] || ['API_KEY']
1779
+
1780
+ new_options = opts.merge(
1781
+ :header_params => header_params,
1782
+ :query_params => query_params,
1783
+ :form_params => form_params,
1784
+ :body => post_body,
1785
+ :auth_names => auth_names,
1786
+ :return_type => return_type
1787
+ )
1788
+
1789
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1790
+ if @api_client.config.debugging
1791
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1792
+ end
1793
+ return data, status_code, headers
1794
+ end
1795
+
1656
1796
  # Parse and return text from an email, stripping HTML and decoding encoded characters
1657
1797
  # Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
1658
1798
  # @param email_id [String] ID of email to fetch text for
@@ -1721,6 +1861,222 @@ module MailSlurpClient
1721
1861
  return data, status_code, headers
1722
1862
  end
1723
1863
 
1864
+ # Return email thread information. Use items endpoints to get messages for thread.
1865
+ # Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint
1866
+ # @param thread_id [String]
1867
+ # @param [Hash] opts the optional parameters
1868
+ # @return [EmailThreadDto]
1869
+ def get_email_thread(thread_id, opts = {})
1870
+ data, _status_code, _headers = get_email_thread_with_http_info(thread_id, opts)
1871
+ data
1872
+ end
1873
+
1874
+ # Return email thread information. Use items endpoints to get messages for thread.
1875
+ # Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint
1876
+ # @param thread_id [String]
1877
+ # @param [Hash] opts the optional parameters
1878
+ # @return [Array<(EmailThreadDto, Integer, Hash)>] EmailThreadDto data, response status code and response headers
1879
+ def get_email_thread_with_http_info(thread_id, opts = {})
1880
+ if @api_client.config.debugging
1881
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_thread ...'
1882
+ end
1883
+ # verify the required parameter 'thread_id' is set
1884
+ if @api_client.config.client_side_validation && thread_id.nil?
1885
+ fail ArgumentError, "Missing the required parameter 'thread_id' when calling EmailControllerApi.get_email_thread"
1886
+ end
1887
+ # resource path
1888
+ local_var_path = '/emails/threads/{threadId}'.sub('{' + 'threadId' + '}', CGI.escape(thread_id.to_s))
1889
+
1890
+ # query parameters
1891
+ query_params = opts[:query_params] || {}
1892
+
1893
+ # header parameters
1894
+ header_params = opts[:header_params] || {}
1895
+ # HTTP header 'Accept' (if needed)
1896
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1897
+
1898
+ # form parameters
1899
+ form_params = opts[:form_params] || {}
1900
+
1901
+ # http body (model)
1902
+ post_body = opts[:body]
1903
+
1904
+ # return_type
1905
+ return_type = opts[:return_type] || 'EmailThreadDto'
1906
+
1907
+ # auth_names
1908
+ auth_names = opts[:auth_names] || ['API_KEY']
1909
+
1910
+ new_options = opts.merge(
1911
+ :header_params => header_params,
1912
+ :query_params => query_params,
1913
+ :form_params => form_params,
1914
+ :body => post_body,
1915
+ :auth_names => auth_names,
1916
+ :return_type => return_type
1917
+ )
1918
+
1919
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1920
+ if @api_client.config.debugging
1921
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_thread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1922
+ end
1923
+ return data, status_code, headers
1924
+ end
1925
+
1926
+ # Return email thread items.
1927
+ # Return email thread messages based on Message-ID, In-Reply-To, and References header
1928
+ # @param thread_id [String]
1929
+ # @param [Hash] opts the optional parameters
1930
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1931
+ # @return [EmailThreadItemsDto]
1932
+ def get_email_thread_items(thread_id, opts = {})
1933
+ data, _status_code, _headers = get_email_thread_items_with_http_info(thread_id, opts)
1934
+ data
1935
+ end
1936
+
1937
+ # Return email thread items.
1938
+ # Return email thread messages based on Message-ID, In-Reply-To, and References header
1939
+ # @param thread_id [String]
1940
+ # @param [Hash] opts the optional parameters
1941
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1942
+ # @return [Array<(EmailThreadItemsDto, Integer, Hash)>] EmailThreadItemsDto data, response status code and response headers
1943
+ def get_email_thread_items_with_http_info(thread_id, opts = {})
1944
+ if @api_client.config.debugging
1945
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_thread_items ...'
1946
+ end
1947
+ # verify the required parameter 'thread_id' is set
1948
+ if @api_client.config.client_side_validation && thread_id.nil?
1949
+ fail ArgumentError, "Missing the required parameter 'thread_id' when calling EmailControllerApi.get_email_thread_items"
1950
+ end
1951
+ allowable_values = ["ASC", "DESC"]
1952
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1953
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1954
+ end
1955
+ # resource path
1956
+ local_var_path = '/emails/threads/{threadId}/items'.sub('{' + 'threadId' + '}', CGI.escape(thread_id.to_s))
1957
+
1958
+ # query parameters
1959
+ query_params = opts[:query_params] || {}
1960
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1961
+
1962
+ # header parameters
1963
+ header_params = opts[:header_params] || {}
1964
+ # HTTP header 'Accept' (if needed)
1965
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1966
+
1967
+ # form parameters
1968
+ form_params = opts[:form_params] || {}
1969
+
1970
+ # http body (model)
1971
+ post_body = opts[:body]
1972
+
1973
+ # return_type
1974
+ return_type = opts[:return_type] || 'EmailThreadItemsDto'
1975
+
1976
+ # auth_names
1977
+ auth_names = opts[:auth_names] || ['API_KEY']
1978
+
1979
+ new_options = opts.merge(
1980
+ :header_params => header_params,
1981
+ :query_params => query_params,
1982
+ :form_params => form_params,
1983
+ :body => post_body,
1984
+ :auth_names => auth_names,
1985
+ :return_type => return_type
1986
+ )
1987
+
1988
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1989
+ if @api_client.config.debugging
1990
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_thread_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1991
+ end
1992
+ return data, status_code, headers
1993
+ end
1994
+
1995
+ # Return email threads in paginated form
1996
+ # Return email message chains built from Message-ID, In-Reply-To, and References header.
1997
+ # @param [Hash] opts the optional parameters
1998
+ # @option opts [String] :html_selector Optional inbox filter
1999
+ # @option opts [Integer] :page Optional page index in email thread pagination (default to 0)
2000
+ # @option opts [Integer] :size Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
2001
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
2002
+ # @option opts [String] :search_filter Optional search filter search filter for email threads.
2003
+ # @option opts [DateTime] :since Optional filter email threads created since time
2004
+ # @option opts [DateTime] :before Optional filter emails threads created before given date time
2005
+ # @return [PageEmailThreadProjection]
2006
+ def get_email_threads(opts = {})
2007
+ data, _status_code, _headers = get_email_threads_with_http_info(opts)
2008
+ data
2009
+ end
2010
+
2011
+ # Return email threads in paginated form
2012
+ # Return email message chains built from Message-ID, In-Reply-To, and References header.
2013
+ # @param [Hash] opts the optional parameters
2014
+ # @option opts [String] :html_selector Optional inbox filter
2015
+ # @option opts [Integer] :page Optional page index in email thread pagination
2016
+ # @option opts [Integer] :size Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results
2017
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
2018
+ # @option opts [String] :search_filter Optional search filter search filter for email threads.
2019
+ # @option opts [DateTime] :since Optional filter email threads created since time
2020
+ # @option opts [DateTime] :before Optional filter emails threads created before given date time
2021
+ # @return [Array<(PageEmailThreadProjection, Integer, Hash)>] PageEmailThreadProjection data, response status code and response headers
2022
+ def get_email_threads_with_http_info(opts = {})
2023
+ if @api_client.config.debugging
2024
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_threads ...'
2025
+ end
2026
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
2027
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_email_threads, must be smaller than or equal to 100.'
2028
+ end
2029
+
2030
+ allowable_values = ["ASC", "DESC"]
2031
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
2032
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
2033
+ end
2034
+ # resource path
2035
+ local_var_path = '/emails/threads'
2036
+
2037
+ # query parameters
2038
+ query_params = opts[:query_params] || {}
2039
+ query_params[:'htmlSelector'] = opts[:'html_selector'] if !opts[:'html_selector'].nil?
2040
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
2041
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
2042
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
2043
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2044
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2045
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2046
+
2047
+ # header parameters
2048
+ header_params = opts[:header_params] || {}
2049
+ # HTTP header 'Accept' (if needed)
2050
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
2051
+
2052
+ # form parameters
2053
+ form_params = opts[:form_params] || {}
2054
+
2055
+ # http body (model)
2056
+ post_body = opts[:body]
2057
+
2058
+ # return_type
2059
+ return_type = opts[:return_type] || 'PageEmailThreadProjection'
2060
+
2061
+ # auth_names
2062
+ auth_names = opts[:auth_names] || ['API_KEY']
2063
+
2064
+ new_options = opts.merge(
2065
+ :header_params => header_params,
2066
+ :query_params => query_params,
2067
+ :form_params => form_params,
2068
+ :body => post_body,
2069
+ :auth_names => auth_names,
2070
+ :return_type => return_type
2071
+ )
2072
+
2073
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2074
+ if @api_client.config.debugging
2075
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2076
+ end
2077
+ return data, status_code, headers
2078
+ end
2079
+
1724
2080
  # Get all emails in all inboxes in paginated form. Email API list all.
1725
2081
  # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
1726
2082
  # @param [Hash] opts the optional parameters
@@ -1732,6 +2088,9 @@ module MailSlurpClient
1732
2088
  # @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
1733
2089
  # @option opts [DateTime] :since Optional filter emails received after given date time
1734
2090
  # @option opts [DateTime] :before Optional filter emails received before given date time
2091
+ # @option opts [Boolean] :favourited Optional filter emails that are favourited
2092
+ # @option opts [Boolean] :sync_connectors Sync connectors
2093
+ # @option opts [String] :plus_address_id Optional plus address ID filter
1735
2094
  # @return [PageEmailProjection]
1736
2095
  def get_emails_offset_paginated(opts = {})
1737
2096
  data, _status_code, _headers = get_emails_offset_paginated_with_http_info(opts)
@@ -1749,6 +2108,9 @@ module MailSlurpClient
1749
2108
  # @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
1750
2109
  # @option opts [DateTime] :since Optional filter emails received after given date time
1751
2110
  # @option opts [DateTime] :before Optional filter emails received before given date time
2111
+ # @option opts [Boolean] :favourited Optional filter emails that are favourited
2112
+ # @option opts [Boolean] :sync_connectors Sync connectors
2113
+ # @option opts [String] :plus_address_id Optional plus address ID filter
1752
2114
  # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
1753
2115
  def get_emails_offset_paginated_with_http_info(opts = {})
1754
2116
  if @api_client.config.debugging
@@ -1775,6 +2137,9 @@ module MailSlurpClient
1775
2137
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1776
2138
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1777
2139
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2140
+ query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
2141
+ query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
2142
+ query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?
1778
2143
 
1779
2144
  # header parameters
1780
2145
  header_params = opts[:header_params] || {}
@@ -1820,6 +2185,9 @@ module MailSlurpClient
1820
2185
  # @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
1821
2186
  # @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
1822
2187
  # @option opts [DateTime] :before Optional filter emails received before given date time
2188
+ # @option opts [Boolean] :sync_connectors Sync connectors
2189
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2190
+ # @option opts [Boolean] :favourited Optional filter emails that are favourited
1823
2191
  # @return [PageEmailProjection]
1824
2192
  def get_emails_paginated(opts = {})
1825
2193
  data, _status_code, _headers = get_emails_paginated_with_http_info(opts)
@@ -1837,6 +2205,9 @@ module MailSlurpClient
1837
2205
  # @option opts [String] :search_filter Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
1838
2206
  # @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
1839
2207
  # @option opts [DateTime] :before Optional filter emails received before given date time
2208
+ # @option opts [Boolean] :sync_connectors Sync connectors
2209
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2210
+ # @option opts [Boolean] :favourited Optional filter emails that are favourited
1840
2211
  # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
1841
2212
  def get_emails_paginated_with_http_info(opts = {})
1842
2213
  if @api_client.config.debugging
@@ -1863,6 +2234,9 @@ module MailSlurpClient
1863
2234
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1864
2235
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1865
2236
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2237
+ query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
2238
+ query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?
2239
+ query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
1866
2240
 
1867
2241
  # header parameters
1868
2242
  header_params = opts[:header_params] || {}
@@ -2094,6 +2468,9 @@ module MailSlurpClient
2094
2468
  # @option opts [String] :search_filter Optional search filter search filter for emails.
2095
2469
  # @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
2096
2470
  # @option opts [DateTime] :before Optional filter emails received before given date time
2471
+ # @option opts [Boolean] :sync_connectors Sync connectors
2472
+ # @option opts [Boolean] :favourited Search only favorited emails
2473
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2097
2474
  # @return [PageEmailProjection]
2098
2475
  def get_organization_emails_paginated(opts = {})
2099
2476
  data, _status_code, _headers = get_organization_emails_paginated_with_http_info(opts)
@@ -2111,6 +2488,9 @@ module MailSlurpClient
2111
2488
  # @option opts [String] :search_filter Optional search filter search filter for emails.
2112
2489
  # @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
2113
2490
  # @option opts [DateTime] :before Optional filter emails received before given date time
2491
+ # @option opts [Boolean] :sync_connectors Sync connectors
2492
+ # @option opts [Boolean] :favourited Search only favorited emails
2493
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2114
2494
  # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
2115
2495
  def get_organization_emails_paginated_with_http_info(opts = {})
2116
2496
  if @api_client.config.debugging
@@ -2137,6 +2517,9 @@ module MailSlurpClient
2137
2517
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
2138
2518
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
2139
2519
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
2520
+ query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
2521
+ query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
2522
+ query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?
2140
2523
 
2141
2524
  # header parameters
2142
2525
  header_params = opts[:header_params] || {}
@@ -2551,6 +2934,9 @@ module MailSlurpClient
2551
2934
  # Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
2552
2935
  # @param search_emails_options [SearchEmailsOptions]
2553
2936
  # @param [Hash] opts the optional parameters
2937
+ # @option opts [Boolean] :sync_connectors Sync connectors
2938
+ # @option opts [Boolean] :favourited Search only favourited emails
2939
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2554
2940
  # @return [PageEmailProjection]
2555
2941
  def search_emails(search_emails_options, opts = {})
2556
2942
  data, _status_code, _headers = search_emails_with_http_info(search_emails_options, opts)
@@ -2561,6 +2947,9 @@ module MailSlurpClient
2561
2947
  # Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
2562
2948
  # @param search_emails_options [SearchEmailsOptions]
2563
2949
  # @param [Hash] opts the optional parameters
2950
+ # @option opts [Boolean] :sync_connectors Sync connectors
2951
+ # @option opts [Boolean] :favourited Search only favourited emails
2952
+ # @option opts [String] :plus_address_id Optional plus address ID filter
2564
2953
  # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
2565
2954
  def search_emails_with_http_info(search_emails_options, opts = {})
2566
2955
  if @api_client.config.debugging
@@ -2575,6 +2964,9 @@ module MailSlurpClient
2575
2964
 
2576
2965
  # query parameters
2577
2966
  query_params = opts[:query_params] || {}
2967
+ query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
2968
+ query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
2969
+ query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?
2578
2970
 
2579
2971
  # header parameters
2580
2972
  header_params = opts[:header_params] || {}
@@ -2682,6 +3074,73 @@ module MailSlurpClient
2682
3074
  return data, status_code, headers
2683
3075
  end
2684
3076
 
3077
+ # Set email favourited state
3078
+ # Set and return new favorite state for an email
3079
+ # @param email_id [String] ID of email to set favourite state
3080
+ # @param favourited [Boolean]
3081
+ # @param [Hash] opts the optional parameters
3082
+ # @return [nil]
3083
+ def set_email_favourited(email_id, favourited, opts = {})
3084
+ set_email_favourited_with_http_info(email_id, favourited, opts)
3085
+ nil
3086
+ end
3087
+
3088
+ # Set email favourited state
3089
+ # Set and return new favorite state for an email
3090
+ # @param email_id [String] ID of email to set favourite state
3091
+ # @param favourited [Boolean]
3092
+ # @param [Hash] opts the optional parameters
3093
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
3094
+ def set_email_favourited_with_http_info(email_id, favourited, opts = {})
3095
+ if @api_client.config.debugging
3096
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.set_email_favourited ...'
3097
+ end
3098
+ # verify the required parameter 'email_id' is set
3099
+ if @api_client.config.client_side_validation && email_id.nil?
3100
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.set_email_favourited"
3101
+ end
3102
+ # verify the required parameter 'favourited' is set
3103
+ if @api_client.config.client_side_validation && favourited.nil?
3104
+ fail ArgumentError, "Missing the required parameter 'favourited' when calling EmailControllerApi.set_email_favourited"
3105
+ end
3106
+ # resource path
3107
+ local_var_path = '/emails/{emailId}/favourite'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
3108
+
3109
+ # query parameters
3110
+ query_params = opts[:query_params] || {}
3111
+ query_params[:'favourited'] = favourited
3112
+
3113
+ # header parameters
3114
+ header_params = opts[:header_params] || {}
3115
+
3116
+ # form parameters
3117
+ form_params = opts[:form_params] || {}
3118
+
3119
+ # http body (model)
3120
+ post_body = opts[:body]
3121
+
3122
+ # return_type
3123
+ return_type = opts[:return_type]
3124
+
3125
+ # auth_names
3126
+ auth_names = opts[:auth_names] || ['API_KEY']
3127
+
3128
+ new_options = opts.merge(
3129
+ :header_params => header_params,
3130
+ :query_params => query_params,
3131
+ :form_params => form_params,
3132
+ :body => post_body,
3133
+ :auth_names => auth_names,
3134
+ :return_type => return_type
3135
+ )
3136
+
3137
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
3138
+ if @api_client.config.debugging
3139
+ @api_client.config.logger.debug "API called: EmailControllerApi#set_email_favourited\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3140
+ end
3141
+ return data, status_code, headers
3142
+ end
3143
+
2685
3144
  # Validate email HTML contents
2686
3145
  # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
2687
3146
  # @param email_id [String] ID of email