mailslurp_client 15.14.0 → 15.15.1
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.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/bounce_controller_api.rb +76 -0
- data/lib/mailslurp_client/api/inbox_controller_api.rb +131 -5
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +145 -0
- data/lib/mailslurp_client/models/contact_projection.rb +26 -26
- data/lib/mailslurp_client/models/forward_email_options.rb +16 -5
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +316 -0
- data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +250 -0
- data/lib/mailslurp_client/models/page_alias.rb +10 -10
- data/lib/mailslurp_client/models/page_attachment_entity.rb +10 -10
- data/lib/mailslurp_client/models/page_bounced_email.rb +10 -10
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +10 -10
- data/lib/mailslurp_client/models/page_complaint.rb +10 -10
- data/lib/mailslurp_client/models/page_contact_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_delivery_status.rb +10 -10
- data/lib/mailslurp_client/models/page_email_preview.rb +10 -10
- data/lib/mailslurp_client/models/page_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_email_validation_request.rb +10 -10
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_group_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +308 -0
- data/lib/mailslurp_client/models/page_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +308 -0
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +16 -16
- data/lib/mailslurp_client/models/page_sms_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_template_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_thread_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_webhook_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_webhook_result.rb +10 -10
- data/lib/mailslurp_client/models/scheduled_job.rb +2 -2
- data/lib/mailslurp_client/models/scheduled_job_dto.rb +371 -0
- data/lib/mailslurp_client/models/sent_email_projection.rb +56 -56
- data/lib/mailslurp_client/models/sort.rb +13 -13
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +5 -0
- metadata +7 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3afacb167496caeeb14fd0729514b99481e413fed1937c125b30f3daa185a28d
|
4
|
+
data.tar.gz: 2a1f0dba656f186fe4dacbbbda10b57786c226e64406fd0a1f2ffd2041d78f9e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fe3e225c87ec823b407fec99d2fd08fedcf19223f85d9510d17095a80c37d1a6603da9fe0f5cb92db40c81680ced407dc5ee3069651590523954449db32b9d88
|
7
|
+
data.tar.gz: 38c1dabe8262bff661abf071f4cdf79a8f5b80543c50ad48863c42eaeb6720be3cf2d7cb8a4b7e89cd22489469ba7f213b7dd155dffb75e9222e6fc2afe87357
|
@@ -443,5 +443,81 @@ module MailSlurpClient
|
|
443
443
|
end
|
444
444
|
return data, status_code, headers
|
445
445
|
end
|
446
|
+
|
447
|
+
# Get paginated list of unsubscribed recipients.
|
448
|
+
# Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
|
449
|
+
# @param [Hash] opts the optional parameters
|
450
|
+
# @option opts [Integer] :page Optional page index (default to 0)
|
451
|
+
# @option opts [Integer] :size Optional page size (default to 20)
|
452
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
453
|
+
# @option opts [String] :domain_id Filter by domainId
|
454
|
+
# @return [PageListUnsubscribeRecipients]
|
455
|
+
def get_list_unsubscribe_recipients(opts = {})
|
456
|
+
data, _status_code, _headers = get_list_unsubscribe_recipients_with_http_info(opts)
|
457
|
+
data
|
458
|
+
end
|
459
|
+
|
460
|
+
# Get paginated list of unsubscribed recipients.
|
461
|
+
# Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
|
462
|
+
# @param [Hash] opts the optional parameters
|
463
|
+
# @option opts [Integer] :page Optional page index
|
464
|
+
# @option opts [Integer] :size Optional page size
|
465
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
466
|
+
# @option opts [String] :domain_id Filter by domainId
|
467
|
+
# @return [Array<(PageListUnsubscribeRecipients, Integer, Hash)>] PageListUnsubscribeRecipients data, response status code and response headers
|
468
|
+
def get_list_unsubscribe_recipients_with_http_info(opts = {})
|
469
|
+
if @api_client.config.debugging
|
470
|
+
@api_client.config.logger.debug 'Calling API: BounceControllerApi.get_list_unsubscribe_recipients ...'
|
471
|
+
end
|
472
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
473
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling BounceControllerApi.get_list_unsubscribe_recipients, must be smaller than or equal to 100.'
|
474
|
+
end
|
475
|
+
|
476
|
+
allowable_values = ["ASC", "DESC"]
|
477
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
478
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
479
|
+
end
|
480
|
+
# resource path
|
481
|
+
local_var_path = '/bounce/list-unsubscribe-recipients'
|
482
|
+
|
483
|
+
# query parameters
|
484
|
+
query_params = opts[:query_params] || {}
|
485
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
486
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
487
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
488
|
+
query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil?
|
489
|
+
|
490
|
+
# header parameters
|
491
|
+
header_params = opts[:header_params] || {}
|
492
|
+
# HTTP header 'Accept' (if needed)
|
493
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
494
|
+
|
495
|
+
# form parameters
|
496
|
+
form_params = opts[:form_params] || {}
|
497
|
+
|
498
|
+
# http body (model)
|
499
|
+
post_body = opts[:body]
|
500
|
+
|
501
|
+
# return_type
|
502
|
+
return_type = opts[:return_type] || 'PageListUnsubscribeRecipients'
|
503
|
+
|
504
|
+
# auth_names
|
505
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
506
|
+
|
507
|
+
new_options = opts.merge(
|
508
|
+
:header_params => header_params,
|
509
|
+
:query_params => query_params,
|
510
|
+
:form_params => form_params,
|
511
|
+
:body => post_body,
|
512
|
+
:auth_names => auth_names,
|
513
|
+
:return_type => return_type
|
514
|
+
)
|
515
|
+
|
516
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
517
|
+
if @api_client.config.debugging
|
518
|
+
@api_client.config.logger.debug "API called: BounceControllerApi#get_list_unsubscribe_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
519
|
+
end
|
520
|
+
return data, status_code, headers
|
521
|
+
end
|
446
522
|
end
|
447
523
|
end
|
@@ -19,6 +19,68 @@ module MailSlurpClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Cancel a scheduled email job
|
23
|
+
# Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
|
24
|
+
# @param job_id [String]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [ScheduledJobDto]
|
27
|
+
def cancel_scheduled_job(job_id, opts = {})
|
28
|
+
data, _status_code, _headers = cancel_scheduled_job_with_http_info(job_id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Cancel a scheduled email job
|
33
|
+
# Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
|
34
|
+
# @param job_id [String]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(ScheduledJobDto, Integer, Hash)>] ScheduledJobDto data, response status code and response headers
|
37
|
+
def cancel_scheduled_job_with_http_info(job_id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.cancel_scheduled_job ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'job_id' is set
|
42
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling InboxControllerApi.cancel_scheduled_job"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/inboxes/scheduled-jobs/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:return_type] || 'ScheduledJobDto'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:header_params => header_params,
|
70
|
+
:query_params => query_params,
|
71
|
+
:form_params => form_params,
|
72
|
+
:body => post_body,
|
73
|
+
:auth_names => auth_names,
|
74
|
+
:return_type => return_type
|
75
|
+
)
|
76
|
+
|
77
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
78
|
+
if @api_client.config.debugging
|
79
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#cancel_scheduled_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
|
+
end
|
81
|
+
return data, status_code, headers
|
82
|
+
end
|
83
|
+
|
22
84
|
# 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
85
|
# 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
86
|
# @param [Hash] opts the optional parameters
|
@@ -1808,6 +1870,68 @@ module MailSlurpClient
|
|
1808
1870
|
return data, status_code, headers
|
1809
1871
|
end
|
1810
1872
|
|
1873
|
+
# Get a scheduled email job
|
1874
|
+
# Get a scheduled email job details.
|
1875
|
+
# @param job_id [String]
|
1876
|
+
# @param [Hash] opts the optional parameters
|
1877
|
+
# @return [ScheduledJobDto]
|
1878
|
+
def get_scheduled_job(job_id, opts = {})
|
1879
|
+
data, _status_code, _headers = get_scheduled_job_with_http_info(job_id, opts)
|
1880
|
+
data
|
1881
|
+
end
|
1882
|
+
|
1883
|
+
# Get a scheduled email job
|
1884
|
+
# Get a scheduled email job details.
|
1885
|
+
# @param job_id [String]
|
1886
|
+
# @param [Hash] opts the optional parameters
|
1887
|
+
# @return [Array<(ScheduledJobDto, Integer, Hash)>] ScheduledJobDto data, response status code and response headers
|
1888
|
+
def get_scheduled_job_with_http_info(job_id, opts = {})
|
1889
|
+
if @api_client.config.debugging
|
1890
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_scheduled_job ...'
|
1891
|
+
end
|
1892
|
+
# verify the required parameter 'job_id' is set
|
1893
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
1894
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling InboxControllerApi.get_scheduled_job"
|
1895
|
+
end
|
1896
|
+
# resource path
|
1897
|
+
local_var_path = '/inboxes/scheduled-jobs/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s))
|
1898
|
+
|
1899
|
+
# query parameters
|
1900
|
+
query_params = opts[:query_params] || {}
|
1901
|
+
|
1902
|
+
# header parameters
|
1903
|
+
header_params = opts[:header_params] || {}
|
1904
|
+
# HTTP header 'Accept' (if needed)
|
1905
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1906
|
+
|
1907
|
+
# form parameters
|
1908
|
+
form_params = opts[:form_params] || {}
|
1909
|
+
|
1910
|
+
# http body (model)
|
1911
|
+
post_body = opts[:body]
|
1912
|
+
|
1913
|
+
# return_type
|
1914
|
+
return_type = opts[:return_type] || 'ScheduledJobDto'
|
1915
|
+
|
1916
|
+
# auth_names
|
1917
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1918
|
+
|
1919
|
+
new_options = opts.merge(
|
1920
|
+
:header_params => header_params,
|
1921
|
+
:query_params => query_params,
|
1922
|
+
:form_params => form_params,
|
1923
|
+
:body => post_body,
|
1924
|
+
:auth_names => auth_names,
|
1925
|
+
:return_type => return_type
|
1926
|
+
)
|
1927
|
+
|
1928
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1929
|
+
if @api_client.config.debugging
|
1930
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_scheduled_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1931
|
+
end
|
1932
|
+
return data, status_code, headers
|
1933
|
+
end
|
1934
|
+
|
1811
1935
|
# Get all scheduled email sending jobs for the inbox
|
1812
1936
|
# Schedule sending of emails using scheduled jobs.
|
1813
1937
|
# @param inbox_id [String]
|
@@ -2408,10 +2532,10 @@ module MailSlurpClient
|
|
2408
2532
|
# @option opts [DateTime] :send_at_timestamp Sending timestamp
|
2409
2533
|
# @option opts [Integer] :send_at_now_plus_seconds Send after n seconds
|
2410
2534
|
# @option opts [Boolean] :validate_before_enqueue Validate before adding to queue
|
2411
|
-
# @return [
|
2535
|
+
# @return [ScheduledJobDto]
|
2412
2536
|
def send_with_schedule(inbox_id, send_email_options, opts = {})
|
2413
|
-
send_with_schedule_with_http_info(inbox_id, send_email_options, opts)
|
2414
|
-
|
2537
|
+
data, _status_code, _headers = send_with_schedule_with_http_info(inbox_id, send_email_options, opts)
|
2538
|
+
data
|
2415
2539
|
end
|
2416
2540
|
|
2417
2541
|
# Send email with with delay or schedule
|
@@ -2422,7 +2546,7 @@ module MailSlurpClient
|
|
2422
2546
|
# @option opts [DateTime] :send_at_timestamp Sending timestamp
|
2423
2547
|
# @option opts [Integer] :send_at_now_plus_seconds Send after n seconds
|
2424
2548
|
# @option opts [Boolean] :validate_before_enqueue Validate before adding to queue
|
2425
|
-
# @return [Array<(
|
2549
|
+
# @return [Array<(ScheduledJobDto, Integer, Hash)>] ScheduledJobDto data, response status code and response headers
|
2426
2550
|
def send_with_schedule_with_http_info(inbox_id, send_email_options, opts = {})
|
2427
2551
|
if @api_client.config.debugging
|
2428
2552
|
@api_client.config.logger.debug 'Calling API: InboxControllerApi.send_with_schedule ...'
|
@@ -2446,6 +2570,8 @@ module MailSlurpClient
|
|
2446
2570
|
|
2447
2571
|
# header parameters
|
2448
2572
|
header_params = opts[:header_params] || {}
|
2573
|
+
# HTTP header 'Accept' (if needed)
|
2574
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
2449
2575
|
# HTTP header 'Content-Type'
|
2450
2576
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2451
2577
|
|
@@ -2456,7 +2582,7 @@ module MailSlurpClient
|
|
2456
2582
|
post_body = opts[:body] || @api_client.object_to_http_body(send_email_options)
|
2457
2583
|
|
2458
2584
|
# return_type
|
2459
|
-
return_type = opts[:return_type]
|
2585
|
+
return_type = opts[:return_type] || 'ScheduledJobDto'
|
2460
2586
|
|
2461
2587
|
# auth_names
|
2462
2588
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -269,6 +269,81 @@ module MailSlurpClient
|
|
269
269
|
return data, status_code, headers
|
270
270
|
end
|
271
271
|
|
272
|
+
# Get an inbox forwarder event list
|
273
|
+
# Get inbox ruleset events
|
274
|
+
# @param id [String] ID of inbox forwarder
|
275
|
+
# @param [Hash] opts the optional parameters
|
276
|
+
# @option opts [Integer] :page Optional page index in inbox forwarder event list pagination (default to 0)
|
277
|
+
# @option opts [Integer] :size Optional page size in inbox forwarder event list pagination (default to 20)
|
278
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
279
|
+
# @return [PageInboxForwarderEvents]
|
280
|
+
def get_inbox_forwarder_events(id, opts = {})
|
281
|
+
data, _status_code, _headers = get_inbox_forwarder_events_with_http_info(id, opts)
|
282
|
+
data
|
283
|
+
end
|
284
|
+
|
285
|
+
# Get an inbox forwarder event list
|
286
|
+
# Get inbox ruleset events
|
287
|
+
# @param id [String] ID of inbox forwarder
|
288
|
+
# @param [Hash] opts the optional parameters
|
289
|
+
# @option opts [Integer] :page Optional page index in inbox forwarder event list pagination
|
290
|
+
# @option opts [Integer] :size Optional page size in inbox forwarder event list pagination
|
291
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
292
|
+
# @return [Array<(PageInboxForwarderEvents, Integer, Hash)>] PageInboxForwarderEvents data, response status code and response headers
|
293
|
+
def get_inbox_forwarder_events_with_http_info(id, opts = {})
|
294
|
+
if @api_client.config.debugging
|
295
|
+
@api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.get_inbox_forwarder_events ...'
|
296
|
+
end
|
297
|
+
# verify the required parameter 'id' is set
|
298
|
+
if @api_client.config.client_side_validation && id.nil?
|
299
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InboxForwarderControllerApi.get_inbox_forwarder_events"
|
300
|
+
end
|
301
|
+
allowable_values = ["ASC", "DESC"]
|
302
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
303
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
304
|
+
end
|
305
|
+
# resource path
|
306
|
+
local_var_path = '/forwarders/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
307
|
+
|
308
|
+
# query parameters
|
309
|
+
query_params = opts[:query_params] || {}
|
310
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
311
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
312
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
313
|
+
|
314
|
+
# header parameters
|
315
|
+
header_params = opts[:header_params] || {}
|
316
|
+
# HTTP header 'Accept' (if needed)
|
317
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
318
|
+
|
319
|
+
# form parameters
|
320
|
+
form_params = opts[:form_params] || {}
|
321
|
+
|
322
|
+
# http body (model)
|
323
|
+
post_body = opts[:body]
|
324
|
+
|
325
|
+
# return_type
|
326
|
+
return_type = opts[:return_type] || 'PageInboxForwarderEvents'
|
327
|
+
|
328
|
+
# auth_names
|
329
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
330
|
+
|
331
|
+
new_options = opts.merge(
|
332
|
+
:header_params => header_params,
|
333
|
+
:query_params => query_params,
|
334
|
+
:form_params => form_params,
|
335
|
+
:body => post_body,
|
336
|
+
:auth_names => auth_names,
|
337
|
+
:return_type => return_type
|
338
|
+
)
|
339
|
+
|
340
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
341
|
+
if @api_client.config.debugging
|
342
|
+
@api_client.config.logger.debug "API called: InboxForwarderControllerApi#get_inbox_forwarder_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
343
|
+
end
|
344
|
+
return data, status_code, headers
|
345
|
+
end
|
346
|
+
|
272
347
|
# List inbox forwarders
|
273
348
|
# List all forwarders attached to an inbox
|
274
349
|
# @param [Hash] opts the optional parameters
|
@@ -554,5 +629,75 @@ module MailSlurpClient
|
|
554
629
|
end
|
555
630
|
return data, status_code, headers
|
556
631
|
end
|
632
|
+
|
633
|
+
# Update an inbox forwarder
|
634
|
+
# Update inbox ruleset
|
635
|
+
# @param id [String] ID of inbox forwarder
|
636
|
+
# @param create_inbox_forwarder_options [CreateInboxForwarderOptions]
|
637
|
+
# @param [Hash] opts the optional parameters
|
638
|
+
# @return [InboxForwarderDto]
|
639
|
+
def update_inbox_forwarder(id, create_inbox_forwarder_options, opts = {})
|
640
|
+
data, _status_code, _headers = update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, opts)
|
641
|
+
data
|
642
|
+
end
|
643
|
+
|
644
|
+
# Update an inbox forwarder
|
645
|
+
# Update inbox ruleset
|
646
|
+
# @param id [String] ID of inbox forwarder
|
647
|
+
# @param create_inbox_forwarder_options [CreateInboxForwarderOptions]
|
648
|
+
# @param [Hash] opts the optional parameters
|
649
|
+
# @return [Array<(InboxForwarderDto, Integer, Hash)>] InboxForwarderDto data, response status code and response headers
|
650
|
+
def update_inbox_forwarder_with_http_info(id, create_inbox_forwarder_options, opts = {})
|
651
|
+
if @api_client.config.debugging
|
652
|
+
@api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.update_inbox_forwarder ...'
|
653
|
+
end
|
654
|
+
# verify the required parameter 'id' is set
|
655
|
+
if @api_client.config.client_side_validation && id.nil?
|
656
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InboxForwarderControllerApi.update_inbox_forwarder"
|
657
|
+
end
|
658
|
+
# verify the required parameter 'create_inbox_forwarder_options' is set
|
659
|
+
if @api_client.config.client_side_validation && create_inbox_forwarder_options.nil?
|
660
|
+
fail ArgumentError, "Missing the required parameter 'create_inbox_forwarder_options' when calling InboxForwarderControllerApi.update_inbox_forwarder"
|
661
|
+
end
|
662
|
+
# resource path
|
663
|
+
local_var_path = '/forwarders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
664
|
+
|
665
|
+
# query parameters
|
666
|
+
query_params = opts[:query_params] || {}
|
667
|
+
|
668
|
+
# header parameters
|
669
|
+
header_params = opts[:header_params] || {}
|
670
|
+
# HTTP header 'Accept' (if needed)
|
671
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
672
|
+
# HTTP header 'Content-Type'
|
673
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
674
|
+
|
675
|
+
# form parameters
|
676
|
+
form_params = opts[:form_params] || {}
|
677
|
+
|
678
|
+
# http body (model)
|
679
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_inbox_forwarder_options)
|
680
|
+
|
681
|
+
# return_type
|
682
|
+
return_type = opts[:return_type] || 'InboxForwarderDto'
|
683
|
+
|
684
|
+
# auth_names
|
685
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
686
|
+
|
687
|
+
new_options = opts.merge(
|
688
|
+
:header_params => header_params,
|
689
|
+
:query_params => query_params,
|
690
|
+
:form_params => form_params,
|
691
|
+
:body => post_body,
|
692
|
+
:auth_names => auth_names,
|
693
|
+
:return_type => return_type
|
694
|
+
)
|
695
|
+
|
696
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
697
|
+
if @api_client.config.debugging
|
698
|
+
@api_client.config.logger.debug "API called: InboxForwarderControllerApi#update_inbox_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
699
|
+
end
|
700
|
+
return data, status_code, headers
|
701
|
+
end
|
557
702
|
end
|
558
703
|
end
|
@@ -21,27 +21,27 @@ module MailSlurpClient
|
|
21
21
|
|
22
22
|
attr_accessor :created_at
|
23
23
|
|
24
|
-
attr_accessor :email_addresses
|
25
|
-
|
26
|
-
attr_accessor :opt_out
|
27
|
-
|
28
24
|
attr_accessor :first_name
|
29
25
|
|
30
26
|
attr_accessor :last_name
|
31
27
|
|
32
28
|
attr_accessor :company
|
33
29
|
|
30
|
+
attr_accessor :email_addresses
|
31
|
+
|
32
|
+
attr_accessor :opt_out
|
33
|
+
|
34
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
35
35
|
def self.attribute_map
|
36
36
|
{
|
37
37
|
:'id' => :'id',
|
38
38
|
:'group_id' => :'groupId',
|
39
39
|
:'created_at' => :'createdAt',
|
40
|
-
:'email_addresses' => :'emailAddresses',
|
41
|
-
:'opt_out' => :'optOut',
|
42
40
|
:'first_name' => :'firstName',
|
43
41
|
:'last_name' => :'lastName',
|
44
|
-
:'company' => :'company'
|
42
|
+
:'company' => :'company',
|
43
|
+
:'email_addresses' => :'emailAddresses',
|
44
|
+
:'opt_out' => :'optOut'
|
45
45
|
}
|
46
46
|
end
|
47
47
|
|
@@ -51,11 +51,11 @@ module MailSlurpClient
|
|
51
51
|
:'id' => :'String',
|
52
52
|
:'group_id' => :'String',
|
53
53
|
:'created_at' => :'DateTime',
|
54
|
-
:'email_addresses' => :'Array<String>',
|
55
|
-
:'opt_out' => :'Boolean',
|
56
54
|
:'first_name' => :'String',
|
57
55
|
:'last_name' => :'String',
|
58
|
-
:'company' => :'String'
|
56
|
+
:'company' => :'String',
|
57
|
+
:'email_addresses' => :'Array<String>',
|
58
|
+
:'opt_out' => :'Boolean'
|
59
59
|
}
|
60
60
|
end
|
61
61
|
|
@@ -63,10 +63,10 @@ module MailSlurpClient
|
|
63
63
|
def self.openapi_nullable
|
64
64
|
Set.new([
|
65
65
|
:'group_id',
|
66
|
-
:'email_addresses',
|
67
66
|
:'first_name',
|
68
67
|
:'last_name',
|
69
|
-
:'company'
|
68
|
+
:'company',
|
69
|
+
:'email_addresses',
|
70
70
|
])
|
71
71
|
end
|
72
72
|
|
@@ -97,16 +97,6 @@ module MailSlurpClient
|
|
97
97
|
self.created_at = attributes[:'created_at']
|
98
98
|
end
|
99
99
|
|
100
|
-
if attributes.key?(:'email_addresses')
|
101
|
-
if (value = attributes[:'email_addresses']).is_a?(Array)
|
102
|
-
self.email_addresses = value
|
103
|
-
end
|
104
|
-
end
|
105
|
-
|
106
|
-
if attributes.key?(:'opt_out')
|
107
|
-
self.opt_out = attributes[:'opt_out']
|
108
|
-
end
|
109
|
-
|
110
100
|
if attributes.key?(:'first_name')
|
111
101
|
self.first_name = attributes[:'first_name']
|
112
102
|
end
|
@@ -118,6 +108,16 @@ module MailSlurpClient
|
|
118
108
|
if attributes.key?(:'company')
|
119
109
|
self.company = attributes[:'company']
|
120
110
|
end
|
111
|
+
|
112
|
+
if attributes.key?(:'email_addresses')
|
113
|
+
if (value = attributes[:'email_addresses']).is_a?(Array)
|
114
|
+
self.email_addresses = value
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
if attributes.key?(:'opt_out')
|
119
|
+
self.opt_out = attributes[:'opt_out']
|
120
|
+
end
|
121
121
|
end
|
122
122
|
|
123
123
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -156,11 +156,11 @@ module MailSlurpClient
|
|
156
156
|
id == o.id &&
|
157
157
|
group_id == o.group_id &&
|
158
158
|
created_at == o.created_at &&
|
159
|
-
email_addresses == o.email_addresses &&
|
160
|
-
opt_out == o.opt_out &&
|
161
159
|
first_name == o.first_name &&
|
162
160
|
last_name == o.last_name &&
|
163
|
-
company == o.company
|
161
|
+
company == o.company &&
|
162
|
+
email_addresses == o.email_addresses &&
|
163
|
+
opt_out == o.opt_out
|
164
164
|
end
|
165
165
|
|
166
166
|
# @see the `==` method
|
@@ -172,7 +172,7 @@ module MailSlurpClient
|
|
172
172
|
# Calculates hash code according to all attributes.
|
173
173
|
# @return [Integer] Hash code
|
174
174
|
def hash
|
175
|
-
[id, group_id, created_at,
|
175
|
+
[id, group_id, created_at, first_name, last_name, company, email_addresses, opt_out].hash
|
176
176
|
end
|
177
177
|
|
178
178
|
# Builds the object from hash
|
@@ -33,6 +33,9 @@ module MailSlurpClient
|
|
33
33
|
# Optionally use inbox name as display name for sender email address
|
34
34
|
attr_accessor :use_inbox_name
|
35
35
|
|
36
|
+
# Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
|
37
|
+
attr_accessor :filter_bounced_recipients
|
38
|
+
|
36
39
|
# Attribute mapping from ruby-style variable name to JSON key.
|
37
40
|
def self.attribute_map
|
38
41
|
{
|
@@ -41,7 +44,8 @@ module MailSlurpClient
|
|
41
44
|
:'cc' => :'cc',
|
42
45
|
:'bcc' => :'bcc',
|
43
46
|
:'from' => :'from',
|
44
|
-
:'use_inbox_name' => :'useInboxName'
|
47
|
+
:'use_inbox_name' => :'useInboxName',
|
48
|
+
:'filter_bounced_recipients' => :'filterBouncedRecipients'
|
45
49
|
}
|
46
50
|
end
|
47
51
|
|
@@ -53,7 +57,8 @@ module MailSlurpClient
|
|
53
57
|
:'cc' => :'Array<String>',
|
54
58
|
:'bcc' => :'Array<String>',
|
55
59
|
:'from' => :'String',
|
56
|
-
:'use_inbox_name' => :'Boolean'
|
60
|
+
:'use_inbox_name' => :'Boolean',
|
61
|
+
:'filter_bounced_recipients' => :'Boolean'
|
57
62
|
}
|
58
63
|
end
|
59
64
|
|
@@ -64,7 +69,8 @@ module MailSlurpClient
|
|
64
69
|
:'cc',
|
65
70
|
:'bcc',
|
66
71
|
:'from',
|
67
|
-
:'use_inbox_name'
|
72
|
+
:'use_inbox_name',
|
73
|
+
:'filter_bounced_recipients'
|
68
74
|
])
|
69
75
|
end
|
70
76
|
|
@@ -112,6 +118,10 @@ module MailSlurpClient
|
|
112
118
|
if attributes.key?(:'use_inbox_name')
|
113
119
|
self.use_inbox_name = attributes[:'use_inbox_name']
|
114
120
|
end
|
121
|
+
|
122
|
+
if attributes.key?(:'filter_bounced_recipients')
|
123
|
+
self.filter_bounced_recipients = attributes[:'filter_bounced_recipients']
|
124
|
+
end
|
115
125
|
end
|
116
126
|
|
117
127
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -142,7 +152,8 @@ module MailSlurpClient
|
|
142
152
|
cc == o.cc &&
|
143
153
|
bcc == o.bcc &&
|
144
154
|
from == o.from &&
|
145
|
-
use_inbox_name == o.use_inbox_name
|
155
|
+
use_inbox_name == o.use_inbox_name &&
|
156
|
+
filter_bounced_recipients == o.filter_bounced_recipients
|
146
157
|
end
|
147
158
|
|
148
159
|
# @see the `==` method
|
@@ -154,7 +165,7 @@ module MailSlurpClient
|
|
154
165
|
# Calculates hash code according to all attributes.
|
155
166
|
# @return [Integer] Hash code
|
156
167
|
def hash
|
157
|
-
[to, subject, cc, bcc, from, use_inbox_name].hash
|
168
|
+
[to, subject, cc, bcc, from, use_inbox_name, filter_bounced_recipients].hash
|
158
169
|
end
|
159
170
|
|
160
171
|
# Builds the object from hash
|