mailslurp_client 15.0.3 → 15.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/lib/mailslurp_client/api/alias_controller_api.rb +59 -55
  4. data/lib/mailslurp_client/api/attachment_controller_api.rb +49 -60
  5. data/lib/mailslurp_client/api/bounce_controller_api.rb +26 -18
  6. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +15 -15
  7. data/lib/mailslurp_client/api/common_actions_controller_api.rb +128 -67
  8. data/lib/mailslurp_client/api/contact_controller_api.rb +22 -22
  9. data/lib/mailslurp_client/api/domain_controller_api.rb +32 -32
  10. data/lib/mailslurp_client/api/email_controller_api.rb +137 -117
  11. data/lib/mailslurp_client/api/expired_controller_api.rb +19 -19
  12. data/lib/mailslurp_client/api/export_controller_api.rb +38 -38
  13. data/lib/mailslurp_client/api/form_controller_api.rb +16 -18
  14. data/lib/mailslurp_client/api/group_controller_api.rb +52 -52
  15. data/lib/mailslurp_client/api/inbox_controller_api.rb +256 -236
  16. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +33 -29
  17. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +33 -29
  18. data/lib/mailslurp_client/api/mail_server_controller_api.rb +26 -26
  19. data/lib/mailslurp_client/api/missed_email_controller_api.rb +54 -42
  20. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +157 -47
  21. data/lib/mailslurp_client/api/template_controller_api.rb +21 -21
  22. data/lib/mailslurp_client/api/tracking_controller_api.rb +16 -16
  23. data/lib/mailslurp_client/api/wait_for_controller_api.rb +128 -88
  24. data/lib/mailslurp_client/api/webhook_controller_api.rb +102 -86
  25. data/lib/mailslurp_client/configuration.rb +4 -4
  26. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +10 -25
  27. data/lib/mailslurp_client/models/alias_dto.rb +45 -56
  28. data/lib/mailslurp_client/models/alias_projection.rb +42 -72
  29. data/lib/mailslurp_client/models/attachment_entity.rb +34 -54
  30. data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -21
  31. data/lib/mailslurp_client/models/attachment_projection.rb +36 -51
  32. data/lib/mailslurp_client/models/basic_auth_options.rb +0 -10
  33. data/lib/mailslurp_client/models/bounce_projection.rb +13 -23
  34. data/lib/mailslurp_client/models/bounce_recipient.rb +22 -42
  35. data/lib/mailslurp_client/models/bounced_email_dto.rb +56 -76
  36. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -31
  37. data/lib/mailslurp_client/models/bulk_send_email_options.rb +5 -0
  38. data/lib/mailslurp_client/models/condition_option.rb +2 -2
  39. data/lib/mailslurp_client/models/contact_dto.rb +53 -73
  40. data/lib/mailslurp_client/models/contact_projection.rb +42 -52
  41. data/lib/mailslurp_client/models/count_dto.rb +0 -5
  42. data/lib/mailslurp_client/models/create_contact_options.rb +42 -42
  43. data/lib/mailslurp_client/models/create_domain_options.rb +21 -16
  44. data/lib/mailslurp_client/models/create_group_options.rb +0 -5
  45. data/lib/mailslurp_client/models/create_inbox_dto.rb +58 -58
  46. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +19 -14
  47. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +23 -23
  48. data/lib/mailslurp_client/models/create_template_options.rb +0 -10
  49. data/lib/mailslurp_client/models/create_webhook_options.rb +18 -18
  50. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +15 -25
  51. data/lib/mailslurp_client/models/dns_lookup_options.rb +24 -14
  52. data/lib/mailslurp_client/models/dns_lookup_result.rb +23 -42
  53. data/lib/mailslurp_client/models/dns_lookup_results.rb +0 -5
  54. data/lib/mailslurp_client/models/domain_dto.rb +59 -80
  55. data/lib/mailslurp_client/models/domain_name_record.rb +11 -30
  56. data/lib/mailslurp_client/models/domain_preview.rb +26 -50
  57. data/lib/mailslurp_client/models/email.rb +134 -135
  58. data/lib/mailslurp_client/models/email_analysis.rb +28 -28
  59. data/lib/mailslurp_client/models/email_content_match_result.rb +13 -23
  60. data/lib/mailslurp_client/models/email_links_result.rb +13 -23
  61. data/lib/mailslurp_client/models/email_preview.rb +47 -47
  62. data/lib/mailslurp_client/models/email_projection.rb +77 -97
  63. data/lib/mailslurp_client/models/email_recipients.rb +16 -15
  64. data/lib/mailslurp_client/models/email_text_lines_result.rb +13 -23
  65. data/lib/mailslurp_client/models/email_verification_result.rb +16 -36
  66. data/lib/mailslurp_client/models/expiration_defaults.rb +16 -26
  67. data/lib/mailslurp_client/models/expired_inbox_dto.rb +13 -28
  68. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +22 -42
  69. data/lib/mailslurp_client/models/export_link.rb +0 -5
  70. data/lib/mailslurp_client/models/export_options.rb +1 -6
  71. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +13 -23
  72. data/lib/mailslurp_client/models/forward_email_options.rb +36 -31
  73. data/lib/mailslurp_client/models/gravatar_url.rb +13 -23
  74. data/lib/mailslurp_client/models/group_contacts_dto.rb +13 -23
  75. data/lib/mailslurp_client/models/group_dto.rb +22 -37
  76. data/lib/mailslurp_client/models/group_projection.rb +22 -37
  77. data/lib/mailslurp_client/models/html_validation_result.rb +13 -14
  78. data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +47 -57
  79. data/lib/mailslurp_client/models/inbox_exists_dto.rb +0 -5
  80. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -61
  81. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +0 -5
  82. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +13 -23
  83. data/lib/mailslurp_client/models/inbox_preview.rb +38 -38
  84. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +43 -78
  85. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +0 -5
  86. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +13 -18
  87. data/lib/mailslurp_client/models/inline_object.rb +221 -0
  88. data/lib/mailslurp_client/models/ip_address_result.rb +0 -10
  89. data/lib/mailslurp_client/models/json_schema_dto.rb +0 -5
  90. data/lib/mailslurp_client/models/match_option.rb +7 -2
  91. data/lib/mailslurp_client/models/match_options.rb +16 -16
  92. data/lib/mailslurp_client/models/missed_email.rb +67 -102
  93. data/lib/mailslurp_client/models/missed_email_projection.rb +19 -29
  94. data/lib/mailslurp_client/models/name_server_record.rb +10 -30
  95. data/lib/mailslurp_client/models/organization_inbox_projection.rb +44 -44
  96. data/lib/mailslurp_client/models/page_alias.rb +52 -52
  97. data/lib/mailslurp_client/models/page_attachment_entity.rb +52 -52
  98. data/lib/mailslurp_client/models/page_bounced_email.rb +52 -52
  99. data/lib/mailslurp_client/models/page_bounced_recipients.rb +52 -52
  100. data/lib/mailslurp_client/models/page_contact_projection.rb +52 -52
  101. data/lib/mailslurp_client/models/page_email_preview.rb +52 -52
  102. data/lib/mailslurp_client/models/page_email_projection.rb +52 -52
  103. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +52 -52
  104. data/lib/mailslurp_client/models/page_group_projection.rb +52 -52
  105. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +52 -52
  106. data/lib/mailslurp_client/models/page_inbox_projection.rb +52 -52
  107. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +52 -52
  108. data/lib/mailslurp_client/models/page_missed_email_projection.rb +52 -52
  109. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +52 -52
  110. data/lib/mailslurp_client/models/page_sent_email_projection.rb +49 -49
  111. data/lib/mailslurp_client/models/page_template_projection.rb +52 -52
  112. data/lib/mailslurp_client/models/page_thread_projection.rb +52 -52
  113. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +52 -52
  114. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +52 -52
  115. data/lib/mailslurp_client/models/page_webhook_projection.rb +52 -52
  116. data/lib/mailslurp_client/models/page_webhook_result.rb +52 -52
  117. data/lib/mailslurp_client/models/pageable.rb +10 -10
  118. data/lib/mailslurp_client/models/raw_email_json.rb +0 -5
  119. data/lib/mailslurp_client/models/recipient.rb +13 -23
  120. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +38 -37
  121. data/lib/mailslurp_client/models/reply_to_email_options.rb +51 -50
  122. data/lib/mailslurp_client/models/send_email_options.rb +107 -115
  123. data/lib/mailslurp_client/models/sender.rb +14 -23
  124. data/lib/mailslurp_client/models/sent_email_dto.rb +97 -102
  125. data/lib/mailslurp_client/models/sent_email_projection.rb +66 -105
  126. data/lib/mailslurp_client/models/simple_send_email_options.rb +24 -24
  127. data/lib/mailslurp_client/models/template_dto.rb +22 -47
  128. data/lib/mailslurp_client/models/template_projection.rb +16 -41
  129. data/lib/mailslurp_client/models/template_variable.rb +0 -10
  130. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +0 -10
  131. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +0 -10
  132. data/lib/mailslurp_client/models/thread_projection.rb +60 -95
  133. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +43 -68
  134. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +34 -54
  135. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +19 -29
  136. data/lib/mailslurp_client/models/unread_count.rb +0 -5
  137. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +0 -5
  138. data/lib/mailslurp_client/models/update_group_contacts.rb +0 -5
  139. data/lib/mailslurp_client/models/update_inbox_options.rb +26 -26
  140. data/lib/mailslurp_client/models/upload_attachment_options.rb +14 -14
  141. data/lib/mailslurp_client/models/validation_message.rb +1 -5
  142. data/lib/mailslurp_client/models/verify_email_address_options.rb +0 -5
  143. data/lib/mailslurp_client/models/wait_for_conditions.rb +48 -58
  144. data/lib/mailslurp_client/models/webhook_dto.rb +64 -69
  145. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +42 -42
  146. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +49 -49
  147. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +43 -43
  148. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +75 -95
  149. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +84 -84
  150. data/lib/mailslurp_client/models/webhook_projection.rb +36 -61
  151. data/lib/mailslurp_client/models/webhook_redrive_result.rb +13 -23
  152. data/lib/mailslurp_client/models/webhook_result_dto.rb +76 -126
  153. data/lib/mailslurp_client/models/webhook_test_request.rb +21 -36
  154. data/lib/mailslurp_client/models/webhook_test_response.rb +13 -13
  155. data/lib/mailslurp_client/models/webhook_test_result.rb +13 -23
  156. data/lib/mailslurp_client/version.rb +1 -1
  157. data/lib/mailslurp_client.rb +2 -1
  158. metadata +4 -3
