mailslurp_client 15.0.3 → 15.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/lib/mailslurp_client/api/alias_controller_api.rb +59 -55
  4. data/lib/mailslurp_client/api/attachment_controller_api.rb +49 -60
  5. data/lib/mailslurp_client/api/bounce_controller_api.rb +26 -18
  6. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +15 -15
  7. data/lib/mailslurp_client/api/common_actions_controller_api.rb +128 -67
  8. data/lib/mailslurp_client/api/contact_controller_api.rb +22 -22
  9. data/lib/mailslurp_client/api/domain_controller_api.rb +32 -32
  10. data/lib/mailslurp_client/api/email_controller_api.rb +137 -117
  11. data/lib/mailslurp_client/api/expired_controller_api.rb +19 -19
  12. data/lib/mailslurp_client/api/export_controller_api.rb +38 -38
  13. data/lib/mailslurp_client/api/form_controller_api.rb +16 -18
  14. data/lib/mailslurp_client/api/group_controller_api.rb +52 -52
  15. data/lib/mailslurp_client/api/inbox_controller_api.rb +256 -236
  16. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +33 -29
  17. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +33 -29
  18. data/lib/mailslurp_client/api/mail_server_controller_api.rb +26 -26
  19. data/lib/mailslurp_client/api/missed_email_controller_api.rb +54 -42
  20. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +157 -47
  21. data/lib/mailslurp_client/api/template_controller_api.rb +21 -21
  22. data/lib/mailslurp_client/api/tracking_controller_api.rb +16 -16
  23. data/lib/mailslurp_client/api/wait_for_controller_api.rb +128 -88
  24. data/lib/mailslurp_client/api/webhook_controller_api.rb +102 -86
  25. data/lib/mailslurp_client/configuration.rb +4 -4
  26. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +10 -25
  27. data/lib/mailslurp_client/models/alias_dto.rb +45 -56
  28. data/lib/mailslurp_client/models/alias_projection.rb +42 -72
  29. data/lib/mailslurp_client/models/attachment_entity.rb +34 -54
  30. data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -21
  31. data/lib/mailslurp_client/models/attachment_projection.rb +36 -51
  32. data/lib/mailslurp_client/models/basic_auth_options.rb +0 -10
  33. data/lib/mailslurp_client/models/bounce_projection.rb +13 -23
  34. data/lib/mailslurp_client/models/bounce_recipient.rb +22 -42
  35. data/lib/mailslurp_client/models/bounced_email_dto.rb +56 -76
  36. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -31
  37. data/lib/mailslurp_client/models/bulk_send_email_options.rb +5 -0
  38. data/lib/mailslurp_client/models/condition_option.rb +2 -2
  39. data/lib/mailslurp_client/models/contact_dto.rb +53 -73
  40. data/lib/mailslurp_client/models/contact_projection.rb +42 -52
  41. data/lib/mailslurp_client/models/count_dto.rb +0 -5
  42. data/lib/mailslurp_client/models/create_contact_options.rb +42 -42
  43. data/lib/mailslurp_client/models/create_domain_options.rb +21 -16
  44. data/lib/mailslurp_client/models/create_group_options.rb +0 -5
  45. data/lib/mailslurp_client/models/create_inbox_dto.rb +58 -58
  46. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +19 -14
  47. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +23 -23
  48. data/lib/mailslurp_client/models/create_template_options.rb +0 -10
  49. data/lib/mailslurp_client/models/create_webhook_options.rb +18 -18
  50. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +15 -25
  51. data/lib/mailslurp_client/models/dns_lookup_options.rb +24 -14
  52. data/lib/mailslurp_client/models/dns_lookup_result.rb +23 -42
  53. data/lib/mailslurp_client/models/dns_lookup_results.rb +0 -5
  54. data/lib/mailslurp_client/models/domain_dto.rb +59 -80
  55. data/lib/mailslurp_client/models/domain_name_record.rb +11 -30
  56. data/lib/mailslurp_client/models/domain_preview.rb +26 -50
  57. data/lib/mailslurp_client/models/email.rb +134 -135
  58. data/lib/mailslurp_client/models/email_analysis.rb +28 -28
  59. data/lib/mailslurp_client/models/email_content_match_result.rb +13 -23
  60. data/lib/mailslurp_client/models/email_links_result.rb +13 -23
  61. data/lib/mailslurp_client/models/email_preview.rb +47 -47
  62. data/lib/mailslurp_client/models/email_projection.rb +77 -97
  63. data/lib/mailslurp_client/models/email_recipients.rb +16 -15
  64. data/lib/mailslurp_client/models/email_text_lines_result.rb +13 -23
  65. data/lib/mailslurp_client/models/email_verification_result.rb +16 -36
  66. data/lib/mailslurp_client/models/expiration_defaults.rb +16 -26
  67. data/lib/mailslurp_client/models/expired_inbox_dto.rb +13 -28
  68. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +22 -42
  69. data/lib/mailslurp_client/models/export_link.rb +0 -5
  70. data/lib/mailslurp_client/models/export_options.rb +1 -6
  71. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +13 -23
  72. data/lib/mailslurp_client/models/forward_email_options.rb +36 -31
  73. data/lib/mailslurp_client/models/gravatar_url.rb +13 -23
  74. data/lib/mailslurp_client/models/group_contacts_dto.rb +13 -23
  75. data/lib/mailslurp_client/models/group_dto.rb +22 -37
  76. data/lib/mailslurp_client/models/group_projection.rb +22 -37
  77. data/lib/mailslurp_client/models/html_validation_result.rb +13 -14
  78. data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +47 -57
  79. data/lib/mailslurp_client/models/inbox_exists_dto.rb +0 -5
  80. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -61
  81. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +0 -5
  82. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +13 -23
  83. data/lib/mailslurp_client/models/inbox_preview.rb +38 -38
  84. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +43 -78
  85. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +0 -5
  86. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +13 -18
  87. data/lib/mailslurp_client/models/inline_object.rb +221 -0
  88. data/lib/mailslurp_client/models/ip_address_result.rb +0 -10
  89. data/lib/mailslurp_client/models/json_schema_dto.rb +0 -5
  90. data/lib/mailslurp_client/models/match_option.rb +7 -2
  91. data/lib/mailslurp_client/models/match_options.rb +16 -16
  92. data/lib/mailslurp_client/models/missed_email.rb +67 -102
  93. data/lib/mailslurp_client/models/missed_email_projection.rb +19 -29
  94. data/lib/mailslurp_client/models/name_server_record.rb +10 -30
  95. data/lib/mailslurp_client/models/organization_inbox_projection.rb +44 -44
  96. data/lib/mailslurp_client/models/page_alias.rb +52 -52
  97. data/lib/mailslurp_client/models/page_attachment_entity.rb +52 -52
  98. data/lib/mailslurp_client/models/page_bounced_email.rb +52 -52
  99. data/lib/mailslurp_client/models/page_bounced_recipients.rb +52 -52
  100. data/lib/mailslurp_client/models/page_contact_projection.rb +52 -52
  101. data/lib/mailslurp_client/models/page_email_preview.rb +52 -52
  102. data/lib/mailslurp_client/models/page_email_projection.rb +52 -52
  103. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +52 -52
  104. data/lib/mailslurp_client/models/page_group_projection.rb +52 -52
  105. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +52 -52
  106. data/lib/mailslurp_client/models/page_inbox_projection.rb +52 -52
  107. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +52 -52
  108. data/lib/mailslurp_client/models/page_missed_email_projection.rb +52 -52
  109. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +52 -52
  110. data/lib/mailslurp_client/models/page_sent_email_projection.rb +49 -49
  111. data/lib/mailslurp_client/models/page_template_projection.rb +52 -52
  112. data/lib/mailslurp_client/models/page_thread_projection.rb +52 -52
  113. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +52 -52
  114. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +52 -52
  115. data/lib/mailslurp_client/models/page_webhook_projection.rb +52 -52
  116. data/lib/mailslurp_client/models/page_webhook_result.rb +52 -52
  117. data/lib/mailslurp_client/models/pageable.rb +10 -10
  118. data/lib/mailslurp_client/models/raw_email_json.rb +0 -5
  119. data/lib/mailslurp_client/models/recipient.rb +13 -23
  120. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +38 -37
  121. data/lib/mailslurp_client/models/reply_to_email_options.rb +51 -50
  122. data/lib/mailslurp_client/models/send_email_options.rb +107 -115
  123. data/lib/mailslurp_client/models/sender.rb +14 -23
  124. data/lib/mailslurp_client/models/sent_email_dto.rb +97 -102
  125. data/lib/mailslurp_client/models/sent_email_projection.rb +66 -105
  126. data/lib/mailslurp_client/models/simple_send_email_options.rb +24 -24
  127. data/lib/mailslurp_client/models/template_dto.rb +22 -47
  128. data/lib/mailslurp_client/models/template_projection.rb +16 -41
  129. data/lib/mailslurp_client/models/template_variable.rb +0 -10
  130. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +0 -10
  131. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +0 -10
  132. data/lib/mailslurp_client/models/thread_projection.rb +60 -95
  133. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +43 -68
  134. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +34 -54
  135. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +19 -29
  136. data/lib/mailslurp_client/models/unread_count.rb +0 -5
  137. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +0 -5
  138. data/lib/mailslurp_client/models/update_group_contacts.rb +0 -5
  139. data/lib/mailslurp_client/models/update_inbox_options.rb +26 -26
  140. data/lib/mailslurp_client/models/upload_attachment_options.rb +14 -14
  141. data/lib/mailslurp_client/models/validation_message.rb +1 -5
  142. data/lib/mailslurp_client/models/verify_email_address_options.rb +0 -5
  143. data/lib/mailslurp_client/models/wait_for_conditions.rb +48 -58
  144. data/lib/mailslurp_client/models/webhook_dto.rb +64 -69
  145. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +42 -42
  146. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +49 -49
  147. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +43 -43
  148. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +75 -95
  149. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +84 -84
  150. data/lib/mailslurp_client/models/webhook_projection.rb +36 -61
  151. data/lib/mailslurp_client/models/webhook_redrive_result.rb +13 -23
  152. data/lib/mailslurp_client/models/webhook_result_dto.rb +76 -126
  153. data/lib/mailslurp_client/models/webhook_test_request.rb +21 -36
  154. data/lib/mailslurp_client/models/webhook_test_response.rb +13 -13
  155. data/lib/mailslurp_client/models/webhook_test_result.rb +13 -23
  156. data/lib/mailslurp_client/version.rb +1 -1
  157. data/lib/mailslurp_client.rb +2 -1
  158. metadata +4 -3
