simplyrets 2.0.0 → 2.0.1

data/lib/simplyrets/models/open_house.rb

@@ -1,12 +1,23 @@
 =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
+The SimplyRETS API is an exciting step towards making it easier for developers and real estate agents to build something awesome with real estate data!  The documentation below makes live requests to our API using the trial data. To get set up with the API using live MLS data, you must have RETS credentials from your MLS, which you can then use to create an app with SimplyRETS. For more information on that process, please see our [FAQ](https://simplyrets.com/faq), [Getting Started](https://simplyrets.com/blog/getting-set-up.html) page, or [contact us](https://simplyrets.com/\\#home-contact).  Below you'll find the API endpoints, query parameters, response bodies, and other information about using the SimplyRETS API. You can run queries by clicking the 'Try it Out' button at the bottom of each section.  ### Authentication The SimplyRETS API uses Basic Authentication. When you create an app, you'll get a set of API credentials to access your listings. If you're trying out the test data, you can use `simplyrets:simplyrets` for connecting to the API.  ### Media Types The SimplyRETS API uses the `Accept` header to allow clients to control media types (content versions). We maintain backwards compatibility with API clients by allowing them to specify a content version. We highly recommend setting and explicity media type when your application reaches production. Both the structure and content of our API response bodies is subject to change so we can add new features while respecting the stability of applications which have already been developed.  To always use the latest SimplyRETS content version, simply use `application/json` in your application `Accept` header.  If you want to pin your clients media type to a specific version, you can use the vendor-specific SimplyRETS media type, e.g. `application/vnd.simplyrets-v0.1+json\"`  To view all valid content-types for making an `OPTIONS`, make a request to the SimplyRETS api root  `curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/`  The default media types used in our API responses may change in the future. If you're building an application and care about the stability of the API, be sure to request a specific media type in the Accept header as shown in the examples below.  The wordpress plugin automatically sets the `Accept` header for the compatible SimplyRETS media types.  ### Pagination There a few pieces of useful information about each request stored in the HTTP Headers:  - `X-Total-Count` shows you the total amount of listings that match   your current query. - `Link` contains pre-built pagination links for accessing the next 'page' of listings that match your query. Read more about that [here](https://simplyrets.com/blog/api-pagination.html).
 
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -24,13 +35,13 @@ module SimplyRetsClient
     # Start Date for the open house
     attr_accessor :start_time
 
-    # A unique identifier for the open house which is specific to the\nSimplyRETS API\n
+    # A unique identifier for the open house which is specific to the SimplyRETS API
     attr_accessor :open_house_key
 
     # The ending date time for the open house
     attr_accessor :end_time
 
-    # The MLS number or id provided by the MLS\n
+    # The MLS number or id provided by the MLS
     attr_accessor :open_house_id
 
     # The open house type. For example, Public or Private
@@ -39,26 +50,18 @@ module SimplyRetsClient
     # The remarks and/or description details for the open house
     attr_accessor :description
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'refreshments' => :'refreshments',
-
         :'listing' => :'listing',
-
         :'start_time' => :'startTime',
-
         :'open_house_key' => :'openHouseKey',
-
         :'end_time' => :'endTime',
-
         :'open_house_id' => :'openHouseId',
-
         :'type' => :'type',
-
         :'description' => :'description'
-
       }
     end
 
@@ -73,52 +76,66 @@ module SimplyRetsClient
         :'open_house_id' => :'String',
         :'type' => :'String',
         :'description' => :'String'
-
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       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}
-
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'refreshments']
+      if attributes.has_key?(:'refreshments')
         self.refreshments = attributes[:'refreshments']
       end
 
-      if attributes[:'listing']
+      if attributes.has_key?(:'listing')
         self.listing = attributes[:'listing']
       end
 
-      if attributes[:'startTime']
+      if attributes.has_key?(:'startTime')
         self.start_time = attributes[:'startTime']
       end
 
-      if attributes[:'openHouseKey']
+      if attributes.has_key?(:'openHouseKey')
         self.open_house_key = attributes[:'openHouseKey']
       end
 
-      if attributes[:'endTime']
+      if attributes.has_key?(:'endTime')
         self.end_time = attributes[:'endTime']
       end
 
