mailslurp_client 15.17.41 → 15.18.1

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/api/email_controller_api.rb +62 -0
  3. data/lib/mailslurp_client/api/tools_controller_api.rb +175 -0
  4. data/lib/mailslurp_client/models/alias_projection.rb +19 -19
  5. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +11 -11
  6. data/lib/mailslurp_client/models/check_email_body_results.rb +259 -0
  7. data/lib/mailslurp_client/models/connector_projection.rb +15 -15
  8. data/lib/mailslurp_client/models/email_projection.rb +10 -10
  9. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +15 -15
  10. data/lib/mailslurp_client/models/fake_email_dto.rb +305 -0
  11. data/lib/mailslurp_client/models/fake_email_preview.rb +291 -0
  12. data/lib/mailslurp_client/models/fake_email_result.rb +206 -0
  13. data/lib/mailslurp_client/models/image_issue.rb +282 -0
  14. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +15 -4
  15. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +11 -11
  16. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +21 -21
  17. data/lib/mailslurp_client/models/link_issue.rb +282 -0
  18. data/lib/mailslurp_client/models/new_fake_email_address_result.rb +211 -0
  19. data/lib/mailslurp_client/models/sent_email_projection.rb +38 -38
  20. data/lib/mailslurp_client/models/spelling_issue.rb +287 -0
  21. data/lib/mailslurp_client/models/thread_projection.rb +16 -16
  22. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +13 -13
  23. data/lib/mailslurp_client/version.rb +1 -1
  24. data/lib/mailslurp_client.rb +8 -0
  25. metadata +10 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1877e1d62462c84900b2f639ad0fdbfd7ec15e07595bbac9e4a15f7a9767d0b2
4
- data.tar.gz: df302298ff1be36183a7dee03b5349758460b332c98e66b9cc35f386249bebc5
3
+ metadata.gz: 71d1ee9e56f6e239d589320339c23b3260bc367765ad28bc00d2bf83b630ba20
4
+ data.tar.gz: b1076e91a536946a3a443d8066c997d521df9f4c9b5655955bd36156ba7ea0cf
5
5
  SHA512:
6
- metadata.gz: a160571de0f62f45e66209e4532644bba01cf4935b9a2a36b78d7f5e98f157788bd9f86d51ba3fe741a8bda042ebc927eebd3b120de90796b871f04fde7d3f75
7
- data.tar.gz: e1183548bff3750e0e28c8d610c427ca4f4269a452f9bffd1655964b99c9a389ed33dd53ad51a3eb63e495c55a05700e02db2a896696d35316f500552a507ff2
6
+ metadata.gz: 28335df6c83826b7769cdac23f17ac397cc912b80f3a57b051c539c6b4219bd21d12a4f202c58e6e31933486e1a014e1f209e0f1a289c7d4fef0b67fff5ccf62
7
+ data.tar.gz: be6a89f55f26508935f4d098716e56b0230db783906e8e994dd391189839893e416b195087a692cd861f976dc7a5b8c8218671eb1bcf2d30d163b6c8aaaec108
@@ -160,6 +160,68 @@ module MailSlurpClient
160
160
  return data, status_code, headers
161
161
  end
162
162
 
