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
@@ -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
@@ -19,6 +19,123 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Delete sent SMS message.
23
+ # Delete a sent SMS message
24
+ # @param sent_sms_id [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [nil]
27
+ def delete_sent_sms_message(sent_sms_id, opts = {})
28
+ delete_sent_sms_message_with_http_info(sent_sms_id, opts)
29
+ nil
30
+ end
31
+
32
+ # Delete sent SMS message.
33
+ # Delete a sent SMS message
34
+ # @param sent_sms_id [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
+ def delete_sent_sms_message_with_http_info(sent_sms_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.delete_sent_sms_message ...'
40
+ end
41
+ # verify the required parameter 'sent_sms_id' is set
42
+ if @api_client.config.client_side_validation && sent_sms_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'sent_sms_id' when calling SmsControllerApi.delete_sent_sms_message"
44
+ end
45
+ # resource path
46
+ local_var_path = '/sms/sent/{sentSmsId}'.sub('{' + 'sentSmsId' + '}', CGI.escape(sent_sms_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:body]
59
+
60
+ # return_type
61
+ return_type = opts[:return_type]
62
+
63
+ # auth_names
64
+ auth_names = opts[:auth_names] || ['API_KEY']
65
+
66
+ new_options = opts.merge(
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => return_type
73
+ )
74
+
75
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: SmsControllerApi#delete_sent_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
82
+ # Delete all sent SMS messages
83
+ # Delete all sent SMS messages or all messages for a given phone number
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [String] :phone_number_id
86
+ # @return [nil]
87
+ def delete_sent_sms_messages(opts = {})
88
+ delete_sent_sms_messages_with_http_info(opts)
89
+ nil
90
+ end
91
+
92
+ # Delete all sent SMS messages
93
+ # Delete all sent SMS messages or all messages for a given phone number
94
+ # @param [Hash] opts the optional parameters
95
+ # @option opts [String] :phone_number_id
96
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
97
+ def delete_sent_sms_messages_with_http_info(opts = {})
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.delete_sent_sms_messages ...'
100
+ end
101
+ # resource path
102
+ local_var_path = '/sms/sent'
103
+
104
+ # query parameters
105
+ query_params = opts[:query_params] || {}
106
+ query_params[:'phoneNumberId'] = opts[:'phone_number_id'] if !opts[:'phone_number_id'].nil?
107
+
108
+ # header parameters
109
+ header_params = opts[:header_params] || {}
110
+
111
+ # form parameters
112
+ form_params = opts[:form_params] || {}
113
+
114
+ # http body (model)
115
+ post_body = opts[:body]
116
+
117
+ # return_type
118
+ return_type = opts[:return_type]
119
+
120
+ # auth_names
121
+ auth_names = opts[:auth_names] || ['API_KEY']
122
+
123
+ new_options = opts.merge(
124
+ :header_params => header_params,
125
+ :query_params => query_params,
126
+ :form_params => form_params,
127
+ :body => post_body,
128
+ :auth_names => auth_names,
129
+ :return_type => return_type
130
+ )
131
+
132
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
133
+ if @api_client.config.debugging
134
+ @api_client.config.logger.debug "API called: SmsControllerApi#delete_sent_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
135
+ end
136
+ return data, status_code, headers
137
+ end
138
+
22
139
  # Delete SMS message.
23
140
  # Delete an SMS message
24
141
  # @param sms_id [String]
@@ -136,6 +253,90 @@ module MailSlurpClient
136
253
  return data, status_code, headers
137
254
  end
138
255
 
256
+ # @param [Hash] opts the optional parameters
257
+ # @option opts [String] :phone_number Optional receiving phone number to filter SMS messages for
258
+ # @option opts [Integer] :page Optional page index in SMS list pagination (default to 0)
259
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
260
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
261
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
262
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
263
+ # @option opts [String] :search Optional search filter
264
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
265
+ # @return [PageSmsProjection]
266
+ def get_all_sms_messages(opts = {})
267
+ data, _status_code, _headers = get_all_sms_messages_with_http_info(opts)
268
+ data
269
+ end
270
+
271
+ # @param [Hash] opts the optional parameters
272
+ # @option opts [String] :phone_number Optional receiving phone number to filter SMS messages for
273
+ # @option opts [Integer] :page Optional page index in SMS list pagination
274
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
275
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
276
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
277
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
278
+ # @option opts [String] :search Optional search filter
279
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only
280
+ # @return [Array<(PageSmsProjection, Integer, Hash)>] PageSmsProjection data, response status code and response headers
281
+ def get_all_sms_messages_with_http_info(opts = {})
282
+ if @api_client.config.debugging
283
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_all_sms_messages ...'
284
+ end
285
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
286
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling SmsControllerApi.get_all_sms_messages, must be smaller than or equal to 100.'
287
+ end
288
+
289
+ allowable_values = ["ASC", "DESC"]
290
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
291
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
292
+ end
293
+ # resource path
294
+ local_var_path = '/sms'
295
+
296
+ # query parameters
297
+ query_params = opts[:query_params] || {}
298
+ query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
299
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
300
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
301
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
302
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
303
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
304
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
305
+ query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
306
+
307
+ # header parameters
308
+ header_params = opts[:header_params] || {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
311
+
312
+ # form parameters
313
+ form_params = opts[:form_params] || {}
314
+
315
+ # http body (model)
316
+ post_body = opts[:body]
317
+
318
+ # return_type
319
+ return_type = opts[:return_type] || 'PageSmsProjection'
320
+
321
+ # auth_names
322
+ auth_names = opts[:auth_names] || ['API_KEY']
323
+
324
+ new_options = opts.merge(
325
+ :header_params => header_params,
326
+ :query_params => query_params,
327
+ :form_params => form_params,
328
+ :body => post_body,
329
+ :auth_names => auth_names,
330
+ :return_type => return_type
331
+ )
332
+
333
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
334
+ if @api_client.config.debugging
335
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_all_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
336
+ end
337
+ return data, status_code, headers
338
+ end
339
+
139
340
  # Get reply for an SMS message
140
341
  # Get reply for an SMS message.
141
342
  # @param sms_id [String]
@@ -198,25 +399,25 @@ module MailSlurpClient
198
399
  return data, status_code, headers
199
400
  end
200
401
 
201
- # Get SMS count
202
- # Get number of SMS
402
+ # Get sent SMS count
403
+ # Get number of sent SMS
203
404
  # @param [Hash] opts the optional parameters
204
405
  # @return [CountDto]
205
- def get_sms_count(opts = {})
206
- data, _status_code, _headers = get_sms_count_with_http_info(opts)
406
+ def get_sent_sms_count(opts = {})
407
+ data, _status_code, _headers = get_sent_sms_count_with_http_info(opts)
207
408
  data
208
409
  end
209
410
 
210
- # Get SMS count
211
- # Get number of SMS
411
+ # Get sent SMS count
412
+ # Get number of sent SMS
212
413
  # @param [Hash] opts the optional parameters
213
414
  # @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
214
- def get_sms_count_with_http_info(opts = {})
415
+ def get_sent_sms_count_with_http_info(opts = {})
215
416
  if @api_client.config.debugging
216
- @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_count ...'
417
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sent_sms_count ...'
217
418
  end
218
419
  # resource path
219
- local_var_path = '/sms/count'
420
+ local_var_path = '/sms/sent/count'
220
421
 
221
422
  # query parameters
222
423
  query_params = opts[:query_params] || {}
@@ -249,36 +450,36 @@ module MailSlurpClient
249
450
 
250
451
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
251
452
  if @api_client.config.debugging
252
- @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
453
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_sent_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
253
454
  end
254
455
  return data, status_code, headers
255
456
  end
256
457
 
257
- # Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
258
- # Returns a SMS summary object with content.
259
- # @param sms_id [String]
458
+ # Get sent SMS content including body. Expects sent SMS to exist by ID.
459
+ # Returns an SMS summary object with content.
460
+ # @param sent_sms_id [String]
260
461
  # @param [Hash] opts the optional parameters
261
- # @return [SmsDto]
262
- def get_sms_message(sms_id, opts = {})
263
- data, _status_code, _headers = get_sms_message_with_http_info(sms_id, opts)
462
+ # @return [SentSmsDto]
463
+ def get_sent_sms_message(sent_sms_id, opts = {})
464
+ data, _status_code, _headers = get_sent_sms_message_with_http_info(sent_sms_id, opts)
264
465
  data
265
466
  end
266
467
 
267
- # Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
268
- # Returns a SMS summary object with content.
269
- # @param sms_id [String]
468
+ # Get sent SMS content including body. Expects sent SMS to exist by ID.
469
+ # Returns an SMS summary object with content.
470
+ # @param sent_sms_id [String]
270
471
  # @param [Hash] opts the optional parameters
271
- # @return [Array<(SmsDto, Integer, Hash)>] SmsDto data, response status code and response headers
272
- def get_sms_message_with_http_info(sms_id, opts = {})
472
+ # @return [Array<(SentSmsDto, Integer, Hash)>] SentSmsDto data, response status code and response headers
473
+ def get_sent_sms_message_with_http_info(sent_sms_id, opts = {})
273
474
  if @api_client.config.debugging
274
- @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_message ...'
475
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sent_sms_message ...'
275
476
  end
276
- # verify the required parameter 'sms_id' is set
277
- if @api_client.config.client_side_validation && sms_id.nil?
278
- fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.get_sms_message"
477
+ # verify the required parameter 'sent_sms_id' is set
478
+ if @api_client.config.client_side_validation && sent_sms_id.nil?
479
+ fail ArgumentError, "Missing the required parameter 'sent_sms_id' when calling SmsControllerApi.get_sent_sms_message"
279
480
  end
280
481
  # resource path
281
- local_var_path = '/sms/{smsId}'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s))
482
+ local_var_path = '/sms/sent/{sentSmsId}'.sub('{' + 'sentSmsId' + '}', CGI.escape(sent_sms_id.to_s))
282
483
 
283
484
  # query parameters
284
485
  query_params = opts[:query_params] || {}
@@ -295,7 +496,7 @@ module MailSlurpClient
295
496
  post_body = opts[:body]
296
497
 
297
498
  # return_type
298
- return_type = opts[:return_type] || 'SmsDto'
499
+ return_type = opts[:return_type] || 'SentSmsDto'
299
500
 
300
501
  # auth_names
301
502
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -311,7 +512,7 @@ module MailSlurpClient
311
512
 
312
513
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
313
514
  if @api_client.config.debugging
314
- @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
515
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_sent_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
315
516
  end
316
517
  return data, status_code, headers
317
518
  end
@@ -319,36 +520,36 @@ module MailSlurpClient
319
520
  # Get all SMS messages in all phone numbers in paginated form. .
320
521
  # By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
321
522
  # @param [Hash] opts the optional parameters
322
- # @option opts [String] :phone_number Optional receiving phone number to filter SMS messages for
523
+ # @option opts [String] :phone_number Optional phone number to filter sent SMS messages for
323
524
  # @option opts [Integer] :page Optional page index in SMS list pagination (default to 0)
324
525
  # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
325
526
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
326
- # @option opts [Boolean] :unread_only Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (default to false)
327
527
  # @option opts [DateTime] :since Optional filter SMSs received after given date time
328
528
  # @option opts [DateTime] :before Optional filter SMSs received before given date time
329
- # @return [PageSmsProjection]
330
- def get_sms_messages_paginated(opts = {})
331
- data, _status_code, _headers = get_sms_messages_paginated_with_http_info(opts)
529
+ # @option opts [String] :search Optional search filter
530
+ # @return [PageSentSmsProjection]
531
+ def get_sent_sms_messages_paginated(opts = {})
532
+ data, _status_code, _headers = get_sent_sms_messages_paginated_with_http_info(opts)
332
533
  data
333
534
  end
334
535
 
335
536
  # Get all SMS messages in all phone numbers in paginated form. .
336
537
  # By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages
337
538
  # @param [Hash] opts the optional parameters
338
- # @option opts [String] :phone_number Optional receiving phone number to filter SMS messages for
539
+ # @option opts [String] :phone_number Optional phone number to filter sent SMS messages for
339
540
  # @option opts [Integer] :page Optional page index in SMS list pagination
340
541
  # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
341
542
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
342
- # @option opts [Boolean] :unread_only Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly
343
543
  # @option opts [DateTime] :since Optional filter SMSs received after given date time
344
544
  # @option opts [DateTime] :before Optional filter SMSs received before given date time
345
- # @return [Array<(PageSmsProjection, Integer, Hash)>] PageSmsProjection data, response status code and response headers
346
- def get_sms_messages_paginated_with_http_info(opts = {})
545
+ # @option opts [String] :search Optional search filter
546
+ # @return [Array<(PageSentSmsProjection, Integer, Hash)>] PageSentSmsProjection data, response status code and response headers
547
+ def get_sent_sms_messages_paginated_with_http_info(opts = {})
347
548
  if @api_client.config.debugging
348
- @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_messages_paginated ...'
549
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sent_sms_messages_paginated ...'
349
550
  end
350
551
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
351
- fail ArgumentError, 'invalid value for "opts[:"size"]" when calling SmsControllerApi.get_sms_messages_paginated, must be smaller than or equal to 100.'
552
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling SmsControllerApi.get_sent_sms_messages_paginated, must be smaller than or equal to 100.'
352
553
  end
353
554
 
354
555
  allowable_values = ["ASC", "DESC"]
@@ -356,7 +557,7 @@ module MailSlurpClient
356
557
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
357
558
  end
358
559
  # resource path
359
- local_var_path = '/sms'
560
+ local_var_path = '/sms/sent'
360
561
 
361
562
  # query parameters
362
563
  query_params = opts[:query_params] || {}
@@ -364,9 +565,9 @@ module MailSlurpClient
364
565
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
365
566
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
366
567
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
367
- query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
368
568
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
369
569
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
570
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
370
571
 
371
572
  # header parameters
372
573
  header_params = opts[:header_params] || {}
@@ -380,7 +581,125 @@ module MailSlurpClient
380
581
  post_body = opts[:body]
381
582
 
382
583
  # return_type
383
- return_type = opts[:return_type] || 'PageSmsProjection'
584
+ return_type = opts[:return_type] || 'PageSentSmsProjection'
585
+
586
+ # auth_names
587
+ auth_names = opts[:auth_names] || ['API_KEY']
588
+
589
+ new_options = opts.merge(
590
+ :header_params => header_params,
591
+ :query_params => query_params,
592
+ :form_params => form_params,
593
+ :body => post_body,
594
+ :auth_names => auth_names,
595
+ :return_type => return_type
596
+ )
597
+
598
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
599
+ if @api_client.config.debugging
600
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_sent_sms_messages_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
601
+ end
602
+ return data, status_code, headers
603
+ end
604
+
605
+ # Get SMS count
606
+ # Get number of SMS
607
+ # @param [Hash] opts the optional parameters
608
+ # @return [CountDto]
609
+ def get_sms_count(opts = {})
610
+ data, _status_code, _headers = get_sms_count_with_http_info(opts)
611
+ data
612
+ end
613
+
614
+ # Get SMS count
615
+ # Get number of SMS
616
+ # @param [Hash] opts the optional parameters
617
+ # @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
618
+ def get_sms_count_with_http_info(opts = {})
619
+ if @api_client.config.debugging
620
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_count ...'
621
+ end
622
+ # resource path
623
+ local_var_path = '/sms/count'
624
+
625
+ # query parameters
626
+ query_params = opts[:query_params] || {}
627
+
628
+ # header parameters
629
+ header_params = opts[:header_params] || {}
630
+ # HTTP header 'Accept' (if needed)
631
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
632
+
633
+ # form parameters
634
+ form_params = opts[:form_params] || {}
635
+
636
+ # http body (model)
637
+ post_body = opts[:body]
638
+
639
+ # return_type
640
+ return_type = opts[:return_type] || 'CountDto'
641
+
642
+ # auth_names
643
+ auth_names = opts[:auth_names] || ['API_KEY']
644
+
645
+ new_options = opts.merge(
646
+ :header_params => header_params,
647
+ :query_params => query_params,
648
+ :form_params => form_params,
649
+ :body => post_body,
650
+ :auth_names => auth_names,
651
+ :return_type => return_type
652
+ )
653
+
654
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
655
+ if @api_client.config.debugging
656
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
657
+ end
658
+ return data, status_code, headers
659
+ end
660
+
661
+ # Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
662
+ # Returns a SMS summary object with content.
663
+ # @param sms_id [String]
664
+ # @param [Hash] opts the optional parameters
665
+ # @return [SmsDto]
666
+ def get_sms_message(sms_id, opts = {})
667
+ data, _status_code, _headers = get_sms_message_with_http_info(sms_id, opts)
668
+ data
669
+ end
670
+
671
+ # Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
672
+ # Returns a SMS summary object with content.
673
+ # @param sms_id [String]
674
+ # @param [Hash] opts the optional parameters
675
+ # @return [Array<(SmsDto, Integer, Hash)>] SmsDto data, response status code and response headers
676
+ def get_sms_message_with_http_info(sms_id, opts = {})
677
+ if @api_client.config.debugging
678
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_message ...'
679
+ end
680
+ # verify the required parameter 'sms_id' is set
681
+ if @api_client.config.client_side_validation && sms_id.nil?
682
+ fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.get_sms_message"
683
+ end
684
+ # resource path
685
+ local_var_path = '/sms/{smsId}'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s))
686
+
687
+ # query parameters
688
+ query_params = opts[:query_params] || {}
689
+
690
+ # header parameters
691
+ header_params = opts[:header_params] || {}
692
+ # HTTP header 'Accept' (if needed)
693
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
694
+
695
+ # form parameters
696
+ form_params = opts[:form_params] || {}
697
+
698
+ # http body (model)
699
+ post_body = opts[:body]
700
+
701
+ # return_type
702
+ return_type = opts[:return_type] || 'SmsDto'
384
703
 
