class AvmClient::AdditionalFeatures

Attributes

annual_energy_consumption_in_k_wh[RW]
annual_heating_cost_in_pounds[RW]
annual_hot_water_cost_in_pounds[RW]
annual_lighting_cost_in_pounds[RW]
built_form[RW]
current_energy_rating[RW]
date_of_previous_sale[RW]
floor_height_in_foot[RW]
leasehold_or_freehold[RW]
potential_energy_rating[RW]
price_of_previous_sale[RW]
roof_energy_efficiency[RW]
roof_insulation[RW]
roof_type[RW]
wall_energy_efficiency[RW]
wall_insulation[RW]
wall_type[RW]
window_energy_efficiency[RW]
window_glazing_type[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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() click to toggle source

Attribute type mapping.

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/avm_client/models/additional_features.rb, line 266
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/avm_client/models/additional_features.rb, line 253
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
price_of_previous_sale=(price_of_previous_sale) click to toggle source

Custom attribute writer method with validation @param [Object] price_of_previous_sale Value to be assigned

# File lib/avm_client/models/additional_features.rb, line 217
def price_of_previous_sale=(price_of_previous_sale)
  if !price_of_previous_sale.nil? && price_of_previous_sale < 1
    fail ArgumentError, 'invalid value for "price_of_previous_sale", must be greater than or equal to 1.'
  end

  @price_of_previous_sale = price_of_previous_sale
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/avm_client/models/additional_features.rb, line 339
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/avm_client/models/additional_features.rb, line 333
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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