mailslurp_client 12.5.0 → 12.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (25) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client.rb +9 -2
  3. data/lib/mailslurp_client/api/contact_controller_api.rb +4 -4
  4. data/lib/mailslurp_client/api/email_controller_api.rb +64 -0
  5. data/lib/mailslurp_client/api/group_controller_api.rb +4 -4
  6. data/lib/mailslurp_client/api/inbox_controller_api.rb +11 -8
  7. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +211 -3
  8. data/lib/mailslurp_client/api/missed_email_controller_api.rb +81 -7
  9. data/lib/mailslurp_client/api/template_controller_api.rb +4 -4
  10. data/lib/mailslurp_client/api/tracking_controller_api.rb +215 -0
  11. data/lib/mailslurp_client/api/wait_for_controller_api.rb +2 -2
  12. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +4 -4
  13. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +215 -0
  14. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +17 -3
  15. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +211 -0
  16. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +223 -0
  17. data/lib/mailslurp_client/models/{page_inbox_ruleset_projection.rb → page_inbox_ruleset_dto.rb} +4 -4
  18. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +299 -0
  19. data/lib/mailslurp_client/models/send_email_options.rb +11 -1
  20. data/lib/mailslurp_client/models/sent_email_dto.rb +12 -1
  21. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +225 -0
  22. data/lib/mailslurp_client/models/{inbox_ruleset_projection.rb → tracking_pixel_dto.rb} +37 -115
  23. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +262 -0
  24. data/lib/mailslurp_client/version.rb +1 -1
  25. metadata +11 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1f4c251e8d9770dcc756b6ba7a0c71e767d13f060d9b33b9da598dde860c082c
4
- data.tar.gz: 3ba897df96fa42b4e9877fd4a6f74e5106254ebb66d60cc736f086b8e7bb5852
3
+ metadata.gz: 70db6bce103b2e7d4ae3eca78e63daa2427d3b3f29db4a8c68cc99d2e2c199a4
4
+ data.tar.gz: 9f3ece76f8fc73b995257bf490e07742f1b955fd4880242bcbd1a275ef01bacf
5
5
  SHA512:
6
- metadata.gz: 138024d869681d4363dbd60dc6228e6a684bafb453403fe3523808e19d767e96536fdad8cd7658b044c137225a659b9a19ce0770434da49a8e920593ddfacca7
7
- data.tar.gz: 4477af048095c3904d33a62f724b8dc4c94e6c7a4a8757e56d0585f6de12cd23e9c7750e9c6094732c493743069a3602dfdef8c7b96594fff70f5179b6eb7adf
6
+ metadata.gz: f9055da51031061aecc74efaa4ba90e84cfd1caae931fe467ec9c4c5cc7b902a248ac9ea2deea15983a6ee4d40eb104e35cee5e9ccb872a8c50803b50bb95308
7
+ data.tar.gz: e748394f21ccbb85dc20605367d2311dd00d5abc3508da54624b53e1945c345d1eea05551489084f3879163ebfdfd54b110d2afb38e4e78fb1f9a508091f972e
@@ -35,6 +35,7 @@ require 'mailslurp_client/models/create_group_options'
35
35
  require 'mailslurp_client/models/create_inbox_dto'
36
36
  require 'mailslurp_client/models/create_inbox_ruleset_options'
37
37
  require 'mailslurp_client/models/create_template_options'
38
+ require 'mailslurp_client/models/create_tracking_pixel_options'
38
39
  require 'mailslurp_client/models/create_webhook_options'
39
40
  require 'mailslurp_client/models/dns_lookup_options'
40
41
  require 'mailslurp_client/models/dns_lookup_result'
@@ -66,7 +67,8 @@ require 'mailslurp_client/models/ip_address_result'
66
67
  require 'mailslurp_client/models/inbox'
67
68
  require 'mailslurp_client/models/inbox_projection'
68
69
  require 'mailslurp_client/models/inbox_ruleset_dto'
69
- require 'mailslurp_client/models/inbox_ruleset_projection'
70
+ require 'mailslurp_client/models/inbox_ruleset_test_options'
71
+ require 'mailslurp_client/models/inbox_ruleset_test_result'
70
72
  require 'mailslurp_client/models/match_option'
71
73
  require 'mailslurp_client/models/match_options'
72
74
  require 'mailslurp_client/models/missed_email'
@@ -82,12 +84,13 @@ require 'mailslurp_client/models/page_email_projection'
82
84
  require 'mailslurp_client/models/page_expired_inbox_record_projection'
83
85
  require 'mailslurp_client/models/page_group_projection'
84
86
  require 'mailslurp_client/models/page_inbox_projection'
