Class: YieldStarClient::Amenity

Inherits:

Modelish::Base

• Object
• Modelish::Base
• YieldStarClient::Amenity

Defined in:

lib/yield_star_client/amenity_methods.rb

Overview

Represents a YieldStar amenity.

All amenities are guaranteed to have a name and type; value is optional.

Instance Attribute Summary

• #Float[ ⇒ Float[ value the value of the amenity

  value the value of the amenity.

• #name ⇒ String

  the name of the amenity.

• #type ⇒ String

  the type of the amenity.

Instance Attribute Details

#Float[ ⇒ Float[ value the value of the amenity

value the value of the amenity

Returns:

• (Float[ value the value of the amenity) —

  the current value of Float[

# File 'lib/yield_star_client/amenity_methods.rb', line 12

def Float[
  @Float[
end

#name ⇒ String

the name of the amenity

Returns:

• (String) —

  the current value of name

# File 'lib/yield_star_client/amenity_methods.rb', line 12

def name
  @name
end

#type ⇒ String

the type of the amenity

Returns:

• (String) —

  the current value of type

# File 'lib/yield_star_client/amenity_methods.rb', line 12

def type
  @type
end