@@ -21,13 +21,13 @@ module MailSlurpClient
21
21
  end
22
22
  # Get all MissedEmails in paginated format
23
23
  # @param [Hash] opts the optional parameters
24
- # @option opts [DateTime] :before Filter by created at before the given timestamp
25
- # @option opts [String] :inbox_id Optional inbox ID filter
26
24
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
27
- # @option opts [String] :search_filter Optional search filter
28
- # @option opts [DateTime] :since Filter by created at after the given timestamp
29
25
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
30
26
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
27
+ # @option opts [String] :search_filter Optional search filter
28
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
29
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
30
+ # @option opts [String] :inbox_id Optional inbox ID filter
31
31
  # @return [PageMissedEmailProjection]
32
32
  def get_all_missed_emails(opts = {})
33
33
  data, _status_code, _headers = get_all_missed_emails_with_http_info(opts)
@@ -36,13 +36,13 @@ module MailSlurpClient
36
36
 
37
37
  # Get all MissedEmails in paginated format
38
38
  # @param [Hash] opts the optional parameters
39
- # @option opts [DateTime] :before Filter by created at before the given timestamp
40
- # @option opts [String] :inbox_id Optional inbox ID filter
41
39
  # @option opts [Integer] :page Optional page index in list pagination
42
- # @option opts [String] :search_filter Optional search filter
43
- # @option opts [DateTime] :since Filter by created at after the given timestamp
44
40
  # @option opts [Integer] :size Optional page size in list pagination
