mailslurp_client 15.18.5 → 15.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/connector_controller_api.rb +260 -0
  3. data/lib/mailslurp_client/api/domain_controller_api.rb +126 -0
  4. data/lib/mailslurp_client/api/email_controller_api.rb +138 -0
  5. data/lib/mailslurp_client/api/imap_controller_api.rb +279 -0
  6. data/lib/mailslurp_client/api/inbox_controller_api.rb +114 -0
  7. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +3 -0
  8. data/lib/mailslurp_client/api/mail_server_controller_api.rb +62 -0
  9. data/lib/mailslurp_client/models/alias_projection.rb +29 -29
  10. data/lib/mailslurp_client/models/attachment_projection.rb +29 -29
  11. data/lib/mailslurp_client/models/bounce_projection.rb +29 -29
  12. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +22 -22
  13. data/lib/mailslurp_client/models/connector_dto.rb +42 -108
  14. data/lib/mailslurp_client/models/connector_imap_connection_dto.rb +311 -0
  15. data/lib/mailslurp_client/models/connector_projection.rb +39 -43
  16. data/lib/mailslurp_client/models/connector_smtp_connection_dto.rb +293 -0
  17. data/lib/mailslurp_client/models/connector_sync_event_projection.rb +15 -15
  18. data/lib/mailslurp_client/models/contact_projection.rb +10 -10
  19. data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb +286 -0
  20. data/lib/mailslurp_client/models/create_connector_options.rb +38 -87
  21. data/lib/mailslurp_client/models/create_connector_smtp_connection_options.rb +256 -0
  22. data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
  23. data/lib/mailslurp_client/models/dns_lookups_options.rb +214 -0
  24. data/lib/mailslurp_client/models/domain_group.rb +261 -0
  25. data/lib/mailslurp_client/models/domain_groups_dto.rb +213 -0
  26. data/lib/mailslurp_client/models/domain_information.rb +274 -0
  27. data/lib/mailslurp_client/models/email_preview_urls.rb +18 -4
  28. data/lib/mailslurp_client/models/email_projection.rb +19 -19
  29. data/lib/mailslurp_client/models/email_screenshot_result.rb +211 -0
  30. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +15 -15
  31. data/lib/mailslurp_client/models/get_email_screenshot_options.rb +220 -0
  32. data/lib/mailslurp_client/models/imap_access_details.rb +273 -0
  33. data/lib/mailslurp_client/models/imap_email_projection.rb +239 -0
  34. data/lib/mailslurp_client/models/{create_connector_imap_options.rb → imap_server_fetch_item.rb} +55 -49
  35. data/lib/mailslurp_client/models/imap_server_fetch_result.rb +208 -0
  36. data/lib/mailslurp_client/models/{create_connector_imap_fetch_options.rb → imap_server_list_options.rb} +18 -16
  37. data/lib/mailslurp_client/models/imap_server_list_result.rb +213 -0
  38. data/lib/mailslurp_client/models/imap_server_search_options.rb +318 -0
  39. data/lib/mailslurp_client/models/imap_server_search_result.rb +213 -0
  40. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +16 -1
  41. data/lib/mailslurp_client/models/imap_update_flags_options.rb +277 -0
  42. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +10 -10
  43. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +10 -10
  44. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +15 -15
  45. data/lib/mailslurp_client/models/match_option.rb +4 -4
  46. data/lib/mailslurp_client/models/missed_email_projection.rb +14 -14
  47. data/lib/mailslurp_client/models/page_alias.rb +15 -15
  48. data/lib/mailslurp_client/models/page_attachment_entity.rb +15 -15
  49. data/lib/mailslurp_client/models/page_bounced_email.rb +15 -15
  50. data/lib/mailslurp_client/models/page_bounced_recipients.rb +15 -15
  51. data/lib/mailslurp_client/models/page_complaint.rb +15 -15
  52. data/lib/mailslurp_client/models/page_connector.rb +15 -15
  53. data/lib/mailslurp_client/models/page_connector_sync_events.rb +15 -15
  54. data/lib/mailslurp_client/models/page_contact_projection.rb +15 -15
  55. data/lib/mailslurp_client/models/page_delivery_status.rb +15 -15
  56. data/lib/mailslurp_client/models/page_email_preview.rb +15 -15
  57. data/lib/mailslurp_client/models/page_email_projection.rb +15 -15
  58. data/lib/mailslurp_client/models/page_email_validation_request.rb +15 -15
  59. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +15 -15
  60. data/lib/mailslurp_client/models/page_group_projection.rb +15 -15
  61. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +15 -15
  62. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +15 -15
  63. data/lib/mailslurp_client/models/page_inbox_projection.rb +15 -15
  64. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +15 -15
  65. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +15 -15
  66. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +15 -15
  67. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +15 -15
  68. data/lib/mailslurp_client/models/page_missed_email_projection.rb +15 -15
  69. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +15 -15
  70. data/lib/mailslurp_client/models/page_phone_number_projection.rb +15 -15
  71. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +15 -15
  72. data/lib/mailslurp_client/models/page_sent_email_projection.rb +15 -15
  73. data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +15 -15
  74. data/lib/mailslurp_client/models/page_sms_projection.rb +15 -15
  75. data/lib/mailslurp_client/models/page_template_projection.rb +15 -15
  76. data/lib/mailslurp_client/models/page_thread_projection.rb +15 -15
  77. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +15 -15
  78. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +15 -15
  79. data/lib/mailslurp_client/models/page_webhook_projection.rb +15 -15
  80. data/lib/mailslurp_client/models/page_webhook_result.rb +15 -15
  81. data/lib/mailslurp_client/models/phone_number_projection.rb +15 -15
  82. data/lib/mailslurp_client/models/sent_email_projection.rb +35 -35
  83. data/lib/mailslurp_client/models/sms_match_option.rb +2 -2
  84. data/lib/mailslurp_client/models/sms_projection.rb +29 -29
  85. data/lib/mailslurp_client/models/smtp_access_details.rb +329 -0
  86. data/lib/mailslurp_client/models/template_projection.rb +17 -17
  87. data/lib/mailslurp_client/models/thread_projection.rb +35 -35
  88. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +15 -15
  89. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +13 -13
  90. data/lib/mailslurp_client/models/webhook_projection.rb +25 -25
  91. data/lib/mailslurp_client/version.rb +1 -1
  92. data/lib/mailslurp_client.rb +21 -2
  93. metadata +23 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9850049a30de9796cb1b3c6b0a679e85157c74c8dc590e4bc0f5435208ad30b5
