marketcheck_ruby_client 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8433069eb2414a0a98142c5c1326bfe3ab6af35
+  data.tar.gz: 110f95fc8ffdf0315bbf44bb46fc6873b4cb3cc5
+SHA512:
+  metadata.gz: eca352d1eadde5f605514a291f9ba09e1cba0654ffbb4d6e7dfba36d035d58e4e02df1e19aa8c2476b0deb97271eec40244d4e511b730329bd79cafaeddd6289
+  data.tar.gz: 7fcf6b3f59633101922e17cf6b371564f1744e8e260b2e0579a4abf3365bbe875d985c865a67864608dd10611bb198aacaa7c5aada6574de75a55d1fa6a8505e

data/README.md

@@ -0,0 +1,133 @@
+# marketcheck_ruby_client
+
+ The Ruby gem for the Marketcheck Cars API
+
+<b>Access 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>
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API verion: 1.0.4
+- Package version: 1.0.0
+- Build date: 2016-03-22T18:25:59.270Z
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build marketcheck_ruby_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./marketcheck_ruby_client-1.0.4.gem
+```
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'marketcheck_ruby_client', '~> 1.0.4'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'marketcheck_ruby_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::DealerApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+latitude = 1.2 # Float | Latitude component of location
+
+longitude = 1.2 # Float | Longitude component of location
+
+radius = 56 # Integer | Radius around the search location
+
+type = "type_example" # String | Dealer inventory type. Allowed values are - new / used / certified
+
+opts = { 
+  rows: 3.4, # Float | Number of results to return. Default is 10. Max is 50
+  start: 3.4 # Float | Offset for the search results. Default is 1.
+}
+
+begin
+  #Find car dealers around
+  result = api_instance.dealer_search(api_key, latitude, longitude, radius, type, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DealerApi->dealer_search: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SwaggerClient::DealerApi* | [**dealer_search**](../../blob/master/marketcheck_ruby_client/docs/DealerApi.md#dealer_search) | **GET** /dealers | Find car dealers around
+*SwaggerClient::DealerApi* | [**get_dealer**](../../blob/master/marketcheck_ruby_client/docs/DealerApi.md#get_dealer) | **GET** /dealer/{id} | Dealer by id
+*SwaggerClient::DealerApi* | [**get_dealer_active_inventory**](../../blob/master/marketcheck_ruby_client/docs/DealerApi.md#get_dealer_active_inventory) | **GET** /dealer/{dealer_id}/active/inventory | Dealer inventory
+*SwaggerClient::DealerApi* | [**get_dealer_historical_inventory**](../../blob/master/marketcheck_ruby_client/docs/DealerApi.md#get_dealer_historical_inventory) | **GET** /dealer/{dealer_id}/historical/inventory | Dealer's historical inventory
+*SwaggerClient::FacetsApi* | [**get_facets**](../../blob/master/marketcheck_ruby_client/docs/FacetsApi.md#get_facets) | **GET** /facets | Facets
+*SwaggerClient::GraphsApi* | [**get_price_miles_plot_data**](../../blob/master/marketcheck_ruby_client/docs/GraphsApi.md#get_price_miles_plot_data) | **GET** /plots | Price, Miles plots data for given criteria
+*SwaggerClient::HistoryApi* | [**history**](../../blob/master/marketcheck_ruby_client/docs/HistoryApi.md#history) | **GET** /history/{vin} | Get a cars online listing history
+*SwaggerClient::InventoryApi* | [**get_dealer_active_inventory**](../../blob/master/marketcheck_ruby_client/docs/InventoryApi.md#get_dealer_active_inventory) | **GET** /dealer/{dealer_id}/active/inventory | Dealer inventory
+*SwaggerClient::InventoryApi* | [**get_dealer_historical_inventory**](../../blob/master/marketcheck_ruby_client/docs/InventoryApi.md#get_dealer_historical_inventory) | **GET** /dealer/{dealer_id}/historical/inventory | Dealer's historical inventory
+*SwaggerClient::ListingsApi* | [**get_listing**](../../blob/master/marketcheck_ruby_client/docs/ListingsApi.md#get_listing) | **GET** /listing/{id} | Listing by id
+*SwaggerClient::ListingsApi* | [**get_listing_extra**](../../blob/master/marketcheck_ruby_client/docs/ListingsApi.md#get_listing_extra) | **GET** /listing/{id}/extra | Long text Listings attributes for Listing with the given id
+*SwaggerClient::ListingsApi* | [**get_listing_media**](../../blob/master/marketcheck_ruby_client/docs/ListingsApi.md#get_listing_media) | **GET** /listing/{id}/media | Listing media by id
+*SwaggerClient::ListingsApi* | [**get_listing_vdp**](../../blob/master/marketcheck_ruby_client/docs/ListingsApi.md#get_listing_vdp) | **GET** /listing/{id}/vdp | Get listing HTML
+*SwaggerClient::ListingsApi* | [**search**](../../blob/master/marketcheck_ruby_client/docs/ListingsApi.md#search) | **GET** /search | Gets active car listings for the given search criteria
+*SwaggerClient::MarketAveragesApi* | [**get_averages**](../../blob/master/marketcheck_ruby_client/docs/MarketAveragesApi.md#get_averages) | **GET** /averages | Get Averages for YMM
+*SwaggerClient::MarketTrendsApi* | [**get_trends**](../../blob/master/marketcheck_ruby_client/docs/MarketTrendsApi.md#get_trends) | **GET** /trends | Get Trends for criteria
+*SwaggerClient::VINDecoderApi* | [**decode**](../../blob/master/marketcheck_ruby_client/docs/VINDecoderApi.md#decode) | **GET** /vin/{vin}/specs | VIN Decoder
+
+
+## Documentation for Models
+
+ - [SwaggerClient::Averages](docs/Averages.md)
+ - [SwaggerClient::BaseListing](docs/BaseListing.md)
+ - [SwaggerClient::Build](docs/Build.md)
+ - [SwaggerClient::Dealer](docs/Dealer.md)
+ - [SwaggerClient::Error](docs/Error.md)
+ - [SwaggerClient::FacetItem](docs/FacetItem.md)
+ - [SwaggerClient::HistoricalListing](docs/HistoricalListing.md)
+ - [SwaggerClient::Listing](docs/Listing.md)
+ - [SwaggerClient::ListingDebugAttributes](docs/ListingDebugAttributes.md)
+ - [SwaggerClient::ListingExtraAttributes](docs/ListingExtraAttributes.md)
+ - [SwaggerClient::ListingMedia](docs/ListingMedia.md)
+ - [SwaggerClient::ListingVDP](docs/ListingVDP.md)
+ - [SwaggerClient::Location](docs/Location.md)
+ - [SwaggerClient::MakeModel](docs/MakeModel.md)
+ - [SwaggerClient::PlotPoint](docs/PlotPoint.md)
+ - [SwaggerClient::SearchResponse](docs/SearchResponse.md)
+ - [SwaggerClient::TrendPoint](docs/TrendPoint.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/docs/Averages.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Averages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** | Mean price value for the car | [optional] 
+**msrp** | **Float** | Mean msrp value for the car | [optional] 
+**miles** | **Float** | Mean miles value for the car | [optional] 
+**dom** | **Float** | Average Days on Market value for the car based on all listings found in the Marketcheck database for this car | [optional] 
+**age** | **Float** | Average age of the car | [optional] 
+**units** | **Float** | No of units for this car on the market | [optional] 
+
+

data/docs/BaseListing.md

@@ -0,0 +1,27 @@
+# SwaggerClient::BaseListing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier representing a specific listing from the Marketcheck database | [optional] 
+**heading** | **String** | Listing title as displayed on the source website | [optional] 
+**vin** | **String** | VIN for the car | [optional] 
+**price** | **String** | Asking price for the car | [optional] 
+**miles** | **String** | Odometer reading / reported miles usage for the car | [optional] 
+**last_seen_at** | **Float** | Listing last seen at (most recent) timestamp | [optional] 
+**ref_price** | **String** | Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date | [optional] 
+**ref_miles** | **String** | Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date | [optional] 
+**ref_price_dt** | **Integer** | The date at which the last price was reported online. This is earlier to last_seen_date | [optional] 
+**ref_miles_dt** | **Integer** | The date at which the last miles was reported online. This is earlier to last_seen_date | [optional] 
+**dom** | **Float** | Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car | [optional] 
+**exterior_color** | **String** | Exterior color of the car | [optional] 
+**interior_color** | **String** | Interior color of the car | [optional] 
+**vdp_url** | **String** | Vehicle Details Page url of the specific car | [optional] 
+**source** | **String** | Source domain of the listing | [optional] 
+**media** | [**ListingMedia**](ListingMedia.md) | Car Media Attributes - main photo link/url and photo links | [optional] 
+**build** | [**Build**](Build.md) |  | [optional] 
+**dealer** | [**Dealer**](Dealer.md) |  | [optional] 
+**is_certified** | **Integer** | Certified car | [optional] 
+**distance** | **Float** | Distance of the car's location from the specified user lcoation | [optional] 
+
+

data/docs/Build.md

@@ -0,0 +1,19 @@
+# SwaggerClient::Build
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **Float** | Year of the Car | [optional] 
+**make** | **String** | Car Make | [optional] 
+**model** | **String** | Car model | [optional] 
+**trim** | **String** | Trim of the car | [optional] 
+**engine** | **String** | Engine of the car | [optional] 
+**engine_block** | **String** | Engine block of the car | [optional] 
+**engine_size** | **String** | Engine size of the car | [optional] 
+**engine_measure** | **String** | Engine block of the car | [optional] 
+**engine_aspiration** | **String** | Engine aspiration of the car | [optional] 
+**transmission** | **String** | Transmission of the car | [optional] 
+**doors** | **Float** | No of doors of the car | [optional] 
+**cylinders** | **Float** | No of cylinders of the car | [optional] 
+
+

data/docs/Dealer.md

@@ -0,0 +1,23 @@
+# SwaggerClient::Dealer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique id associated with the dealer in the Marketcheck database | [optional] 
+**franchise_id** | **String** | Dealer franchise id | [optional] 
+**name** | **String** | Name of the dealer | [optional] 
+**street** | **String** | Street of the dealer | [optional] 
+**city** | **String** | City of the dealer | [optional] 
+**state** | **String** | State of the dealer | [optional] 
+**zip** | **String** | Zip of the dealer | [optional] 
+**latitude** | **String** | Latutide for the dealer location | [optional] 
+**longitude** | **String** | Longitude for the dealer location | [optional] 
+**phone** | **String** | Contact no of the dealer | [optional] 
+**car_type** | **String** | Car type new|used|certified | [optional] 
+**target_url_new** | **String** | Target url for the new cars listing | [optional] 
+**target_url_used** | **String** | Target url for the used cars listing | [optional] 
+**target_url_certified** | **String** | Target url for the certified cars listing | [optional] 
+**dealer_type** | **String** | Dealer type - independent, franchise, multi-brand, authorized | [optional] [default to "independent"]
+**rating** | **Float** | Overall rating of the dealership on scale 1-5 | [optional] 
+
+

data/docs/DealerApi.md

@@ -0,0 +1,230 @@
+# SwaggerClient::DealerApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**dealer_search**](DealerApi.md#dealer_search) | **GET** /dealers | Find car dealers around
+[**get_dealer**](DealerApi.md#get_dealer) | **GET** /dealer/{id} | Dealer by id
+[**get_dealer_active_inventory**](DealerApi.md#get_dealer_active_inventory) | **GET** /dealer/{dealer_id}/active/inventory | Dealer inventory
+[**get_dealer_historical_inventory**](DealerApi.md#get_dealer_historical_inventory) | **GET** /dealer/{dealer_id}/historical/inventory | Dealer's historical inventory
+
+
+# **dealer_search**
+> Array<Dealer> dealer_search(api_key, latitude, longitude, radius, type, opts)
+
+Find car dealers around
+
+The dealers API returns a list of dealers around a given point and radius. Max radius of only 50 miles is supported.
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::DealerApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+latitude = 1.2 # Float | Latitude component of location
+
+longitude = 1.2 # Float | Longitude component of location
+
+radius = 56 # Integer | Radius around the search location
+
+type = "type_example" # String | Dealer inventory type. Allowed values are - new / used / certified
+
+opts = { 
+  rows: 3.4, # Float | Number of results to return. Default is 10. Max is 50
+  start: 3.4 # Float | Offset for the search results. Default is 1.
+}
+
+begin
+  #Find car dealers around
+  result = api_instance.dealer_search(api_key, latitude, longitude, radius, type, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DealerApi->dealer_search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **latitude** | **Float**| Latitude component of location | 
+ **longitude** | **Float**| Longitude component of location | 
+ **radius** | [**Integer**](.md)| Radius around the search location | 
+ **type** | **String**| Dealer inventory type. Allowed values are - new / used / certified | 
+ **rows** | [**Float**](.md)| Number of results to return. Default is 10. Max is 50 | [optional] 
+ **start** | [**Float**](.md)| Offset for the search results. Default is 1. | [optional] 
+
+### Return type
+
+[**Array<Dealer>**](Dealer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_dealer**
+> Dealer get_dealer(api_key, id)
+
+Dealer by id
+
+Get a particular dealer's information by its id
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::DealerApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+id = "id_example" # String | Dealer id to get all the dealer info attributes
+
+
+begin
+  #Dealer by id
+  result = api_instance.get_dealer(api_key, id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DealerApi->get_dealer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **id** | **String**| Dealer id to get all the dealer info attributes | 
+
+### Return type
+
+[**Dealer**](Dealer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_dealer_active_inventory**
+> BaseListing get_dealer_active_inventory(api_key, dealer_id, opts)
+
+Dealer inventory
+
+Get a dealer's currently active inventory
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::DealerApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+dealer_id = "dealer_id_example" # String | Id representing the dealer to fetch the active inventory for
+
+opts = { 
+  rows: "rows_example", # String | Number of results to return. Default is 10. Max is 50
+  start: "start_example" # String | 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
+}
+
+begin
+  #Dealer inventory
+  result = api_instance.get_dealer_active_inventory(api_key, dealer_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DealerApi->get_dealer_active_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **dealer_id** | **String**| Id representing the dealer to fetch the active inventory for | 
+ **rows** | **String**| Number of results to return. Default is 10. Max is 50 | [optional] 
+ **start** | **String**| 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 | [optional] 
+
+### Return type
+
+[**BaseListing**](BaseListing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_dealer_historical_inventory**
+> BaseListing get_dealer_historical_inventory(dealer_id)
+
+Dealer's historical inventory
+
+[v1 : Not Implemented Yet] - Get a dealer's historical inventory
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::DealerApi.new
+
+dealer_id = "dealer_id_example" # String | Id representing the dealer to fetch the active inventory for
+
+
+begin
+  #Dealer's historical inventory
+  result = api_instance.get_dealer_historical_inventory(dealer_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DealerApi->get_dealer_historical_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dealer_id** | **String**| Id representing the dealer to fetch the active inventory for | 
+
+### Return type
+
+[**BaseListing**](BaseListing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+