Class: Svix::MessageIn

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/svix/models/message_in.rb', line 93

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

  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?(:'payload')
    self.payload = attributes[:'payload']
  else
    self.payload = nil
  end

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

  if attributes.key?(:'payload_retention_period')
    self.payload_retention_period = attributes[:'payload_retention_period']
  else
    self.payload_retention_period = 90
  end

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

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

Instance Attribute Details

#application ⇒ Object

Returns the value of attribute application.



18
19
20
 
# File 'lib/svix/models/message_in.rb', line 18

def application
  @application
end

#channels ⇒ Object

List of free-form identifiers that endpoints can filter by



21
22
23
 
# File 'lib/svix/models/message_in.rb', line 21

def channels
  @channels
end

#event_id ⇒ Object

Optional unique identifier for the message



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

def event_id
  @event_id
end

#event_type ⇒ Object

The event type’s name



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

def event_type
  @event_type
end

#payload ⇒ Object

JSON payload to send as the request body of the webhook. We also support sending non-JSON payloads. Please contact us for more information.



30
31
32
 
# File 'lib/svix/models/message_in.rb', line 30

def payload
  @payload
end

#payload_retention_hours ⇒ Object

Optional number of hours to retain the message payload. Note that this is mutually exclusive with ‘payloadRetentionPeriod`.



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

def payload_retention_hours
  @payload_retention_hours
end

#payload_retention_period ⇒ Object

Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with ‘payloadRetentionHours`.



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

def payload_retention_period
  @payload_retention_period
end

#tags ⇒ Object

List of free-form tags that can be filtered by when listing messages



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

def tags
  @tags
end

#transformations_params ⇒ Object

Extra parameters to pass to Transformations (for future use)



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

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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/svix/models/message_in.rb', line 394

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



60
61
62
 
# File 'lib/svix/models/message_in.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/svix/models/message_in.rb', line 45

def self.attribute_map
  {
    :'application' => :'application',
    :'channels' => :'channels',
    :'event_id' => :'eventId',
    :'event_type' => :'eventType',
    :'payload' => :'payload',
    :'payload_retention_hours' => :'payloadRetentionHours',
    :'payload_retention_period' => :'payloadRetentionPeriod',
    :'tags' => :'tags',
    :'transformations_params' => :'transformationsParams'
  }
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/svix/models/message_in.rb', line 370

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



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/svix/models/message_in.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'application' => :'ApplicationIn',
    :'channels' => :'Array<String>',
    :'event_id' => :'String',
    :'event_type' => :'String',
    :'payload' => :'Object',
    :'payload_retention_hours' => :'Integer',
    :'payload_retention_period' => :'Integer',
    :'tags' => :'Array<String>',
    :'transformations_params' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application == o.application &&
      channels == o.channels &&
      event_id == o.event_id &&
      event_type == o.event_type &&
      payload == o.payload &&
      payload_retention_hours == o.payload_retention_hours &&
      payload_retention_period == o.payload_retention_period &&
      tags == o.tags &&
      transformations_params == o.transformations_params
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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/svix/models/message_in.rb', line 465

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


357
358
359
 
# File 'lib/svix/models/message_in.rb', line 357

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



363
364
365
 
# File 'lib/svix/models/message_in.rb', line 363

def hash
  [application, channels, event_id, event_type, payload, payload_retention_hours, payload_retention_period, tags, transformations_params].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



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

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

  if !@payload_retention_hours.nil? && @payload_retention_hours > 2160
    invalid_properties.push('invalid value for "payload_retention_hours", must be smaller than or equal to 2160.')
  end

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

  if !@payload_retention_period.nil? && @payload_retention_period > 90
    invalid_properties.push('invalid value for "payload_retention_period", must be smaller than or equal to 90.')
  end

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

  if !@tags.nil? && @tags.length > 5
    invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 5.')
  end

  if !@tags.nil? && @tags.length < 1
    invalid_properties.push('invalid value for "tags", number of items must be greater 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



441
442
443
 
# File 'lib/svix/models/message_in.rb', line 441

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/svix/models/message_in.rb', line 447

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



435
436
437
 
# File 'lib/svix/models/message_in.rb', line 435

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/svix/models/message_in.rb', line 225

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 @payload.nil?
  return false if !@payload_retention_hours.nil? && @payload_retention_hours > 2160
  return false if !@payload_retention_hours.nil? && @payload_retention_hours < 1
  return false if !@payload_retention_period.nil? && @payload_retention_period > 90
  return false if !@payload_retention_period.nil? && @payload_retention_period < 1
  return false if !@tags.nil? && @tags.length > 5
  return false if !@tags.nil? && @tags.length < 1
  true
end