Class: YieldStarClient::Unit

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

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

Returns:

  • (Symbol) —

    the current value of availability_status



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

Returns:

  • (Float) —

    the current value of bathrooms



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

Returns:

  • (Float) —

    the current value of bedrooms



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

Returns:

  • (String) —

    the current value of building



25
26
27
 
# File 'lib/yield_star_client/unit_methods.rb', line 25

def building
  @building
end

#external_property_id ⇒ String

the property ID

Returns:

  • (String) —

    the current value of external_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

Returns:

  • (String) —

    the current value of floor_plan_name



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

Returns:

  • (Date) —

    the current value of make_ready_date



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

Returns:

  • (String) —

    the current value of 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

Returns:

  • (Integer) —

    the current value of square_feet



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

Returns:

  • (String) —

    the current value of unit_type



25
26
27
 
# File 'lib/yield_star_client/unit_methods.rb', line 25

def unit_type
  @unit_type
end