mailslurp_client 13.0.1 → 14.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/alias_controller_api.rb +19 -1
  3. data/lib/mailslurp_client/api/attachment_controller_api.rb +7 -1
  4. data/lib/mailslurp_client/api/bounce_controller_api.rb +13 -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 +45 -1
  7. data/lib/mailslurp_client/api/contact_controller_api.rb +7 -1
  8. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  9. data/lib/mailslurp_client/api/email_controller_api.rb +17 -5
  10. data/lib/mailslurp_client/api/expired_controller_api.rb +7 -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 +13 -1
  14. data/lib/mailslurp_client/api/inbox_controller_api.rb +111 -7
  15. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +7 -1
  16. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +7 -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 +94 -1
  19. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +25 -1
  20. data/lib/mailslurp_client/api/template_controller_api.rb +81 -7
  21. data/lib/mailslurp_client/api/tracking_controller_api.rb +7 -1
  22. data/lib/mailslurp_client/api/wait_for_controller_api.rb +22 -7
  23. data/lib/mailslurp_client/api/webhook_controller_api.rb +386 -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 +2 -2
  48. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +18 -29
  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 +19 -5
  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/flush_expired_inboxes_result.rb +227 -0
  77. data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
  78. data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
  79. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  80. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  81. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  82. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  83. data/lib/mailslurp_client/models/inbox.rb +1 -1
  84. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +1 -1
  85. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  86. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
  87. data/lib/mailslurp_client/models/{inbox_projection.rb → inbox_preview.rb} +23 -25
  88. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
  89. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  90. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
  91. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  92. data/lib/mailslurp_client/models/json_schema_dto.rb +211 -0
  93. data/lib/mailslurp_client/models/match_option.rb +1 -1
  94. data/lib/mailslurp_client/models/match_options.rb +1 -1
  95. data/lib/mailslurp_client/models/missed_email.rb +1 -6
  96. data/lib/mailslurp_client/models/missed_email_projection.rb +1 -6
  97. data/lib/mailslurp_client/models/name_server_record.rb +1 -1
  98. data/lib/mailslurp_client/models/organization_inbox_projection.rb +1 -1
  99. data/lib/mailslurp_client/models/page_alias.rb +1 -1
  100. data/lib/mailslurp_client/models/page_attachment_entity.rb +1 -1
  101. data/lib/mailslurp_client/models/page_bounced_email.rb +1 -1
  102. data/lib/mailslurp_client/models/page_bounced_recipients.rb +1 -1
  103. data/lib/mailslurp_client/models/page_contact_projection.rb +1 -1
  104. data/lib/mailslurp_client/models/page_email_preview.rb +1 -1
  105. data/lib/mailslurp_client/models/page_email_projection.rb +1 -1
  106. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +1 -1
  107. data/lib/mailslurp_client/models/page_group_projection.rb +1 -1
  108. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +1 -1
  109. data/lib/mailslurp_client/models/page_inbox_projection.rb +2 -2
  110. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +1 -1
  111. data/lib/mailslurp_client/models/page_missed_email_projection.rb +1 -1
  112. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +1 -1
  113. data/lib/mailslurp_client/models/page_sent_email_projection.rb +1 -1
  114. data/lib/mailslurp_client/models/page_template_projection.rb +1 -1
  115. data/lib/mailslurp_client/models/page_thread_projection.rb +1 -1
  116. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +1 -1
  117. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +299 -0
  118. data/lib/mailslurp_client/models/page_webhook_projection.rb +2 -1
  119. data/lib/mailslurp_client/models/page_webhook_result.rb +2 -2
  120. data/lib/mailslurp_client/models/pageable.rb +1 -1
  121. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  122. data/lib/mailslurp_client/models/{model_alias.rb → recipient.rb} +14 -74
  123. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
  124. data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
  125. data/lib/mailslurp_client/models/send_email_options.rb +1 -1
  126. data/lib/mailslurp_client/models/sender.rb +234 -0
  127. data/lib/mailslurp_client/models/sent_email_dto.rb +1 -1
  128. data/lib/mailslurp_client/models/sent_email_projection.rb +1 -1
  129. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  130. data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
  131. data/lib/mailslurp_client/models/sort.rb +1 -1
  132. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  133. data/lib/mailslurp_client/models/template_projection.rb +1 -1
  134. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  135. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  136. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  137. data/lib/mailslurp_client/models/thread_projection.rb +1 -1
  138. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
  139. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +1 -1
  140. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +254 -0
  141. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  142. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +211 -0
  143. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  144. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  145. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  146. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  147. data/lib/mailslurp_client/models/upload_attachment_options.rb +2 -2
  148. data/lib/mailslurp_client/models/validation_dto.rb +1 -1
  149. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  150. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  151. data/lib/mailslurp_client/models/wait_for_conditions.rb +43 -3
  152. data/lib/mailslurp_client/models/webhook_dto.rb +4 -4
  153. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
  154. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +312 -0
  155. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
  156. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
  157. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +8 -8
  158. data/lib/mailslurp_client/models/webhook_projection.rb +3 -3
  159. data/lib/mailslurp_client/models/webhook_redrive_result.rb +234 -0
  160. data/lib/mailslurp_client/models/{webhook_result_entity.rb → webhook_result_dto.rb} +25 -7
  161. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  162. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  163. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  164. data/lib/mailslurp_client/version.rb +2 -2
  165. data/lib/mailslurp_client.rb +13 -4
  166. metadata +14 -5
