Class: YieldStarClient::Unit
- Inherits:
-
Modelish::Base
- Object
- Modelish::Base
- YieldStarClient::Unit
- Defined in:
- lib/yield_star_client/unit_methods.rb
Overview
Represents a unit in the YieldStar system.
A unit is guaranteed to have an external_property_id
, floor_plan_name
, name
, and availablity_status
. All other attributes are optional.
Instance Attribute Summary collapse
-
#availability_status ⇒ Symbol
the current availability of the unit.
-
#bathrooms ⇒ Float
the number of bathrooms in the unit.
-
#bedrooms ⇒ Float
the number of bedrooms in the unit.
-
#building ⇒ String
the name of the building associated with the unit.
-
#external_property_id ⇒ String
the property ID.
-
#floor_plan_name ⇒ String
the name of the unit’s floor plan.
-
#make_ready_date ⇒ Date
the date on which the unit is ready for move-in.
-
#name ⇒ String
the unit name.
-
#square_feet ⇒ Integer
the square footage of the unit.
-
#unit_type ⇒ String
the client-defined grouping of the unit.
Instance Attribute Details
#availability_status ⇒ Symbol
the current availability of the unit. This may be one of the following values:
-
:occupied
– this unit is presently leased by a resident -
:occupied_on_notice
– this unit is presently leased by a resident but a notice date has been provided -
:vacant
– this unit is not presently leased -
:pending
– this unit is available but a lease is pending -
:unknown
– the status is unknown or unrecognized
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def availability_status @availability_status end |
#bathrooms ⇒ Float
the number of bathrooms in the unit
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def bathrooms @bathrooms end |
#bedrooms ⇒ Float
the number of bedrooms in the unit
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def bedrooms @bedrooms end |
#building ⇒ String
the name of the building associated with the unit
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def building @building end |
#external_property_id ⇒ String
the property ID
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def external_property_id @external_property_id end |
#floor_plan_name ⇒ String
the name of the unit’s floor plan
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def floor_plan_name @floor_plan_name end |
#make_ready_date ⇒ Date
the date on which the unit is ready for move-in
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def make_ready_date @make_ready_date end |
#name ⇒ String
the unit name
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def name @name end |
#square_feet ⇒ Integer
the square footage of the unit
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def square_feet @square_feet end |
#unit_type ⇒ String
the client-defined grouping of the unit
25 26 27 |
# File 'lib/yield_star_client/unit_methods.rb', line 25 def unit_type @unit_type end |