@@ -21,25 +21,29 @@ module MailSlurpClient
21
21
  end
22
22
  # Create an inbox forwarder
23
23
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
24
- # @param create_inbox_forwarder_options [CreateInboxForwarderOptions] createInboxForwarderOptions
24
+ # @param inbox_id [String] Inbox id to attach forwarder to
25
+ # @param create_inbox_forwarder_options [CreateInboxForwarderOptions]
25
26
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :inbox_id Inbox id to attach forwarder to
27
27
  # @return [InboxForwarderDto]
28
- def create_new_inbox_forwarder(create_inbox_forwarder_options, opts = {})
29
- data, _status_code, _headers = create_new_inbox_forwarder_with_http_info(create_inbox_forwarder_options, opts)
28
+ def create_new_inbox_forwarder(inbox_id, create_inbox_forwarder_options, opts = {})
29
+ data, _status_code, _headers = create_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, opts)
30
30
  data
31
31
  end
32
32
 
33
33
  # Create an inbox forwarder
34
34
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
35
- # @param create_inbox_forwarder_options [CreateInboxForwarderOptions] createInboxForwarderOptions
35
+ # @param inbox_id [String] Inbox id to attach forwarder to
36
+ # @param create_inbox_forwarder_options [CreateInboxForwarderOptions]
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [String] :inbox_id Inbox id to attach forwarder to
38
38
  # @return [Array<(InboxForwarderDto, Integer, Hash)>] InboxForwarderDto data, response status code and response headers