385
704
  # auth_names
386
705
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -396,7 +715,7 @@ module MailSlurpClient
396
715
 
397
716
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
398
717
  if @api_client.config.debugging
399
- @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_messages_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
718
+ @api_client.config.logger.debug "API called: SmsControllerApi#get_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
400
719
  end
401
720
  return data, status_code, headers
402
721
  end
@@ -526,5 +845,136 @@ module MailSlurpClient
526
845
  end
527
846
  return data, status_code, headers
528
847
  end
848
+
849
+ # @param sms_send_options [SmsSendOptions]
850
+ # @param [Hash] opts the optional parameters
851
+ # @option opts [String] :from_phone_number Phone number to send from in E.164 format
852
+ # @option opts [String] :from_phone_id Phone number ID to send from in UUID form
853
+ # @return [SentSmsDto]
854
+ def send_sms(sms_send_options, opts = {})
855
+ data, _status_code, _headers = send_sms_with_http_info(sms_send_options, opts)
856
+ data
857
+ end
858
+
859
+ # @param sms_send_options [SmsSendOptions]
860
+ # @param [Hash] opts the optional parameters
861
+ # @option opts [String] :from_phone_number Phone number to send from in E.164 format
862
+ # @option opts [String] :from_phone_id Phone number ID to send from in UUID form
863
+ # @return [Array<(SentSmsDto, Integer, Hash)>] SentSmsDto data, response status code and response headers
864
+ def send_sms_with_http_info(sms_send_options, opts = {})
865
+ if @api_client.config.debugging
866
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.send_sms ...'
867
+ end
868
+ # verify the required parameter 'sms_send_options' is set
869
+ if @api_client.config.client_side_validation && sms_send_options.nil?
870
+ fail ArgumentError, "Missing the required parameter 'sms_send_options' when calling SmsControllerApi.send_sms"
871
+ end
872
+ # resource path
873
+ local_var_path = '/sms/send'
874
+
875
+ # query parameters
876
+ query_params = opts[:query_params] || {}
877
+ query_params[:'fromPhoneNumber'] = opts[:'from_phone_number'] if !opts[:'from_phone_number'].nil?
878
+ query_params[:'fromPhoneId'] = opts[:'from_phone_id'] if !opts[:'from_phone_id'].nil?
879
+
880
+ # header parameters
881
+ header_params = opts[:header_params] || {}
882
+ # HTTP header 'Accept' (if needed)
883
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
884
+ # HTTP header 'Content-Type'
885
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
886
+
887
+ # form parameters
888
+ form_params = opts[:form_params] || {}
889
+
890
+ # http body (model)
891
+ post_body = opts[:body] || @api_client.object_to_http_body(sms_send_options)
892
+
893
+ # return_type
894
+ return_type = opts[:return_type] || 'SentSmsDto'
895
+
896
+ # auth_names
897
+ auth_names = opts[:auth_names] || ['API_KEY']
898
+
899
+ new_options = opts.merge(
900
+ :header_params => header_params,
901
+ :query_params => query_params,
902
+ :form_params => form_params,
903
+ :body => post_body,
904
+ :auth_names => auth_names,
905
+ :return_type => return_type
906
+ )
907
+
908
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
909
+ if @api_client.config.debugging
910
+ @api_client.config.logger.debug "API called: SmsControllerApi#send_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
911
+ end
912
+ return data, status_code, headers
913
+ end
914
+
915
+ # @param sms_id [String] ID of SMS to set favourite state
916
+ # @param favourited [Boolean]
917
+ # @param [Hash] opts the optional parameters
918
+ # @return [SmsDto]
919
+ def set_sms_favourited(sms_id, favourited, opts = {})
920
+ data, _status_code, _headers = set_sms_favourited_with_http_info(sms_id, favourited, opts)
921
+ data
922
+ end
923
+
924
+ # @param sms_id [String] ID of SMS to set favourite state
925
+ # @param favourited [Boolean]
926
+ # @param [Hash] opts the optional parameters
927
+ # @return [Array<(SmsDto, Integer, Hash)>] SmsDto data, response status code and response headers
928
+ def set_sms_favourited_with_http_info(sms_id, favourited, opts = {})
929
+ if @api_client.config.debugging
930
+ @api_client.config.logger.debug 'Calling API: SmsControllerApi.set_sms_favourited ...'
931
+ end
932
+ # verify the required parameter 'sms_id' is set
933
+ if @api_client.config.client_side_validation && sms_id.nil?
934
+ fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.set_sms_favourited"
935
+ end
936
+ # verify the required parameter 'favourited' is set
937
+ if @api_client.config.client_side_validation && favourited.nil?
938
+ fail ArgumentError, "Missing the required parameter 'favourited' when calling SmsControllerApi.set_sms_favourited"
939
+ end
940
+ # resource path
941
+ local_var_path = '/sms/{smsId}/favourite'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s))
942
+
943
+ # query parameters
944
+ query_params = opts[:query_params] || {}
945
+ query_params[:'favourited'] = favourited
946
+
947
+ # header parameters
948
+ header_params = opts[:header_params] || {}
949
+ # HTTP header 'Accept' (if needed)
950
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
951
+
952
+ # form parameters
953
+ form_params = opts[:form_params] || {}
954
+
955
+ # http body (model)
956
+ post_body = opts[:body]
957
+
958
+ # return_type
959
+ return_type = opts[:return_type] || 'SmsDto'
960
+
961
+ # auth_names
962
+ auth_names = opts[:auth_names] || ['API_KEY']
963
+
964
+ new_options = opts.merge(
965
+ :header_params => header_params,
966
+ :query_params => query_params,
967
+ :form_params => form_params,
968
+ :body => post_body,
969
+ :auth_names => auth_names,
970
+ :return_type => return_type
971
+ )
972
+
973
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
974
+ if @api_client.config.debugging
975
+ @api_client.config.logger.debug "API called: SmsControllerApi#set_sms_favourited\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
976
+ end
977
+ return data, status_code, headers
978
+ end
529
979
  end
530
980
  end