163
+ # Detect broken links, spelling, and images in email content
164
+ # Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.
165
+ # @param email_id [String]
166
+ # @param [Hash] opts the optional parameters
167
+ # @return [CheckEmailBodyResults]
168
+ def check_email_body(email_id, opts = {})
169
+ data, _status_code, _headers = check_email_body_with_http_info(email_id, opts)
170
+ data
171
+ end
172
+
173
+ # Detect broken links, spelling, and images in email content
174
+ # Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.
175
+ # @param email_id [String]
176
+ # @param [Hash] opts the optional parameters
177
+ # @return [Array<(CheckEmailBodyResults, Integer, Hash)>] CheckEmailBodyResults data, response status code and response headers
178
+ def check_email_body_with_http_info(email_id, opts = {})
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.check_email_body ...'
181
+ end
182
+ # verify the required parameter 'email_id' is set
183
+ if @api_client.config.client_side_validation && email_id.nil?
184
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.check_email_body"
185
+ end
186
+ # resource path
187
+ local_var_path = '/emails/{emailId}/check-email-body'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
188
+
189
+ # query parameters
190
+ query_params = opts[:query_params] || {}
191
+
192
+ # header parameters
193
+ header_params = opts[:header_params] || {}
194
+ # HTTP header 'Accept' (if needed)
195
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
196
+
197
+ # form parameters
198
+ form_params = opts[:form_params] || {}
199
+
200
+ # http body (model)
201
+ post_body = opts[:body]
202
+
203
+ # return_type
204
+ return_type = opts[:return_type] || 'CheckEmailBodyResults'
205
+
206
+ # auth_names
207
+ auth_names = opts[:auth_names] || ['API_KEY']
208
+
209
+ new_options = opts.merge(
210
+ :header_params => header_params,
211
+ :query_params => query_params,
212
+ :form_params => form_params,
213
+ :body => post_body,
214
+ :auth_names => auth_names,
215
+ :return_type => return_type
216
+ )
217
+
218
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
219
+ if @api_client.config.debugging
220
+ @api_client.config.logger.debug "API called: EmailControllerApi#check_email_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
221
+ end
222
+ return data, status_code, headers
223
+ end
224
+
163
225
  # Show which mail clients support the HTML and CSS features used in an email body.
164
226
  # Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions.
165
227
  # @param email_id [String]
@@ -81,6 +81,60 @@ module MailSlurpClient
81
81
  return data, status_code, headers
82
82
  end
83
83
 
