Class: MailSlurpClient::WebhookResultDto

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

Overview

Result of a webhook notification

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookResultDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



150
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
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 150

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::WebhookResultDto` 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::WebhookResultDto`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachment_id ⇒ Object

Returns the value of attribute attachment_id.



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

def attachment_id
  @attachment_id
end

#created_at ⇒ Object

Returns the value of attribute created_at.



42
43
44
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 42

def created_at
  @created_at
end

#email_id ⇒ Object

Returns the value of attribute email_id.



50
51
52
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 50

def email_id
  @email_id
end

#http_method ⇒ Object

Returns the value of attribute http_method.



30
31
32
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 30

def http_method
  @http_method
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 18

def id
  @id
end

#inbox_id ⇒ Object

Returns the value of attribute inbox_id.



48
49
50
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 48

def inbox_id
  @inbox_id
end

#message_id ⇒ Object

Returns the value of attribute message_id.



26
27
28
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 26

def message_id
  @message_id
end

#phone_id ⇒ Object

Returns the value of attribute phone_id.



54
55
56
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 54

def phone_id
  @phone_id
end

#redrive_id ⇒ Object

Returns the value of attribute redrive_id.



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

def redrive_id
  @redrive_id
end

#response_body_extract ⇒ Object

Returns the value of attribute response_body_extract.



38
39
40
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 38

def response_body_extract
  @response_body_extract
end

#response_status ⇒ Object

Returns the value of attribute response_status.



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

def response_status
  @response_status
end

#response_time_millis ⇒ Object

Returns the value of attribute response_time_millis.



36
37
38
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 36

def response_time_millis
  @response_time_millis
end

#result_type ⇒ Object

Returns the value of attribute result_type.



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

def result_type
  @result_type
end

#seen ⇒ Object

Returns the value of attribute seen.



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

def seen
  @seen
end

#sms_id ⇒ Object

Returns the value of attribute sms_id.



56
57
58
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 56

def sms_id
  @sms_id
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



44
45
46
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 44

def updated_at
  @updated_at
end

#user_id ⇒ Object

Returns the value of attribute user_id.



20
21
22
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 20

def user_id
  @user_id
end

#webhook_event ⇒ Object

Returns the value of attribute webhook_event.



32
33
34
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 32

def webhook_event
  @webhook_event
end

#webhook_id ⇒ Object

Returns the value of attribute webhook_id.



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

def webhook_id
  @webhook_id
end

#webhook_url ⇒ Object

Returns the value of attribute webhook_url.



24
25
26
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 24

def webhook_url
  @webhook_url
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 81

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'webhook_id' => :'webhookId',
    :'webhook_url' => :'webhookUrl',
    :'message_id' => :'messageId',
    :'redrive_id' => :'redriveId',
    :'http_method' => :'httpMethod',
    :'webhook_event' => :'webhookEvent',
    :'response_status' => :'responseStatus',
    :'response_time_millis' => :'responseTimeMillis',
    :'response_body_extract' => :'responseBodyExtract',
    :'result_type' => :'resultType',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'seen' => :'seen',
    :'inbox_id' => :'inboxId',
    :'email_id' => :'emailId',
    :'attachment_id' => :'attachmentId',
    :'phone_id' => :'phoneId',
    :'sms_id' => :'smsId'
  }
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



385
386
387
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 385

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
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 133

def self.openapi_nullable
  Set.new([
    :'id',
    :'redrive_id',
    :'response_status',
    :'response_body_extract',
    :'result_type',
    :'inbox_id',
    :'email_id',
    :'attachment_id',
    :'phone_id',
    :'sms_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
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_result_dto.rb', line 107

def self.openapi_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'webhook_id' => :'String',
    :'webhook_url' => :'String',
    :'message_id' => :'String',
    :'redrive_id' => :'String',
    :'http_method' => :'String',
    :'webhook_event' => :'String',
    :'response_status' => :'Integer',
    :'response_time_millis' => :'Integer',
    :'response_body_extract' => :'String',
    :'result_type' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'seen' => :'Boolean',
    :'inbox_id' => :'String',
    :'email_id' => :'String',
    :'attachment_id' => :'String',
    :'phone_id' => :'String',
    :'sms_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 345

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      webhook_id == o.webhook_id &&
      webhook_url == o.webhook_url &&
      message_id == o.message_id &&
      redrive_id == o.redrive_id &&
      http_method == o.http_method &&
      webhook_event == o.webhook_event &&
      response_status == o.response_status &&
      response_time_millis == o.response_time_millis &&
      response_body_extract == o.response_body_extract &&
      result_type == o.result_type &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      seen == o.seen &&
      inbox_id == o.inbox_id &&
      email_id == o.email_id &&
      attachment_id == o.attachment_id &&
      phone_id == o.phone_id &&
      sms_id == o.sms_id
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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 413

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



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 482

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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 392

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


372
373
374
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



378
379
380
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 378

def hash
  [id, user_id, webhook_id, webhook_url, message_id, redrive_id, http_method, webhook_event, response_status, response_time_millis, response_body_extract, result_type, created_at, updated_at, seen, inbox_id, email_id, attachment_id, phone_id, sms_id].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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 246

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

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

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

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

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

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

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

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

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

  if @seen.nil?
    invalid_properties.push('invalid value for "seen", seen 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



458
459
460
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 458

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



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 464

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



452
453
454
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 452

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/mailslurp_client/models/webhook_result_dto.rb', line 293

def valid?
  return false if @user_id.nil?
  return false if @webhook_id.nil?
  return false if @webhook_url.nil?
  return false if @message_id.nil?
  return false if @http_method.nil?
  http_method_validator = EnumAttributeValidator.new('String', ["POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE"])
  return false unless http_method_validator.valid?(@http_method)
  return false if @webhook_event.nil?
  webhook_event_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 webhook_event_validator.valid?(@webhook_event)
  return false if @response_time_millis.nil?
  result_type_validator = EnumAttributeValidator.new('String', ["BAD_RESPONSE", "EXCEPTION", "SUCCESS", "REDRIVEN"])
  return false unless result_type_validator.valid?(@result_type)
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @seen.nil?
  true
end