simplyrets 2.0.0 → 2.0.1

data/ruby-client/docs/Error.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **Integer** | Error code. In general, we try to adhere to HTTP status code and use these error statuses for detailed reporting.  | [optional] 
+**message** | **String** | Status message with an explanation of the error | [optional] 
+
+

data/ruby-client/docs/GeographicData.md

@@ -0,0 +1,12 @@
+# SwaggerClient::GeographicData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**county** | **String** | Listing county | [optional] 
+**lat** | **Float** | Listing latitude (if available) | [optional] 
+**lng** | **Float** | Listing longitude (if available) | [optional] 
+**market_area** | **String** | Listing GeoMarket area. May be the same as mlsArea | [optional] 
+**directions** | **String** | Directions to the property | [optional] 
+
+

data/ruby-client/docs/Listing.md

@@ -0,0 +1,30 @@
+# SwaggerClient::Listing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**private_remarks** | **String** | Agent only remarks | [optional] 
+**property** | [**Property**](Property.md) | Specific property data associated with listing. | [optional] 
+**mls_id** | **Integer** | A unique identifier for this listing specific to the SimplyRETS API. Thie identifier is specific to the SimplyRETS api and has no correlation with the MLS number. Use this id when making requests to the single listing endpoint (eg, `/properties/{mlsId}`).  Applications should not rely on specific `mlsId`s being present. Instead, apps should dynamically use the `mlsId` after using other more general query parameters. Many mls vendors require listings which are expired, terminated or sold to be purged, which will render calls to specific `mlsId`s to return nothing (or possibly a 404).  | [optional] 
+**showing_instructions** | **String** | Public instructions for showing the property. | [optional] 
+**office** | [**Office**](Office.md) | Listing office or brokerage. | [optional] 
+**lease_term** | **String** | Represents the length of the lease. | [optional] 
+**disclaimer** | **String** | Data accuracy disclaimer. The value in the disclaimer may change depending on your MLS vendors rules.  | [optional] 
+**address** | [**StreetAddress**](StreetAddress.md) | Comprehensive property address information | [optional] 
+**list_date** | **DateTime** | Date and time the listing became Active | [optional] 
+**agent** | [**Agent**](Agent.md) | Comprehensive listing agent information | [optional] 
+**modified** | **DateTime** | Date and time of the last modification | [optional] 
+**school** | [**School**](School.md) | Comprehensive school zone data | [optional] 
+**photos** | **Array<String>** | Photos of the property. Images are served over https and are suitable for production use on secure websites  | [optional] 
+**list_price** | **Float** | Price of the listing | [optional] 
+**listing_id** | **String** | Data Dictionary v1.3 ListingId. The well known identifier for the listing. The value is the id or number by the MLS as a public identifier for the listing.  This identifier should not be confused with the `mlsId`, which is specific to the SimplyRETS API.  | [optional] 
+**mls** | [**MlsInformation**](MlsInformation.md) | MLS vendor information and data | [optional] 
+**geo** | [**GeographicData**](GeographicData.md) | Geographic data for the listing | [optional] 
+**tax** | [**Tax**](Tax.md) | Associate tax data | [optional] 
+**co_agent** | [**Agent**](Agent.md) | co-listing agent information.  *NOTE*: If your RETS feed stores co-list information outside of the `Property` resource, co-list agent information will not be available.  | [optional] 
+**sales** | [**Sales**](Sales.md) | Sales data | [optional] 
+**lease_type** | **String** | Information about the status of the existing lease on the property. | [optional] 
+**virtual_tour_url** | **String** | The URL for an unbranded virtual tour of the property.  **Added on 2016/05/04 - Not available for all RETS vendors**  | [optional] 
+**remarks** | **String** | Description or remarks | [optional] 
+
+

data/ruby-client/docs/MlsInformation.md