39
- def create_new_inbox_forwarder_with_http_info(create_inbox_forwarder_options, opts = {})
39
+ def create_new_inbox_forwarder_with_http_info(inbox_id, create_inbox_forwarder_options, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: InboxForwarderControllerApi.create_new_inbox_forwarder ...'
42
42
  end
43
+ # verify the required parameter 'inbox_id' is set
44
+ if @api_client.config.client_side_validation && inbox_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxForwarderControllerApi.create_new_inbox_forwarder"
46
+ end
43
47
  # verify the required parameter 'create_inbox_forwarder_options' is set
44
48
  if @api_client.config.client_side_validation && create_inbox_forwarder_options.nil?
45
49
  fail ArgumentError, "Missing the required parameter 'create_inbox_forwarder_options' when calling InboxForwarderControllerApi.create_new_inbox_forwarder"
@@ -49,12 +53,12 @@ module MailSlurpClient
49
53
 
50
54
  # query parameters
51
55
  query_params = opts[:query_params] || {}
52
- query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
56
+ query_params[:'inboxId'] = inbox_id
53
57
 
54
58
  # header parameters
55
59
  header_params = opts[:header_params] || {}
56
60
  # HTTP header 'Accept' (if needed)
57
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
58
62
  # HTTP header 'Content-Type'
59
63
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
60
64
 
@@ -235,7 +239,7 @@ module MailSlurpClient
235
239
  # header parameters
236
240
  header_params = opts[:header_params] || {}
237
241
  # HTTP header 'Accept' (if needed)
238
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
239
243
 
240
244
  # form parameters
241
245
  form_params = opts[:form_params] || {}
@@ -268,13 +272,13 @@ module MailSlurpClient
268
272
  # List inbox forwarders
269
273
  # List all forwarders attached to an inbox
270
274
  # @param [Hash] opts the optional parameters
271
- # @option opts [DateTime] :before Filter by created at before the given timestamp
272
275
  # @option opts [String] :inbox_id Optional inbox id to get forwarders from
273
276
  # @option opts [Integer] :page Optional page index in inbox forwarder list pagination (default to 0)
274
- # @option opts [String] :search_filter Optional search filter
275
- # @option opts [DateTime] :since Filter by created at after the given timestamp
276
277
  # @option opts [Integer] :size Optional page size in inbox forwarder list pagination (default to 20)
277
278
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
279
+ # @option opts [String] :search_filter Optional search filter
280
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
281
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
278
282
  # @return [PageInboxForwarderDto]
279
283
  def get_inbox_forwarders(opts = {})
280
284
  data, _status_code, _headers = get_inbox_forwarders_with_http_info(opts)
@@ -284,13 +288,13 @@ module MailSlurpClient
284
288
  # List inbox forwarders
285
289
  # List all forwarders attached to an inbox
286
290
  # @param [Hash] opts the optional parameters
287
- # @option opts [DateTime] :before Filter by created at before the given timestamp
288
291
  # @option opts [String] :inbox_id Optional inbox id to get forwarders from
289
292
  # @option opts [Integer] :page Optional page index in inbox forwarder list pagination
290
- # @option opts [String] :search_filter Optional search filter
291
- # @option opts [DateTime] :since Filter by created at after the given timestamp
292
293
  # @option opts [Integer] :size Optional page size in inbox forwarder list pagination
293
294
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
295
+ # @option opts [String] :search_filter Optional search filter
296
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
297
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
294
298
  # @return [Array<(PageInboxForwarderDto, Integer, Hash)>] PageInboxForwarderDto data, response status code and response headers
295
299
  def get_inbox_forwarders_with_http_info(opts = {})
296
300
  if @api_client.config.debugging
@@ -305,18 +309,18 @@ module MailSlurpClient
305
309
 
306
310
  # query parameters
307
311
  query_params = opts[:query_params] || {}
308
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
309
312
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
310
313
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
311
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
312
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
313
314
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
314
315
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
316
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
317
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
318
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
315
319
 
316
320
  # header parameters
317
321
  header_params = opts[:header_params] || {}
318
322
  # HTTP header 'Accept' (if needed)
319
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
323
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
320
324
 
321
325
  # form parameters
322
326
  form_params = opts[:form_params] || {}
@@ -349,7 +353,7 @@ module MailSlurpClient
349
353
  # Test an inbox forwarder
350
354
  # Test an inbox forwarder
351
355
  # @param id [String] ID of inbox forwarder
352
- # @param inbox_forwarder_test_options [InboxForwarderTestOptions] inboxForwarderTestOptions
356
+ # @param inbox_forwarder_test_options [InboxForwarderTestOptions]
353
357
  # @param [Hash] opts the optional parameters
354
358
  # @return [InboxForwarderTestResult]
355
359
  def test_inbox_forwarder(id, inbox_forwarder_test_options, opts = {})
@@ -360,7 +364,7 @@ module MailSlurpClient
360
364
  # Test an inbox forwarder
361
365
  # Test an inbox forwarder
362
366
  # @param id [String] ID of inbox forwarder
363
- # @param inbox_forwarder_test_options [InboxForwarderTestOptions] inboxForwarderTestOptions
367
+ # @param inbox_forwarder_test_options [InboxForwarderTestOptions]
364
368
  # @param [Hash] opts the optional parameters
365
369
  # @return [Array<(InboxForwarderTestResult, Integer, Hash)>] InboxForwarderTestResult data, response status code and response headers
366
370
  def test_inbox_forwarder_with_http_info(id, inbox_forwarder_test_options, opts = {})
@@ -384,7 +388,7 @@ module MailSlurpClient
384
388
  # header parameters
385
389
  header_params = opts[:header_params] || {}
386
390
  # HTTP header 'Accept' (if needed)
387
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
391
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
388
392
  # HTTP header 'Content-Type'
389
393
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
390
394
 
@@ -419,7 +423,7 @@ module MailSlurpClient
419
423
  # Test inbox forwarders for inbox
420
424
  # Test inbox forwarders for inbox
421
425
  # @param inbox_id [String] ID of inbox
422
- # @param inbox_forwarder_test_options [InboxForwarderTestOptions] inboxForwarderTestOptions
426
+ # @param inbox_forwarder_test_options [InboxForwarderTestOptions]
423
427
  # @param [Hash] opts the optional parameters
424
428
  # @return [InboxForwarderTestResult]
425
429
  def test_inbox_forwarders_for_inbox(inbox_id, inbox_forwarder_test_options, opts = {})
@@ -430,7 +434,7 @@ module MailSlurpClient
430
434
  # Test inbox forwarders for inbox
431
435
  # Test inbox forwarders for inbox
432
436
  # @param inbox_id [String] ID of inbox
433
- # @param inbox_forwarder_test_options [InboxForwarderTestOptions] inboxForwarderTestOptions
437
+ # @param inbox_forwarder_test_options [InboxForwarderTestOptions]
434
438
  # @param [Hash] opts the optional parameters
435
439
  # @return [Array<(InboxForwarderTestResult, Integer, Hash)>] InboxForwarderTestResult data, response status code and response headers
436
440
  def test_inbox_forwarders_for_inbox_with_http_info(inbox_id, inbox_forwarder_test_options, opts = {})
@@ -455,7 +459,7 @@ module MailSlurpClient
455
459
  # header parameters
456
460
  header_params = opts[:header_params] || {}
457
461
  # HTTP header 'Accept' (if needed)
458
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
462
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
459
463
  # HTTP header 'Content-Type'
460
464
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
461
465
 
@@ -489,7 +493,7 @@ module MailSlurpClient
489
493
 
490
494
  # Test new inbox forwarder
491
495
  # Test new inbox forwarder
492
- # @param test_new_inbox_forwarder_options [TestNewInboxForwarderOptions] testNewInboxForwarderOptions
496
+ # @param test_new_inbox_forwarder_options [TestNewInboxForwarderOptions]
493
497
  # @param [Hash] opts the optional parameters
494
498
  # @return [InboxForwarderTestResult]
495
499
  def test_new_inbox_forwarder(test_new_inbox_forwarder_options, opts = {})
@@ -499,7 +503,7 @@ module MailSlurpClient
499
503
 
500
504
  # Test new inbox forwarder
501
505
  # Test new inbox forwarder
502
- # @param test_new_inbox_forwarder_options [TestNewInboxForwarderOptions] testNewInboxForwarderOptions
506
+ # @param test_new_inbox_forwarder_options [TestNewInboxForwarderOptions]
503
507
  # @param [Hash] opts the optional parameters
504
508
  # @return [Array<(InboxForwarderTestResult, Integer, Hash)>] InboxForwarderTestResult data, response status code and response headers
505
509
  def test_new_inbox_forwarder_with_http_info(test_new_inbox_forwarder_options, opts = {})
@@ -519,7 +523,7 @@ module MailSlurpClient
519
523
  # header parameters
520
524
  header_params = opts[:header_params] || {}
521
525
  # HTTP header 'Accept' (if needed)
522
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
526
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
523
527
  # HTTP header 'Content-Type'
524
528
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
525
529
 
@@ -21,25 +21,29 @@ module MailSlurpClient
21
21
  end
22
22
  # Create an inbox ruleset
23
23
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
24
- # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
24
+ # @param inbox_id [String] Inbox id to attach ruleset to
25
+ # @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
25
26
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :inbox_id Inbox id to attach ruleset to
27
27
  # @return [InboxRulesetDto]
28
- def create_new_inbox_ruleset(create_inbox_ruleset_options, opts = {})
29
- data, _status_code, _headers = create_new_inbox_ruleset_with_http_info(create_inbox_ruleset_options, opts)
28
+ def create_new_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {})
29
+ data, _status_code, _headers = create_new_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts)
30
30
  data