85
- require 'mailslurp_client/models/page_inbox_ruleset_projection'
87
+ require 'mailslurp_client/models/page_inbox_ruleset_dto'
86
88
  require 'mailslurp_client/models/page_missed_email_projection'
87
89
  require 'mailslurp_client/models/page_organization_inbox_projection'
88
90
  require 'mailslurp_client/models/page_sent_email_projection'
89
91
  require 'mailslurp_client/models/page_template_projection'
90
92
  require 'mailslurp_client/models/page_thread_projection'
93
+ require 'mailslurp_client/models/page_tracking_pixel_projection'
91
94
  require 'mailslurp_client/models/page_webhook_projection'
92
95
  require 'mailslurp_client/models/page_webhook_result'
93
96
  require 'mailslurp_client/models/pageable'
@@ -103,7 +106,10 @@ require 'mailslurp_client/models/sort'
103
106
  require 'mailslurp_client/models/template_dto'
104
107
  require 'mailslurp_client/models/template_projection'
105
108
  require 'mailslurp_client/models/template_variable'
109
+ require 'mailslurp_client/models/test_new_inbox_ruleset_options'
106
110
  require 'mailslurp_client/models/thread_projection'
111
+ require 'mailslurp_client/models/tracking_pixel_dto'
112
+ require 'mailslurp_client/models/tracking_pixel_projection'
107
113
  require 'mailslurp_client/models/unread_count'
108
114
  require 'mailslurp_client/models/update_alias_options'
109
115
  require 'mailslurp_client/models/update_domain_options'
@@ -142,6 +148,7 @@ require 'mailslurp_client/api/mail_server_controller_api'
142
148
  require 'mailslurp_client/api/missed_email_controller_api'
143
149
  require 'mailslurp_client/api/sent_emails_controller_api'
144
150
  require 'mailslurp_client/api/template_controller_api'
151
+ require 'mailslurp_client/api/tracking_controller_api'
145
152
  require 'mailslurp_client/api/wait_for_controller_api'
146
153
  require 'mailslurp_client/api/webhook_controller_api'
147
154
 
@@ -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 inbox list pagination (default to 0)
145
- # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
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 inbox list pagination
156
- # @option opts [Integer] :size Optional page size in inbox list pagination
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 = {})
@@ -1451,6 +1451,70 @@ module MailSlurpClient
1451
1451
  return data, status_code, headers
1452
1452
  end
1453
1453
 
1454
+ # Send email
1455
+ # 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.
1456
+ # @param [Hash] opts the optional parameters
1457
+ # @option opts [String] :inbox_id ID of the inbox you want to send the email from
1458
+ # @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
1459
+ # @option opts [SendEmailOptions] :send_email_options Options for the email
1460
+ # @return [nil]
1461
+ def send_email_source_optional(opts = {})
1462
+ send_email_source_optional_with_http_info(opts)
1463
+ nil
1464
+ end
1465
+
1466
+ # Send email
1467
+ # Alias for &#x60;InboxController.sendEmail&#x60; 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.
1468
+ # @param [Hash] opts the optional parameters
1469
+ # @option opts [String] :inbox_id ID of the inbox you want to send the email from
1470
+ # @option opts [Boolean] :use_domain_pool Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
1471
+ # @option opts [SendEmailOptions] :send_email_options Options for the email
1472
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1473
+ def send_email_source_optional_with_http_info(opts = {})
1474
+ if @api_client.config.debugging
1475
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.send_email_source_optional ...'
1476
+ end
1477
+ # resource path
1478
+ local_var_path = '/emails'
1479
+
1480
+ # query parameters
1481
+ query_params = opts[:query_params] || {}
1482
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
1483
+ query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
1484
+
1485
+ # header parameters
1486
+ header_params = opts[:header_params] || {}
1487
+ # HTTP header 'Content-Type'
1488
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1489
+
1490
+ # form parameters
1491
+ form_params = opts[:form_params] || {}
1492
+
1493
+ # http body (model)
1494
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'send_email_options'])
1495
+
1496
+ # return_type
1497
+ return_type = opts[:return_type]
1498
+
1499
+ # auth_names
1500
+ auth_names = opts[:auth_names] || ['API_KEY']
1501
+
1502
+ new_options = opts.merge(
1503
+ :header_params => header_params,
1504
+ :query_params => query_params,
1505
+ :form_params => form_params,
1506
+ :body => post_body,
1507
+ :auth_names => auth_names,
1508
+ :return_type => return_type
1509
+ )
1510
+
1511
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1512
+ if @api_client.config.debugging
1513
+ @api_client.config.logger.debug "API called: EmailControllerApi#send_email_source_optional\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1514
+ end
1515
+ return data, status_code, headers
1516
+ end
1517
+
1454
1518
  # Validate email HTML contents