-      if attributes[:'openHouseId']
+      if attributes.has_key?(:'openHouseId')
         self.open_house_id = attributes[:'openHouseId']
       end
 
-      if attributes[:'type']
+      if attributes.has_key?(:'type')
         self.type = attributes[:'type']
       end
 
-      if attributes[:'description']
+      if attributes.has_key?(:'description')
         self.description = attributes[:'description']
       end
 
     end
 
-    # Check equality by comparing each attribute.
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -133,35 +150,41 @@ module SimplyRetsClient
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [refreshments, listing, start_time, open_house_key, end_time, open_house_id, type, description].hash
     end
 
-    # build the object from hash
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
     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) } )
-          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 # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -195,21 +218,25 @@ module SimplyRetsClient
           end
         end
       else # model
-        _model = SimplyRetsClient.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = SimplyRetsClient.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -220,8 +247,10 @@ module SimplyRetsClient
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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
     def _to_hash(value)
       if value.is_a?(Array)
         value.compact.map{ |v| _to_hash(v) }
@@ -237,4 +266,5 @@ module SimplyRetsClient
     end
 
   end
+
 end

data/lib/simplyrets/models/parking.rb

@@ -1,12 +1,23 @@
 =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
+The SimplyRETS API is an exciting step towards making it easier for developers and real estate agents to build something awesome with real estate data!  The documentation below makes live requests to our API using the trial data. To get set up with the API using live MLS data, you must have RETS credentials from your MLS, which you can then use to create an app with SimplyRETS. For more information on that process, please see our [FAQ](https://simplyrets.com/faq), [Getting Started](https://simplyrets.com/blog/getting-set-up.html) page, or [contact us](https://simplyrets.com/\\#home-contact).  Below you'll find the API endpoints, query parameters, response bodies, and other information about using the SimplyRETS API. You can run queries by clicking the 'Try it Out' button at the bottom of each section.  ### Authentication The SimplyRETS API uses Basic Authentication. When you create an app, you'll get a set of API credentials to access your listings. If you're trying out the test data, you can use `simplyrets:simplyrets` for connecting to the API.  ### Media Types The SimplyRETS API uses the `Accept` header to allow clients to control media types (content versions). We maintain backwards compatibility with API clients by allowing them to specify a content version. We highly recommend setting and explicity media type when your application reaches production. Both the structure and content of our API response bodies is subject to change so we can add new features while respecting the stability of applications which have already been developed.  To always use the latest SimplyRETS content version, simply use `application/json` in your application `Accept` header.  If you want to pin your clients media type to a specific version, you can use the vendor-specific SimplyRETS media type, e.g. `application/vnd.simplyrets-v0.1+json\"`  To view all valid content-types for making an `OPTIONS`, make a request to the SimplyRETS api root  `curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/`  The default media types used in our API responses may change in the future. If you're building an application and care about the stability of the API, be sure to request a specific media type in the Accept header as shown in the examples below.  The wordpress plugin automatically sets the `Accept` header for the compatible SimplyRETS media types.  ### Pagination There a few pieces of useful information about each request stored in the HTTP Headers:  - `X-Total-Count` shows you the total amount of listings that match   your current query. - `Link` contains pre-built pagination links for accessing the next 'page' of listings that match your query. Read more about that [here](https://simplyrets.com/blog/api-pagination.html).
 
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -23,16 +34,13 @@ module SimplyRetsClient
     # Parking features description
     attr_accessor :description
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'leased' => :'leased',
-
         :'spaces' => :'spaces',
-
         :'description' => :'description'
-
       }
     end
 
@@ -42,32 +50,46 @@ module SimplyRetsClient
         :'leased' => :'String',
         :'spaces' => :'Integer',
         :'description' => :'String'
-
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       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}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-
-      if attributes[:'leased']
+      if attributes.has_key?(:'leased')
         self.leased = attributes[:'leased']
       end
 
-      if attributes[:'spaces']
+      if attributes.has_key?(:'spaces')
         self.spaces = attributes[:'spaces']
       end
 
-      if attributes[:'description']
+      if attributes.has_key?(:'description')
         self.description = attributes[:'description']
       end
 
     end
 
-    # Check equality by comparing each attribute.
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -77,35 +99,41 @@ module SimplyRetsClient
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [leased, spaces, description].hash
     end
 
