Class: Svix::MessageAttemptOut

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/message_attempt_out.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageAttemptOut

Initializes the object

Parameters:

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

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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
# File 'lib/svix/models/message_attempt_out.rb', line 113

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

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

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

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

  if attributes.key?(:'response')
    self.response = attributes[:'response']
  else
    self.response = nil
  end

  if attributes.key?(:'response_duration_ms')
    self.response_duration_ms = attributes[:'response_duration_ms']
  else
    self.response_duration_ms = nil
  end

  if attributes.key?(:'response_status_code')
    self.response_status_code = attributes[:'response_status_code']
  else
    self.response_status_code = nil
  end

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

  if attributes.key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  else
    self.timestamp = nil
  end

  if attributes.key?(:'trigger_type')
    self.trigger_type = attributes[:'trigger_type']
  else
    self.trigger_type = nil
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  else
    self.url = nil
  end
end

Instance Attribute Details

#endpoint_idObject

The ep’s ID



19
20
21
# File 'lib/svix/models/message_attempt_out.rb', line 19

def endpoint_id
  @endpoint_id
end

#idObject

The attempt’s ID



22
23
24
# File 'lib/svix/models/message_attempt_out.rb', line 22

def id
  @id
end

#msgObject

Returns the value of attribute msg.



24
25
26
# File 'lib/svix/models/message_attempt_out.rb', line 24

def msg
  @msg
end

#msg_idObject

The msg’s ID



27
28
29
# File 'lib/svix/models/message_attempt_out.rb', line 27

def msg_id
  @msg_id
end

#responseObject

Returns the value of attribute response.



29
30
31
# File 'lib/svix/models/message_attempt_out.rb', line 29

def response
  @response
end

#response_duration_msObject

Response duration in milliseconds.



32
33
34
# File 'lib/svix/models/message_attempt_out.rb', line 32

def response_duration_ms
  @response_duration_ms
end

#response_status_codeObject

Returns the value of attribute response_status_code.



34
35
36
# File 'lib/svix/models/message_attempt_out.rb', line 34

def response_status_code
  @response_status_code
end

#statusObject

Returns the value of attribute status.



36
37
38
# File 'lib/svix/models/message_attempt_out.rb', line 36

def status
  @status
end

#timestampObject

Returns the value of attribute timestamp.



38
39
40
# File 'lib/svix/models/message_attempt_out.rb', line 38

def timestamp
  @timestamp
end

#trigger_typeObject

Returns the value of attribute trigger_type.



40
41
42
# File 'lib/svix/models/message_attempt_out.rb', line 40

def trigger_type
  @trigger_type
end

#urlObject

Returns the value of attribute url.



42
43
44
# File 'lib/svix/models/message_attempt_out.rb', line 42

def url
  @url
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



341
342
343
344
345
346
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
# File 'lib/svix/models/message_attempt_out.rb', line 341

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 = Svix.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_attributesObject

Returns all the JSON keys this model knows about



84
85
86
# File 'lib/svix/models/message_attempt_out.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/svix/models/message_attempt_out.rb', line 67

def self.attribute_map
  {
    :'endpoint_id' => :'endpointId',
    :'id' => :'id',
    :'msg' => :'msg',
    :'msg_id' => :'msgId',
    :'response' => :'response',
    :'response_duration_ms' => :'responseDurationMs',
    :'response_status_code' => :'responseStatusCode',
    :'status' => :'status',
    :'timestamp' => :'timestamp',
    :'trigger_type' => :'triggerType',
    :'url' => :'url'
  }
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/svix/models/message_attempt_out.rb', line 317

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_nullableObject

List of attributes with nullable: true



106
107
108
109
# File 'lib/svix/models/message_attempt_out.rb', line 106

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/svix/models/message_attempt_out.rb', line 89

def self.openapi_types
  {
    :'endpoint_id' => :'String',
    :'id' => :'String',
    :'msg' => :'MessageOut',
    :'msg_id' => :'String',
    :'response' => :'String',
    :'response_duration_ms' => :'Integer',
    :'response_status_code' => :'Integer',
    :'status' => :'MessageStatus',
    :'timestamp' => :'Time',
    :'trigger_type' => :'MessageAttemptTriggerType',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/svix/models/message_attempt_out.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      endpoint_id == o.endpoint_id &&
      id == o.id &&
      msg == o.msg &&
      msg_id == o.msg_id &&
      response == o.response &&
      response_duration_ms == o.response_duration_ms &&
      response_status_code == o.response_status_code &&
      status == o.status &&
      timestamp == o.timestamp &&
      trigger_type == o.trigger_type &&
      url == o.url
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



412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/svix/models/message_attempt_out.rb', line 412

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


304
305
306
# File 'lib/svix/models/message_attempt_out.rb', line 304

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



310
311
312
# File 'lib/svix/models/message_attempt_out.rb', line 310

def hash
  [endpoint_id, id, msg, msg_id, response, response_duration_ms, response_status_code, status, timestamp, trigger_type, url].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/svix/models/message_attempt_out.rb', line 193

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @endpoint_id.nil?
    invalid_properties.push('invalid value for "endpoint_id", endpoint_id cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

  if @url.to_s.length > 65536
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 65536.')
  end

  if @url.to_s.length < 1
    invalid_properties.push('invalid value for "url", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



388
389
390
# File 'lib/svix/models/message_attempt_out.rb', line 388

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'lib/svix/models/message_attempt_out.rb', line 394

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



382
383
384
# File 'lib/svix/models/message_attempt_out.rb', line 382

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/svix/models/message_attempt_out.rb', line 249

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @endpoint_id.nil?
  return false if @id.nil?
  return false if @msg_id.nil?
  return false if @response.nil?
  return false if @response_duration_ms.nil?
  return false if @response_status_code.nil?
  return false if @status.nil?
  return false if @timestamp.nil?
  return false if @trigger_type.nil?
  return false if @url.nil?
  return false if @url.to_s.length > 65536
  return false if @url.to_s.length < 1
  true
end