45
41
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
42
+ # @option opts [String] :search_filter Optional search filter
43
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
44
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
45
+ # @option opts [String] :inbox_id Optional inbox ID filter
46
46
  # @return [Array<(PageMissedEmailProjection, Integer, Hash)>] PageMissedEmailProjection data, response status code and response headers
47
47
  def get_all_missed_emails_with_http_info(opts = {})
48
48
  if @api_client.config.debugging
@@ -57,18 +57,18 @@ module MailSlurpClient
57
57
 
58
58
  # query parameters
59
59
  query_params = opts[:query_params] || {}
60
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
61
- query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
62
60
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
63
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
64
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
65
61
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
66
62
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
63
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
64
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
65
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
66
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
67
67
 
68
68
  # header parameters
69
69
  header_params = opts[:header_params] || {}
70
70
  # HTTP header 'Accept' (if needed)
71
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
71
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
72
72
 
73
73
  # form parameters
74
74
  form_params = opts[:form_params] || {}
@@ -101,13 +101,13 @@ module MailSlurpClient
101
101
  # Get all unknown missed emails in paginated format
102
102
  # Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
103
103
  # @param [Hash] opts the optional parameters
104
- # @option opts [DateTime] :before Filter by created at before the given timestamp
105
- # @option opts [String] :inbox_id Optional inbox ID filter
106
104
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
107
- # @option opts [String] :search_filter Optional search filter
108
- # @option opts [DateTime] :since Filter by created at after the given timestamp
109
105
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
110
106
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
107
+ # @option opts [String] :search_filter Optional search filter
108
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
109
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
110
+ # @option opts [String] :inbox_id Optional inbox ID filter
111
111
  # @return [PageUnknownMissedEmailProjection]