4
- data.tar.gz: 3af4a3d03795e2d91bb4ff2fed4408812fe2a9c9c4fc61e1d5386c4bee207228
3
+ metadata.gz: 9850bd5b0d57564153b7c7fae5a47a4e12f178a3f7274c9a1132bef2bdd33272
4
+ data.tar.gz: 500630412e1d4e8ef7f6abdf83eb4dd62682f188b74d7df9e7fdb1f8289f8239
5
5
  SHA512:
6
- metadata.gz: f2e88f73b596989c7812d50493b71f198c7c867231b78266c15e8579772147f35b081c25be2f5c6d5bee9874e1981127839b94cedf74ee5e4f108b94455d587b
7
- data.tar.gz: d8fec58d243f4e8e0f4dbb7ba469c4dc56d15f81c434bf017418190154bd61d28ced0eaa83ff2321f66128a1ba11eaacba31ebf30e95426922595eb3731b122b
6
+ metadata.gz: b6a54491db990d625d4a02656c46611d105fbd98fc1c696213c011f03e5562027dc5b1b8ca32d600d5037ffceebba5641cece7a45a450a0c718839907d901778
7
+ data.tar.gz: 968f6e1f02393566666cab0309601545cc9aeb473bfc3bf9cfd0dbe839b80879e029f1b0f67e5f16a07d886c6e1c2bd75edad9c5467c5d6aa89f9df309a095f6
@@ -83,6 +83,146 @@ module MailSlurpClient
83
83
  return data, status_code, headers
84
84
  end
85
85
 
