marketcheck_ruby_client 1.0.7

data/spec/api/facets_api_spec.rb

@@ -0,0 +1,57 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::FacetsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FacetsApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::FacetsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FacetsApi' do
+    it 'should create an instact of FacetsApi' do
+      @instance.should be_a(SwaggerClient::FacetsApi)
+    end
+  end
+
+  # unit tests for get_facets
+  # 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<FacetItem>]
+  describe 'get_facets test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/graphs_api_spec.rb

@@ -0,0 +1,58 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::GraphsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GraphsApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::GraphsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GraphsApi' do
+    it 'should create an instact of GraphsApi' do
+      @instance.should be_a(SwaggerClient::GraphsApi)
+    end
+  end
+
+  # unit tests for get_price_miles_plot_data
+  # 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<PlotPoint>]
+  describe 'get_price_miles_plot_data test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/history_api_spec.rb

@@ -0,0 +1,54 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::HistoryApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'HistoryApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::HistoryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of HistoryApi' do
+    it 'should create an instact of HistoryApi' do
+      @instance.should be_a(SwaggerClient::HistoryApi)
+    end
+  end
+
+  # unit tests for history
+  # 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>]
+  describe 'history test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/inventory_api_spec.rb

@@ -0,0 +1,70 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::InventoryApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InventoryApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::InventoryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InventoryApi' do
+    it 'should create an instact of InventoryApi' do
+      @instance.should be_a(SwaggerClient::InventoryApi)
+    end
+  end
+
+  # unit tests for get_dealer_active_inventory
+  # 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 [BaseListing]
+  describe 'get_dealer_active_inventory test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_dealer_historical_inventory
+  # 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 [BaseListing]
+  describe 'get_dealer_historical_inventory test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/listings_api_spec.rb

@@ -0,0 +1,148 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::ListingsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ListingsApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::ListingsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ListingsApi' do
+    it 'should create an instact of ListingsApi' do
+      @instance.should be_a(SwaggerClient::ListingsApi)
+    end
+  end
+
+  # unit tests for get_listing
+  # 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]
+  describe 'get_listing test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_listing_extra
+  # 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]
+  describe 'get_listing_extra test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_listing_media
+  # 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]
+  describe 'get_listing_media test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_listing_vdp
+  # 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]
+  describe 'get_listing_vdp test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for search
+  # 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]
+  describe 'search test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/spec/api/market_averages_api_spec.rb

@@ -0,0 +1,57 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SwaggerClient::MarketAveragesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'MarketAveragesApi' do
+  before do
+    # run before each test
+    @instance = SwaggerClient::MarketAveragesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MarketAveragesApi' do
+    it 'should create an instact of MarketAveragesApi' do
+      @instance.should be_a(SwaggerClient::MarketAveragesApi)
+    end
+  end
+
+  # unit tests for get_averages
+  # Get Averages for YMM
+  # [Merged with the /search API - Please check the &#39;stats&#39; parameter to the Search API above] Get market averages for price / miles / msrp / dom (days on market) fields for active cars matching the given reference 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 [Hash] opts the optional parameters
+  # @option opts [String] :vin VIN as a reference to the type of car for which averages 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] :fields Comma separated list of fields to generate stats for. Allowed fields in the list are - price, miles, msrp, dom (days on market)
+  # @return [Averages]
+  describe 'get_averages test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end