Class: Svix::TemplateIn

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateIn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
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/template_in.rb', line 82

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#feature_flag ⇒ Object

Returns the value of attribute feature_flag.



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

def feature_flag
  @feature_flag
end

#filter_types ⇒ Object

Returns the value of attribute filter_types.



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

def filter_types
  @filter_types
end

#instructions ⇒ Object

Returns the value of attribute instructions.



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

def instructions
  @instructions
end

#instructions_link ⇒ Object

Returns the value of attribute instructions_link.



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

def instructions_link
  @instructions_link
end

#kind ⇒ Object

Returns the value of attribute kind.



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

def kind
  @kind
end

#logo ⇒ Object

Returns the value of attribute logo.



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

def 
  @logo
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#transformation ⇒ Object

Returns the value of attribute transformation.



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

def transformation
  @transformation
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/svix/models/template_in.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/svix/models/template_in.rb', line 37

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



268
269
270
 
# File 'lib/svix/models/template_in.rb', line 268

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
76
77
78
 
# File 'lib/svix/models/template_in.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/svix/models/template_in.rb', line 57

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/svix/models/template_in.rb', line 239

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



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
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/svix/models/template_in.rb', line 298

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/svix/models/template_in.rb', line 369

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/svix/models/template_in.rb', line 275

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


255
256
257
 
# File 'lib/svix/models/template_in.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/svix/models/template_in.rb', line 261

def hash
  [description, feature_flag, filter_types, instructions, instructions_link, kind, , name, transformation].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
 
# File 'lib/svix/models/template_in.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  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 @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 @transformation.nil?
    invalid_properties.push('invalid value for "transformation", transformation cannot be nil.')
  end

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

  if @transformation.to_s.length < 10
    invalid_properties.push('invalid value for "transformation", the character length must be great than or equal to 10.')
  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



345
346
347
 
# File 'lib/svix/models/template_in.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/svix/models/template_in.rb', line 351

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



339
340
341
 
# File 'lib/svix/models/template_in.rb', line 339

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



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/svix/models/template_in.rb', line 182

def valid?
  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 @logo.nil?
  return false if @name.nil?
  return false if @transformation.nil?
  return false if @transformation.to_s.length > 51200
  return false if @transformation.to_s.length < 10
  true
end