112
112
  def get_all_unknown_missed_emails(opts = {})
113
113
  data, _status_code, _headers = get_all_unknown_missed_emails_with_http_info(opts)
@@ -117,13 +117,13 @@ module MailSlurpClient
117
117
  # Get all unknown missed emails in paginated format
118
118
  # Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
119
119
  # @param [Hash] opts the optional parameters
120
- # @option opts [DateTime] :before Filter by created at before the given timestamp
121
- # @option opts [String] :inbox_id Optional inbox ID filter
122
120
  # @option opts [Integer] :page Optional page index in list pagination
123
- # @option opts [String] :search_filter Optional search filter
124
- # @option opts [DateTime] :since Filter by created at after the given timestamp
125
121
  # @option opts [Integer] :size Optional page size in list pagination
126
122
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
123
+ # @option opts [String] :search_filter Optional search filter
124
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
125
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
126
+ # @option opts [String] :inbox_id Optional inbox ID filter
127
127
  # @return [Array<(PageUnknownMissedEmailProjection, Integer, Hash)>] PageUnknownMissedEmailProjection data, response status code and response headers
128
128
  def get_all_unknown_missed_emails_with_http_info(opts = {})
129
129
  if @api_client.config.debugging
@@ -138,18 +138,18 @@ module MailSlurpClient
138
138
 
139
139
  # query parameters
140
140
  query_params = opts[:query_params] || {}
141
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
142
- query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
143
141
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
144
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
145
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
146
142
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
147
143
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
144
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
145
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
146
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
147
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
148
148
 
149
149
  # header parameters
150
150
  header_params = opts[:header_params] || {}
151
151
  # HTTP header 'Accept' (if needed)
152
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
152
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
153
153
 
154
154
  # form parameters
155
155
  form_params = opts[:form_params] || {}
@@ -180,7 +180,7 @@ module MailSlurpClient
180
180
  end
181
181
 
182
182
  # Get MissedEmail
183
- # @param missed_email_id [String] missedEmailId
183
+ # @param missed_email_id [String]
184
184
  # @param [Hash] opts the optional parameters
185
185
  # @return [MissedEmail]
186
186
  def get_missed_email(missed_email_id, opts = {})
@@ -189,7 +189,7 @@ module MailSlurpClient
189
189
  end
190
190
 
191
191
  # Get MissedEmail
192
- # @param missed_email_id [String] missedEmailId
192
+ # @param missed_email_id [String]
193
193
  # @param [Hash] opts the optional parameters
194
194
  # @return [Array<(MissedEmail, Integer, Hash)>] MissedEmail data, response status code and response headers
195
195
  def get_missed_email_with_http_info(missed_email_id, opts = {})
@@ -209,7 +209,7 @@ module MailSlurpClient
209
209
  # header parameters
210
210
  header_params = opts[:header_params] || {}
211
211
  # HTTP header 'Accept' (if needed)
