Class: Svix::MessageAttemptOut

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

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/svix/models/message_attempt_out.rb', line 86

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']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#endpoint_id ⇒ Object

The ep’s ID



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

def endpoint_id
  @endpoint_id
end

#id ⇒ Object

The attempt’s ID



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

def id
  @id
end

#msg ⇒ Object

Returns the value of attribute msg.



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

def msg
  @msg
end

#msg_id ⇒ Object

The msg’s ID



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

def msg_id
  @msg_id
end

#response ⇒ Object

Returns the value of attribute response.



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

def response
  @response
end

#response_status_code ⇒ Object

Returns the value of attribute response_status_code.



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

def response_status_code
  @response_status_code
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



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

def timestamp
  @timestamp
end

#trigger_type ⇒ Object

Returns the value of attribute trigger_type.



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

def trigger_type
  @trigger_type
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/svix/models/message_attempt_out.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/svix/models/message_attempt_out.rb', line 42

def self.attribute_map
  {
    :'endpoint_id' => :'endpointId',
    :'id' => :'id',
    :'msg' => :'msg',
    :'msg_id' => :'msgId',
    :'response' => :'response',
    :'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



258
259
260
 
# File 'lib/svix/models/message_attempt_out.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/svix/models/message_attempt_out.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/svix/models/message_attempt_out.rb', line 63

def self.openapi_types
  {
    :'endpoint_id' => :'String',
    :'id' => :'String',
    :'msg' => :'MessageOut',
    :'msg_id' => :'String',
    :'response' => :'String',
    :'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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/svix/models/message_attempt_out.rb', line 228

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_status_code == o.response_status_code &&
      status == o.status &&
      timestamp == o.timestamp &&
      trigger_type == o.trigger_type &&
      url == o.url
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/svix/models/message_attempt_out.rb', line 288

def _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_one_of) ? klass.build(value) : klass.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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/svix/models/message_attempt_out.rb', line 359

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/svix/models/message_attempt_out.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/svix/models/message_attempt_out.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/svix/models/message_attempt_out.rb', line 251

def hash
  [endpoint_id, id, msg, msg_id, response, response_status_code, status, timestamp, trigger_type, url].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



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 142

def list_invalid_properties
  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_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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
 
# File 'lib/svix/models/message_attempt_out.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/svix/models/message_attempt_out.rb', line 341

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



329
330
331
 
# File 'lib/svix/models/message_attempt_out.rb', line 329

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/svix/models/message_attempt_out.rb', line 193

def valid?
  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_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