Class: YieldStarClient::AvailableUnit

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

Overview

Represents an available unit.

Instance Attribute Summary collapse

Instance Attribute Details

#base_concession ⇒ Integer

the concession amountt

Returns:

  • (Integer) —

    the current value of base_concession



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def base_concession
  @base_concession
end

#base_final_rent ⇒ Integer

the 12-month effective rent (market rent less concessions)

Returns:

  • (Integer) —

    the current value of base_final_rent



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def base_final_rent
  @base_final_rent
end

#base_market_rent ⇒ Integer

the 12-month market rent

Returns:

  • (Integer) —

    the current value of base_market_rent



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def base_market_rent
  @base_market_rent
end

#best_concession ⇒ Integer

the concession associated with the best price term and move-in period

Returns:

  • (Integer) —

    the current value of best_concession



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def best_concession
  @best_concession
end

#best_final_rent ⇒ Integer

the effective monthly rent associated with the best price term and move-in period

Returns:

  • (Integer) —

    the current value of best_final_rent



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def best_final_rent
  @best_final_rent
end

#best_lease_term ⇒ Integer

the lease term associated with the best price from the Lease Term Rent Matrix.

Returns:

  • (Integer) —

    the current value of best_lease_term



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def best_lease_term
  @best_lease_term
end

#best_market_rent ⇒ Integer

the market monthly rent associated with the best price term and move-in period

Returns:

  • (Integer) —

    the current value of best_market_rent



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def best_market_rent
  @best_market_rent
end

#building ⇒ String

the building for this unit

Returns:

  • (String) —

    the current value of building



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def building
  @building
end

#date_available ⇒ Date

the date this unit can be occupied

Returns:

  • (Date) —

    the current value of date_available



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def date_available
  @date_available
end

#features ⇒ Array<String>

the list of unit amenities/features

Returns:

  • (Array<String>) —

    the current value of features



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def features
  @features
end

#status ⇒ Symbol

the availability status of this unit. The status may be one of the following values:

  • :on_notice

  • :vacant

  • :new_unit

  • :unknown

Returns:

  • (Symbol) —

    the current value of status



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def status
  @status
end

#unit_number ⇒ String

the unit number from the property management system

Returns:

  • (String) —

    the current value of unit_number



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def unit_number
  @unit_number
end

#unit_type ⇒ String

the unit type

Returns:

  • (String) —

    the current value of unit_type



101
102
103
 
# File 'lib/yield_star_client/rent_methods.rb', line 101

def unit_type
  @unit_type
end