84
+ # Create a new email address using the fake email domains
85
+ # @param [Hash] opts the optional parameters
86
+ # @return [NewFakeEmailAddressResult]
87
+ def create_new_fake_email_address(opts = {})
88
+ data, _status_code, _headers = create_new_fake_email_address_with_http_info(opts)
89
+ data
90
+ end
91
+
92
+ # Create a new email address using the fake email domains
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [Array<(NewFakeEmailAddressResult, Integer, Hash)>] NewFakeEmailAddressResult data, response status code and response headers
95
+ def create_new_fake_email_address_with_http_info(opts = {})
96
+ if @api_client.config.debugging
97
+ @api_client.config.logger.debug 'Calling API: ToolsControllerApi.create_new_fake_email_address ...'
98
+ end
99
+ # resource path
100
+ local_var_path = '/tools/fake-email'
101
+
102
+ # query parameters
103
+ query_params = opts[:query_params] || {}
104
+
105
+ # header parameters
106
+ header_params = opts[:header_params] || {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
109
+
110
+ # form parameters
111
+ form_params = opts[:form_params] || {}
112
+
113
+ # http body (model)
114
+ post_body = opts[:body]
115
+
116
+ # return_type
117
+ return_type = opts[:return_type] || 'NewFakeEmailAddressResult'
118
+
119
+ # auth_names
120
+ auth_names = opts[:auth_names] || ['API_KEY']
121
+
122
+ new_options = opts.merge(
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => return_type
129
+ )
130
+
131
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
132
+ if @api_client.config.debugging
133
+ @api_client.config.logger.debug "API called: ToolsControllerApi#create_new_fake_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
134
+ end
135
+ return data, status_code, headers
136
+ end
137
+
84
138
  # Create a BIMI record policy
85
139
  # @param generate_bimi_record_options [GenerateBimiRecordOptions]
86
140
  # @param [Hash] opts the optional parameters
@@ -329,6 +383,127 @@ module MailSlurpClient
329
383
  return data, status_code, headers
330
384
  end
331
385
 
386
+ # @param id [String]
387
+ # @param [Hash] opts the optional parameters
388
+ # @return [FakeEmailResult]
389
+ def get_fake_email_by_id(id, opts = {})
390
+ data, _status_code, _headers = get_fake_email_by_id_with_http_info(id, opts)
391
+ data
392
+ end
393
+
394
+ # @param id [String]
395
+ # @param [Hash] opts the optional parameters
396
+ # @return [Array<(FakeEmailResult, Integer, Hash)>] FakeEmailResult data, response status code and response headers
397
+ def get_fake_email_by_id_with_http_info(id, opts = {})
398
+ if @api_client.config.debugging
399
+ @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_email_by_id ...'
400
+ end
401
+ # verify the required parameter 'id' is set
402
+ if @api_client.config.client_side_validation && id.nil?
403
+ fail ArgumentError, "Missing the required parameter 'id' when calling ToolsControllerApi.get_fake_email_by_id"
404
+ end
405
+ # resource path
406
+ local_var_path = '/tools/fake-email'
407
+
408
+ # query parameters
409
+ query_params = opts[:query_params] || {}
410
+ query_params[:'id'] = id
411
+
412
+ # header parameters
413
+ header_params = opts[:header_params] || {}
414
+ # HTTP header 'Accept' (if needed)
415
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
416
+
417
+ # form parameters
418
+ form_params = opts[:form_params] || {}
419
+
420
+ # http body (model)
421
+ post_body = opts[:body]
422
+
423
+ # return_type
424
+ return_type = opts[:return_type] || 'FakeEmailResult'
425
+
426
+ # auth_names
427
+ auth_names = opts[:auth_names] || ['API_KEY']
428
+
429
+ new_options = opts.merge(
430
+ :header_params => header_params,
431
+ :query_params => query_params,
432
+ :form_params => form_params,
433
+ :body => post_body,
434
+ :auth_names => auth_names,
435
+ :return_type => return_type
436
+ )
437
+
438
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
439
+ if @api_client.config.debugging
440
+ @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_email_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
441
+ end
442
+ return data, status_code, headers
443
+ end
444
+
445
+ # @param email_address [String]
446
+ # @param [Hash] opts the optional parameters
447
+ # @option opts [Integer] :page
448
+ # @return [Array<FakeEmailPreview>]
449
+ def get_fake_emails_for_address(email_address, opts = {})
450
+ data, _status_code, _headers = get_fake_emails_for_address_with_http_info(email_address, opts)
451
+ data
452
+ end
453
+
454
+ # @param email_address [String]
455
+ # @param [Hash] opts the optional parameters
456
+ # @option opts [Integer] :page
457
+ # @return [Array<(Array<FakeEmailPreview>, Integer, Hash)>] Array<FakeEmailPreview> data, response status code and response headers
458
+ def get_fake_emails_for_address_with_http_info(email_address, opts = {})
459
+ if @api_client.config.debugging
460
+ @api_client.config.logger.debug 'Calling API: ToolsControllerApi.get_fake_emails_for_address ...'
461
+ end
462
+ # verify the required parameter 'email_address' is set
463
+ if @api_client.config.client_side_validation && email_address.nil?
464
+ fail ArgumentError, "Missing the required parameter 'email_address' when calling ToolsControllerApi.get_fake_emails_for_address"
465
+ end
466
+ # resource path
467
+ local_var_path = '/tools/fake-emails'
468
+
469
+ # query parameters
470
+ query_params = opts[:query_params] || {}
471
+ query_params[:'emailAddress'] = email_address
472
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
473
+
474
+ # header parameters
475
+ header_params = opts[:header_params] || {}
476
+ # HTTP header 'Accept' (if needed)
477
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
478
+
479
+ # form parameters
480
+ form_params = opts[:form_params] || {}
481
+
482
+ # http body (model)
483
+ post_body = opts[:body]
484
+
485
+ # return_type
486
+ return_type = opts[:return_type] || 'Array<FakeEmailPreview>'
487
+
488
+ # auth_names
489
+ auth_names = opts[:auth_names] || ['API_KEY']
490
+
491
+ new_options = opts.merge(
492
+ :header_params => header_params,
493
+ :query_params => query_params,
494
+ :form_params => form_params,
495
+ :body => post_body,
496
+ :auth_names => auth_names,
497
+ :return_type => return_type
498
+ )
499
+
500
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
501
+ if @api_client.config.debugging
502
+ @api_client.config.logger.debug "API called: ToolsControllerApi#get_fake_emails_for_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
+ end
504
+ return data, status_code, headers
505
+ end
506
+
332
507
  # Lookup a BIMI record policy
333
508
  # @param lookup_bimi_domain_options [LookupBimiDomainOptions]
334
509
  # @param [Hash] opts the optional parameters
@@ -19,11 +19,11 @@ module MailSlurpClient
19
19
 
20
20
  attr_accessor :updated_at
21
21
 
22
- attr_accessor :email_address
22
+ attr_accessor :inbox_id
23
23
 
24
24
  attr_accessor :user_id
25
25
 
26
- attr_accessor :inbox_id
26
+ attr_accessor :email_address
27
27
 
28
28
  attr_accessor :use_threads
29
29
 
@@ -36,9 +36,9 @@ module MailSlurpClient
36
36
  {
37
37
  :'created_at' => :'createdAt',
38
38
  :'updated_at' => :'updatedAt',
39
- :'email_address' => :'emailAddress',
40
- :'user_id' => :'userId',
41
39
  :'inbox_id' => :'inboxId',
40
+ :'user_id' => :'userId',
41
+ :'email_address' => :'emailAddress',
42
42
  :'use_threads' => :'useThreads',
43
43
  :'name' => :'name',
44
44
  :'id' => :'id'
@@ -50,9 +50,9 @@ module MailSlurpClient
50
50
  {
51
51
  :'created_at' => :'DateTime',
52
52
  :'updated_at' => :'DateTime',
53
- :'email_address' => :'String',
54
- :'user_id' => :'String',
55
53
  :'inbox_id' => :'String',
54
+ :'user_id' => :'String',
55
+ :'email_address' => :'String',
56
56
  :'use_threads' => :'Boolean',
57
57
  :'name' => :'String',
58
58
  :'id' => :'String'
@@ -88,16 +88,16 @@ module MailSlurpClient
88
88
  self.updated_at = attributes[:'updated_at']
89
89
  end
90
90
 
91
- if attributes.key?(:'email_address')
92
- self.email_address = attributes[:'email_address']
91
+ if attributes.key?(:'inbox_id')
92
+ self.inbox_id = attributes[:'inbox_id']
93
93
  end
94
94
 
95
95
  if attributes.key?(:'user_id')
96
96
  self.user_id = attributes[:'user_id']
97
97
  end
98
98
 
99
- if attributes.key?(:'inbox_id')
100
- self.inbox_id = attributes[:'inbox_id']
99
+ if attributes.key?(:'email_address')
100
+ self.email_address = attributes[:'email_address']
101
101
  end
102
102
 
103
103
  if attributes.key?(:'use_threads')
@@ -125,16 +125,16 @@ module MailSlurpClient
125
125
  invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
126
126
  end
127
127
 
128
- if @email_address.nil?
129
- invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
128
+ if @inbox_id.nil?
129
+ invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
130
130
  end
131
131
 
132
132
  if @user_id.nil?
133
133
  invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
134
134
  end
135
135
 
136
- if @inbox_id.nil?
137
- invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
136
+ if @email_address.nil?
137
+ invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
138
138
  end
139
139
 
140
140
  if @id.nil?
@@ -149,9 +149,9 @@ module MailSlurpClient
149
149
  def valid?
150
150
  return false if @created_at.nil?
151
151
  return false if @updated_at.nil?
152
- return false if @email_address.nil?
153
- return false if @user_id.nil?
154
152
  return false if @inbox_id.nil?
153
+ return false if @user_id.nil?
154
+ return false if @email_address.nil?
155
155
  return false if @id.nil?
156
156
  true
157
157
  end
@@ -163,9 +163,9 @@ module MailSlurpClient
163
163
  self.class == o.class &&
164
164
  created_at == o.created_at &&
165
165
  updated_at == o.updated_at &&
166
- email_address == o.email_address &&
167
- user_id == o.user_id &&
168
166
  inbox_id == o.inbox_id &&
167
+ user_id == o.user_id &&
168
+ email_address == o.email_address &&
169
169
  use_threads == o.use_threads &&
170
170
  name == o.name &&
171
171
  id == o.id
@@ -180,7 +180,7 @@ module MailSlurpClient
180
180
  # Calculates hash code according to all attributes.
181
181
  # @return [Integer] Hash code
182
182
  def hash
183
- [created_at, updated_at, email_address, user_id, inbox_id, use_threads, name, id].hash
183
+ [created_at, updated_at, inbox_id, user_id, email_address, use_threads, name, id].hash
184
184
  end
185
185
 
186
186
  # Builds the object from hash
@@ -21,10 +21,10 @@ module MailSlurpClient
21
21
 
22
22
  attr_accessor :recipient
23
23
 
24
- attr_accessor :action
25
-
26
24
  attr_accessor :bounce_type
27
25
 
26
+ attr_accessor :action
27
+
28
28
  attr_accessor :id
29
29
 
30
30
  attr_accessor :status
@@ -35,8 +35,8 @@ module MailSlurpClient
35
35
  :'created_at' => :'createdAt',
36
36
  :'sent_email_id' => :'sentEmailId',
37
37
  :'recipient' => :'recipient',
38
- :'action' => :'action',
39
38
  :'bounce_type' => :'bounceType',
39
+ :'action' => :'action',
40
40
  :'id' => :'id',
41
41
  :'status' => :'status'
42
42
  }
@@ -48,8 +48,8 @@ module MailSlurpClient
48
48
  :'created_at' => :'DateTime',
49
49
  :'sent_email_id' => :'String',
50
50
  :'recipient' => :'String',
51
- :'action' => :'String',
52
51
  :'bounce_type' => :'String',
52
+ :'action' => :'String',
53
53
  :'id' => :'String',
54
54
  :'status' => :'String'
55
55
  }
@@ -59,8 +59,8 @@ module MailSlurpClient
59
59
  def self.openapi_nullable
60
60
  Set.new([
61
61
  :'sent_email_id',
62
- :'action',
63
62
  :'bounce_type',
63
+ :'action',
64
64
  :'status'
65
65
  ])
66
66
  end
@@ -92,14 +92,14 @@ module MailSlurpClient
92
92
  self.recipient = attributes[:'recipient']
93
93
  end
94
94
 
95
- if attributes.key?(:'action')
96
- self.action = attributes[:'action']
97
- end
98
-
99
95
  if attributes.key?(:'bounce_type')
100
96
  self.bounce_type = attributes[:'bounce_type']
101
97
  end
102
98
 
99
+ if attributes.key?(:'action')
100
+ self.action = attributes[:'action']
101
+ end
102
+
103
103
  if attributes.key?(:'id')
104
104
  self.id = attributes[:'id']
105
105
  end
@@ -140,8 +140,8 @@ module MailSlurpClient
140
140
  created_at == o.created_at &&
141
141
  sent_email_id == o.sent_email_id &&
142
142
  recipient == o.recipient &&
143
- action == o.action &&
144
143
  bounce_type == o.bounce_type &&
144
+ action == o.action &&
145
145
  id == o.id &&
146
146
  status == o.status
147
147
  end
@@ -155,7 +155,7 @@ module MailSlurpClient
155
155
  # Calculates hash code according to all attributes.
156
156
  # @return [Integer] Hash code
157
157
  def hash
158
- [created_at, sent_email_id, recipient, action, bounce_type, id, status].hash
158
+ [created_at, sent_email_id, recipient, bounce_type, action, id, status].hash
159
159
  end
160
160
 
161
161
  # Builds the object from hash