@@ -0,0 +1,11 @@
+# SwaggerClient::MlsInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | MLS Status Code. Compliant with data dictionary v1.3 ListingStatus Listing statuses depend on your MLS's availability. Below is a brief description of each status with possible synonyms which may map to your MLS-specific statuses - Active: Active Listing which is still on the market - ActiveUnderContract: An offer has been accepted but the listing is still on market. Synonyms: Accepting Backup Offers, Backup Offer, Active With Accepted. Synonyms: Offer, Backup, Contingent - Pending: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract - Hold: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - Withdrawn: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - Closed: The purchase agreement has been fulfilled or the lease   agreement has been executed. Synonyms: Sold, Leased, Rented, Closed Sale - Expired: The listing contract has expired - Delete: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap - Incomplete: The listing has not yet be completely entered and is not yet   published in the MLS. Synonyms: Draft, Partially Complted - ComingSoon  | [optional] 
+**area** | **String** | MLS Area. Generally a subdivision or community name. | [optional] 
+**days_on_market** | **Integer** | Amount of days the property has been Active | [optional] 
+**originating_system_name** | **String** | Alias for the listing office or brokerage  This field corresponds to the data-dictionary `OriginatingSystemName` field  The name of the originating record provider.  Most commonly the name of the MLS. The place where the listing is originally input by the member.  The legal name of the company.  To be used for display.  If you're RETS provider aggregates feeds from multiple MLS's, this will be the name of the corresponding MLS.  | [optional] 
+
+

data/ruby-client/docs/Office.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Office
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact** | [**ContactInformation**](ContactInformation.md) | Associated contact details for the office. The availability of this information depends on your MLS rules and regulations  *Contact information is not available for all RETS Vendors.*  | [optional] 
+**name** | **String** | Pimary office name | [optional] 
+**serving_name** | **String** | Primary office or brokerage name | [optional] 
+**brokerid** | **String** | Office or brokerage MLS identifier  **Not available for all RETS vendors**  | [optional] 
+
+

data/ruby-client/docs/OpenHouse.md

@@ -0,0 +1,15 @@
+# SwaggerClient::OpenHouse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**refreshments** | **String** | Provided | [optional] 
+**listing** | [**Listing**](Listing.md) | The full listing associated with the OpenHouse | [optional] 
+**start_time** | **DateTime** | Start Date for the open house | [optional] 
+**open_house_key** | **String** | A unique identifier for the open house which is specific to the SimplyRETS API  | [optional] 
+**end_time** | **DateTime** | The ending date time for the open house | [optional] 
+**open_house_id** | **String** | The MLS number or id provided by the MLS  | [optional] 
+**type** | **String** | The open house type. For example, Public or Private | [optional] 
+**description** | **String** | The remarks and/or description details for the open house | [optional] 
+
+

data/ruby-client/docs/Parking.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Parking
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leased** | **String** |  | [optional] 
+**spaces** | **Integer** | Number of parking spaces | [optional] 
+**description** | **String** | Parking features description | [optional] 
+
+

data/ruby-client/docs/Property.md

