mailslurp_client 13.1.0 → 14.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.
@@ -412,15 +412,17 @@ module MailSlurpClient
412
412
  end
413
413
 
414
414
  # 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.
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.
416
416
  # @param [Hash] opts the optional parameters
417
+ # @option opts [DateTime] :before Optional filter by created before given date time
417
418
  # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
418
419
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
419
420
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
421
+ # @option opts [DateTime] :since Optional filter by created after given date time
420
422
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
421
423
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
422
424
  # @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)
425
+ # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access. (default to false)
424
426
  # @return [PageInboxProjection]
425
427
  def get_all_inboxes(opts = {})
426
428
  data, _status_code, _headers = get_all_inboxes_with_http_info(opts)
@@ -428,15 +430,17 @@ module MailSlurpClient
428
430
  end
429
431
 
430
432
  # List All Inboxes Paginated
431
- # 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.
433
+ # 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.
432
434
  # @param [Hash] opts the optional parameters
435
+ # @option opts [DateTime] :before Optional filter by created before given date time
433
436
  # @option opts [Boolean] :favourite Optionally filter results for favourites only
434
437
  # @option opts [Integer] :page Optional page index in list pagination
435
438
  # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
439
+ # @option opts [DateTime] :since Optional filter by created after given date time
436
440
  # @option opts [Integer] :size Optional page size in list pagination
437
441
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
438
442
  # @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
443
+ # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
440
444
  # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
441
445
  def get_all_inboxes_with_http_info(opts = {})
442
446
  if @api_client.config.debugging
@@ -451,9 +455,11 @@ module MailSlurpClient
451
455
 
452
456
  # query parameters
453
457
  query_params = opts[:query_params] || {}
458
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
454
459
  query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
455
460
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
456
461
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
462
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
457
463
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
458
464
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
459
465
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
@@ -496,6 +502,7 @@ module MailSlurpClient
496
502
  # 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
503
  # @param inbox_id [String] Id of inbox that emails belongs to
498
504
  # @param [Hash] opts the optional parameters
505
+ # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
499
506
  # @option opts [Integer] :delay_timeout delayTimeout
500
507
  # @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
508
  # @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 +521,7 @@ module MailSlurpClient
514
521
  # 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
522
  # @param inbox_id [String] Id of inbox that emails belongs to
516
523
  # @param [Hash] opts the optional parameters
524
+ # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
517
525
  # @option opts [Integer] :delay_timeout delayTimeout
518
526
  # @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
527
  # @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 +548,7 @@ module MailSlurpClient
540
548
 
541
549
  # query parameters
542
550
  query_params = opts[:query_params] || {}
551
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
543
552
  query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
544
553
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
545
554
  query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
@@ -648,7 +657,9 @@ module MailSlurpClient
648
657
  # Get a paginated list of emails in an inbox. Does not hold connections open.
649
658
  # @param inbox_id [String] Id of inbox that emails belongs to
650
659
  # @param [Hash] opts the optional parameters
660
+ # @option opts [DateTime] :before Optional filter by received before given date time
651
661
  # @option opts [Integer] :page Optional page index in inbox emails list pagination (default to 0)
662
+ # @option opts [DateTime] :since Optional filter by received after given date time
652
663
  # @option opts [Integer] :size Optional page size in inbox emails list pagination (default to 20)
653
664
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
654
665
  # @return [PageEmailPreview]
@@ -661,7 +672,9 @@ module MailSlurpClient
661
672
  # Get a paginated list of emails in an inbox. Does not hold connections open.
662
673
  # @param inbox_id [String] Id of inbox that emails belongs to
663
674
  # @param [Hash] opts the optional parameters
675
+ # @option opts [DateTime] :before Optional filter by received before given date time
664
676
  # @option opts [Integer] :page Optional page index in inbox emails list pagination
677
+ # @option opts [DateTime] :since Optional filter by received after given date time
665
678
  # @option opts [Integer] :size Optional page size in inbox emails list pagination
666
679
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
667
680
  # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
@@ -682,7 +695,9 @@ module MailSlurpClient
682
695
 
683
696
  # query parameters
684
697
  query_params = opts[:query_params] || {}
698
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
685
699
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
700
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
686
701
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
687
702
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
688
703
 
@@ -723,8 +738,10 @@ module MailSlurpClient
723
738
  # 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
739
  # @param inbox_id [String] inboxId
725
740
  # @param [Hash] opts the optional parameters
741
+ # @option opts [DateTime] :before Optional filter by sent before given date time
726
742
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
727
743
  # @option opts [String] :search_filter Optional sent email search
744
+ # @option opts [DateTime] :since Optional filter by sent after given date time
728
745
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
729
746
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
730
747
  # @return [PageSentEmailProjection]
@@ -737,8 +754,10 @@ module MailSlurpClient
737
754
  # 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
755
  # @param inbox_id [String] inboxId
739
756
  # @param [Hash] opts the optional parameters
757
+ # @option opts [DateTime] :before Optional filter by sent before given date time
740
758
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
741
759
  # @option opts [String] :search_filter Optional sent email search
760
+ # @option opts [DateTime] :since Optional filter by sent after given date time
742
761
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination
743
762
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
744
763
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
@@ -759,8 +778,10 @@ module MailSlurpClient
759
778
 
760
779
  # query parameters
