Class: AvmClient::AdditionalFeatures

Inherits:
Object
  • Object
show all
Defined in:
lib/avm_client/models/additional_features.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdditionalFeatures

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/avm_client/models/additional_features.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#annual_energy_consumption_in_k_wh ⇒ Object

Returns the value of attribute annual_energy_consumption_in_k_wh.



49
50
51
 
# File 'lib/avm_client/models/additional_features.rb', line 49

def annual_energy_consumption_in_k_wh
  @annual_energy_consumption_in_k_wh
end

#annual_heating_cost_in_pounds ⇒ Object

Returns the value of attribute annual_heating_cost_in_pounds.



43
44
45
 
# File 'lib/avm_client/models/additional_features.rb', line 43

def annual_heating_cost_in_pounds
  @annual_heating_cost_in_pounds
end

#annual_hot_water_cost_in_pounds ⇒ Object

Returns the value of attribute annual_hot_water_cost_in_pounds.



45
46
47
 
# File 'lib/avm_client/models/additional_features.rb', line 45

def annual_hot_water_cost_in_pounds
  @annual_hot_water_cost_in_pounds
end

#annual_lighting_cost_in_pounds ⇒ Object

Returns the value of attribute annual_lighting_cost_in_pounds.



47
48
49
 
# File 'lib/avm_client/models/additional_features.rb', line 47

def annual_lighting_cost_in_pounds
  @annual_lighting_cost_in_pounds
end

#built_form ⇒ Object

Returns the value of attribute built_form.



53
54
55
 
# File 'lib/avm_client/models/additional_features.rb', line 53

def built_form
  @built_form
end

#current_energy_rating ⇒ Object

Returns the value of attribute current_energy_rating.



39
40
41
 
# File 'lib/avm_client/models/additional_features.rb', line 39

def current_energy_rating
  @current_energy_rating
end

#date_of_previous_sale ⇒ Object

Returns the value of attribute date_of_previous_sale.



19
20
21
 
# File 'lib/avm_client/models/additional_features.rb', line 19

def date_of_previous_sale
  @date_of_previous_sale
end

#floor_height_in_foot ⇒ Object

Returns the value of attribute floor_height_in_foot.



51
52
53
 
# File 'lib/avm_client/models/additional_features.rb', line 51

def floor_height_in_foot
  @floor_height_in_foot
end

#leasehold_or_freehold ⇒ Object

Returns the value of attribute leasehold_or_freehold.



21
22
23
 
# File 'lib/avm_client/models/additional_features.rb', line 21

def leasehold_or_freehold
  @leasehold_or_freehold
end

#potential_energy_rating ⇒ Object

Returns the value of attribute potential_energy_rating.



41
42
43
 
# File 'lib/avm_client/models/additional_features.rb', line 41

def potential_energy_rating
  @potential_energy_rating
end

#price_of_previous_sale ⇒ Object

Returns the value of attribute price_of_previous_sale.



17
18
19
 
# File 'lib/avm_client/models/additional_features.rb', line 17

def price_of_previous_sale
  @price_of_previous_sale
end

#roof_energy_efficiency ⇒ Object

Returns the value of attribute roof_energy_efficiency.



33
34
35
 
# File 'lib/avm_client/models/additional_features.rb', line 33

def roof_energy_efficiency
  @roof_energy_efficiency
end

#roof_insulation ⇒ Object

Returns the value of attribute roof_insulation.



31
32
33
 
# File 'lib/avm_client/models/additional_features.rb', line 31

def roof_insulation
  @roof_insulation
end

#roof_type ⇒ Object

Returns the value of attribute roof_type.



29
30
31
 
# File 'lib/avm_client/models/additional_features.rb', line 29

def roof_type
  @roof_type
end

#wall_energy_efficiency ⇒ Object

Returns the value of attribute wall_energy_efficiency.



27
28
29
 
# File 'lib/avm_client/models/additional_features.rb', line 27

def wall_energy_efficiency
  @wall_energy_efficiency
end

#wall_insulation ⇒ Object

Returns the value of attribute wall_insulation.



25
26
27
 
# File 'lib/avm_client/models/additional_features.rb', line 25

def wall_insulation
  @wall_insulation
end

#wall_type ⇒ Object

Returns the value of attribute wall_type.



23
24
25
 
# File 'lib/avm_client/models/additional_features.rb', line 23

def wall_type
  @wall_type
end

#window_energy_efficiency ⇒ Object

Returns the value of attribute window_energy_efficiency.



37
38
39
 
# File 'lib/avm_client/models/additional_features.rb', line 37

def window_energy_efficiency
  @window_energy_efficiency
end

#window_glazing_type ⇒ Object

Returns the value of attribute window_glazing_type.



35
36
37
 
# File 'lib/avm_client/models/additional_features.rb', line 35

def window_glazing_type
  @window_glazing_type
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/avm_client/models/additional_features.rb', line 56

