Class: TogaiClient::AddOn

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/add_on.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddOn

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
 
# File 'lib/togai_client/models/add_on.rb', line 106

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

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

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

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

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

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

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

Instance Attribute Details

#billable_name ⇒ Object

Billable name of addon. Billable name takes precedence over name to display in invoice.



24
25
26
 
# File 'lib/togai_client/models/add_on.rb', line 24

def billable_name
  @billable_name
end

#created_at ⇒ Object

Created Time of addon



30
31
32
 
# File 'lib/togai_client/models/add_on.rb', line 30

def created_at
  @created_at
end

#display_name ⇒ Object

Display name of addon. This is an auto-generated field which contains billableName of addon. If billableName is not provided, name will be used as display name.



36
37
38
 
# File 'lib/togai_client/models/add_on.rb', line 36

def display_name
  @display_name
end

#id ⇒ Object

Id of addon



27
28
29
 
# File 'lib/togai_client/models/add_on.rb', line 27

def id
  @id
end

#name ⇒ Object

Name of addon



19
20
21
 
# File 'lib/togai_client/models/add_on.rb', line 19

def name
  @name
end

#status ⇒ Object

status of addon



33
34
35
 
# File 'lib/togai_client/models/add_on.rb', line 33

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



21
22
23
 
# File 'lib/togai_client/models/add_on.rb', line 21

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



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
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/togai_client/models/add_on.rb', line 308

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 = TogaiClient.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



74
75
76
 
# File 'lib/togai_client/models/add_on.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/togai_client/models/add_on.rb', line 61

def self.attribute_map
  {
    :'name' => :'name',
    :'type' => :'type',
    :'billable_name' => :'billableName',
    :'id' => :'id',
    :'created_at' => :'createdAt',
    :'status' => :'status',
    :'display_name' => :'displayName'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/togai_client/models/add_on.rb', line 284

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

List of class defined in allOf (OpenAPI v3)



98
99
100
101
102
 
# File 'lib/togai_client/models/add_on.rb', line 98

def self.openapi_all_of
  [
  :'CreateAddOnRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/togai_client/models/add_on.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'type' => :'AddOnType',
    :'billable_name' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'status' => :'String',
    :'display_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/togai_client/models/add_on.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type == o.type &&
      billable_name == o.billable_name &&
      id == o.id &&
      created_at == o.created_at &&
      status == o.status &&
      display_name == o.display_name
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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/togai_client/models/add_on.rb', line 379

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


271
272
273
 
# File 'lib/togai_client/models/add_on.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/togai_client/models/add_on.rb', line 277

def hash
  [name, type, billable_name, id, created_at, status, display_name].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



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
 
# File 'lib/togai_client/models/add_on.rb', line 162

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

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

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

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

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

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

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

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



355
356
357
 
# File 'lib/togai_client/models/add_on.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/togai_client/models/add_on.rb', line 361

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



349
350
351
 
# File 'lib/togai_client/models/add_on.rb', line 349

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/togai_client/models/add_on.rb', line 202

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @type.nil?
  return false if !@billable_name.nil? && @billable_name.to_s.length > 255
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED"])
  return false unless status_validator.valid?(@status)
  return false if @display_name.nil?
  true
end