@@ -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
 
@@ -20,19 +20,19 @@ module MailSlurpClient
20
20
  # List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
21
21
  attr_accessor :attachments
22
22
 
23
- # List of `BCC` recipients email was addressed to
23
+ # List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
24
24
  attr_accessor :bcc
25
25
 
26
- # The body of the email message
26
+ # The body of the email message as text parsed from the SMTP message body (does not include attachments). Fetch the raw content to access the SMTP message and use the attachments property to access attachments. The body is stored separately to the email entity so the body is not returned in paginated results only in full single email or wait requests.
27
27
  attr_accessor :body
28
28
 
29
- # An excerpt of the body of the email message
29
+ # An excerpt of the body of the email message for quick preview .
30
30
  attr_accessor :body_excerpt
31
31
 
32
- # A hash signature of the email message
32
+ # A hash signature of the email message using MD5. Useful for comparing emails without fetching full body.
33
33
  attr_accessor :body_md5_hash
34
34
 
35
- # List of `CC` recipients email was addressed to
35
+ # List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
36
36
  attr_accessor :cc
37
37
 
38
38
  # Detected character set of the email body such as UTF-8
@@ -41,7 +41,7 @@ module MailSlurpClient
41
41
  # When was the email received by MailSlurp
42
42
  attr_accessor :created_at
43
43
 
44
- # Who the email was sent from
44
+ # Who the email was sent from. An email address - see fromName for the sender name.
45
45
  attr_accessor :from
46
46
 
47
47
  # Collection of SMTP headers attached to email
@@ -56,19 +56,23 @@ module MailSlurpClient
56
56
  # Is the email body HTML
57
57
  attr_accessor :is_html
58
58
 
59
- # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
59
+ # Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.
60
60
  attr_accessor :read
61
61
 
62
+ attr_accessor :recipients
63
+
62
64
  # The `replyTo` field on the received email message
63
65
  attr_accessor :reply_to
64
66
 
65
- # The subject line of the email message
67
+ attr_accessor :sender
68
+
69
+ # The subject line of the email message as specified by SMTP subject header
66
70
  attr_accessor :subject
67
71
 
68
72
  # Can the email be accessed by organization team members
69
73
  attr_accessor :team_access
70
74
 
71
- # List of `To` recipients that email was addressed to
75
+ # List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
72
76
  attr_accessor :to
73
77
 
74
78
  # When was the email last updated
@@ -95,7 +99,9 @@ module MailSlurpClient
95
99
  :'inbox_id' => :'inboxId',
96
100
  :'is_html' => :'isHTML',
97
101
  :'read' => :'read',
102
+ :'recipients' => :'recipients',
98
103
  :'reply_to' => :'replyTo',
104
+ :'sender' => :'sender',
99
105
  :'subject' => :'subject',
100
106
  :'team_access' => :'teamAccess',
101
107
  :'to' => :'to',
@@ -122,7 +128,9 @@ module MailSlurpClient
122
128
  :'inbox_id' => :'String',
123
129
  :'is_html' => :'Boolean',
124
130
  :'read' => :'Boolean',
