mailslurp_client 15.5.1 → 15.5.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +53 -11
- data/lib/mailslurp_client/api/attachment_controller_api.rb +1 -1
- data/lib/mailslurp_client/api/email_controller_api.rb +68 -6
- data/lib/mailslurp_client/api/inbox_controller_api.rb +70 -0
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +186 -0
- data/lib/mailslurp_client/models/alias_projection.rb +13 -13
- data/lib/mailslurp_client/models/attachment_projection.rb +15 -15
- data/lib/mailslurp_client/models/email_preview_urls.rb +225 -0
- data/lib/mailslurp_client/models/template_projection.rb +15 -15
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +1 -0
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a4c1edd7d2313f6dfb7fb30cce0befaeb0fc1c63a1c2dceda5e1e0a807d5a1a8
|
4
|
+
data.tar.gz: 2de675537c0d500cc406e03b44eee3c92b7cb375b9fd6dd260821cc983c400c3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 89bd585939760abc3b0c80227a7f3e0f47b8379e05efb51f5f16ec9f1991b30da71d017d647e022f3bb250835436df160aa0693033ef7bc906b56c4864fcf176
|
7
|
+
data.tar.gz: 98d00e767665363cac6a1da4dbd7c09796f8fec4c0c77747f6f25e6c873386bdb96e78bd790a5954da14ab7f61196bedeb9ab91b16ca7ac3ff3216d9d71db3e3
|
data/README.md
CHANGED
@@ -6,15 +6,17 @@ 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
|
+
- [SMTP access details](https://www.mailslurp.com/guides/smtp-imap/)
|
13
|
+
- [Send email in Ruby with SMTP](https://www.mailslurp.com/smtp/ruby-send-email-smtp/)
|
12
14
|
|
13
15
|
### Common controllers
|
14
16
|
|
15
|
-
- [Email controller](https://
|
16
|
-
- [Inbox controller](https://
|
17
|
-
- [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
|
18
20
|
|
19
21
|
|
20
22
|
### Example tutorials
|
@@ -25,7 +27,7 @@ This section describes how to get up and running with the Ruby client.
|
|
25
27
|
|
26
28
|
See the [examples page](https://www.mailslurp.com/examples/) for more examples and use with common frameworks such as Rails and RSpec.
|
27
29
|
|
28
|
-
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/)
|
29
31
|
|
30
32
|
### Create API Key
|
31
33
|
|
@@ -80,7 +82,7 @@ Here are some common uses:
|
|
80
82
|
|
81
83
|
### Create inboxes
|
82
84
|
|
83
|
-
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.
|
84
86
|
|
85
87
|
```ruby
|
86
88
|
inbox_controller = MailSlurpClient::InboxControllerApi.new
|
@@ -133,9 +135,49 @@ end
|
|
133
135
|
|
134
136
|
Inboxes can be either `SMTP` or `HTTP` type. Set the inbox type using the `inboxType` property. SMTP inboxes are handled by a custom mailserver and support a wide range of clients while HTTP inboxes use Amazon SES and don't support some older clients like Outlook. SMTP inboxes are recommended for public facing email addresses while HTTP inboxes are best for application testing. Please see the guide on [types of inboxes](https://www.mailslurp.com/guides/smtp-vs-http-email-inboxes/) for more information.
|
135
137
|
|
138
|
+
|
139
|
+
### Configure NET/SMTP access
|
140
|
+
SMTP type inboxes allow SMTP and IMAP access using unique host, port, password, and username. Use the `inbox_controller.get_imap_smtp_access` method to access SMTP credentials. Then configure `net/smtp` in Ruby to send email using SMTP.
|
141
|
+
|
142
|
+
```ruby
|
143
|
+
it 'can send email using SMTP' do
|
144
|
+
inbox_controller = MailSlurpClient::InboxControllerApi.new
|
145
|
+
|
146
|
+
# create two inboxes
|
147
|
+
inbox1 = inbox_controller.create_inbox_with_options({ inboxType: 'SMTP_INBOX' })
|
148
|
+
inbox2 = inbox_controller.create_inbox
|
149
|
+
|
150
|
+
expect(inbox1.email_address).to include('@mailslurp.mx')
|
151
|
+
|
152
|
+
# get smtp access for inbox
|
153
|
+
smtp_access = inbox_controller.get_imap_smtp_access({ inbox_id: inbox1.id })
|
154
|
+
|
155
|
+
# compose email
|
156
|
+
message = <<~MESSAGE_END
|
157
|
+
From: #{inbox1.email_address}
|
158
|
+
To: #{inbox2.email_address}
|
159
|
+
Subject: Test smtp email
|
160
|
+
|
161
|
+
This is a test
|
162
|
+
MESSAGE_END
|
163
|
+
|
164
|
+
# configure SMTP with host port and "PLAIN" authentication
|
165
|
+
Net::SMTP.start(smtp_access.smtp_server_host, smtp_access.smtp_server_port, 'greeting.your.domain',
|
166
|
+
smtp_access.smtp_username, smtp_access.smtp_password, :plain) do |smtp|
|
167
|
+
# send email
|
168
|
+
smtp.send_message message, inbox1.email_address, inbox2.email_address
|
169
|
+
end
|
170
|
+
|
171
|
+
# now confirm email was sent
|
172
|
+
wait_for_controller = MailSlurpClient::WaitForControllerApi.new
|
173
|
+
email = wait_for_controller.wait_for_latest_email({ inbox_id: inbox2.id })
|
174
|
+
expect(email.subject).to include("Test smtp email")
|
175
|
+
end
|
176
|
+
```
|
177
|
+
|
136
178
|
### List inboxes
|
137
179
|
|
138
|
-
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/)).
|
139
181
|
|
140
182
|
```ruby
|
141
183
|
it 'can list inboxes' do
|
@@ -156,7 +198,7 @@ end
|
|
156
198
|
### Send emails
|
157
199
|
|
158
200
|
You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
|
159
|
-
To send attachments see the [Method Documentation](https://
|
201
|
+
To send attachments see the [Method Documentation](https://docs.mailslurp.com/ruby/docs/).
|
160
202
|
|
161
203
|
```ruby
|
162
204
|
# create an inbox
|
@@ -198,7 +240,7 @@ inbox_controller.send_email(inbox_1.id, opts)
|
|
198
240
|
|
199
241
|
### Receive emails
|
200
242
|
|
201
|
-
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/).
|
202
244
|
You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
|
203
245
|
If a timeout is exceeded it will throw an error instead:
|
204
246
|
|
@@ -232,7 +274,7 @@ code, * = match.captures
|
|
232
274
|
|
233
275
|
### Attachments
|
234
276
|
|
235
|
-
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.
|
236
278
|
|
237
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.
|
238
280
|
|
@@ -378,4 +420,4 @@ end
|
|
378
420
|
|
379
421
|
## SDK Documentation
|
380
422
|
|
381
|
-
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.
|
@@ -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] || {}
|
@@ -1051,6 +1051,68 @@ module MailSlurpClient
|
|
1051
1051
|
return data, status_code, headers
|
1052
1052
|
end
|
1053
1053
|
|
1054
|
+
# Get email URLs for viewing in browser or downloading
|
1055
|
+
# Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
1056
|
+
# @param email_id [String]
|
1057
|
+
# @param [Hash] opts the optional parameters
|
1058
|
+
# @return [EmailPreviewUrls]
|
1059
|
+
def get_email_preview_ur_ls(email_id, opts = {})
|
1060
|
+
data, _status_code, _headers = get_email_preview_ur_ls_with_http_info(email_id, opts)
|
1061
|
+
data
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Get email URLs for viewing in browser or downloading
|
1065
|
+
# Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
1066
|
+
# @param email_id [String]
|
1067
|
+
# @param [Hash] opts the optional parameters
|
1068
|
+
# @return [Array<(EmailPreviewUrls, Integer, Hash)>] EmailPreviewUrls data, response status code and response headers
|
1069
|
+
def get_email_preview_ur_ls_with_http_info(email_id, opts = {})
|
1070
|
+
if @api_client.config.debugging
|
1071
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_preview_ur_ls ...'
|
1072
|
+
end
|
1073
|
+
# verify the required parameter 'email_id' is set
|
1074
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
1075
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_preview_ur_ls"
|
1076
|
+
end
|
1077
|
+
# resource path
|
1078
|
+
local_var_path = '/emails/{emailId}/urls'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
1079
|
+
|
1080
|
+
# query parameters
|
1081
|
+
query_params = opts[:query_params] || {}
|
1082
|
+
|
1083
|
+
# header parameters
|
1084
|
+
header_params = opts[:header_params] || {}
|
1085
|
+
# HTTP header 'Accept' (if needed)
|
1086
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1087
|
+
|
1088
|
+
# form parameters
|
1089
|
+
form_params = opts[:form_params] || {}
|
1090
|
+
|
1091
|
+
# http body (model)
|
1092
|
+
post_body = opts[:body]
|
1093
|
+
|
1094
|
+
# return_type
|
1095
|
+
return_type = opts[:return_type] || 'EmailPreviewUrls'
|
1096
|
+
|
1097
|
+
# auth_names
|
1098
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1099
|
+
|
1100
|
+
new_options = opts.merge(
|
1101
|
+
:header_params => header_params,
|
1102
|
+
:query_params => query_params,
|
1103
|
+
:form_params => form_params,
|
1104
|
+
:body => post_body,
|
1105
|
+
:auth_names => auth_names,
|
1106
|
+
:return_type => return_type
|
1107
|
+
)
|
1108
|
+
|
1109
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1110
|
+
if @api_client.config.debugging
|
1111
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_email_preview_ur_ls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1112
|
+
end
|
1113
|
+
return data, status_code, headers
|
1114
|
+
end
|
1115
|
+
|
1054
1116
|
# Parse and return text from an email, stripping HTML and decoding encoded characters
|
1055
1117
|
# Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
|
1056
1118
|
# @param email_id [String] ID of email to fetch text for
|
@@ -1335,8 +1397,8 @@ module MailSlurpClient
|
|
1335
1397
|
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1336
1398
|
# @param [Hash] opts the optional parameters
|
1337
1399
|
# @return [Email]
|
1338
|
-
def
|
1339
|
-
data, _status_code, _headers =
|
1400
|
+
def get_latest_email_in_inbox1(inbox_id, opts = {})
|
1401
|
+
data, _status_code, _headers = get_latest_email_in_inbox1_with_http_info(inbox_id, opts)
|
1340
1402
|
data
|
1341
1403
|
end
|
1342
1404
|
|
@@ -1345,13 +1407,13 @@ module MailSlurpClient
|
|
1345
1407
|
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1346
1408
|
# @param [Hash] opts the optional parameters
|
1347
1409
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
1348
|
-
def
|
1410
|
+
def get_latest_email_in_inbox1_with_http_info(inbox_id, opts = {})
|
1349
1411
|
if @api_client.config.debugging
|
1350
|
-
@api_client.config.logger.debug 'Calling API: EmailControllerApi.
|
1412
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email_in_inbox1 ...'
|
1351
1413
|
end
|
1352
1414
|
# verify the required parameter 'inbox_id' is set
|
1353
1415
|
if @api_client.config.client_side_validation && inbox_id.nil?
|
1354
|
-
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling EmailControllerApi.
|
1416
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling EmailControllerApi.get_latest_email_in_inbox1"
|
1355
1417
|
end
|
1356
1418
|
# resource path
|
1357
1419
|
local_var_path = '/emails/latestIn'
|
@@ -1388,7 +1450,7 @@ module MailSlurpClient
|
|
1388
1450
|
|
1389
1451
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1390
1452
|
if @api_client.config.debugging
|
1391
|
-
@api_client.config.logger.debug "API called: EmailControllerApi#
|
1453
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_latest_email_in_inbox1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1392
1454
|
end
|
1393
1455
|
return data, status_code, headers
|
1394
1456
|
end
|
@@ -1370,6 +1370,76 @@ module MailSlurpClient
|
|
1370
1370
|
return data, status_code, headers
|
1371
1371
|
end
|
1372
1372
|
|
1373
|
+
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
1374
|
+
# Get the newest email in an inbox or wait for one to arrive
|
1375
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1376
|
+
# @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
|
1377
|
+
# @param [Hash] opts the optional parameters
|
1378
|
+
# @return [Email]
|
1379
|
+
def get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {})
|
1380
|
+
data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts)
|
1381
|
+
data
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
1385
|
+
# Get the newest email in an inbox or wait for one to arrive
|
1386
|
+
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
1387
|
+
# @param timeout_millis [Integer] Timeout milliseconds to wait for latest email
|
1388
|
+
# @param [Hash] opts the optional parameters
|
1389
|
+
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
1390
|
+
def get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {})
|
1391
|
+
if @api_client.config.debugging
|
1392
|
+
@api_client.config.logger.debug 'Calling API: InboxControllerApi.get_latest_email_in_inbox ...'
|
1393
|
+
end
|
1394
|
+
# verify the required parameter 'inbox_id' is set
|
1395
|
+
if @api_client.config.client_side_validation && inbox_id.nil?
|
1396
|
+
fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_latest_email_in_inbox"
|
1397
|
+
end
|
1398
|
+
# verify the required parameter 'timeout_millis' is set
|
1399
|
+
if @api_client.config.client_side_validation && timeout_millis.nil?
|
1400
|
+
fail ArgumentError, "Missing the required parameter 'timeout_millis' when calling InboxControllerApi.get_latest_email_in_inbox"
|
1401
|
+
end
|
1402
|
+
# resource path
|
1403
|
+
local_var_path = '/inboxes/getLatestEmail'
|
1404
|
+
|
1405
|
+
# query parameters
|
1406
|
+
query_params = opts[:query_params] || {}
|
1407
|
+
query_params[:'inboxId'] = inbox_id
|
1408
|
+
query_params[:'timeoutMillis'] = timeout_millis
|
1409
|
+
|
1410
|
+
# header parameters
|
1411
|
+
header_params = opts[:header_params] || {}
|
1412
|
+
# HTTP header 'Accept' (if needed)
|
1413
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
1414
|
+
|
1415
|
+
# form parameters
|
1416
|
+
form_params = opts[:form_params] || {}
|
1417
|
+
|
1418
|
+
# http body (model)
|
1419
|
+
post_body = opts[:body]
|
1420
|
+
|
1421
|
+
# return_type
|
1422
|
+
return_type = opts[:return_type] || 'Email'
|
1423
|
+
|
1424
|
+
# auth_names
|
1425
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
1426
|
+
|
1427
|
+
new_options = opts.merge(
|
1428
|
+
:header_params => header_params,
|
1429
|
+
:query_params => query_params,
|
1430
|
+
:form_params => form_params,
|
1431
|
+
:body => post_body,
|
1432
|
+
:auth_names => auth_names,
|
1433
|
+
:return_type => return_type
|
1434
|
+
)
|
1435
|
+
|
1436
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1437
|
+
if @api_client.config.debugging
|
1438
|
+
@api_client.config.logger.debug "API called: InboxControllerApi#get_latest_email_in_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1439
|
+
end
|
1440
|
+
return data, status_code, headers
|
1441
|
+
end
|
1442
|
+
|
1373
1443
|
# List Organization Inboxes Paginated
|
1374
1444
|
# List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
|
1375
1445
|
# @param [Hash] opts the optional parameters
|
@@ -205,6 +205,130 @@ module MailSlurpClient
|
|
205
205
|
return data, status_code, headers
|
206
206
|
end
|
207
207
|
|
208
|
+
# Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
|
209
|
+
# Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint
|
210
|
+
# @param email_id [String] ID of email
|
211
|
+
# @param [Hash] opts the optional parameters
|
212
|
+
# @return [String]
|
213
|
+
def get_raw_sent_email_contents(email_id, opts = {})
|
214
|
+
data, _status_code, _headers = get_raw_sent_email_contents_with_http_info(email_id, opts)
|
215
|
+
data
|
216
|
+
end
|
217
|
+
|
218
|
+
# Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
|
219
|
+
# Returns a raw, unparsed, and unprocessed sent email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawSentEmailJson endpoint
|
220
|
+
# @param email_id [String] ID of email
|
221
|
+
# @param [Hash] opts the optional parameters
|
222
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
223
|
+
def get_raw_sent_email_contents_with_http_info(email_id, opts = {})
|
224
|
+
if @api_client.config.debugging
|
225
|
+
@api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.get_raw_sent_email_contents ...'
|
226
|
+
end
|
227
|
+
# verify the required parameter 'email_id' is set
|
228
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
229
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling SentEmailsControllerApi.get_raw_sent_email_contents"
|
230
|
+
end
|
231
|
+
# resource path
|
232
|
+
local_var_path = '/sent/{emailId}/raw'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
233
|
+
|
234
|
+
# query parameters
|
235
|
+
query_params = opts[:query_params] || {}
|
236
|
+
|
237
|
+
# header parameters
|
238
|
+
header_params = opts[:header_params] || {}
|
239
|
+
# HTTP header 'Accept' (if needed)
|
240
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
|
241
|
+
|
242
|
+
# form parameters
|
243
|
+
form_params = opts[:form_params] || {}
|
244
|
+
|
245
|
+
# http body (model)
|
246
|
+
post_body = opts[:body]
|
247
|
+
|
248
|
+
# return_type
|
249
|
+
return_type = opts[:return_type] || 'String'
|
250
|
+
|
251
|
+
# auth_names
|
252
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
253
|
+
|
254
|
+
new_options = opts.merge(
|
255
|
+
:header_params => header_params,
|
256
|
+
:query_params => query_params,
|
257
|
+
:form_params => form_params,
|
258
|
+
:body => post_body,
|
259
|
+
:auth_names => auth_names,
|
260
|
+
:return_type => return_type
|
261
|
+
)
|
262
|
+
|
263
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
264
|
+
if @api_client.config.debugging
|
265
|
+
@api_client.config.logger.debug "API called: SentEmailsControllerApi#get_raw_sent_email_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
266
|
+
end
|
267
|
+
return data, status_code, headers
|
268
|
+
end
|
269
|
+
|
270
|
+
# Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
|
271
|
+
# Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response
|
272
|
+
# @param email_id [String] ID of email
|
273
|
+
# @param [Hash] opts the optional parameters
|
274
|
+
# @return [RawEmailJson]
|
275
|
+
def get_raw_sent_email_json(email_id, opts = {})
|
276
|
+
data, _status_code, _headers = get_raw_sent_email_json_with_http_info(email_id, opts)
|
277
|
+
data
|
278
|
+
end
|
279
|
+
|
280
|
+
# Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
|
281
|
+
# Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail text/plain response
|
282
|
+
# @param email_id [String] ID of email
|
283
|
+
# @param [Hash] opts the optional parameters
|
284
|
+
# @return [Array<(RawEmailJson, Integer, Hash)>] RawEmailJson data, response status code and response headers
|
285
|
+
def get_raw_sent_email_json_with_http_info(email_id, opts = {})
|
286
|
+
if @api_client.config.debugging
|
287
|
+
@api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.get_raw_sent_email_json ...'
|
288
|
+
end
|
289
|
+
# verify the required parameter 'email_id' is set
|
290
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
291
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling SentEmailsControllerApi.get_raw_sent_email_json"
|
292
|
+
end
|
293
|
+
# resource path
|
294
|
+
local_var_path = '/sent/{emailId}/raw/json'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
295
|
+
|
296
|
+
# query parameters
|
297
|
+
query_params = opts[:query_params] || {}
|
298
|
+
|
299
|
+
# header parameters
|
300
|
+
header_params = opts[:header_params] || {}
|
301
|
+
# HTTP header 'Accept' (if needed)
|
302
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
303
|
+
|
304
|
+
# form parameters
|
305
|
+
form_params = opts[:form_params] || {}
|
306
|
+
|
307
|
+
# http body (model)
|
308
|
+
post_body = opts[:body]
|
309
|
+
|
310
|
+
# return_type
|
311
|
+
return_type = opts[:return_type] || 'RawEmailJson'
|
312
|
+
|
313
|
+
# auth_names
|
314
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
315
|
+
|
316
|
+
new_options = opts.merge(
|
317
|
+
:header_params => header_params,
|
318
|
+
:query_params => query_params,
|
319
|
+
:form_params => form_params,
|
320
|
+
:body => post_body,
|
321
|
+
:auth_names => auth_names,
|
322
|
+
:return_type => return_type
|
323
|
+
)
|
324
|
+
|
325
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
326
|
+
if @api_client.config.debugging
|
327
|
+
@api_client.config.logger.debug "API called: SentEmailsControllerApi#get_raw_sent_email_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
328
|
+
end
|
329
|
+
return data, status_code, headers
|
330
|
+
end
|
331
|
+
|
208
332
|
# Get sent email receipt
|
209
333
|
# @param id [String]
|
210
334
|
# @param [Hash] opts the optional parameters
|
@@ -325,6 +449,68 @@ module MailSlurpClient
|
|
325
449
|
return data, status_code, headers
|
326
450
|
end
|
327
451
|
|
452
|
+
# Get sent email URL for viewing in browser or downloading
|
453
|
+
# Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
|
454
|
+
# @param id [String]
|
455
|
+
# @param [Hash] opts the optional parameters
|
456
|
+
# @return [EmailPreviewUrls]
|
457
|
+
def get_sent_email_preview_ur_ls(id, opts = {})
|
458
|
+
data, _status_code, _headers = get_sent_email_preview_ur_ls_with_http_info(id, opts)
|
459
|
+
data
|
460
|
+
end
|
461
|
+
|
462
|
+
# Get sent email URL for viewing in browser or downloading
|
463
|
+
# Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
|
464
|
+
# @param id [String]
|
465
|
+
# @param [Hash] opts the optional parameters
|
466
|
+
# @return [Array<(EmailPreviewUrls, Integer, Hash)>] EmailPreviewUrls data, response status code and response headers
|
467
|
+
def get_sent_email_preview_ur_ls_with_http_info(id, opts = {})
|
468
|
+
if @api_client.config.debugging
|
469
|
+
@api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.get_sent_email_preview_ur_ls ...'
|
470
|
+
end
|
471
|
+
# verify the required parameter 'id' is set
|
472
|
+
if @api_client.config.client_side_validation && id.nil?
|
473
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SentEmailsControllerApi.get_sent_email_preview_ur_ls"
|
474
|
+
end
|
475
|
+
# resource path
|
476
|
+
local_var_path = '/sent/{id}/urls'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
477
|
+
|
478
|
+
# query parameters
|
479
|
+
query_params = opts[:query_params] || {}
|
480
|
+
|
481
|
+
# header parameters
|
482
|
+
header_params = opts[:header_params] || {}
|
483
|
+
# HTTP header 'Accept' (if needed)
|
484
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
485
|
+
|
486
|
+
# form parameters
|
487
|
+
form_params = opts[:form_params] || {}
|
488
|
+
|
489
|
+
# http body (model)
|
490
|
+
post_body = opts[:body]
|
491
|
+
|
492
|
+
# return_type
|
493
|
+
return_type = opts[:return_type] || 'EmailPreviewUrls'
|
494
|
+
|
495
|
+
# auth_names
|
496
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
497
|
+
|
498
|
+
new_options = opts.merge(
|
499
|
+
:header_params => header_params,
|
500
|
+
:query_params => query_params,
|
501
|
+
:form_params => form_params,
|
502
|
+
:body => post_body,
|
503
|
+
:auth_names => auth_names,
|
504
|
+
:return_type => return_type
|
505
|
+
)
|
506
|
+
|
507
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
508
|
+
if @api_client.config.debugging
|
509
|
+
@api_client.config.logger.debug "API called: SentEmailsControllerApi#get_sent_email_preview_ur_ls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
510
|
+
end
|
511
|
+
return data, status_code, headers
|
512
|
+
end
|
513
|
+
|
328
514
|
# Get all tracking pixels for a sent email in paginated form
|
329
515
|
# @param id [String]
|
330
516
|
# @param [Hash] opts the optional parameters
|
@@ -27,10 +27,10 @@ module MailSlurpClient
|
|
27
27
|
|
28
28
|
attr_accessor :created_at
|
29
29
|
|
30
|
-
attr_accessor :updated_at
|
31
|
-
|
32
30
|
attr_accessor :use_threads
|
33
31
|
|
32
|
+
attr_accessor :updated_at
|
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
|
+
:'use_threads' => :'useThreads',
|
44
|
+
:'updated_at' => :'updatedAt'
|
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
|
+
:'use_threads' => :'Boolean',
|
58
|
+
:'updated_at' => :'DateTime'
|
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?(:'updated_at')
|
108
|
-
self.updated_at = attributes[:'updated_at']
|
109
|
-
end
|
110
|
-
|
111
107
|
if attributes.key?(:'use_threads')
|
112
108
|
self.use_threads = attributes[:'use_threads']
|
113
109
|
end
|
110
|
+
|
111
|
+
if attributes.key?(:'updated_at')
|
112
|
+
self.updated_at = attributes[:'updated_at']
|
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
|
+
use_threads == o.use_threads &&
|
171
|
+
updated_at == o.updated_at
|
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, use_threads, updated_at].hash
|
184
184
|
end
|
185
185
|
|
186
186
|
# Builds the object from hash
|
@@ -22,11 +22,11 @@ module MailSlurpClient
|
|
22
22
|
# Content type of attachment.
|
23
23
|
attr_accessor :content_type
|
24
24
|
|
25
|
-
attr_accessor :user_id
|
26
|
-
|
27
25
|
# Attachment ID
|
28
26
|
attr_accessor :attachment_id
|
29
27
|
|
28
|
+
attr_accessor :user_id
|
29
|
+
|
30
30
|
attr_accessor :created_at
|
31
31
|
|
32
32
|
attr_accessor :updated_at
|
@@ -37,8 +37,8 @@ module MailSlurpClient
|
|
37
37
|
:'name' => :'name',
|
38
38
|
:'content_length' => :'contentLength',
|
39
39
|
:'content_type' => :'contentType',
|
40
|
-
:'user_id' => :'userId',
|
41
40
|
:'attachment_id' => :'attachmentId',
|
41
|
+
:'user_id' => :'userId',
|
42
42
|
:'created_at' => :'createdAt',
|
43
43
|
:'updated_at' => :'updatedAt'
|
44
44
|
}
|
@@ -50,8 +50,8 @@ module MailSlurpClient
|
|
50
50
|
:'name' => :'String',
|
51
51
|
:'content_length' => :'Integer',
|
52
52
|
:'content_type' => :'String',
|
53
|
-
:'user_id' => :'String',
|
54
53
|
:'attachment_id' => :'String',
|
54
|
+
:'user_id' => :'String',
|
55
55
|
:'created_at' => :'DateTime',
|
56
56
|
:'updated_at' => :'DateTime'
|
57
57
|
}
|
@@ -90,14 +90,14 @@ module MailSlurpClient
|
|
90
90
|
self.content_type = attributes[:'content_type']
|
91
91
|
end
|
92
92
|
|
93
|
-
if attributes.key?(:'user_id')
|
94
|
-
self.user_id = attributes[:'user_id']
|
95
|
-
end
|
96
|
-
|
97
93
|
if attributes.key?(:'attachment_id')
|
98
94
|
self.attachment_id = attributes[:'attachment_id']
|
99
95
|
end
|
100
96
|
|
97
|
+
if attributes.key?(:'user_id')
|
98
|
+
self.user_id = attributes[:'user_id']
|
99
|
+
end
|
100
|
+
|
101
101
|
if attributes.key?(:'created_at')
|
102
102
|
self.created_at = attributes[:'created_at']
|
103
103
|
end
|
@@ -111,14 +111,14 @@ module MailSlurpClient
|
|
111
111
|
# @return Array for valid properties with the reasons
|
112
112
|
def list_invalid_properties
|
113
113
|
invalid_properties = Array.new
|
114
|
-
if @user_id.nil?
|
115
|
-
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
116
|
-
end
|
117
|
-
|
118
114
|
if @attachment_id.nil?
|
119
115
|
invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
|
120
116
|
end
|
121
117
|
|
118
|
+
if @user_id.nil?
|
119
|
+
invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
|
120
|
+
end
|
121
|
+
|
122
122
|
if @created_at.nil?
|
123
123
|
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
124
124
|
end
|
@@ -133,8 +133,8 @@ module MailSlurpClient
|
|
133
133
|
# Check to see if the all the properties in the model are valid
|
134
134
|
# @return true if the model is valid
|
135
135
|
def valid?
|
136
|
-
return false if @user_id.nil?
|
137
136
|
return false if @attachment_id.nil?
|
137
|
+
return false if @user_id.nil?
|
138
138
|
return false if @created_at.nil?
|
139
139
|
return false if @updated_at.nil?
|
140
140
|
true
|
@@ -148,8 +148,8 @@ module MailSlurpClient
|
|
148
148
|
name == o.name &&
|
149
149
|
content_length == o.content_length &&
|
150
150
|
content_type == o.content_type &&
|
151
|
-
user_id == o.user_id &&
|
152
151
|
attachment_id == o.attachment_id &&
|
152
|
+
user_id == o.user_id &&
|
153
153
|
created_at == o.created_at &&
|
154
154
|
updated_at == o.updated_at
|
155
155
|
end
|
@@ -163,7 +163,7 @@ module MailSlurpClient
|
|
163
163
|
# Calculates hash code according to all attributes.
|
164
164
|
# @return [Integer] Hash code
|
165
165
|
def hash
|
166
|
-
[name, content_length, content_type,
|
166
|
+
[name, content_length, content_type, attachment_id, user_id, created_at, updated_at].hash
|
167
167
|
end
|
168
168
|
|
169
169
|
# Builds the object from hash
|
@@ -0,0 +1,225 @@
|
|
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 'date'
|
14
|
+
|
15
|
+
module MailSlurpClient
|
16
|
+
class EmailPreviewUrls
|
17
|
+
attr_accessor :raw_smtp_message_url
|
18
|
+
|
19
|
+
attr_accessor :plain_html_body_url
|
20
|
+
|
21
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
22
|
+
def self.attribute_map
|
23
|
+
{
|
24
|
+
:'raw_smtp_message_url' => :'rawSmtpMessageUrl',
|
25
|
+
:'plain_html_body_url' => :'plainHtmlBodyUrl'
|
26
|
+
}
|
27
|
+
end
|
28
|
+
|
29
|
+
# Attribute type mapping.
|
30
|
+
def self.openapi_types
|
31
|
+
{
|
32
|
+
:'raw_smtp_message_url' => :'String',
|
33
|
+
:'plain_html_body_url' => :'String'
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
# List of attributes with nullable: true
|
38
|
+
def self.openapi_nullable
|
39
|
+
Set.new([
|
40
|
+
])
|
41
|
+
end
|
42
|
+
|
43
|
+
# Initializes the object
|
44
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
45
|
+
def initialize(attributes = {})
|
46
|
+
if (!attributes.is_a?(Hash))
|
47
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailPreviewUrls` initialize method"
|
48
|
+
end
|
49
|
+
|
50
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
51
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
52
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
53
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::EmailPreviewUrls`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
54
|
+
end
|
55
|
+
h[k.to_sym] = v
|
56
|
+
}
|
57
|
+
|
58
|
+
if attributes.key?(:'raw_smtp_message_url')
|
59
|
+
self.raw_smtp_message_url = attributes[:'raw_smtp_message_url']
|
60
|
+
end
|
61
|
+
|
62
|
+
if attributes.key?(:'plain_html_body_url')
|
63
|
+
self.plain_html_body_url = attributes[:'plain_html_body_url']
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
68
|
+
# @return Array for valid properties with the reasons
|
69
|
+
def list_invalid_properties
|
70
|
+
invalid_properties = Array.new
|
71
|
+
if @raw_smtp_message_url.nil?
|
72
|
+
invalid_properties.push('invalid value for "raw_smtp_message_url", raw_smtp_message_url cannot be nil.')
|
73
|
+
end
|
74
|
+
|
75
|
+
if @plain_html_body_url.nil?
|
76
|
+
invalid_properties.push('invalid value for "plain_html_body_url", plain_html_body_url cannot be nil.')
|
77
|
+
end
|
78
|
+
|
79
|
+
invalid_properties
|
80
|
+
end
|
81
|
+
|
82
|
+
# Check to see if the all the properties in the model are valid
|
83
|
+
# @return true if the model is valid
|
84
|
+
def valid?
|
85
|
+
return false if @raw_smtp_message_url.nil?
|
86
|
+
return false if @plain_html_body_url.nil?
|
87
|
+
true
|
88
|
+
end
|
89
|
+
|
90
|
+
# Checks equality by comparing each attribute.
|
91
|
+
# @param [Object] Object to be compared
|
92
|
+
def ==(o)
|
93
|
+
return true if self.equal?(o)
|
94
|
+
self.class == o.class &&
|
95
|
+
raw_smtp_message_url == o.raw_smtp_message_url &&
|
96
|
+
plain_html_body_url == o.plain_html_body_url
|
97
|
+
end
|
98
|
+
|
99
|
+
# @see the `==` method
|
100
|
+
# @param [Object] Object to be compared
|
101
|
+
def eql?(o)
|
102
|
+
self == o
|
103
|
+
end
|
104
|
+
|
105
|
+
# Calculates hash code according to all attributes.
|
106
|
+
# @return [Integer] Hash code
|
107
|
+
def hash
|
108
|
+
[raw_smtp_message_url, plain_html_body_url].hash
|
109
|
+
end
|
110
|
+
|
111
|
+
# Builds the object from hash
|
112
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
113
|
+
# @return [Object] Returns the model itself
|
114
|
+
def self.build_from_hash(attributes)
|
115
|
+
new.build_from_hash(attributes)
|
116
|
+
end
|
117
|
+
|
118
|
+
# Builds the object from hash
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
120
|
+
# @return [Object] Returns the model itself
|
121
|
+
def build_from_hash(attributes)
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
123
|
+
self.class.openapi_types.each_pair do |key, type|
|
124
|
+
if type =~ /\AArray<(.*)>/i
|
125
|
+
# check to ensure the input is an array given that the attribute
|
126
|
+
# is documented as an array but the input is not
|
127
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
128
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
129
|
+
end
|
130
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
131
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
132
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
133
|
+
end
|
134
|
+
|
135
|
+
self
|
136
|
+
end
|
137
|
+
|
138
|
+
# Deserializes the data based on type
|
139
|
+
# @param string type Data type
|
140
|
+
# @param string value Value to be deserialized
|
141
|
+
# @return [Object] Deserialized data
|
142
|
+
def _deserialize(type, value)
|
143
|
+
case type.to_sym
|
144
|
+
when :DateTime
|
145
|
+
DateTime.parse(value)
|
146
|
+
when :Date
|
147
|
+
Date.parse(value)
|
148
|
+
when :String
|
149
|
+
value.to_s
|
150
|
+
when :Integer
|
151
|
+
value.to_i
|
152
|
+
when :Float
|
153
|
+
value.to_f
|
154
|
+
when :Boolean
|
155
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
156
|
+
true
|
157
|
+
else
|
158
|
+
false
|
159
|
+
end
|
160
|
+
when :Object
|
161
|
+
# generic object (usually a Hash), return directly
|
162
|
+
value
|
163
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
164
|
+
inner_type = Regexp.last_match[:inner_type]
|
165
|
+
value.map { |v| _deserialize(inner_type, v) }
|
166
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
167
|
+
k_type = Regexp.last_match[:k_type]
|
168
|
+
v_type = Regexp.last_match[:v_type]
|
169
|
+
{}.tap do |hash|
|
170
|
+
value.each do |k, v|
|
171
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
else # model
|
175
|
+
MailSlurpClient.const_get(type).build_from_hash(value)
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
179
|
+
# Returns the string representation of the object
|
180
|
+
# @return [String] String presentation of the object
|
181
|
+
def to_s
|
182
|
+
to_hash.to_s
|
183
|
+
end
|
184
|
+
|
185
|
+
# to_body is an alias to to_hash (backward compatibility)
|
186
|
+
# @return [Hash] Returns the object in the form of hash
|
187
|
+
def to_body
|
188
|
+
to_hash
|
189
|
+
end
|
190
|
+
|
191
|
+
# Returns the object in the form of hash
|
192
|
+
# @return [Hash] Returns the object in the form of hash
|
193
|
+
def to_hash
|
194
|
+
hash = {}
|
195
|
+
self.class.attribute_map.each_pair do |attr, param|
|
196
|
+
value = self.send(attr)
|
197
|
+
if value.nil?
|
198
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
199
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
200
|
+
end
|
201
|
+
|
202
|
+
hash[param] = _to_hash(value)
|
203
|
+
end
|
204
|
+
hash
|
205
|
+
end
|
206
|
+
|
207
|
+
# Outputs non-array value in the form of hash
|
208
|
+
# For object, use to_hash. Otherwise, just return the value
|
209
|
+
# @param [Object] value Any valid value
|
210
|
+
# @return [Hash] Returns the value in the form of hash
|
211
|
+
def _to_hash(value)
|
212
|
+
if value.is_a?(Array)
|
213
|
+
value.compact.map { |v| _to_hash(v) }
|
214
|
+
elsif value.is_a?(Hash)
|
215
|
+
{}.tap do |hash|
|
216
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
217
|
+
end
|
218
|
+
elsif value.respond_to? :to_hash
|
219
|
+
value.to_hash
|
220
|
+
else
|
221
|
+
value
|
222
|
+
end
|
223
|
+
end
|
224
|
+
end
|
225
|
+
end
|
@@ -18,10 +18,10 @@ module MailSlurpClient
|
|
18
18
|
|
19
19
|
attr_accessor :id
|
20
20
|
|
21
|
-
attr_accessor :variables
|
22
|
-
|
23
21
|
attr_accessor :created_at
|
24
22
|
|
23
|
+
attr_accessor :variables
|
24
|
+
|
25
25
|
attr_accessor :updated_at
|
26
26
|
|
27
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -29,8 +29,8 @@ module MailSlurpClient
|
|
29
29
|
{
|
30
30
|
:'name' => :'name',
|
31
31
|
:'id' => :'id',
|
32
|
-
:'variables' => :'variables',
|
33
32
|
:'created_at' => :'createdAt',
|
33
|
+
:'variables' => :'variables',
|
34
34
|
:'updated_at' => :'updatedAt'
|
35
35
|
}
|
36
36
|
end
|
@@ -40,8 +40,8 @@ module MailSlurpClient
|
|
40
40
|
{
|
41
41
|
:'name' => :'String',
|
42
42
|
:'id' => :'String',
|
43
|
-
:'variables' => :'Array<String>',
|
44
43
|
:'created_at' => :'DateTime',
|
44
|
+
:'variables' => :'Array<String>',
|
45
45
|
:'updated_at' => :'DateTime'
|
46
46
|
}
|
47
47
|
end
|
@@ -75,16 +75,16 @@ module MailSlurpClient
|
|
75
75
|
self.id = attributes[:'id']
|
76
76
|
end
|
77
77
|
|
78
|
+
if attributes.key?(:'created_at')
|
79
|
+
self.created_at = attributes[:'created_at']
|
80
|
+
end
|
81
|
+
|
78
82
|
if attributes.key?(:'variables')
|
79
83
|
if (value = attributes[:'variables']).is_a?(Array)
|
80
84
|
self.variables = value
|
81
85
|
end
|
82
86
|
end
|
83
87
|
|
84
|
-
if attributes.key?(:'created_at')
|
85
|
-
self.created_at = attributes[:'created_at']
|
86
|
-
end
|
87
|
-
|
88
88
|
if attributes.key?(:'updated_at')
|
89
89
|
self.updated_at = attributes[:'updated_at']
|
90
90
|
end
|
@@ -102,14 +102,14 @@ module MailSlurpClient
|
|
102
102
|
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
103
103
|
end
|
104
104
|
|
105
|
-
if @variables.nil?
|
106
|
-
invalid_properties.push('invalid value for "variables", variables cannot be nil.')
|
107
|
-
end
|
108
|
-
|
109
105
|
if @created_at.nil?
|
110
106
|
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
111
107
|
end
|
112
108
|
|
109
|
+
if @variables.nil?
|
110
|
+
invalid_properties.push('invalid value for "variables", variables cannot be nil.')
|
111
|
+
end
|
112
|
+
|
113
113
|
if @updated_at.nil?
|
114
114
|
invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
|
115
115
|
end
|
@@ -122,8 +122,8 @@ module MailSlurpClient
|
|
122
122
|
def valid?
|
123
123
|
return false if @name.nil?
|
124
124
|
return false if @id.nil?
|
125
|
-
return false if @variables.nil?
|
126
125
|
return false if @created_at.nil?
|
126
|
+
return false if @variables.nil?
|
127
127
|
return false if @updated_at.nil?
|
128
128
|
true
|
129
129
|
end
|
@@ -135,8 +135,8 @@ module MailSlurpClient
|
|
135
135
|
self.class == o.class &&
|
136
136
|
name == o.name &&
|
137
137
|
id == o.id &&
|
138
|
-
variables == o.variables &&
|
139
138
|
created_at == o.created_at &&
|
139
|
+
variables == o.variables &&
|
140
140
|
updated_at == o.updated_at
|
141
141
|
end
|
142
142
|
|
@@ -149,7 +149,7 @@ module MailSlurpClient
|
|
149
149
|
# Calculates hash code according to all attributes.
|
150
150
|
# @return [Integer] Hash code
|
151
151
|
def hash
|
152
|
-
[name, id,
|
152
|
+
[name, id, created_at, variables, updated_at].hash
|
153
153
|
end
|
154
154
|
|
155
155
|
# Builds the object from hash
|
data/lib/mailslurp_client.rb
CHANGED
@@ -58,6 +58,7 @@ require 'mailslurp_client/models/email_analysis'
|
|
58
58
|
require 'mailslurp_client/models/email_content_match_result'
|
59
59
|
require 'mailslurp_client/models/email_links_result'
|
60
60
|
require 'mailslurp_client/models/email_preview'
|
61
|
+
require 'mailslurp_client/models/email_preview_urls'
|
61
62
|
require 'mailslurp_client/models/email_projection'
|
62
63
|
require 'mailslurp_client/models/email_recipients'
|
63
64
|
require 'mailslurp_client/models/email_text_lines_result'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mailslurp_client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 15.5.
|
4
|
+
version: 15.5.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- mailslurp
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-01-
|
11
|
+
date: 2022-01-31 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: Create emails addresses in Ruby then send and receive real emails and
|
14
14
|
attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.
|
@@ -89,6 +89,7 @@ files:
|
|
89
89
|
- lib/mailslurp_client/models/email_content_match_result.rb
|
90
90
|
- lib/mailslurp_client/models/email_links_result.rb
|
91
91
|
- lib/mailslurp_client/models/email_preview.rb
|
92
|
+
- lib/mailslurp_client/models/email_preview_urls.rb
|
92
93
|
- lib/mailslurp_client/models/email_projection.rb
|
93
94
|
- lib/mailslurp_client/models/email_recipients.rb
|
94
95
|
- lib/mailslurp_client/models/email_text_lines_result.rb
|