Class: YieldStarClient::Property
- Inherits:
-
Modelish::Base
- Object
- Modelish::Base
- YieldStarClient::Property
- 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
-
#address ⇒ String
the street address.
-
#city ⇒ String
the city in which the property is located.
-
#external_property_id ⇒ String
the property ID.
-
#fax ⇒ String
the fax telephone number.
-
#latitude ⇒ Float
the latitude of the property’s location.
-
#longitude ⇒ Float
the longitude of the property’s location.
-
#name ⇒ String
the name of the property.
-
#phone ⇒ String
the voice telephone number.
-
#state ⇒ String
the two-letter code of the state in which the property is located.
-
#unit_count ⇒ Integer
the number of units at this property.
-
#website ⇒ String
the URL of the property website.
-
#year_built ⇒ Integer
the year in which the property was built.
-
#zip ⇒ String
the zip code.
Instance Attribute Details
#address ⇒ String
the street 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
22 23 24 |
# File 'lib/yield_star_client/property_methods.rb', line 22 def city @city end |
#external_property_id ⇒ String
the 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
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
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
22 23 24 |
# File 'lib/yield_star_client/property_methods.rb', line 22 def longitude @longitude end |
#name ⇒ String
the name of the property
22 23 24 |
# File 'lib/yield_star_client/property_methods.rb', line 22 def name @name end |
#phone ⇒ String
the voice telephone number
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
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
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
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
22 23 24 |
# File 'lib/yield_star_client/property_methods.rb', line 22 def year_built @year_built end |
#zip ⇒ String
the zip code
22 23 24 |
# File 'lib/yield_star_client/property_methods.rb', line 22 def zip @zip end |