simplyrets 1.0.7 → 2.0.0

data/lib/simplyrets/models/street_address.rb

@@ -1,90 +1,268 @@
+=begin
+SimplyRETS API
+
+The SimplyRETS API is an exciting step towards making it easier for\ndevelopers and real estate agents to build something awesome with\nreal estate data!\n\nThe documentation below makes live requests to our API using the\ntrial data. To get set up with the API using live MLS data, you\nmust have RETS credentials from your MLS, which you can then use to\ncreate an app with SimplyRETS. For more information on that\nprocess, please see our [FAQ](https://simplyrets.com/faq), [Getting\nStarted](https://simplyrets.com/blog/getting-set-up.html) page, or\n[contact us](https://simplyrets.com/\\#home-contact).\n\nBelow you'll find the API endpoints, query parameters, response bodies,\nand other information about using the SimplyRETS API. You can run\nqueries by clicking the 'Try it Out' button at the bottom of each\nsection.\n\n### Authentication\nThe SimplyRETS API uses Basic Authentication. When you create an\napp, you'll get a set of API credentials to access your\nlistings. If you're trying out the test data, you can use\n`simplyrets:simplyrets` for connecting to the API.\n\n### Media Types\nThe SimplyRETS API uses the `Accept` header to allow clients to\ncontrol media types (content versions). We maintain backwards\ncompatibility with API clients by allowing them to specify a\ncontent version. We highly recommend setting and explicity media\ntype when your application reaches production. Both the structure\nand content of our API response bodies is subject to change so we\ncan add new features while respecting the stability of applications\nwhich have already been developed.\n\nTo always use the latest SimplyRETS content version, simply use\n`application/json` in your application `Accept` header.\n\nIf you want to pin your clients media type to a specific version,\nyou can use the vendor-specific SimplyRETS media type, e.g.\n`application/vnd.simplyrets-v0.1+json\"`\n\nTo view all valid content-types for making an `OPTIONS`, make a\nrequest to the SimplyRETS api root\n\n`curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/`\n\nThe default media types used in our API responses may change in the\nfuture. If you're building an application and care about the\nstability of the API, be sure to request a specific media type in the\nAccept header as shown in the examples below.\n\nThe wordpress plugin automatically sets the `Accept` header for the\ncompatible SimplyRETS media types.\n\n### Pagination\nThere a few pieces of useful information about each request stored\nin the HTTP Headers:\n\n- `X-Total-Count` shows you the total amount of listings that match\n  your current query.\n- `Link` contains pre-built pagination links for accessing the next\n'page' of listings that match your query. Read more about that\n[here](https://simplyrets.com/blog/api-pagination.html).\n
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'date'
+
 module SimplyRetsClient
-  #
-  class StreetAddress < BaseObject
-    attr_accessor :country, :postal_code, :street_name, :city, :street_number, :full, :cross_street, :state
-    # attribute mapping from ruby-style variable name to JSON key
+  # RETS MLS Street Address
+  class StreetAddress
+    # Known cross street
+    attr_accessor :cross_street
+
+    # State or province. Maps to the data dictionary field `StateOrProvince`.
+    attr_accessor :state
+
+    # Street address country (United States or Canada)
+    attr_accessor :country
+
+    # Street Address postal code
+    attr_accessor :postal_code
+
+    # Name of the street
+    attr_accessor :street_name
+
+    # Textual representation of the street number. This field\nis usually redundant with what's in `streetNumber` but is\noccassionally usefuly for street number which are actually\nalpha-numerical. For example, \"N63453\" or \"34556B\".\n\n**Added on 2016/05/02**\n
+    attr_accessor :street_number_text
+
+    # City name
+    attr_accessor :city
+
+    # Street number
+    attr_accessor :street_number
+
+    # Full pretty-printed address with suffix (if available)
+    attr_accessor :full
+
+    # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
 
-        # Street address country (United States or Canada)
+        :'cross_street' => :'crossStreet',
+
+        :'state' => :'state',
+
         :'country' => :'country',
 
-        # Street Address postal code
         :'postal_code' => :'postalCode',
 
-        # Name of the street
         :'street_name' => :'streetName',
 
-        # City name
+        :'street_number_text' => :'streetNumberText',
+
         :'city' => :'city',
 
-        # Street number
         :'street_number' => :'streetNumber',
 
-        # Full pretty-printed address with suffix (if available)
-        :'full' => :'full',
-
-        # Known cross street
-        :'cross_street' => :'crossStreet',
+        :'full' => :'full'
 
-        # state or province
-        :'state' => :'state'
       }
     end
 
-    # attribute type
-    def self.simplyrets_types
+    # Attribute type mapping.
+    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',
-        :'cross_street' => :'String',
-        :'state' => :'String'
+        :'full' => :'String'
+
       }
     end
 
     def initialize(attributes = {})
-      return if !attributes.is_a?(Hash) || attributes.empty?
+      return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
       attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 
 
+      if attributes[:'crossStreet']
+        self.cross_street = attributes[:'crossStreet']
+      else
+        self.cross_street = "456 Cross Rd"
+      end
+
+      if attributes[:'state']
+        self.state = attributes[:'state']
+      else
+        self.state = "Texas"
+      end
+
       if attributes[:'country']
         self.country = attributes[:'country']
+      else
+        self.country = "United States"
       end
 
       if attributes[:'postalCode']
         self.postal_code = attributes[:'postalCode']
+      else
+        self.postal_code = "77324"
       end
 
       if attributes[:'streetName']
         self.street_name = attributes[:'streetName']
