simplyrets 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5029ff6e372255736bef2765aecf2b597118c64a
-  data.tar.gz: 249e13b09309079b5b6b129714dcb39d27779f32
+  metadata.gz: 412b35e38999019546945d6529debef414e4844f
+  data.tar.gz: ad7e6a70f4633e31c0daa4e67dd800030308fb6e
 SHA512:
-  metadata.gz: 20edb852c10abbfcdfec3d38cf20b78f682a7432a273c2f0d33f711298b1e3fe84dc2cee099a14178ebc0d8bf73e2d55008c7c62c5ee786d17590ae044ee216b
-  data.tar.gz: 496de05f0d5c7bda062bd34422273f2e8219c8d0ac8fe8a5a2a5e00ea3118773e1b59ce5783c2ad07c06f9ae09d194e0f790e676cbacbd34eea4bebef6b24c27
+  metadata.gz: 8695c34518124f980b505d15034ad99e2ff34ec227e8e041da470e857d7f06d5f6d402f3dcc267db43d1a33534d2a26c2f79d793671514f3ec4cedd7481eec52
+  data.tar.gz: be04eb5215c2b210934bad81bbba88473ed7b5f4ba4d461cd1582543ecbd9958e2ba8cd412034a245a7ec8f97d0821bbddf71fd82228bbda67d64870e4a00120

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simplyrets (1.0.6)
+    simplyrets (1.0.7)
       json (~> 1.4, >= 1.4.6)
       typhoeus (~> 0.2, >= 0.2.1)
 

data/lib/simplyrets.rb~

@@ -0,0 +1,34 @@
+# SimplyRets common files
+require 'simplyrets/simplyrets'
+require 'simplyrets/simplyrets/configuration'
+require 'simplyrets/simplyrets/api_error'
+require 'simplyrets/simplyrets/request'
+require 'simplyrets/simplyrets/response'
+require 'simplyrets/simplyrets/version'
+
+# Models
+require 'simplyrets/models/base_object'
+require 'simplyrets/models/street_address'
+require 'simplyrets/models/property'
+require 'simplyrets/models/listing'
+require 'simplyrets/models/open_house'
+require 'simplyrets/models/office'
+require 'simplyrets/models/agent'
+require 'simplyrets/models/sales'
+require 'simplyrets/models/school'
+require 'simplyrets/models/parking'
+require 'simplyrets/models/contact_information'
+require 'simplyrets/models/tax'
+require 'simplyrets/models/geographic_data'
+require 'simplyrets/models/broker'
+require 'simplyrets/models/mls_information'
+require 'simplyrets/models/error'
+
+# APIs
+require 'simplyrets/api/default_api'
+
+module SimplyRetsClient
+  # Initialize the default configuration
+  SimplyRets.configuration = SimplyRets::Configuration.new
+  SimplyRets.configure { |config| }
+end

data/lib/simplyrets/api/#default_api.rb#