86
+ # Create an inbox connector IMAP connection
87
+ # Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox
88
+ # @param id [String]
89
+ # @param create_connector_imap_connection_options [CreateConnectorImapConnectionOptions]
90
+ # @param [Hash] opts the optional parameters
91
+ # @return [ConnectorImapConnectionDto]
92
+ def create_connector_imap_connection(id, create_connector_imap_connection_options, opts = {})
93
+ data, _status_code, _headers = create_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, opts)
94
+ data
95
+ end
96
+
97
+ # Create an inbox connector IMAP connection
98
+ # Allows the reading of emails in an external mailbox and syncing to a MailSlurp inbox
99
+ # @param id [String]
100
+ # @param create_connector_imap_connection_options [CreateConnectorImapConnectionOptions]
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [Array<(ConnectorImapConnectionDto, Integer, Hash)>] ConnectorImapConnectionDto data, response status code and response headers
103
+ def create_connector_imap_connection_with_http_info(id, create_connector_imap_connection_options, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: ConnectorControllerApi.create_connector_imap_connection ...'
106
+ end
107
+ # verify the required parameter 'id' is set
108
+ if @api_client.config.client_side_validation && id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'id' when calling ConnectorControllerApi.create_connector_imap_connection"
110
+ end
111
+ # verify the required parameter 'create_connector_imap_connection_options' is set
112
+ if @api_client.config.client_side_validation && create_connector_imap_connection_options.nil?
113
+ fail ArgumentError, "Missing the required parameter 'create_connector_imap_connection_options' when calling ConnectorControllerApi.create_connector_imap_connection"
114
+ end
115
+ # resource path
116
+ local_var_path = '/connectors/{id}/imap'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
125
+ # HTTP header 'Content-Type'
126
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:body] || @api_client.object_to_http_body(create_connector_imap_connection_options)
133
+
134
+ # return_type
135
+ return_type = opts[:return_type] || 'ConnectorImapConnectionDto'
136
+
137
+ # auth_names
138
+ auth_names = opts[:auth_names] || ['API_KEY']
139
+
140
+ new_options = opts.merge(
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: ConnectorControllerApi#create_connector_imap_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Create an inbox connector SMTP connection
157
+ # Allows sending via connector and email is routed to connected inbox and sent via SMTP
158
+ # @param id [String]
159
+ # @param create_connector_smtp_connection_options [CreateConnectorSmtpConnectionOptions]
160
+ # @param [Hash] opts the optional parameters
161
+ # @return [ConnectorSmtpConnectionDto]
162
+ def create_connector_smtp_connection(id, create_connector_smtp_connection_options, opts = {})
163
+ data, _status_code, _headers = create_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, opts)
164
+ data
165
+ end
166
+
167
+ # Create an inbox connector SMTP connection
168
+ # Allows sending via connector and email is routed to connected inbox and sent via SMTP
169
+ # @param id [String]
170
+ # @param create_connector_smtp_connection_options [CreateConnectorSmtpConnectionOptions]
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [Array<(ConnectorSmtpConnectionDto, Integer, Hash)>] ConnectorSmtpConnectionDto data, response status code and response headers
173
+ def create_connector_smtp_connection_with_http_info(id, create_connector_smtp_connection_options, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: ConnectorControllerApi.create_connector_smtp_connection ...'
176
+ end
177
+ # verify the required parameter 'id' is set
178
+ if @api_client.config.client_side_validation && id.nil?
179
+ fail ArgumentError, "Missing the required parameter 'id' when calling ConnectorControllerApi.create_connector_smtp_connection"
180
+ end
181
+ # verify the required parameter 'create_connector_smtp_connection_options' is set
182
+ if @api_client.config.client_side_validation && create_connector_smtp_connection_options.nil?
183
+ fail ArgumentError, "Missing the required parameter 'create_connector_smtp_connection_options' when calling ConnectorControllerApi.create_connector_smtp_connection"
184
+ end
185
+ # resource path
186
+ local_var_path = '/connectors/{id}/smtp'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
187
+
188
+ # query parameters
189
+ query_params = opts[:query_params] || {}
190
+
191
+ # header parameters
192
+ header_params = opts[:header_params] || {}
193
+ # HTTP header 'Accept' (if needed)
194
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
195
+ # HTTP header 'Content-Type'
196
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
197
+
198
+ # form parameters
199
+ form_params = opts[:form_params] || {}
200
+
201
+ # http body (model)
202
+ post_body = opts[:body] || @api_client.object_to_http_body(create_connector_smtp_connection_options)
203
+
204
+ # return_type
205
+ return_type = opts[:return_type] || 'ConnectorSmtpConnectionDto'
206
+
207
+ # auth_names
208
+ auth_names = opts[:auth_names] || ['API_KEY']
209
+
210
+ new_options = opts.merge(
211
+ :header_params => header_params,
212
+ :query_params => query_params,
213
+ :form_params => form_params,
214
+ :body => post_body,
215
+ :auth_names => auth_names,
216
+ :return_type => return_type
217
+ )
218
+
219
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "API called: ConnectorControllerApi#create_connector_smtp_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
+ end
223
+ return data, status_code, headers
224
+ end
225
+
86
226
  # Delete all inbox connectors
87
227
  # @param [Hash] opts the optional parameters
88
228
  # @return [nil]
@@ -193,6 +333,126 @@ module MailSlurpClient
193
333
  return data, status_code, headers
194
334
  end
195
335
 
336
+ # Delete an inbox connector IMAP connection
337
+ # Delete IMAP connection for external inbox
338
+ # @param id [String]
339
+ # @param [Hash] opts the optional parameters
340
+ # @return [nil]
341
+ def delete_connector_imap_connection(id, opts = {})
342
+ delete_connector_imap_connection_with_http_info(id, opts)
343
+ nil
344
+ end
345
+
346
+ # Delete an inbox connector IMAP connection
347
+ # Delete IMAP connection for external inbox
348
+ # @param id [String]
349
+ # @param [Hash] opts the optional parameters
350
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
351
+ def delete_connector_imap_connection_with_http_info(id, opts = {})
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug 'Calling API: ConnectorControllerApi.delete_connector_imap_connection ...'
354
+ end
355
+ # verify the required parameter 'id' is set
356
+ if @api_client.config.client_side_validation && id.nil?
357
+ fail ArgumentError, "Missing the required parameter 'id' when calling ConnectorControllerApi.delete_connector_imap_connection"
358
+ end
359
+ # resource path
360
+ local_var_path = '/connectors/{id}/imap'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
361
+
362
+ # query parameters
363
+ query_params = opts[:query_params] || {}
364
+
365
+ # header parameters
366
+ header_params = opts[:header_params] || {}
367
+
368
+ # form parameters
369
+ form_params = opts[:form_params] || {}
370
+
371
+ # http body (model)
372
+ post_body = opts[:body]
373
+
374
+ # return_type
375
+ return_type = opts[:return_type]
376
+
377
+ # auth_names
378
+ auth_names = opts[:auth_names] || ['API_KEY']
379
+
380
+ new_options = opts.merge(
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names,
386
+ :return_type => return_type
387
+ )
388
+
389
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug "API called: ConnectorControllerApi#delete_connector_imap_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
392
+ end
393
+ return data, status_code, headers
394
+ end
395
+
396
+ # Delete an inbox connector SMTP connection
397
+ # Delete SMTP connection for external inbox
398
+ # @param id [String]
399
+ # @param [Hash] opts the optional parameters
400
+ # @return [nil]
401
+ def delete_connector_smtp_connection(id, opts = {})
402
+ delete_connector_smtp_connection_with_http_info(id, opts)
403
+ nil
404
+ end
405
+
406
+ # Delete an inbox connector SMTP connection
407
+ # Delete SMTP connection for external inbox
408
+ # @param id [String]
409
+ # @param [Hash] opts the optional parameters
410
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
411
+ def delete_connector_smtp_connection_with_http_info(id, opts = {})
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug 'Calling API: ConnectorControllerApi.delete_connector_smtp_connection ...'
414
+ end
415
+ # verify the required parameter 'id' is set
416
+ if @api_client.config.client_side_validation && id.nil?
417
+ fail ArgumentError, "Missing the required parameter 'id' when calling ConnectorControllerApi.delete_connector_smtp_connection"
418
+ end
419
+ # resource path
420
+ local_var_path = '/connectors/{id}/smtp'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
421
+
422
+ # query parameters
423
+ query_params = opts[:query_params] || {}
424
+
425
+ # header parameters
426
+ header_params = opts[:header_params] || {}
427
+
428
+ # form parameters
429
+ form_params = opts[:form_params] || {}
430
+
431
+ # http body (model)
432
+ post_body = opts[:body]
433
+
434
+ # return_type
435
+ return_type = opts[:return_type]
436
+
437
+ # auth_names
438
+ auth_names = opts[:auth_names] || ['API_KEY']
439
+
440
+ new_options = opts.merge(
441
+ :header_params => header_params,
442
+ :query_params => query_params,
443
+ :form_params => form_params,
444
+ :body => post_body,
445
+ :auth_names => auth_names,
446
+ :return_type => return_type
447
+ )
448
+
449
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
450
+ if @api_client.config.debugging
451
+ @api_client.config.logger.debug "API called: ConnectorControllerApi#delete_connector_smtp_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
452
+ end
453
+ return data, status_code, headers
454
+ end
455
+
196
456
  # Get all inbox connector sync events
197
457
  # @param [Hash] opts the optional parameters
198
458
  # @option opts [Integer] :page Optional page index in connector list pagination (default to 0)
@@ -207,6 +207,69 @@ module MailSlurpClient
207
207
  return data, status_code, headers
208
208
  end
209
209
 
210
+ # Get all usable domains
211
+ # List all domains available for use with email address creation
212
+ # @param [Hash] opts the optional parameters
213
+ # @option opts [String] :inbox_type
214
+ # @return [DomainGroupsDto]
215
+ def get_available_domains(opts = {})
216
+ data, _status_code, _headers = get_available_domains_with_http_info(opts)
217
+ data
218
+ end
219
+
220
+ # Get all usable domains
221
+ # List all domains available for use with email address creation
222
+ # @param [Hash] opts the optional parameters
223
+ # @option opts [String] :inbox_type
224
+ # @return [Array<(DomainGroupsDto, Integer, Hash)>] DomainGroupsDto data, response status code and response headers
225
+ def get_available_domains_with_http_info(opts = {})
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug 'Calling API: DomainControllerApi.get_available_domains ...'
228
+ end
229
+ allowable_values = ["HTTP_INBOX", "SMTP_INBOX"]
230
+ if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
231
+ fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
232
+ end
233
+ # resource path
234
+ local_var_path = '/domains/available-domains'
235
+
236
+ # query parameters
237
+ query_params = opts[:query_params] || {}
238
+ query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
239
+
240
+ # header parameters
241
+ header_params = opts[:header_params] || {}
242
+ # HTTP header 'Accept' (if needed)
243
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
244
+
245
+ # form parameters
246
+ form_params = opts[:form_params] || {}
247
+
248
+ # http body (model)
249
+ post_body = opts[:body]
250
+
251
+ # return_type
252
+ return_type = opts[:return_type] || 'DomainGroupsDto'
253
+
254
+ # auth_names
255
+ auth_names = opts[:auth_names] || ['API_KEY']
256
+
257
+ new_options = opts.merge(
258
+ :header_params => header_params,
259
+ :query_params => query_params,
260
+ :form_params => form_params,
261
+ :body => post_body,
262
+ :auth_names => auth_names,
263
+ :return_type => return_type
264
+ )
265
+
266
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
267
+ if @api_client.config.debugging
268
+ @api_client.config.logger.debug "API called: DomainControllerApi#get_available_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
269
+ end
270
+ return data, status_code, headers
271
+ end
272
+
210
273
  # Get a domain
211
274
  # Returns domain verification status and tokens for a given domain
212
275
  # @param id [String]
@@ -446,6 +509,69 @@ module MailSlurpClient
446
509
  return data, status_code, headers
447
510
  end
448
511
 
512
+ # Get MailSlurp domains
513
+ # List all MailSlurp domains used with non-custom email addresses
514
+ # @param [Hash] opts the optional parameters
515
+ # @option opts [String] :inbox_type
516
+ # @return [DomainGroupsDto]
517
+ def get_mail_slurp_domains(opts = {})
518
+ data, _status_code, _headers = get_mail_slurp_domains_with_http_info(opts)
519
+ data
520
+ end
521
+
522
+ # Get MailSlurp domains
523
+ # List all MailSlurp domains used with non-custom email addresses
524
+ # @param [Hash] opts the optional parameters
525
+ # @option opts [String] :inbox_type
526
+ # @return [Array<(DomainGroupsDto, Integer, Hash)>] DomainGroupsDto data, response status code and response headers
527
+ def get_mail_slurp_domains_with_http_info(opts = {})
528
+ if @api_client.config.debugging
529
+ @api_client.config.logger.debug 'Calling API: DomainControllerApi.get_mail_slurp_domains ...'
530
+ end
531
+ allowable_values = ["HTTP_INBOX", "SMTP_INBOX"]
532
+ if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
533
+ fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
534
+ end
535
+ # resource path
536
+ local_var_path = '/domains/mailslurp-domains'
537
+
538
+ # query parameters
539
+ query_params = opts[:query_params] || {}
540
+ query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
541
+
542
+ # header parameters
543
+ header_params = opts[:header_params] || {}
544
+ # HTTP header 'Accept' (if needed)
545
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
546
+
547
+ # form parameters
548
+ form_params = opts[:form_params] || {}
549
+
550
+ # http body (model)
551
+ post_body = opts[:body]
552
+
553
+ # return_type
554
+ return_type = opts[:return_type] || 'DomainGroupsDto'
555
+
556
+ # auth_names
557
+ auth_names = opts[:auth_names] || ['API_KEY']
558
+
559
+ new_options = opts.merge(
560
+ :header_params => header_params,
561
+ :query_params => query_params,
562
+ :form_params => form_params,
563
+ :body => post_body,
564
+ :auth_names => auth_names,
565
+ :return_type => return_type
566
+ )
567
+
568
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
569
+ if @api_client.config.debugging
570
+ @api_client.config.logger.debug "API called: DomainControllerApi#get_mail_slurp_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
571
+ end
572
+ return data, status_code, headers
573
+ end
574
+
449
575
  # Update a domain
450
576
  # 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.
451
577
  # @param id [String]
@@ -1512,6 +1512,144 @@ module MailSlurpClient
1512
1512
  return data, status_code, headers
1513
1513
  end
1514
1514
 
1515
+ # Take a screenshot of an email in a browser and return base64 encoded string
1516
+ # Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.
1517
+ # @param email_id [String]
1518
+ # @param get_email_screenshot_options [GetEmailScreenshotOptions]
1519
+ # @param [Hash] opts the optional parameters
1520
+ # @return [EmailScreenshotResult]
1521
+ def get_email_screenshot_as_base64(email_id, get_email_screenshot_options, opts = {})
1522
+ data, _status_code, _headers = get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts)
1523
+ data
1524
+ end
1525
+
1526
+ # Take a screenshot of an email in a browser and return base64 encoded string
1527
+ # Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.
1528
+ # @param email_id [String]
1529
+ # @param get_email_screenshot_options [GetEmailScreenshotOptions]
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @return [Array<(EmailScreenshotResult, Integer, Hash)>] EmailScreenshotResult data, response status code and response headers
1532
+ def get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts = {})
1533
+ if @api_client.config.debugging
1534
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_screenshot_as_base64 ...'
1535
+ end
1536
+ # verify the required parameter 'email_id' is set
1537
+ if @api_client.config.client_side_validation && email_id.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_screenshot_as_base64"
1539
+ end
1540
+ # verify the required parameter 'get_email_screenshot_options' is set
1541
+ if @api_client.config.client_side_validation && get_email_screenshot_options.nil?
1542
+ fail ArgumentError, "Missing the required parameter 'get_email_screenshot_options' when calling EmailControllerApi.get_email_screenshot_as_base64"
1543
+ end
1544
+ # resource path
1545
+ local_var_path = '/emails/{emailId}/screenshot/base64'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
1546
+
1547
+ # query parameters
1548
+ query_params = opts[:query_params] || {}
1549
+
1550
+ # header parameters
1551
+ header_params = opts[:header_params] || {}
1552
+ # HTTP header 'Accept' (if needed)
1553
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1554
+ # HTTP header 'Content-Type'
1555
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1556
+
1557
+ # form parameters
1558
+ form_params = opts[:form_params] || {}
1559
+
1560
+ # http body (model)
1561
+ post_body = opts[:body] || @api_client.object_to_http_body(get_email_screenshot_options)
1562
+
1563
+ # return_type
1564
+ return_type = opts[:return_type] || 'EmailScreenshotResult'
1565
+
1566
+ # auth_names
1567
+ auth_names = opts[:auth_names] || ['API_KEY']
1568
+
1569
+ new_options = opts.merge(
1570
+ :header_params => header_params,
1571
+ :query_params => query_params,
1572
+ :form_params => form_params,
1573
+ :body => post_body,
1574
+ :auth_names => auth_names,
1575
+ :return_type => return_type
1576
+ )
1577
+
1578
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1579
+ if @api_client.config.debugging
1580
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_screenshot_as_base64\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1581
+ end
1582
+ return data, status_code, headers
1583
+ end
1584
+
1585
+ # Take a screenshot of an email in a browser
1586
+ # Returns binary octet-stream of screenshot of the given email
1587
+ # @param email_id [String]
1588
+ # @param get_email_screenshot_options [GetEmailScreenshotOptions]
1589
+ # @param [Hash] opts the optional parameters
1590
+ # @return [nil]
1591
+ def get_email_screenshot_as_binary(email_id, get_email_screenshot_options, opts = {})
1592
+ get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts)
1593
+ nil
1594
+ end
1595
+
1596
+ # Take a screenshot of an email in a browser
1597
+ # Returns binary octet-stream of screenshot of the given email
1598
+ # @param email_id [String]
1599
+ # @param get_email_screenshot_options [GetEmailScreenshotOptions]
1600
+ # @param [Hash] opts the optional parameters
1601
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1602
+ def get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts = {})
1603
+ if @api_client.config.debugging
1604
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_screenshot_as_binary ...'
1605
+ end
1606
+ # verify the required parameter 'email_id' is set
1607
+ if @api_client.config.client_side_validation && email_id.nil?
1608
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_screenshot_as_binary"
1609
+ end
1610
+ # verify the required parameter 'get_email_screenshot_options' is set
1611
+ if @api_client.config.client_side_validation && get_email_screenshot_options.nil?
1612
+ fail ArgumentError, "Missing the required parameter 'get_email_screenshot_options' when calling EmailControllerApi.get_email_screenshot_as_binary"
1613
+ end
1614
+ # resource path
1615
+ local_var_path = '/emails/{emailId}/screenshot/binary'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
1616
+
1617
+ # query parameters
1618
+ query_params = opts[:query_params] || {}
1619
+
1620
+ # header parameters
1621
+ header_params = opts[:header_params] || {}
1622
+ # HTTP header 'Content-Type'
1623
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1624
+
1625
+ # form parameters
1626
+ form_params = opts[:form_params] || {}
1627
+
1628
+ # http body (model)
1629
+ post_body = opts[:body] || @api_client.object_to_http_body(get_email_screenshot_options)
1630
+
1631
+ # return_type
1632
+ return_type = opts[:return_type]
1633
+
1634
+ # auth_names
1635
+ auth_names = opts[:auth_names] || ['API_KEY']
1636
+
1637
+ new_options = opts.merge(
1638
+ :header_params => header_params,
1639
+ :query_params => query_params,
1640
+ :form_params => form_params,
1641
+ :body => post_body,
1642
+ :auth_names => auth_names,
1643
+ :return_type => return_type
1644
+ )
1645
+
1646
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1647
+ if @api_client.config.debugging
1648
+ @api_client.config.logger.debug "API called: EmailControllerApi#get_email_screenshot_as_binary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1649
+ end
1650
+ return data, status_code, headers
1651
+ end
1652
+
1515
1653
  # Parse and return text from an email, stripping HTML and decoding encoded characters
1516
1654
  # Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
1517
1655
  # @param email_id [String] ID of email to fetch text for