mailslurp_client 16.2.5 → 17.0.0
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/inbox_controller_api.rb +15 -15
- data/lib/mailslurp_client/api/{inbox_ruleset_controller_api.rb → ruleset_controller_api.rb} +184 -175
- data/lib/mailslurp_client/api/tools_controller_api.rb +62 -0
- data/lib/mailslurp_client/api/webhook_controller_api.rb +82 -0
- data/lib/mailslurp_client/models/ai_transform_dto.rb +19 -5
- data/lib/mailslurp_client/models/alias_projection.rb +29 -29
- data/lib/mailslurp_client/models/alias_thread_projection.rb +26 -26
- data/lib/mailslurp_client/models/attachment_projection.rb +21 -21
- data/lib/mailslurp_client/models/connector_projection.rb +15 -15
- data/lib/mailslurp_client/models/{create_inbox_ruleset_options.rb → create_ruleset_options.rb} +5 -5
- data/lib/mailslurp_client/models/email.rb +13 -13
- data/lib/mailslurp_client/models/email_thread_projection.rb +23 -23
- data/lib/mailslurp_client/models/entity_automation_item_projection.rb +10 -10
- data/lib/mailslurp_client/models/guest_portal_user_projection.rb +24 -24
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +11 -11
- data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +11 -11
- data/lib/mailslurp_client/models/lookup_mx_records_options.rb +211 -0
- data/lib/mailslurp_client/models/lookup_mx_records_results.rb +245 -0
- data/lib/mailslurp_client/models/opt_in_identity_projection.rb +21 -21
- data/lib/mailslurp_client/models/page_ai_transform_mapping_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_ai_transform_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_ai_transform_result_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_alias.rb +10 -10
- data/lib/mailslurp_client/models/page_alias_thread_projection.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_connector.rb +10 -10
- data/lib/mailslurp_client/models/page_connector_events.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_thread_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_email_validation_request.rb +10 -10
- data/lib/mailslurp_client/models/page_entity_automation_items.rb +10 -10
- data/lib/mailslurp_client/models/page_entity_event_items.rb +10 -10
- data/lib/mailslurp_client/models/page_entity_favourite_items.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_guest_portal_users.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 +10 -10
- data/lib/mailslurp_client/models/page_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_replier_events.rb +10 -10
- data/lib/mailslurp_client/models/page_inbox_tags.rb +10 -10
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +10 -10
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_plus_address_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_reputation_items.rb +10 -10
- data/lib/mailslurp_client/models/{page_inbox_ruleset_dto.rb → page_ruleset_dto.rb} +15 -15
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +10 -10
- data/lib/mailslurp_client/models/page_sent_sms_projection.rb +10 -10
- 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_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_endpoint_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/pageable_object.rb +13 -13
- data/lib/mailslurp_client/models/phone_message_thread_projection.rb +27 -27
- data/lib/mailslurp_client/models/plus_address_projection.rb +24 -24
- data/lib/mailslurp_client/models/{inbox_ruleset_dto.rb → ruleset_dto.rb} +17 -7
- data/lib/mailslurp_client/models/{inbox_ruleset_test_options.rb → ruleset_test_options.rb} +3 -3
- data/lib/mailslurp_client/models/sent_email_projection.rb +45 -45
- data/lib/mailslurp_client/models/template_projection.rb +15 -15
- data/lib/mailslurp_client/models/test_inbox_ruleset_sending_options.rb +13 -7
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +11 -11
- data/lib/mailslurp_client/models/{test_inbox_ruleset_receiving_options.rb → test_ruleset_receiving_options.rb} +16 -10
- data/lib/mailslurp_client/models/{test_inbox_ruleset_receiving_result.rb → test_ruleset_receiving_result.rb} +3 -3
- data/lib/mailslurp_client/models/{test_inbox_ruleset_sending_result.rb → test_ruleset_sending_result.rb} +3 -3
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
- data/lib/mailslurp_client/models/webhook_projection.rb +39 -30
- data/lib/mailslurp_client/models/webhook_result_dto.rb +15 -5
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +10 -8
- metadata +12 -10
@@ -13,36 +13,38 @@ OpenAPI Generator version: 4.3.1
|
|
13
13
|
require 'cgi'
|
14
14
|
|
15
15
|
module MailSlurpClient
|
16
|
-
class
|
16
|
+
class RulesetControllerApi
|
17
17
|
attr_accessor :api_client
|
18
18
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Create
|
23
|
-
# Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
24
|
-
# @param
|
22
|
+
# Create a ruleset
|
23
|
+
# Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving
|
24
|
+
# @param create_ruleset_options [CreateRulesetOptions]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [String] :inbox_id Inbox id to attach ruleset to
|
27
|
-
# @
|
28
|
-
|
29
|
-
|
27
|
+
# @option opts [String] :phone_id Phone id to attach ruleset to
|
28
|
+
# @return [RulesetDto]
|
29
|
+
def create_new_ruleset(create_ruleset_options, opts = {})
|
30
|
+
data, _status_code, _headers = create_new_ruleset_with_http_info(create_ruleset_options, opts)
|
30
31
|
data
|
31
32
|
end
|
32
33
|
|
33
|
-
# Create
|
34
|
-
# Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
|
35
|
-
# @param
|
34
|
+
# Create a ruleset
|
35
|
+
# Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving
|
36
|
+
# @param create_ruleset_options [CreateRulesetOptions]
|
36
37
|
# @param [Hash] opts the optional parameters
|
37
38
|
# @option opts [String] :inbox_id Inbox id to attach ruleset to
|
38
|
-
# @
|
39
|
-
|
39
|
+
# @option opts [String] :phone_id Phone id to attach ruleset to
|
40
|
+
# @return [Array<(RulesetDto, Integer, Hash)>] RulesetDto data, response status code and response headers
|
41
|
+
def create_new_ruleset_with_http_info(create_ruleset_options, opts = {})
|
40
42
|
if @api_client.config.debugging
|
41
|
-
@api_client.config.logger.debug 'Calling API:
|
43
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.create_new_ruleset ...'
|
42
44
|
end
|
43
|
-
# verify the required parameter '
|
44
|
-
if @api_client.config.client_side_validation &&
|
45
|
-
fail ArgumentError, "Missing the required parameter '
|
45
|
+
# verify the required parameter 'create_ruleset_options' is set
|
46
|
+
if @api_client.config.client_side_validation && create_ruleset_options.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'create_ruleset_options' when calling RulesetControllerApi.create_new_ruleset"
|
46
48
|
end
|
47
49
|
# resource path
|
48
50
|
local_var_path = '/rulesets'
|
@@ -50,6 +52,7 @@ module MailSlurpClient
|
|
50
52
|
# query parameters
|
51
53
|
query_params = opts[:query_params] || {}
|
52
54
|
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
55
|
+
query_params[:'phoneId'] = opts[:'phone_id'] if !opts[:'phone_id'].nil?
|
53
56
|
|
54
57
|
# header parameters
|
55
58
|
header_params = opts[:header_params] || {}
|
@@ -62,10 +65,10 @@ module MailSlurpClient
|
|
62
65
|
form_params = opts[:form_params] || {}
|
63
66
|
|
64
67
|
# http body (model)
|
65
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
68
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_ruleset_options)
|
66
69
|
|
67
70
|
# return_type
|
68
|
-
return_type = opts[:return_type] || '
|
71
|
+
return_type = opts[:return_type] || 'RulesetDto'
|
69
72
|
|
70
73
|
# auth_names
|
71
74
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -81,33 +84,33 @@ module MailSlurpClient
|
|
81
84
|
|
82
85
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
83
86
|
if @api_client.config.debugging
|
84
|
-
@api_client.config.logger.debug "API called:
|
87
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#create_new_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
85
88
|
end
|
86
89
|
return data, status_code, headers
|
87
90
|
end
|
88
91
|
|
89
|
-
# Delete
|
90
|
-
# Delete
|
91
|
-
# @param id [String] ID of
|
92
|
+
# Delete a ruleset
|
93
|
+
# Delete ruleset
|
94
|
+
# @param id [String] ID of ruleset
|
92
95
|
# @param [Hash] opts the optional parameters
|
93
96
|
# @return [nil]
|
94
|
-
def
|
95
|
-
|
97
|
+
def delete_ruleset(id, opts = {})
|
98
|
+
delete_ruleset_with_http_info(id, opts)
|
96
99
|
nil
|
97
100
|
end
|
98
101
|
|
99
|
-
# Delete
|
100
|
-
# Delete
|
101
|
-
# @param id [String] ID of
|
102
|
+
# Delete a ruleset
|
103
|
+
# Delete ruleset
|
104
|
+
# @param id [String] ID of ruleset
|
102
105
|
# @param [Hash] opts the optional parameters
|
103
106
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
104
|
-
def
|
107
|
+
def delete_ruleset_with_http_info(id, opts = {})
|
105
108
|
if @api_client.config.debugging
|
106
|
-
@api_client.config.logger.debug 'Calling API:
|
109
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.delete_ruleset ...'
|
107
110
|
end
|
108
111
|
# verify the required parameter 'id' is set
|
109
112
|
if @api_client.config.client_side_validation && id.nil?
|
110
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling
|
113
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling RulesetControllerApi.delete_ruleset"
|
111
114
|
end
|
112
115
|
# resource path
|
113
116
|
local_var_path = '/rulesets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
@@ -141,29 +144,31 @@ module MailSlurpClient
|
|
141
144
|
|
142
145
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
143
146
|
if @api_client.config.debugging
|
144
|
-
@api_client.config.logger.debug "API called:
|
147
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#delete_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
145
148
|
end
|
146
149
|
return data, status_code, headers
|
147
150
|
end
|
148
151
|
|
149
|
-
# Delete
|
150
|
-
# Delete
|
152
|
+
# Delete rulesets
|
153
|
+
# Delete rulesets. Accepts optional inboxId or phoneId filters.
|
151
154
|
# @param [Hash] opts the optional parameters
|
152
155
|
# @option opts [String] :inbox_id Optional inbox id to attach ruleset to
|
156
|
+
# @option opts [String] :phone_id
|
153
157
|
# @return [nil]
|
154
|
-
def
|
155
|
-
|
158
|
+
def delete_rulesets(opts = {})
|
159
|
+
delete_rulesets_with_http_info(opts)
|
156
160
|
nil
|
157
161
|
end
|
158
162
|
|
159
|
-
# Delete
|
160
|
-
# Delete
|
163
|
+
# Delete rulesets
|
164
|
+
# Delete rulesets. Accepts optional inboxId or phoneId filters.
|
161
165
|
# @param [Hash] opts the optional parameters
|
162
166
|
# @option opts [String] :inbox_id Optional inbox id to attach ruleset to
|
167
|
+
# @option opts [String] :phone_id
|
163
168
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
164
|
-
def
|
169
|
+
def delete_rulesets_with_http_info(opts = {})
|
165
170
|
if @api_client.config.debugging
|
166
|
-
@api_client.config.logger.debug 'Calling API:
|
171
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.delete_rulesets ...'
|
167
172
|
end
|
168
173
|
# resource path
|
169
174
|
local_var_path = '/rulesets'
|
@@ -171,6 +176,7 @@ module MailSlurpClient
|
|
171
176
|
# query parameters
|
172
177
|
query_params = opts[:query_params] || {}
|
173
178
|
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
179
|
+
query_params[:'phoneId'] = opts[:'phone_id'] if !opts[:'phone_id'].nil?
|
174
180
|
|
175
181
|
# header parameters
|
176
182
|
header_params = opts[:header_params] || {}
|
@@ -198,33 +204,33 @@ module MailSlurpClient
|
|
198
204
|
|
199
205
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
200
206
|
if @api_client.config.debugging
|
201
|
-
@api_client.config.logger.debug "API called:
|
207
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#delete_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
202
208
|
end
|
203
209
|
return data, status_code, headers
|
204
210
|
end
|
205
211
|
|
206
|
-
# Get
|
207
|
-
# Get
|
208
|
-
# @param id [String] ID of
|
212
|
+
# Get a ruleset
|
213
|
+
# Get ruleset
|
214
|
+
# @param id [String] ID of ruleset
|
209
215
|
# @param [Hash] opts the optional parameters
|
210
|
-
# @return [
|
211
|
-
def
|
212
|
-
data, _status_code, _headers =
|
216
|
+
# @return [RulesetDto]
|
217
|
+
def get_ruleset(id, opts = {})
|
218
|
+
data, _status_code, _headers = get_ruleset_with_http_info(id, opts)
|
213
219
|
data
|
214
220
|
end
|
215
221
|
|
216
|
-
# Get
|
217
|
-
# Get
|
218
|
-
# @param id [String] ID of
|
222
|
+
# Get a ruleset
|
223
|
+
# Get ruleset
|
224
|
+
# @param id [String] ID of ruleset
|
219
225
|
# @param [Hash] opts the optional parameters
|
220
|
-
# @return [Array<(
|
221
|
-
def
|
226
|
+
# @return [Array<(RulesetDto, Integer, Hash)>] RulesetDto data, response status code and response headers
|
227
|
+
def get_ruleset_with_http_info(id, opts = {})
|
222
228
|
if @api_client.config.debugging
|
223
|
-
@api_client.config.logger.debug 'Calling API:
|
229
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.get_ruleset ...'
|
224
230
|
end
|
225
231
|
# verify the required parameter 'id' is set
|
226
232
|
if @api_client.config.client_side_validation && id.nil?
|
227
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling
|
233
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling RulesetControllerApi.get_ruleset"
|
228
234
|
end
|
229
235
|
# resource path
|
230
236
|
local_var_path = '/rulesets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
@@ -244,7 +250,7 @@ module MailSlurpClient
|
|
244
250
|
post_body = opts[:body]
|
245
251
|
|
246
252
|
# return_type
|
247
|
-
return_type = opts[:return_type] || '
|
253
|
+
return_type = opts[:return_type] || 'RulesetDto'
|
248
254
|
|
249
255
|
# auth_names
|
250
256
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -260,41 +266,43 @@ module MailSlurpClient
|
|
260
266
|
|
261
267
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
262
268
|
if @api_client.config.debugging
|
263
|
-
@api_client.config.logger.debug "API called:
|
269
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#get_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
264
270
|
end
|
265
271
|
return data, status_code, headers
|
266
272
|
end
|
267
273
|
|
268
|
-
# List
|
269
|
-
# List all rulesets attached to an inbox
|
274
|
+
# List rulesets block and allow lists
|
275
|
+
# List all rulesets attached to an inbox or phone or account
|
270
276
|
# @param [Hash] opts the optional parameters
|
271
277
|
# @option opts [String] :inbox_id Optional inbox id to get rulesets from
|
278
|
+
# @option opts [String] :phone_id Optional phone id to get rulesets from
|
272
279
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
|
273
280
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
|
274
281
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
275
282
|
# @option opts [String] :search_filter Optional search filter
|
276
283
|
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
277
284
|
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
278
|
-
# @return [
|
279
|
-
def
|
280
|
-
data, _status_code, _headers =
|
285
|
+
# @return [PageRulesetDto]
|
286
|
+
def get_rulesets(opts = {})
|
287
|
+
data, _status_code, _headers = get_rulesets_with_http_info(opts)
|
281
288
|
data
|
282
289
|
end
|
283
290
|
|
284
|
-
# List
|
285
|
-
# List all rulesets attached to an inbox
|
291
|
+
# List rulesets block and allow lists
|
292
|
+
# List all rulesets attached to an inbox or phone or account
|
286
293
|
# @param [Hash] opts the optional parameters
|
287
294
|
# @option opts [String] :inbox_id Optional inbox id to get rulesets from
|
295
|
+
# @option opts [String] :phone_id Optional phone id to get rulesets from
|
288
296
|
# @option opts [Integer] :page Optional page index in inbox ruleset list pagination
|
289
297
|
# @option opts [Integer] :size Optional page size in inbox ruleset list pagination
|
290
298
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
291
299
|
# @option opts [String] :search_filter Optional search filter
|
292
300
|
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
293
301
|
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
294
|
-
# @return [Array<(
|
295
|
-
def
|
302
|
+
# @return [Array<(PageRulesetDto, Integer, Hash)>] PageRulesetDto data, response status code and response headers
|
303
|
+
def get_rulesets_with_http_info(opts = {})
|
296
304
|
if @api_client.config.debugging
|
297
|
-
@api_client.config.logger.debug 'Calling API:
|
305
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.get_rulesets ...'
|
298
306
|
end
|
299
307
|
allowable_values = ["ASC", "DESC"]
|
300
308
|
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
@@ -306,6 +314,7 @@ module MailSlurpClient
|
|
306
314
|
# query parameters
|
307
315
|
query_params = opts[:query_params] || {}
|
308
316
|
query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
|
317
|
+
query_params[:'phoneId'] = opts[:'phone_id'] if !opts[:'phone_id'].nil?
|
309
318
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
310
319
|
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
311
320
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
@@ -325,7 +334,7 @@ module MailSlurpClient
|
|
325
334
|
post_body = opts[:body]
|
326
335
|
|
327
336
|
# return_type
|
328
|
-
return_type = opts[:return_type] || '
|
337
|
+
return_type = opts[:return_type] || 'PageRulesetDto'
|
329
338
|
|
330
339
|
# auth_names
|
331
340
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -341,45 +350,46 @@ module MailSlurpClient
|
|
341
350
|
|
342
351
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
343
352
|
if @api_client.config.debugging
|
344
|
-
@api_client.config.logger.debug "API called:
|
353
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#get_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
345
354
|
end
|
346
355
|
return data, status_code, headers
|
347
356
|
end
|
348
357
|
|
349
|
-
# Test
|
350
|
-
# Test
|
351
|
-
# @param
|
352
|
-
# @param
|
358
|
+
# Test inbox rulesets for inbox
|
359
|
+
# Test inbox rulesets for inbox
|
360
|
+
# @param inbox_id [String] ID of inbox
|
361
|
+
# @param ruleset_test_options [RulesetTestOptions]
|
353
362
|
# @param [Hash] opts the optional parameters
|
354
363
|
# @return [InboxRulesetTestResult]
|
355
|
-
def
|
356
|
-
data, _status_code, _headers =
|
364
|
+
def test_inbox_rulesets_for_inbox(inbox_id, ruleset_test_options, opts = {})
|
365
|
+
data, _status_code, _headers = test_inbox_rulesets_for_inbox_with_http_info(inbox_id, ruleset_test_options, opts)
|
357
366
|
data
|
358
367
|
end
|
359
368
|
|
360
|
-
# Test
|
361
|
-
# Test
|
362
|
-
# @param
|
363
|
-
# @param
|
369
|
+
# Test inbox rulesets for inbox
|
370
|
+
# Test inbox rulesets for inbox
|
371
|
+
# @param inbox_id [String] ID of inbox
|
372
|
+
# @param ruleset_test_options [RulesetTestOptions]
|
364
373
|
# @param [Hash] opts the optional parameters
|
365
374
|
# @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
|
366
|
-
def
|
375
|
+
def test_inbox_rulesets_for_inbox_with_http_info(inbox_id, ruleset_test_options, opts = {})
|
367
376
|
if @api_client.config.debugging
|
368
|
-
@api_client.config.logger.debug 'Calling API:
|
377
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.test_inbox_rulesets_for_inbox ...'
|
369
378
|
end
|
370
|
-
# verify the required parameter '
|
371
|
-
if @api_client.config.client_side_validation &&
|
372
|
-
fail ArgumentError, "Missing the required parameter '
|
379
|
+
# verify the required parameter 'inbox_id' is set
|
380
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
381
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling RulesetControllerApi.test_inbox_rulesets_for_inbox"
|
373
382
|
end
|
374
|
-
# verify the required parameter '
|
375
|
-
if @api_client.config.client_side_validation &&
|
376
|
-
fail ArgumentError, "Missing the required parameter '
|
383
|
+
# verify the required parameter 'ruleset_test_options' is set
|
384
|
+
if @api_client.config.client_side_validation && ruleset_test_options.nil?
|
385
|
+
fail ArgumentError, "Missing the required parameter 'ruleset_test_options' when calling RulesetControllerApi.test_inbox_rulesets_for_inbox"
|
377
386
|
end
|
378
387
|
# resource path
|
379
|
-
local_var_path = '/rulesets
|
388
|
+
local_var_path = '/rulesets'
|
380
389
|
|
381
390
|
# query parameters
|
382
391
|
query_params = opts[:query_params] || {}
|
392
|
+
query_params[:'inboxId'] = inbox_id
|
383
393
|
|
384
394
|
# header parameters
|
385
395
|
header_params = opts[:header_params] || {}
|
@@ -392,7 +402,7 @@ module MailSlurpClient
|
|
392
402
|
form_params = opts[:form_params] || {}
|
393
403
|
|
394
404
|
# http body (model)
|
395
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
405
|
+
post_body = opts[:body] || @api_client.object_to_http_body(ruleset_test_options)
|
396
406
|
|
397
407
|
# return_type
|
398
408
|
return_type = opts[:return_type] || 'InboxRulesetTestResult'
|
@@ -409,38 +419,38 @@ module MailSlurpClient
|
|
409
419
|
:return_type => return_type
|
410
420
|
)
|
411
421
|
|
412
|
-
data, status_code, headers = @api_client.call_api(:
|
422
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
413
423
|
if @api_client.config.debugging
|
414
|
-
@api_client.config.logger.debug "API called:
|
424
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#test_inbox_rulesets_for_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
415
425
|
end
|
416
426
|
return data, status_code, headers
|
417
427
|
end
|
418
428
|
|
419
|
-
# Test
|
420
|
-
# Test
|
421
|
-
# @param
|
429
|
+
# Test new ruleset
|
430
|
+
# Test new ruleset
|
431
|
+
# @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions]
|
422
432
|
# @param [Hash] opts the optional parameters
|
423
|
-
# @return [
|
424
|
-
def
|
425
|
-
data, _status_code, _headers =
|
433
|
+
# @return [InboxRulesetTestResult]
|
434
|
+
def test_new_ruleset(test_new_inbox_ruleset_options, opts = {})
|
435
|
+
data, _status_code, _headers = test_new_ruleset_with_http_info(test_new_inbox_ruleset_options, opts)
|
426
436
|
data
|
427
437
|
end
|
428
438
|
|
429
|
-
# Test
|
430
|
-
# Test
|
431
|
-
# @param
|
439
|
+
# Test new ruleset
|
440
|
+
# Test new ruleset
|
441
|
+
# @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions]
|
432
442
|
# @param [Hash] opts the optional parameters
|
433
|
-
# @return [Array<(
|
434
|
-
def
|
443
|
+
# @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
|
444
|
+
def test_new_ruleset_with_http_info(test_new_inbox_ruleset_options, opts = {})
|
435
445
|
if @api_client.config.debugging
|
436
|
-
@api_client.config.logger.debug 'Calling API:
|
446
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.test_new_ruleset ...'
|
437
447
|
end
|
438
|
-
# verify the required parameter '
|
439
|
-
if @api_client.config.client_side_validation &&
|
440
|
-
fail ArgumentError, "Missing the required parameter '
|
448
|
+
# verify the required parameter 'test_new_inbox_ruleset_options' is set
|
449
|
+
if @api_client.config.client_side_validation && test_new_inbox_ruleset_options.nil?
|
450
|
+
fail ArgumentError, "Missing the required parameter 'test_new_inbox_ruleset_options' when calling RulesetControllerApi.test_new_ruleset"
|
441
451
|
end
|
442
452
|
# resource path
|
443
|
-
local_var_path = '/rulesets
|
453
|
+
local_var_path = '/rulesets'
|
444
454
|
|
445
455
|
# query parameters
|
446
456
|
query_params = opts[:query_params] || {}
|
@@ -456,10 +466,10 @@ module MailSlurpClient
|
|
456
466
|
form_params = opts[:form_params] || {}
|
457
467
|
|
458
468
|
# http body (model)
|
459
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
469
|
+
post_body = opts[:body] || @api_client.object_to_http_body(test_new_inbox_ruleset_options)
|
460
470
|
|
461
471
|
# return_type
|
462
|
-
return_type = opts[:return_type] || '
|
472
|
+
return_type = opts[:return_type] || 'InboxRulesetTestResult'
|
463
473
|
|
464
474
|
# auth_names
|
465
475
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -473,38 +483,44 @@ module MailSlurpClient
|
|
473
483
|
:return_type => return_type
|
474
484
|
)
|
475
485
|
|
476
|
-
data, status_code, headers = @api_client.call_api(:
|
486
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
477
487
|
if @api_client.config.debugging
|
478
|
-
@api_client.config.logger.debug "API called:
|
488
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#test_new_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
479
489
|
end
|
480
490
|
return data, status_code, headers
|
481
491
|
end
|
482
492
|
|
483
|
-
# Test
|
484
|
-
# Test
|
485
|
-
# @param
|
493
|
+
# Test a ruleset
|
494
|
+
# Test an inbox or phone ruleset
|
495
|
+
# @param id [String] ID of ruleset
|
496
|
+
# @param ruleset_test_options [RulesetTestOptions]
|
486
497
|
# @param [Hash] opts the optional parameters
|
487
|
-
# @return [
|
488
|
-
def
|
489
|
-
data, _status_code, _headers =
|
498
|
+
# @return [InboxRulesetTestResult]
|
499
|
+
def test_ruleset(id, ruleset_test_options, opts = {})
|
500
|
+
data, _status_code, _headers = test_ruleset_with_http_info(id, ruleset_test_options, opts)
|
490
501
|
data
|
491
502
|
end
|
492
503
|
|
493
|
-
# Test
|
494
|
-
# Test
|
495
|
-
# @param
|
504
|
+
# Test a ruleset
|
505
|
+
# Test an inbox or phone ruleset
|
506
|
+
# @param id [String] ID of ruleset
|
507
|
+
# @param ruleset_test_options [RulesetTestOptions]
|
496
508
|
# @param [Hash] opts the optional parameters
|
497
|
-
# @return [Array<(
|
498
|
-
def
|
509
|
+
# @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
|
510
|
+
def test_ruleset_with_http_info(id, ruleset_test_options, opts = {})
|
499
511
|
if @api_client.config.debugging
|
500
|
-
@api_client.config.logger.debug 'Calling API:
|
512
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.test_ruleset ...'
|
501
513
|
end
|
502
|
-
# verify the required parameter '
|
503
|
-
if @api_client.config.client_side_validation &&
|
504
|
-
fail ArgumentError, "Missing the required parameter '
|
514
|
+
# verify the required parameter 'id' is set
|
515
|
+
if @api_client.config.client_side_validation && id.nil?
|
516
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling RulesetControllerApi.test_ruleset"
|
517
|
+
end
|
518
|
+
# verify the required parameter 'ruleset_test_options' is set
|
519
|
+
if @api_client.config.client_side_validation && ruleset_test_options.nil?
|
520
|
+
fail ArgumentError, "Missing the required parameter 'ruleset_test_options' when calling RulesetControllerApi.test_ruleset"
|
505
521
|
end
|
506
522
|
# resource path
|
507
|
-
local_var_path = '/rulesets/test
|
523
|
+
local_var_path = '/rulesets/{id}/test'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
508
524
|
|
509
525
|
# query parameters
|
510
526
|
query_params = opts[:query_params] || {}
|
@@ -520,10 +536,10 @@ module MailSlurpClient
|
|
520
536
|
form_params = opts[:form_params] || {}
|
521
537
|
|
522
538
|
# http body (model)
|
523
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
539
|
+
post_body = opts[:body] || @api_client.object_to_http_body(ruleset_test_options)
|
524
540
|
|
525
541
|
# return_type
|
526
|
-
return_type = opts[:return_type] || '
|
542
|
+
return_type = opts[:return_type] || 'InboxRulesetTestResult'
|
527
543
|
|
528
544
|
# auth_names
|
529
545
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -539,46 +555,39 @@ module MailSlurpClient
|
|
539
555
|
|
540
556
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
541
557
|
if @api_client.config.debugging
|
542
|
-
@api_client.config.logger.debug "API called:
|
558
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#test_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
543
559
|
end
|
544
560
|
return data, status_code, headers
|
545
561
|
end
|
546
562
|
|
547
|
-
# Test
|
548
|
-
# Test inbox rulesets
|
549
|
-
# @param
|
550
|
-
# @param inbox_ruleset_test_options [InboxRulesetTestOptions]
|
563
|
+
# Test receiving with rulesets
|
564
|
+
# Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS
|
565
|
+
# @param test_ruleset_receiving_options [TestRulesetReceivingOptions]
|
551
566
|
# @param [Hash] opts the optional parameters
|
552
|
-
# @return [
|
553
|
-
def
|
554
|
-
data, _status_code, _headers =
|
567
|
+
# @return [TestRulesetReceivingResult]
|
568
|
+
def test_ruleset_receiving(test_ruleset_receiving_options, opts = {})
|
569
|
+
data, _status_code, _headers = test_ruleset_receiving_with_http_info(test_ruleset_receiving_options, opts)
|
555
570
|
data
|
556
571
|
end
|
557
572
|
|
558
|
-
# Test
|
559
|
-
# Test inbox rulesets
|
560
|
-
# @param
|
561
|
-
# @param inbox_ruleset_test_options [InboxRulesetTestOptions]
|
573
|
+
# Test receiving with rulesets
|
574
|
+
# Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS
|
575
|
+
# @param test_ruleset_receiving_options [TestRulesetReceivingOptions]
|
562
576
|
# @param [Hash] opts the optional parameters
|
563
|
-
# @return [Array<(
|
564
|
-
def
|
577
|
+
# @return [Array<(TestRulesetReceivingResult, Integer, Hash)>] TestRulesetReceivingResult data, response status code and response headers
|
578
|
+
def test_ruleset_receiving_with_http_info(test_ruleset_receiving_options, opts = {})
|
565
579
|
if @api_client.config.debugging
|
566
|
-
@api_client.config.logger.debug 'Calling API:
|
580
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.test_ruleset_receiving ...'
|
567
581
|
end
|
568
|
-
# verify the required parameter '
|
569
|
-
if @api_client.config.client_side_validation &&
|
570
|
-
fail ArgumentError, "Missing the required parameter '
|
571
|
-
end
|
572
|
-
# verify the required parameter 'inbox_ruleset_test_options' is set
|
573
|
-
if @api_client.config.client_side_validation && inbox_ruleset_test_options.nil?
|
574
|
-
fail ArgumentError, "Missing the required parameter 'inbox_ruleset_test_options' when calling InboxRulesetControllerApi.test_inbox_rulesets_for_inbox"
|
582
|
+
# verify the required parameter 'test_ruleset_receiving_options' is set
|
583
|
+
if @api_client.config.client_side_validation && test_ruleset_receiving_options.nil?
|
584
|
+
fail ArgumentError, "Missing the required parameter 'test_ruleset_receiving_options' when calling RulesetControllerApi.test_ruleset_receiving"
|
575
585
|
end
|
576
586
|
# resource path
|
577
|
-
local_var_path = '/rulesets'
|
587
|
+
local_var_path = '/rulesets/test-receiving'
|
578
588
|
|
579
589
|
# query parameters
|
580
590
|
query_params = opts[:query_params] || {}
|
581
|
-
query_params[:'inboxId'] = inbox_id
|
582
591
|
|
583
592
|
# header parameters
|
584
593
|
header_params = opts[:header_params] || {}
|
@@ -591,10 +600,10 @@ module MailSlurpClient
|
|
591
600
|
form_params = opts[:form_params] || {}
|
592
601
|
|
593
602
|
# http body (model)
|
594
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
603
|
+
post_body = opts[:body] || @api_client.object_to_http_body(test_ruleset_receiving_options)
|
595
604
|
|
596
605
|
# return_type
|
597
|
-
return_type = opts[:return_type] || '
|
606
|
+
return_type = opts[:return_type] || 'TestRulesetReceivingResult'
|
598
607
|
|
599
608
|
# auth_names
|
600
609
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -608,38 +617,38 @@ module MailSlurpClient
|
|
608
617
|
:return_type => return_type
|
609
618
|
)
|
610
619
|
|
611
|
-
data, status_code, headers = @api_client.call_api(:
|
620
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
612
621
|
if @api_client.config.debugging
|
613
|
-
@api_client.config.logger.debug "API called:
|
622
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#test_ruleset_receiving\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
614
623
|
end
|
615
624
|
return data, status_code, headers
|
616
625
|
end
|
617
626
|
|
618
|
-
# Test
|
619
|
-
# Test
|
620
|
-
# @param
|
627
|
+
# Test sending with rulesets
|
628
|
+
# Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS
|
629
|
+
# @param test_inbox_ruleset_sending_options [TestInboxRulesetSendingOptions]
|
621
630
|
# @param [Hash] opts the optional parameters
|
622
|
-
# @return [
|
623
|
-
def
|
624
|
-
data, _status_code, _headers =
|
631
|
+
# @return [TestRulesetSendingResult]
|
632
|
+
def test_ruleset_sending(test_inbox_ruleset_sending_options, opts = {})
|
633
|
+
data, _status_code, _headers = test_ruleset_sending_with_http_info(test_inbox_ruleset_sending_options, opts)
|
625
634
|
data
|
626
635
|
end
|
627
636
|
|
628
|
-
# Test
|
629
|
-
# Test
|
630
|
-
# @param
|
637
|
+
# Test sending with rulesets
|
638
|
+
# Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS
|
639
|
+
# @param test_inbox_ruleset_sending_options [TestInboxRulesetSendingOptions]
|
631
640
|
# @param [Hash] opts the optional parameters
|
632
|
-
# @return [Array<(
|
633
|
-
def
|
641
|
+
# @return [Array<(TestRulesetSendingResult, Integer, Hash)>] TestRulesetSendingResult data, response status code and response headers
|
642
|
+
def test_ruleset_sending_with_http_info(test_inbox_ruleset_sending_options, opts = {})
|
634
643
|
if @api_client.config.debugging
|
635
|
-
@api_client.config.logger.debug 'Calling API:
|
644
|
+
@api_client.config.logger.debug 'Calling API: RulesetControllerApi.test_ruleset_sending ...'
|
636
645
|
end
|
637
|
-
# verify the required parameter '
|
638
|
-
if @api_client.config.client_side_validation &&
|
639
|
-
fail ArgumentError, "Missing the required parameter '
|
646
|
+
# verify the required parameter 'test_inbox_ruleset_sending_options' is set
|
647
|
+
if @api_client.config.client_side_validation && test_inbox_ruleset_sending_options.nil?
|
648
|
+
fail ArgumentError, "Missing the required parameter 'test_inbox_ruleset_sending_options' when calling RulesetControllerApi.test_ruleset_sending"
|
640
649
|
end
|
641
650
|
# resource path
|
642
|
-
local_var_path = '/rulesets'
|
651
|
+
local_var_path = '/rulesets/test-sending'
|
643
652
|
|
644
653
|
# query parameters
|
645
654
|
query_params = opts[:query_params] || {}
|
@@ -655,10 +664,10 @@ module MailSlurpClient
|
|
655
664
|
form_params = opts[:form_params] || {}
|
656
665
|
|
657
666
|
# http body (model)
|
658
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
667
|
+
post_body = opts[:body] || @api_client.object_to_http_body(test_inbox_ruleset_sending_options)
|
659
668
|
|
660
669
|
# return_type
|
661
|
-
return_type = opts[:return_type] || '
|
670
|
+
return_type = opts[:return_type] || 'TestRulesetSendingResult'
|
662
671
|
|
663
672
|
# auth_names
|
664
673
|
auth_names = opts[:auth_names] || ['API_KEY']
|
@@ -672,9 +681,9 @@ module MailSlurpClient
|
|
672
681
|
:return_type => return_type
|
673
682
|
)
|
674
683
|
|
675
|
-
data, status_code, headers = @api_client.call_api(:
|
684
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
676
685
|
if @api_client.config.debugging
|
677
|
-
@api_client.config.logger.debug "API called:
|
686
|
+
@api_client.config.logger.debug "API called: RulesetControllerApi#test_ruleset_sending\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
678
687
|
end
|
679
688
|
return data, status_code, headers
|
680
689
|
end
|