-    # build the object from hash
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
     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) } )
-          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 # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -139,21 +167,25 @@ module SimplyRetsClient
           end
         end
       else # model
-        _model = SimplyRetsClient.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = SimplyRetsClient.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -164,8 +196,10 @@ module SimplyRetsClient
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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
     def _to_hash(value)
       if value.is_a?(Array)
         value.compact.map{ |v| _to_hash(v) }
@@ -181,4 +215,5 @@ module SimplyRetsClient
     end
 
   end
+
 end

data/lib/simplyrets/models/property.rb

@@ -1,12 +1,23 @@
 =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
+The SimplyRETS API is an exciting step towards making it easier for developers and real estate agents to build something awesome with real estate data!  The documentation below makes live requests to our API using the trial data. To get set up with the API using live MLS data, you must have RETS credentials from your MLS, which you can then use to create an app with SimplyRETS. For more information on that process, please see our [FAQ](https://simplyrets.com/faq), [Getting Started](https://simplyrets.com/blog/getting-set-up.html) page, or [contact us](https://simplyrets.com/\\#home-contact).  Below you'll find the API endpoints, query parameters, response bodies, and other information about using the SimplyRETS API. You can run queries by clicking the 'Try it Out' button at the bottom of each section.  ### Authentication The SimplyRETS API uses Basic Authentication. When you create an app, you'll get a set of API credentials to access your listings. If you're trying out the test data, you can use `simplyrets:simplyrets` for connecting to the API.  ### Media Types The SimplyRETS API uses the `Accept` header to allow clients to control media types (content versions). We maintain backwards compatibility with API clients by allowing them to specify a content version. We highly recommend setting and explicity media type when your application reaches production. Both the structure and content of our API response bodies is subject to change so we can add new features while respecting the stability of applications which have already been developed.  To always use the latest SimplyRETS content version, simply use `application/json` in your application `Accept` header.  If you want to pin your clients media type to a specific version, you can use the vendor-specific SimplyRETS media type, e.g. `application/vnd.simplyrets-v0.1+json\"`  To view all valid content-types for making an `OPTIONS`, make a request to the SimplyRETS api root  `curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/`  The default media types used in our API responses may change in the future. If you're building an application and care about the stability of the API, be sure to request a specific media type in the Accept header as shown in the examples below.  The wordpress plugin automatically sets the `Accept` header for the compatible SimplyRETS media types.  ### Pagination There a few pieces of useful information about each request stored in the HTTP Headers:  - `X-Total-Count` shows you the total amount of listings that match   your current query. - `Link` contains pre-built pagination links for accessing the next 'page' of listings that match your query. Read more about that [here](https://simplyrets.com/blog/api-pagination.html).
 
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -33,7 +44,7 @@ module SimplyRetsClient
     # Number of half bathrooms
     attr_accessor :baths_half
 
-    # Number of stories or levels. Represented as a `double' to\naccount for half stories.\n
+    # Number of stories or levels. Represented as a `double' to account for half stories.
     attr_accessor :stories
 
     # Number of fireplaces
@@ -55,10 +66,10 @@ module SimplyRetsClient
 
     attr_accessor :lot_description
 
-    # Lot size in acres\n\n**Added on 2016/05/04 - Not available for all RETS vendors**\n
+    # Lot size in acres  **Added on 2016/05/04 - Not available for all RETS vendors**
     attr_accessor :lot_size_acres
 
-    # The property's sub-type, i.e. SingleFamilyResidential,\nCondo, etc. Or a list of Sub Types for Mobile, such as\nExpando, Manufactured, Modular, etc.\n
+    # The property's sub-type, i.e. SingleFamilyResidential, Condo, etc. Or a list of Sub Types for Mobile, such as Expando, Manufactured, Modular, etc.
     attr_accessor :sub_type
 
     # Number of bedrooms
@@ -67,7 +78,7 @@ module SimplyRetsClient
     # The properties interior features
     attr_accessor :interior_features
 
-    # Lot size dimensions or square footage as a text. This\nfield is generally used to show the pretty formatted\nlot size.\n
+    # Lot size dimensions or square footage as a text. This field is generally used to show the pretty formatted lot size.
     attr_accessor :lot_size
 
     attr_accessor :area_source
@@ -78,7 +89,7 @@ module SimplyRetsClient
     # Additional room information
     attr_accessor :additional_rooms
 
-    # Exterior Features for the listing\n
+    # Exterior Features for the listing
     attr_accessor :exterior_features
 
     # Water description and details
@@ -87,7 +98,7 @@ module SimplyRetsClient
     # View details and description
     attr_accessor :view
 
-    # The total area of the lot.  See `lotSizeUnits` for the units\nof measurement (Square Feet, Square Meters, Acres, etc.).\n\n**Added on 2016/05/04 - Not available for all RETS vendors**\n
+    # The total area of the lot.  See `lotSizeUnits` for the units of measurement (Square Feet, Square Meters, Acres, etc.).  **Added on 2016/05/04 - Not available for all RETS vendors**
     attr_accessor :lot_size_area
 
     # The subdivision or community name
@@ -98,10 +109,10 @@ module SimplyRetsClient
 
     attr_accessor :parking
 
-    # Unit of measurement for the lotSizeArea field.  e.g. Square\nFeet, Square Meters, Acres, etc.\n\nIf this field is `null` the units is the default unit\nof measure specified by your RETS provider.\n\n**Added on 2016/05/04 - Not available for all RETS vendors**\n
+    # Unit of measurement for the lotSizeArea field.  e.g. Square Feet, Square Meters, Acres, etc.  If this field is `null` the units is the default unit of measure specified by your RETS provider.  **Added on 2016/05/04 - Not available for all RETS vendors**
     attr_accessor :lot_size_area_units
 
-    # Abbreviated property type. RES is Residential, CND is CondoOrTownhome,\nRNT is Rental, MLF is Multi-Family, CRE is Commercial, LND is Land,\nFRM is Farm. See the `propertySubType` field for more information.\n
+    # Abbreviated property type. RES is Residential, CND is CondoOrTownhome, RNT is Rental, MLF is Multi-Family, CRE is Commercial, LND is Land, FRM is Farm. See the `propertySubType` field for more information.
     attr_accessor :type
 
     # Number of garage spaces
@@ -114,82 +125,67 @@ module SimplyRetsClient
     # Year the property was built
     attr_accessor :year_built
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-
         :'roof' => :'roof',
-
         :'cooling' => :'cooling',
-
         :'style' => :'style',
-
         :'area' => :'area',
-
         :'baths_full' => :'bathsFull',
-
         :'baths_half' => :'bathsHalf',
-
         :'stories' => :'stories',
-
         :'fireplaces' => :'fireplaces',
-
         :'flooring' => :'flooring',
-
         :'heating' => :'heating',
-
         :'foundation' => :'foundation',
-
         :'pool_features' => :'poolFeatures',
-
         :'laundry_features' => :'laundryFeatures',
-
         :'occupant_name' => :'occupantName',
-
         :'lot_description' => :'lotDescription',
-
         :'lot_size_acres' => :'lotSizeAcres',
-
         :'sub_type' => :'subType',
-
         :'bedrooms' => :'bedrooms',
-
         :'interior_features' => :'interiorFeatures',
-
         :'lot_size' => :'lotSize',
-
         :'area_source' => :'areaSource',
-
         :'maintenance_expense' => :'maintenanceExpense',
-
         :'additional_rooms' => :'additionalRooms',
-
         :'exterior_features' => :'exteriorFeatures',
-
         :'water' => :'water',
-
         :'view' => :'view',
-
         :'lot_size_area' => :'lotSizeArea',
-
         :'subdivision' => :'subdivision',
-
         :'construction' => :'construction',
-
         :'parking' => :'parking',
-
         :'lot_size_area_units' => :'lotSizeAreaUnits',
-
         :'type' => :'type',
-
         :'garage_spaces' => :'garageSpaces',
-
         :'accessibility' => :'accessibility',
-
         :'occupant_type' => :'occupantType',
-
         :'year_built' => :'yearBuilt'
-
       }
     end
 