131
+ :'recipients' => :'EmailRecipients',
125
132
  :'reply_to' => :'String',
133
+ :'sender' => :'Sender',
126
134
  :'subject' => :'String',
127
135
  :'team_access' => :'Boolean',
128
136
  :'to' => :'Array<String>',
@@ -220,10 +228,18 @@ module MailSlurpClient
220
228
  self.read = attributes[:'read']
221
229
  end
222
230
 
231
+ if attributes.key?(:'recipients')
232
+ self.recipients = attributes[:'recipients']
233
+ end
234
+
223
235
  if attributes.key?(:'reply_to')
224
236
  self.reply_to = attributes[:'reply_to']
225
237
  end
226
238
 
239
+ if attributes.key?(:'sender')
240
+ self.sender = attributes[:'sender']
241
+ end
242
+
227
243
  if attributes.key?(:'subject')
228
244
  self.subject = attributes[:'subject']
229
245
  end
@@ -280,7 +296,9 @@ module MailSlurpClient
280
296
  inbox_id == o.inbox_id &&
281
297
  is_html == o.is_html &&
282
298
  read == o.read &&
299
+ recipients == o.recipients &&
283
300
  reply_to == o.reply_to &&
301
+ sender == o.sender &&
284
302
  subject == o.subject &&
285
303
  team_access == o.team_access &&
286
304
  to == o.to &&
@@ -297,7 +315,7 @@ module MailSlurpClient
297
315
  # Calculates hash code according to all attributes.
298
316
  # @return [Integer] Hash code
299
317
  def hash
300
- [analysis, attachments, bcc, body, body_excerpt, body_md5_hash, cc, charset, created_at, from, headers, id, inbox_id, is_html, read, reply_to, subject, team_access, to, updated_at, user_id].hash
318
+ [analysis, attachments, bcc, body, body_excerpt, body_md5_hash, cc, charset, created_at, from, headers, id, inbox_id, is_html, read, recipients, reply_to, sender, subject, team_access, to, updated_at, user_id].hash
301
319
  end
302
320
 
303
321
  # 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
 
@@ -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
 
@@ -18,28 +18,28 @@ module MailSlurpClient
18
18
  # List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.
19
19
  attr_accessor :attachments
20
20
 
21
- # List of `BCC` recipients email was addressed to
21
+ # List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
22
22
  attr_accessor :bcc
23
23
 
24
- # List of `CC` recipients email was addressed to
24
+ # List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
25
25
  attr_accessor :cc
26
26
 
27
27
  # When was the email received by MailSlurp
28
28
  attr_accessor :created_at
29
29
 
30
- # Who the email was sent from
30
+ # Who the email was sent from. An email address - see fromName for the sender name.
31
31
  attr_accessor :from
32
32
 
33
33
  # ID of the email entity
34
34
  attr_accessor :id
35
35
 
36
- # Read flag. Has the email ever been viewed in the dashboard or fetched via the API? If so the email is marked as read.
36
+ # Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.
37
37
  attr_accessor :read
38
38
 
39
- # The subject line of the email message
39
+ # The subject line of the email message as specified by SMTP subject header
40
40
  attr_accessor :subject
41
41
 
42
- # List of `To` recipients that email was addressed to
42
+ # List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
43
43
  attr_accessor :to
44
44
 
45
45
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -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
 