31
31
  end
32
32
 
33
33
  # Create an inbox ruleset
34
34
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
35
- # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
35
+ # @param inbox_id [String] Inbox id to attach ruleset to
36
+ # @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [String] :inbox_id Inbox id to attach ruleset to
38
38
  # @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
39
- def create_new_inbox_ruleset_with_http_info(create_inbox_ruleset_options, opts = {})
39
+ def create_new_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: InboxRulesetControllerApi.create_new_inbox_ruleset ...'
42
42
  end
43
+ # verify the required parameter 'inbox_id' is set
44
+ if @api_client.config.client_side_validation && inbox_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxRulesetControllerApi.create_new_inbox_ruleset"
46
+ end
43
47
  # verify the required parameter 'create_inbox_ruleset_options' is set
44
48
  if @api_client.config.client_side_validation && create_inbox_ruleset_options.nil?
45
49
  fail ArgumentError, "Missing the required parameter 'create_inbox_ruleset_options' when calling InboxRulesetControllerApi.create_new_inbox_ruleset"
@@ -49,12 +53,12 @@ module MailSlurpClient
49
53
 
50
54
  # query parameters
51
55
  query_params = opts[:query_params] || {}
52
- query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
56
+ query_params[:'inboxId'] = inbox_id
53
57
 
