mailslurp_client 15.5.4 → 15.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -11
- data/lib/mailslurp_client/api/api_internal_controller_api.rb +89 -0
- data/lib/mailslurp_client/api/attachment_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/bounce_controller_api.rb +64 -0
- data/lib/mailslurp_client/api/email_verification_controller_api.rb +179 -0
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +2 -2
- data/lib/mailslurp_client/models/alias_projection.rb +13 -13
- data/lib/mailslurp_client/models/attachment_projection.rb +28 -28
- data/lib/mailslurp_client/models/bounce_recipient.rb +0 -5
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +0 -5
- data/lib/mailslurp_client/models/contact_projection.rb +13 -13
- data/lib/mailslurp_client/models/email_projection.rb +23 -23
- data/lib/mailslurp_client/models/email_validation_request.rb +276 -0
- data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb +213 -0
- data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb +213 -0
- data/lib/mailslurp_client/models/get_or_create_saml_user_options.rb +234 -0
- data/lib/mailslurp_client/models/page_alias.rb +19 -19
- data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
- data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
- data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_validation_request.rb +308 -0
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
- data/lib/mailslurp_client/models/send_email_options.rb +36 -4
- data/lib/mailslurp_client/models/sent_email_dto.rb +13 -4
- data/lib/mailslurp_client/models/sent_email_projection.rb +26 -26
- data/lib/mailslurp_client/models/template_projection.rb +18 -18
- data/lib/mailslurp_client/models/thread_projection.rb +15 -15
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +13 -13
- data/lib/mailslurp_client/models/user_dto.rb +438 -0
- data/lib/mailslurp_client/models/validate_email_address_list_options.rb +213 -0
- data/lib/mailslurp_client/models/validate_email_address_list_result.rb +245 -0
- data/lib/mailslurp_client/models/webhook_projection.rb +12 -12
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +10 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6a8c0a72af5e8b9d2cda4c9e7f06f758e8070eae92fa85396029bb527d1d409c
|
4
|
+
data.tar.gz: 66d731754da21857a4ae66cee051db6100007927a6949134a689cd6097ea9574
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3f4305a2e05cb26b720ac2d8e47fd45f202b6ffb19273098ce7743ea297fd7a650623bbcea041ec757e11ca35dbd0a211810f8591fc3444ba68658c273e1880c
|
7
|
+
data.tar.gz: 4abcd7e07cd54e97eaadd6d1df769f349ee67986211c8ea1cde07bf562a9ea5e08a2579d3b95b6f08ee13e17bfc1c5efea692d6e400aee29aa4c59ead862ed8d
|
data/README.md
CHANGED
@@ -6,7 +6,7 @@ MailSlurp is an email API service that lets you create real email addresses in c
|
|
6
6
|
|
7
7
|
## Quick links
|
8
8
|
|
9
|
-
- [Method Documentation](https://
|
9
|
+
- [Method Documentation](https://docs.mailslurp.com/ruby/docs/)
|
10
10
|
- [Gem Package](https://rubygems.org/gems/mailslurp_client)
|
11
11
|
- [Github Source](https://github.com/mailslurp/mailslurp-client-ruby)
|
12
12
|
- [SMTP access details](https://www.mailslurp.com/guides/smtp-imap/)
|
@@ -14,9 +14,9 @@ MailSlurp is an email API service that lets you create real email addresses in c
|
|
14
14
|
|
15
15
|
### Common controllers
|
16
16
|
|
17
|
-
- [Email controller](https://
|
18
|
-
- [Inbox controller](https://
|
19
|
-
- [WaitFor controller](https://
|
17
|
+
- [Email controller](https://docs.mailslurp.com/ruby/docs/EmailControllerApi/) send and receive emails
|
18
|
+
- [Inbox controller](https://docs.mailslurp.com/ruby/docs/InboxControllerApi/) create and manage email addresses
|
19
|
+
- [WaitFor controller](https://docs.mailslurp.com/ruby/docs/WaitForControllerApi/) wait for expected emails to arrive
|
20
20
|
|
21
21
|
|
22
22
|
### Example tutorials
|
@@ -27,7 +27,7 @@ This section describes how to get up and running with the Ruby client.
|
|
27
27
|
|
28
28
|
See the [examples page](https://www.mailslurp.com/examples/) for more examples and use with common frameworks such as Rails and RSpec.
|
29
29
|
|
30
|
-
See the method documentation for a [list of all functions](https://
|
30
|
+
See the method documentation for a [list of all functions](https://docs.mailslurp.com/ruby/docs/)
|
31
31
|
|
32
32
|
### Create API Key
|
33
33
|
|
@@ -82,7 +82,7 @@ Here are some common uses:
|
|
82
82
|
|
83
83
|
### Create inboxes
|
84
84
|
|
85
|
-
To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address. See methods on the [inbox controller](https://
|
85
|
+
To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address. See methods on the [inbox controller](https://docs.mailslurp.com/ruby/docs/InboxControllerApi/) for more information.
|
86
86
|
|
87
87
|
```ruby
|
88
88
|
inbox_controller = MailSlurpClient::InboxControllerApi.new
|
@@ -177,7 +177,7 @@ end
|
|
177
177
|
|
178
178
|
### List inboxes
|
179
179
|
|
180
|
-
Inboxes you create can be listed in a paginated way using the [InboxController](https://
|
180
|
+
Inboxes you create can be listed in a paginated way using the [InboxController](https://docs.mailslurp.com/ruby/docs/InboxControllerApi/)).
|
181
181
|
|
182
182
|
```ruby
|
183
183
|
it 'can list inboxes' do
|
@@ -198,7 +198,7 @@ end
|
|
198
198
|
### Send emails
|
199
199
|
|
200
200
|
You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
|
201
|
-
To send attachments see the [Method Documentation](https://
|
201
|
+
To send attachments see the [Method Documentation](https://docs.mailslurp.com/ruby/docs/).
|
202
202
|
|
203
203
|
```ruby
|
204
204
|
# create an inbox
|
@@ -240,7 +240,7 @@ inbox_controller.send_email(inbox_1.id, opts)
|
|
240
240
|
|
241
241
|
### Receive emails
|
242
242
|
|
243
|
-
To read already existing emails use the [Email Controller](https://
|
243
|
+
To read already existing emails use the [Email Controller](https://docs.mailslurp.com/ruby/docs/EmailControllerApi/). To wait for expected emails to arrive use the [WaitFor Controller](https://docs.mailslurp.com/ruby/docs/WaitForControllerApi/).
|
244
244
|
You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
|
245
245
|
If a timeout is exceeded it will throw an error instead:
|
246
246
|
|
@@ -274,7 +274,7 @@ code, * = match.captures
|
|
274
274
|
|
275
275
|
### Attachments
|
276
276
|
|
277
|
-
You can send attachments by first uploading files with the [AttachmentControllerApi](https://
|
277
|
+
You can send attachments by first uploading files with the [AttachmentControllerApi](https://docs.mailslurp.com/ruby/docs/AttachmentControllerApi/) then using the returned attachment IDs in the send email method.
|
278
278
|
|
279
279
|
MailSlurp endpoints use base64 string encoding for upload and download files. To encode or decode strings in Ruby make sure you use the **strict** variables that avoid added newlines.
|
280
280
|
|
@@ -420,4 +420,4 @@ end
|
|
420
420
|
|
421
421
|
## SDK Documentation
|
422
422
|
|
423
|
-
See the [examples page](https://www.mailslurp.com/examples/) or the full [Method Documentation](https://
|
423
|
+
See the [examples page](https://www.mailslurp.com/examples/) or the full [Method Documentation](https://docs.mailslurp.com/ruby/docs/) on Github.
|
@@ -0,0 +1,89 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 6.5.2
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MailSlurpClient
|
16
|
+
class ApiInternalControllerApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# @param key [String]
|
23
|
+
# @param get_or_create_saml_user_options [GetOrCreateSamlUserOptions]
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [UserDto]
|
26
|
+
def get_saml_user_or_create(key, get_or_create_saml_user_options, opts = {})
|
27
|
+
data, _status_code, _headers = get_saml_user_or_create_with_http_info(key, get_or_create_saml_user_options, opts)
|
28
|
+
data
|
29
|
+
end
|
30
|
+
|
31
|
+
# @param key [String]
|
32
|
+
# @param get_or_create_saml_user_options [GetOrCreateSamlUserOptions]
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(UserDto, Integer, Hash)>] UserDto data, response status code and response headers
|
35
|
+
def get_saml_user_or_create_with_http_info(key, get_or_create_saml_user_options, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: ApiInternalControllerApi.get_saml_user_or_create ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'key' is set
|
40
|
+
if @api_client.config.client_side_validation && key.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'key' when calling ApiInternalControllerApi.get_saml_user_or_create"
|
42
|
+
end
|
43
|
+
# verify the required parameter 'get_or_create_saml_user_options' is set
|
44
|
+
if @api_client.config.client_side_validation && get_or_create_saml_user_options.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'get_or_create_saml_user_options' when calling ApiInternalControllerApi.get_saml_user_or_create"
|
46
|
+
end
|
47
|
+
# resource path
|
48
|
+
local_var_path = '/internal/saml/user'
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = opts[:query_params] || {}
|
52
|
+
query_params[:'key'] = key
|
53
|
+
|
54
|
+
# header parameters
|
55
|
+
header_params = opts[:header_params] || {}
|
56
|
+
# HTTP header 'Accept' (if needed)
|
57
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
58
|
+
# HTTP header 'Content-Type'
|
59
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
60
|
+
|
61
|
+
# form parameters
|
62
|
+
form_params = opts[:form_params] || {}
|
63
|
+
|
64
|
+
# http body (model)
|
65
|
+
post_body = opts[:body] || @api_client.object_to_http_body(get_or_create_saml_user_options)
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:return_type] || 'UserDto'
|
69
|
+
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
72
|
+
|
73
|
+
new_options = opts.merge(
|
74
|
+
:header_params => header_params,
|
75
|
+
:query_params => query_params,
|
76
|
+
:form_params => form_params,
|
77
|
+
:body => post_body,
|
78
|
+
:auth_names => auth_names,
|
79
|
+
:return_type => return_type
|
80
|
+
)
|
81
|
+
|
82
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
83
|
+
if @api_client.config.debugging
|
84
|
+
@api_client.config.logger.debug "API called: ApiInternalControllerApi#get_saml_user_or_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
85
|
+
end
|
86
|
+
return data, status_code, headers
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
@@ -545,7 +545,6 @@ module MailSlurpClient
|
|
545
545
|
|
546
546
|
# query parameters
|
547
547
|
query_params = opts[:query_params] || {}
|
548
|
-
query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
|
549
548
|
query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
|
550
549
|
|
551
550
|
# header parameters
|
@@ -554,6 +553,7 @@ module MailSlurpClient
|
|
554
553
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
555
554
|
# HTTP header 'Content-Type'
|
556
555
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
|
556
|
+
header_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
|
557
557
|
|
558
558
|
# form parameters
|
559
559
|
form_params = opts[:form_params] || {}
|
@@ -19,6 +19,70 @@ module MailSlurpClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Filter a list of email recipients and remove those who have bounced
|
23
|
+
# Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
|
24
|
+
# @param filter_bounced_recipients_options [FilterBouncedRecipientsOptions]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [FilterBouncedRecipientsResult]
|
27
|
+
def filter_bounced_recipient(filter_bounced_recipients_options, opts = {})
|
28
|
+
data, _status_code, _headers = filter_bounced_recipient_with_http_info(filter_bounced_recipients_options, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Filter a list of email recipients and remove those who have bounced
|
33
|
+
# Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
|
34
|
+
# @param filter_bounced_recipients_options [FilterBouncedRecipientsOptions]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(FilterBouncedRecipientsResult, Integer, Hash)>] FilterBouncedRecipientsResult data, response status code and response headers
|
37
|
+
def filter_bounced_recipient_with_http_info(filter_bounced_recipients_options, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: BounceControllerApi.filter_bounced_recipient ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'filter_bounced_recipients_options' is set
|
42
|
+
if @api_client.config.client_side_validation && filter_bounced_recipients_options.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'filter_bounced_recipients_options' when calling BounceControllerApi.filter_bounced_recipient"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/bounce/filter-recipients'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = opts[:form_params] || {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(filter_bounced_recipients_options)
|
63
|
+
|
64
|
+
# return_type
|
65
|
+
return_type = opts[:return_type] || 'FilterBouncedRecipientsResult'
|
66
|
+
|
67
|
+
# auth_names
|
68
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
69
|
+
|
70
|
+
new_options = opts.merge(
|
71
|
+
:header_params => header_params,
|
72
|
+
:query_params => query_params,
|
73
|
+
:form_params => form_params,
|
74
|
+
:body => post_body,
|
75
|
+
:auth_names => auth_names,
|
76
|
+
:return_type => return_type
|
77
|
+
)
|
78
|
+
|
79
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
80
|
+
if @api_client.config.debugging
|
81
|
+
@api_client.config.logger.debug "API called: BounceControllerApi#filter_bounced_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
82
|
+
end
|
83
|
+
return data, status_code, headers
|
84
|
+
end
|
85
|
+
|
22
86
|
# Get a bounced email.
|
23
87
|
# Bounced emails are email you have sent that were rejected by a recipient
|
24
88
|
# @param id [String] ID of the bounced email to fetch
|
@@ -0,0 +1,179 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 6.5.2
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MailSlurpClient
|
16
|
+
class EmailVerificationControllerApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @option opts [Integer] :page Optional page index in list pagination (default to 0)
|
25
|
+
# @option opts [Integer] :size Optional page size for paginated result list. (default to 20)
|
26
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'DESC')
|
27
|
+
# @option opts [String] :search_filter Optional search filter
|
28
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
29
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
30
|
+
# @option opts [Boolean] :is_valid Filter where email is valid is true or false
|
31
|
+
# @return [PageEmailValidationRequest]
|
32
|
+
def get_validation_requests(opts = {})
|
33
|
+
data, _status_code, _headers = get_validation_requests_with_http_info(opts)
|
34
|
+
data
|
35
|
+
end
|
36
|
+
|
37
|
+
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [Integer] :page Optional page index in list pagination
|
40
|
+
# @option opts [Integer] :size Optional page size for paginated result list.
|
41
|
+
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
42
|
+
# @option opts [String] :search_filter Optional search filter
|
43
|
+
# @option opts [DateTime] :since Filter by created at after the given timestamp
|
44
|
+
# @option opts [DateTime] :before Filter by created at before the given timestamp
|
45
|
+
# @option opts [Boolean] :is_valid Filter where email is valid is true or false
|
46
|
+
# @return [Array<(PageEmailValidationRequest, Integer, Hash)>] PageEmailValidationRequest data, response status code and response headers
|
47
|
+
def get_validation_requests_with_http_info(opts = {})
|
48
|
+
if @api_client.config.debugging
|
49
|
+
@api_client.config.logger.debug 'Calling API: EmailVerificationControllerApi.get_validation_requests ...'
|
50
|
+
end
|
51
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 9223372036854775807
|
52
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EmailVerificationControllerApi.get_validation_requests, must be smaller than or equal to 9223372036854775807.'
|
53
|
+
end
|
54
|
+
|
55
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EmailVerificationControllerApi.get_validation_requests, must be greater than or equal to 0.'
|
57
|
+
end
|
58
|
+
|
59
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
60
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailVerificationControllerApi.get_validation_requests, must be smaller than or equal to 100.'
|
61
|
+
end
|
62
|
+
|
63
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
|
64
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailVerificationControllerApi.get_validation_requests, must be greater than or equal to 1.'
|
65
|
+
end
|
66
|
+
|
67
|
+
allowable_values = ["ASC", "DESC"]
|
68
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
69
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
70
|
+
end
|
71
|
+
# resource path
|
72
|
+
local_var_path = '/email-verification/validation-requests'
|
73
|
+
|
74
|
+
# query parameters
|
75
|
+
query_params = opts[:query_params] || {}
|
76
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
77
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
78
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
79
|
+
query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
|
80
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
81
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
82
|
+
query_params[:'isValid'] = opts[:'is_valid'] if !opts[:'is_valid'].nil?
|
83
|
+
|
84
|
+
# header parameters
|
85
|
+
header_params = opts[:header_params] || {}
|
86
|
+
# HTTP header 'Accept' (if needed)
|
87
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
88
|
+
|
89
|
+
# form parameters
|
90
|
+
form_params = opts[:form_params] || {}
|
91
|
+
|
92
|
+
# http body (model)
|
93
|
+
post_body = opts[:body]
|
94
|
+
|
95
|
+
# return_type
|
96
|
+
return_type = opts[:return_type] || 'PageEmailValidationRequest'
|
97
|
+
|
98
|
+
# auth_names
|
99
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
100
|
+
|
101
|
+
new_options = opts.merge(
|
102
|
+
:header_params => header_params,
|
103
|
+
:query_params => query_params,
|
104
|
+
:form_params => form_params,
|
105
|
+
:body => post_body,
|
106
|
+
:auth_names => auth_names,
|
107
|
+
:return_type => return_type
|
108
|
+
)
|
109
|
+
|
110
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
111
|
+
if @api_client.config.debugging
|
112
|
+
@api_client.config.logger.debug "API called: EmailVerificationControllerApi#get_validation_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
113
|
+
end
|
114
|
+
return data, status_code, headers
|
115
|
+
end
|
116
|
+
|
117
|
+
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
|
118
|
+
# @param validate_email_address_list_options [ValidateEmailAddressListOptions]
|
119
|
+
# @param [Hash] opts the optional parameters
|
120
|
+
# @return [ValidateEmailAddressListResult]
|
121
|
+
def validate_email_address_list(validate_email_address_list_options, opts = {})
|
122
|
+
data, _status_code, _headers = validate_email_address_list_with_http_info(validate_email_address_list_options, opts)
|
123
|
+
data
|
124
|
+
end
|
125
|
+
|
126
|
+
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
|
127
|
+
# @param validate_email_address_list_options [ValidateEmailAddressListOptions]
|
128
|
+
# @param [Hash] opts the optional parameters
|
129
|
+
# @return [Array<(ValidateEmailAddressListResult, Integer, Hash)>] ValidateEmailAddressListResult data, response status code and response headers
|
130
|
+
def validate_email_address_list_with_http_info(validate_email_address_list_options, opts = {})
|
131
|
+
if @api_client.config.debugging
|
132
|
+
@api_client.config.logger.debug 'Calling API: EmailVerificationControllerApi.validate_email_address_list ...'
|
133
|
+
end
|
134
|
+
# verify the required parameter 'validate_email_address_list_options' is set
|
135
|
+
if @api_client.config.client_side_validation && validate_email_address_list_options.nil?
|
136
|
+
fail ArgumentError, "Missing the required parameter 'validate_email_address_list_options' when calling EmailVerificationControllerApi.validate_email_address_list"
|
137
|
+
end
|
138
|
+
# resource path
|
139
|
+
local_var_path = '/email-verification/email-address-list'
|
140
|
+
|
141
|
+
# query parameters
|
142
|
+
query_params = opts[:query_params] || {}
|
143
|
+
|
144
|
+
# header parameters
|
145
|
+
header_params = opts[:header_params] || {}
|
146
|
+
# HTTP header 'Accept' (if needed)
|
147
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
148
|
+
# HTTP header 'Content-Type'
|
149
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
150
|
+
|
151
|
+
# form parameters
|
152
|
+
form_params = opts[:form_params] || {}
|
153
|
+
|
154
|
+
# http body (model)
|
155
|
+
post_body = opts[:body] || @api_client.object_to_http_body(validate_email_address_list_options)
|
156
|
+
|
157
|
+
# return_type
|
158
|
+
return_type = opts[:return_type] || 'ValidateEmailAddressListResult'
|
159
|
+
|
160
|
+
# auth_names
|
161
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
162
|
+
|
163
|
+
new_options = opts.merge(
|
164
|
+
:header_params => header_params,
|
165
|
+
:query_params => query_params,
|
166
|
+
:form_params => form_params,
|
167
|
+
:body => post_body,
|
168
|
+
:auth_names => auth_names,
|
169
|
+
:return_type => return_type
|
170
|
+
)
|
171
|
+
|
172
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
173
|
+
if @api_client.config.debugging
|
174
|
+
@api_client.config.logger.debug "API called: EmailVerificationControllerApi#validate_email_address_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
175
|
+
end
|
176
|
+
return data, status_code, headers
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
@@ -204,7 +204,7 @@ module MailSlurpClient
|
|
204
204
|
return data, status_code, headers
|
205
205
|
end
|
206
206
|
|
207
|
-
# Verify the existence of an email address at a given mail server.
|
207
|
+
# Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
|
208
208
|
# @param verify_email_address_options [VerifyEmailAddressOptions]
|
209
209
|
# @param [Hash] opts the optional parameters
|
210
210
|
# @return [EmailVerificationResult]
|
@@ -213,7 +213,7 @@ module MailSlurpClient
|
|
213
213
|
data
|
214
214
|
end
|
215
215
|
|
216
|
-
# Verify the existence of an email address at a given mail server.
|
216
|
+
# Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
|
217
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
|
@@ -27,10 +27,10 @@ module MailSlurpClient
|
|
27
27
|
|
28
28
|
attr_accessor :created_at
|
29
29
|
|
30
|
-
attr_accessor :use_threads
|
31
|
-
|
32
30
|
attr_accessor :updated_at
|
33
31
|
|
32
|
+
attr_accessor :use_threads
|
33
|
+
|
34
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
35
35
|
def self.attribute_map
|
36
36
|
{
|
@@ -40,8 +40,8 @@ module MailSlurpClient
|
|
40
40
|
:'email_address' => :'emailAddress',
|
41
41
|
:'inbox_id' => :'inboxId',
|
42
42
|
:'created_at' => :'createdAt',
|
43
|
-
:'
|
44
|
-
:'
|
43
|
+
:'updated_at' => :'updatedAt',
|
44
|
+
:'use_threads' => :'useThreads'
|
45
45
|
}
|
46
46
|
end
|
47
47
|
|
@@ -54,8 +54,8 @@ module MailSlurpClient
|
|
54
54
|
:'email_address' => :'String',
|
55
55
|
:'inbox_id' => :'String',
|
56
56
|
:'created_at' => :'DateTime',
|
57
|
-
:'
|
58
|
-
:'
|
57
|
+
:'updated_at' => :'DateTime',
|
58
|
+
:'use_threads' => :'Boolean'
|
59
59
|
}
|
60
60
|
end
|
61
61
|
|
@@ -104,13 +104,13 @@ module MailSlurpClient
|
|
104
104
|
self.created_at = attributes[:'created_at']
|
105
105
|
end
|
106
106
|
|
107
|
-
if attributes.key?(:'use_threads')
|
108
|
-
self.use_threads = attributes[:'use_threads']
|
109
|
-
end
|
110
|
-
|
111
107
|
if attributes.key?(:'updated_at')
|
112
108
|
self.updated_at = attributes[:'updated_at']
|
113
109
|
end
|
110
|
+
|
111
|
+
if attributes.key?(:'use_threads')
|
112
|
+
self.use_threads = attributes[:'use_threads']
|
113
|
+
end
|
114
114
|
end
|
115
115
|
|
116
116
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -167,8 +167,8 @@ module MailSlurpClient
|
|
167
167
|
email_address == o.email_address &&
|
168
168
|
inbox_id == o.inbox_id &&
|
169
169
|
created_at == o.created_at &&
|
170
|
-
|
171
|
-
|
170
|
+
updated_at == o.updated_at &&
|
171
|
+
use_threads == o.use_threads
|
172
172
|
end
|
173
173
|
|
174
174
|
# @see the `==` method
|
@@ -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
|
-
[name, id, user_id, email_address, inbox_id, created_at,
|
183
|
+
[name, id, user_id, email_address, inbox_id, created_at, updated_at, use_threads].hash
|
184
184
|
end
|
185
185
|
|
186
186
|
# Builds the object from hash
|