mailslurp_client 12.6.0 → 12.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client.rb +8 -0
  3. data/lib/mailslurp_client/api/email_controller_api.rb +7 -5
  4. data/lib/mailslurp_client/api/inbox_controller_api.rb +96 -14
  5. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +548 -0
  6. data/lib/mailslurp_client/api/missed_email_controller_api.rb +10 -16
  7. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +150 -4
  8. data/lib/mailslurp_client/api/tracking_controller_api.rb +5 -2
  9. data/lib/mailslurp_client/api/webhook_controller_api.rb +55 -1
  10. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
  11. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +275 -0
  12. data/lib/mailslurp_client/models/create_webhook_options.rb +3 -3
  13. data/lib/mailslurp_client/models/domain_preview.rb +66 -4
  14. data/lib/mailslurp_client/models/email.rb +11 -1
  15. data/lib/mailslurp_client/models/email_projection.rb +10 -1
  16. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +317 -0
  17. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +211 -0
  18. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +227 -0
  19. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +299 -0
  20. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +225 -0
  21. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +42 -1
  22. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +37 -1
  23. data/lib/mailslurp_client/models/webhook_dto.rb +2 -2
  24. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +322 -0
  25. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +2 -2
  26. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +2 -2
  27. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +2 -2
  28. data/lib/mailslurp_client/models/webhook_projection.rb +44 -1
  29. data/lib/mailslurp_client/models/webhook_result_entity.rb +24 -3
  30. data/lib/mailslurp_client/version.rb +1 -1
  31. metadata +10 -2
