mailslurp_client 13.1.0 → 14.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/alias_controller_api.rb +18 -0
  3. data/lib/mailslurp_client/api/attachment_controller_api.rb +6 -0
  4. data/lib/mailslurp_client/api/bounce_controller_api.rb +12 -0
  5. data/lib/mailslurp_client/api/common_actions_controller_api.rb +44 -0
  6. data/lib/mailslurp_client/api/contact_controller_api.rb +6 -0
  7. data/lib/mailslurp_client/api/email_controller_api.rb +12 -0
  8. data/lib/mailslurp_client/api/expired_controller_api.rb +6 -0
  9. data/lib/mailslurp_client/api/group_controller_api.rb +12 -0
  10. data/lib/mailslurp_client/api/inbox_controller_api.rb +110 -6
  11. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +6 -0
  12. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +6 -0
  13. data/lib/mailslurp_client/api/missed_email_controller_api.rb +18 -0
  14. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +24 -0
  15. data/lib/mailslurp_client/api/template_controller_api.rb +6 -0
  16. data/lib/mailslurp_client/api/tracking_controller_api.rb +6 -0
  17. data/lib/mailslurp_client/api/wait_for_controller_api.rb +15 -0
  18. data/lib/mailslurp_client/api/webhook_controller_api.rb +262 -0
  19. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  20. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +17 -28
  21. data/lib/mailslurp_client/models/expiration_defaults.rb +18 -4
  22. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +227 -0
  23. data/lib/mailslurp_client/models/{inbox_projection.rb → inbox_preview.rb} +22 -24
  24. data/lib/mailslurp_client/models/json_schema_dto.rb +211 -0
  25. data/lib/mailslurp_client/models/page_inbox_projection.rb +1 -1
  26. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +211 -0
  27. data/lib/mailslurp_client/models/wait_for_conditions.rb +21 -6
  28. data/lib/mailslurp_client/models/webhook_dto.rb +1 -1
  29. data/lib/mailslurp_client/models/webhook_result_dto.rb +10 -1
  30. data/lib/mailslurp_client/version.rb +1 -1
  31. data/lib/mailslurp_client.rb +4 -1
  32. metadata +6 -3
@@ -21,8 +21,10 @@ module MailSlurpClient
21
21
  end
22
22
  # Get all sent email tracking pixels in paginated form
23
23
  # @param [Hash] opts the optional parameters
24
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
24
25
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
25
26
  # @option opts [String] :search_filter Optional search filter
27
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
26
28
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
27
29
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
28
30
  # @return [PageTrackingPixelProjection]
@@ -33,8 +35,10 @@ module MailSlurpClient
33
35
 
34
36
  # Get all sent email tracking pixels in paginated form
35
37
  # @param [Hash] opts the optional parameters
38
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
36
39
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
37
40
  # @option opts [String] :search_filter Optional search filter
41
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
38
42
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
39
43
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
40
44
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -51,8 +55,10 @@ module MailSlurpClient
51
55
 
52
56
  # query parameters
53
57
  query_params = opts[:query_params] || {}
58
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
54
59
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
55
60
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
61
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
56
62
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
57
63
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
58
64
 
@@ -212,8 +218,10 @@ module MailSlurpClient
212
218
  # Get all tracking pixels for a sent email in paginated form
213
219
  # @param id [String] id
214
220
  # @param [Hash] opts the optional parameters
221
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
215
222
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
216
223
  # @option opts [String] :search_filter Optional search filter
224
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
217
225
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
218
226
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
219
227
  # @return [PageTrackingPixelProjection]
@@ -225,8 +233,10 @@ module MailSlurpClient
225
233
  # Get all tracking pixels for a sent email in paginated form
226
234
  # @param id [String] id
227
235
  # @param [Hash] opts the optional parameters
236
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
228
237
  # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
229
238
  # @option opts [String] :search_filter Optional search filter
239
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
230
240
  # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
231
241
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
232
242
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -247,8 +257,10 @@ module MailSlurpClient
247
257
 
248
258
  # query parameters
249
259
  query_params = opts[:query_params] || {}
260
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
250
261
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
251
262
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
263
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
252
264
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
253
265
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
254
266
 
@@ -287,9 +299,11 @@ module MailSlurpClient
287
299
 
288
300
  # Get all sent emails in paginated form
289
301
  # @param [Hash] opts the optional parameters
302
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
290
303
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
291
304
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
292
305
  # @option opts [String] :search_filter Optional search filter
306
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
293
307
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
294
308
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
295
309
  # @return [PageSentEmailProjection]
@@ -300,9 +314,11 @@ module MailSlurpClient
300
314
 
301
315
  # Get all sent emails in paginated form
302
316
  # @param [Hash] opts the optional parameters
