mailslurp_client 13.1.0 → 14.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -22,7 +22,7 @@ module MailSlurpClient
22
22
  # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
23
23
  # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
25
+ # @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
26
26
  # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
27
27
  # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
28
28
  # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
@@ -41,7 +41,7 @@ module MailSlurpClient
41
41
  # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
42
42
  # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
43
43
  # @param [Hash] opts the optional parameters
44
- # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
44
+ # @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
45
45
  # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
46
46
  # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
47
47
  # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
@@ -411,16 +411,77 @@ module MailSlurpClient
411
411
  return data, status_code, headers
412
412
  end
413
413
 
414
+ # Remove expired inboxes
415
+ # Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
416
+ # @param [Hash] opts the optional parameters
417
+ # @option opts [DateTime] :before Optional expired at before flag to flush expired inboxes that have expired before the given time
418
+ # @return [FlushExpiredInboxesResult]
419
+ def flush_expired(opts = {})
420
+ data, _status_code, _headers = flush_expired_with_http_info(opts)
421
+ data
422
+ end
423
+
424
+ # Remove expired inboxes
425
+ # Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
426
+ # @param [Hash] opts the optional parameters
427
+ # @option opts [DateTime] :before Optional expired at before flag to flush expired inboxes that have expired before the given time
428
+ # @return [Array<(FlushExpiredInboxesResult, Integer, Hash)>] FlushExpiredInboxesResult data, response status code and response headers
429
+ def flush_expired_with_http_info(opts = {})
430
+ if @api_client.config.debugging
431
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.flush_expired ...'
432
+ end
433
+ # resource path
434
+ local_var_path = '/inboxes/expired'
435
+
436
+ # query parameters
437
+ query_params = opts[:query_params] || {}
438
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
439
+
440
+ # header parameters
441
+ header_params = opts[:header_params] || {}
442
+ # HTTP header 'Accept' (if needed)
443
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
444
+
445
+ # form parameters
446
+ form_params = opts[:form_params] || {}
447
+
448
+ # http body (model)
449
+ post_body = opts[:body]
450
+
451
+ # return_type
452
+ return_type = opts[:return_type] || 'FlushExpiredInboxesResult'
453
+
454
+ # auth_names
455
+ auth_names = opts[:auth_names] || ['API_KEY']
456
+
457
+ new_options = opts.merge(
458
+ :header_params => header_params,
459
+ :query_params => query_params,
460
+ :form_params => form_params,
461
+ :body => post_body,
462
+ :auth_names => auth_names,
463
+ :return_type => return_type
464
+ )
465
+
466
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
467
+ if @api_client.config.debugging
468
+ @api_client.config.logger.debug "API called: InboxControllerApi#flush_expired\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
469
+ end
470
+ return data, status_code, headers
471
+ end
472
+
414
473
  # List All Inboxes Paginated
415
- # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set `teamAccess` to true.
474
+ # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
416
475
  # @param [Hash] opts the optional parameters
476
+ # @option opts [DateTime] :before Optional filter by created before given date time
417
477
  # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
418
478
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
419
479
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
480
+ # @option opts [DateTime] :since Optional filter by created after given date time
420
481
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
421
482
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
422
483
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
423
- # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included (default to false)
484
+ # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access. (default to false)
424
485
  # @return [PageInboxProjection]
425
486
  def get_all_inboxes(opts = {})
426
487
  data, _status_code, _headers = get_all_inboxes_with_http_info(opts)
@@ -428,15 +489,17 @@ module MailSlurpClient
428
489
  end
429
490
 
430
491
  # List All Inboxes Paginated
431
- # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set &#x60;teamAccess&#x60; to true.
492
+ # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.
432
493
  # @param [Hash] opts the optional parameters
494
+ # @option opts [DateTime] :before Optional filter by created before given date time
433
495
  # @option opts [Boolean] :favourite Optionally filter results for favourites only
434
496
  # @option opts [Integer] :page Optional page index in list pagination
435
497
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
498
+ # @option opts [DateTime] :since Optional filter by created after given date time
436
499
  # @option opts [Integer] :size Optional page size in list pagination