212
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
212
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
213
213
 
214
214
  # form parameters
215
215
  form_params = opts[:form_params] || {}
@@ -241,46 +241,58 @@ module MailSlurpClient
241
241
 
242
242
  # Wait for Nth missed email
243
243
  # Wait for 0 based index missed email
244
+ # @param index [Integer] Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index&#x3D;1
244
245
  # @param [Hash] opts the optional parameters
245
- # @option opts [DateTime] :before Filter by created at before the given timestamp
246
246
  # @option opts [String] :inbox_id Optional inbox ID filter
247
- # @option opts [Integer] :index Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index&#x3D;1
248
- # @option opts [DateTime] :since Filter by created at after the given timestamp
249
247
  # @option opts [Integer] :timeout Optional timeout milliseconds
248
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
249
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
250
250
  # @return [MissedEmail]
251
- def wait_for_nth_missed_email(opts = {})
252
- data, _status_code, _headers = wait_for_nth_missed_email_with_http_info(opts)
251
+ def wait_for_nth_missed_email(index, opts = {})
252
+ data, _status_code, _headers = wait_for_nth_missed_email_with_http_info(index, opts)
253
253
  data
254
254
  end
255
255
 
256
256
  # Wait for Nth missed email
257
257
  # Wait for 0 based index missed email
258
+ # @param index [Integer] Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index&#x3D;1
258
259
  # @param [Hash] opts the optional parameters
259
- # @option opts [DateTime] :before Filter by created at before the given timestamp
260
260
  # @option opts [String] :inbox_id Optional inbox ID filter
261
- # @option opts [Integer] :index Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index&#x3D;1
262
- # @option opts [DateTime] :since Filter by created at after the given timestamp
263
261
  # @option opts [Integer] :timeout Optional timeout milliseconds
262
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
263
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
264
264
  # @return [Array<(MissedEmail, Integer, Hash)>] MissedEmail data, response status code and response headers
265
- def wait_for_nth_missed_email_with_http_info(opts = {})
265
+ def wait_for_nth_missed_email_with_http_info(index, opts = {})
266
266
  if @api_client.config.debugging
267
267
  @api_client.config.logger.debug 'Calling API: MissedEmailControllerApi.wait_for_nth_missed_email ...'
268
268
  end
269
+ # verify the required parameter 'index' is set
270
+ if @api_client.config.client_side_validation && index.nil?
271
+ fail ArgumentError, "Missing the required parameter 'index' when calling MissedEmailControllerApi.wait_for_nth_missed_email"
272
+ end
273
+ if @api_client.config.client_side_validation && index > 2147483647
274
+ fail ArgumentError, 'invalid value for "index" when calling MissedEmailControllerApi.wait_for_nth_missed_email, must be smaller than or equal to 2147483647.'
275
+ end
276
+
277
+ if @api_client.config.client_side_validation && index < 0
278
+ fail ArgumentError, 'invalid value for "index" when calling MissedEmailControllerApi.wait_for_nth_missed_email, must be greater than or equal to 0.'
279
+ end
280
+
269
281
  # resource path
270
282
  local_var_path = '/missed-emails/waitForNthMissedEmail'
271
283
 
272
284
  # query parameters
273
285
  query_params = opts[:query_params] || {}
274
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
286
+ query_params[:'index'] = index
275
287
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
276
- query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
277
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
278
288
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
289
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
290
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
279
291
 
280
292
  # header parameters
281
293
  header_params = opts[:header_params] || {}
282
294
  # HTTP header 'Accept' (if needed)
283
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
295
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
284
296
 
285
297
  # form parameters
286
298
  form_params = opts[:form_params] || {}