317
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
303
318
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
304
319
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
305
320
  # @option opts [String] :search_filter Optional search filter
321
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
306
322
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination
307
323
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
308
324
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -319,9 +335,11 @@ module MailSlurpClient
319
335
 
320
336
  # query parameters
321
337
  query_params = opts[:query_params] || {}
338
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
322
339
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
323
340
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
324
341
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
342
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
325
343
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
326
344
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
327
345
 
@@ -360,9 +378,11 @@ module MailSlurpClient
360
378
 
361
379
  # Get all sent organization emails in paginated form
362
380
  # @param [Hash] opts the optional parameters
381
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
363
382
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
364
383
  # @option opts [Integer] :page Optional page index in sent email list pagination (default to 0)
365
384
  # @option opts [String] :search_filter Optional search filter
385
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
366
386
  # @option opts [Integer] :size Optional page size in sent email list pagination (default to 20)
367
387
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
368
388
  # @return [PageSentEmailProjection]
@@ -373,9 +393,11 @@ module MailSlurpClient
373
393
 
374
394
  # Get all sent organization emails in paginated form
375
395
  # @param [Hash] opts the optional parameters
396
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
376
397
  # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
377
398
  # @option opts [Integer] :page Optional page index in sent email list pagination
378
399
  # @option opts [String] :search_filter Optional search filter
400
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
379
401
  # @option opts [Integer] :size Optional page size in sent email list pagination
380
402
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
381
403
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -392,9 +414,11 @@ module MailSlurpClient
392
414
 
393
415
  # query parameters
394
416
  query_params = opts[:query_params] || {}
417
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
395
418
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
396
419
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
397
420
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
421
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
398
422
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
399
423
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
400
424
 
@@ -141,7 +141,9 @@ module MailSlurpClient
141
141
 
142
142
  # Get all Templates in paginated format
143
143
  # @param [Hash] opts the optional parameters
144
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
144
145
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
146
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
145
147
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
146
148
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
147
149
  # @return [PageTemplateProjection]
@@ -152,7 +154,9 @@ module MailSlurpClient
152
154
 
153
155
  # Get all Templates in paginated format
154
156
  # @param [Hash] opts the optional parameters
157
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
155
158
  # @option opts [Integer] :page Optional page index in list pagination
159
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
156
160
  # @option opts [Integer] :size Optional page size in list pagination
157
161
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
158
162
  # @return [Array<(PageTemplateProjection, Integer, Hash)>] PageTemplateProjection data, response status code and response headers
@@ -169,7 +173,9 @@ module MailSlurpClient
169
173
 
170
174
  # query parameters
171
175
  query_params = opts[:query_params] || {}
176
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
172
177
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
178
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
173
179
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
174
180
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
175
181
 
@@ -86,8 +86,10 @@ module MailSlurpClient
86
86
  # Get tracking pixels
87
87
  # List tracking pixels in paginated form
88
88
  # @param [Hash] opts the optional parameters
89
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
89
90
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
90
91
  # @option opts [String] :search_filter Optional search filter
92
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
91
93
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
92
94
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
93
95
  # @return [PageTrackingPixelProjection]
@@ -99,8 +101,10 @@ module MailSlurpClient
99
101
  # Get tracking pixels
100
102
  # List tracking pixels in paginated form
101
103
  # @param [Hash] opts the optional parameters
104
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
102
105
  # @option opts [Integer] :page Optional page index in list pagination
103
106
  # @option opts [String] :search_filter Optional search filter
107
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
104
108
  # @option opts [Integer] :size Optional page size in list pagination
105
109
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
106
110
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -117,8 +121,10 @@ module MailSlurpClient
117
121
 
118
122
  # query parameters
119
123
  query_params = opts[:query_params] || {}
124
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
120
125
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
121
126
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
127
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
122
128
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
123
129
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
124
130
 
@@ -82,6 +82,7 @@ module MailSlurpClient
82
82
  # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
83
83
  # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
84
84
  # @param [Hash] opts the optional parameters
85
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
85
86
  # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
86
87
  # @option opts [Integer] :delay Max milliseconds delay between calls
87
88
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -98,6 +99,7 @@ module MailSlurpClient
98
99
  # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
99
100
  # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
100
101
  # @param [Hash] opts the optional parameters
102
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
101
103
  # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
102
104
  # @option opts [Integer] :delay Max milliseconds delay between calls
103
105
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -119,6 +121,7 @@ module MailSlurpClient
119
121
 
120
122
  # query parameters
121
123
  query_params = opts[:query_params] || {}
124
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
122
125
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
123
126
  query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
124
127
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
@@ -163,6 +166,7 @@ module MailSlurpClient
163
166
  # Fetch inbox's latest email or if empty wait for an email to arrive