@@ -0,0 +1,230 @@
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
+ class EmailRecipients
17
+ attr_accessor :bcc
18
+
19
+ attr_accessor :cc
20
+
21
+ attr_accessor :to
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'bcc' => :'bcc',
27
+ :'cc' => :'cc',
28
+ :'to' => :'to'
29
+ }
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.openapi_types
34
+ {
35
+ :'bcc' => :'Array<Recipient>',
36
+ :'cc' => :'Array<Recipient>',
37
+ :'to' => :'Array<Recipient>'
38
+ }
39
+ end
40
+
41
+ # List of attributes with nullable: true
42
+ def self.openapi_nullable
43
+ Set.new([
44
+ ])
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ if (!attributes.is_a?(Hash))
51
+ fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailRecipients` initialize method"
52
+ end
53
+
54
+ # check to see if the attribute exists and convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h|
56
+ if (!self.class.attribute_map.key?(k.to_sym))
57
+ fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::EmailRecipients`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
58
+ end
59
+ h[k.to_sym] = v
60
+ }
61
+
62
+ if attributes.key?(:'bcc')
63
+ if (value = attributes[:'bcc']).is_a?(Array)
64
+ self.bcc = value
65
+ end
66
+ end
67
+
68
+ if attributes.key?(:'cc')
69
+ if (value = attributes[:'cc']).is_a?(Array)
70
+ self.cc = value
71
+ end
72
+ end
73
+
74
+ if attributes.key?(:'to')
75
+ if (value = attributes[:'to']).is_a?(Array)
76
+ self.to = value
77
+ end
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ invalid_properties = Array.new
85
+ invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ bcc == o.bcc &&
100
+ cc == o.cc &&
101
+ to == o.to
102
+ end
103
+
104
+ # @see the `==` method
105
+ # @param [Object] Object to be compared
106
+ def eql?(o)
107
+ self == o
108
+ end
109
+
110
+ # Calculates hash code according to all attributes.
111
+ # @return [Integer] Hash code
112
+ def hash
113
+ [bcc, cc, to].hash
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def self.build_from_hash(attributes)
120
+ new.build_from_hash(attributes)
121
+ end
122
+
123
+ # Builds the object from hash
124
+ # @param [Hash] attributes Model attributes in the form of hash
125
+ # @return [Object] Returns the model itself
126
+ def build_from_hash(attributes)
127
+ return nil unless attributes.is_a?(Hash)
128
+ self.class.openapi_types.each_pair do |key, type|
129
+ if type =~ /\AArray<(.*)>/i
130
+ # check to ensure the input is an array given that the attribute
131
+ # is documented as an array but the input is not
132
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
133
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
134
+ end
135
+ elsif !attributes[self.class.attribute_map[key]].nil?
136
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
137
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
138
+ end
139
+
140
+ self
141
+ end
142
+
143
+ # Deserializes the data based on type
144
+ # @param string type Data type
145
+ # @param string value Value to be deserialized
146
+ # @return [Object] Deserialized data
147
+ def _deserialize(type, value)
148
+ case type.to_sym
149
+ when :DateTime
150
+ DateTime.parse(value)
151
+ when :Date
152
+ Date.parse(value)
153
+ when :String
154
+ value.to_s
155
+ when :Integer
156
+ value.to_i
157
+ when :Float
158
+ value.to_f
159
+ when :Boolean
160
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
161
+ true
162
+ else
163
+ false
164
+ end
165
+ when :Object
166
+ # generic object (usually a Hash), return directly
167
+ value
168
+ when /\AArray<(?<inner_type>.+)>\z/
169
+ inner_type = Regexp.last_match[:inner_type]
170
+ value.map { |v| _deserialize(inner_type, v) }
171
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
172
+ k_type = Regexp.last_match[:k_type]
173
+ v_type = Regexp.last_match[:v_type]
174
+ {}.tap do |hash|
175
+ value.each do |k, v|
176
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
177
+ end
178
+ end
179
+ else # model
180
+ MailSlurpClient.const_get(type).build_from_hash(value)
181
+ end
182
+ end
183
+
184
+ # Returns the string representation of the object
185
+ # @return [String] String presentation of the object
186
+ def to_s
187
+ to_hash.to_s
188
+ end
189
+
190
+ # to_body is an alias to to_hash (backward compatibility)
191
+ # @return [Hash] Returns the object in the form of hash
192
+ def to_body
193
+ to_hash
194
+ end
195
+
196
+ # Returns the object in the form of hash
197
+ # @return [Hash] Returns the object in the form of hash
198
+ def to_hash
199
+ hash = {}
200
+ self.class.attribute_map.each_pair do |attr, param|
201
+ value = self.send(attr)
202
+ if value.nil?
203
+ is_nullable = self.class.openapi_nullable.include?(attr)
204
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
205
+ end
206
+
207
+ hash[param] = _to_hash(value)
208
+ end
209
+ hash
210
+ end
211
+
212
+ # Outputs non-array value in the form of hash
213
+ # For object, use to_hash. Otherwise, just return the value
214
+ # @param [Object] value Any valid value
215
+ # @return [Hash] Returns the value in the form of hash
216
+ def _to_hash(value)
217
+ if value.is_a?(Array)
218
+ value.compact.map { |v| _to_hash(v) }
219
+ elsif value.is_a?(Hash)
220
+ {}.tap do |hash|
221
+ value.each { |k, v| hash[k] = _to_hash(v) }
222
+ end
223
+ elsif value.respond_to? :to_hash
224
+ value.to_hash
225
+ else
226
+ value
227
+ end
228
+ end
229
+ end
230
+ 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
 
