mailslurp_client 12.5.0 → 12.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/mailslurp_client.rb +17 -2
- data/lib/mailslurp_client/api/contact_controller_api.rb +4 -4
- data/lib/mailslurp_client/api/email_controller_api.rb +71 -5
- data/lib/mailslurp_client/api/group_controller_api.rb +4 -4
- data/lib/mailslurp_client/api/inbox_controller_api.rb +107 -22
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +548 -0
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +211 -3
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +75 -7
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +150 -4
- data/lib/mailslurp_client/api/template_controller_api.rb +4 -4
- data/lib/mailslurp_client/api/tracking_controller_api.rb +218 -0
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +2 -2
- data/lib/mailslurp_client/api/webhook_controller_api.rb +55 -1
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +275 -0
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +4 -4
- data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +215 -0
- data/lib/mailslurp_client/models/create_webhook_options.rb +3 -3
- data/lib/mailslurp_client/models/domain_preview.rb +66 -4
- data/lib/mailslurp_client/models/email.rb +11 -1
- data/lib/mailslurp_client/models/email_projection.rb +10 -1
- data/lib/mailslurp_client/models/{inbox_ruleset_projection.rb → inbox_forwarder_dto.rb} +55 -78
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +211 -0
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +227 -0
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +17 -3
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +211 -0
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +223 -0
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +299 -0
- data/lib/mailslurp_client/models/{page_inbox_ruleset_projection.rb → page_inbox_ruleset_dto.rb} +4 -4
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +299 -0
- data/lib/mailslurp_client/models/send_email_options.rb +11 -1
- data/lib/mailslurp_client/models/sent_email_dto.rb +12 -1
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +225 -0
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +225 -0
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +303 -0
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +289 -0
- data/lib/mailslurp_client/models/webhook_dto.rb +2 -2
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +322 -0
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +2 -2
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +2 -2
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +2 -2
- data/lib/mailslurp_client/models/webhook_result_entity.rb +2 -2
- data/lib/mailslurp_client/version.rb +1 -1
- metadata +19 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8d907fe29af9707e86cda64ddeb8374eda666440f3bb1e22e3d198393659bf00
|
4
|
+
data.tar.gz: 33fb186e151fb3e226050b3c011826cdbb78913dea7535d260e106e1b91fa5dd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2b6866210153496dd4fc9426b14b64875e12ca827d552dbc99290aaa1a11a1480ab82313704992dcfa27299cc0b8fec934acc71bea734655a347f99881308a49
|
7
|
+
data.tar.gz: 156ad05851da940c8a3fd122456c99ccc5ecaf611062361e5eb372b632733a1c7aff4641db6011b151ed324070f484369a4d3e616dba9455f502c1601aa021aa
|
data/lib/mailslurp_client.rb
CHANGED
@@ -33,8 +33,10 @@ require 'mailslurp_client/models/create_contact_options'
|
|
33
33
|
require 'mailslurp_client/models/create_domain_options'
|
34
34
|
require 'mailslurp_client/models/create_group_options'
|
35
35
|
require 'mailslurp_client/models/create_inbox_dto'
|
36
|
+
require 'mailslurp_client/models/create_inbox_forwarder_options'
|
36
37
|
require 'mailslurp_client/models/create_inbox_ruleset_options'
|
37
38
|
require 'mailslurp_client/models/create_template_options'
|
39
|
+
require 'mailslurp_client/models/create_tracking_pixel_options'
|
38
40
|
require 'mailslurp_client/models/create_webhook_options'
|
39
41
|
require 'mailslurp_client/models/dns_lookup_options'
|
40
42
|
require 'mailslurp_client/models/dns_lookup_result'
|
@@ -64,9 +66,13 @@ require 'mailslurp_client/models/group_projection'
|
|
64
66
|
require 'mailslurp_client/models/html_validation_result'
|
65
67
|
require 'mailslurp_client/models/ip_address_result'
|
66
68
|
require 'mailslurp_client/models/inbox'
|
69
|
+
require 'mailslurp_client/models/inbox_forwarder_dto'
|
70
|
+
require 'mailslurp_client/models/inbox_forwarder_test_options'
|
71
|
+
require 'mailslurp_client/models/inbox_forwarder_test_result'
|
67
72
|
require 'mailslurp_client/models/inbox_projection'
|
68
73
|
require 'mailslurp_client/models/inbox_ruleset_dto'
|
69
|
-
require 'mailslurp_client/models/
|
74
|
+
require 'mailslurp_client/models/inbox_ruleset_test_options'
|
75
|
+
require 'mailslurp_client/models/inbox_ruleset_test_result'
|
70
76
|
require 'mailslurp_client/models/match_option'
|
71
77
|
require 'mailslurp_client/models/match_options'
|
72
78
|
require 'mailslurp_client/models/missed_email'
|
@@ -81,13 +87,15 @@ require 'mailslurp_client/models/page_email_preview'
|
|
81
87
|
require 'mailslurp_client/models/page_email_projection'
|
82
88
|
require 'mailslurp_client/models/page_expired_inbox_record_projection'
|
83
89
|
require 'mailslurp_client/models/page_group_projection'
|
90
|
+
require 'mailslurp_client/models/page_inbox_forwarder_dto'
|
84
91
|
require 'mailslurp_client/models/page_inbox_projection'
|
85
|
-
require 'mailslurp_client/models/
|
92
|
+
require 'mailslurp_client/models/page_inbox_ruleset_dto'
|
86
93
|
require 'mailslurp_client/models/page_missed_email_projection'
|
87
94
|
require 'mailslurp_client/models/page_organization_inbox_projection'
|
88
95
|
require 'mailslurp_client/models/page_sent_email_projection'
|
89
96
|
require 'mailslurp_client/models/page_template_projection'
|
90
97
|
require 'mailslurp_client/models/page_thread_projection'
|
98
|
+
require 'mailslurp_client/models/page_tracking_pixel_projection'
|
91
99
|
require 'mailslurp_client/models/page_webhook_projection'
|
92
100
|
require 'mailslurp_client/models/page_webhook_result'
|
93
101
|
require 'mailslurp_client/models/pageable'
|
@@ -103,7 +111,11 @@ require 'mailslurp_client/models/sort'
|
|
103
111
|
require 'mailslurp_client/models/template_dto'
|
104
112
|
require 'mailslurp_client/models/template_projection'
|
105
113
|
require 'mailslurp_client/models/template_variable'
|
114
|
+
require 'mailslurp_client/models/test_new_inbox_forwarder_options'
|
115
|
+
require 'mailslurp_client/models/test_new_inbox_ruleset_options'
|
106
116
|
require 'mailslurp_client/models/thread_projection'
|
117
|
+
require 'mailslurp_client/models/tracking_pixel_dto'
|
118
|
+
require 'mailslurp_client/models/tracking_pixel_projection'
|
107
119
|
require 'mailslurp_client/models/unread_count'
|
108
120
|
require 'mailslurp_client/models/update_alias_options'
|
109
121
|
require 'mailslurp_client/models/update_domain_options'
|
@@ -115,6 +127,7 @@ require 'mailslurp_client/models/validation_message'
|
|
115
127
|
require 'mailslurp_client/models/verify_email_address_options'
|
116
128
|
require 'mailslurp_client/models/wait_for_conditions'
|
117
129
|
require 'mailslurp_client/models/webhook_dto'
|
130
|
+
require 'mailslurp_client/models/webhook_email_opened_payload'
|
118
131
|
require 'mailslurp_client/models/webhook_new_attachment_payload'
|
119
132
|
require 'mailslurp_client/models/webhook_new_contact_payload'
|
120
133
|
require 'mailslurp_client/models/webhook_new_email_payload'
|
@@ -137,11 +150,13 @@ require 'mailslurp_client/api/export_controller_api'
|
|
137
150
|
require 'mailslurp_client/api/form_controller_api'
|
138
151
|
require 'mailslurp_client/api/group_controller_api'
|
139
152
|
require 'mailslurp_client/api/inbox_controller_api'
|
153
|
+
require 'mailslurp_client/api/inbox_forwarder_controller_api'
|
140
154
|
require 'mailslurp_client/api/inbox_ruleset_controller_api'
|
141
155
|
require 'mailslurp_client/api/mail_server_controller_api'
|
142
156
|
require 'mailslurp_client/api/missed_email_controller_api'
|
143
157
|
require 'mailslurp_client/api/sent_emails_controller_api'
|
144
158
|
require 'mailslurp_client/api/template_controller_api'
|
159
|
+
require 'mailslurp_client/api/tracking_controller_api'
|
145
160
|
require 'mailslurp_client/api/wait_for_controller_api'
|
146
161
|
require 'mailslurp_client/api/webhook_controller_api'
|
147
162
|
|
@@ -141,8 +141,8 @@ module MailSlurpClient
|
|
141
141
|
|
142
142
|
# Get all contacts
|
143
143
|
# @param [Hash] opts the optional parameters
|
144
|
-
# @option opts [Integer] :page Optional page index in
|
145
|
-
# @option opts [Integer] :size Optional page size in
|
144
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
145
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
146
146
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
147
147
|
# @return [PageContactProjection]
|
148
148
|
def get_all_contacts(opts = {})
|
@@ -152,8 +152,8 @@ module MailSlurpClient
|
|
152
152
|
|
153
153
|
# Get all contacts
|
154
154
|
# @param [Hash] opts the optional parameters
|
155
|
-
# @option opts [Integer] :page Optional page index in
|
156
|
-
# @option opts [Integer] :size Optional page size in
|
155
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
156
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
157
157
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
158
158
|
# @return [Array<(PageContactProjection, Integer, Hash)>] PageContactProjection data, response status code and response headers
|
159
159
|
def get_all_contacts_with_http_info(opts = {})
|
@@ -401,10 +401,10 @@ module MailSlurpClient
|
|
401
401
|
# @param email_id [String] ID of email
|
402
402
|
# @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
|
403
403
|
# @param [Hash] opts the optional parameters
|
404
|
-
# @return [
|
404
|
+
# @return [SentEmailDto]
|
405
405
|
def forward_email(email_id, forward_email_options, opts = {})
|
406
|
-
forward_email_with_http_info(email_id, forward_email_options, opts)
|
407
|
-
|
406
|
+
data, _status_code, _headers = forward_email_with_http_info(email_id, forward_email_options, opts)
|
407
|
+
data
|
408
408
|
end
|
409
409
|
|
410
410
|
# Forward email to recipients
|
@@ -412,7 +412,7 @@ module MailSlurpClient
|
|
412
412
|
# @param email_id [String] ID of email
|
413
413
|
# @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
|
414
414
|
# @param [Hash] opts the optional parameters
|
415
|
-
# @return [Array<(
|
415
|
+
# @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
|
416
416
|
def forward_email_with_http_info(email_id, forward_email_options, opts = {})
|
417
417
|
if @api_client.config.debugging
|
418
418
|
@api_client.config.logger.debug 'Calling API: EmailControllerApi.forward_email ...'
|
@@ -433,6 +433,8 @@ module MailSlurpClient
|
|
433
433
|
|
434
434
|
# header parameters
|
435
435
|
header_params = opts[:header_params] || {}
|
436
|
+
# HTTP header 'Accept' (if needed)
|
437
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
436
438
|
# HTTP header 'Content-Type'
|
437
439
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
438
440
|
|
@@ -443,7 +445,7 @@ module MailSlurpClient
|
|
443
445
|
post_body = opts[:body] || @api_client.object_to_http_body(forward_email_options)
|
444
446
|
|
445
447
|
# return_type
|
446
|
-
return_type = opts[:return_type]
|
448
|
+
return_type = opts[:return_type] || 'SentEmailDto'
|
447
449
|
|
448
450
|
# auth_names
|
449
451
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -1451,6 +1453,70 @@ module MailSlurpClient
|
|
1451
1453
|
return data, status_code, headers
|
1452
1454
|
end
|
1453
1455
|
|
1456
|
+
# Send email
|
1457
|
+
# Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
|
1458
|
+
# @param [Hash] opts the optional parameters
|
1459
|
+
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
1460
|
+
# @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
|
1461
|
+
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
1462
|
+
# @return [nil]
|
1463
|
+
def send_email_source_optional(opts = {})
|
1464
|
+
send_email_source_optional_with_http_info(opts)
|
1465
|
+
nil
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
# Send email
|
1469
|
+
# Alias for `InboxController.sendEmail` method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
|
1470
|
+
# @param [Hash] opts the optional parameters
|
1471
|
+
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
1472
|
+
# @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
|
1473
|
+
# @option opts [SendEmailOptions] :send_email_options Options for the email
|
1474
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1475
|
+
def send_email_source_optional_with_http_info(opts = {})
|
1476
|
+
if @api_client.config.debugging
|
1477
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.send_email_source_optional ...'
|
1478
|
+
end
|
1479
|
+
# resource path
|
1480
|
+
local_var_path = '/emails'
|
1481
|
+
|
1482
|
+
# query parameters
|
1483
|
+
query_params = opts[:query_params] || {}
|
1484
|
+
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
1485
|
+
query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
|
1486
|
+
|
1487
|
+
# header parameters
|
1488
|
+
header_params = opts[:header_params] || {}
|
1489
|
+
# HTTP header 'Content-Type'
|
1490
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1491
|
+
|
1492
|
+
# form parameters
|
1493
|
+
form_params = opts[:form_params] || {}
|
1494
|
+
|
1495
|
+
# http body (model)
|
1496
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'send_email_options'])
|
1497
|
+
|
1498
|
+
# return_type
|
1499
|
+
return_type = opts[:return_type]
|
1500
|
+
|
1501
|
+
# auth_names
|
1502
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1503
|
+
|
1504
|
+
new_options = opts.merge(
|
1505
|
+
:header_params => header_params,
|
1506
|
+
:query_params => query_params,
|
1507
|
+
:form_params => form_params,
|
1508
|
+
:body => post_body,
|
1509
|
+
:auth_names => auth_names,
|
1510
|
+
:return_type => return_type
|
1511
|
+
)
|
1512
|
+
|
1513
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1514
|
+
if @api_client.config.debugging
|
1515
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#send_email_source_optional\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1516
|
+
end
|
1517
|
+
return data, status_code, headers
|
1518
|
+
end
|
1519
|
+
|
1454
1520
|
# Validate email HTML contents
|
1455
1521
|
# Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
|
1456
1522
|
# @param email_id [String] ID of email
|
@@ -209,8 +209,8 @@ module MailSlurpClient
|
|
209
209
|
|
210
210
|
# Get all Contact Groups in paginated format
|
211
211
|
# @param [Hash] opts the optional parameters
|
212
|
-
# @option opts [Integer] :page Optional page index in
|
213
|
-
# @option opts [Integer] :size Optional page size in
|
212
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
213
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
214
214
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
215
215
|
# @return [PageGroupProjection]
|
216
216
|
def get_all_groups(opts = {})
|
@@ -220,8 +220,8 @@ module MailSlurpClient
|
|
220
220
|
|
221
221
|
# Get all Contact Groups in paginated format
|
222
222
|
# @param [Hash] opts the optional parameters
|
223
|
-
# @option opts [Integer] :page Optional page index in
|
224
|
-
# @option opts [Integer] :size Optional page size in
|
223
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
224
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
225
225
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
226
226
|
# @return [Array<(PageGroupProjection, Integer, Hash)>] PageGroupProjection data, response status code and response headers
|
227
227
|
def get_all_groups_with_http_info(opts = {})
|
@@ -114,10 +114,10 @@ module MailSlurpClient
|
|
114
114
|
# @param inbox_id [String] inboxId
|
115
115
|
# @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
|
116
116
|
# @param [Hash] opts the optional parameters
|
117
|
-
# @return [
|
117
|
+
# @return [InboxRulesetDto]
|
118
118
|
def create_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {})
|
119
|
-
create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts)
|
120
|
-
|
119
|
+
data, _status_code, _headers = create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts)
|
120
|
+
data
|
121
121
|
end
|
122
122
|
|
123
123
|
# Create an inbox ruleset
|
@@ -125,7 +125,7 @@ module MailSlurpClient
|
|
125
125
|
# @param inbox_id [String] inboxId
|
126
126
|
# @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
|
127
127
|
# @param [Hash] opts the optional parameters
|
128
|
-
# @return [Array<(
|
128
|
+
# @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
|
129
129
|
def create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {})
|
130
130
|
if @api_client.config.debugging
|
131
131
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_ruleset ...'
|
@@ -146,6 +146,8 @@ module MailSlurpClient
|
|
146
146
|
|
147
147
|
# header parameters
|
148
148
|
header_params = opts[:header_params] || {}
|
149
|
+
# HTTP header 'Accept' (if needed)
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
149
151
|
# HTTP header 'Content-Type'
|
150
152
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
151
153
|
|
@@ -156,7 +158,7 @@ module MailSlurpClient
|
|
156
158
|
post_body = opts[:body] || @api_client.object_to_http_body(create_inbox_ruleset_options)
|
157
159
|
|
158
160
|
# return_type
|
159
|
-
return_type = opts[:return_type]
|
161
|
+
return_type = opts[:return_type] || 'InboxRulesetDto'
|
160
162
|
|
161
163
|
# auth_names
|
162
164
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -413,9 +415,9 @@ module MailSlurpClient
|
|
413
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.
|
414
416
|
# @param [Hash] opts the optional parameters
|
415
417
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
|
416
|
-
# @option opts [Integer] :page Optional page index in
|
418
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
417
419
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
418
|
-
# @option opts [Integer] :size Optional page size in
|
420
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
419
421
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
420
422
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
421
423
|
# @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included (default to false)
|
@@ -429,9 +431,9 @@ module MailSlurpClient
|
|
429
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.
|
430
432
|
# @param [Hash] opts the optional parameters
|
431
433
|
# @option opts [Boolean] :favourite Optionally filter results for favourites only
|
432
|
-
# @option opts [Integer] :page Optional page index in
|
434
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
433
435
|
# @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
|
434
|
-
# @option opts [Integer] :size Optional page size in
|
436
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
435
437
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
436
438
|
# @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
|
437
439
|
# @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included
|
@@ -845,8 +847,8 @@ module MailSlurpClient
|
|
845
847
|
return data, status_code, headers
|
846
848
|
end
|
847
849
|
|
848
|
-
# List Inboxes and email
|
849
|
-
# List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended
|
850
|
+
# List Inboxes and email addresses
|
851
|
+
# 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.
|
850
852
|
# @param [Hash] opts the optional parameters
|
851
853
|
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries. (default to 100)
|
852
854
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
@@ -856,8 +858,8 @@ module MailSlurpClient
|
|
856
858
|
data
|
857
859
|
end
|
858
860
|
|
859
|
-
# List Inboxes and email
|
860
|
-
# List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended
|
861
|
+
# List Inboxes and email addresses
|
862
|
+
# 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.
|
861
863
|
# @param [Hash] opts the optional parameters
|
862
864
|
# @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated `getAllEmails` for larger queries.
|
863
865
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
@@ -914,9 +916,9 @@ module MailSlurpClient
|
|
914
916
|
# List Organization Inboxes Paginated
|
915
917
|
# 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).
|
916
918
|
# @param [Hash] opts the optional parameters
|
917
|
-
# @option opts [Integer] :page Optional page index in
|
919
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
918
920
|
# @option opts [String] :search_filter Optional search filter
|
919
|
-
# @option opts [Integer] :size Optional page size in
|
921
|
+
# @option opts [Integer] :size Optional page size in list pagination (default to 20)
|
920
922
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
921
923
|
# @return [PageOrganizationInboxProjection]
|
922
924
|
def get_organization_inboxes(opts = {})
|
@@ -927,9 +929,9 @@ module MailSlurpClient
|
|
927
929
|
# List Organization Inboxes Paginated
|
928
930
|
# 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).
|
929
931
|
# @param [Hash] opts the optional parameters
|
930
|
-
# @option opts [Integer] :page Optional page index in
|
932
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
931
933
|
# @option opts [String] :search_filter Optional search filter
|
932
|
-
# @option opts [Integer] :size Optional page size in
|
934
|
+
# @option opts [Integer] :size Optional page size in list pagination
|
933
935
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
934
936
|
# @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
|
935
937
|
def get_organization_inboxes_with_http_info(opts = {})
|
@@ -988,12 +990,13 @@ module MailSlurpClient
|
|
988
990
|
# @param inbox_id [String] inboxId
|
989
991
|
# @param [Hash] opts the optional parameters
|
990
992
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
|
993
|
+
# @option opts [String] :search_filter Optional search filter
|
991
994
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
|
992
995
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
993
|
-
# @return [
|
996
|
+
# @return [PageInboxRulesetDto]
|
994
997
|
def list_inbox_rulesets(inbox_id, opts = {})
|
995
|
-
list_inbox_rulesets_with_http_info(inbox_id, opts)
|
996
|
-
|
998
|
+
data, _status_code, _headers = list_inbox_rulesets_with_http_info(inbox_id, opts)
|
999
|
+
data
|
997
1000
|
end
|
998
1001
|
|
999
1002
|
# List inbox rulesets
|
@@ -1001,9 +1004,10 @@ module MailSlurpClient
|
|
1001
1004
|
# @param inbox_id [String] inboxId
|
1002
1005
|
# @param [Hash] opts the optional parameters
|
1003
1006
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination
|
1007
|
+
# @option opts [String] :search_filter Optional search filter
|
1004
1008
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination
|
1005
1009
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1006
|
-
# @return [Array<(
|
1010
|
+
# @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
|
1007
1011
|
def list_inbox_rulesets_with_http_info(inbox_id, opts = {})
|
1008
1012
|
if @api_client.config.debugging
|
1009
1013
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.list_inbox_rulesets ...'
|
@@ -1022,11 +1026,14 @@ module MailSlurpClient
|
|
1022
1026
|
# query parameters
|
1023
1027
|
query_params = opts[:query_params] || {}
|
1024
1028
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1029
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1025
1030
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1026
1031
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1027
1032
|
|
1028
1033
|
# header parameters
|
1029
1034
|
header_params = opts[:header_params] || {}
|
1035
|
+
# HTTP header 'Accept' (if needed)
|
1036
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1030
1037
|
|
1031
1038
|
# form parameters
|
1032
1039
|
form_params = opts[:form_params] || {}
|
@@ -1035,7 +1042,7 @@ module MailSlurpClient
|
|
1035
1042
|
post_body = opts[:body]
|
1036
1043
|
|
1037
1044
|
# return_type
|
1038
|
-
return_type = opts[:return_type]
|
1045
|
+
return_type = opts[:return_type] || 'PageInboxRulesetDto'
|
1039
1046
|
|
1040
1047
|
# auth_names
|
1041
1048
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -1056,6 +1063,84 @@ module MailSlurpClient
|
|
1056
1063
|
return data, status_code, headers
|
1057
1064
|
end
|
1058
1065
|
|
1066
|
+
# List inbox tracking pixels
|
1067
|
+
# List all tracking pixels sent from an inbox
|
1068
|
+
# @param inbox_id [String] inboxId
|
1069
|
+
# @param [Hash] opts the optional parameters
|
1070
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
|
1071
|
+
# @option opts [String] :search_filter Optional search filter
|
1072
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
|
1073
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
1074
|
+
# @return [PageTrackingPixelProjection]
|
1075
|
+
def list_inbox_tracking_pixels(inbox_id, opts = {})
|
1076
|
+
data, _status_code, _headers = list_inbox_tracking_pixels_with_http_info(inbox_id, opts)
|
1077
|
+
data
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# List inbox tracking pixels
|
1081
|
+
# List all tracking pixels sent from an inbox
|
1082
|
+
# @param inbox_id [String] inboxId
|
1083
|
+
# @param [Hash] opts the optional parameters
|
1084
|
+
# @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
|
1085
|
+
# @option opts [String] :search_filter Optional search filter
|
1086
|
+
# @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
|
1087
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
1088
|
+
# @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
|
1089
|
+
def list_inbox_tracking_pixels_with_http_info(inbox_id, opts = {})
|
1090
|
+
if @api_client.config.debugging
|
1091
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.list_inbox_tracking_pixels ...'
|
1092
|
+
end
|
1093
|
+
# verify the required parameter 'inbox_id' is set
|
1094
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
1095
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.list_inbox_tracking_pixels"
|
1096
|
+
end
|
1097
|
+
allowable_values = ["ASC", "DESC"]
|
1098
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
1099
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
1100
|
+
end
|
1101
|
+
# resource path
|
1102
|
+
local_var_path = '/inboxes/{inboxId}/tracking-pixels'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
|
1103
|
+
|
1104
|
+
# query parameters
|
1105
|
+
query_params = opts[:query_params] || {}
|
1106
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
1107
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
1108
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
1109
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
1110
|
+
|
1111
|
+
# header parameters
|
1112
|
+
header_params = opts[:header_params] || {}
|
1113
|
+
# HTTP header 'Accept' (if needed)
|
1114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1115
|
+
|
1116
|
+
# form parameters
|
1117
|
+
form_params = opts[:form_params] || {}
|
1118
|
+
|
1119
|
+
# http body (model)
|
1120
|
+
post_body = opts[:body]
|
1121
|
+
|
1122
|
+
# return_type
|
1123
|
+
return_type = opts[:return_type] || 'PageTrackingPixelProjection'
|
1124
|
+
|
1125
|
+
# auth_names
|
1126
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1127
|
+
|
1128
|
+
new_options = opts.merge(
|
1129
|
+
:header_params => header_params,
|
1130
|
+
:query_params => query_params,
|
1131
|
+
:form_params => form_params,
|
1132
|
+
:body => post_body,
|
1133
|
+
:auth_names => auth_names,
|
1134
|
+
:return_type => return_type
|
1135
|
+
)
|
1136
|
+
|
1137
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1138
|
+
if @api_client.config.debugging
|
1139
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#list_inbox_tracking_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1140
|
+
end
|
1141
|
+
return data, status_code, headers
|
1142
|
+
end
|
1143
|
+
|
1059
1144
|
# Send Email
|
1060
1145
|
# Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
|
1061
1146
|
# @param inbox_id [String] ID of the inbox you want to send the email from
|