54
58
  # header parameters
55
59
  header_params = opts[:header_params] || {}
56
60
  # HTTP header 'Accept' (if needed)
57
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
58
62
  # HTTP header 'Content-Type'
59
63
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
60
64
 
@@ -235,7 +239,7 @@ module MailSlurpClient
235
239
  # header parameters
236
240
  header_params = opts[:header_params] || {}
237
241
  # HTTP header 'Accept' (if needed)
238
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
239
243
 
240
244
  # form parameters
241
245
  form_params = opts[:form_params] || {}
@@ -268,13 +272,13 @@ module MailSlurpClient
268
272
  # List inbox rulesets
269
273
  # List all rulesets attached to an inbox
270
274
  # @param [Hash] opts the optional parameters
271
- # @option opts [DateTime] :before Filter by created at before the given timestamp
272
275
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
273
276
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
274
- # @option opts [String] :search_filter Optional search filter
275
- # @option opts [DateTime] :since Filter by created at after the given timestamp
276
277
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
277
278
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
279
+ # @option opts [String] :search_filter Optional search filter
280
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
281
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
278
282
  # @return [PageInboxRulesetDto]
279
283
  def get_inbox_rulesets(opts = {})
280
284
  data, _status_code, _headers = get_inbox_rulesets_with_http_info(opts)