1455
1519
  # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
1456
1520
  # @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 inbox list pagination (default to 0)
213
- # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
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 inbox list pagination
224
- # @option opts [Integer] :size Optional page size in inbox list pagination
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 = {})
@@ -413,9 +413,9 @@ module MailSlurpClient
413
413
  # 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
414
  # @param [Hash] opts the optional parameters
415
415
  # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
416
- # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
416
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
417
417
  # @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 inbox list pagination (default to 20)
418
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
419
419
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
420
420
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
421
421
  # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included (default to false)
@@ -429,9 +429,9 @@ module MailSlurpClient
429
429
  # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results. Results do not include team access inboxes by default. Use organization method to list team inboxes or set &#x60;teamAccess&#x60; to true.
430
430
  # @param [Hash] opts the optional parameters
431
431
  # @option opts [Boolean] :favourite Optionally filter results for favourites only
432
- # @option opts [Integer] :page Optional page index in inbox list pagination
432
+ # @option opts [Integer] :page Optional page index in list pagination
433
433
  # @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 inbox list pagination
434
+ # @option opts [Integer] :size Optional page size in list pagination
435
435
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
436
436
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
437
437
  # @option opts [Boolean] :team_access Optionally filter by team access. Defaults to false so organization inboxes are not included
@@ -914,9 +914,9 @@ module MailSlurpClient
914
914
  # List Organization Inboxes Paginated
915
915
  # 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
916
  # @param [Hash] opts the optional parameters
917
- # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
917
+ # @option opts [Integer] :page Optional page index in list pagination (default to 0)
918
918
  # @option opts [String] :search_filter Optional search filter
919
- # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
919
+ # @option opts [Integer] :size Optional page size in list pagination (default to 20)
920
920
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
921
921
  # @return [PageOrganizationInboxProjection]
922
922
  def get_organization_inboxes(opts = {})
@@ -927,9 +927,9 @@ module MailSlurpClient
927
927
  # List Organization Inboxes Paginated
928
928
  # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
929
929
  # @param [Hash] opts the optional parameters
930
- # @option opts [Integer] :page Optional page index in inbox list pagination
930
+ # @option opts [Integer] :page Optional page index in list pagination
931
931
  # @option opts [String] :search_filter Optional search filter
932
- # @option opts [Integer] :size Optional page size in inbox list pagination
932
+ # @option opts [Integer] :size Optional page size in list pagination
933
933
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
934
934
  # @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
935
935
  def get_organization_inboxes_with_http_info(opts = {})
@@ -988,6 +988,7 @@ module MailSlurpClient
988
988
  # @param inbox_id [String] inboxId
989
989
  # @param [Hash] opts the optional parameters
990
990
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
991
+ # @option opts [String] :search_filter Optional search filter
991
992
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
992
993
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
993
994
  # @return [nil]
@@ -1001,6 +1002,7 @@ module MailSlurpClient
1001
1002
  # @param inbox_id [String] inboxId
1002
1003
  # @param [Hash] opts the optional parameters
1003
1004
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
1005
+ # @option opts [String] :search_filter Optional search filter
1004
1006
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
1005
1007
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1006
1008
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -1022,6 +1024,7 @@ module MailSlurpClient
1022
1024
  # query parameters
1023
1025
  query_params = opts[:query_params] || {}
1024
1026
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1027
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1025
1028
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1026
1029
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1027
1030
 
@@ -270,9 +270,10 @@ module MailSlurpClient
270
270
  # @param [Hash] opts the optional parameters
271
271
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
272
272
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
273
+ # @option opts [String] :search_filter Optional search filter
273
274
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
274
275
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
275
- # @return [PageInboxRulesetProjection]
276
+ # @return [PageInboxRulesetDto]
276
277
  def get_inbox_rulesets(opts = {})
277
278
  data, _status_code, _headers = get_inbox_rulesets_with_http_info(opts)
278
279
  data
@@ -283,9 +284,10 @@ module MailSlurpClient
283
284
  # @param [Hash] opts the optional parameters
284
285
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
285
286
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
287
+ # @option opts [String] :search_filter Optional search filter
286
288
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
287
289
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
288
- # @return [Array<(PageInboxRulesetProjection, Integer, Hash)>] PageInboxRulesetProjection data, response status code and response headers
290
+ # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
289
291
  def get_inbox_rulesets_with_http_info(opts = {})
290
292
  if @api_client.config.debugging
