Class: YieldStarClient::UnitRate

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

Overview

Represents common unit rate information.

Direct Known Subclasses

LeaseTermRent, RenewalLeaseTermRent

Instance Attribute Summary collapse

Instance Attribute Details

#best ⇒ true, false

indicates whether this is the best (i.e. highest) rent for the unit; defaults to true

Returns:

  • (true, false) —

    the current value of best



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def best
  @best
end

#building ⇒ String

the building in which the unit is located

Returns:

  • (String) —

    the current value of building



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def building
  @building
end

#end_date ⇒ Date

the date the proposed lease will expire

Returns:

  • (Date) —

    the current value of end_date



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def end_date
  @end_date
end

#external_property_id ⇒ String

the ID of the property where the unit is located

Returns:

  • (String) —

    the current value of external_property_id



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def external_property_id
  @external_property_id
end

#final_rent ⇒ Integer

the effective rent for the current lease

Returns:

  • (Integer) —

    the current value of final_rent



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def final_rent
  @final_rent
end

#lease_term ⇒ Integer

the length, in months, of the lease term

Returns:

  • (Integer) —

    the current value of lease_term



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def lease_term
  @lease_term
end

#market_rent ⇒ Integer

the market rent for the current lease

Returns:

  • (Integer) —

    the current value of market_rent



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def market_rent
  @market_rent
end

#unit_number ⇒ String

the unit number identifying this unit

Returns:

  • (String) —

    the current value of unit_number



16
17
18
 
# File 'lib/yield_star_client/lease_term_rent_methods.rb', line 16

def unit_number
  @unit_number
end