Class: Svix::TemplateOut

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateOut

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/svix/models/template_out.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#feature_flag ⇒ Object

Returns the value of attribute feature_flag.



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

def feature_flag
  @feature_flag
end

#filter_types ⇒ Object

Returns the value of attribute filter_types.



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

def filter_types
  @filter_types
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#instructions ⇒ Object

Returns the value of attribute instructions.



28
29
30
 
# File 'lib/svix/models/template_out.rb', line 28

def instructions
  @instructions
end

#instructions_link ⇒ Object

Returns the value of attribute instructions_link.



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

def instructions_link
  @instructions_link
end

#kind ⇒ Object

Returns the value of attribute kind.



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

def kind
  @kind
end

#logo ⇒ Object

Returns the value of attribute logo.



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

def 
  @logo
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#org_id ⇒ Object

Returns the value of attribute org_id.



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

def org_id
  @org_id
end

#transformation ⇒ Object

Returns the value of attribute transformation.



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

def transformation
  @transformation
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

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



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
402
403
404
405
406
407
408
409
410
 
# File 'lib/svix/models/template_out.rb', line 373

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



86
87
88
 
# File 'lib/svix/models/template_out.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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
82
83
 
# File 'lib/svix/models/template_out.rb', line 67

def self.attribute_map
  {
    :'created_at' => :'createdAt',
    :'description' => :'description',
    :'feature_flag' => :'featureFlag',
    :'filter_types' => :'filterTypes',
    :'id' => :'id',
    :'instructions' => :'instructions',
    :'instructions_link' => :'instructionsLink',
    :'kind' => :'kind',
    :'logo' => :'logo',
    :'name' => :'name',
    :'org_id' => :'orgId',
    :'transformation' => :'transformation',
    :'updated_at' => :'updatedAt'
  }
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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/svix/models/template_out.rb', line 349

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



110
111
112
113
114
115
116
 
# File 'lib/svix/models/template_out.rb', line 110

def self.openapi_nullable
  Set.new([
    :'feature_flag',
    :'filter_types',
    :'instructions_link',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/svix/models/template_out.rb', line 91

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'description' => :'String',
    :'feature_flag' => :'String',
    :'filter_types' => :'Array<String>',
    :'id' => :'String',
    :'instructions' => :'String',
    :'instructions_link' => :'String',
    :'kind' => :'TransformationTemplateKind',
    :'logo' => :'String',
    :'name' => :'String',
    :'org_id' => :'String',
    :'transformation' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      description == o.description &&
      feature_flag == o.feature_flag &&
      filter_types == o.filter_types &&
      id == o.id &&
      instructions == o.instructions &&
      instructions_link == o.instructions_link &&
      kind == o.kind &&
       == o. &&
      name == o.name &&
      org_id == o.org_id &&
      transformation == o.transformation &&
      updated_at == o.updated_at
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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/svix/models/template_out.rb', line 444

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


336
337
338
 
# File 'lib/svix/models/template_out.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



342
343
344
 
# File 'lib/svix/models/template_out.rb', line 342

def hash
  [created_at, description, feature_flag, filter_types, id, instructions, instructions_link, kind, , name, org_id, transformation, updated_at].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



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
263
264
265
266
267
 
# File 'lib/svix/models/template_out.rb', line 210

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

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

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

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

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

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

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

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

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

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

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

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

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



420
421
422
 
# File 'lib/svix/models/template_out.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/svix/models/template_out.rb', line 426

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



414
415
416
 
# File 'lib/svix/models/template_out.rb', line 414

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/svix/models/template_out.rb', line 271

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @description.nil?
  return false if !@feature_flag.nil? && @feature_flag.to_s.length > 256
  return false if !@feature_flag.nil? && @feature_flag !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  return false if !@filter_types.nil? && @filter_types.length < 1
  return false if @id.nil?
  return false if @instructions.nil?
  return false if @kind.nil?
  return false if @logo.nil?
  return false if @name.nil?
  return false if @org_id.nil?
  return false if @transformation.nil?
  return false if @updated_at.nil?
  true
end