Class: YieldStarClient::AvailableFloorPlan

Inherits:
Modelish::Base
  • Object
show all
Defined in:
lib/yield_star_client/rent_methods.rb

Overview

Represents a floor plan with available units.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ AvailableFloorPlan

Returns a new instance of AvailableFloorPlan.



69
70
71
72
73
74
 
# File 'lib/yield_star_client/rent_methods.rb', line 69

def initialize(options = {})
  super(options)

  # TODO: add support for nested types to modelish?
  self.units = [self.units].flatten.collect { |u| AvailableUnit.new(u) }
end

Instance Attribute Details

#bathrooms ⇒ Float

the number of bathrooms in this floor plan

Returns:

  • (Float) —

    the current value of bathrooms



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def bathrooms
  @bathrooms
end

#bedrooms ⇒ Float

the number of bedrooms in this floor plan

Returns:

  • (Float) —

    the current value of bedrooms



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def bedrooms
  @bedrooms
end

#effective_date ⇒ Date

the date that all listed prices are considered effective

Returns:

  • (Date) —

    the current value of effective_date



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def effective_date
  @effective_date
end

#external_property_id ⇒ String

the ID of the property associated with the floor plan

Returns:

  • (String) —

    the current value of external_property_id



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def external_property_id
  @external_property_id
end

#floor_plan_name ⇒ String

the name of the floor plan that matches the Price Optimizer dashboard

Returns:

  • (String) —

    the current value of floor_plan_name



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def floor_plan_name
  @floor_plan_name
end

#square_feet ⇒ Integer

the square footage of the floor plan

Returns:

  • (Integer) —

    the current value of square_feet



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def square_feet
  @square_feet
end

#units ⇒ Array<AvailableUnit>

the available unit data associated with this floor plan

Returns:



60
61
62
 
# File 'lib/yield_star_client/rent_methods.rb', line 60

def units
  @units
end