mailslurp_client 13.0.1 → 13.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/alias_controller_api.rb +1 -1
  3. data/lib/mailslurp_client/api/attachment_controller_api.rb +1 -1
  4. data/lib/mailslurp_client/api/bounce_controller_api.rb +1 -1
  5. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
  6. data/lib/mailslurp_client/api/common_actions_controller_api.rb +1 -1
  7. data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
  8. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  9. data/lib/mailslurp_client/api/email_controller_api.rb +5 -5
  10. data/lib/mailslurp_client/api/expired_controller_api.rb +1 -1
  11. data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
  12. data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
  13. data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
  14. data/lib/mailslurp_client/api/inbox_controller_api.rb +1 -1
  15. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +1 -1
  16. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +1 -1
  17. data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
  18. data/lib/mailslurp_client/api/missed_email_controller_api.rb +76 -1
  19. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
  20. data/lib/mailslurp_client/api/template_controller_api.rb +75 -7
  21. data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
  22. data/lib/mailslurp_client/api/wait_for_controller_api.rb +7 -7
  23. data/lib/mailslurp_client/api/webhook_controller_api.rb +124 -8
  24. data/lib/mailslurp_client/api_client.rb +1 -1
  25. data/lib/mailslurp_client/api_error.rb +1 -1
  26. data/lib/mailslurp_client/configuration.rb +1 -1
  27. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
  28. data/lib/mailslurp_client/models/alias_dto.rb +1 -1
  29. data/lib/mailslurp_client/models/alias_projection.rb +1 -1
  30. data/lib/mailslurp_client/models/attachment_entity.rb +1 -1
  31. data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
  32. data/lib/mailslurp_client/models/attachment_projection.rb +1 -1
  33. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  34. data/lib/mailslurp_client/models/bounce_projection.rb +1 -1
  35. data/lib/mailslurp_client/models/bounce_recipient.rb +1 -1
  36. data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
  37. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
  38. data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
  39. data/lib/mailslurp_client/models/condition_option.rb +1 -1
  40. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  41. data/lib/mailslurp_client/models/contact_projection.rb +1 -1
  42. data/lib/mailslurp_client/models/content_match_options.rb +1 -1
  43. data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
  44. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  45. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  46. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  47. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  48. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
  49. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
  50. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  51. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
  52. data/lib/mailslurp_client/models/create_webhook_options.rb +3 -3
  53. data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
  54. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
  55. data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
  56. data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
  57. data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
  58. data/lib/mailslurp_client/models/domain_dto.rb +1 -1
  59. data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
  60. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  61. data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
  62. data/lib/mailslurp_client/models/email.rb +29 -11
  63. data/lib/mailslurp_client/models/email_analysis.rb +1 -1
  64. data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
  65. data/lib/mailslurp_client/models/email_links_result.rb +1 -1
  66. data/lib/mailslurp_client/models/email_preview.rb +7 -7
  67. data/lib/mailslurp_client/models/email_projection.rb +1 -1
  68. data/lib/mailslurp_client/models/email_recipients.rb +230 -0
  69. data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
  70. data/lib/mailslurp_client/models/email_verification_result.rb +2 -2
  71. data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
  72. data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
  73. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +1 -1
  74. data/lib/mailslurp_client/models/export_link.rb +1 -1
  75. data/lib/mailslurp_client/models/export_options.rb +1 -1
  76. data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
  77. data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
  78. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  79. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  80. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  81. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  82. data/lib/mailslurp_client/models/inbox.rb +1 -1
  83. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +1 -1
  84. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  85. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
  86. data/lib/mailslurp_client/models/inbox_projection.rb +1 -1
  87. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
  88. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  89. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
  90. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  91. data/lib/mailslurp_client/models/match_option.rb +1 -1
  92. data/lib/mailslurp_client/models/match_options.rb +1 -1
  93. data/lib/mailslurp_client/models/missed_email.rb +1 -6
  94. data/lib/mailslurp_client/models/missed_email_projection.rb +1 -6
  95. data/lib/mailslurp_client/models/name_server_record.rb +1 -1
  96. data/lib/mailslurp_client/models/organization_inbox_projection.rb +1 -1
  97. data/lib/mailslurp_client/models/page_alias.rb +1 -1
  98. data/lib/mailslurp_client/models/page_attachment_entity.rb +1 -1
  99. data/lib/mailslurp_client/models/page_bounced_email.rb +1 -1
  100. data/lib/mailslurp_client/models/page_bounced_recipients.rb +1 -1
  101. data/lib/mailslurp_client/models/page_contact_projection.rb +1 -1
  102. data/lib/mailslurp_client/models/page_email_preview.rb +1 -1
  103. data/lib/mailslurp_client/models/page_email_projection.rb +1 -1
  104. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +1 -1
  105. data/lib/mailslurp_client/models/page_group_projection.rb +1 -1
  106. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +1 -1
  107. data/lib/mailslurp_client/models/page_inbox_projection.rb +1 -1
  108. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +1 -1
  109. data/lib/mailslurp_client/models/page_missed_email_projection.rb +1 -1
  110. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +1 -1
  111. data/lib/mailslurp_client/models/page_sent_email_projection.rb +1 -1
  112. data/lib/mailslurp_client/models/page_template_projection.rb +1 -1
  113. data/lib/mailslurp_client/models/page_thread_projection.rb +1 -1
  114. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +1 -1
  115. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +299 -0
  116. data/lib/mailslurp_client/models/page_webhook_projection.rb +2 -1
  117. data/lib/mailslurp_client/models/page_webhook_result.rb +2 -2
  118. data/lib/mailslurp_client/models/pageable.rb +1 -1
  119. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  120. data/lib/mailslurp_client/models/{model_alias.rb → recipient.rb} +14 -74
  121. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
  122. data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
  123. data/lib/mailslurp_client/models/send_email_options.rb +1 -1
  124. data/lib/mailslurp_client/models/sender.rb +234 -0
  125. data/lib/mailslurp_client/models/sent_email_dto.rb +1 -1
  126. data/lib/mailslurp_client/models/sent_email_projection.rb +1 -1
  127. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  128. data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
  129. data/lib/mailslurp_client/models/sort.rb +1 -1
  130. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  131. data/lib/mailslurp_client/models/template_projection.rb +1 -1
  132. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  133. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  134. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  135. data/lib/mailslurp_client/models/thread_projection.rb +1 -1
  136. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
  137. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +1 -1
  138. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +254 -0
  139. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  140. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  141. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  142. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  143. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  144. data/lib/mailslurp_client/models/upload_attachment_options.rb +2 -2
  145. data/lib/mailslurp_client/models/validation_dto.rb +1 -1
  146. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  147. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  148. data/lib/mailslurp_client/models/wait_for_conditions.rb +28 -3
  149. data/lib/mailslurp_client/models/webhook_dto.rb +3 -3
  150. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
  151. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +312 -0
  152. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
  153. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
  154. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +8 -8
  155. data/lib/mailslurp_client/models/webhook_projection.rb +3 -3
  156. data/lib/mailslurp_client/models/webhook_redrive_result.rb +234 -0
  157. data/lib/mailslurp_client/models/{webhook_result_entity.rb → webhook_result_dto.rb} +16 -7
  158. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  159. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  160. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  161. data/lib/mailslurp_client/version.rb +2 -2
  162. data/lib/mailslurp_client.rb +9 -3
  163. metadata +10 -4
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -15,7 +15,7 @@ require 'date'
15
15
  module MailSlurpClient
