class SimplyRetsClient::MlsInformation
RETS MLS Vendor Data
Attributes
MLS Area. Generally a subdivision or community name.
Amount of days the property has been Active
Alias for the listing office or brokerage This field corresponds to the data-dictionary ‘OriginatingSystemName` field The name of the originating record provider. Most commonly the name of the MLS. The place where the listing is originally input by the member. The legal name of the company. To be used for display. If you’re RETS provider aggregates feeds from multiple MLS’s, this will be the name of the corresponding MLS.
MLS Status Code. Compliant with data dictionary v1.3 ListingStatus Listing
statuses depend on your MLS’s availability. Below is a brief description of each status with possible synonyms which may map to your MLS-specific statuses - Active: Active Listing
which is still on the market - ActiveUnderContract: An offer has been accepted but the listing is still on market. Synonyms: Accepting Backup Offers, Backup Offer, Active With Accepted. Synonyms: Offer, Backup, Contingent - Pending: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract - Hold: The listing has been withdrawn from the market, but a contract still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - Withdrawn: The listing has been withdrawn from the market, but a contract still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - Closed: The purchase agreement has been fulfilled or the lease agreement has been executed. Synonyms: Sold, Leased, Rented, Closed Sale - Expired: The listing contract has expired - Delete: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap - Incomplete: The listing has not yet be completely entered and is not yet published in the MLS. Synonyms: Draft, Partially Complted - ComingSoon
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/simplyrets/models/mls_information.rb, line 64 def self.attribute_map { :'status' => :'status', :'area' => :'area', :'days_on_market' => :'daysOnMarket', :'originating_system_name' => :'originatingSystemName' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/simplyrets/models/mls_information.rb, line 85 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?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'area') self.area = attributes[:'area'] end if attributes.has_key?(:'daysOnMarket') self.days_on_market = attributes[:'daysOnMarket'] end if attributes.has_key?(:'originatingSystemName') self.originating_system_name = attributes[:'originatingSystemName'] end end
Attribute type mapping.
# File lib/simplyrets/models/mls_information.rb, line 74 def self.swagger_types { :'status' => :'String', :'area' => :'String', :'days_on_market' => :'Integer', :'originating_system_name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/simplyrets/models/mls_information.rb, line 136 def ==(o) return true if self.equal?(o) self.class == o.class && status == o.status && area == o.area && days_on_market == o.days_on_market && originating_system_name == o.originating_system_name end
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/mls_information.rb, line 181 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
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/mls_information.rb, line 247 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
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/mls_information.rb, line 160 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/simplyrets/models/mls_information.rb, line 147 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/simplyrets/models/mls_information.rb, line 153 def hash [status, area, days_on_market, originating_system_name].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/simplyrets/models/mls_information.rb, line 111 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/simplyrets/models/mls_information.rb, line 126 def status=(status) validator = EnumAttributeValidator.new('String', ["Active", "ActiveUnderContract (Backup-Offer)", "Pending", "Hold", "Withdrawn", "Closed", "Expired", "Delete", "Incomplete", "ComingSoon"]) unless validator.valid?(status) fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/simplyrets/models/mls_information.rb, line 233 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/simplyrets/models/mls_information.rb, line 221 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/simplyrets/models/mls_information.rb, line 118 def valid? status_validator = EnumAttributeValidator.new('String', ["Active", "ActiveUnderContract (Backup-Offer)", "Pending", "Hold", "Withdrawn", "Closed", "Expired", "Delete", "Incomplete", "ComingSoon"]) return false unless status_validator.valid?(@status) return true end