marketcheck_ruby_client 1.0.7

data/lib/swagger_client/api/facets_api.rb

@@ -0,0 +1,105 @@
+=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 FacetsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Facets
+    # [Merged with the /search API - Please check the 'facets' parameter to the Search API above] Get the facets for the given simple filter criteria (by given VIN's basic specification, Or by Year, Make, Model, Trim criteria) and facet fields
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param fields Comma separated list of fields to generate facets for. Supported fields are - year, make, model, trim, exterior_color, interior_color, drivetrain, vehicle_type, car_type, body_style, body_subtype, doors
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :vin VIN as a reference to the type of car for which facets data is to be returned
+    # @option opts [String] :year Year of the car
+    # @option opts [String] :make Make of the car
+    # @option opts [String] :model Model of the Car
+    # @option opts [String] :trim Trim of the Car
+    # @return [Array<FacetItem>]
+    def get_facets(api_key, fields, opts = {})
+      data, status_code, headers = get_facets_with_http_info(api_key, fields, opts)
+      return data
+    end
+
+    # Facets
+    # [Merged with the /search API - Please check the &#39;facets&#39; parameter to the Search API above] Get the facets for the given simple filter criteria (by given VIN&#39;s basic specification, Or by Year, Make, Model, Trim criteria) and facet fields
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param fields Comma separated list of fields to generate facets for. Supported fields are - year, make, model, trim, exterior_color, interior_color, drivetrain, vehicle_type, car_type, body_style, body_subtype, doors
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :vin VIN as a reference to the type of car for which facets data is to be returned
+    # @option opts [String] :year Year of the car
+    # @option opts [String] :make Make of the car
+    # @option opts [String] :model Model of the Car
+    # @option opts [String] :trim Trim of the Car
+    # @return [Array<(Array<FacetItem>, Fixnum, Hash)>] Array<FacetItem> data, response status code and response headers
+    def get_facets_with_http_info(api_key, fields, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FacetsApi#get_facets ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_facets" if api_key.nil?
+      
+      # verify the required parameter 'fields' is set
+      fail "Missing the required parameter 'fields' when calling get_facets" if fields.nil?
+      
+      # resource path
+      local_var_path = "/facets".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+      query_params[:'fields'] = fields
+      query_params[:'vin'] = opts[:'vin'] if opts[:'vin']
+      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']
+
+      # 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 => 'Array<FacetItem>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FacetsApi#get_facets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/graphs_api.rb

@@ -0,0 +1,108 @@
+=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 GraphsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Price, Miles plots data for given criteria
+    # Get price, miles plot data for active cars matching the given VIN's basic specification or Year, Make, Model, Trim (Optional) criteria
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param car_type Car type to get the scatter plot data for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :vin VIN as a reference to the type of car for which plot data is to be returned
+    # @option opts [String] :year Year of the car
+    # @option opts [String] :make Make of the car
+    # @option opts [String] :model Model of the Car
+    # @option opts [String] :trim Trim of the Car
+    # @option opts [String] :rows Number of results to return. Default is 1000. Max is 10000
+    # @return [Array<PlotPoint>]
+    def get_price_miles_plot_data(api_key, car_type, opts = {})
+      data, status_code, headers = get_price_miles_plot_data_with_http_info(api_key, car_type, opts)
+      return data
+    end
+
+    # Price, Miles plots data for given criteria
+    # Get price, miles plot data for active cars matching the given VIN&#39;s basic specification or Year, Make, Model, Trim (Optional) criteria
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param car_type Car type to get the scatter plot data for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :vin VIN as a reference to the type of car for which plot data is to be returned
+    # @option opts [String] :year Year of the car
+    # @option opts [String] :make Make of the car
+    # @option opts [String] :model Model of the Car
+    # @option opts [String] :trim Trim of the Car
+    # @option opts [String] :rows Number of results to return. Default is 1000. Max is 10000
+    # @return [Array<(Array<PlotPoint>, Fixnum, Hash)>] Array<PlotPoint> data, response status code and response headers
+    def get_price_miles_plot_data_with_http_info(api_key, car_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GraphsApi#get_price_miles_plot_data ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_price_miles_plot_data" if api_key.nil?
+      
+      # verify the required parameter 'car_type' is set
+      fail "Missing the required parameter 'car_type' when calling get_price_miles_plot_data" if car_type.nil?
+      
+      # resource path
+      local_var_path = "/plots".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+      query_params[:'car_type'] = car_type
+      query_params[:'vin'] = opts[:'vin'] if opts[:'vin']
+      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[:'rows'] = opts[:'rows'] if opts[:'rows']
+
+      # 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 => 'Array<PlotPoint>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GraphsApi#get_price_miles_plot_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/history_api.rb

@@ -0,0 +1,95 @@
+=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 HistoryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get a cars online listing history
+    # The history API returns online listing history for a car identified by its VIN. History listings are sorted in the descending order of the listing date / last seen date
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param vin The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :rows Number of results to return. Default is 10. Max is 50
+    # @option opts [Float] :page Page number to fetch the results for the given criteria. Default is 1.
+    # @return [Array<HistoricalListing>]
+    def history(api_key, vin, opts = {})
+      data, status_code, headers = history_with_http_info(api_key, vin, opts)
+      return data
+    end
+
+    # Get a cars online listing history
+    # The history API returns online listing history for a car identified by its VIN. History listings are sorted in the descending order of the listing date / last seen date
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param vin The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :rows Number of results to return. Default is 10. Max is 50
+    # @option opts [Float] :page Page number to fetch the results for the given criteria. Default is 1.
+    # @return [Array<(Array<HistoricalListing>, Fixnum, Hash)>] Array<HistoricalListing> data, response status code and response headers
+    def history_with_http_info(api_key, vin, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HistoryApi#history ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling history" if api_key.nil?
+      
+      # verify the required parameter 'vin' is set
+      fail "Missing the required parameter 'vin' when calling history" if vin.nil?
+      
+      # resource path
+      local_var_path = "/history/{vin}".sub('{format}','json').sub('{' + 'vin' + '}', vin.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+      query_params[:'rows'] = opts[:'rows'] if opts[:'rows']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+
+      # 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 => 'Array<HistoricalListing>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HistoryApi#history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/inventory_api.rb

@@ -0,0 +1,155 @@
+=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 InventoryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Dealer inventory
+    # Get a dealer's currently active inventory
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param dealer_id Id representing the dealer to fetch the active inventory for
+    # @param [Hash] opts the optional parameters
+    # @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
+    # @return [BaseListing]
+    def get_dealer_active_inventory(api_key, dealer_id, opts = {})
+      data, status_code, headers = get_dealer_active_inventory_with_http_info(api_key, dealer_id, opts)
+      return data
+    end
+
+    # Dealer inventory
+    # Get a dealer&#39;s currently active inventory
+    # @param api_key The API Authentication Key. Mandatory with all API calls.
+    # @param dealer_id Id representing the dealer to fetch the active inventory for
+    # @param [Hash] opts the optional parameters
+    # @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
+    # @return [Array<(BaseListing, Fixnum, Hash)>] BaseListing data, response status code and response headers
+    def get_dealer_active_inventory_with_http_info(api_key, dealer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: InventoryApi#get_dealer_active_inventory ..."
+      end
+      
+      # verify the required parameter 'api_key' is set
+      fail "Missing the required parameter 'api_key' when calling get_dealer_active_inventory" if api_key.nil?
+      
+      # verify the required parameter 'dealer_id' is set
+      fail "Missing the required parameter 'dealer_id' when calling get_dealer_active_inventory" if dealer_id.nil?
+      
+      # resource path
+      local_var_path = "/dealer/{dealer_id}/active/inventory".sub('{format}','json').sub('{' + 'dealer_id' + '}', dealer_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'api_key'] = api_key
+      query_params[:'rows'] = opts[:'rows'] if opts[:'rows']
+      query_params[:'start'] = opts[:'start'] if opts[:'start']
+
+      # 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 => 'BaseListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InventoryApi#get_dealer_active_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Dealer's historical inventory
+    # [v1 : Not Implemented Yet] - Get a dealer's historical inventory
+    # @param dealer_id Id representing the dealer to fetch the active inventory for
+    # @param [Hash] opts the optional parameters
+    # @return [BaseListing]
+    def get_dealer_historical_inventory(dealer_id, opts = {})
+      data, status_code, headers = get_dealer_historical_inventory_with_http_info(dealer_id, opts)
+      return data
+    end
+
+    # Dealer&#39;s historical inventory
+    # [v1 : Not Implemented Yet] - Get a dealer&#39;s historical inventory
+    # @param dealer_id Id representing the dealer to fetch the active inventory for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BaseListing, Fixnum, Hash)>] BaseListing data, response status code and response headers
+    def get_dealer_historical_inventory_with_http_info(dealer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: InventoryApi#get_dealer_historical_inventory ..."
+      end
+      
+      # verify the required parameter 'dealer_id' is set
+      fail "Missing the required parameter 'dealer_id' when calling get_dealer_historical_inventory" if dealer_id.nil?
+      
+      # resource path
+      local_var_path = "/dealer/{dealer_id}/historical/inventory".sub('{format}','json').sub('{' + 'dealer_id' + '}', dealer_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'BaseListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InventoryApi#get_dealer_historical_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end