class SimplyRetsClient::StreetAddress

RETS MLS Street Address

Attributes

city[RW]

City name

country[RW]

Street address country (United States or Canada)

cross_street[RW]

Known cross street

full[RW]

Full pretty-printed address with suffix (if available)

postal_code[RW]

Street Address postal code

state[RW]

State or province. Maps to the data dictionary field ‘StateOrProvince`.

street_name[RW]

Name of the street

street_number[RW]

Street number

street_number_text[RW]

Textual representation of the street number. This field is usually redundant with what’s in ‘streetNumber` but is occassionally usefuly for street number which are actually alpha-numerical. For example, "N63453" or "34556B". **Added on 2016/05/02**

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/simplyrets/models/street_address.rb, line 58
def self.attribute_map
  {
    :'cross_street' => :'crossStreet',
    :'state' => :'state',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'street_name' => :'streetName',
    :'street_number_text' => :'streetNumberText',
    :'city' => :'city',
    :'street_number' => :'streetNumber',
    :'full' => :'full'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/simplyrets/models/street_address.rb, line 89
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'crossStreet')
    self.cross_street = attributes[:'crossStreet']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.has_key?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  end

  if attributes.has_key?(:'streetName')
    self.street_name = attributes[:'streetName']
  end

  if attributes.has_key?(:'streetNumberText')
    self.street_number_text = attributes[:'streetNumberText']
  end

  if attributes.has_key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.has_key?(:'streetNumber')
    self.street_number = attributes[:'streetNumber']
  end

  if attributes.has_key?(:'full')
    self.full = attributes[:'full']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/simplyrets/models/street_address.rb, line 73
def self.swagger_types
  {
    :'cross_street' => :'String',
    :'state' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'street_name' => :'String',
    :'street_number_text' => :'String',
    :'city' => :'String',
    :'street_number' => :'Integer',
    :'full' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/simplyrets/models/street_address.rb, line 148
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cross_street == o.cross_street &&
      state == o.state &&
      country == o.country &&
      postal_code == o.postal_code &&
      street_name == o.street_name &&
      street_number_text == o.street_number_text &&
      city == o.city &&
      street_number == o.street_number &&
      full == o.full
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/simplyrets/models/street_address.rb, line 198
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = SimplyRetsClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/simplyrets/models/street_address.rb, line 264
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/simplyrets/models/street_address.rb, line 177
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/simplyrets/models/street_address.rb, line 164
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/simplyrets/models/street_address.rb, line 170
def hash
  [cross_street, state, country, postal_code, street_name, street_number_text, city, street_number, full].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/simplyrets/models/street_address.rb, line 135
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/simplyrets/models/street_address.rb, line 244
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/simplyrets/models/street_address.rb, line 250
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/simplyrets/models/street_address.rb, line 238
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/simplyrets/models/street_address.rb, line 142
def valid?
  return true
end