@@ -225,214 +221,197 @@ module SimplyRetsClient
         :'lot_size_area' => :'Float',
         :'subdivision' => :'String',
         :'construction' => :'String',
-        :'parking' => :'School',
+        :'parking' => :'Parking',
         :'lot_size_area_units' => :'String',
         :'type' => :'String',
         :'garage_spaces' => :'Float',
         :'accessibility' => :'String',
         :'occupant_type' => :'String',
         :'year_built' => :'Integer'
-
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       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}
-
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'roof']
+      if attributes.has_key?(:'roof')
         self.roof = attributes[:'roof']
-      else
-        self.roof = "Composition"
       end
 
-      if attributes[:'cooling']
+      if attributes.has_key?(:'cooling')
         self.cooling = attributes[:'cooling']
       end
 
-      if attributes[:'style']
+      if attributes.has_key?(:'style')
         self.style = attributes[:'style']
-      else
-        self.style = "Ranch, Traditional"
       end
 
-      if attributes[:'area']
+      if attributes.has_key?(:'area')
         self.area = attributes[:'area']
-      else
-        self.area = 5984
       end
 
-      if attributes[:'bathsFull']
+      if attributes.has_key?(:'bathsFull')
         self.baths_full = attributes[:'bathsFull']
       end
 
-      if attributes[:'bathsHalf']
+      if attributes.has_key?(:'bathsHalf')
         self.baths_half = attributes[:'bathsHalf']
       end
 