@@ -0,0 +1,146 @@
+require "uri"
+
+module SimplyRetsClient
+  class Properties_api
+
+    # The SimplyRets Listings API
+    # This is the main endpoint for accessing your properties. View\nall of the available query parameters and make requests below!\nThe API uses Basic Authorization, which most HTTP libraries\nwill handle for you. To use the test test data (which is what\nthis pages uses), you can use the api key `simplyrets` and\nsecret `simplyrets`. Note that the test listings are not live\nMLS listings but the data, query parameters, and response\nbodies will all work the same.\n
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q A fuzzy keyword search.\n
+    # @option opts [Integer] :minprice Filter listings by a minimum price.\n
+    # @option opts [Integer] :maxprice Filter listings by a maximum price\n
+    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
+    # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft.\n
+    # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft.\n
+    # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms.\n
+    # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms.\n
+    # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms.\n
+    # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms.\n
+    # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the `offset` parameter, or the Link in the HTTP\nHeader.\n
+    # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter\nby the limit to go to the next \"page\" of listings. Also take\na look at the Link HTTP Header for pre-built pagination.\n
+    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID.\nYou can specific multiple broker parameters. Note, the Broker\nID is provided by your MLS.\n
+    # @option opts [Array<String>] :features Filter the listings returned by specific features.  You\ncan specify multiple.\n
+    # @option opts [Array<String>] :amenities Filter the listings returned by specific amenities.  You\ncan specify multiple amenities.\n
+    # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and\nsubdivisions. You can specify multiple.\n
+    # @option opts [Array<String>] :points A list of latitude longitude coordinates which contain\nthe property. Our documentation generator does not yet\nsupport using a list of parameters.\n
+    # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can\nspecify multiple.\n
+    # @option opts [Array<String>] :status Filter the listings returned by a specific status. You can\nspecify multiple.\n
+    # @option opts [String] :type Request listings by a specific property type. This\ndefaults to Residential, and you can only specify multiple property types in a single query.\n
+    # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
+    # @option opts [String] :include Include a limited set of extra fields which are not found\nin the default response body\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n- &#39;pool&#39; includes an additional pool description\n- &#39;association&#39; includes additional home owners association data\n
+    # @return [Array<Listing>]
+    def self.properties(opts = {})
+      if SimplyRets.configuration.debug
+        SimplyRets.logger.debug "Calling API: DefaultApi#properties ..."
+      end
+
+      if opts[:'sort'] && !['listprice', '-listprice', 'listdate', '-listdate', 'beds', '-beds', 'baths', '-baths'].include?(opts[:'sort'])
+        fail 'invalid value for "sort", must be one of listprice, -listprice, listdate, -listdate, beds, -beds, baths, -baths'
+      end
+
+      if opts[:'include'] && !['pool', 'rooms', 'association'].include?(opts[:'include'])
+        fail 'invalid value for "include", must be one of pool, rooms, association'
+      end
+
+      # resource path
+      path = "/properties".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q'] = opts[:'q'] if opts[:'q']
+      query_params[:'minprice'] = opts[:'minprice'] if opts[:'minprice']
+      query_params[:'maxprice'] = opts[:'maxprice'] if opts[:'maxprice']
+      query_params[:'agent'] = opts[:'agent'] if opts[:'agent']
+      query_params[:'minarea'] = opts[:'minarea'] if opts[:'minarea']
+      query_params[:'maxarea'] = opts[:'maxarea'] if opts[:'maxarea']
+      query_params[:'minbaths'] = opts[:'minbaths'] if opts[:'minbaths']
+      query_params[:'maxbaths'] = opts[:'maxbaths'] if opts[:'maxbaths']
+      query_params[:'minbeds'] = opts[:'minbeds'] if opts[:'minbeds']
+      query_params[:'maxbeds'] = opts[:'maxbeds'] if opts[:'maxbeds']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'brokers'] = opts[:'brokers'] if opts[:'brokers']
+      query_params[:'features'] = opts[:'features'] if opts[:'features']
+      query_params[:'amenities'] = opts[:'amenities'] if opts[:'amenities']
+      query_params[:'neighborhoods'] = opts[:'neighborhoods'] if opts[:'neighborhoods']
+      query_params[:'points'] = opts[:'points'] if opts[:'points']
+      query_params[:'counties'] = opts[:'counties'] if opts[:'counties']
+      query_params[:'status'] = opts[:'status'] if opts[:'status']
+      query_params[:'type'] = opts[:'type'] if opts[:'type']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+      query_params[:'include'] = opts[:'include'] if opts[:'include']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = []
+      _header_accept_result = SimplyRets::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = SimplyRets::Request.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+
+
+      auth_names = ['basicAuth']
+      response = SimplyRets::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
+      result = response.deserialize('Array<Listing>')
+      if SimplyRets.configuration.debug
+        SimplyRets.logger.debug "API called: DefaultApi#properties. Result: #{result.inspect}"
+      end
+      result
+    end
+
+    # Single Listing Endpoint
+    # Use this endpoint for accessing a single listing.\n
+    # @param listing_id A listings listingId (unique indentifier).
+    # @param [Hash] opts the optional parameters
+    # @return [Listing]
+    def self.property(listing_id, opts = {})
+      if SimplyRets.configuration.debug
+        SimplyRets.logger.debug "Calling API: DefaultApi#property ..."
+      end
+
+      # verify the required parameter 'listing_id' is set
+      fail "Missing the required parameter 'listing_id' when calling property" if listing_id.nil?
+
+      # resource path
+      path = "/properties/{listingId}".sub('{format}','json').sub('{' + 'listingId' + '}', listing_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = []
+      _header_accept_result = SimplyRets::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = SimplyRets::Request.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+
+
+      auth_names = ['basicAuth']
+      response = SimplyRets::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
+      result = response.deserialize('Listing')
+      if SimplyRets.configuration.debug
+        SimplyRets.logger.debug "API called: DefaultApi#property. Result: #{result.inspect}"
+      end
+      result
+    end
+  end
+end

data/lib/simplyrets/api/default_api.rb

@@ -25,7 +25,7 @@ module SimplyRetsClient
     # @option opts [Array<String>] :points A list of latitude longitude coordinates which contain\nthe property. Our documentation generator does not yet\nsupport using a list of parameters.\n
     # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can\nspecify multiple.\n
     # @option opts [Array<String>] :status Filter the listings returned by a specific status. You can\nspecify multiple.\n
-    # @option opts [String] :type Request listings by a specific property type. This\ndefaults to Residential, and you can only specify one type\nin a single query.\n
+    # @option opts [String] :type Request listings by a specific property type. This\ndefaults to searching by Residential & Rental, and you can only specify multiple property types in a single query.\n
     # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
     # @option opts [String] :include Include a limited set of extra fields which are not found\nin the default response body\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n- &#39;pool&#39; includes an additional pool description\n- &#39;association&#39; includes additional home owners association data\n
     # @return [Array<Listing>]
@@ -34,10 +34,6 @@ module SimplyRetsClient
         SimplyRets.logger.debug "Calling API: DefaultApi#properties ..."
       end
 
-      if opts[:'type'] && !['Residential', 'Rental', 'Multifamily', 'Condominium', 'Commercial', 'Land'].include?(opts[:'type'])
-        fail 'invalid value for "type", must be one of Residential, Rential, Multifamily, Condominium, Commercial, Land'
-      end
-
       if opts[:'sort'] && !['listprice', '-listprice', 'listdate', '-listdate', 'beds', '-beds', 'baths', '-baths'].include?(opts[:'sort'])
         fail 'invalid value for "sort", must be one of listprice, -listprice, listdate, -listdate, beds, -beds, baths, -baths'
       end

data/lib/simplyrets/simplyrets/version.rb

@@ -1,5 +1,5 @@
 module SimplyRetsClient
   module SimplyRets
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplyrets
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Christopher Reichert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -207,6 +207,8 @@ files:
 - Rakefile
 - example.rb
 - lib/simplyrets.rb
+- lib/simplyrets.rb~
+- lib/simplyrets/api/#default_api.rb#
 - lib/simplyrets/api/default_api.rb
 - lib/simplyrets/models/agent.rb
 - lib/simplyrets/models/base_object.rb
@@ -230,26 +232,8 @@ files:
 - lib/simplyrets/simplyrets/request.rb
 - lib/simplyrets/simplyrets/response.rb
 - lib/simplyrets/simplyrets/version.rb
+- simplyrets-1.0.6.gem
 - simplyrets.gemspec
-- spec/api/default_api_spec.rb
-- spec/api/default_api_spec.rb~
-- spec/models/agent_spec.rb
-- spec/models/broker_spec.rb
-- spec/models/contact_information_spec.rb
-- spec/models/error_spec.rb
-- spec/models/geographic_data_spec.rb
-- spec/models/listing_spec.rb
-- spec/models/mls_information_spec.rb
-- spec/models/office_spec.rb
-- spec/models/open_house_spec.rb
-- spec/models/parking_spec.rb
-- spec/models/property_spec.rb
-- spec/models/sales_spec.rb
-- spec/models/school_spec.rb
-- spec/models/street_address_spec.rb
-- spec/models/tax_spec.rb
-- spec/spec_helper.rb
-- spec/spec_helper.rb~
 homepage: https://simplyrets.com
 licenses:
 - MIT

data/spec/api/default_api_spec.rb

@@ -1,135 +0,0 @@
-=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 'spec_helper'
-require 'json'
-
-# Unit tests for SwaggerClient::DefaultApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
-# Please update as you see appropriate
-describe 'DefaultApi' do
-  before do
-    # run before each test
-    @instance = SwaggerClient::DefaultApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of DefaultApi' do
-    it 'should create an instact of DefaultApi' do
-      @instance.should be_a(SwaggerClient::DefaultApi)
-    end
-  end
-
-  # unit tests for openhouses_get
-  # The SimplyRETS OpenHouses API
-  # This is the main endpoint for accessing openhouses.\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :type Request listings by a specific property type. This\ndefaults to Residential, and you can only specify one type\nin a single query.\n
-  # @option opts [String] :listing_id Request openhouses for a specific `listingId`.\n
-  # @option opts [Array<String>] :cities Filter the openhouses returned by a list of valid cities. A\nlist of valid cities can be found by making an OPTIONS\nrequest to the &#x60;/openhouses&#x60; endpoint.\n
-  # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID.\nYou can specific multiple broker parameters. Note, the Broker\nID is provided by your MLS.\n
-  # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
-  # @option opts [Integer] :minprice Filter listings by a minimum price.\n
-  # @option opts [DateTime] :startdate Scheduled date and time of the open house showing
-  # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter\nby the limit to go to the next \&quot;page\&quot; of listings. Also take\na look at the Link HTTP Header for pre-built pagination.\n
-  # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the &#x60;offset&#x60; parameter, or the Link in the HTTP\nHeader.\n
-  # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
-  # @return [Array<OpenHouse>]
-  describe 'openhouses_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for openhouses_open_house_key_get
-  # Single OpenHouse Endpoint
-  # Use this endpoint for accessing a single OpenHouse.\n
-  # @param open_house_key A unique OpenHouse identification key
-  # @param [Hash] opts the optional parameters
-  # @return [OpenHouse]
-  describe 'openhouses_open_house_key_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for properties_get
-  # The SimplyRETS Listings API
-  # This is the main endpoint for accessing your properties. View\nall of the available query parameters and make requests below!\nThe API uses Basic Authentication, which most HTTP libraries\nwill handle for you. To use the test data (which is what this\npages uses), you can use the api key &#x60;simplyrets&#x60; and secret\n&#x60;simplyrets&#x60;. Note that these test listings are not live MLS\nlistings but the data, query parameters, and response bodies\nwill all work the same.\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :q A textual keyword search. This parameter will search  the following\nfields, when available:\n\n  - listingId (This does _not_ search the &#39;mlsId&#39; field in the\nSimplyRETS response body)\n\n  - street number\n\n  - street name\n\n  - mls area (major)\n\n  - city\n\n  - subdivision name\n\n  - postal code\n\nNOTE\n
-  # @option opts [Array<String>] :status Request listings by a specific status. This parameter\ndefaults to active and you can specify multiple statuses\nin a single query.\n\n\nListing statuses depend on your MLS&#39;s availability. Below is\na brief description of each status with possible synonyms which\nmay map to your MLS-specific statuses\n- *Active*: Active Listing which is still on the market\n- *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\n- *Pending*: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract\n- *Hold*: The listing has been withdrawn from the market, but a contract\n\n  still exists between the seller and the listing member. Synonyms:\nHold, Hold Do Not Show, Temp Off Market\n- *Withdrawn*: The listing has been withdrawn from the market, but a contract\n\n  still exists between the seller and the listing member. Synonyms:\nHold, Hold Do Not Show, Temp Off Market\n- *Closed*: The purchase agreement has been fulfilled or the lease\n\n  agreement has been executed. Synonyms: Sold, Leased, Rented, Closed\nSale\n- *Expired*: The listing contract has expired\n- *Delete*: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap\n- *Incomplete*: The listing has not yet be completely entered and is not yet\n\n  published in the MLS. Synonyms: Draft, Partially Complted\n\n- *ComingSoon*\n
-  # @option opts [Array<String>] :type Request listings by a specific property type. This\ndefaults to Residential and Rental. You can specify\nmultiple property types in a single query.\n
-  # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
-  # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker\nID. For some MLS areas, this is the ListOfficeId (Listing\nOffice ID).  You can specific multiple broker\nparameters. Note, this query parameter is only available\nif a Broker ID is provided by your MLS.\n
-  # @option opts [Integer] :minprice Filter listings by a minimum price.\n
-  # @option opts [Integer] :maxprice Filter listings by a maximum price\n
-  # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft.\n
-  # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft.\n
-  # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms.\n
-  # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms.\n
-  # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms.\n
-  # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms.\n
-  # @option opts [Integer] :maxdom Filter listings by a maximum number of days on market.\n_Note that your MLS must provide Days on Market data._\n
-  # @option opts [Integer] :minyear Filter listings by a setting a minimum year built.\n
-  # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the &#x60;offset&#x60; parameter, or the Link in the HTTP\nHeader.\n
-  # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset\nparameter by the limit to go to the next \&quot;page\&quot; of\nlistings. Also take a look at the Link HTTP Header for\npre-built pagination.\n
-  # @option opts [String] :vendor Used to specify the vendor (MLS) to search from. This\nparameter is required on multi-MLS apps, and you can only\nquery one vendor at a time. To get your vendor id&#39;s make\nan OPTIONS request to https://api.simplyrets.com.\n
-  # @option opts [Array<String>] :postal_codes Filter the listings returned by postal codes / zip\ncode. You can specify multiple.\n
-  # @option opts [Array<String>] :features Filter the listings by specific interior features.  You\ncan filter by multiple. For example, to filter trial listings\nby multiple features you can use,\nReturn listings that are within a set of latitude\nlongitude coordinates. For example,\n\n\n&#x60;&#x60;&#x60;\nWet Bar\nHigh Ceiling\n&#x60;&#x60;&#x60;\n\n\ne.g. &#x60;https://simplyrets.com/services?features&#x3D;Wet%20Bar&amp;features&#x3D;High%20Ceiling&#x60;\n\n\nThe features provided by your MLS can be seen in your\nOPTIONS request. To view all valid features, make a\nrequest to the SimplyRETS api root\n\n\n&#x60;curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/&#x60;\n
-  # @option opts [String] :water Query water/waterfront listings only. Specify &#39;true&#39; to\nfilter waterfront listings.\n
-  # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and\nsubdivisions. You can specify multiple.\n
-  # @option opts [Array<String>] :cities Filter the listings returned by specific cities. You can\nspecify multiple.\n
-  # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can\nspecify multiple.\n
-  # @option opts [Array<String>] :points Return listings that are within a set of latitude\nlongitude coordinates. For example;\n&#x60;&#x60;&#x60;\n29.723837,-95.69778\n29.938275,-95.69778\n29.938275,-95.32974\n29.723837,-95.32974\n&#x60;&#x60;&#x60;\nNote that some MLS&#39;s do not provide latitude and longitude\nfor their listings, which is required for this parameter\nto work. In these cases, SimplyRETS offers a [Geocoding\nAddon](https://simplyrets.com/services#geocoding).\n\n\nCheck out our\n[blog post](https://simplyrets.com/blog/interactive-map-search.html)\non using the &#x60;points&#x60; parameter to build a map-based app\nin javascript.\n
-  # @option opts [Array<String>] :include Include a extra fields which are not in the default\nresponse body\n- &#39;association&#39; includes additional HOA data\n- &#39;agreement&#39; information on the listing agreement\n- &#39;garageSpaces&#39; additional garage data\n- &#39;maintenanceExpense&#39; data on maintenance expenses\n- &#39;parking&#39; additional parking data\n- &#39;pool&#39; includes an additional pool description\n- &#39;taxAnnualAmount&#39; include the annual tax amount\n- &#39;taxYear&#39; include the tax year data\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n\nNote that your MLS must provide these fields in their RETS\ndata for them to be available in the API response.\n
-  # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
-  # @return [Array<Listing>]
-  describe 'properties_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for properties_mls_id_get
-  # Single Listing Endpoint
-  # Use this endpoint for accessing a single listing. When you\nmake a search to the &#x60;/properties&#x60; endpoint, each listing in\nthe response will contain a unique &#x60;mlsId&#x60; field which should\nbe used to request that listing on this route.\n\nThe &#x60;mlsId&#x60; field is a unique identifier for a listing which\nis specific to the SimplyRETS API only.  It is different from\nthe &#x60;listingId&#x60; field is the public number given to a listing\nby the MLS and is not used here.\n
-  # @param mls_id The &#x60;mlsId&#x60; field is a unique identifier which is specific\nto the SimplyRETS API only.  This field is different from\nthe &#x60;listingId&#x60; field (which is the public number given to\na listing by the MLS and is not used here).\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [Array<String>] :include Include a extra fields which are not in the default\nresponse body\n- &#39;association&#39; includes additional HOA data\n- &#39;agreement&#39; information on the listing agreement\n- &#39;garageSpaces&#39; additional garage data\n- &#39;maintenanceExpense&#39; data on maintenance expenses\n- &#39;parking&#39; additional parking data\n- &#39;pool&#39; includes an additional pool description\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n\nNote that your MLS must provide these fields in their RETS\ndata for them to be available with valid data in the API\nresponse. If your MLS does not offer these fields, they will\ncontain &#39;null&#39;.\n
-  # @return [Listing]
-  describe 'properties_mls_id_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-end

data/spec/api/default_api_spec.rb~

@@ -1,135 +0,0 @@
-=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 'spec_helper'
-require 'json'
-
-# Unit tests for SwaggerClient::DefaultApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
-# Please update as you see appropriate
-describe 'DefaultApi' do
-  before do
-    # run before each test
-    @instance = SwaggerClient::DefaultApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of DefaultApi' do
-    it 'should create an instact of DefaultApi' do
-      @instance.should be_a(SwaggerClient::DefaultApi)
-    end
-  end
-
-  # unit tests for openhouses_get
-  # The SimplyRETS OpenHouses API
-  # This is the main endpoint for accessing openhouses.\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :type Request listings by a specific property type. This\ndefaults to Residential, and you can only specify one type\nin a single query.\n
-  # @option opts [String] :listing_id Request openhouses for a specific `listingId`.\n
-  # @option opts [Array<String>] :cities Filter the openhouses returned by a list of valid cities. A\nlist of valid cities can be found by making an OPTIONS\nrequest to the &#x60;/openhouses&#x60; endpoint.\n
-  # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID.\nYou can specific multiple broker parameters. Note, the Broker\nID is provided by your MLS.\n
-  # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
-  # @option opts [Integer] :minprice Filter listings by a minimum price.\n
-  # @option opts [DateTime] :startdate Scheduled date and time of the open house showing
-  # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter\nby the limit to go to the next \&quot;page\&quot; of listings. Also take\na look at the Link HTTP Header for pre-built pagination.\n
-  # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the &#x60;offset&#x60; parameter, or the Link in the HTTP\nHeader.\n
-  # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
-  # @return [Array<OpenHouse>]
-  describe 'openhouses_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for openhouses_open_house_key_get
-  # Single OpenHouse Endpoint
-  # Use this endpoint for accessing a single OpenHouse.\n
-  # @param open_house_key A unique OpenHouse identification key
-  # @param [Hash] opts the optional parameters
-  # @return [OpenHouse]
-  describe 'openhouses_open_house_key_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for properties_get
-  # The SimplyRETS Listings API
-  # This is the main endpoint for accessing your properties. View\nall of the available query parameters and make requests below!\nThe API uses Basic Authentication, which most HTTP libraries\nwill handle for you. To use the test data (which is what this\npages uses), you can use the api key &#x60;simplyrets&#x60; and secret\n&#x60;simplyrets&#x60;. Note that these test listings are not live MLS\nlistings but the data, query parameters, and response bodies\nwill all work the same.\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :q A textual keyword search. This parameter will search  the following\nfields, when available:\n\n  - listingId (This does _not_ search the &#39;mlsId&#39; field in the\nSimplyRETS response body)\n\n  - street number\n\n  - street name\n\n  - mls area (major)\n\n  - city\n\n  - subdivision name\n\n  - postal code\n\nNOTE\n
-  # @option opts [Array<String>] :status Request listings by a specific status. This parameter\ndefaults to active and you can specify multiple statuses\nin a single query.\n\n\nListing statuses depend on your MLS&#39;s availability. Below is\na brief description of each status with possible synonyms which\nmay map to your MLS-specific statuses\n- *Active*: Active Listing which is still on the market\n- *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\n- *Pending*: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract\n- *Hold*: The listing has been withdrawn from the market, but a contract\n\n  still exists between the seller and the listing member. Synonyms:\nHold, Hold Do Not Show, Temp Off Market\n- *Withdrawn*: The listing has been withdrawn from the market, but a contract\n\n  still exists between the seller and the listing member. Synonyms:\nHold, Hold Do Not Show, Temp Off Market\n- *Closed*: The purchase agreement has been fulfilled or the lease\n\n  agreement has been executed. Synonyms: Sold, Leased, Rented, Closed\nSale\n- *Expired*: The listing contract has expired\n- *Delete*: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap\n- *Incomplete*: The listing has not yet be completely entered and is not yet\n\n  published in the MLS. Synonyms: Draft, Partially Complted\n\n- *ComingSoon*\n
-  # @option opts [Array<String>] :type Request listings by a specific property type. This\ndefaults to Residential and Rental. You can specify\nmultiple property types in a single query.\n
-  # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the\nAgent ID is provided by your MLS.\n
-  # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker\nID. For some MLS areas, this is the ListOfficeId (Listing\nOffice ID).  You can specific multiple broker\nparameters. Note, this query parameter is only available\nif a Broker ID is provided by your MLS.\n
-  # @option opts [Integer] :minprice Filter listings by a minimum price.\n
-  # @option opts [Integer] :maxprice Filter listings by a maximum price\n
-  # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft.\n
-  # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft.\n
-  # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms.\n
-  # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms.\n
-  # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms.\n
-  # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms.\n
-  # @option opts [Integer] :maxdom Filter listings by a maximum number of days on market.\n_Note that your MLS must provide Days on Market data._\n
-  # @option opts [Integer] :minyear Filter listings by a setting a minimum year built.\n
-  # @option opts [Integer] :limit Set the number of listings to return in the response.\nThis defaults to 20 listings, and can be a maximum of 50.\nTo paginate through to the next page of listings, take a\nlook at the &#x60;offset&#x60; parameter, or the Link in the HTTP\nHeader.\n
-  # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset\nparameter by the limit to go to the next \&quot;page\&quot; of\nlistings. Also take a look at the Link HTTP Header for\npre-built pagination.\n
-  # @option opts [String] :vendor Used to specify the vendor (MLS) to search from. This\nparameter is required on multi-MLS apps, and you can only\nquery one vendor at a time. To get your vendor id&#39;s make\nan OPTIONS request to https://api.simplyrets.com.\n
-  # @option opts [Array<String>] :postal_codes Filter the listings returned by postal codes / zip\ncode. You can specify multiple.\n
-  # @option opts [Array<String>] :features Filter the listings by specific interior features.  You\ncan filter by multiple. For example, to filter trial listings\nby multiple features you can use,\nReturn listings that are within a set of latitude\nlongitude coordinates. For example,\n\n\n&#x60;&#x60;&#x60;\nWet Bar\nHigh Ceiling\n&#x60;&#x60;&#x60;\n\n\ne.g. &#x60;https://simplyrets.com/services?features&#x3D;Wet%20Bar&amp;features&#x3D;High%20Ceiling&#x60;\n\n\nThe features provided by your MLS can be seen in your\nOPTIONS request. To view all valid features, make a\nrequest to the SimplyRETS api root\n\n\n&#x60;curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/&#x60;\n
-  # @option opts [String] :water Query water/waterfront listings only. Specify &#39;true&#39; to\nfilter waterfront listings.\n
-  # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and\nsubdivisions. You can specify multiple.\n
-  # @option opts [Array<String>] :cities Filter the listings returned by specific cities. You can\nspecify multiple.\n
-  # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can\nspecify multiple.\n
-  # @option opts [Array<String>] :points Return listings that are within a set of latitude\nlongitude coordinates. For example;\n&#x60;&#x60;&#x60;\n29.723837,-95.69778\n29.938275,-95.69778\n29.938275,-95.32974\n29.723837,-95.32974\n&#x60;&#x60;&#x60;\nNote that some MLS&#39;s do not provide latitude and longitude\nfor their listings, which is required for this parameter\nto work. In these cases, SimplyRETS offers a [Geocoding\nAddon](https://simplyrets.com/services#geocoding).\n\n\nCheck out our\n[blog post](https://simplyrets.com/blog/interactive-map-search.html)\non using the &#x60;points&#x60; parameter to build a map-based app\nin javascript.\n
-  # @option opts [Array<String>] :include Include a extra fields which are not in the default\nresponse body\n- &#39;association&#39; includes additional HOA data\n- &#39;agreement&#39; information on the listing agreement\n- &#39;garageSpaces&#39; additional garage data\n- &#39;maintenanceExpense&#39; data on maintenance expenses\n- &#39;parking&#39; additional parking data\n- &#39;pool&#39; includes an additional pool description\n- &#39;taxAnnualAmount&#39; include the annual tax amount\n- &#39;taxYear&#39; include the tax year data\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n\nNote that your MLS must provide these fields in their RETS\ndata for them to be available in the API response.\n
-  # @option opts [String] :sort Sort the response by a specific field. Values starting\nwith a minus (-) denote descending order, while the others\nare ascending.\n
-  # @return [Array<Listing>]
-  describe 'properties_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-  # unit tests for properties_mls_id_get
-  # Single Listing Endpoint
-  # Use this endpoint for accessing a single listing. When you\nmake a search to the &#x60;/properties&#x60; endpoint, each listing in\nthe response will contain a unique &#x60;mlsId&#x60; field which should\nbe used to request that listing on this route.\n\nThe &#x60;mlsId&#x60; field is a unique identifier for a listing which\nis specific to the SimplyRETS API only.  It is different from\nthe &#x60;listingId&#x60; field is the public number given to a listing\nby the MLS and is not used here.\n
-  # @param mls_id The &#x60;mlsId&#x60; field is a unique identifier which is specific\nto the SimplyRETS API only.  This field is different from\nthe &#x60;listingId&#x60; field (which is the public number given to\na listing by the MLS and is not used here).\n
-  # @param [Hash] opts the optional parameters
-  # @option opts [Array<String>] :include Include a extra fields which are not in the default\nresponse body\n- &#39;association&#39; includes additional HOA data\n- &#39;agreement&#39; information on the listing agreement\n- &#39;garageSpaces&#39; additional garage data\n- &#39;maintenanceExpense&#39; data on maintenance expenses\n- &#39;parking&#39; additional parking data\n- &#39;pool&#39; includes an additional pool description\n- &#39;rooms&#39; include parameter will include\n   any additional rooms as a list.\n\nNote that your MLS must provide these fields in their RETS\ndata for them to be available with valid data in the API\nresponse. If your MLS does not offer these fields, they will\ncontain &#39;null&#39;.\n
-  # @return [Listing]
-  describe 'properties_mls_id_get test' do
-    it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
-    end
-  end
-
-end