16
16
  # Options for uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your `SendEmailOptions` when sending an email. This way you can use attachments multiple times once they have been uploaded.
17
17
  class UploadAttachmentOptions
18
- # Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string.
18
+ # Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/
19
19
  attr_accessor :base64_contents
20
20
 
21
21
  # Optional contentType for file. For instance `application/pdf`
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -27,13 +27,16 @@ module MailSlurpClient
27
27
  # Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.
28
28
  attr_accessor :matches
29
29
 
30
+ # ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date
31
+ attr_accessor :since
32
+
30
33
  # Direction to sort matching emails by created time
31
34
  attr_accessor :sort_direction
32
35
 
33
36
  # Max time in milliseconds to retry the `waitFor` operation until conditions are met.
34
37
  attr_accessor :timeout
35
38
 
36
- # Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.
39
+ # Apply conditions only to **unread** emails. All emails begin with `read=false`. An email is marked `read=true` when an `EmailDto` representation of it has been returned to the user at least once. For example you have called `getEmail` or `waitForLatestEmail` etc., or you have viewed the email in the dashboard.
37
40
  attr_accessor :unread_only
38
41
 
39
42
  class EnumAttributeValidator
@@ -65,6 +68,7 @@ module MailSlurpClient
65
68
  :'count_type' => :'countType',