+      else
+        self.street_name = "SimplyRETS Drive"
+      end
+
+      if attributes[:'streetNumberText']
+        self.street_number_text = attributes[:'streetNumberText']
+      else
+        self.street_number_text = "1234"
       end
 
       if attributes[:'city']
         self.city = attributes[:'city']
+      else
+        self.city = "Houston"
       end
 
       if attributes[:'streetNumber']
         self.street_number = attributes[:'streetNumber']
+      else
+        self.street_number = 1234
       end
 
       if attributes[:'full']
         self.full = attributes[:'full']
+      else
+        self.full = "1234 SimplyRETS Drive"
       end
 
-      if attributes[:'crossStreet']
-        self.cross_street = attributes[:'crossStreet']
+    end
+
+    # Check equality by comparing each attribute.
+    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
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [cross_street, state, country, postal_code, street_name, street_number_text, city, street_number, full].hash
+    end
+
+    # build the object from hash
+    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
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
       end
 
-      if attributes[:'state']
-        self.state = attributes[:'state']
+      self
+    end
+
+    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
+        _model = SimplyRetsClient.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    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
 
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    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
 
   end

data/lib/simplyrets/models/tax.rb

@@ -1,53 +1,185 @@
+=begin
+SimplyRETS API
+
+The SimplyRETS API is an exciting step towards making it easier for\ndevelopers and real estate agents to build something awesome with\nreal estate data!\n\nThe documentation below makes live requests to our API using the\ntrial data. To get set up with the API using live MLS data, you\nmust have RETS credentials from your MLS, which you can then use to\ncreate an app with SimplyRETS. For more information on that\nprocess, please see our [FAQ](https://simplyrets.com/faq), [Getting\nStarted](https://simplyrets.com/blog/getting-set-up.html) page, or\n[contact us](https://simplyrets.com/\\#home-contact).\n\nBelow you'll find the API endpoints, query parameters, response bodies,\nand other information about using the SimplyRETS API. You can run\nqueries by clicking the 'Try it Out' button at the bottom of each\nsection.\n\n### Authentication\nThe SimplyRETS API uses Basic Authentication. When you create an\napp, you'll get a set of API credentials to access your\nlistings. If you're trying out the test data, you can use\n`simplyrets:simplyrets` for connecting to the API.\n\n### Media Types\nThe SimplyRETS API uses the `Accept` header to allow clients to\ncontrol media types (content versions). We maintain backwards\ncompatibility with API clients by allowing them to specify a\ncontent version. We highly recommend setting and explicity media\ntype when your application reaches production. Both the structure\nand content of our API response bodies is subject to change so we\ncan add new features while respecting the stability of applications\nwhich have already been developed.\n\nTo always use the latest SimplyRETS content version, simply use\n`application/json` in your application `Accept` header.\n\nIf you want to pin your clients media type to a specific version,\nyou can use the vendor-specific SimplyRETS media type, e.g.\n`application/vnd.simplyrets-v0.1+json\"`\n\nTo view all valid content-types for making an `OPTIONS`, make a\nrequest to the SimplyRETS api root\n\n`curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/`\n\nThe default media types used in our API responses may change in the\nfuture. If you're building an application and care about the\nstability of the API, be sure to request a specific media type in the\nAccept header as shown in the examples below.\n\nThe wordpress plugin automatically sets the `Accept` header for the\ncompatible SimplyRETS media types.\n\n### Pagination\nThere a few pieces of useful information about each request stored\nin the HTTP Headers:\n\n- `X-Total-Count` shows you the total amount of listings that match\n  your current query.\n- `Link` contains pre-built pagination links for accessing the next\n'page' of listings that match your query. Read more about that\n[here](https://simplyrets.com/blog/api-pagination.html).\n
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'date'
+
 module SimplyRetsClient
-  #
-  class Tax < BaseObject
-    attr_accessor :id, :annual_amount, :year
-    # attribute mapping from ruby-style variable name to JSON key
+  # RETS MLS Tax Data
+  class Tax
+    # Tax Year
+    attr_accessor :year
+
+    # Annual tax amount in USD
+    attr_accessor :annual_amount
+
+    # Tax Parcel ID for the listing
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
 
-        # Tax Parcel ID for the listing
-        :'id' => :'id',
+        :'year' => :'year',
 
-        # Annual tax amount in USD
         :'annual_amount' => :'annualAmount',
 
-        # Tax Year
-        :'year' => :'year'
+        :'id' => :'id'
 
       }
     end
 
-    # attribute type
-    def self.simplyrets_types
+    # Attribute type mapping.
+    def self.swagger_types
       {
-        :'id' => :'String',
+        :'year' => :'Integer',
         :'annual_amount' => :'String',
-        :'year' => :'Integer'
+        :'id' => :'String'
 
       }
     end
 
     def initialize(attributes = {})
-      return if !attributes.is_a?(Hash) || attributes.empty?
+      return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
       attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 
 
-      if attributes[:'id']
-        self.id = attributes[:'id']
+      if attributes[:'year']
+        self.year = attributes[:'year']
       end
 
       if attributes[:'annualAmount']
         self.annual_amount = attributes[:'annualAmount']
       end
 
-      if attributes[:'year']
-        self.year = attributes[:'year']
+      if attributes[:'id']
+        self.id = attributes[:'id']
       end
 
     end
 
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          year == o.year &&
+          annual_amount == o.annual_amount &&
+          id == o.id
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [year, annual_amount, id].hash
+    end
+
+    # build the object from hash
+    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
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    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
+        _model = SimplyRetsClient.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    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
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    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
+
   end
 end