Class: Zyphr::WebhookDeliveryDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/models/webhook_delivery_detail.rb

Overview

Full delivery object with payload, headers, and response details

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookDeliveryDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 169

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attempts ⇒ Object

Returns the value of attribute attempts.



29
30
31
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 29

def attempts
  @attempts
end

#completed_at ⇒ Object

Returns the value of attribute completed_at.



45
46
47
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 45

def completed_at
  @completed_at
end

#created_at ⇒ Object

Returns the value of attribute created_at.



49
50
51
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 49

def created_at
  @created_at
end

#delivery_region ⇒ Object

Returns the value of attribute delivery_region.



47
48
49
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 47

def delivery_region
  @delivery_region
end

#event_id ⇒ Object

Returns the value of attribute event_id.



23
24
25
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 23

def event_id
  @event_id
end

#event_type ⇒ Object

Returns the value of attribute event_type.



25
26
27
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 25

def event_type
  @event_type
end

#first_attempted_at ⇒ Object

Returns the value of attribute first_attempted_at.



41
42
43
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 41

def first_attempted_at
  @first_attempted_at
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 19

def id
  @id
end

#last_attempted_at ⇒ Object

Returns the value of attribute last_attempted_at.



43
44
45
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 43

def last_attempted_at
  @last_attempted_at
end

#last_error ⇒ Object

Returns the value of attribute last_error.



39
40
41
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 39

def last_error
  @last_error
end

#last_response_body ⇒ Object

Returns the value of attribute last_response_body.



53
54
55
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 53

def last_response_body
  @last_response_body
end

#last_response_status ⇒ Object

Returns the value of attribute last_response_status.



35
36
37
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 35

def last_response_status
  @last_response_status
end

#latency_ms ⇒ Object

Returns the value of attribute latency_ms.



37
38
39
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 37

def latency_ms
  @latency_ms
end

#max_attempts ⇒ Object

Returns the value of attribute max_attempts.



31
32
33
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 31

def max_attempts
  @max_attempts
end

#msg_id ⇒ Object

Returns the value of attribute msg_id.



21
22
23
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 21

def msg_id
  @msg_id
end

#next_attempt_at ⇒ Object

Returns the value of attribute next_attempt_at.



33
34
35
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 33

def next_attempt_at
  @next_attempt_at
end

#payload ⇒ Object

Returns the value of attribute payload.



51
52
53
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 51

def payload
  @payload
end

#request_headers ⇒ Object

Returns the value of attribute request_headers.



55
56
57
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 55

def request_headers
  @request_headers
end

#response_headers ⇒ Object

Returns the value of attribute response_headers.



57
58
59
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 57

def response_headers
  @response_headers
end

#status ⇒ Object

Returns the value of attribute status.



27
28
29
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 27

def status
  @status
end

Class Method Details

._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



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
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 357

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Zyphr.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



108
109
110
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 108

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 113

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'msg_id' => :'msg_id',
    :'event_id' => :'event_id',
    :'event_type' => :'event_type',
    :'status' => :'status',
    :'attempts' => :'attempts',
    :'max_attempts' => :'max_attempts',
    :'next_attempt_at' => :'next_attempt_at',
    :'last_response_status' => :'last_response_status',
    :'latency_ms' => :'latency_ms',
    :'last_error' => :'last_error',
    :'first_attempted_at' => :'first_attempted_at',
    :'last_attempted_at' => :'last_attempted_at',
    :'completed_at' => :'completed_at',
    :'delivery_region' => :'delivery_region',
    :'created_at' => :'created_at',
    :'payload' => :'payload',
    :'last_response_body' => :'last_response_body',
    :'request_headers' => :'request_headers',
    :'response_headers' => :'response_headers'
  }
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 333

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



161
162
163
164
165
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 161

def self.openapi_all_of
  [
  :'WebhookDelivery'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 144

def self.openapi_nullable
  Set.new([
    :'next_attempt_at',
    :'last_response_status',
    :'latency_ms',
    :'last_error',
    :'first_attempted_at',
    :'last_attempted_at',
    :'completed_at',
    :'delivery_region',
    :'last_response_body',
    :'request_headers',
    :'response_headers'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 118

def self.openapi_types
  {
    :'id' => :'String',
    :'msg_id' => :'String',
    :'event_id' => :'String',
    :'event_type' => :'String',
    :'status' => :'String',
    :'attempts' => :'Integer',
    :'max_attempts' => :'Integer',
    :'next_attempt_at' => :'Time',
    :'last_response_status' => :'Integer',
    :'latency_ms' => :'Integer',
    :'last_error' => :'String',
    :'first_attempted_at' => :'Time',
    :'last_attempted_at' => :'Time',
    :'completed_at' => :'Time',
    :'delivery_region' => :'String',
    :'created_at' => :'Time',
    :'payload' => :'Object',
    :'last_response_body' => :'String',
    :'request_headers' => :'Object',
    :'response_headers' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      msg_id == o.msg_id &&
      event_id == o.event_id &&
      event_type == o.event_type &&
      status == o.status &&
      attempts == o.attempts &&
      max_attempts == o.max_attempts &&
      next_attempt_at == o.next_attempt_at &&
      last_response_status == o.last_response_status &&
      latency_ms == o.latency_ms &&
      last_error == o.last_error &&
      first_attempted_at == o.first_attempted_at &&
      last_attempted_at == o.last_attempted_at &&
      completed_at == o.completed_at &&
      delivery_region == o.delivery_region &&
      created_at == o.created_at &&
      payload == o.payload &&
      last_response_body == o.last_response_body &&
      request_headers == o.request_headers &&
      response_headers == o.response_headers
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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 428

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



326
327
328
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 326

def hash
  [id, msg_id, event_id, event_type, status, attempts, max_attempts, next_attempt_at, last_response_status, latency_ms, last_error, first_attempted_at, last_attempted_at, completed_at, delivery_region, created_at, payload, last_response_body, request_headers, response_headers].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



266
267
268
269
270
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 266

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



404
405
406
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 404

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 410

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



398
399
400
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 398

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



274
275
276
277
278
279
 
# File 'lib/zyphr/models/webhook_delivery_detail.rb', line 274

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["pending", "delivering", "delivered", "failed", "exhausted"])
  return false unless status_validator.valid?(@status)
  true
end