-      if attributes[:'stories']
+      if attributes.has_key?(:'stories')
         self.stories = attributes[:'stories']
-      else
-        self.stories = 2.0
       end
 
-      if attributes[:'fireplaces']
+      if attributes.has_key?(:'fireplaces')
         self.fireplaces = attributes[:'fireplaces']
-      else
-        self.fireplaces = 1
       end
 
-      if attributes[:'flooring']
+      if attributes.has_key?(:'flooring')
         self.flooring = attributes[:'flooring']
       end
 
-      if attributes[:'heating']
+      if attributes.has_key?(:'heating')
         self.heating = attributes[:'heating']
-      else
-        self.heating = "Central System, Forced Air, Gas"
       end
 
-      if attributes[:'foundation']
+      if attributes.has_key?(:'foundation')
         self.foundation = attributes[:'foundation']
       end
 
-      if attributes[:'poolFeatures']
+      if attributes.has_key?(:'poolFeatures')
         self.pool_features = attributes[:'poolFeatures']
       end
 
-      if attributes[:'laundryFeatures']
+      if attributes.has_key?(:'laundryFeatures')
         self.laundry_features = attributes[:'laundryFeatures']
       end
 
-      if attributes[:'occupantName']
+      if attributes.has_key?(:'occupantName')
         self.occupant_name = attributes[:'occupantName']
       end
 
-      if attributes[:'lotDescription']
+      if attributes.has_key?(:'lotDescription')
         self.lot_description = attributes[:'lotDescription']
       end
 
-      if attributes[:'lotSizeAcres']
+      if attributes.has_key?(:'lotSizeAcres')
         self.lot_size_acres = attributes[:'lotSizeAcres']
-      else
-        self.lot_size_acres = 10.0
       end
 
-      if attributes[:'subType']
+      if attributes.has_key?(:'subType')
         self.sub_type = attributes[:'subType']
       end
 
-      if attributes[:'bedrooms']
+      if attributes.has_key?(:'bedrooms')
         self.bedrooms = attributes[:'bedrooms']
-      else
-        self.bedrooms = 5
       end
 
-      if attributes[:'interiorFeatures']
+      if attributes.has_key?(:'interiorFeatures')
         self.interior_features = attributes[:'interiorFeatures']
-      else
-        self.interior_features = "2-Story Foyer,9 ft + Ceil Main,Cathedral Ceiling,Double Vnty\nOther,High Speed Internet Available,Entrance Foyer,Hardwood\nFloors,Trey Ceilings,Walk-In Closet(s),Wall/Wall Carpet\n"
       end
 
-      if attributes[:'lotSize']
+      if attributes.has_key?(:'lotSize')
         self.lot_size = attributes[:'lotSize']
-      else
-        self.lot_size = "3/4 Up To 1 Acre"
       end
 
-      if attributes[:'areaSource']
+      if attributes.has_key?(:'areaSource')
         self.area_source = attributes[:'areaSource']
-      else
-        self.area_source = "Tax Record"
       end
 