@@ -284,13 +288,13 @@ module MailSlurpClient
284
288
  # List inbox rulesets
285
289
  # List all rulesets attached to an inbox
286
290
  # @param [Hash] opts the optional parameters
287
- # @option opts [DateTime] :before Filter by created at before the given timestamp
288
291
  # @option opts [String] :inbox_id Optional inbox id to get rulesets from
289
292
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
290
- # @option opts [String] :search_filter Optional search filter
291
- # @option opts [DateTime] :since Filter by created at after the given timestamp
292
293
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
293
294
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
295
+ # @option opts [String] :search_filter Optional search filter
296
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
297
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
294
298
  # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
295
299
  def get_inbox_rulesets_with_http_info(opts = {})
296
300
  if @api_client.config.debugging
@@ -305,18 +309,18 @@ module MailSlurpClient
305
309
 
306
310
  # query parameters
307
311
  query_params = opts[:query_params] || {}
308
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
309
312
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
310
313
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
311
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
312
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
313
314
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
314
315
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
316
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
317
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
318
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
315
319
 
316
320
  # header parameters
317
321
  header_params = opts[:header_params] || {}
318
322
  # HTTP header 'Accept' (if needed)
319
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
323
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
320
324
 
321
325
  # form parameters
322
326
  form_params = opts[:form_params] || {}
@@ -349,7 +353,7 @@ module MailSlurpClient
349
353
  # Test an inbox ruleset
350
354
  # Test an inbox ruleset
351
355
  # @param id [String] ID of inbox ruleset
352
- # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
356
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions]
353
357
  # @param [Hash] opts the optional parameters
354
358
  # @return [InboxRulesetTestResult]
355
359
  def test_inbox_ruleset(id, inbox_ruleset_test_options, opts = {})
@@ -360,7 +364,7 @@ module MailSlurpClient
360
364
  # Test an inbox ruleset
361
365
  # Test an inbox ruleset
362
366
  # @param id [String] ID of inbox ruleset
363
- # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
367
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions]
364
368
  # @param [Hash] opts the optional parameters
365
369
  # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
366
370
  def test_inbox_ruleset_with_http_info(id, inbox_ruleset_test_options, opts = {})
@@ -384,7 +388,7 @@ module MailSlurpClient
384
388
  # header parameters
385
389
  header_params = opts[:header_params] || {}
386
390
  # HTTP header 'Accept' (if needed)
387
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
391
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
388
392
  # HTTP header 'Content-Type'
389
393
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
390
394
 
@@ -419,7 +423,7 @@ module MailSlurpClient
419
423
  # Test inbox rulesets for inbox
420
424
  # Test inbox rulesets for inbox
421
425
  # @param inbox_id [String] ID of inbox
422
- # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
426
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions]
423
427
  # @param [Hash] opts the optional parameters
424
428
  # @return [InboxRulesetTestResult]
425
429
  def test_inbox_rulesets_for_inbox(inbox_id, inbox_ruleset_test_options, opts = {})
@@ -430,7 +434,7 @@ module MailSlurpClient
430
434
  # Test inbox rulesets for inbox
431
435
  # Test inbox rulesets for inbox
432
436
  # @param inbox_id [String] ID of inbox
433
- # @param inbox_ruleset_test_options [InboxRulesetTestOptions] inboxRulesetTestOptions
437
+ # @param inbox_ruleset_test_options [InboxRulesetTestOptions]
434
438
  # @param [Hash] opts the optional parameters
435
439
  # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
436
440
  def test_inbox_rulesets_for_inbox_with_http_info(inbox_id, inbox_ruleset_test_options, opts = {})
@@ -455,7 +459,7 @@ module MailSlurpClient
455
459
  # header parameters