def self.attribute_map
  {
    :'price_of_previous_sale' => :'priceOfPreviousSale',
    :'date_of_previous_sale' => :'dateOfPreviousSale',
    :'leasehold_or_freehold' => :'leaseholdOrFreehold',
    :'wall_type' => :'wallType',
    :'wall_insulation' => :'wallInsulation',
    :'wall_energy_efficiency' => :'wallEnergyEfficiency',
    :'roof_type' => :'roofType',
    :'roof_insulation' => :'roofInsulation',
    :'roof_energy_efficiency' => :'roofEnergyEfficiency',
    :'window_glazing_type' => :'windowGlazingType',
    :'window_energy_efficiency' => :'windowEnergyEfficiency',
    :'current_energy_rating' => :'currentEnergyRating',
    :'potential_energy_rating' => :'potentialEnergyRating',
    :'annual_heating_cost_in_pounds' => :'annualHeatingCostInPounds',
    :'annual_hot_water_cost_in_pounds' => :'annualHotWaterCostInPounds',
    :'annual_lighting_cost_in_pounds' => :'annualLightingCostInPounds',
    :'annual_energy_consumption_in_k_wh' => :'annualEnergyConsumptionInKWh',
    :'floor_height_in_foot' => :'floorHeightInFoot',
    :'built_form' => :'builtForm'
  }
end

.avm_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/avm_client/models/additional_features.rb', line 81

def self.avm_types
  {
    :'price_of_previous_sale' => :'Integer',
    :'date_of_previous_sale' => :'Date',
    :'leasehold_or_freehold' => :'LeaseholdOrFreehold',
    :'wall_type' => :'WallType',
    :'wall_insulation' => :'WallInsulation',
    :'wall_energy_efficiency' => :'EnergyEfficiency',
    :'roof_type' => :'RoofType',
    :'roof_insulation' => :'RoofInsulation',
    :'roof_energy_efficiency' => :'EnergyEfficiency',
    :'window_glazing_type' => :'WindowGlazingType',
    :'window_energy_efficiency' => :'EnergyEfficiency',
    :'current_energy_rating' => :'EnergyRating',
    :'potential_energy_rating' => :'EnergyRating',
    :'annual_heating_cost_in_pounds' => :'Integer',
    :'annual_hot_water_cost_in_pounds' => :'Integer',
    :'annual_lighting_cost_in_pounds' => :'Integer',
    :'annual_energy_consumption_in_k_wh' => :'Integer',
    :'floor_height_in_foot' => :'Float',
    :'built_form' => :'BuiltForm'
  }
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



266
267
268
 
# File 'lib/avm_client/models/additional_features.rb', line 266

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/avm_client/models/additional_features.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      price_of_previous_sale == o.price_of_previous_sale &&
      date_of_previous_sale == o.date_of_previous_sale &&
      leasehold_or_freehold == o.leasehold_or_freehold &&
      wall_type == o.wall_type &&
      wall_insulation == o.wall_insulation &&
      wall_energy_efficiency == o.wall_energy_efficiency &&
      roof_type == o.roof_type &&
      roof_insulation == o.roof_insulation &&
      roof_energy_efficiency == o.roof_energy_efficiency &&
      window_glazing_type == o.window_glazing_type &&
      window_energy_efficiency == o.window_energy_efficiency &&
      current_energy_rating == o.current_energy_rating &&
      potential_energy_rating == o.potential_energy_rating &&
      annual_heating_cost_in_pounds == o.annual_heating_cost_in_pounds &&
      annual_hot_water_cost_in_pounds == o.annual_hot_water_cost_in_pounds &&
      annual_lighting_cost_in_pounds == o.annual_lighting_cost_in_pounds &&
      annual_energy_consumption_in_k_wh == o.annual_energy_consumption_in_k_wh &&
      floor_height_in_foot == o.floor_height_in_foot &&
      built_form == o.built_form
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



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
324
325
326
327
328
329
 
# File 'lib/avm_client/models/additional_features.rb', line 294

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    AvmClient.const_get(type).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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/avm_client/models/additional_features.rb', line 359

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/avm_client/models/additional_features.rb', line 273

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.avm_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/avm_client/models/additional_features.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/avm_client/models/additional_features.rb', line 259

def hash
  [price_of_previous_sale, date_of_previous_sale, leasehold_or_freehold, wall_type, wall_insulation, wall_energy_efficiency, roof_type, roof_insulation, roof_energy_efficiency, window_glazing_type, window_energy_efficiency, current_energy_rating, potential_energy_rating, annual_heating_cost_in_pounds, annual_hot_water_cost_in_pounds, annual_lighting_cost_in_pounds, annual_energy_consumption_in_k_wh, floor_height_in_foot, built_form].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



199
200
201
202
203
204
205
206
 
# File 'lib/avm_client/models/additional_features.rb', line 199

def list_invalid_properties
  invalid_properties = Array.new
  if !@price_of_previous_sale.nil? && @price_of_previous_sale < 1
    invalid_properties.push('invalid value for "price_of_previous_sale", 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



339
340
341
 
# File 'lib/avm_client/models/additional_features.rb', line 339

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



345
346
347
348
349
350
351
352
353
 
# File 'lib/avm_client/models/additional_features.rb', line 345

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



333
334
335
 
# File 'lib/avm_client/models/additional_features.rb', line 333

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



210
211
212
213
 
# File 'lib/avm_client/models/additional_features.rb', line 210

def valid?
  return false if !@price_of_previous_sale.nil? && @price_of_previous_sale < 1
  true
end