@@ -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
+
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 TestNewInboxForwarderOptions
17
+ attr_accessor :inbox_forwarder_test_options
18
+
19
+ attr_accessor :create_inbox_forwarder_options
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'inbox_forwarder_test_options' => :'inboxForwarderTestOptions',
25
+ :'create_inbox_forwarder_options' => :'createInboxForwarderOptions'
26
+ }
27
+ end
28
+
29
+ # Attribute type mapping.
30
+ def self.openapi_types
31
+ {
32
+ :'inbox_forwarder_test_options' => :'InboxForwarderTestOptions',
33
+ :'create_inbox_forwarder_options' => :'CreateInboxForwarderOptions'
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::TestNewInboxForwarderOptions` 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::TestNewInboxForwarderOptions`. 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?(:'inbox_forwarder_test_options')
59
+ self.inbox_forwarder_test_options = attributes[:'inbox_forwarder_test_options']
60
+ end
61
+
62
+ if attributes.key?(:'create_inbox_forwarder_options')
63
+ self.create_inbox_forwarder_options = attributes[:'create_inbox_forwarder_options']
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 @inbox_forwarder_test_options.nil?
72
+ invalid_properties.push('invalid value for "inbox_forwarder_test_options", inbox_forwarder_test_options cannot be nil.')
73
+ end
74
+
75
+ if @create_inbox_forwarder_options.nil?
76
+ invalid_properties.push('invalid value for "create_inbox_forwarder_options", create_inbox_forwarder_options 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 @inbox_forwarder_test_options.nil?
86
+ return false if @create_inbox_forwarder_options.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
+ inbox_forwarder_test_options == o.inbox_forwarder_test_options &&
96
+ create_inbox_forwarder_options == o.create_inbox_forwarder_options
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
+ [inbox_forwarder_test_options, create_inbox_forwarder_options].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
@@ -14,23 +14,35 @@ require 'date'
14
14
 
15
15
  module MailSlurpClient
16
16
  class TrackingPixelDto
17
+ attr_accessor :created_at
18
+
17
19
  attr_accessor :html
18
20
 
19
21
  attr_accessor :id
20
22
 
23
+ attr_accessor :inbox_id
24
+
21
25
  attr_accessor :recipient
22
26
 
23
27
  attr_accessor :seen
24
28
 
29
+ attr_accessor :seen_at
30
+
31
+ attr_accessor :sent_email_id
32
+
25
33
  attr_accessor :url
26
34
 
27
35
  # Attribute mapping from ruby-style variable name to JSON key.
28
36
  def self.attribute_map
29
37
  {
38
+ :'created_at' => :'createdAt',
30
39
  :'html' => :'html',
31
40
  :'id' => :'id',
41
+ :'inbox_id' => :'inboxId',
32
42
  :'recipient' => :'recipient',
33
43
  :'seen' => :'seen',
44
+ :'seen_at' => :'seenAt',
45
+ :'sent_email_id' => :'sentEmailId',
34
46
  :'url' => :'url'
35
47
  }
36
48
  end
@@ -38,10 +50,14 @@ module MailSlurpClient
38
50
  # Attribute type mapping.
39
51
  def self.openapi_types
40
52
  {
53
+ :'created_at' => :'DateTime',
41
54
  :'html' => :'String',
42
55
  :'id' => :'String',
56
+ :'inbox_id' => :'String',
43
57
  :'recipient' => :'String',
44
58
  :'seen' => :'Boolean',
59
+ :'seen_at' => :'DateTime',
60
+ :'sent_email_id' => :'String',
45
61
  :'url' => :'String'
46
62
  }
47
63
  end
@@ -67,6 +83,10 @@ module MailSlurpClient
67
83
  h[k.to_sym] = v
68
84
  }
69
85
 
86
+ if attributes.key?(:'created_at')
87
+ self.created_at = attributes[:'created_at']
88
+ end
89
+
70
90
  if attributes.key?(:'html')
71
91
  self.html = attributes[:'html']
72
92
  end
@@ -75,6 +95,10 @@ module MailSlurpClient
75
95
  self.id = attributes[:'id']
76
96
  end
77
97
 
98
+ if attributes.key?(:'inbox_id')
99
+ self.inbox_id = attributes[:'inbox_id']
100
+ end
101
+
78
102
  if attributes.key?(:'recipient')
79
103
  self.recipient = attributes[:'recipient']
80
104
  end
@@ -83,6 +107,14 @@ module MailSlurpClient
83
107
  self.seen = attributes[:'seen']
84
108
  end
85
109
 
110
+ if attributes.key?(:'seen_at')
111
+ self.seen_at = attributes[:'seen_at']
112
+ end
113
+
114
+ if attributes.key?(:'sent_email_id')
115
+ self.sent_email_id = attributes[:'sent_email_id']
116
+ end
117
+
86
118
  if attributes.key?(:'url')
87
119
  self.url = attributes[:'url']
88
120
  end
@@ -92,6 +124,10 @@ module MailSlurpClient
92
124
  # @return Array for valid properties with the reasons
93
125
  def list_invalid_properties
94
126
  invalid_properties = Array.new
127
+ if @created_at.nil?
128
+ invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
129
+ end
130
+
95
131
  if @html.nil?
96
132
  invalid_properties.push('invalid value for "html", html cannot be nil.')
97
133
  end
@@ -114,6 +150,7 @@ module MailSlurpClient
114
150
  # Check to see if the all the properties in the model are valid
115
151
  # @return true if the model is valid
116
152
  def valid?
153
+ return false if @created_at.nil?
117
154
  return false if @html.nil?
118
155
  return false if @id.nil?
119
156
  return false if @seen.nil?
@@ -126,10 +163,14 @@ module MailSlurpClient
126
163
  def ==(o)
127
164
  return true if self.equal?(o)
128
165
  self.class == o.class &&
166
+ created_at == o.created_at &&
129
167
  html == o.html &&
130
168
  id == o.id &&
169
+ inbox_id == o.inbox_id &&
131
170
  recipient == o.recipient &&
132
171
  seen == o.seen &&
172
+ seen_at == o.seen_at &&
173
+ sent_email_id == o.sent_email_id &&
133
174
  url == o.url
134
175
  end
135
176
 
@@ -142,7 +183,7 @@ module MailSlurpClient
142
183
  # Calculates hash code according to all attributes.
143
184
  # @return [Integer] Hash code
144
185
  def hash
145
- [html, id, recipient, seen, url].hash
186
+ [created_at, html, id, inbox_id, recipient, seen, seen_at, sent_email_id, url].hash
146
187
  end
147
188
 
148
189
  # Builds the object from hash
@@ -18,10 +18,18 @@ module MailSlurpClient
18
18
 
19
19
  attr_accessor :id
20
20
 
21
+ attr_accessor :inbox_id
22
+
21
23
  attr_accessor :name
22
24
 
25
+ attr_accessor :recipient
26
+
23
27
  attr_accessor :seen
24
28
 
29
+ attr_accessor :seen_at
30
+
31
+ attr_accessor :sent_email_id
32
+
25
33
  attr_accessor :user_id
26
34
 
27
35
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -29,8 +37,12 @@ module MailSlurpClient
29
37
  {
30
38
  :'created_at' => :'createdAt',
31
39
  :'id' => :'id',
40
+ :'inbox_id' => :'inboxId',
32
41
  :'name' => :'name',
42
+ :'recipient' => :'recipient',
33
43
  :'seen' => :'seen',
44
+ :'seen_at' => :'seenAt',
45
+ :'sent_email_id' => :'sentEmailId',
34
46
  :'user_id' => :'userId'
35
47
  }
36
48
  end
@@ -40,8 +52,12 @@ module MailSlurpClient
40
52
  {
41
53
  :'created_at' => :'DateTime',
42
54
  :'id' => :'String',
55
+ :'inbox_id' => :'String',
43
56
  :'name' => :'String',
57
+ :'recipient' => :'String',
44
58
  :'seen' => :'Boolean',
59
+ :'seen_at' => :'DateTime',
60
+ :'sent_email_id' => :'String',
45
61
  :'user_id' => :'String'
46
62
  }
47
63
  end
@@ -75,14 +91,30 @@ module MailSlurpClient
75
91
  self.id = attributes[:'id']
76
92
  end
77
93
 
94
+ if attributes.key?(:'inbox_id')
95
+ self.inbox_id = attributes[:'inbox_id']
96
+ end
97
+
78
98
  if attributes.key?(:'name')
79
99
  self.name = attributes[:'name']
80
100
  end
81
101
 
102
+ if attributes.key?(:'recipient')
103
+ self.recipient = attributes[:'recipient']
104
+ end
105
+
82
106
  if attributes.key?(:'seen')
83
107
  self.seen = attributes[:'seen']
84
108
  end
85
109
 
110
+ if attributes.key?(:'seen_at')
111
+ self.seen_at = attributes[:'seen_at']
112
+ end
113
+
114
+ if attributes.key?(:'sent_email_id')
115
+ self.sent_email_id = attributes[:'sent_email_id']
116
+ end
117
+
86
118
  if attributes.key?(:'user_id')
87
119
  self.user_id = attributes[:'user_id']
88
120
  end
@@ -128,8 +160,12 @@ module MailSlurpClient
128
160
  self.class == o.class &&
129
161
  created_at == o.created_at &&
130
162
  id == o.id &&
163
+ inbox_id == o.inbox_id &&
131
164
  name == o.name &&
165
+ recipient == o.recipient &&
132
166
  seen == o.seen &&
167
+ seen_at == o.seen_at &&
168
+ sent_email_id == o.sent_email_id &&
133
169
  user_id == o.user_id
134
170
  end
135
171
 
@@ -142,7 +178,7 @@ module MailSlurpClient
142
178
  # Calculates hash code according to all attributes.
143
179
  # @return [Integer] Hash code
144
180
  def hash
145
- [created_at, id, name, seen, user_id].hash
181
+ [created_at, id, inbox_id, name, recipient, seen, seen_at, sent_email_id, user_id].hash
146
182
  end
147
183
 
148
184
  # Builds the object from hash
@@ -182,7 +182,7 @@ module MailSlurpClient
182
182
  # Check to see if the all the properties in the model are valid
183
183
  # @return true if the model is valid
184
184
  def valid?
185
- event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT"])
185
+ event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
186
186
  return false unless event_name_validator.valid?(@event_name)
187
187
  method_validator = EnumAttributeValidator.new('String', ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "TRACE"])
188
188
  return false unless method_validator.valid?(@method)
@@ -193,7 +193,7 @@ module MailSlurpClient
193
193
  # Custom attribute writer method checking allowed values (enum).
194
194
  # @param [Object] event_name Object to be assigned
195
195
  def event_name=(event_name)
196
- validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT"])
196
+ validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
197
197
  unless validator.valid?(event_name)
198
198
  fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
199
199
  end