437
500
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
438
501
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
439
- # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included
502
+ # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
440
503
  # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
441
504
  def get_all_inboxes_with_http_info(opts = {})
442
505
  if @api_client.config.debugging
@@ -451,9 +514,11 @@ module MailSlurpClient
451
514
 
452
515
  # query parameters
453
516
  query_params = opts[:query_params] || {}
517
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
454
518
  query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
455
519
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
456
520
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
521
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
457
522
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
458
523
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
459
524
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
@@ -496,6 +561,7 @@ module MailSlurpClient
496
561
  # List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
497
562
  # @param inbox_id [String] Id of inbox that emails belongs to
498
563
  # @param [Hash] opts the optional parameters
564
+ # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
499
565
  # @option opts [Integer] :delay_timeout delayTimeout
500
566
  # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
501
567
  # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
@@ -514,6 +580,7 @@ module MailSlurpClient
514
580
  # List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached
515
581
  # @param inbox_id [String] Id of inbox that emails belongs to
516
582
  # @param [Hash] opts the optional parameters
583
+ # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
517
584
  # @option opts [Integer] :delay_timeout delayTimeout
518
585
  # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
519
586
  # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
@@ -540,6 +607,7 @@ module MailSlurpClient
540
607
 
541
608
  # query parameters
542
609
  query_params = opts[:query_params] || {}
610
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
543
611
  query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
544
612
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
545
613
  query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
@@ -648,7 +716,9 @@ module MailSlurpClient
648
716
  # Get a paginated list of emails in an inbox. Does not hold connections open.
649
717
  # @param inbox_id [String] Id of inbox that emails belongs to
650
718
  # @param [Hash] opts the optional parameters
719
+ # @option opts [DateTime] :before Optional filter by received before given date time
651
720
  # @option opts [Integer] :page Optional page index in inbox emails list pagination (default to 0)
721
+ # @option opts [DateTime] :since Optional filter by received after given date time
652
722
  # @option opts [Integer] :size Optional page size in inbox emails list pagination (default to 20)
653
723
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
654
724
  # @return [PageEmailPreview]
@@ -661,7 +731,9 @@ module MailSlurpClient
661
731
  # Get a paginated list of emails in an inbox. Does not hold connections open.
662
732
  # @param inbox_id [String] Id of inbox that emails belongs to
663
733
  # @param [Hash] opts the optional parameters
734
+ # @option opts [DateTime] :before Optional filter by received before given date time
664
735
  # @option opts [Integer] :page Optional page index in inbox emails list pagination
736
+ # @option opts [DateTime] :since Optional filter by received after given date time
665
737
  # @option opts [Integer] :size Optional page size in inbox emails list pagination
666
738
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
667
739
  # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
@@ -682,7 +754,9 @@ module MailSlurpClient
682
754
 
683
755
  # query parameters
684
756
  query_params = opts[:query_params] || {}
757
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
685
758
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
759
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
686
760
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
687
761
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
688
762
 
@@ -723,8 +797,10 @@ module MailSlurpClient
723
797
  # Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
724
798
  # @param inbox_id [String] inboxId
725
799
  # @param [Hash] opts the optional parameters
800
+ # @option opts [DateTime] :before Optional filter by sent before given date time
726
801
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
727
802
  # @option opts [String] :search_filter Optional sent email search
803
+ # @option opts [DateTime] :since Optional filter by sent after given date time
728
804
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
729
805
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
730
806
  # @return [PageSentEmailProjection]
@@ -737,8 +813,10 @@ module MailSlurpClient
737
813
  # Returns an inbox&#39;s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
738
814
  # @param inbox_id [String] inboxId
739
815
  # @param [Hash] opts the optional parameters
816
+ # @option opts [DateTime] :before Optional filter by sent before given date time
740
817
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
741
818
  # @option opts [String] :search_filter Optional sent email search
819
+ # @option opts [DateTime] :since Optional filter by sent after given date time
742
820
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination
743
821
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
744
822
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -759,8 +837,10 @@ module MailSlurpClient
759
837
 
