mailslurp_client 15.0.1 → 15.0.5

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 +190 -116
  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 +359 -225
  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 +206 -0
  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 +3 -1
  158. metadata +5 -3
@@ -21,7 +21,7 @@ module MailSlurpClient
21
21
  end
22
22
  # Add catch all wild card inbox to domain
23
23
  # Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
24
- # @param id [String] id
24
+ # @param id [String]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [DomainDto]
27
27
  def add_domain_wildcard_catch_all(id, opts = {})
@@ -31,7 +31,7 @@ module MailSlurpClient
31
31
 
32
32
  # Add catch all wild card inbox to domain
33
33
  # Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
34
- # @param id [String] id
34
+ # @param id [String]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
37
37
  def add_domain_wildcard_catch_all_with_http_info(id, opts = {})
@@ -51,7 +51,7 @@ module MailSlurpClient
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # HTTP header 'Accept' (if needed)
54
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
54
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
55
55
 
56
56
  # form parameters
57
57
  form_params = opts[:form_params] || {}
@@ -83,26 +83,26 @@ module MailSlurpClient
83
83
 
84
84
  # Create Domain
85
85
  # Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
86
- # @param domain_options [CreateDomainOptions] domainOptions
86
+ # @param create_domain_options [CreateDomainOptions]
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [DomainDto]
89
- def create_domain(domain_options, opts = {})
90
- data, _status_code, _headers = create_domain_with_http_info(domain_options, opts)
89
+ def create_domain(create_domain_options, opts = {})
90
+ data, _status_code, _headers = create_domain_with_http_info(create_domain_options, opts)
91
91
  data
92
92
  end
93
93
 
94
94
  # Create Domain
95
95
  # Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider&#39;s DNS setup to verify the domain.
96
- # @param domain_options [CreateDomainOptions] domainOptions
96
+ # @param create_domain_options [CreateDomainOptions]
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
99
- def create_domain_with_http_info(domain_options, opts = {})
99
+ def create_domain_with_http_info(create_domain_options, opts = {})
100
100
  if @api_client.config.debugging
101
101
  @api_client.config.logger.debug 'Calling API: DomainControllerApi.create_domain ...'
102
102
  end
103
- # verify the required parameter 'domain_options' is set
104
- if @api_client.config.client_side_validation && domain_options.nil?
105
- fail ArgumentError, "Missing the required parameter 'domain_options' when calling DomainControllerApi.create_domain"
103
+ # verify the required parameter 'create_domain_options' is set
104
+ if @api_client.config.client_side_validation && create_domain_options.nil?
105
+ fail ArgumentError, "Missing the required parameter 'create_domain_options' when calling DomainControllerApi.create_domain"
106
106
  end
107
107
  # resource path
108
108
  local_var_path = '/domains'
@@ -113,7 +113,7 @@ module MailSlurpClient
113
113
  # header parameters
114
114
  header_params = opts[:header_params] || {}
115
115
  # HTTP header 'Accept' (if needed)
116
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
117
117
  # HTTP header 'Content-Type'
118
118
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
119
119
 
@@ -121,7 +121,7 @@ module MailSlurpClient
121
121
  form_params = opts[:form_params] || {}
122
122
 
123
123
  # http body (model)
124
- post_body = opts[:body] || @api_client.object_to_http_body(domain_options)
124
+ post_body = opts[:body] || @api_client.object_to_http_body(create_domain_options)
125
125
 
126
126
  # return_type
127
127
  return_type = opts[:return_type] || 'DomainDto'
@@ -147,7 +147,7 @@ module MailSlurpClient
147
147
 
148
148
  # Delete a domain
149
149
  # Delete a domain. This will disable any existing inboxes that use this domain.
150
- # @param id [String] id
150
+ # @param id [String]
151
151
  # @param [Hash] opts the optional parameters
152
152
  # @return [Array<String>]
153
153
  def delete_domain(id, opts = {})
@@ -157,7 +157,7 @@ module MailSlurpClient
157
157
 
158
158
  # Delete a domain
159
159
  # Delete a domain. This will disable any existing inboxes that use this domain.
160
- # @param id [String] id
160
+ # @param id [String]
161
161
  # @param [Hash] opts the optional parameters
162
162
  # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
163
163
  def delete_domain_with_http_info(id, opts = {})
@@ -177,7 +177,7 @@ module MailSlurpClient
177
177
  # header parameters
178
178
  header_params = opts[:header_params] || {}
179
179
  # HTTP header 'Accept' (if needed)
180
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
180
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
181
181
 
