Class: MailSlurpClient::WebhookDeliveryStatusPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/webhook_delivery_status_payload.rb

Overview

DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookDeliveryStatusPayload

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 151

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookDeliveryStatusPayload` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::WebhookDeliveryStatusPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'message_id')
    self.message_id = attributes[:'message_id']
  end

  if attributes.key?(:'webhook_id')
    self.webhook_id = attributes[:'webhook_id']
  end

  if attributes.key?(:'event_name')
    self.event_name = attributes[:'event_name']
  end

  if attributes.key?(:'webhook_name')
    self.webhook_name = attributes[:'webhook_name']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'sent_id')
    self.sent_id = attributes[:'sent_id']
  end

  if attributes.key?(:'remote_mta_ip')
    self.remote_mta_ip = attributes[:'remote_mta_ip']
  end

  if attributes.key?(:'inbox_id')
    self.inbox_id = attributes[:'inbox_id']
  end

  if attributes.key?(:'reporting_mta')
    self.reporting_mta = attributes[:'reporting_mta']
  end

  if attributes.key?(:'recipients')
    if (value = attributes[:'recipients']).is_a?(Array)
      self.recipients = value
    end
  end

  if attributes.key?(:'smtp_response')
    self.smtp_response = attributes[:'smtp_response']
  end

  if attributes.key?(:'smtp_status_code')
    self.smtp_status_code = attributes[:'smtp_status_code']
  end

  if attributes.key?(:'processing_time_millis')
    self.processing_time_millis = attributes[:'processing_time_millis']
  end

  if attributes.key?(:'received')
    self.received = attributes[:'received']
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end
end

Instance Attribute Details

#event_name ⇒ Object

Name of the event type webhook is being triggered for.



25
26
27
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 25

def event_name
  @event_name
end

#id ⇒ Object

ID of delivery status



31
32
33
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 31

def id
  @id
end

#inbox_id ⇒ Object

Id of the inbox



43
44
45
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 43

def inbox_id
  @inbox_id
end

#message_id ⇒ Object

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.



19
20
21
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 19

def message_id
  @message_id
end

#processing_time_millis ⇒ Object

Time in milliseconds for delivery processing



58
59
60
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 58

def processing_time_millis
  @processing_time_millis
end

#received ⇒ Object

Time event was received



61
62
63
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 61

def received
  @received
end

#recipients ⇒ Object

Recipients for delivery



49
50
51
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 49

def recipients
  @recipients
end

#remote_mta_ip ⇒ Object

IP address of the remote Mail Transfer Agent



40
41
42
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 40

def remote_mta_ip
  @remote_mta_ip
end

#reporting_mta ⇒ Object

Mail Transfer Agent reporting delivery status



46
47
48
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 46

def reporting_mta
  @reporting_mta
end

#sent_id ⇒ Object

ID of sent email



37
38
39
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 37

def sent_id
  @sent_id
end

#smtp_response ⇒ Object

SMTP server response message



52
53
54
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 52

def smtp_response
  @smtp_response
end

#smtp_status_code ⇒ Object

SMTP server status



55
56
57
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 55

def smtp_status_code
  @smtp_status_code
end

#subject ⇒ Object

Email subject



64
65
66
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 64

def subject
  @subject
end

#user_id ⇒ Object

User ID of event



34
35
36
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 34

def user_id
  @user_id
end

#webhook_id ⇒ Object

ID of webhook entity being triggered



22
23
24
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 22

def webhook_id
  @webhook_id
end

#webhook_name ⇒ Object

Name of the webhook being triggered



28
29
30
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 28

def webhook_name
  @webhook_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 89

def self.attribute_map
  {
    :'message_id' => :'messageId',
    :'webhook_id' => :'webhookId',
    :'event_name' => :'eventName',
    :'webhook_name' => :'webhookName',
    :'id' => :'id',
    :'user_id' => :'userId',
    :'sent_id' => :'sentId',
    :'remote_mta_ip' => :'remoteMtaIp',
    :'inbox_id' => :'inboxId',
    :'reporting_mta' => :'reportingMta',
    :'recipients' => :'recipients',
    :'smtp_response' => :'smtpResponse',
    :'smtp_status_code' => :'smtpStatusCode',
    :'processing_time_millis' => :'processingTimeMillis',
    :'received' => :'received',
    :'subject' => :'subject'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



319
320
321
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 319

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 133

def self.openapi_nullable
  Set.new([
    :'webhook_name',
    :'sent_id',
    :'remote_mta_ip',
    :'inbox_id',
    :'reporting_mta',
    :'recipients',
    :'smtp_response',
    :'smtp_status_code',
    :'processing_time_millis',
    :'received',
    :'subject'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 111

def self.openapi_types
  {
    :'message_id' => :'String',
    :'webhook_id' => :'String',
    :'event_name' => :'String',
    :'webhook_name' => :'String',
    :'id' => :'String',
    :'user_id' => :'String',
    :'sent_id' => :'String',
    :'remote_mta_ip' => :'String',
    :'inbox_id' => :'String',
    :'reporting_mta' => :'String',
    :'recipients' => :'Array<String>',
    :'smtp_response' => :'String',
    :'smtp_status_code' => :'Integer',
    :'processing_time_millis' => :'Integer',
    :'received' => :'DateTime',
    :'subject' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      webhook_id == o.webhook_id &&
      event_name == o.event_name &&
      webhook_name == o.webhook_name &&
      id == o.id &&
      user_id == o.user_id &&
      sent_id == o.sent_id &&
      remote_mta_ip == o.remote_mta_ip &&
      inbox_id == o.inbox_id &&
      reporting_mta == o.reporting_mta &&
      recipients == o.recipients &&
      smtp_response == o.smtp_response &&
      smtp_status_code == o.smtp_status_code &&
      processing_time_millis == o.processing_time_millis &&
      received == o.received &&
      subject == o.subject
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 347

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 416

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 326

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 312

def hash
  [message_id, webhook_id, event_name, webhook_name, id, user_id, sent_id, remote_mta_ip, inbox_id, reporting_mta, recipients, smtp_response, smtp_status_code, processing_time_millis, received, subject].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 233

def list_invalid_properties
  invalid_properties = Array.new
  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
  end

  if @webhook_id.nil?
    invalid_properties.push('invalid value for "webhook_id", webhook_id cannot be nil.')
  end

  if @event_name.nil?
    invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @user_id.nil?
    invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 392

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 398

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



386
387
388
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 386

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/mailslurp_client/models/webhook_delivery_status_payload.rb', line 260

def valid?
  return false if @message_id.nil?
  return false if @webhook_id.nil?
  return false if @event_name.nil?
  event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"])
  return false unless event_name_validator.valid?(@event_name)
  return false if @id.nil?
  return false if @user_id.nil?
  true
end