164
167
  # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set `unreadOnly=true` or see the other receive methods such as `waitForNthEmail` or `waitForEmailCount`.
165
168
  # @param [Hash] opts the optional parameters
169
+ # @option opts [DateTime] :before Filter for emails that were before after the given timestamp
166
170
  # @option opts [Integer] :delay Max milliseconds delay between calls
167
171
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
168
172
  # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -178,6 +182,7 @@ module MailSlurpClient
178
182
  # Fetch inbox&#39;s latest email or if empty wait for an email to arrive
179
183
  # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set &#x60;unreadOnly&#x3D;true&#x60; or see the other receive methods such as &#x60;waitForNthEmail&#x60; or &#x60;waitForEmailCount&#x60;.
180
184
  # @param [Hash] opts the optional parameters
185
+ # @option opts [DateTime] :before Filter for emails that were before after the given timestamp
181
186
  # @option opts [Integer] :delay Max milliseconds delay between calls
182
187
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
183
188
  # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -198,6 +203,7 @@ module MailSlurpClient
198
203
 
199
204
  # query parameters
200
205
  query_params = opts[:query_params] || {}
206
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
201
207
  query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
202
208
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
203
209
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
@@ -242,6 +248,7 @@ module MailSlurpClient
242
248
  # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
243
249
  # @param match_options [MatchOptions] matchOptions
244
250
  # @param [Hash] opts the optional parameters
251
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
245
252
  # @option opts [Integer] :count Number of emails to wait for. Must be greater or equal to 1
246
253
  # @option opts [Integer] :delay Max milliseconds delay between calls
247
254
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -259,6 +266,7 @@ module MailSlurpClient
259
266
  # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.
260
267
  # @param match_options [MatchOptions] matchOptions
261
268
  # @param [Hash] opts the optional parameters
269
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
262
270
  # @option opts [Integer] :count Number of emails to wait for. Must be greater or equal to 1
263
271
  # @option opts [Integer] :delay Max milliseconds delay between calls
264
272
  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
@@ -284,6 +292,7 @@ module MailSlurpClient
284
292
 
285
293
  # query parameters
286
294
  query_params = opts[:query_params] || {}
295
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
287
296
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
288
297
  query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
289
298
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
@@ -331,6 +340,7 @@ module MailSlurpClient
331
340
  # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
332
341
  # @param match_options [MatchOptions] matchOptions
333
342
  # @param [Hash] opts the optional parameters
343
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
334
344
  # @option opts [Integer] :delay Max milliseconds delay between calls
335
345
  # @option opts [String] :inbox_id Id of the inbox we are matching an email for
336
346
  # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -347,6 +357,7 @@ module MailSlurpClient
347
357
  # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the &#x60;MatchOptions&#x60; object for options. An example payload is &#x60;{ matches: [{field: &#39;SUBJECT&#39;,should:&#39;CONTAIN&#39;,value:&#39;needle&#39;}] }&#x60;. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController &#x60;getEmailContentMatch&#x60; method.
348
358
  # @param match_options [MatchOptions] matchOptions
349
359
  # @param [Hash] opts the optional parameters
360
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
350
361
  # @option opts [Integer] :delay Max milliseconds delay between calls
351
362
  # @option opts [String] :inbox_id Id of the inbox we are matching an email for
352
363
  # @option opts [DateTime] :since Filter for emails that were received after the given timestamp
@@ -371,6 +382,7 @@ module MailSlurpClient
371
382
 
372
383
  # query parameters
373
384
  query_params = opts[:query_params] || {}
385
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
374
386
  query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
375
387
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
376
388
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
@@ -416,6 +428,7 @@ module MailSlurpClient
416
428
  # Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.
417
429
  # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
418
430
  # @param [Hash] opts the optional parameters
431
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
419
432
  # @option opts [Integer] :delay Max milliseconds delay between calls
420
433
  # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
421
434
  # @option opts [Integer] :index Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index&#x3D;1 (default to 0)
@@ -432,6 +445,7 @@ module MailSlurpClient
432
445
  # Wait for or fetch the email with a given index in the inbox specified. If index doesn&#39;t exist waits for it to exist or timeout to occur.
433
446
  # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
434
447
  # @param [Hash] opts the optional parameters
448
+ # @option opts [DateTime] :before Filter for emails that were received before the given timestamp
435
449
  # @option opts [Integer] :delay Max milliseconds delay between calls
436
450
  # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
437
451
  # @option opts [Integer] :index Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index&#x3D;1
@@ -453,6 +467,7 @@ module MailSlurpClient
453
467
 
454
468
  # query parameters
455
469
  query_params = opts[:query_params] || {}
470
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
456
471
  query_params[:'delay'] = opts[:'delay'] if !opts[:'delay'].nil?
457
472
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
458
473
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?