mailslurp_client 4.3.3 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile.lock +1 -1
- data/README.md +19 -6
- data/docs/CommonOperationsApi.md +337 -4
- data/docs/Email.md +2 -0
- data/docs/EmailPreview.md +4 -0
- data/docs/ExtraOperationsApi.md +173 -7
- data/docs/ForwardEmailOptions.md +11 -0
- data/docs/MatchOption.md +10 -0
- data/docs/MatchOptions.md +8 -0
- data/docs/SendEmailOptions.md +3 -1
- data/docs/UploadAttachmentOptions.md +10 -0
- data/lib/mailslurp_client.rb +4 -0
- data/lib/mailslurp_client/api/common_operations_api.rb +331 -4
- data/lib/mailslurp_client/api/extra_operations_api.rb +183 -8
- data/lib/mailslurp_client/models/email.rb +19 -1
- data/lib/mailslurp_client/models/email_preview.rb +51 -4
- data/lib/mailslurp_client/models/forward_email_options.rb +222 -0
- data/lib/mailslurp_client/models/match_option.rb +250 -0
- data/lib/mailslurp_client/models/match_options.rb +187 -0
- data/lib/mailslurp_client/models/send_email_options.rb +24 -2
- data/lib/mailslurp_client/models/upload_attachment_options.rb +205 -0
- data/lib/mailslurp_client/version.rb +1 -1
- data/spec/api/common_operations_api_spec.rb +24 -0
- data/spec/api/extra_operations_api_spec.rb +1 -1
- data/spec/models/forward_email_options_spec.rb +59 -0
- data/spec/models/match_option_spec.rb +61 -0
- data/spec/models/match_options_spec.rb +41 -0
- data/spec/models/upload_attachment_options_spec.rb +53 -0
- metadata +23 -7
@@ -0,0 +1,205 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.1-alpha
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.4
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module MailSlurpClient
|
16
|
+
# Options for uploading files for attachments
|
17
|
+
class UploadAttachmentOptions
|
18
|
+
# Base64 encoded string of file contents
|
19
|
+
attr_accessor :base64_contents
|
20
|
+
|
21
|
+
# Optional contentType for file. For instance application/pdf
|
22
|
+
attr_accessor :content_type
|
23
|
+
|
24
|
+
# Optional filename to save upload with
|
25
|
+
attr_accessor :filename
|
26
|
+
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
28
|
+
def self.attribute_map
|
29
|
+
{
|
30
|
+
:'base64_contents' => :'base64Contents',
|
31
|
+
:'content_type' => :'contentType',
|
32
|
+
:'filename' => :'filename'
|
33
|
+
}
|
34
|
+
end
|
35
|
+
|
36
|
+
# Attribute type mapping.
|
37
|
+
def self.openapi_types
|
38
|
+
{
|
39
|
+
:'base64_contents' => :'String',
|
40
|
+
:'content_type' => :'String',
|
41
|
+
:'filename' => :'String'
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# Initializes the object
|
46
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
47
|
+
def initialize(attributes = {})
|
48
|
+
return unless attributes.is_a?(Hash)
|
49
|
+
|
50
|
+
# convert string to symbol for hash key
|
51
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
52
|
+
|
53
|
+
if attributes.has_key?(:'base64Contents')
|
54
|
+
self.base64_contents = attributes[:'base64Contents']
|
55
|
+
end
|
56
|
+
|
57
|
+
if attributes.has_key?(:'contentType')
|
58
|
+
self.content_type = attributes[:'contentType']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'filename')
|
62
|
+
self.filename = attributes[:'filename']
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
67
|
+
# @return Array for valid properties with the reasons
|
68
|
+
def list_invalid_properties
|
69
|
+
invalid_properties = Array.new
|
70
|
+
invalid_properties
|
71
|
+
end
|
72
|
+
|
73
|
+
# Check to see if the all the properties in the model are valid
|
74
|
+
# @return true if the model is valid
|
75
|
+
def valid?
|
76
|
+
true
|
77
|
+
end
|
78
|
+
|
79
|
+
# Checks equality by comparing each attribute.
|
80
|
+
# @param [Object] Object to be compared
|
81
|
+
def ==(o)
|
82
|
+
return true if self.equal?(o)
|
83
|
+
self.class == o.class &&
|
84
|
+
base64_contents == o.base64_contents &&
|
85
|
+
content_type == o.content_type &&
|
86
|
+
filename == o.filename
|
87
|
+
end
|
88
|
+
|
89
|
+
# @see the `==` method
|
90
|
+
# @param [Object] Object to be compared
|
91
|
+
def eql?(o)
|
92
|
+
self == o
|
93
|
+
end
|
94
|
+
|
95
|
+
# Calculates hash code according to all attributes.
|
96
|
+
# @return [Fixnum] Hash code
|
97
|
+
def hash
|
98
|
+
[base64_contents, content_type, filename].hash
|
99
|
+
end
|
100
|
+
|
101
|
+
# Builds the object from hash
|
102
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
103
|
+
# @return [Object] Returns the model itself
|
104
|
+
def build_from_hash(attributes)
|
105
|
+
return nil unless attributes.is_a?(Hash)
|
106
|
+
self.class.openapi_types.each_pair do |key, type|
|
107
|
+
if type =~ /\AArray<(.*)>/i
|
108
|
+
# check to ensure the input is an array given that the the attribute
|
109
|
+
# is documented as an array but the input is not
|
110
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
111
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
112
|
+
end
|
113
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
114
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
115
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
116
|
+
end
|
117
|
+
|
118
|
+
self
|
119
|
+
end
|
120
|
+
|
121
|
+
# Deserializes the data based on type
|
122
|
+
# @param string type Data type
|
123
|
+
# @param string value Value to be deserialized
|
124
|
+
# @return [Object] Deserialized data
|
125
|
+
def _deserialize(type, value)
|
126
|
+
case type.to_sym
|
127
|
+
when :DateTime
|
128
|
+
DateTime.parse(value)
|
129
|
+
when :Date
|
130
|
+
Date.parse(value)
|
131
|
+
when :String
|
132
|
+
value.to_s
|
133
|
+
when :Integer
|
134
|
+
value.to_i
|
135
|
+
when :Float
|
136
|
+
value.to_f
|
137
|
+
when :BOOLEAN
|
138
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
139
|
+
true
|
140
|
+
else
|
141
|
+
false
|
142
|
+
end
|
143
|
+
when :Object
|
144
|
+
# generic object (usually a Hash), return directly
|
145
|
+
value
|
146
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
147
|
+
inner_type = Regexp.last_match[:inner_type]
|
148
|
+
value.map { |v| _deserialize(inner_type, v) }
|
149
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
150
|
+
k_type = Regexp.last_match[:k_type]
|
151
|
+
v_type = Regexp.last_match[:v_type]
|
152
|
+
{}.tap do |hash|
|
153
|
+
value.each do |k, v|
|
154
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
else # model
|
158
|
+
temp_model = MailSlurpClient.const_get(type).new
|
159
|
+
temp_model.build_from_hash(value)
|
160
|
+
end
|
161
|
+
end
|
162
|
+
|
163
|
+
# Returns the string representation of the object
|
164
|
+
# @return [String] String presentation of the object
|
165
|
+
def to_s
|
166
|
+
to_hash.to_s
|
167
|
+
end
|
168
|
+
|
169
|
+
# to_body is an alias to to_hash (backward compatibility)
|
170
|
+
# @return [Hash] Returns the object in the form of hash
|
171
|
+
def to_body
|
172
|
+
to_hash
|
173
|
+
end
|
174
|
+
|
175
|
+
# Returns the object in the form of hash
|
176
|
+
# @return [Hash] Returns the object in the form of hash
|
177
|
+
def to_hash
|
178
|
+
hash = {}
|
179
|
+
self.class.attribute_map.each_pair do |attr, param|
|
180
|
+
value = self.send(attr)
|
181
|
+
next if value.nil?
|
182
|
+
hash[param] = _to_hash(value)
|
183
|
+
end
|
184
|
+
hash
|
185
|
+
end
|
186
|
+
|
187
|
+
# Outputs non-array value in the form of hash
|
188
|
+
# For object, use to_hash. Otherwise, just return the value
|
189
|
+
# @param [Object] value Any valid value
|
190
|
+
# @return [Hash] Returns the value in the form of hash
|
191
|
+
def _to_hash(value)
|
192
|
+
if value.is_a?(Array)
|
193
|
+
value.compact.map { |v| _to_hash(v) }
|
194
|
+
elsif value.is_a?(Hash)
|
195
|
+
{}.tap do |hash|
|
196
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
197
|
+
end
|
198
|
+
elsif value.respond_to? :to_hash
|
199
|
+
value.to_hash
|
200
|
+
else
|
201
|
+
value
|
202
|
+
end
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|
@@ -43,6 +43,18 @@ describe 'CommonOperationsApi' do
|
|
43
43
|
end
|
44
44
|
end
|
45
45
|
|
46
|
+
# unit tests for delete_email_address
|
47
|
+
# Delete email address and its emails
|
48
|
+
# Deletes an inbox
|
49
|
+
# @param inbox_id inboxId
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @return [nil]
|
52
|
+
describe 'delete_email_address test' do
|
53
|
+
it 'should work' do
|
54
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
46
58
|
# unit tests for send_email_simple
|
47
59
|
# Send an email from a random email address
|
48
60
|
# To specify an email address first create an inbox and use that with the other send email methods
|
@@ -68,4 +80,16 @@ describe 'CommonOperationsApi' do
|
|
68
80
|
end
|
69
81
|
end
|
70
82
|
|
83
|
+
# unit tests for wait_for_nth_email
|
84
|
+
# Wait for or fetch the email with a given index in the inbox specified
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [String] :inbox_id Id of the inbox we are fetching emails from
|
87
|
+
# @option opts [Integer] :index Zero based index of the email to wait for
|
88
|
+
# @return [Email]
|
89
|
+
describe 'wait_for_nth_email test' do
|
90
|
+
it 'should work' do
|
91
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
71
95
|
end
|
@@ -83,7 +83,7 @@ describe 'ExtraOperationsApi' do
|
|
83
83
|
# Attach a WebHook URL to an inbox
|
84
84
|
# Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
|
85
85
|
# @param inbox_id inboxId
|
86
|
-
# @param create_webhook_options
|
86
|
+
# @param create_webhook_options webhookOptions
|
87
87
|
# @param [Hash] opts the optional parameters
|
88
88
|
# @return [Webhook]
|
89
89
|
describe 'create_webhook test' do
|
@@ -0,0 +1,59 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.1-alpha
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.4
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for MailSlurpClient::ForwardEmailOptions
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'ForwardEmailOptions' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = MailSlurpClient::ForwardEmailOptions.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of ForwardEmailOptions' do
|
31
|
+
it 'should create an instance of ForwardEmailOptions' do
|
32
|
+
expect(@instance).to be_instance_of(MailSlurpClient::ForwardEmailOptions)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "to"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "subject"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
describe 'test attribute "cc"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
describe 'test attribute "bcc"' do
|
54
|
+
it 'should work' do
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.1-alpha
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.4
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for MailSlurpClient::MatchOption
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'MatchOption' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = MailSlurpClient::MatchOption.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of MatchOption' do
|
31
|
+
it 'should create an instance of MatchOption' do
|
32
|
+
expect(@instance).to be_instance_of(MailSlurpClient::MatchOption)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "field"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["SUBJECT", "TO", "BCC", "CC", "FROM"])
|
39
|
+
# validator.allowable_values.each do |value|
|
40
|
+
# expect { @instance.field = value }.not_to raise_error
|
41
|
+
# end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
describe 'test attribute "should"' do
|
46
|
+
it 'should work' do
|
47
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
48
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["CONTAIN", "EQUAL"])
|
49
|
+
# validator.allowable_values.each do |value|
|
50
|
+
# expect { @instance.should = value }.not_to raise_error
|
51
|
+
# end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
describe 'test attribute "value"' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.1-alpha
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.4
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for MailSlurpClient::MatchOptions
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'MatchOptions' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = MailSlurpClient::MatchOptions.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of MatchOptions' do
|
31
|
+
it 'should create an instance of MatchOptions' do
|
32
|
+
expect(@instance).to be_instance_of(MailSlurpClient::MatchOptions)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "matches"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
=begin
|
2
|
+
#MailSlurp API
|
3
|
+
|
4
|
+
#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.1-alpha
|
7
|
+
Contact: contact@mailslurp.dev
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 3.3.4
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for MailSlurpClient::UploadAttachmentOptions
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe 'UploadAttachmentOptions' do
|
21
|
+
before do
|
22
|
+
# run before each test
|
23
|
+
@instance = MailSlurpClient::UploadAttachmentOptions.new
|
24
|
+
end
|
25
|
+
|
26
|
+
after do
|
27
|
+
# run after each test
|
28
|
+
end
|
29
|
+
|
30
|
+
describe 'test an instance of UploadAttachmentOptions' do
|
31
|
+
it 'should create an instance of UploadAttachmentOptions' do
|
32
|
+
expect(@instance).to be_instance_of(MailSlurpClient::UploadAttachmentOptions)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
describe 'test attribute "base64_contents"' do
|
36
|
+
it 'should work' do
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
describe 'test attribute "content_type"' do
|
42
|
+
it 'should work' do
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
describe 'test attribute "filename"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|