Class: YieldStarClient::RentSummary
- Inherits:
-
Modelish::Base
- Object
- Modelish::Base
- YieldStarClient::RentSummary
- Defined in:
- lib/yield_star_client/rent_methods.rb
Overview
Represents a summary of rent information for a floor plan/unit type combination.
Instance Attribute Summary collapse
-
#avg_square_feet ⇒ Integer
the average square footage in this unit type.
-
#bathrooms ⇒ Float
the number of bathrooms in this unit type.
-
#bedrooms ⇒ Float
the number of bedrooms in this unit type.
-
#concession_type ⇒ Object
reserved for future use by YieldStar.
-
#effective_date ⇒ Date
the data on which all listed prices are considered effective.
-
#external_property_id ⇒ String
the ID of the property associated with the floor plan.
-
#floor_plan_description ⇒ String
the marketing name of the floor plan.
-
#floor_plan_name ⇒ String
the floor plan that matches the Price Optimizer dashboard.
-
#max_concession ⇒ Integer
the maximum value of any concessions (rent discounts, recurrent discounts currently being offered) for this particular unit type.
-
#max_final_rent ⇒ Integer
the maximum EFFECTIVE rents for the currently available units in this unit type.
-
#max_market_rent ⇒ Integer
the maximum market rents for the currently available units in this unit type.
-
#min_concession ⇒ Integer
the minimum value of any ocncessions (rent discount, recurrent discounts currently being offtered) for this particular unit type.
-
#min_final_rent ⇒ Integer
the minimum EFFECTIVE rents for the currently available units in this unit type.
-
#min_market_rent ⇒ Integer
the minimum market rents for the currently available units in this unit type.
-
#unit_type ⇒ String
the unit type for this information.
Instance Attribute Details
#avg_square_feet ⇒ Integer
the average square footage in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def avg_square_feet @avg_square_feet end |
#bathrooms ⇒ Float
the number of bathrooms in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def bathrooms @bathrooms end |
#bedrooms ⇒ Float
the number of bedrooms in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def bedrooms @bedrooms end |
#concession_type ⇒ Object
reserved for future use by YieldStar
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def concession_type @concession_type end |
#effective_date ⇒ Date
the data on which all listed prices are considered effective
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def effective_date @effective_date end |
#external_property_id ⇒ String
the ID of the property associated with the floor plan
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def external_property_id @external_property_id end |
#floor_plan_description ⇒ String
the marketing name of the floor plan
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def floor_plan_description @floor_plan_description end |
#floor_plan_name ⇒ String
the floor plan that matches the Price Optimizer dashboard
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def floor_plan_name @floor_plan_name end |
#max_concession ⇒ Integer
the maximum value of any concessions (rent discounts, recurrent discounts currently being offered) for this particular unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def max_concession @max_concession end |
#max_final_rent ⇒ Integer
the maximum EFFECTIVE rents for the currently available units in this unit type.
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def max_final_rent @max_final_rent end |
#max_market_rent ⇒ Integer
the maximum market rents for the currently available units in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def max_market_rent @max_market_rent end |
#min_concession ⇒ Integer
the minimum value of any ocncessions (rent discount, recurrent discounts currently being offtered) for this particular unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def min_concession @min_concession end |
#min_final_rent ⇒ Integer
the minimum EFFECTIVE rents for the currently available units in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def min_final_rent @min_final_rent end |
#min_market_rent ⇒ Integer
the minimum market rents for the currently available units in this unit type
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def min_market_rent @min_market_rent end |
#unit_type ⇒ String
the unit type for this information
30 31 32 |
# File 'lib/yield_star_client/rent_methods.rb', line 30 def unit_type @unit_type end |