Class: YieldStarClient::Property

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

Overview

Represents a property in the YieldStar system.

A property is guaranteed to have an external_property_id and name; all other attributes are optional.

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String

the street address

Returns:

  • (String) —

    the current value of address



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def address
  @address
end

#city ⇒ String

the city in which the property is located

Returns:

  • (String) —

    the current value of city



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def city
  @city
end

#external_property_id ⇒ String

the property ID

Returns:

  • (String) —

    the current value of external_property_id



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def external_property_id
  @external_property_id
end

#fax ⇒ String

the fax telephone number

Returns:

  • (String) —

    the current value of fax



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def fax
  @fax
end

#latitude ⇒ Float

the latitude of the property’s location

Returns:

  • (Float) —

    the current value of latitude



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def latitude
  @latitude
end

#longitude ⇒ Float

the longitude of the property’s location

Returns:

  • (Float) —

    the current value of longitude



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def longitude
  @longitude
end

#name ⇒ String

the name of the property

Returns:

  • (String) —

    the current value of name



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def name
  @name
end

#phone ⇒ String

the voice telephone number

Returns:

  • (String) —

    the current value of phone



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def phone
  @phone
end

#state ⇒ String

the two-letter code of the state in which the property is located

Returns:

  • (String) —

    the current value of state



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def state
  @state
end

#unit_count ⇒ Integer

the number of units at this property

Returns:

  • (Integer) —

    the current value of unit_count



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def unit_count
  @unit_count
end

#website ⇒ String

the URL of the property website

Returns:

  • (String) —

    the current value of website



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def website
  @website
end

#year_built ⇒ Integer

the year in which the property was built

Returns:

  • (Integer) —

    the current value of year_built



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def year_built
  @year_built
end

#zip ⇒ String

the zip code

Returns:

  • (String) —

    the current value of zip



22
23
24
 
# File 'lib/yield_star_client/property_methods.rb', line 22

def zip
  @zip
end