@@ -19,14 +19,124 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Delete all sent email receipts
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [nil]
25
+ def delete_all_sent_emails(opts = {})
26
+ delete_all_sent_emails_with_http_info(opts)
27
+ nil
28
+ end
29
+
30
+ # Delete all sent email receipts
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
33
+ def delete_all_sent_emails_with_http_info(opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.delete_all_sent_emails ...'
36
+ end
37
+ # resource path
38
+ local_var_path = '/sent'
39
+
40
+ # query parameters
41
+ query_params = opts[:query_params] || {}
42
+
43
+ # header parameters
44
+ header_params = opts[:header_params] || {}
45
+
46
+ # form parameters
47
+ form_params = opts[:form_params] || {}
48
+
49
+ # http body (model)
50
+ post_body = opts[:body]
51
+
52
+ # return_type
53
+ return_type = opts[:return_type]
54
+
55
+ # auth_names
56
+ auth_names = opts[:auth_names] || ['API_KEY']
57
+
58
+ new_options = opts.merge(
59
+ :header_params => header_params,
60
+ :query_params => query_params,
61
+ :form_params => form_params,
62
+ :body => post_body,
63
+ :auth_names => auth_names,
64
+ :return_type => return_type
65
+ )
66
+
67
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
68
+ if @api_client.config.debugging
69
+ @api_client.config.logger.debug "API called: SentEmailsControllerApi#delete_all_sent_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
70
+ end
71
+ return data, status_code, headers
72
+ end
73
+
74
+ # Delete sent email receipt
75
+ # @param id [String]
76
+ # @param [Hash] opts the optional parameters
77
+ # @return [nil]
78
+ def delete_sent_email(id, opts = {})
79
+ delete_sent_email_with_http_info(id, opts)
80
+ nil
81
+ end
82
+
83
+ # Delete sent email receipt
84
+ # @param id [String]
85
+ # @param [Hash] opts the optional parameters
86
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
87
+ def delete_sent_email_with_http_info(id, opts = {})
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.delete_sent_email ...'
90
+ end
91
+ # verify the required parameter 'id' is set
92
+ if @api_client.config.client_side_validation && id.nil?
93
+ fail ArgumentError, "Missing the required parameter 'id' when calling SentEmailsControllerApi.delete_sent_email"
94
+ end
95
+ # resource path
96
+ local_var_path = '/sent/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
97
+
98
+ # query parameters
99
+ query_params = opts[:query_params] || {}
100
+
101
+ # header parameters
102
+ header_params = opts[:header_params] || {}
103
+
104
+ # form parameters
105
+ form_params = opts[:form_params] || {}
106
+
107
+ # http body (model)
108
+ post_body = opts[:body]
109
+
110
+ # return_type
111
+ return_type = opts[:return_type]
112
+
113
+ # auth_names
114
+ auth_names = opts[:auth_names] || ['API_KEY']
115
+
116
+ new_options = opts.merge(
117
+ :header_params => header_params,
118
+ :query_params => query_params,
119
+ :form_params => form_params,
120
+ :body => post_body,
121
+ :auth_names => auth_names,
122
+ :return_type => return_type
123
+ )
124
+
125
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
126
+ if @api_client.config.debugging
127
+ @api_client.config.logger.debug "API called: SentEmailsControllerApi#delete_sent_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
128
+ end
129
+ return data, status_code, headers
130
+ end
131
+
22
132
  # Get all sent email tracking pixels in paginated form
23
133
  # @param [Hash] opts the optional parameters
24
- # @option opts [DateTime] :before Filter by created at before the given timestamp
25
134
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
26
- # @option opts [String] :search_filter Optional search filter
27
- # @option opts [DateTime] :since Filter by created at after the given timestamp
28
135
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
29
136
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
137
+ # @option opts [String] :search_filter Optional search filter
138
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
139
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
30
140
  # @return [PageTrackingPixelProjection]
31
141
  def get_all_sent_tracking_pixels(opts = {})
32
142
  data, _status_code, _headers = get_all_sent_tracking_pixels_with_http_info(opts)
@@ -35,12 +145,12 @@ module MailSlurpClient
35
145
 
36
146
  # Get all sent email tracking pixels in paginated form
37
147
  # @param [Hash] opts the optional parameters
38
- # @option opts [DateTime] :before Filter by created at before the given timestamp
39
148
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
40
- # @option opts [String] :search_filter Optional search filter
41
- # @option opts [DateTime] :since Filter by created at after the given timestamp
42
149
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
43
150
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
151
+ # @option opts [String] :search_filter Optional search filter
152
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
153
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
44
154
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
45
155
  def get_all_sent_tracking_pixels_with_http_info(opts = {})
46
156
  if @api_client.config.debugging
@@ -55,17 +165,17 @@ module MailSlurpClient
55
165
 
56
166
  # query parameters
57
167
  query_params = opts[:query_params] || {}
58
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
59
168
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
60
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
61
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
62
169
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
63
170
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
171
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
172
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
173
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
64
174
 
65
175
  # header parameters
66
176
  header_params = opts[:header_params] || {}
67
177
  # HTTP header 'Accept' (if needed)
68
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
178
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
69
179
 
70
180
  # form parameters
71
181
  form_params = opts[:form_params] || {}
@@ -96,7 +206,7 @@ module MailSlurpClient
96
206
  end
97
207
 
98
208
  # Get sent email receipt
99
- # @param id [String] id
209
+ # @param id [String]
100
210
  # @param [Hash] opts the optional parameters
101
211
  # @return [SentEmailDto]
102
212
  def get_sent_email(id, opts = {})
@@ -105,7 +215,7 @@ module MailSlurpClient
105
215
  end
106
216
 
107
217
  # Get sent email receipt
108
- # @param id [String] id
218
+ # @param id [String]
109
219
  # @param [Hash] opts the optional parameters
110
220
  # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
111
221
  def get_sent_email_with_http_info(id, opts = {})
@@ -125,7 +235,7 @@ module MailSlurpClient
125
235
  # header parameters
126
236
  header_params = opts[:header_params] || {}
127
237
  # HTTP header 'Accept' (if needed)
128
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
238
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
129
239
 
130
240
  # form parameters
131
241
  form_params = opts[:form_params] || {}
@@ -156,7 +266,7 @@ module MailSlurpClient
156
266
  end
157
267
 
158
268
  # Get sent email HTML content
159
- # @param id [String] id
269
+ # @param id [String]
160
270
  # @param [Hash] opts the optional parameters
161
271
  # @return [String]
162
272
  def get_sent_email_html_content(id, opts = {})
@@ -165,7 +275,7 @@ module MailSlurpClient
165
275
  end
166
276
 
167
277
  # Get sent email HTML content
168
- # @param id [String] id
278
+ # @param id [String]
169
279
  # @param [Hash] opts the optional parameters
170
280
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
171
281
  def get_sent_email_html_content_with_http_info(id, opts = {})
@@ -216,14 +326,14 @@ module MailSlurpClient
216
326
  end
217
327
 
218
328
  # Get all tracking pixels for a sent email in paginated form
219
- # @param id [String] id
329
+ # @param id [String]
220
330
  # @param [Hash] opts the optional parameters
221
- # @option opts [DateTime] :before Filter by created at before the given timestamp
222
331
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
223
- # @option opts [String] :search_filter Optional search filter
224
- # @option opts [DateTime] :since Filter by created at after the given timestamp
225
332
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
226
333
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
334
+ # @option opts [String] :search_filter Optional search filter
335
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
336
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
227
337
  # @return [PageTrackingPixelProjection]
228
338
  def get_sent_email_tracking_pixels(id, opts = {})
229
339
  data, _status_code, _headers = get_sent_email_tracking_pixels_with_http_info(id, opts)
@@ -231,14 +341,14 @@ module MailSlurpClient
231
341
  end
232
342
 
233
343
  # Get all tracking pixels for a sent email in paginated form
234
- # @param id [String] id
344
+ # @param id [String]
235
345
  # @param [Hash] opts the optional parameters
236
- # @option opts [DateTime] :before Filter by created at before the given timestamp
237
346
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
238
- # @option opts [String] :search_filter Optional search filter
239
- # @option opts [DateTime] :since Filter by created at after the given timestamp
240
347
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
241
348
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
349
+ # @option opts [String] :search_filter Optional search filter
350
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
351
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
242
352
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
243
353
  def get_sent_email_tracking_pixels_with_http_info(id, opts = {})
244
354
  if @api_client.config.debugging
@@ -257,17 +367,17 @@ module MailSlurpClient
257
367
 
258
368
  # query parameters
259
369
  query_params = opts[:query_params] || {}
260
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
261
370
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
262
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
263
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
264
371
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
265
372
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
373
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
374
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
375
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
266
376
 
267
377
  # header parameters
268
378
  header_params = opts[:header_params] || {}
269
379
  # HTTP header 'Accept' (if needed)
270
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
380
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
271
381
 
272
382
  # form parameters
273
383
  form_params = opts[:form_params] || {}
@@ -299,13 +409,13 @@ module MailSlurpClient
299
409
 
300
410
  # Get all sent emails in paginated form
301
411
  # @param [Hash] opts the optional parameters
302
- # @option opts [DateTime] :before Filter by created at before the given timestamp
303
412
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
304
413
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
305
- # @option opts [String] :search_filter Optional search filter
306
- # @option opts [DateTime] :since Filter by created at after the given timestamp
307
414
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
308
415
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
416
+ # @option opts [String] :search_filter Optional search filter
417
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
418
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
309
419
  # @return [PageSentEmailProjection]
310
420
  def get_sent_emails(opts = {})
311
421
  data, _status_code, _headers = get_sent_emails_with_http_info(opts)
@@ -314,13 +424,13 @@ module MailSlurpClient
314
424
 
315
425
  # Get all sent emails in paginated form
316
426
  # @param [Hash] opts the optional parameters
317
- # @option opts [DateTime] :before Filter by created at before the given timestamp
318
427
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
319
428
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
320
- # @option opts [String] :search_filter Optional search filter
321
- # @option opts [DateTime] :since Filter by created at after the given timestamp
322
429
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination
323
430
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
431
+ # @option opts [String] :search_filter Optional search filter
432
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
433
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
324
434
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
325
435
  def get_sent_emails_with_http_info(opts = {})
326
436
  if @api_client.config.debugging
@@ -335,18 +445,18 @@ module MailSlurpClient
335
445
 
336
446
  # query parameters
337
447
  query_params = opts[:query_params] || {}
338
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
339
448
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
340
449
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
341
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
342
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
343
450
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
344
451
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
452
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
453
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
454
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
345
455
 
346
456
  # header parameters
347
457
  header_params = opts[:header_params] || {}
348
458
  # HTTP header 'Accept' (if needed)
349
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
459
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
350
460
 
351
461
  # form parameters
352
462
  form_params = opts[:form_params] || {}
@@ -378,13 +488,13 @@ module MailSlurpClient
378
488
 
379
489
  # Get all sent organization emails in paginated form
380
490
  # @param [Hash] opts the optional parameters
381
- # @option opts [DateTime] :before Filter by created at before the given timestamp
382
491
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
383
492
  # @option opts [Integer] :page Optional page index in sent email list pagination (default to 0)
384
- # @option opts [String] :search_filter Optional search filter
385
- # @option opts [DateTime] :since Filter by created at after the given timestamp
386
493
  # @option opts [Integer] :size Optional page size in sent email list pagination (default to 20)
387
494
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
495
+ # @option opts [String] :search_filter Optional search filter
496
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
497
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
388
498
  # @return [PageSentEmailProjection]
389
499
  def get_sent_organization_emails(opts = {})
390
500
  data, _status_code, _headers = get_sent_organization_emails_with_http_info(opts)
@@ -393,13 +503,13 @@ module MailSlurpClient
393
503
 
394
504
  # Get all sent organization emails in paginated form
395
505
  # @param [Hash] opts the optional parameters
396
- # @option opts [DateTime] :before Filter by created at before the given timestamp
397
506
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
398
507
  # @option opts [Integer] :page Optional page index in sent email list pagination
399
- # @option opts [String] :search_filter Optional search filter
400
- # @option opts [DateTime] :since Filter by created at after the given timestamp
401
508
  # @option opts [Integer] :size Optional page size in sent email list pagination
402
509
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
510
+ # @option opts [String] :search_filter Optional search filter
511
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
512
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
403
513
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
404
514
  def get_sent_organization_emails_with_http_info(opts = {})
405
515
  if @api_client.config.debugging
@@ -414,18 +524,18 @@ module MailSlurpClient
414
524
 
415
525
  # query parameters
416
526
  query_params = opts[:query_params] || {}
417
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
418
527
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
419
528
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
420
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
421
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
422
529
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
423
530
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
531
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
532
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
533
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
424
534
 
425
535
  # header parameters
426
536
  header_params = opts[:header_params] || {}
427
537
  # HTTP header 'Accept' (if needed)
428
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
538
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
429
539
 
430
540
  # form parameters
431
541
  form_params = opts[:form_params] || {}