Class: Svix::EndpointMessageOut

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

Overview

A model containing information on a given message plus additional fields on the last attempt for that message.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointMessageOut

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#channels ⇒ Object

List of free-form identifiers that endpoints can filter by



20
21
22
 
# File 'lib/svix/models/endpoint_message_out.rb', line 20

def channels
  @channels
end

#event_id ⇒ Object

Optional unique identifier for the message



23
24
25
 
# File 'lib/svix/models/endpoint_message_out.rb', line 23

def event_id
  @event_id
end

#event_type ⇒ Object

The event type’s name



26
27
28
 
# File 'lib/svix/models/endpoint_message_out.rb', line 26

def event_type
  @event_type
end

#id ⇒ Object

The msg’s ID



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

def id
  @id
end

#next_attempt ⇒ Object

Returns the value of attribute next_attempt.



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

def next_attempt
  @next_attempt
end

#payload ⇒ Object

Returns the value of attribute payload.



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

def payload
  @payload
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



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

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



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
395
396
397
398
399
400
401
 
# File 'lib/svix/models/endpoint_message_out.rb', line 364

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'channels' => :'channels',
    :'event_id' => :'eventId',
    :'event_type' => :'eventType',
    :'id' => :'id',
    :'next_attempt' => :'nextAttempt',
    :'payload' => :'payload',
    :'status' => :'status',
    :'tags' => :'tags',
    :'timestamp' => :'timestamp'
  }
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/svix/models/endpoint_message_out.rb', line 340

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_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
106
 
# File 'lib/svix/models/endpoint_message_out.rb', line 99

def self.openapi_nullable
  Set.new([
    :'channels',
    :'event_id',
    :'next_attempt',
    :'tags',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/svix/models/endpoint_message_out.rb', line 84

def self.openapi_types
  {
    :'channels' => :'Array<String>',
    :'event_id' => :'String',
    :'event_type' => :'String',
    :'id' => :'String',
    :'next_attempt' => :'Time',
    :'payload' => :'Object',
    :'status' => :'MessageStatus',
    :'tags' => :'Array<String>',
    :'timestamp' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/svix/models/endpoint_message_out.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channels == o.channels &&
      event_id == o.event_id &&
      event_type == o.event_type &&
      id == o.id &&
      next_attempt == o.next_attempt &&
      payload == o.payload &&
      status == o.status &&
      tags == o.tags &&
      timestamp == o.timestamp
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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/svix/models/endpoint_message_out.rb', line 435

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


327
328
329
 
# File 'lib/svix/models/endpoint_message_out.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



333
334
335
 
# File 'lib/svix/models/endpoint_message_out.rb', line 333

def hash
  [channels, event_id, event_type, id, next_attempt, payload, status, tags, timestamp].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@channels.nil? && @channels.length > 10
    invalid_properties.push('invalid value for "channels", number of items must be less than or equal to 10.')
  end

  if !@channels.nil? && @channels.length < 1
    invalid_properties.push('invalid value for "channels", number of items must be greater than or equal to 1.')
  end

  if !@event_id.nil? && @event_id.to_s.length > 256
    invalid_properties.push('invalid value for "event_id", the character length must be smaller than or equal to 256.')
  end

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

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if !@event_id.nil? && @event_id !~ pattern
    invalid_properties.push("invalid value for \"event_id\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @event_type !~ pattern
    invalid_properties.push("invalid value for \"event_type\", must conform to the pattern #{pattern}.")
  end

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

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

  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



411
412
413
 
# File 'lib/svix/models/endpoint_message_out.rb', line 411

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/svix/models/endpoint_message_out.rb', line 417

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



405
406
407
 
# File 'lib/svix/models/endpoint_message_out.rb', line 405

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/svix/models/endpoint_message_out.rb', line 234

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@channels.nil? && @channels.length > 10
  return false if !@channels.nil? && @channels.length < 1
  return false if !@event_id.nil? && @event_id.to_s.length > 256
  return false if !@event_id.nil? && @event_id.to_s.length < 1
  return false if !@event_id.nil? && @event_id !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if @event_type.nil?
  return false if @event_type.to_s.length > 256
  return false if @event_type !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if @id.nil?
  return false if @payload.nil?
  return false if @status.nil?
  return false if @timestamp.nil?
  true
end