-      if attributes[:'maintenanceExpense']
+      if attributes.has_key?(:'maintenanceExpense')
         self.maintenance_expense = attributes[:'maintenanceExpense']
       end
 
-      if attributes[:'additionalRooms']
+      if attributes.has_key?(:'additionalRooms')
         self.additional_rooms = attributes[:'additionalRooms']
       end
 
-      if attributes[:'exteriorFeatures']
+      if attributes.has_key?(:'exteriorFeatures')
         self.exterior_features = attributes[:'exteriorFeatures']
-      else
-        self.exterior_features = "1-2 Step Entry,Barn(s),Fenced Yard,Front Porch,Garden\nArea,Guest House,Out-Buildings,Patio,Prof Landscaping\n"
       end
 
-      if attributes[:'water']
+      if attributes.has_key?(:'water')
         self.water = attributes[:'water']
       end
 
-      if attributes[:'view']
+      if attributes.has_key?(:'view')
         self.view = attributes[:'view']
       end
 
-      if attributes[:'lotSizeArea']
+      if attributes.has_key?(:'lotSizeArea')
         self.lot_size_area = attributes[:'lotSizeArea']
-      else
-        self.lot_size_area = 5000.0
       end
 
-      if attributes[:'subdivision']
+      if attributes.has_key?(:'subdivision')
         self.subdivision = attributes[:'subdivision']
-      else
-        self.subdivision = "River Oaks"
       end
 
-      if attributes[:'construction']
+      if attributes.has_key?(:'construction')
         self.construction = attributes[:'construction']
       end
 
-      if attributes[:'parking']
+      if attributes.has_key?(:'parking')
         self.parking = attributes[:'parking']
       end
 
-      if attributes[:'lotSizeAreaUnits']
+      if attributes.has_key?(:'lotSizeAreaUnits')
         self.lot_size_area_units = attributes[:'lotSizeAreaUnits']
-      else
-        self.lot_size_area_units = "Sq Ft"
       end
 
-      if attributes[:'type']
+      if attributes.has_key?(:'type')
         self.type = attributes[:'type']
-      else
-        self.type = "RES"
       end
 
-      if attributes[:'garageSpaces']
+      if attributes.has_key?(:'garageSpaces')
         self.garage_spaces = attributes[:'garageSpaces']
       end
 
-      if attributes[:'accessibility']
+      if attributes.has_key?(:'accessibility')
         self.accessibility = attributes[:'accessibility']
       end
 
-      if attributes[:'occupantType']
+      if attributes.has_key?(:'occupantType')
         self.occupant_type = attributes[:'occupantType']
       end
 
-      if attributes[:'yearBuilt']
+      if attributes.has_key?(:'yearBuilt')
         self.year_built = attributes[:'yearBuilt']
-      else
-        self.year_built = 2007
       end
 
     end
 
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      type_validator = EnumAttributeValidator.new('String', ["RES", "CND", "RNT", "MLF", "CRE", "LND", "FRM"])
+      return false unless type_validator.valid?(@type)
+      return true
+    end
+
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["RES", "CND", "RNT", "MLF", "CRE", "LND", "FRM"]
-      if type && !allowed_values.include?(type)
-        fail "invalid value for 'type', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["RES", "CND", "RNT", "MLF", "CRE", "LND", "FRM"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
       end
       @type = type
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -475,35 +454,41 @@ module SimplyRetsClient
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [roof, cooling, style, area, baths_full, baths_half, stories, fireplaces, flooring, heating, foundation, pool_features, laundry_features, occupant_name, lot_description, lot_size_acres, sub_type, bedrooms, interior_features, lot_size, area_source, maintenance_expense, additional_rooms, exterior_features, water, view, lot_size_area, subdivision, construction, parking, lot_size_area_units, type, garage_spaces, accessibility, occupant_type, year_built].hash
     end
 
-    # build the object from hash
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
     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) } )
-          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 # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -537,21 +522,25 @@ module SimplyRetsClient
           end
         end
       else # model
-        _model = SimplyRetsClient.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = SimplyRetsClient.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -562,8 +551,10 @@ module SimplyRetsClient
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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
     def _to_hash(value)
       if value.is_a?(Array)
         value.compact.map{ |v| _to_hash(v) }
@@ -579,4 +570,5 @@ module SimplyRetsClient
     end
 
   end
+
 end