Class: Airthings::GetLocationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/airthings/models/get_location_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetLocationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
# File 'lib/airthings/models/get_location_response.rb', line 99

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError, "The input argument (attributes) must be a hash in `Airthings::GetLocationResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError, "`#{k}` is not a valid attribute in `Airthings::GetLocationResponse`. 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
  end

  self.id = attributes[:id] if attributes.key?(:id)

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

  if attributes.key?(:labels) && (value = attributes[:labels]).is_a?(Hash)
    self.labels = value
  end

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

  self.address = attributes[:address] if attributes.key?(:address)

  self.country_code = attributes[:country_code] if attributes.key?(:country_code)

  self.lat = attributes[:lat] if attributes.key?(:lat)

  self.lng = attributes[:lng] if attributes.key?(:lng)

  self.building_type = attributes[:building_type] if attributes.key?(:building_type)

  self.building_year = attributes[:building_year] if attributes.key?(:building_year)

  self.ventilation_type = attributes[:ventilation_type] if attributes.key?(:ventilation_type)

  self.timezone = attributes[:timezone] if attributes.key?(:timezone)

  if attributes.key?(:usage_hours) && (value = attributes[:usage_hours]).is_a?(Hash)
    self.usage_hours = value
  end

  self.building_height = attributes[:building_height] if attributes.key?(:building_height)

  self.building_size = attributes[:building_size] if attributes.key?(:building_size)

  self.building_volume = attributes[:building_volume] if attributes.key?(:building_volume)

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

Instance Attribute Details

#addressObject

Returns the value of attribute address.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def address
  @address
end

#building_heightObject

Returns the value of attribute building_height.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def building_height
  @building_height
end

#building_sizeObject

Returns the value of attribute building_size.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def building_size
  @building_size
end

#building_typeObject

Returns the value of attribute building_type.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def building_type
  @building_type
end

#building_volumeObject

Returns the value of attribute building_volume.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def building_volume
  @building_volume
end

#building_yearObject

Returns the value of attribute building_year.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def building_year
  @building_year
end

#country_codeObject

Returns the value of attribute country_code.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def country_code
  @country_code
end

#devicesObject

Returns the value of attribute devices.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def devices
  @devices
end

#floorsObject

Returns the value of attribute floors.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def floors
  @floors
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def id
  @id
end

#labelsObject

Returns the value of attribute labels.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def labels
  @labels
end

#latObject

Returns the value of attribute lat.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def lat
  @lat
end

#lngObject

Returns the value of attribute lng.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def lng
  @lng
end

#nameObject

Returns the value of attribute name.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def name
  @name
end

#timezoneObject

Returns the value of attribute timezone.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def timezone
  @timezone
end

#usage_hoursObject

Returns the value of attribute usage_hours.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def usage_hours
  @usage_hours
end

#ventilation_typeObject

Returns the value of attribute ventilation_type.



18
19
20
# File 'lib/airthings/models/get_location_response.rb', line 18

def ventilation_type
  @ventilation_type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



65
66
67
# File 'lib/airthings/models/get_location_response.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/airthings/models/get_location_response.rb', line 42

def self.attribute_map
  {
    id: :id,
    name: :name,
    labels: :labels,
    devices: :devices,
    address: :address,
    country_code: :countryCode,
    lat: :lat,
    lng: :lng,
    building_type: :buildingType,
    building_year: :buildingYear,
    ventilation_type: :ventilationType,
    timezone: :timezone,
    usage_hours: :usageHours,
    building_height: :buildingHeight,
    building_size: :buildingSize,
    building_volume: :buildingVolume,
    floors: :floors
  }
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



254
255
256
# File 'lib/airthings/models/get_location_response.rb', line 254

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

.openapi_nullableObject

List of attributes with nullable: true



93
94
95
# File 'lib/airthings/models/get_location_response.rb', line 93

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

.openapi_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/airthings/models/get_location_response.rb', line 70

def self.openapi_types
  {
    id: :String,
    name: :String,
    labels: :"Hash<String, String>",
    devices: :"Array<DeviceSimpleResponse>",
    address: :String,
    country_code: :String,
    lat: :Float,
    lng: :Float,
    building_type: :String,
    building_year: :Integer,
    ventilation_type: :String,
    timezone: :String,
    usage_hours: :"Hash<String, LocationUsage>",
    building_height: :Float,
    building_size: :Float,
    building_volume: :Float,
    floors: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/airthings/models/get_location_response.rb', line 216

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    labels == other.labels &&
    devices == other.devices &&
    address == other.address &&
    country_code == other.country_code &&
    lat == other.lat &&
    lng == other.lng &&
    building_type == other.building_type &&
    building_year == other.building_year &&
    ventilation_type == other.ventilation_type &&
    timezone == other.timezone &&
    usage_hours == other.usage_hours &&
    building_height == other.building_height &&
    building_size == other.building_size &&
    building_volume == other.building_volume &&
    floors == other.floors
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



286
287
288
289
290
291
292
293
294
295
296
297
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
# File 'lib/airthings/models/get_location_response.rb', line 286

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



357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'lib/airthings/models/get_location_response.rb', line 357

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/airthings/models/get_location_response.rb', line 261

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
# File 'lib/airthings/models/get_location_response.rb', line 241

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



247
248
249
# File 'lib/airthings/models/get_location_response.rb', line 247

def hash
  [id, name, labels, devices, address, country_code, lat, lng, building_type, building_year, ventilation_type, timezone, usage_hours, building_height, building_size, building_volume, floors].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/airthings/models/get_location_response.rb', line 156

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "id", id cannot be nil.') if @id.nil?

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



333
334
335
# File 'lib/airthings/models/get_location_response.rb', line 333

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/airthings/models/get_location_response.rb', line 339

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



327
328
329
# File 'lib/airthings/models/get_location_response.rb', line 327

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/airthings/models/get_location_response.rb', line 175

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @labels.nil?
  return false if @devices.nil?
  return false if @lat.nil?
  return false if @lng.nil?

  building_type_validator = EnumAttributeValidator.new("String", %w[SCHOOL RESIDENTIAL APARTMENT KINDERGARTEN HEALTHCENTER OFFICE OTHER])
  return false unless building_type_validator.valid?(@building_type)

  ventilation_type_validator = EnumAttributeValidator.new("String", %w[NATURAL MECHANICAL BALANCED])
  return false unless ventilation_type_validator.valid?(@ventilation_type)

  true
end