66
69
  :'inbox_id' => :'inboxId',
67
70
  :'matches' => :'matches',
71
+ :'since' => :'since',
68
72
  :'sort_direction' => :'sortDirection',
69
73
  :'timeout' => :'timeout',
70
74
  :'unread_only' => :'unreadOnly'
@@ -78,6 +82,7 @@ module MailSlurpClient
78
82
  :'count_type' => :'String',
79
83
  :'inbox_id' => :'String',
80
84
  :'matches' => :'Array<MatchOption>',
85
+ :'since' => :'DateTime',
81
86
  :'sort_direction' => :'String',
82
87
  :'timeout' => :'Integer',
83
88
  :'unread_only' => :'Boolean'
@@ -123,6 +128,10 @@ module MailSlurpClient
123
128
  end
124
129
  end
125
130
 
131
+ if attributes.key?(:'since')
132
+ self.since = attributes[:'since']
133
+ end
134
+
126
135
  if attributes.key?(:'sort_direction')
127
136
  self.sort_direction = attributes[:'sort_direction']
128
137
  end
@@ -140,16 +149,31 @@ module MailSlurpClient
140
149
  # @return Array for valid properties with the reasons
141
150
  def list_invalid_properties
142
151
  invalid_properties = Array.new
152
+ if @count.nil?
153
+ invalid_properties.push('invalid value for "count", count cannot be nil.')
154
+ end
155
+
156
+ if @inbox_id.nil?
157
+ invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
158
+ end
159
+
160
+ if @timeout.nil?
161
+ invalid_properties.push('invalid value for "timeout", timeout cannot be nil.')
162
+ end
163
+
143
164
  invalid_properties
144
165
  end
145
166
 
146
167
  # Check to see if the all the properties in the model are valid
147
168
  # @return true if the model is valid
148
169
  def valid?
170
+ return false if @count.nil?
149
171
  count_type_validator = EnumAttributeValidator.new('String', ["EXACTLY", "ATLEAST"])
150
172
  return false unless count_type_validator.valid?(@count_type)
173
+ return false if @inbox_id.nil?
151
174
  sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
152
175
  return false unless sort_direction_validator.valid?(@sort_direction)
176
+ return false if @timeout.nil?
153
177
  true
154
178
  end
155
179
 
@@ -182,6 +206,7 @@ module MailSlurpClient
182
206
  count_type == o.count_type &&
183
207
  inbox_id == o.inbox_id &&
184
208
  matches == o.matches &&
209
+ since == o.since &&
185
210
  sort_direction == o.sort_direction &&
186
211
  timeout == o.timeout &&
187
212
  unread_only == o.unread_only
@@ -196,7 +221,7 @@ module MailSlurpClient
196
221
  # Calculates hash code according to all attributes.
197
222
  # @return [Integer] Hash code
198
223
  def hash