456
460
  header_params = opts[:header_params] || {}
457
461
  # HTTP header 'Accept' (if needed)
458
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
462
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
459
463
  # HTTP header 'Content-Type'
460
464
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
461
465
 
@@ -489,7 +493,7 @@ module MailSlurpClient
489
493
 
490
494
  # Test new inbox ruleset
491
495
  # Test new inbox ruleset
492
- # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
496
+ # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions]
493
497
  # @param [Hash] opts the optional parameters
494
498
  # @return [InboxRulesetTestResult]
495
499
  def test_new_inbox_ruleset(test_new_inbox_ruleset_options, opts = {})
@@ -499,7 +503,7 @@ module MailSlurpClient
499
503
 
500
504
  # Test new inbox ruleset
501
505
  # Test new inbox ruleset
502
- # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions] testNewInboxRulesetOptions
506
+ # @param test_new_inbox_ruleset_options [TestNewInboxRulesetOptions]
503
507
  # @param [Hash] opts the optional parameters
504
508
  # @return [Array<(InboxRulesetTestResult, Integer, Hash)>] InboxRulesetTestResult data, response status code and response headers
505
509
  def test_new_inbox_ruleset_with_http_info(test_new_inbox_ruleset_options, opts = {})
@@ -519,7 +523,7 @@ module MailSlurpClient
519
523
  # header parameters
520
524
  header_params = opts[:header_params] || {}
521
525
  # HTTP header 'Accept' (if needed)
522
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
526
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
523
527
  # HTTP header 'Content-Type'
524
528
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
525
529
 
@@ -20,25 +20,25 @@ module MailSlurpClient
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get DNS Mail Server records for a domain
23
- # @param describe_options [DescribeDomainOptions] describeOptions
23
+ # @param describe_domain_options [DescribeDomainOptions]
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [DescribeMailServerDomainResult]
26
- def describe_mail_server_domain(describe_options, opts = {})
27
- data, _status_code, _headers = describe_mail_server_domain_with_http_info(describe_options, opts)
26
+ def describe_mail_server_domain(describe_domain_options, opts = {})
27
+ data, _status_code, _headers = describe_mail_server_domain_with_http_info(describe_domain_options, opts)
28
28
  data
29
29
  end
30
30
 
31
31
  # Get DNS Mail Server records for a domain
32
- # @param describe_options [DescribeDomainOptions] describeOptions
32
+ # @param describe_domain_options [DescribeDomainOptions]
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(DescribeMailServerDomainResult, Integer, Hash)>] DescribeMailServerDomainResult data, response status code and response headers
35
- def describe_mail_server_domain_with_http_info(describe_options, opts = {})
35
+ def describe_mail_server_domain_with_http_info(describe_domain_options, opts = {})
36
36
  if @api_client.config.debugging
37
37
  @api_client.config.logger.debug 'Calling API: MailServerControllerApi.describe_mail_server_domain ...'
38
38
  end
39
- # verify the required parameter 'describe_options' is set
40
- if @api_client.config.client_side_validation && describe_options.nil?
41
- fail ArgumentError, "Missing the required parameter 'describe_options' when calling MailServerControllerApi.describe_mail_server_domain"
39
+ # verify the required parameter 'describe_domain_options' is set
40
+ if @api_client.config.client_side_validation && describe_domain_options.nil?
41
+ fail ArgumentError, "Missing the required parameter 'describe_domain_options' when calling MailServerControllerApi.describe_mail_server_domain"
42
42
  end
43
43
  # resource path
44
44
  local_var_path = '/mail-server/describe/domain'
@@ -49,7 +49,7 @@ module MailSlurpClient
49
49
  # header parameters
50
50
  header_params = opts[:header_params] || {}
51
51
  # HTTP header 'Accept' (if needed)
52
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
52
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
53
53
  # HTTP header 'Content-Type'
54
54
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
55
55
 
@@ -57,7 +57,7 @@ module MailSlurpClient
57
57
  form_params = opts[:form_params] || {}
58
58
 
59
59
  # http body (model)
60
- post_body = opts[:body] || @api_client.object_to_http_body(describe_options)
60
+ post_body = opts[:body] || @api_client.object_to_http_body(describe_domain_options)
61
61
 
62
62
  # return_type
63
63
  return_type = opts[:return_type] || 'DescribeMailServerDomainResult'
@@ -82,7 +82,7 @@ module MailSlurpClient
82
82
  end
83
83
 
84
84
  # Lookup DNS records for a domain
85
- # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
85
+ # @param dns_lookup_options [DNSLookupOptions]
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [DNSLookupResults]
88
88
  def get_dns_lookup(dns_lookup_options, opts = {})
