marketcheck_ruby_client 1.0.7

data/lib/swagger_client/api/listings_api.rb

@@ -0,0 +1,474 @@
+=begin
+Marketcheck Cars API
+
+<b>Access the New, Used and Certified cars inventories for all Car Dealers in US.</b> <br/>The data is sourced from online listings by over 40,000 Car dealers in US. At any time, there are about 5.2M searchable listings (about 1.8M unique VINs) for Used & Certified cars and about 5M (about 2.3M unique VINs) New Car listings from all over US. We use this API at the back for our website <a href='http://www.marketcheck.com' target='_blank'>www.marketcheck.com</a> and our Android and iOS mobile apps too.<br/><h5> Few useful links : </h5><ul><li>A quick view of the API and the use cases is depicated <a href='https://portals.marketcheck.com/mcapi/' target='_blank'>here</a></li><li>The Postman collection with various usages of the API is shared here https://www.getpostman.com/collections/2752684ff636cdd7bac2</li><li> [Coming soon] API Key : Request your API Key <a href='https://portals.marketcheck.com/api' target='_blank'> here </a> </li><li> [Coming soon] Benchmarks : See the API benchmarks <a href='https://portals.marketcheck.com/mcapi/benchmarks'>here</a></li></ul>
+
+OpenAPI spec version: 1.0.3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require "uri"
+
+module SwaggerClient
+  class ListingsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Listing by id
+    # Get a particular listing by its id
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [Listing]
+    def get_listing(api_key, id, opts = {})
+      data, status_code, headers = get_listing_with_http_info(api_key, id, opts)
+      return data
+    end
+
+    # Listing by id
+    # Get a particular listing by its id
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Listing, Fixnum, Hash)>] Listing data, response status code and response headers
+    def get_listing_with_http_info(api_key, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ListingsApi#get_listing ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_listing" if api_key.nil?
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_listing" if id.nil?
+      
+      # resource path
+      local_var_path = "/listing/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      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: ListingsApi#get_listing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Long text Listings attributes for Listing with the given id
+    # Get listing options, features, seller comments
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the long text listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [ListingExtraAttributes]
+    def get_listing_extra(api_key, id, opts = {})
+      data, status_code, headers = get_listing_extra_with_http_info(api_key, id, opts)
+      return data
+    end
+
+    # Long text Listings attributes for Listing with the given id
+    # Get listing options, features, seller comments
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the long text listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListingExtraAttributes, Fixnum, Hash)>] ListingExtraAttributes data, response status code and response headers
+    def get_listing_extra_with_http_info(api_key, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ListingsApi#get_listing_extra ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_listing_extra" if api_key.nil?
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_listing_extra" if id.nil?
+      
+      # resource path
+      local_var_path = "/listing/{id}/extra".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      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 => 'ListingExtraAttributes')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ListingsApi#get_listing_extra\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Listing media by id
+    # Get listing media (photo, photos) by id
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [ListingMedia]
+    def get_listing_media(api_key, id, opts = {})
+      data, status_code, headers = get_listing_media_with_http_info(api_key, id, opts)
+      return data
+    end
+
+    # Listing media by id
+    # Get listing media (photo, photos) by id
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get all the listing attributes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListingMedia, Fixnum, Hash)>] ListingMedia data, response status code and response headers
+    def get_listing_media_with_http_info(api_key, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ListingsApi#get_listing_media ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_listing_media" if api_key.nil?
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_listing_media" if id.nil?
+      
+      # resource path
+      local_var_path = "/listing/{id}/media".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      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 => 'ListingMedia')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ListingsApi#get_listing_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get listing HTML
+    # Cached HTML of the Vehicle Details Page (VDP) for the listing. The HTML is cached only for 7 days for all listings. So this API could be used to get HTML of mostly active listings and that have recently expired
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get the vehicle details page (VDP) HTML
+    # @param [Hash] opts the optional parameters
+    # @return [ListingVDP]
+    def get_listing_vdp(api_key, id, opts = {})
+      data, status_code, headers = get_listing_vdp_with_http_info(api_key, id, opts)
+      return data
+    end
+
+    # Get listing HTML
+    # Cached HTML of the Vehicle Details Page (VDP) for the listing. The HTML is cached only for 7 days for all listings. So this API could be used to get HTML of mostly active listings and that have recently expired
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param id Listing id to get the vehicle details page (VDP) HTML
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListingVDP, Fixnum, Hash)>] ListingVDP data, response status code and response headers
+    def get_listing_vdp_with_http_info(api_key, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ListingsApi#get_listing_vdp ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_listing_vdp" if api_key.nil?
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_listing_vdp" if id.nil?
+      
+      # resource path
+      local_var_path = "/listing/{id}/vdp".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      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 => 'ListingVDP')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ListingsApi#get_listing_vdp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets active car listings for the given search criteria
+    # This endpoint is the meat of the API and serves many purposes. This API produces a list of currently active cars from the market for the given search criteria. The API results are limited to allow pagination upto 1000 rows. \n The search API facilitates the following use cases - \n1. Search Cars around a given geo-point within a given radius \n2. Search cars for a specific year / make / model or combination of these \n3. Search cars matching multiple year, make, model combinatins in the same search request\n4. Filter results by most car specification attributes\n5. Search for similar cars by VIN or Taxonomy VIN \n6. Filter cars within a given price / miles / days on market (dom) range\n7. Specify a sort order for the results on price / miles / dom / listed date \n8. Search cars for a given City / State combination \n9. Get Facets to build the search drill downs \n10. Get Market averages for price/miles/dom/msrp for your search
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param latitude Latitude component of location
+    # @param longitude Longitude component of location
+    # @param radius Radius around the search location
+    # @param car_type Car type. Allowed values are - new / used / certified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :year Car year - 1980 onwards. You can pass in multiple year separated by comma e.g. 2010,2011
+    # @option opts [String] :make Car Make - should be a standard OEM Make name
+    # @option opts [String] :model Car model to search
+    # @option opts [String] :trim Car trim to search
+    # @option opts [String] :dealer_id Dealer id to filter the cars
+    # @option opts [String] :body_type Body type to filter the cars on
+    # @option opts [String] :body_subtype Body subtype to filter the cars on
+    # @option opts [String] :vehicle_type Vehicle type to filter the cars on
+    # @option opts [String] :vins Comma separated list of 17 digit vins to search the matching cars for. Only 10 VINs allowed per request. If the request contains more than 10 VINs the first 10 VINs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VINs. Ths vins parameter is an alternative to taxonomy_vins or ymmt parameters available with the search API. vins and taxonomy_vins parameters could be used to filter our cars with the exact build represented by the vins or taxonomy_vins whereas ymmt is a top level filter that does not filter cars by the build attributes like doors, drivetrain, cylinders, body type, body subtype, vehicle type etc
+    # @option opts [String] :taxonomy_vins Comma separated list of 10 letters excert from the 17 letter VIN. The 10 letters to be picked up from the 17 letter VIN are - first 8 letters and the 10th and 11th letter. E.g. For a VIN - 1FTFW1EF3EKE57182 the taxonomy vin would be - 1FTFW1EFEK  A taxonomy VIN identified a build of a car and could be used to filter our cars of a particular build. This is an alternative to the vin or ymmt parameters to the search API.
+    # @option opts [String] :ymmt Comma separated list of Year, Make, Model, Trim combinations. Each combination needs to have the year,make,model, trim values separated by a pipe &#39;|&#39; character in the form year|make|model|trim. e.g. 2010|Audi|A5,2014|Nissan|Sentra|S 6MT,|Honda|City|   You could just provide strings of the form - &#39;year|make||&#39; or &#39;year|make|model&#39; or &#39;|make|model|&#39; combinations. Individual year / make / model filters provied with the API calls will take precedence over the Year, Make, Model, Trim combinations. The Make, Model, Trim values must be valid values as per the Marketcheck Vin Decoder. If you are using a separate vin decoder then look at using the &#39;vins&#39; or &#39;taxonomy_vins&#39; parameter to the search api instead the year|make|model|trim combinations.
+    # @option opts [String] :cylinders Cylinders to filter the cars on
+    # @option opts [String] :transmission Transmission to filter the cars on. [a = Automatic, m = Manual]
+    # @option opts [String] :drivetrain Drivetrain to filter the cars on.
+    # @option opts [String] :exterior_color Exterior color to match
+    # @option opts [String] :interior_color Interior color to match
+    # @option opts [String] :miles_range Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
+    # @option opts [String] :price_range Price range to filter cars with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000
+    # @option opts [String] :dom_range Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50
+    # @option opts [String] :sort_by Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point
+    # @option opts [String] :sort_order Sort order - asc or desc. Default sort order is distance from a point.
+    # @option opts [String] :rows Number of results to return. Default is 10. Max is 50
+    # @option opts [String] :start Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows
+    # @option opts [String] :facets The comma separated list of fields for which facets are requested. Supported fields are - year, make, model, trim, vehicle_type, car_type, body_type, body_subtype, drivetrain, cylinders, transmission, exterior_color, interior_color. Facets could be requested in addition to the listings for the search. Please note - The API calls with lots of facet fields may take longer to respond.
+    # @option opts [String] :stats The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.
+    # @return [SearchResponse]
+    def search(api_key, latitude, longitude, radius, car_type, opts = {})
+      data, status_code, headers = search_with_http_info(api_key, latitude, longitude, radius, car_type, opts)
+      return data
+    end
+
+    # Gets active car listings for the given search criteria
+    # This endpoint is the meat of the API and serves many purposes. This API produces a list of currently active cars from the market for the given search criteria. The API results are limited to allow pagination upto 1000 rows. \n The search API facilitates the following use cases - \n1. Search Cars around a given geo-point within a given radius \n2. Search cars for a specific year / make / model or combination of these \n3. Search cars matching multiple year, make, model combinatins in the same search request\n4. Filter results by most car specification attributes\n5. Search for similar cars by VIN or Taxonomy VIN \n6. Filter cars within a given price / miles / days on market (dom) range\n7. Specify a sort order for the results on price / miles / dom / listed date \n8. Search cars for a given City / State combination \n9. Get Facets to build the search drill downs \n10. Get Market averages for price/miles/dom/msrp for your search
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param latitude Latitude component of location
+    # @param longitude Longitude component of location
+    # @param radius Radius around the search location
+    # @param car_type Car type. Allowed values are - new / used / certified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :year Car year - 1980 onwards. You can pass in multiple year separated by comma e.g. 2010,2011
+    # @option opts [String] :make Car Make - should be a standard OEM Make name
+    # @option opts [String] :model Car model to search
+    # @option opts [String] :trim Car trim to search
+    # @option opts [String] :dealer_id Dealer id to filter the cars
+    # @option opts [String] :body_type Body type to filter the cars on
+    # @option opts [String] :body_subtype Body subtype to filter the cars on
+    # @option opts [String] :vehicle_type Vehicle type to filter the cars on
+    # @option opts [String] :vins Comma separated list of 17 digit vins to search the matching cars for. Only 10 VINs allowed per request. If the request contains more than 10 VINs the first 10 VINs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VINs. Ths vins parameter is an alternative to taxonomy_vins or ymmt parameters available with the search API. vins and taxonomy_vins parameters could be used to filter our cars with the exact build represented by the vins or taxonomy_vins whereas ymmt is a top level filter that does not filter cars by the build attributes like doors, drivetrain, cylinders, body type, body subtype, vehicle type etc
+    # @option opts [String] :taxonomy_vins Comma separated list of 10 letters excert from the 17 letter VIN. The 10 letters to be picked up from the 17 letter VIN are - first 8 letters and the 10th and 11th letter. E.g. For a VIN - 1FTFW1EF3EKE57182 the taxonomy vin would be - 1FTFW1EFEK  A taxonomy VIN identified a build of a car and could be used to filter our cars of a particular build. This is an alternative to the vin or ymmt parameters to the search API.
+    # @option opts [String] :ymmt Comma separated list of Year, Make, Model, Trim combinations. Each combination needs to have the year,make,model, trim values separated by a pipe &#39;|&#39; character in the form year|make|model|trim. e.g. 2010|Audi|A5,2014|Nissan|Sentra|S 6MT,|Honda|City|   You could just provide strings of the form - &#39;year|make||&#39; or &#39;year|make|model&#39; or &#39;|make|model|&#39; combinations. Individual year / make / model filters provied with the API calls will take precedence over the Year, Make, Model, Trim combinations. The Make, Model, Trim values must be valid values as per the Marketcheck Vin Decoder. If you are using a separate vin decoder then look at using the &#39;vins&#39; or &#39;taxonomy_vins&#39; parameter to the search api instead the year|make|model|trim combinations.
+    # @option opts [String] :cylinders Cylinders to filter the cars on
+    # @option opts [String] :transmission Transmission to filter the cars on. [a = Automatic, m = Manual]
+    # @option opts [String] :drivetrain Drivetrain to filter the cars on.
+    # @option opts [String] :exterior_color Exterior color to match
+    # @option opts [String] :interior_color Interior color to match
+    # @option opts [String] :miles_range Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
+    # @option opts [String] :price_range Price range to filter cars with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000
+    # @option opts [String] :dom_range Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50
+    # @option opts [String] :sort_by Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point
+    # @option opts [String] :sort_order Sort order - asc or desc. Default sort order is distance from a point.
+    # @option opts [String] :rows Number of results to return. Default is 10. Max is 50
+    # @option opts [String] :start Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows
+    # @option opts [String] :facets The comma separated list of fields for which facets are requested. Supported fields are - year, make, model, trim, vehicle_type, car_type, body_type, body_subtype, drivetrain, cylinders, transmission, exterior_color, interior_color. Facets could be requested in addition to the listings for the search. Please note - The API calls with lots of facet fields may take longer to respond.
+    # @option opts [String] :stats The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.
+    # @return [Array<(SearchResponse, Fixnum, Hash)>] SearchResponse data, response status code and response headers
+    def search_with_http_info(api_key, latitude, longitude, radius, car_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ListingsApi#search ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling search" if api_key.nil?
+      
+      # verify the required parameter 'latitude' is set
+      fail "Missing the required parameter 'latitude' when calling search" if latitude.nil?
+      
+      # verify the required parameter 'longitude' is set
+      fail "Missing the required parameter 'longitude' when calling search" if longitude.nil?
+      
+      # verify the required parameter 'radius' is set
+      fail "Missing the required parameter 'radius' when calling search" if radius.nil?
+      
+      # verify the required parameter 'car_type' is set
+      fail "Missing the required parameter 'car_type' when calling search" if car_type.nil?
+      unless ['new', 'used', 'certified'].include?(car_type)
+        fail "invalid value for 'car_type', must be one of new, used, certified"
+      end
+      
+      if opts[:'body_type'] && !['suv', 'sedan', 'pickup', 'minivan', 'coupe', 'hatchback', 'convertible', 'wagon', 'crossover', 'chassis', 'liftback'].include?(opts[:'body_type'])
+        fail 'invalid value for "body_type", must be one of suv, sedan, pickup, minivan, coupe, hatchback, convertible, wagon, crossover, chassis, liftback'
+      end
+      
+      if opts[:'body_subtype'] && !['crew cab', 'quad cab', 'extended cab', 'double cab', 'regular cab', 'super cab', 'mega cab', 'king cab', 'supercab'].include?(opts[:'body_subtype'])
+        fail 'invalid value for "body_subtype", must be one of crew cab, quad cab, extended cab, double cab, regular cab, super cab, mega cab, king cab', 'supercab'
+      end
+      
+      if opts[:'vehicle_type'] && !['suv', 'truck', 'car', 'van'].include?(opts[:'vehicle_type'])
+        fail 'invalid value for "vehicle_type", must be one of suv, truck, car, van'
+      end
+      
+      if opts[:'cylinders'] && !['0', '3', '4', '5', '6', '8', '10', '12', '16'].include?(opts[:'cylinders'])
+        fail 'invalid value for "cylinders", must be one of 0, 3, 4, 5, 6, 8, 10, 12, 16'
+      end
+      
+      if opts[:'transmission'] && !['a', 'm'].include?(opts[:'transmission'])
+        fail 'invalid value for "transmission", must be one of a, m'
+      end
+      
+      if opts[:'drivetrain'] && !['4wd', '2wd', 'awd', 'fwd', 'rwd', '4x2', '4x4'].include?(opts[:'drivetrain'])
+        fail 'invalid value for "drivetrain", must be one of 4wd, 2wd, awd, fwd, rwd, 4x2, 4x4'
+      end
+      
+      # resource path
+      local_var_path = "/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+      query_params[:'latitude'] = latitude
+      query_params[:'longitude'] = longitude
+      query_params[:'radius'] = radius
+      query_params[:'car_type'] = car_type
+      query_params[:'year'] = opts[:'year'] if opts[:'year']
+      query_params[:'make'] = opts[:'make'] if opts[:'make']
+      query_params[:'model'] = opts[:'model'] if opts[:'model']
+      query_params[:'trim'] = opts[:'trim'] if opts[:'trim']
+      query_params[:'dealer_id'] = opts[:'dealer_id'] if opts[:'dealer_id']
+      query_params[:'body_type'] = opts[:'body_type'] if opts[:'body_type']
+      query_params[:'body_subtype'] = opts[:'body_subtype'] if opts[:'body_subtype']
+      query_params[:'vehicle_type'] = opts[:'vehicle_type'] if opts[:'vehicle_type']
+      query_params[:'vins'] = opts[:'vins'] if opts[:'vins']
+      query_params[:'taxonomy_vins'] = opts[:'taxonomy_vins'] if opts[:'taxonomy_vins']
+      query_params[:'ymmt'] = opts[:'ymmt'] if opts[:'ymmt']
+      query_params[:'cylinders'] = opts[:'cylinders'] if opts[:'cylinders']
+      query_params[:'transmission'] = opts[:'transmission'] if opts[:'transmission']
+      query_params[:'drivetrain'] = opts[:'drivetrain'] if opts[:'drivetrain']
+      query_params[:'exterior_color'] = opts[:'exterior_color'] if opts[:'exterior_color']
+      query_params[:'interior_color'] = opts[:'interior_color'] if opts[:'interior_color']
+      query_params[:'miles_range'] = opts[:'miles_range'] if opts[:'miles_range']
+      query_params[:'price_range'] = opts[:'price_range'] if opts[:'price_range']
+      query_params[:'dom_range'] = opts[:'dom_range'] if opts[:'dom_range']
+      query_params[:'sort_by'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sort_order'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'rows'] = opts[:'rows'] if opts[:'rows']
+      query_params[:'start'] = opts[:'start'] if opts[:'start']
+      query_params[:'facets'] = opts[:'facets'] if opts[:'facets']
+      query_params[:'stats'] = opts[:'stats'] if opts[:'stats']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      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 => 'SearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ListingsApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end