760
838
  # query parameters
761
839
  query_params = opts[:query_params] || {}
840
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
762
841
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
763
842
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
843
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
764
844
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
765
845
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
766
846
 
@@ -856,6 +936,8 @@ module MailSlurpClient
856
936
  # List Inboxes and email addresses
857
937
  # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended and allows paginated access using a limit and sort parameter.
858
938
  # @param [Hash] opts the optional parameters
939
+ # @option opts [DateTime] :before Optional filter by created before given date time
940
+ # @option opts [DateTime] :since Optional filter by created after given date time
859
941
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
860
942
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
861
943
  # @return [Array<Inbox>]
@@ -867,6 +949,8 @@ module MailSlurpClient
867
949
  # List Inboxes and email addresses
868
950
  # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended and allows paginated access using a limit and sort parameter.
869
951
  # @param [Hash] opts the optional parameters
952
+ # @option opts [DateTime] :before Optional filter by created before given date time
953
+ # @option opts [DateTime] :since Optional filter by created after given date time
870
954
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
871
955
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
872
956
  # @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
@@ -883,6 +967,8 @@ module MailSlurpClient
883
967
 
884
968
  # query parameters
885
969
  query_params = opts[:query_params] || {}
970
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
971
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
886
972
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
887
973
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
888
974
 
@@ -922,8 +1008,10 @@ module MailSlurpClient
922
1008
  # List Organization Inboxes Paginated
923
1009
  # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
924
1010
  # @param [Hash] opts the optional parameters
1011
+ # @option opts [DateTime] :before Optional filter by created before given date time
925
1012
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
926
1013
  # @option opts [String] :search_filter Optional search filter
1014
+ # @option opts [DateTime] :since Optional filter by created after given date time
927
1015
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
928
1016
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
929
1017
  # @return [PageOrganizationInboxProjection]
@@ -935,8 +1023,10 @@ module MailSlurpClient
935
1023
  # List Organization Inboxes Paginated
936
1024
  # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
937
1025
  # @param [Hash] opts the optional parameters
1026
+ # @option opts [DateTime] :before Optional filter by created before given date time
938
1027
  # @option opts [Integer] :page Optional page index in list pagination
939
1028
  # @option opts [String] :search_filter Optional search filter
1029
+ # @option opts [DateTime] :since Optional filter by created after given date time
940
1030
  # @option opts [Integer] :size Optional page size in list pagination
941
1031
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
942
1032
  # @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
@@ -953,8 +1043,10 @@ module MailSlurpClient
953
1043
 
954
1044
  # query parameters
955
1045
  query_params = opts[:query_params] || {}
1046
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
956
1047
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
957
1048
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1049
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
958
1050
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
959
1051
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
960
1052
 
@@ -995,8 +1087,10 @@ module MailSlurpClient
995
1087
  # List all rulesets attached to an inbox
996
1088
  # @param inbox_id [String] inboxId
997
1089
  # @param [Hash] opts the optional parameters
1090
+ # @option opts [DateTime] :before Optional filter by created before given date time
998
1091
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
999
1092
  # @option opts [String] :search_filter Optional search filter
1093
+ # @option opts [DateTime] :since Optional filter by created after given date time
1000
1094
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
1001
1095
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1002
1096
  # @return [PageInboxRulesetDto]
@@ -1009,8 +1103,10 @@ module MailSlurpClient
1009
1103
  # List all rulesets attached to an inbox
1010
1104
  # @param inbox_id [String] inboxId
1011
1105
  # @param [Hash] opts the optional parameters
1106
+ # @option opts [DateTime] :before Optional filter by created before given date time
1012
1107
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
1013
1108
  # @option opts [String] :search_filter Optional search filter
1109
+ # @option opts [DateTime] :since Optional filter by created after given date time
1014
1110
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
1015
1111
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1016
1112
  # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
@@ -1031,8 +1127,10 @@ module MailSlurpClient
1031
1127
 
1032
1128
  # query parameters
1033
1129
  query_params = opts[:query_params] || {}