@@ -0,0 +1,43 @@
+# SwaggerClient::Property
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**roof** | **String** | Property roof description | [optional] 
+**cooling** | **String** | A description of the cooling or air conditioning features of the property. | [optional] 
+**style** | **String** | Property style description or short string | [optional] 
+**area** | **Integer** | Square footage of the building associated with a listing | [optional] 
+**baths_full** | **Integer** | Number of full bathrooms | [optional] 
+**baths_half** | **Integer** | Number of half bathrooms | [optional] 
+**stories** | **Float** | Number of stories or levels. Represented as a `double' to account for half stories.  | [optional] 
+**fireplaces** | **Integer** | Number of fireplaces | [optional] 
+**flooring** | **String** | The type(s) of flooring found within the property. | [optional] 
+**heating** | **String** | Heating description or short string | [optional] 
+**foundation** | **String** |  | [optional] 
+**pool_features** | **String** |  | [optional] 
+**laundry_features** | **String** |  | [optional] 
+**occupant_name** | **String** |  | [optional] 
+**lot_description** | **String** |  | [optional] 
+**lot_size_acres** | **Float** | Lot size in acres  **Added on 2016/05/04 - Not available for all RETS vendors**  | [optional] 
+**sub_type** | **String** | The property's sub-type, i.e. SingleFamilyResidential, Condo, etc. Or a list of Sub Types for Mobile, such as Expando, Manufactured, Modular, etc.  | [optional] 
+**bedrooms** | **Integer** | Number of bedrooms | [optional] 
+**interior_features** | **String** | The properties interior features | [optional] 
+**lot_size** | **String** | Lot size dimensions or square footage as a text. This field is generally used to show the pretty formatted lot size.  | [optional] 
+**area_source** | **String** |  | [optional] 
+**maintenance_expense** | **Float** | Yearly maintenance expense | [optional] 
+**additional_rooms** | **String** | Additional room information | [optional] 
+**exterior_features** | **String** | Exterior Features for the listing  | [optional] 
+**water** | **String** | Water description and details | [optional] 
+**view** | **String** | View details and description | [optional] 
+**lot_size_area** | **Float** | 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**  | [optional] 
+**subdivision** | **String** | The subdivision or community name | [optional] 
+**construction** | **String** | The materials that were used in the construction of the property. | [optional] 
+**parking** | [**Parking**](Parking.md) |  | [optional] 
+**lot_size_area_units** | **String** | 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**  | [optional] 
+**type** | **String** | 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.  | [optional] 
+**garage_spaces** | **Float** | Number of garage spaces | [optional] 
+**accessibility** | **String** |  | [optional] 
+**occupant_type** | **String** |  | [optional] 
+**year_built** | **Integer** | Year the property was built | [optional] 
+
+

data/ruby-client/docs/Sales.md

@@ -0,0 +1,12 @@
+# SwaggerClient::Sales
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**close_date** | **DateTime** | RETS Sales data close date | [optional] 
+**office** | **String** | RETS Sales data selling office/brokerage id | [optional] 
+**close_price** | **Integer** | RETS Sales data sold price | [optional] 
+**agent** | **String** | RETS Sales data agent id | [optional] 
+**contract_date** | **DateTime** | RETS Sales data contract date | [optional] 
+
+

data/ruby-client/docs/School.md

@@ -0,0 +1,11 @@
+# SwaggerClient::School
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**middle_school** | **String** | Middle or junior school name | [optional] 
+**high_school** | **String** | High school name | [optional] 
+**elementary_school** | **String** | Elementary school name. | [optional] 
+**district** | **String** | School district name. | [optional] 
+
+

data/ruby-client/docs/StreetAddress.md

@@ -0,0 +1,16 @@
+# SwaggerClient::StreetAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cross_street** | **String** | Known cross street | [optional] 
+**state** | **String** | State or province. Maps to the data dictionary field `StateOrProvince`. | [optional] 
+**country** | **String** | Street address country (United States or Canada) | [optional] 
+**postal_code** | **String** | Street Address postal code | [optional] 
+**street_name** | **String** | Name of the street | [optional] 
+**street_number_text** | **String** | Textual representation of the street number. This field is usually redundant with what's in `streetNumber` but is occassionally usefuly for street number which are actually alpha-numerical. For example, \"N63453\" or \"34556B\".  **Added on 2016/05/02**  | [optional] 
+**city** | **String** | City name | [optional] 
+**street_number** | **Integer** | Street number | [optional] 
+**full** | **String** | Full pretty-printed address with suffix (if available) | [optional] 
+
+

data/ruby-client/docs/Tax.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Tax
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_year** | **Integer** | Tax Year | [optional] 
+**tax_annual_amount** | **String** | Annual tax amount in USD | [optional] 
+**id** | **String** | Tax Parcel ID for the listing | [optional] 
+
+

data/ruby-client/git_push.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# 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.
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/ruby-client/lib/swagger_client.rb

@@ -0,0 +1,66 @@
+=begin
+SimplyRETS API
+
+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
+
+# Common files
+require 'swagger_client/api_client'
+require 'swagger_client/api_error'
+require 'swagger_client/version'
+require 'swagger_client/configuration'
+
+# Models
+require 'swagger_client/models/agent'
+require 'swagger_client/models/broker'
+require 'swagger_client/models/contact_information'
+require 'swagger_client/models/error'
+require 'swagger_client/models/geographic_data'
+require 'swagger_client/models/listing'
+require 'swagger_client/models/mls_information'
+require 'swagger_client/models/office'
+require 'swagger_client/models/open_house'
+require 'swagger_client/models/parking'
+require 'swagger_client/models/property'
+require 'swagger_client/models/sales'
+require 'swagger_client/models/school'
+require 'swagger_client/models/street_address'
+require 'swagger_client/models/tax'
+
+# APIs
+require 'swagger_client/api/default_api'
+
+module SwaggerClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SwaggerClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/ruby-client/lib/swagger_client/api/default_api.rb

@@ -0,0 +1,383 @@
+=begin
+SimplyRETS API
+
+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
+
+require "uri"
+
+module SwaggerClient
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # The SimplyRETS OpenHouses API
+    # This is the main endpoint for accessing openhouses. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :type Request listings by a specific property type. This defaults to Residential, and you can only specify one type in a single query. 
+    # @option opts [String] :listing_id Request openhouses for a specific `listingId`. 
+    # @option opts [Array<String>] :cities Filter the openhouses returned by a list of valid cities. A list of valid cities can be found by making an OPTIONS request to the &#x60;/openhouses&#x60; endpoint. 
+    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID. You can specific multiple broker parameters. Note, the Broker ID is provided by your MLS. 
+    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the Agent ID is provided by your MLS. 
+    # @option opts [Integer] :minprice Filter listings by a minimum price. 
+    # @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 by the limit to go to the next \&quot;page\&quot; of listings. Also take a look at the Link HTTP Header for pre-built pagination. 
+    # @option opts [Integer] :limit Set the number of listings to return in the response. This defaults to 20 listings, and can be a maximum of 50. To paginate through to the next page of listings, take a look at the &#x60;offset&#x60; parameter, or the Link in the HTTP Header. 
+    # @option opts [String] :sort Sort the response by a specific field. Values starting with a minus (-) denote descending order, while the others are ascending. 
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response.  In the future, fields which require an &#39;include&#39; may become available by default. 
+    # @return [Array<OpenHouse>]
+    def openhouses_get(opts = {})
+      data, _status_code, _headers = openhouses_get_with_http_info(opts)
+      return data
+    end
+
+    # The SimplyRETS OpenHouses API
+    # This is the main endpoint for accessing openhouses. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :type Request listings by a specific property type. This defaults to Residential, and you can only specify one type in a single query. 
+    # @option opts [String] :listing_id Request openhouses for a specific &#x60;listingId&#x60;. 
+    # @option opts [Array<String>] :cities Filter the openhouses returned by a list of valid cities. A list of valid cities can be found by making an OPTIONS request to the &#x60;/openhouses&#x60; endpoint. 
+    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID. You can specific multiple broker parameters. Note, the Broker ID is provided by your MLS. 
+    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the Agent ID is provided by your MLS. 
+    # @option opts [Integer] :minprice Filter listings by a minimum price. 
+    # @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 by the limit to go to the next \&quot;page\&quot; of listings. Also take a look at the Link HTTP Header for pre-built pagination. 
+    # @option opts [Integer] :limit Set the number of listings to return in the response. This defaults to 20 listings, and can be a maximum of 50. To paginate through to the next page of listings, take a look at the &#x60;offset&#x60; parameter, or the Link in the HTTP Header. 
+    # @option opts [String] :sort Sort the response by a specific field. Values starting with a minus (-) denote descending order, while the others are ascending. 
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response.  In the future, fields which require an &#39;include&#39; may become available by default. 
+    # @return [Array<(Array<OpenHouse>, Fixnum, Hash)>] Array<OpenHouse> data, response status code and response headers
+    def openhouses_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.openhouses_get ..."
+      end
+      if opts[:'type'] && !['Residential', 'Rental', 'Multifamily', 'Condominium', 'Commercial', 'Land'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of Residential, Rental, Multifamily, Condominium, Commercial, Land'
+      end
+      if opts[:'sort'] && !['listprice', '-listprice', 'listdate', '-listdate', 'beds', '-beds', 'baths', '-baths'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of listprice, -listprice, listdate, -listdate, beds, -beds, baths, -baths'
+      end
+      # resource path
+      local_var_path = "/openhouses".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'type'] = opts[:'type'] if opts[:'type']
+      query_params[:'listingId'] = opts[:'listing_id'] if opts[:'listing_id']
+      query_params[:'cities'] = @api_client.build_collection_param(opts[:'cities'], :multi) if opts[:'cities']
+      query_params[:'brokers'] = @api_client.build_collection_param(opts[:'brokers'], :multi) if opts[:'brokers']
+      query_params[:'agent'] = opts[:'agent'] if opts[:'agent']
+      query_params[:'minprice'] = opts[:'minprice'] if opts[:'minprice']
+      query_params[:'startdate'] = opts[:'startdate'] if opts[:'startdate']
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if opts[:'include']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json', 'application/vnd.simplyrets-v0.1+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+            auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<OpenHouse>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#openhouses_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Single OpenHouse Endpoint
+    # Use this endpoint for accessing a single OpenHouse. 
+    # @param open_house_key A unique OpenHouse identification key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response.  In the future, fields which require an &#39;include&#39; may become available by default. 
+    # @return [OpenHouse]
+    def openhouses_open_house_key_get(open_house_key, opts = {})
+      data, _status_code, _headers = openhouses_open_house_key_get_with_http_info(open_house_key, opts)
+      return data
+    end
+
+    # Single OpenHouse Endpoint
+    # Use this endpoint for accessing a single OpenHouse. 
+    # @param open_house_key A unique OpenHouse identification key
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response.  In the future, fields which require an &#39;include&#39; may become available by default. 
+    # @return [Array<(OpenHouse, Fixnum, Hash)>] OpenHouse data, response status code and response headers
+    def openhouses_open_house_key_get_with_http_info(open_house_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.openhouses_open_house_key_get ..."
+      end
+      # verify the required parameter 'open_house_key' is set
+      fail ArgumentError, "Missing the required parameter 'open_house_key' when calling DefaultApi.openhouses_open_house_key_get" if open_house_key.nil?
+      # resource path
+      local_var_path = "/openhouses/{openHouseKey}".sub('{format}','json').sub('{' + 'openHouseKey' + '}', open_house_key.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if opts[:'include']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json', 'application/vnd.simplyrets-v0.1+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+            auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OpenHouse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#openhouses_open_house_key_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # The SimplyRETS Listings API
+    # This is the main endpoint for accessing your properties. View all of the available query parameters and make requests below! The API uses Basic Authentication, which most HTTP libraries will handle for you. To use the test data (which is what this pages uses), you can use the api key `simplyrets` and secret `simplyrets`. Note that these test listings are not live MLS listings but the data, query parameters, and response bodies will all work the same. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q A textual keyword search. This parameter will search  the following fields, when available:   - listingId (This does _not_ search the &#x60;mlsId&#x60; field in the SimplyRETS response body)   - street number   - street name   - mls area (major)   - city   - subdivision name   - postal code 
+    # @option opts [Array<String>] :status Request listings by a specific status. This parameter defaults to active and you can specify multiple statuses in a single query.  Listing statuses depend on your MLS&#39;s availability. Below is a brief description of each status with possible synonyms which may map to your MLS-specific statuses - *Active*: Active Listing which is still on the market - *ActiveUnderContract*: An offer has been accepted but the listing is still on market. Synonyms: Accepting Backup Offers, Backup Offer, Active With Accepted. Synonyms: Offer, Backup, Contingent - *Pending*: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract - *Hold*: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - *Withdrawn*: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - *Closed*: The purchase agreement has been fulfilled or the lease   agreement has been executed. Synonyms: Sold, Leased, Rented, Closed Sale - *Expired*: The listing contract has expired - *Delete*: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap - *Incomplete*: The listing has not yet be completely entered and is not yet   published in the MLS. Synonyms: Draft, Partially Complted - *ComingSoon* 
+    # @option opts [Array<String>] :type Request listings by a specific property type. This defaults to Residential and Rental. You can specify multiple property types in a single query. 
+    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the Agent ID is provided by your MLS.  The co-listing agent is not included in this query parameter. 
+    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID. For some MLS areas, this is the ListOfficeId (Listing Office ID).  You can specific multiple broker parameters. Note, this query parameter is only available if a Broker ID is provided by your MLS. 
+    # @option opts [Integer] :minprice Filter listings by a minimum price. 
+    # @option opts [Integer] :maxprice Filter listings by a maximum price 
+    # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft. 
+    # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft. 
+    # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms. 
+    # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms. 
+    # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms. 
+    # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms. 
+    # @option opts [Integer] :maxdom Filter listings by a maximum number of days on market. _Note that your MLS must provide Days on Market data._ 
+    # @option opts [Integer] :minyear Filter listings by a setting a minimum year built. 
+    # @option opts [Integer] :limit Set the number of listings to return in the response. This defaults to 20 listings, and can be a maximum of 50. To paginate through to the next page of listings, take a look at the &#x60;offset&#x60; parameter, or the Link in the HTTP Header. 
+    # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter by the limit to go to the next \&quot;page\&quot; of listings. Also take a look at the Link HTTP Header for pre-built pagination.  *NOTE:* If you&#39;re offset is too high, you will receive an &#x60;HTTP 400 offset too high&#x60; error message. 
+    # @option opts [String] :vendor Used to specify the vendor (MLS) to search from. This parameter is required on multi-MLS apps, and you can only query one vendor at a time. To get your vendor id&#39;s make an OPTIONS request to https://api.simplyrets.com. 
+    # @option opts [Array<String>] :postal_codes Filter the listings returned by postal codes / zip code. You can specify multiple. 
+    # @option opts [Array<String>] :features Filter the listings by specific interior features.  You can filter by multiple. For example, to filter trial listings by multiple features you can use, Return listings that are within a set of latitude longitude coordinates. For example,  &#x60;&#x60;&#x60; Wet Bar High Ceiling &#x60;&#x60;&#x60;  e.g. &#x60;https://simplyrets.com/services?features&#x3D;Wet%20Bar&amp;features&#x3D;High%20Ceiling&#x60;  The features provided by your MLS can be seen in your OPTIONS request. To view all valid features, make a request to the SimplyRETS api root  &#x60;curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/&#x60; 
+    # @option opts [String] :water Query water/waterfront listings only. Specify &#x60;true&#x60; to filter waterfront listings. 
+    # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and subdivisions. You can specify multiple. 
+    # @option opts [Array<String>] :cities Filter the listings returned by specific cities. You can specify multiple. 
+    # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can specify multiple. 
+    # @option opts [Array<String>] :points Return listings that are within a set of latitude longitude coordinates. For example; &#x60;&#x60;&#x60; 29.723837,-95.69778 29.938275,-95.69778 29.938275,-95.32974 29.723837,-95.32974 &#x60;&#x60;&#x60; Note that some MLS&#39;s do not provide latitude and longitude for their listings, which is required for this parameter to work. In these cases, SimplyRETS offers a [Geocoding Addon](https://simplyrets.com/services#geocoding).  Check out our [blog post](https://simplyrets.com/blog/interactive-map-search.html) on using the &#x60;points&#x60; parameter to build a map-based app in javascript. 
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response. 
+    # @option opts [String] :sort Sort the response by a specific field. Values starting with a minus (-) denote descending order, while the others are ascending. 
+    # @return [Array<Listing>]
+    def properties_get(opts = {})
+      data, _status_code, _headers = properties_get_with_http_info(opts)
+      return data
+    end
+
+    # The SimplyRETS Listings API
+    # This is the main endpoint for accessing your properties. View all of the available query parameters and make requests below! The API uses Basic Authentication, which most HTTP libraries will handle for you. To use the test data (which is what this pages uses), you can use the api key &#x60;simplyrets&#x60; and secret &#x60;simplyrets&#x60;. Note that these test listings are not live MLS listings but the data, query parameters, and response bodies will all work the same. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :q A textual keyword search. This parameter will search  the following fields, when available:   - listingId (This does _not_ search the &#x60;mlsId&#x60; field in the SimplyRETS response body)   - street number   - street name   - mls area (major)   - city   - subdivision name   - postal code 
+    # @option opts [Array<String>] :status Request listings by a specific status. This parameter defaults to active and you can specify multiple statuses in a single query.  Listing statuses depend on your MLS&#39;s availability. Below is a brief description of each status with possible synonyms which may map to your MLS-specific statuses - *Active*: Active Listing which is still on the market - *ActiveUnderContract*: An offer has been accepted but the listing is still on market. Synonyms: Accepting Backup Offers, Backup Offer, Active With Accepted. Synonyms: Offer, Backup, Contingent - *Pending*: An offer has been accepted and the listing is no longer on market. Synonyms: Offer Accepted, Under Contract - *Hold*: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - *Withdrawn*: The listing has been withdrawn from the market, but a contract   still exists between the seller and the listing member. Synonyms: Hold, Hold Do Not Show, Temp Off Market - *Closed*: The purchase agreement has been fulfilled or the lease   agreement has been executed. Synonyms: Sold, Leased, Rented, Closed Sale - *Expired*: The listing contract has expired - *Delete*: The listing contract was never valid or other reason for the contract to be nullified. Synonyms: Kill, Zap - *Incomplete*: The listing has not yet be completely entered and is not yet   published in the MLS. Synonyms: Draft, Partially Complted - *ComingSoon* 
+    # @option opts [Array<String>] :type Request listings by a specific property type. This defaults to Residential and Rental. You can specify multiple property types in a single query. 
+    # @option opts [String] :agent Filter the listings returned by an agent ID.  Note, the Agent ID is provided by your MLS.  The co-listing agent is not included in this query parameter. 
+    # @option opts [Array<String>] :brokers Filter the listings returned by brokerage with a Broker ID. For some MLS areas, this is the ListOfficeId (Listing Office ID).  You can specific multiple broker parameters. Note, this query parameter is only available if a Broker ID is provided by your MLS. 
+    # @option opts [Integer] :minprice Filter listings by a minimum price. 
+    # @option opts [Integer] :maxprice Filter listings by a maximum price 
+    # @option opts [Integer] :minarea Filter listings by a minimum area size in Sq Ft. 
+    # @option opts [Integer] :maxarea Filter listings by a maximum area size in Sq Ft. 
+    # @option opts [Integer] :minbaths Filter listings by a minimum number of bathrooms. 
+    # @option opts [Integer] :maxbaths Filter listings by a maximum number of bathrooms. 
+    # @option opts [Integer] :minbeds Filter listings by a minimum number of bedrooms. 
+    # @option opts [Integer] :maxbeds Filter listings by a maximum number of bedrooms. 
+    # @option opts [Integer] :maxdom Filter listings by a maximum number of days on market. _Note that your MLS must provide Days on Market data._ 
+    # @option opts [Integer] :minyear Filter listings by a setting a minimum year built. 
+    # @option opts [Integer] :limit Set the number of listings to return in the response. This defaults to 20 listings, and can be a maximum of 50. To paginate through to the next page of listings, take a look at the &#x60;offset&#x60; parameter, or the Link in the HTTP Header. 
+    # @option opts [Integer] :offset Used as a cursor for pagination. Increase the offset parameter by the limit to go to the next \&quot;page\&quot; of listings. Also take a look at the Link HTTP Header for pre-built pagination.  *NOTE:* If you&#39;re offset is too high, you will receive an &#x60;HTTP 400 offset too high&#x60; error message. 
+    # @option opts [String] :vendor Used to specify the vendor (MLS) to search from. This parameter is required on multi-MLS apps, and you can only query one vendor at a time. To get your vendor id&#39;s make an OPTIONS request to https://api.simplyrets.com. 
+    # @option opts [Array<String>] :postal_codes Filter the listings returned by postal codes / zip code. You can specify multiple. 
+    # @option opts [Array<String>] :features Filter the listings by specific interior features.  You can filter by multiple. For example, to filter trial listings by multiple features you can use, Return listings that are within a set of latitude longitude coordinates. For example,  &#x60;&#x60;&#x60; Wet Bar High Ceiling &#x60;&#x60;&#x60;  e.g. &#x60;https://simplyrets.com/services?features&#x3D;Wet%20Bar&amp;features&#x3D;High%20Ceiling&#x60;  The features provided by your MLS can be seen in your OPTIONS request. To view all valid features, make a request to the SimplyRETS api root  &#x60;curl -XOPTIONS -u simplyrets:simplyrets https://api.simplyrets.com/&#x60; 
+    # @option opts [String] :water Query water/waterfront listings only. Specify &#x60;true&#x60; to filter waterfront listings. 
+    # @option opts [Array<String>] :neighborhoods Filter the listings returned by specific neighborhoods and subdivisions. You can specify multiple. 
+    # @option opts [Array<String>] :cities Filter the listings returned by specific cities. You can specify multiple. 
+    # @option opts [Array<String>] :counties Filter the listings returned by specific counties. You can specify multiple. 
+    # @option opts [Array<String>] :points Return listings that are within a set of latitude longitude coordinates. For example; &#x60;&#x60;&#x60; 29.723837,-95.69778 29.938275,-95.69778 29.938275,-95.32974 29.723837,-95.32974 &#x60;&#x60;&#x60; Note that some MLS&#39;s do not provide latitude and longitude for their listings, which is required for this parameter to work. In these cases, SimplyRETS offers a [Geocoding Addon](https://simplyrets.com/services#geocoding).  Check out our [blog post](https://simplyrets.com/blog/interactive-map-search.html) on using the &#x60;points&#x60; parameter to build a map-based app in javascript. 
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;taxAnnualAmount&#39; include the annual tax amount - &#39;taxYear&#39; include the tax year data - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available in the API response. 
+    # @option opts [String] :sort Sort the response by a specific field. Values starting with a minus (-) denote descending order, while the others are ascending. 
+    # @return [Array<(Array<Listing>, Fixnum, Hash)>] Array<Listing> data, response status code and response headers
+    def properties_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.properties_get ..."
+      end
+      if opts[:'sort'] && !['listprice', '-listprice', 'listdate', '-listdate', 'beds', '-beds', 'baths', '-baths'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of listprice, -listprice, listdate, -listdate, beds, -beds, baths, -baths'
+      end
+      # resource path
+      local_var_path = "/properties".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'q'] = opts[:'q'] if opts[:'q']
+      query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :multi) if opts[:'status']
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if opts[:'type']
+      query_params[:'agent'] = opts[:'agent'] if opts[:'agent']
+      query_params[:'brokers'] = @api_client.build_collection_param(opts[:'brokers'], :multi) if opts[:'brokers']
+      query_params[:'minprice'] = opts[:'minprice'] if opts[:'minprice']
+      query_params[:'maxprice'] = opts[:'maxprice'] if opts[:'maxprice']
+      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[:'maxdom'] = opts[:'maxdom'] if opts[:'maxdom']
+      query_params[:'minyear'] = opts[:'minyear'] if opts[:'minyear']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'vendor'] = opts[:'vendor'] if opts[:'vendor']
+      query_params[:'postalCodes'] = @api_client.build_collection_param(opts[:'postal_codes'], :multi) if opts[:'postal_codes']
+      query_params[:'features'] = @api_client.build_collection_param(opts[:'features'], :multi) if opts[:'features']
+      query_params[:'water'] = opts[:'water'] if opts[:'water']
+      query_params[:'neighborhoods'] = @api_client.build_collection_param(opts[:'neighborhoods'], :multi) if opts[:'neighborhoods']
+      query_params[:'cities'] = @api_client.build_collection_param(opts[:'cities'], :multi) if opts[:'cities']
+      query_params[:'counties'] = @api_client.build_collection_param(opts[:'counties'], :multi) if opts[:'counties']
+      query_params[:'points'] = @api_client.build_collection_param(opts[:'points'], :multi) if opts[:'points']
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if opts[:'include']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json', 'application/vnd.simplyrets-v0.1+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+            auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Listing>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#properties_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Single Listing Endpoint
+    # Use this endpoint for accessing a single listing. When you make a search to the `/properties` endpoint, each listing in the response will contain a unique `mlsId` field which should be used to request that listing on this route.  The `mlsId` field is a unique identifier for a listing which is specific to the SimplyRETS API only.  It is different from the `listingId` field is the public number given to a listing by the MLS and is not used here. 
+    # @param mls_id The &#x60;mlsId&#x60; field is a unique identifier which is specific to the SimplyRETS API only.  This field is different from the &#x60;listingId&#x60; field (which is the public number given to a listing by the MLS and is not used here). 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available with valid data in the API response. If your MLS does not offer these fields, they will contain &#39;null&#39;. 
+    # @return [Listing]
+    def properties_mls_id_get(mls_id, opts = {})
+      data, _status_code, _headers = properties_mls_id_get_with_http_info(mls_id, opts)
+      return data
+    end
+
+    # Single Listing Endpoint
+    # Use this endpoint for accessing a single listing. When you make a search to the &#x60;/properties&#x60; endpoint, each listing in the response will contain a unique &#x60;mlsId&#x60; field which should be used to request that listing on this route.  The &#x60;mlsId&#x60; field is a unique identifier for a listing which is specific to the SimplyRETS API only.  It is different from the &#x60;listingId&#x60; field is the public number given to a listing by the MLS and is not used here. 
+    # @param mls_id The &#x60;mlsId&#x60; field is a unique identifier which is specific to the SimplyRETS API only.  This field is different from the &#x60;listingId&#x60; field (which is the public number given to a listing by the MLS and is not used here). 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :include Include a extra fields which are not in the default response body - &#39;association&#39; includes additional HOA data - &#39;agreement&#39; information on the listing agreement - &#39;garageSpaces&#39; additional garage data - &#39;maintenanceExpense&#39; data on maintenance expenses - &#39;parking&#39; additional parking data - &#39;pool&#39; includes an additional pool description - &#39;rooms&#39; include parameter will include    any additional rooms as a list.  Note that your MLS must provide these fields in their RETS data for them to be available with valid data in the API response. If your MLS does not offer these fields, they will contain &#39;null&#39;. 
+    # @return [Array<(Listing, Fixnum, Hash)>] Listing data, response status code and response headers
+    def properties_mls_id_get_with_http_info(mls_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DefaultApi.properties_mls_id_get ..."
+      end
+      # verify the required parameter 'mls_id' is set
+      fail ArgumentError, "Missing the required parameter 'mls_id' when calling DefaultApi.properties_mls_id_get" if mls_id.nil?
+      # resource path
+      local_var_path = "/properties/{mlsId}".sub('{format}','json').sub('{' + 'mlsId' + '}', mls_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if opts[:'include']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json', 'application/vnd.simplyrets-v0.1+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+            auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Listing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#properties_mls_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end