761
780
  query_params = opts[:query_params] || {}
781
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
762
782
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
763
783
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
784
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
764
785
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
765
786
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
766
787
 
@@ -856,6 +877,8 @@ module MailSlurpClient
856
877
  # List Inboxes and email addresses
857
878
  # 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
879
  # @param [Hash] opts the optional parameters
880
+ # @option opts [DateTime] :before Optional filter by created before given date time
881
+ # @option opts [DateTime] :since Optional filter by created after given date time
859
882
  # @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
883
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
861
884
  # @return [Array<Inbox>]
@@ -867,6 +890,8 @@ module MailSlurpClient
867
890
  # List Inboxes and email addresses
868
891
  # 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
892
  # @param [Hash] opts the optional parameters
893
+ # @option opts [DateTime] :before Optional filter by created before given date time
894
+ # @option opts [DateTime] :since Optional filter by created after given date time
870
895
  # @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
896
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
872
897
  # @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
@@ -883,6 +908,8 @@ module MailSlurpClient
883
908
 
884
909
  # query parameters
885
910
  query_params = opts[:query_params] || {}
911
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
912
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
886
913
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
887
914
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
888
915
 
@@ -922,8 +949,10 @@ module MailSlurpClient
922
949
  # List Organization Inboxes Paginated
923
950
  # 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
951
  # @param [Hash] opts the optional parameters
952
+ # @option opts [DateTime] :before Optional filter by created before given date time
925
953
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
926
954
  # @option opts [String] :search_filter Optional search filter
955
+ # @option opts [DateTime] :since Optional filter by created after given date time
927
956
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
928
957
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
929
958
  # @return [PageOrganizationInboxProjection]
@@ -935,8 +964,10 @@ module MailSlurpClient
935
964
  # List Organization Inboxes Paginated
936
965
  # 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
966
  # @param [Hash] opts the optional parameters
967
+ # @option opts [DateTime] :before Optional filter by created before given date time
938
968
  # @option opts [Integer] :page Optional page index in list pagination
939
969
  # @option opts [String] :search_filter Optional search filter
970
+ # @option opts [DateTime] :since Optional filter by created after given date time
940
971
  # @option opts [Integer] :size Optional page size in list pagination
941
972
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
942
973
  # @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
@@ -953,8 +984,10 @@ module MailSlurpClient
953
984
 
954
985
  # query parameters
955
986
  query_params = opts[:query_params] || {}
987
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
956
988
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
957
989
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
990
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
958
991
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
959
992
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
960
993
 
@@ -995,8 +1028,10 @@ module MailSlurpClient
995
1028
  # List all rulesets attached to an inbox
996
1029
  # @param inbox_id [String] inboxId
997
1030
  # @param [Hash] opts the optional parameters
1031
+ # @option opts [DateTime] :before Optional filter by created before given date time
998
1032
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
999
1033
  # @option opts [String] :search_filter Optional search filter
1034
+ # @option opts [DateTime] :since Optional filter by created after given date time
1000
1035
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
1001
1036
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1002
1037
  # @return [PageInboxRulesetDto]
@@ -1009,8 +1044,10 @@ module MailSlurpClient
1009
1044
  # List all rulesets attached to an inbox
1010
1045
  # @param inbox_id [String] inboxId
1011
1046
  # @param [Hash] opts the optional parameters
1047
+ # @option opts [DateTime] :before Optional filter by created before given date time
1012
1048
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
1013
1049
  # @option opts [String] :search_filter Optional search filter
1050
+ # @option opts [DateTime] :since Optional filter by created after given date time
1014
1051
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
1015
1052
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1016
1053
  # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
@@ -1031,8 +1068,10 @@ module MailSlurpClient
1031
1068
 
1032
1069
  # query parameters
1033
1070
  query_params = opts[:query_params] || {}
1071
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1034
1072
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1035
1073
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1074
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1036
1075
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1037
1076
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1038
1077
 
@@ -1073,8 +1112,10 @@ module MailSlurpClient
1073
1112
  # List all tracking pixels sent from an inbox
1074
1113
  # @param inbox_id [String] inboxId
1075
1114
  # @param [Hash] opts the optional parameters
1115
+ # @option opts [DateTime] :before Optional filter by created before given date time
1076
1116
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
1077
1117
  # @option opts [String] :search_filter Optional search filter
1118
+ # @option opts [DateTime] :since Optional filter by created after given date time
1078
1119
  # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
1079
1120
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1080
1121
  # @return [PageTrackingPixelProjection]
@@ -1087,8 +1128,10 @@ module MailSlurpClient
1087
1128
  # List all tracking pixels sent from an inbox
1088
1129
  # @param inbox_id [String] inboxId
1089
1130
  # @param [Hash] opts the optional parameters
1131
+ # @option opts [DateTime] :before Optional filter by created before given date time
1090
1132
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
1091
1133
  # @option opts [String] :search_filter Optional search filter
1134
+ # @option opts [DateTime] :since Optional filter by created after given date time
1092
1135
  # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
1093
1136
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1094
1137
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -1109,8 +1152,10 @@ module MailSlurpClient
1109
1152
 
1110
1153
  # query parameters
1111
1154
  query_params = opts[:query_params] || {}
1155
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1112
1156
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1113
1157
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1158
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1114
1159
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1115
1160
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1116
1161
 
@@ -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
@@ -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