1130
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1034
1131
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1035
1132
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1133
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1036
1134
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1037
1135
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1038
1136
 
@@ -1073,8 +1171,10 @@ module MailSlurpClient
1073
1171
  # List all tracking pixels sent from an inbox
1074
1172
  # @param inbox_id [String] inboxId
1075
1173
  # @param [Hash] opts the optional parameters
1174
+ # @option opts [DateTime] :before Optional filter by created before given date time
1076
1175
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
1077
1176
  # @option opts [String] :search_filter Optional search filter
1177
+ # @option opts [DateTime] :since Optional filter by created after given date time
1078
1178
  # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
1079
1179
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1080
1180
  # @return [PageTrackingPixelProjection]
@@ -1087,8 +1187,10 @@ module MailSlurpClient
1087
1187
  # List all tracking pixels sent from an inbox
1088
1188
  # @param inbox_id [String] inboxId
1089
1189
  # @param [Hash] opts the optional parameters
1190
+ # @option opts [DateTime] :before Optional filter by created before given date time
1090
1191
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
1091
1192
  # @option opts [String] :search_filter Optional search filter
1193
+ # @option opts [DateTime] :since Optional filter by created after given date time
1092
1194
  # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
1093
1195
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1094
1196
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -1109,8 +1211,10 @@ module MailSlurpClient
1109
1211
 
1110
1212
  # query parameters
1111
1213
  query_params = opts[:query_params] || {}
1214
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1112
1215
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1113
1216
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1217
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1114
1218
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1115
1219
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1116
1220
 
@@ -268,9 +268,11 @@ module MailSlurpClient
268
268
  # List inbox forwarders
269
269
  # List all forwarders attached to an inbox
270
270
  # @param [Hash] opts the optional parameters
271
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
271
272
  # @option opts [String] :inbox_id Optional inbox id to get forwarders from
272
273
  # @option opts [Integer] :page Optional page index in inbox forwarder list pagination (default to 0)
273
274
  # @option opts [String] :search_filter Optional search filter
275
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
274
276
  # @option opts [Integer] :size Optional page size in inbox forwarder list pagination (default to 20)
275
277
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
276
278
  # @return [PageInboxForwarderDto]
@@ -282,9 +284,11 @@ module MailSlurpClient
282
284
  # List inbox forwarders
283
285
  # List all forwarders attached to an inbox
284
286
  # @param [Hash] opts the optional parameters
287
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
285
288
  # @option opts [String] :inbox_id Optional inbox id to get forwarders from
286
289
  # @option opts [Integer] :page Optional page index in inbox forwarder list pagination
287
290
  # @option opts [String] :search_filter Optional search filter
291
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
288
292
  # @option opts [Integer] :size Optional page size in inbox forwarder list pagination
289
293
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
290
294
  # @return [Array<(PageInboxForwarderDto, Integer, Hash)>] PageInboxForwarderDto data, response status code and response headers
@@ -301,9 +305,11 @@ module MailSlurpClient
301
305
 
302
306
  # query parameters
303
307
  query_params = opts[:query_params] || {}
308
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
304
309
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
305
310
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
306
311
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
312
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
307
313
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
308
314
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
309
315
 
@@ -268,9 +268,11 @@ module MailSlurpClient
268
268
  # List inbox rulesets
269
269
  # List all rulesets attached to an inbox
270
270
  # @param [Hash] opts the optional parameters
271
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
271
272
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
272
273
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
273
274
  # @option opts [String] :search_filter Optional search filter
275
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
274
276
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
275
277
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
276
278
  # @return [PageInboxRulesetDto]
@@ -282,9 +284,11 @@ module MailSlurpClient
282
284
  # List inbox rulesets
283
285
  # List all rulesets attached to an inbox
284
286
  # @param [Hash] opts the optional parameters
287
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
285
288
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
286
289
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
287
290
  # @option opts [String] :search_filter Optional search filter
291
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
288
292
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
289
293
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
290
294
  # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
@@ -301,9 +305,11 @@ module MailSlurpClient
301
305
 
302
306
  # query parameters
303
307
  query_params = opts[:query_params] || {}