291
293
  @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.get_inbox_rulesets ...'
@@ -301,6 +303,7 @@ module MailSlurpClient
301
303
  query_params = opts[:query_params] || {}
302
304
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
303
305
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
306
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
304
307
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
305
308
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
306
309
 
@@ -316,7 +319,7 @@ module MailSlurpClient
316
319
  post_body = opts[:body]
317
320
 
318
321
  # return_type
319
- return_type = opts[:return_type] || 'PageInboxRulesetProjection'
322
+ return_type = opts[:return_type] || 'PageInboxRulesetDto'
320
323
 
321
324
  # auth_names
322
325
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -336,5 +339,210 @@ module MailSlurpClient
336
339
  end
337
340
  return data, status_code, headers
338
341
  end
342
+
343
+ # Test an inbox ruleset
344
+ # Test an inbox ruleset
345
+ # @param id [String] ID of inbox ruleset
346
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
347
+ # @param [Hash] opts the optional parameters
348
+ # @return [InboxRulesetTestResult]
349
+ def test_inbox_ruleset(id, inbox_ruleset_test_options, opts = {})
350
+ data, _status_code, _headers = test_inbox_ruleset_with_http_info(id, inbox_ruleset_test_options, opts)
351
+ data
352
+ end
353
+
354
+ # Test an inbox ruleset
355
+ # Test an inbox ruleset
356
+ # @param id [String] ID of inbox ruleset
357
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
358
+ # @param [Hash] opts the optional parameters
359
+ # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
360
+ def test_inbox_ruleset_with_http_info(id, inbox_ruleset_test_options, opts = {})
361
+ if @api_client.config.debugging
362
+ @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_inbox_ruleset ...'
363
+ end
364
+ # verify the required parameter 'id' is set
365
+ if @api_client.config.client_side_validation && id.nil?
366
+ fail ArgumentError, "Missing the required parameter 'id' when calling InboxRulesetControllerApi.test_inbox_ruleset"
367
+ end
368
+ # verify the required parameter 'inbox_ruleset_test_options' is set
369
+ if @api_client.config.client_side_validation && inbox_ruleset_test_options.nil?
370
+ fail ArgumentError, "Missing the required parameter 'inbox_ruleset_test_options' when calling InboxRulesetControllerApi.test_inbox_ruleset"
371
+ end
372
+ # resource path
373
+ local_var_path = '/rulesets/{id}/test'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
374
+
375
+ # query parameters
376
+ query_params = opts[:query_params] || {}
377
+
378
+ # header parameters
379
+ header_params = opts[:header_params] || {}
380
+ # HTTP header 'Accept' (if needed)
381
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
382
+ # HTTP header 'Content-Type'
383
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
384
+
385
+ # form parameters
386
+ form_params = opts[:form_params] || {}
387
+
388
+ # http body (model)
389
+ post_body = opts[:body] || @api_client.object_to_http_body(inbox_ruleset_test_options)
390
+
391
+ # return_type
392
+ return_type = opts[:return_type] || 'InboxRulesetTestResult'
393
+
394
+ # auth_names
395
+ auth_names = opts[:auth_names] || ['API_KEY']
396
+
397
+ new_options = opts.merge(
398
+ :header_params => header_params,
399
+ :query_params => query_params,
400
+ :form_params => form_params,
401
+ :body => post_body,
402
+ :auth_names => auth_names,
403
+ :return_type => return_type
404
+ )
405
+
406
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
407
+ if @api_client.config.debugging
408
+ @api_client.config.logger.debug "API called: InboxRulesetControllerApi#test_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
+ end
410
+ return data, status_code, headers
411
+ end
412
+
413
+ # Test inbox rulesets for inbox
414
+ # Test inbox rulesets for inbox
415
+ # @param inbox_id [String] ID of inbox
416
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
417
+ # @param [Hash] opts the optional parameters
418
+ # @return [InboxRulesetTestResult]
419
+ def test_inbox_rulesets_for_inbox(inbox_id, inbox_ruleset_test_options, opts = {})
420
+ data, _status_code, _headers = test_inbox_rulesets_for_inbox_with_http_info(inbox_id, inbox_ruleset_test_options, opts)
421
+ data
422
+ end
423
+
424
+ # Test inbox rulesets for inbox
425
+ # Test inbox rulesets for inbox
426
+ # @param inbox_id [String] ID of inbox
427
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
428
+ # @param [Hash] opts the optional parameters
429
+ # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
430
+ def test_inbox_rulesets_for_inbox_with_http_info(inbox_id, inbox_ruleset_test_options, opts = {})
431
+ if @api_client.config.debugging
432
+ @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_inbox_rulesets_for_inbox ...'
433
+ end
434
+ # verify the required parameter 'inbox_id' is set
435
+ if @api_client.config.client_side_validation && inbox_id.nil?
436
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxRulesetControllerApi.test_inbox_rulesets_for_inbox"
437
+ end
438
+ # verify the required parameter 'inbox_ruleset_test_options' is set
439
+ if @api_client.config.client_side_validation && inbox_ruleset_test_options.nil?
440
+ fail ArgumentError, "Missing the required parameter 'inbox_ruleset_test_options' when calling InboxRulesetControllerApi.test_inbox_rulesets_for_inbox"
441
+ end
442
+ # resource path
443
+ local_var_path = '/rulesets'
444
+
445
+ # query parameters
446
+ query_params = opts[:query_params] || {}
447
+ query_params[:'inboxId'] = inbox_id
448
+
449
+ # header parameters
450
+ header_params = opts[:header_params] || {}
451
+ # HTTP header 'Accept' (if needed)
452
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
453
+ # HTTP header 'Content-Type'
454
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
455
+
456
+ # form parameters
457
+ form_params = opts[:form_params] || {}
458
+
459
+ # http body (model)
460
+ post_body = opts[:body] || @api_client.object_to_http_body(inbox_ruleset_test_options)
461
+
462
+ # return_type
463
+ return_type = opts[:return_type] || 'InboxRulesetTestResult'
464
+
465
+ # auth_names
466
+ auth_names = opts[:auth_names] || ['API_KEY']
467
+
468
+ new_options = opts.merge(
469
+ :header_params => header_params,
470
+ :query_params => query_params,
471
+ :form_params => form_params,
472
+ :body => post_body,
473
+ :auth_names => auth_names,
474
+ :return_type => return_type
475
+ )
476
+
477
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
478
+ if @api_client.config.debugging
479
+ @api_client.config.logger.debug "API called: InboxRulesetControllerApi#test_inbox_rulesets_for_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
480
+ end
481
+ return data, status_code, headers
482
+ end
483
+
484
+ # Test new inbox ruleset
485
+ # Test new inbox ruleset
486
+ # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
487
+ # @param [Hash] opts the optional parameters
488
+ # @return [InboxRulesetTestResult]
489
+ def test_new_inbox_ruleset(test_new_inbox_ruleset_options, opts = {})
490
+ data, _status_code, _headers = test_new_inbox_ruleset_with_http_info(test_new_inbox_ruleset_options, opts)
491
+ data
492
+ end
493
+
494
+ # Test new inbox ruleset
495
+ # Test new inbox ruleset
496
+ # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
497
+ # @param [Hash] opts the optional parameters
498
+ # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
499
+ def test_new_inbox_ruleset_with_http_info(test_new_inbox_ruleset_options, opts = {})
500
+ if @api_client.config.debugging
501
+ @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.test_new_inbox_ruleset ...'
502
+ end
503
+ # verify the required parameter 'test_new_inbox_ruleset_options' is set
504
+ if @api_client.config.client_side_validation && test_new_inbox_ruleset_options.nil?
505
+ fail ArgumentError, "Missing the required parameter 'test_new_inbox_ruleset_options' when calling InboxRulesetControllerApi.test_new_inbox_ruleset"
506
+ end
507
+ # resource path
508
+ local_var_path = '/rulesets'
509
+
510
+ # query parameters
511
+ query_params = opts[:query_params] || {}
512
+
513
+ # header parameters
514
+ header_params = opts[:header_params] || {}
515
+ # HTTP header 'Accept' (if needed)
516
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
517
+ # HTTP header 'Content-Type'
518
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
519
+
520
+ # form parameters
521
+ form_params = opts[:form_params] || {}
522
+
523
+ # http body (model)
524
+ post_body = opts[:body] || @api_client.object_to_http_body(test_new_inbox_ruleset_options)
525
+
526
+ # return_type
527
+ return_type = opts[:return_type] || 'InboxRulesetTestResult'
528
+
529
+ # auth_names
530
+ auth_names = opts[:auth_names] || ['API_KEY']
531
+
532
+ new_options = opts.merge(
533
+ :header_params => header_params,
534
+ :query_params => query_params,
535
+ :form_params => form_params,
536
+ :body => post_body,
537
+ :auth_names => auth_names,
538
+ :return_type => return_type
539
+ )
540
+
541
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
542
+ if @api_client.config.debugging
543
+ @api_client.config.logger.debug "API called: InboxRulesetControllerApi#test_new_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
544
+ end
545
+ return data, status_code, headers
546
+ end
339
547
  end
340
548
  end