Class: YieldStarClient::FloorPlan

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

Overview

Represents a floor plan in the YieldStar system.

A floor plan is guaranteed to have an external_property_id and name. All other attributes are optional.

Instance Attribute Summary collapse

Instance Attribute Details

#bathrooms ⇒ Float

the bathroom count of the floor plan

Returns:

  • (Float) —

    the current value of bathrooms



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def bathrooms
  @bathrooms
end

#bedrooms ⇒ Float

the bedroom count of the floor plan

Returns:

  • (Float) —

    the current value of bedrooms



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def bedrooms
  @bedrooms
end

#description ⇒ String

the description of this floor plan

Returns:

  • (String) —

    the current value of description



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def description
  @description
end

#external_property_id ⇒ String

the property ID of this floor plan

Returns:

  • (String) —

    the current value of external_property_id



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def external_property_id
  @external_property_id
end

#name ⇒ String

the name of this floor plan

Returns:

  • (String) —

    the current value of name



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def name
  @name
end

#square_feet ⇒ Integer

the average square footage of this floor plan

Returns:

  • (Integer) —

    the current value of square_feet



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def square_feet
  @square_feet
end

#unit_count ⇒ Integer

the number of units with this floor plan

Returns:

  • (Integer) —

    the current value of unit_count



17
18
19
 
# File 'lib/yield_star_client/floor_plan_methods.rb', line 17

def unit_count
  @unit_count
end