308
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
304
309
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
305
310
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
306
311
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
312
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
307
313
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
308
314
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
309
315
 
@@ -21,9 +21,11 @@ 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
24
25
  # @option opts [String] :inbox_id Optional inbox ID filter
25
26
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
26
27
  # @option opts [String] :search_filter Optional search filter
28
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
27
29
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
28
30
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
29
31
  # @return [PageMissedEmailProjection]
@@ -34,9 +36,11 @@ module MailSlurpClient
34
36
 
35
37
  # Get all MissedEmails in paginated format
36
38
  # @param [Hash] opts the optional parameters
39
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
37
40
  # @option opts [String] :inbox_id Optional inbox ID filter
38
41
  # @option opts [Integer] :page Optional page index in list pagination
39
42
  # @option opts [String] :search_filter Optional search filter
43
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
40
44
  # @option opts [Integer] :size Optional page size in list pagination
41
45
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
42
46
  # @return [Array<(PageMissedEmailProjection, Integer, Hash)>] PageMissedEmailProjection data, response status code and response headers
@@ -53,9 +57,11 @@ module MailSlurpClient
53
57
 
54
58
  # query parameters
55
59
  query_params = opts[:query_params] || {}
60
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
56
61
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
57
62
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
58
63
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
64
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
59
65
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
60
66
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
61
67
 
@@ -95,9 +101,11 @@ module MailSlurpClient
95
101
  # Get all unknown missed emails in paginated format
96
102
  # Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
97
103
  # @param [Hash] opts the optional parameters
104
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
98
105
  # @option opts [String] :inbox_id Optional inbox ID filter
99
106
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
100
107
  # @option opts [String] :search_filter Optional search filter
108
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
101
109
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
102
110
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
103
111
  # @return [PageUnknownMissedEmailProjection]
@@ -109,9 +117,11 @@ module MailSlurpClient
109
117
  # Get all unknown missed emails in paginated format
110
118
  # Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
111
119
  # @param [Hash] opts the optional parameters
120
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
112
121
  # @option opts [String] :inbox_id Optional inbox ID filter
113
122
  # @option opts [Integer] :page Optional page index in list pagination
114
123
  # @option opts [String] :search_filter Optional search filter
124
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
115
125
  # @option opts [Integer] :size Optional page size in list pagination
116
126
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
117
127
  # @return [Array<(PageUnknownMissedEmailProjection, Integer, Hash)>] PageUnknownMissedEmailProjection data, response status code and response headers
@@ -128,9 +138,11 @@ module MailSlurpClient
128
138
 
129
139
  # query parameters
130
140
  query_params = opts[:query_params] || {}
141
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
131
142
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
132
143
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
133
144
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
145
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
134
146
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
135
147
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
136
148
 
@@ -230,8 +242,10 @@ module MailSlurpClient
230
242
  # Wait for Nth missed email
231
243
  # Wait for 0 based index missed email
232
244
  # @param [Hash] opts the optional parameters
245
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
233
246
  # @option opts [String] :inbox_id Optional inbox ID filter
234
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
235
249
  # @option opts [Integer] :timeout Optional timeout milliseconds
236
250
  # @return [MissedEmail]
237
251
  def wait_for_nth_missed_email(opts = {})
@@ -242,8 +256,10 @@ module MailSlurpClient
242
256
  # Wait for Nth missed email
243
257
  # Wait for 0 based index missed email
244
258
  # @param [Hash] opts the optional parameters
259
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
245
260
  # @option opts [String] :inbox_id Optional inbox ID filter
246
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
247
263
  # @option opts [Integer] :timeout Optional timeout milliseconds
248
264
  # @return [Array<(MissedEmail, Integer, Hash)>] MissedEmail data, response status code and response headers
249
265
  def wait_for_nth_missed_email_with_http_info(opts = {})
@@ -255,8 +271,10 @@ module MailSlurpClient
255
271
 
256
272
  # query parameters
257
273
  query_params = opts[:query_params] || {}
274
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
258
275
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
259
276
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
277
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
260
278
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
261
279
 
262
280
  # header parameters