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
@@ -0,0 +1,569 @@
1
+ =begin
2
+ #MailSlurp API
3
+
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
+
6
+ The version of the OpenAPI document: 6.5.2
7
+ Contact: contact@mailslurp.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MailSlurpClient
16
+ class GuestPortalControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create a portal page for your customers or clients to log into email accounts and view emails.
23
+ # Create a guest login page for customers or clients to access assigned email addresses
24
+ # @param create_portal_options [CreatePortalOptions]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [GuestPortalDto]
27
+ def create_guest_portal(create_portal_options, opts = {})
28
+ data, _status_code, _headers = create_guest_portal_with_http_info(create_portal_options, opts)
29
+ data
30
+ end
31
+
32
+ # Create a portal page for your customers or clients to log into email accounts and view emails.
33
+ # Create a guest login page for customers or clients to access assigned email addresses
34
+ # @param create_portal_options [CreatePortalOptions]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(GuestPortalDto, Integer, Hash)>] GuestPortalDto data, response status code and response headers
37
+ def create_guest_portal_with_http_info(create_portal_options, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.create_guest_portal ...'
40
+ end
41
+ # verify the required parameter 'create_portal_options' is set
42
+ if @api_client.config.client_side_validation && create_portal_options.nil?
43
+ fail ArgumentError, "Missing the required parameter 'create_portal_options' when calling GuestPortalControllerApi.create_guest_portal"
44
+ end
45
+ # resource path
46
+ local_var_path = '/guest-portal'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body] || @api_client.object_to_http_body(create_portal_options)
63
+
64
+ # return_type
65
+ return_type = opts[:return_type] || 'GuestPortalDto'
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['API_KEY']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#create_guest_portal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Create a portal guest user
87
+ # Add customer to portal
88
+ # @param portal_id [String]
89
+ # @param create_portal_user_options [CreatePortalUserOptions]
90
+ # @param [Hash] opts the optional parameters
91
+ # @return [GuestPortalUserCreateDto]
92
+ def create_guest_portal_user(portal_id, create_portal_user_options, opts = {})
93
+ data, _status_code, _headers = create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, opts)
94
+ data
95
+ end
96
+
97
+ # Create a portal guest user
98
+ # Add customer to portal
99
+ # @param portal_id [String]
100
+ # @param create_portal_user_options [CreatePortalUserOptions]
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [Array<(GuestPortalUserCreateDto, Integer, Hash)>] GuestPortalUserCreateDto data, response status code and response headers
103
+ def create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.create_guest_portal_user ...'
106
+ end
107
+ # verify the required parameter 'portal_id' is set
108
+ if @api_client.config.client_side_validation && portal_id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.create_guest_portal_user"
110
+ end
111
+ # verify the required parameter 'create_portal_user_options' is set
112
+ if @api_client.config.client_side_validation && create_portal_user_options.nil?
113
+ fail ArgumentError, "Missing the required parameter 'create_portal_user_options' when calling GuestPortalControllerApi.create_guest_portal_user"
114
+ end
115
+ # resource path
116
+ local_var_path = '/guest-portal/{portalId}/user'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
125
+ # HTTP header 'Content-Type'
126
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:body] || @api_client.object_to_http_body(create_portal_user_options)
133
+
134
+ # return_type
135
+ return_type = opts[:return_type] || 'GuestPortalUserCreateDto'
136
+
137
+ # auth_names
138
+ auth_names = opts[:auth_names] || ['API_KEY']
139
+
140
+ new_options = opts.merge(
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#create_guest_portal_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Get all guest users for portal
157
+ # Get all customers for a portal
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [String] :portal_id Optional portal ID
160
+ # @option opts [String] :search Optional search term
161
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
162
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
163
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
164
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
165
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
166
+ # @return [PageGuestPortalUsers]
167
+ def get_all_guest_portal_users(opts = {})
168
+ data, _status_code, _headers = get_all_guest_portal_users_with_http_info(opts)
169
+ data
170
+ end
171
+
172
+ # Get all guest users for portal
173
+ # Get all customers for a portal
174
+ # @param [Hash] opts the optional parameters
175
+ # @option opts [String] :portal_id Optional portal ID
176
+ # @option opts [String] :search Optional search term
177
+ # @option opts [Integer] :page Optional page index in list pagination
178
+ # @option opts [Integer] :size Optional page size in list pagination
179
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
180
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
181
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
182
+ # @return [Array<(PageGuestPortalUsers, Integer, Hash)>] PageGuestPortalUsers data, response status code and response headers
183
+ def get_all_guest_portal_users_with_http_info(opts = {})
184
+ if @api_client.config.debugging
185
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_all_guest_portal_users ...'
186
+ end
187
+ allowable_values = ["ASC", "DESC"]
188
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
189
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
190
+ end
191
+ # resource path
192
+ local_var_path = '/guest-portal/user'
193
+
194
+ # query parameters
195
+ query_params = opts[:query_params] || {}
196
+ query_params[:'portalId'] = opts[:'portal_id'] if !opts[:'portal_id'].nil?
197
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
198
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
199
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
200
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
201
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
202
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
203
+
204
+ # header parameters
205
+ header_params = opts[:header_params] || {}
206
+ # HTTP header 'Accept' (if needed)
207
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
208
+
209
+ # form parameters
210
+ form_params = opts[:form_params] || {}
211
+
212
+ # http body (model)
213
+ post_body = opts[:body]
214
+
215
+ # return_type
216
+ return_type = opts[:return_type] || 'PageGuestPortalUsers'
217
+
218
+ # auth_names
219
+ auth_names = opts[:auth_names] || ['API_KEY']
220
+
221
+ new_options = opts.merge(
222
+ :header_params => header_params,
223
+ :query_params => query_params,
224
+ :form_params => form_params,
225
+ :body => post_body,
226
+ :auth_names => auth_names,
227
+ :return_type => return_type
228
+ )
229
+
230
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_all_guest_portal_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+
237
+ # Get a client email portal
238
+ # Fetch a customer guest portal
239
+ # @param portal_id [String]
240
+ # @param [Hash] opts the optional parameters
241
+ # @return [GuestPortalDto]
242
+ def get_guest_portal(portal_id, opts = {})
243
+ data, _status_code, _headers = get_guest_portal_with_http_info(portal_id, opts)
244
+ data
245
+ end
246
+
247
+ # Get a client email portal
248
+ # Fetch a customer guest portal
249
+ # @param portal_id [String]
250
+ # @param [Hash] opts the optional parameters
251
+ # @return [Array<(GuestPortalDto, Integer, Hash)>] GuestPortalDto data, response status code and response headers
252
+ def get_guest_portal_with_http_info(portal_id, opts = {})
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal ...'
255
+ end
256
+ # verify the required parameter 'portal_id' is set
257
+ if @api_client.config.client_side_validation && portal_id.nil?
258
+ fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal"
259
+ end
260
+ # resource path
261
+ local_var_path = '/guest-portal/{portalId}'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s))
262
+
263
+ # query parameters
264
+ query_params = opts[:query_params] || {}
265
+
266
+ # header parameters
267
+ header_params = opts[:header_params] || {}
268
+ # HTTP header 'Accept' (if needed)
269
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
270
+
271
+ # form parameters
272
+ form_params = opts[:form_params] || {}
273
+
274
+ # http body (model)
275
+ post_body = opts[:body]
276
+
277
+ # return_type
278
+ return_type = opts[:return_type] || 'GuestPortalDto'
279
+
280
+ # auth_names
281
+ auth_names = opts[:auth_names] || ['API_KEY']
282
+
283
+ new_options = opts.merge(
284
+ :header_params => header_params,
285
+ :query_params => query_params,
286
+ :form_params => form_params,
287
+ :body => post_body,
288
+ :auth_names => auth_names,
289
+ :return_type => return_type
290
+ )
291
+
292
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_guest_portal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
295
+ end
296
+ return data, status_code, headers
297
+ end
298
+
299
+ # Get guest user for portal
300
+ # Get customer for portal
301
+ # @param portal_id [String]
302
+ # @param guest_id [String]
303
+ # @param [Hash] opts the optional parameters
304
+ # @return [GuestPortalUserDto]
305
+ def get_guest_portal_user(portal_id, guest_id, opts = {})
306
+ data, _status_code, _headers = get_guest_portal_user_with_http_info(portal_id, guest_id, opts)
307
+ data
308
+ end
309
+
310
+ # Get guest user for portal
311
+ # Get customer for portal
312
+ # @param portal_id [String]
313
+ # @param guest_id [String]
314
+ # @param [Hash] opts the optional parameters
315
+ # @return [Array<(GuestPortalUserDto, Integer, Hash)>] GuestPortalUserDto data, response status code and response headers
316
+ def get_guest_portal_user_with_http_info(portal_id, guest_id, opts = {})
317
+ if @api_client.config.debugging
318
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_user ...'
319
+ end
320
+ # verify the required parameter 'portal_id' is set
321
+ if @api_client.config.client_side_validation && portal_id.nil?
322
+ fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal_user"
323
+ end
324
+ # verify the required parameter 'guest_id' is set
325
+ if @api_client.config.client_side_validation && guest_id.nil?
326
+ fail ArgumentError, "Missing the required parameter 'guest_id' when calling GuestPortalControllerApi.get_guest_portal_user"
327
+ end
328
+ # resource path
329
+ local_var_path = '/guest-portal/{portalId}/user/{guestId}'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s)).sub('{' + 'guestId' + '}', CGI.escape(guest_id.to_s))
330
+
331
+ # query parameters
332
+ query_params = opts[:query_params] || {}
333
+
334
+ # header parameters
335
+ header_params = opts[:header_params] || {}
336
+ # HTTP header 'Accept' (if needed)
337
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
338
+
339
+ # form parameters
340
+ form_params = opts[:form_params] || {}
341
+
342
+ # http body (model)
343
+ post_body = opts[:body]
344
+
345
+ # return_type
346
+ return_type = opts[:return_type] || 'GuestPortalUserDto'
347
+
348
+ # auth_names
349
+ auth_names = opts[:auth_names] || ['API_KEY']
350
+
351
+ new_options = opts.merge(
352
+ :header_params => header_params,
353
+ :query_params => query_params,
354
+ :form_params => form_params,
355
+ :body => post_body,
356
+ :auth_names => auth_names,
357
+ :return_type => return_type
358
+ )
359
+
360
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
361
+ if @api_client.config.debugging
362
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_guest_portal_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
363
+ end
364
+ return data, status_code, headers
365
+ end
366
+
367
+ # Get guest user
368
+ # Get customer by ID
369
+ # @param guest_id [String]
370
+ # @param [Hash] opts the optional parameters
371
+ # @return [GuestPortalUserDto]
372
+ def get_guest_portal_user_by_id(guest_id, opts = {})
373
+ data, _status_code, _headers = get_guest_portal_user_by_id_with_http_info(guest_id, opts)
374
+ data
375
+ end
376
+
377
+ # Get guest user
378
+ # Get customer by ID
379
+ # @param guest_id [String]
380
+ # @param [Hash] opts the optional parameters
381
+ # @return [Array<(GuestPortalUserDto, Integer, Hash)>] GuestPortalUserDto data, response status code and response headers
382
+ def get_guest_portal_user_by_id_with_http_info(guest_id, opts = {})
383
+ if @api_client.config.debugging
384
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_user_by_id ...'
385
+ end
386
+ # verify the required parameter 'guest_id' is set
387
+ if @api_client.config.client_side_validation && guest_id.nil?
388
+ fail ArgumentError, "Missing the required parameter 'guest_id' when calling GuestPortalControllerApi.get_guest_portal_user_by_id"
389
+ end
390
+ # resource path
391
+ local_var_path = '/guest-portal/user/{guestId}'.sub('{' + 'guestId' + '}', CGI.escape(guest_id.to_s))
392
+
393
+ # query parameters
394
+ query_params = opts[:query_params] || {}
395
+
396
+ # header parameters
397
+ header_params = opts[:header_params] || {}
398
+ # HTTP header 'Accept' (if needed)
399
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
400
+
401
+ # form parameters
402
+ form_params = opts[:form_params] || {}
403
+
404
+ # http body (model)
405
+ post_body = opts[:body]
406
+
407
+ # return_type
408
+ return_type = opts[:return_type] || 'GuestPortalUserDto'
409
+
410
+ # auth_names
411
+ auth_names = opts[:auth_names] || ['API_KEY']
412
+
413
+ new_options = opts.merge(
414
+ :header_params => header_params,
415
+ :query_params => query_params,
416
+ :form_params => form_params,
417
+ :body => post_body,
418
+ :auth_names => auth_names,
419
+ :return_type => return_type
420
+ )
421
+
422
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
423
+ if @api_client.config.debugging
424
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_guest_portal_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
425
+ end
426
+ return data, status_code, headers
427
+ end
428
+
429
+ # Get all guest users for portal
430
+ # Get customers for a portal
431
+ # @param portal_id [String]
432
+ # @param [Hash] opts the optional parameters
433
+ # @option opts [String] :search Optional search term
434
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
435
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
436
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
437
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
438
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
439
+ # @return [PageGuestPortalUsers]
440
+ def get_guest_portal_users(portal_id, opts = {})
441
+ data, _status_code, _headers = get_guest_portal_users_with_http_info(portal_id, opts)
442
+ data
443
+ end
444
+
445
+ # Get all guest users for portal
446
+ # Get customers for a portal
447
+ # @param portal_id [String]
448
+ # @param [Hash] opts the optional parameters
449
+ # @option opts [String] :search Optional search term
450
+ # @option opts [Integer] :page Optional page index in list pagination
451
+ # @option opts [Integer] :size Optional page size in list pagination
452
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
453
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
454
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
455
+ # @return [Array<(PageGuestPortalUsers, Integer, Hash)>] PageGuestPortalUsers data, response status code and response headers
456
+ def get_guest_portal_users_with_http_info(portal_id, opts = {})
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_users ...'
459
+ end
460
+ # verify the required parameter 'portal_id' is set
461
+ if @api_client.config.client_side_validation && portal_id.nil?
462
+ fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal_users"
463
+ end
464
+ allowable_values = ["ASC", "DESC"]
465
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
466
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
467
+ end
468
+ # resource path
469
+ local_var_path = '/guest-portal/{portalId}/user'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s))
470
+
471
+ # query parameters
472
+ query_params = opts[:query_params] || {}
473
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
474
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
475
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
476
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
477
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
478
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
479
+
480
+ # header parameters
481
+ header_params = opts[:header_params] || {}
482
+ # HTTP header 'Accept' (if needed)
483
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
484
+
485
+ # form parameters
486
+ form_params = opts[:form_params] || {}
487
+
488
+ # http body (model)
489
+ post_body = opts[:body]
490
+
491
+ # return_type
492
+ return_type = opts[:return_type] || 'PageGuestPortalUsers'
493
+
494
+ # auth_names
495
+ auth_names = opts[:auth_names] || ['API_KEY']
496
+
497
+ new_options = opts.merge(
498
+ :header_params => header_params,
499
+ :query_params => query_params,
500
+ :form_params => form_params,
501
+ :body => post_body,
502
+ :auth_names => auth_names,
503
+ :return_type => return_type
504
+ )
505
+
506
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
507
+ if @api_client.config.debugging
508
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_guest_portal_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
509
+ end
510
+ return data, status_code, headers
511
+ end
512
+
513
+ # Get guest portals
514
+ # Get portals
515
+ # @param [Hash] opts the optional parameters
516
+ # @return [Array<GuestPortalDto>]
517
+ def get_guest_portals(opts = {})
518
+ data, _status_code, _headers = get_guest_portals_with_http_info(opts)
519
+ data
520
+ end
521
+
522
+ # Get guest portals
523
+ # Get portals
524
+ # @param [Hash] opts the optional parameters
525
+ # @return [Array<(Array<GuestPortalDto>, Integer, Hash)>] Array<GuestPortalDto> data, response status code and response headers
526
+ def get_guest_portals_with_http_info(opts = {})
527
+ if @api_client.config.debugging
528
+ @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portals ...'
529
+ end
530
+ # resource path
531
+ local_var_path = '/guest-portal'
532
+
533
+ # query parameters
534
+ query_params = opts[:query_params] || {}
535
+
536
+ # header parameters
537
+ header_params = opts[:header_params] || {}
538
+ # HTTP header 'Accept' (if needed)
539
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
540
+
541
+ # form parameters
542
+ form_params = opts[:form_params] || {}
543
+
544
+ # http body (model)
545
+ post_body = opts[:body]
546
+
547
+ # return_type
548
+ return_type = opts[:return_type] || 'Array<GuestPortalDto>'
549
+
550
+ # auth_names
551
+ auth_names = opts[:auth_names] || ['API_KEY']
552
+
553
+ new_options = opts.merge(
554
+ :header_params => header_params,
555
+ :query_params => query_params,
556
+ :form_params => form_params,
557
+ :body => post_body,
558
+ :auth_names => auth_names,
559
+ :return_type => return_type
560
+ )
561
+
562
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
563
+ if @api_client.config.debugging
564
+ @api_client.config.logger.debug "API called: GuestPortalControllerApi#get_guest_portals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
+ end
566
+ return data, status_code, headers
567
+ end
568
+ end
569
+ end
@@ -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