@@ -91,7 +91,7 @@ module MailSlurpClient
91
91
  end
92
92
 
93
93
  # Lookup DNS records for a domain
94
- # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
94
+ # @param dns_lookup_options [DNSLookupOptions]
95
95
  # @param [Hash] opts the optional parameters
96
96
  # @return [Array<(DNSLookupResults, Integer, Hash)>] DNSLookupResults data, response status code and response headers
97
97
  def get_dns_lookup_with_http_info(dns_lookup_options, opts = {})
@@ -111,7 +111,7 @@ module MailSlurpClient
111
111
  # header parameters
112
112
  header_params = opts[:header_params] || {}
113
113
  # HTTP header 'Accept' (if needed)
114
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
114
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
115
115
  # HTTP header 'Content-Type'
116
116
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
117
117
 
@@ -144,7 +144,7 @@ module MailSlurpClient
144
144
  end
145
145
 
146
146
  # Get IP address for a domain
147
- # @param name [String] name
147
+ # @param name [String]
148
148
  # @param [Hash] opts the optional parameters
149
149
  # @return [IPAddressResult]
150
150
  def get_ip_address(name, opts = {})
@@ -153,7 +153,7 @@ module MailSlurpClient
153
153
  end
154
154
 
155
155
  # Get IP address for a domain
156
- # @param name [String] name
156
+ # @param name [String]
157
157
  # @param [Hash] opts the optional parameters
158
158
  # @return [Array<(IPAddressResult, Integer, Hash)>] IPAddressResult data, response status code and response headers
159
159
  def get_ip_address_with_http_info(name, opts = {})
@@ -174,7 +174,7 @@ module MailSlurpClient
174
174
  # header parameters
175
175
  header_params = opts[:header_params] || {}
176
176
  # HTTP header 'Accept' (if needed)
177
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
178
178
 
179
179
  # form parameters
180
180
  form_params = opts[:form_params] || {}
@@ -205,25 +205,25 @@ module MailSlurpClient
205
205
  end
206
206
 
207
207
  # Verify the existence of an email address at a given mail server.
208
- # @param verify_options [VerifyEmailAddressOptions] verifyOptions
208
+ # @param verify_email_address_options [VerifyEmailAddressOptions]
209
209
  # @param [Hash] opts the optional parameters
210
210
  # @return [EmailVerificationResult]
211
- def verify_email_address(verify_options, opts = {})
212
- data, _status_code, _headers = verify_email_address_with_http_info(verify_options, opts)
211
+ def verify_email_address(verify_email_address_options, opts = {})
212
+ data, _status_code, _headers = verify_email_address_with_http_info(verify_email_address_options, opts)
213
213
  data
214
214
  end
215
215
 
216
216
  # Verify the existence of an email address at a given mail server.
217
- # @param verify_options [VerifyEmailAddressOptions] verifyOptions
217
+ # @param verify_email_address_options [VerifyEmailAddressOptions]
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @return [Array<(EmailVerificationResult, Integer, Hash)>] EmailVerificationResult data, response status code and response headers
220
- def verify_email_address_with_http_info(verify_options, opts = {})
220
+ def verify_email_address_with_http_info(verify_email_address_options, opts = {})
221
221
  if @api_client.config.debugging
222
222
  @api_client.config.logger.debug 'Calling API: MailServerControllerApi.verify_email_address ...'
223
223
  end
224
- # verify the required parameter 'verify_options' is set
225
- if @api_client.config.client_side_validation && verify_options.nil?
226
- fail ArgumentError, "Missing the required parameter 'verify_options' when calling MailServerControllerApi.verify_email_address"
224
+ # verify the required parameter 'verify_email_address_options' is set
225
+ if @api_client.config.client_side_validation && verify_email_address_options.nil?
226
+ fail ArgumentError, "Missing the required parameter 'verify_email_address_options' when calling MailServerControllerApi.verify_email_address"
227
227
  end
228
228
  # resource path
229
229
  local_var_path = '/mail-server/verify/email-address'
@@ -234,7 +234,7 @@ module MailSlurpClient
234
234
  # header parameters
235
235
  header_params = opts[:header_params] || {}
236
236
  # HTTP header 'Accept' (if needed)
237
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
237
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
238
238
  # HTTP header 'Content-Type'
239
239
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
240
240
 
@@ -242,7 +242,7 @@ module MailSlurpClient
242
242
  form_params = opts[:form_params] || {}
243
243
 
244
244
  # http body (model)
245
- post_body = opts[:body] || @api_client.object_to_http_body(verify_options)
245
+ post_body = opts[:body] || @api_client.object_to_http_body(verify_email_address_options)
246
246
 
247
247
  # return_type
248
248
  return_type = opts[:return_type] || 'EmailVerificationResult'