182
182
  # form parameters
183
183
  form_params = opts[:form_params] || {}
@@ -209,7 +209,7 @@ module MailSlurpClient
209
209
 
210
210
  # Get a domain
211
211
  # Returns domain verification status and tokens for a given domain
212
- # @param id [String] id
212
+ # @param id [String]
213
213
  # @param [Hash] opts the optional parameters
214
214
  # @return [DomainDto]
215
215
  def get_domain(id, opts = {})
@@ -219,7 +219,7 @@ module MailSlurpClient
219
219
 
220
220
  # Get a domain
221
221
  # Returns domain verification status and tokens for a given domain
222
- # @param id [String] id
222
+ # @param id [String]
223
223
  # @param [Hash] opts the optional parameters
224
224
  # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
225
225
  def get_domain_with_http_info(id, opts = {})
@@ -239,7 +239,7 @@ module MailSlurpClient
239
239
  # header parameters
240
240
  header_params = opts[:header_params] || {}
241
241
  # HTTP header 'Accept' (if needed)
242
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
242
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
243
243
 
244
244
  # form parameters
245
245
  form_params = opts[:form_params] || {}
@@ -295,7 +295,7 @@ module MailSlurpClient
295
295
  # header parameters
296
296
  header_params = opts[:header_params] || {}
297
297
  # HTTP header 'Accept' (if needed)
298
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
298
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
299
299
 
300
300
  # form parameters
301
301
  form_params = opts[:form_params] || {}
@@ -327,22 +327,22 @@ module MailSlurpClient
327
327
 
328
328
  # Update a domain
329
329
  # Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.
330
- # @param id [String] id
331
- # @param update_domain_dto [UpdateDomainOptions] updateDomainDto
330
+ # @param id [String]
331
+ # @param update_domain_options [UpdateDomainOptions]
332
332
  # @param [Hash] opts the optional parameters
333
333
  # @return [DomainDto]
334
- def update_domain(id, update_domain_dto, opts = {})
335
- data, _status_code, _headers = update_domain_with_http_info(id, update_domain_dto, opts)
334
+ def update_domain(id, update_domain_options, opts = {})
335
+ data, _status_code, _headers = update_domain_with_http_info(id, update_domain_options, opts)
336
336
  data
337
337
  end
338
338
 
339
339
  # Update a domain
340
340
  # Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.
341
- # @param id [String] id
342
- # @param update_domain_dto [UpdateDomainOptions] updateDomainDto
341
+ # @param id [String]
342
+ # @param update_domain_options [UpdateDomainOptions]
343
343
  # @param [Hash] opts the optional parameters
344
344
  # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
345
- def update_domain_with_http_info(id, update_domain_dto, opts = {})
345
+ def update_domain_with_http_info(id, update_domain_options, opts = {})
346
346
  if @api_client.config.debugging
347
347
  @api_client.config.logger.debug 'Calling API: DomainControllerApi.update_domain ...'
348
348
  end
@@ -350,9 +350,9 @@ module MailSlurpClient
350
350
  if @api_client.config.client_side_validation && id.nil?
351
351
  fail ArgumentError, "Missing the required parameter 'id' when calling DomainControllerApi.update_domain"
352
352
  end
353
- # verify the required parameter 'update_domain_dto' is set
354
- if @api_client.config.client_side_validation && update_domain_dto.nil?
355
- fail ArgumentError, "Missing the required parameter 'update_domain_dto' when calling DomainControllerApi.update_domain"
353
+ # verify the required parameter 'update_domain_options' is set
354
+ if @api_client.config.client_side_validation && update_domain_options.nil?
355
+ fail ArgumentError, "Missing the required parameter 'update_domain_options' when calling DomainControllerApi.update_domain"
356
356
  end
357
357
  # resource path
358
358
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -363,7 +363,7 @@ module MailSlurpClient
363
363
  # header parameters
364
364
  header_params = opts[:header_params] || {}
365
365
  # HTTP header 'Accept' (if needed)
366
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
366
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
367
367
  # HTTP header 'Content-Type'
368
368
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
369
369
 
@@ -371,7 +371,7 @@ module MailSlurpClient
371
371
  form_params = opts[:form_params] || {}
372
372
 
373
373
  # http body (model)
374
- post_body = opts[:body] || @api_client.object_to_http_body(update_domain_dto)
374
+ post_body = opts[:body] || @api_client.object_to_http_body(update_domain_options)
375
375
 
376
376
  # return_type
377
377
  return_type = opts[:return_type] || 'DomainDto'