Class: YieldStarClient::RentSummary

Inherits:
Modelish::Base
  • Object
show all
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

Instance Attribute Details

#avg_square_feet ⇒ Integer

the average square footage in this unit type

Returns:

  • (Integer) —

    the current value of avg_square_feet



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

Returns:

  • (Float) —

    the current value of bathrooms



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

Returns:

  • (Float) —

    the current value of bedrooms



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

Returns:

  • (Object) —

    the current value of concession_type



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

Returns:

  • (Date) —

    the current value of effective_date



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

Returns:

  • (String) —

    the current value of external_property_id



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

Returns:

  • (String) —

    the current value of floor_plan_description



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

Returns:

  • (String) —

    the current value of floor_plan_name



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

Returns:

  • (Integer) —

    the current value of max_concession



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.

Returns:

  • (Integer) —

    the current value of max_final_rent



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

Returns:

  • (Integer) —

    the current value of max_market_rent



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

Returns:

  • (Integer) —

    the current value of min_concession



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

Returns:

  • (Integer) —

    the current value of min_final_rent



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

Returns:

  • (Integer) —

    the current value of min_market_rent



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

Returns:

  • (String) —

    the current value of unit_type



30
31
32
 
# File 'lib/yield_star_client/rent_methods.rb', line 30

def unit_type
  @unit_type
end