@@ -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
 
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module MailSlurpClient
16
- # Email verification result. Valid means email address exists according to response from mail server running at the domian and port given.
16
+ # Email verification result. Valid means email address exists according to response from mail server running at the domain and port given.
17
17
  class EmailVerificationResult
18
18
  attr_accessor :domain_name
19
19
 
@@ -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
 
@@ -23,13 +23,16 @@ module MailSlurpClient
23
23
 
24
24
  attr_accessor :max_expiration_millis
25
25
 
26
+ attr_accessor :next_inbox_allows_permanent
27
+
26
28
  # Attribute mapping from ruby-style variable name to JSON key.
27
29
  def self.attribute_map
28
30
  {
29
31
  :'can_permanent_inbox' => :'canPermanentInbox',
30
32
  :'default_expiration_millis' => :'defaultExpirationMillis',
31
33
  :'default_expires_at' => :'defaultExpiresAt',
32
- :'max_expiration_millis' => :'maxExpirationMillis'
34
+ :'max_expiration_millis' => :'maxExpirationMillis',
35
+ :'next_inbox_allows_permanent' => :'nextInboxAllowsPermanent'
33
36
  }
34
37
  end
35
38
 
@@ -39,7 +42,8 @@ module MailSlurpClient
39
42
  :'can_permanent_inbox' => :'Boolean',
40
43
  :'default_expiration_millis' => :'Integer',
41
44
  :'default_expires_at' => :'DateTime',
42
- :'max_expiration_millis' => :'Integer'
45
+ :'max_expiration_millis' => :'Integer',
46
+ :'next_inbox_allows_permanent' => :'Boolean'
43
47
  }
44
48
  end
45
49
 
@@ -79,6 +83,10 @@ module MailSlurpClient
79
83
  if attributes.key?(:'max_expiration_millis')
80
84
  self.max_expiration_millis = attributes[:'max_expiration_millis']
81
85
  end
86
+
87
+ if attributes.key?(:'next_inbox_allows_permanent')
88
+ self.next_inbox_allows_permanent = attributes[:'next_inbox_allows_permanent']
89
+ end
82
90
  end
83
91
 
84
92
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,6 +97,10 @@ module MailSlurpClient
89
97
  invalid_properties.push('invalid value for "can_permanent_inbox", can_permanent_inbox cannot be nil.')
90
98
  end
91
99
 
100
+ if @next_inbox_allows_permanent.nil?
101
+ invalid_properties.push('invalid value for "next_inbox_allows_permanent", next_inbox_allows_permanent cannot be nil.')
102
+ end
103
+
92
104
  invalid_properties
93
105
  end
94
106
 
@@ -96,6 +108,7 @@ module MailSlurpClient
96
108
  # @return true if the model is valid
97
109
  def valid?
98
110
  return false if @can_permanent_inbox.nil?
111
+ return false if @next_inbox_allows_permanent.nil?
99
112
  true
100
113
  end
101
114
 
@@ -107,7 +120,8 @@ module MailSlurpClient
107
120
  can_permanent_inbox == o.can_permanent_inbox &&
108
121
  default_expiration_millis == o.default_expiration_millis &&
109
122
  default_expires_at == o.default_expires_at &&
110
- max_expiration_millis == o.max_expiration_millis
123
+ max_expiration_millis == o.max_expiration_millis &&
124
+ next_inbox_allows_permanent == o.next_inbox_allows_permanent
111
125
  end
112
126
 
113
127
  # @see the `==` method
@@ -119,7 +133,7 @@ module MailSlurpClient
119
133
  # Calculates hash code according to all attributes.
120
134
  # @return [Integer] Hash code
121
135
  def hash
122
- [can_permanent_inbox, default_expiration_millis, default_expires_at, max_expiration_millis].hash
136
+ [can_permanent_inbox, default_expiration_millis, default_expires_at, max_expiration_millis, next_inbox_allows_permanent].hash
123
137
  end
124
138
 
125
139
  # 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
 
@@ -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