199
- [count, count_type, inbox_id, matches, sort_direction, timeout, unread_only].hash
224
+ [count, count_type, inbox_id, matches, since, sort_direction, timeout, unread_only].hash
200
225
  end
201
226
 
202
227
  # Builds the object from hash
@@ -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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -182,7 +182,7 @@ module MailSlurpClient
182
182
  # Check to see if the all the properties in the model are valid
183
183
  # @return true if the model is valid
184
184
  def valid?
185
- event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
185
+ event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
186
186
  return false unless event_name_validator.valid?(@event_name)
187
187
  method_validator = EnumAttributeValidator.new('String', ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"])
188
188
  return false unless method_validator.valid?(@method)
@@ -193,7 +193,7 @@ module MailSlurpClient
193
193
  # Custom attribute writer method checking allowed values (enum).
194
194
  # @param [Object] event_name Object to be assigned
195
195
  def event_name=(event_name)
196
- validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
196
+ validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
197
197
  unless validator.valid?(event_name)
198
198
  fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
199
199
  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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
 
@@ -162,7 +162,7 @@ module MailSlurpClient
162
162
  # Check to see if the all the properties in the model are valid
163
163
  # @return true if the model is valid
164
164
  def valid?
165
- event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
165
+ event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
166
166
  return false unless event_name_validator.valid?(@event_name)
167
167
  true
168
168
  end
@@ -170,7 +170,7 @@ module MailSlurpClient
170
170
  # Custom attribute writer method checking allowed values (enum).
171
171
  # @param [Object] event_name Object to be assigned
172
172
  def event_name=(event_name)
173
- validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
173
+ validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
174
174
  unless validator.valid?(event_name)
175
175
  fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
176
176
  end
@@ -0,0 +1,312 @@
1
+ =begin
2
+ #MailSlurp API
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://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
5
+
6
+ The version of the OpenAPI document: 6.5.2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module MailSlurpClient
16
+ # EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.
17
+ class WebhookEmailReadPayload
18
+ # Date time of event creation
19
+ attr_accessor :created_at
20
+
21
+ # ID of the email that was received. Use this ID for fetching the email with the `EmailController`.
22
+ attr_accessor :email_id
23
+
24
+ # Is the email read
25
+ attr_accessor :email_is_read
26
+
27
+ # Name of the event type webhook is being triggered for.
28
+ attr_accessor :event_name
29
+
30
+ # Id of the inbox that received an email
31
+ attr_accessor :inbox_id
32
+
33
+ # Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
34
+ attr_accessor :message_id
35
+
36
+ # ID of webhook entity being triggered
37
+ attr_accessor :webhook_id
38
+
39
+ # Name of the webhook being triggered
40
+ attr_accessor :webhook_name
41
+
42
+ class EnumAttributeValidator
43
+ attr_reader :datatype
44
+ attr_reader :allowable_values
45
+
46
+ def initialize(datatype, allowable_values)
47
+ @allowable_values = allowable_values.map do |value|
48
+ case datatype.to_s
49
+ when /Integer/i
50
+ value.to_i
51
+ when /Float/i
52
+ value.to_f
53
+ else
54
+ value
55
+ end
56
+ end
57
+ end
58
+
59
+ def valid?(value)
60
+ !value || allowable_values.include?(value)
61
+ end
62
+ end
63
+
64
+ # Attribute mapping from ruby-style variable name to JSON key.
65
+ def self.attribute_map
66
+ {
67
+ :'created_at' => :'createdAt',
68
+ :'email_id' => :'emailId',
69
+ :'email_is_read' => :'emailIsRead',
70
+ :'event_name' => :'eventName',
71
+ :'inbox_id' => :'inboxId',
72
+ :'message_id' => :'messageId',
73
+ :'webhook_id' => :'webhookId',
74
+ :'webhook_name' => :'webhookName'
75
+ }
76
+ end
77
+
78
+ # Attribute type mapping.
79
+ def self.openapi_types
80
+ {
81
+ :'created_at' => :'DateTime',
82
+ :'email_id' => :'String',
83
+ :'email_is_read' => :'Boolean',
84
+ :'event_name' => :'String',
85
+ :'inbox_id' => :'String',
86
+ :'message_id' => :'String',
87
+ :'webhook_id' => :'String',
88
+ :'webhook_name' => :'String'
89
+ }
90
+ end
91
+
92
+ # List of attributes with nullable: true
93
+ def self.openapi_nullable
94
+ Set.new([
95
+ ])
96
+ end
97
+
98
+ # Initializes the object
99
+ # @param [Hash] attributes Model attributes in the form of hash
100
+ def initialize(attributes = {})
101
+ if (!attributes.is_a?(Hash))
102
+ fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookEmailReadPayload` initialize method"
103
+ end
104
+
105
+ # check to see if the attribute exists and convert string to symbol for hash key
106
+ attributes = attributes.each_with_object({}) { |(k, v), h|
107
+ if (!self.class.attribute_map.key?(k.to_sym))
108
+ fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::WebhookEmailReadPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
109
+ end
110
+ h[k.to_sym] = v
111
+ }
112
+
113
+ if attributes.key?(:'created_at')
114
+ self.created_at = attributes[:'created_at']
115
+ end
116
+
117
+ if attributes.key?(:'email_id')
118
+ self.email_id = attributes[:'email_id']
119
+ end
120
+
121
+ if attributes.key?(:'email_is_read')
122
+ self.email_is_read = attributes[:'email_is_read']
123
+ end
124
+
125
+ if attributes.key?(:'event_name')
126
+ self.event_name = attributes[:'event_name']
127
+ end
128
+
129
+ if attributes.key?(:'inbox_id')
130
+ self.inbox_id = attributes[:'inbox_id']
131
+ end
132
+
133
+ if attributes.key?(:'message_id')
134
+ self.message_id = attributes[:'message_id']
135
+ end
136
+
137
+ if attributes.key?(:'webhook_id')
138
+ self.webhook_id = attributes[:'webhook_id']
139
+ end
140
+
141
+ if attributes.key?(:'webhook_name')
142
+ self.webhook_name = attributes[:'webhook_name']
143
+ end
144
+ end
145
+
146
+ # Show invalid properties with the reasons. Usually used together with valid?
147
+ # @return Array for valid properties with the reasons
148
+ def list_invalid_properties
149
+ invalid_properties = Array.new
150
+ invalid_properties
151
+ end
152
+
153
+ # Check to see if the all the properties in the model are valid
154
+ # @return true if the model is valid
155
+ def valid?
156
+ event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
157
+ return false unless event_name_validator.valid?(@event_name)
158
+ true
159
+ end
160
+
161
+ # Custom attribute writer method checking allowed values (enum).
162
+ # @param [Object] event_name Object to be assigned
163
+ def event_name=(event_name)
164
+ validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
165
+ unless validator.valid?(event_name)
166
+ fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
167
+ end
168
+ @event_name = event_name
169
+ end
170
+
171
+ # Checks equality by comparing each attribute.
172
+ # @param [Object] Object to be compared
173
+ def ==(o)
174
+ return true if self.equal?(o)
175
+ self.class == o.class &&
176
+ created_at == o.created_at &&
177
+ email_id == o.email_id &&
178
+ email_is_read == o.email_is_read &&
179
+ event_name == o.event_name &&
180
+ inbox_id == o.inbox_id &&
181
+ message_id == o.message_id &&
182
+ webhook_id == o.webhook_id &&
183
+ webhook_name == o.webhook_name
184
+ end
185
+
186
+ # @see the `==` method
187
+ # @param [Object] Object to be compared
188
+ def eql?(o)
189
+ self == o
190
+ end
191
+
192
+ # Calculates hash code according to all attributes.
193
+ # @return [Integer] Hash code
194
+ def hash
195
+ [created_at, email_id, email_is_read, event_name, inbox_id, message_id, webhook_id, webhook_name].hash
196
+ end
197
+
198
+ # Builds the object from hash
199
+ # @param [Hash] attributes Model attributes in the form of hash
200
+ # @return [Object] Returns the model itself
201
+ def self.build_from_hash(attributes)
202
+ new.build_from_hash(attributes)
203
+ end
204
+
205
+ # Builds the object from hash
206
+ # @param [Hash] attributes Model attributes in the form of hash
207
+ # @return [Object] Returns the model itself
208
+ def build_from_hash(attributes)
209
+ return nil unless attributes.is_a?(Hash)
210
+ self.class.openapi_types.each_pair do |key, type|
211
+ if type =~ /\AArray<(.*)>/i
212
+ # check to ensure the input is an array given that the attribute
213
+ # is documented as an array but the input is not
214
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
215
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
216
+ end
217
+ elsif !attributes[self.class.attribute_map[key]].nil?
218
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
219
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
220
+ end
221
+
222
+ self
223
+ end
224
+
225
+ # Deserializes the data based on type
226
+ # @param string type Data type
227
+ # @param string value Value to be deserialized
228
+ # @return [Object] Deserialized data
229
+ def _deserialize(type, value)
230
+ case type.to_sym
231
+ when :DateTime
232
+ DateTime.parse(value)
233
+ when :Date
234
+ Date.parse(value)
235
+ when :String
236
+ value.to_s
237
+ when :Integer
238
+ value.to_i
239
+ when :Float
240
+ value.to_f
241
+ when :Boolean
242
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
243
+ true
244
+ else
245
+ false
246
+ end
247
+ when :Object
248
+ # generic object (usually a Hash), return directly
249
+ value
250
+ when /\AArray<(?<inner_type>.+)>\z/
251
+ inner_type = Regexp.last_match[:inner_type]
252
+ value.map { |v| _deserialize(inner_type, v) }
253
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
254
+ k_type = Regexp.last_match[:k_type]
255
+ v_type = Regexp.last_match[:v_type]
256
+ {}.tap do |hash|
257
+ value.each do |k, v|
258
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
259
+ end
260
+ end
261
+ else # model
262
+ MailSlurpClient.const_get(type).build_from_hash(value)
263
+ end
264
+ end
265
+
266
+ # Returns the string representation of the object
267
+ # @return [String] String presentation of the object
268
+ def to_s
269
+ to_hash.to_s
270
+ end
271
+
272
+ # to_body is an alias to to_hash (backward compatibility)
273
+ # @return [Hash] Returns the object in the form of hash
274
+ def to_body
275
+ to_hash
276
+ end
277
+
278
+ # Returns the object in the form of hash
279
+ # @return [Hash] Returns the object in the form of hash
280
+ def to_hash
281
+ hash = {}
282
+ self.class.attribute_map.each_pair do |attr, param|
283
+ value = self.send(attr)
284
+ if value.nil?
285
+ is_nullable = self.class.openapi_nullable.include?(attr)
286
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
287
+ end
288
+
289
+ hash[param] = _to_hash(value)
290
+ end
291
+ hash
292
+ end
293
+
294
+ # Outputs non-array value in the form of hash
295
+ # For object, use to_hash. Otherwise, just return the value
296
+ # @param [Object] value Any valid value
297
+ # @return [Hash] Returns the value in the form of hash
298
+ def _to_hash(value)
299
+ if value.is_a?(Array)
300
+ value.compact.map { |v| _to_hash(v) }
301
+ elsif value.is_a?(Hash)
302
+ {}.tap do |hash|
303
+ value.each { |k, v| hash[k] = _to_hash(v) }
304
+ end
305
+ elsif value.respond_to? :to_hash
306
+ value.to_hash
307
+ else
308
+ value
309
+ end
310
+ end
311
+ end
312
+ end