marketcheck_ruby_client 1.0.7

data/lib/swagger_client/api_error.rb

@@ -0,0 +1,36 @@
+=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
+
+module SwaggerClient
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        arg.each do |k, v|
+          if k.to_s == 'message'
+            super v
+          else
+            instance_variable_set "@#{k}", v
+          end
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/swagger_client/configuration.rb

@@ -0,0 +1,163 @@
+require 'uri'
+
+module SwaggerClient
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    ### TLS/SSL
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'http'
+      @host = 'api.marketcheck.com'
+      @base_path = '/v1'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @verify_ssl = true
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "" if @base_path == "/"
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+      }
+    end
+  end
+end

data/lib/swagger_client/models/averages.rb

@@ -0,0 +1,217 @@
+=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 'date'
+
+module SwaggerClient
+  class Averages
+    # Mean price value for the car
+    attr_accessor :price
+
+    # Mean msrp value for the car
+    attr_accessor :msrp
+
+    # Mean miles value for the car
+    attr_accessor :miles
+
+    # Average Days on Market value for the car based on all listings found in the Marketcheck database for this car
+    attr_accessor :dom
+
+    # Average age of the car
+    attr_accessor :age
+
+    # No of units for this car on the market
+    attr_accessor :units
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'price' => :'price',
+        
+        :'msrp' => :'msrp',
+        
+        :'miles' => :'miles',
+        
+        :'dom' => :'dom',
+        
+        :'age' => :'age',
+        
+        :'units' => :'units'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'price' => :'Float',
+        :'msrp' => :'Float',
+        :'miles' => :'Float',
+        :'dom' => :'Float',
+        :'age' => :'Float',
+        :'units' => :'Float'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'price']
+        self.price = attributes[:'price']
+      end
+      
+      if attributes[:'msrp']
+        self.msrp = attributes[:'msrp']
+      end
+      
+      if attributes[:'miles']
+        self.miles = attributes[:'miles']
+      end
+      
+      if attributes[:'dom']
+        self.dom = attributes[:'dom']
+      end
+      
+      if attributes[:'age']
+        self.age = attributes[:'age']
+      end
+      
+      if attributes[:'units']
+        self.units = attributes[:'units']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          price == o.price &&
+          msrp == o.msrp &&
+          miles == o.miles &&
+          dom == o.dom &&
+          age == o.age &&
+          units == o.units
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [price, msrp, miles, dom, age, units].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = SwaggerClient.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/swagger_client/models/base_listing.rb

@@ -0,0 +1,370 @@
+=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 'date'
+
+module SwaggerClient
+  # Minimal set of attributes describing a listing
+  class BaseListing
+    # Unique identifier representing a specific listing from the Marketcheck database
+    attr_accessor :id
+
+    # Listing title as displayed on the source website
+    attr_accessor :heading
+
+    # VIN for the car
+    attr_accessor :vin
+
+    # Asking price for the car
+    attr_accessor :price
+
+    # Odometer reading / reported miles usage for the car
+    attr_accessor :miles
+
+    # Listing last seen at (most recent) timestamp
+    attr_accessor :last_seen_at
+
+    # 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
+    attr_accessor :ref_price
+
+    # 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
+    attr_accessor :ref_miles
+
+    # The date at which the last price was reported online. This is earlier to last_seen_date
+    attr_accessor :ref_price_dt
+
+    # The date at which the last miles was reported online. This is earlier to last_seen_date
+    attr_accessor :ref_miles_dt
+
+    # Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
+    attr_accessor :dom
+
+    # Exterior color of the car
+    attr_accessor :exterior_color
+
+    # Interior color of the car
+    attr_accessor :interior_color
+
+    # Vehicle Details Page url of the specific car
+    attr_accessor :vdp_url
+
+    # Source domain of the listing
+    attr_accessor :source
+
+    # Car Media Attributes - main photo link/url and photo links
+    attr_accessor :media
+
+    attr_accessor :build
+
+    attr_accessor :dealer
+
+    # Certified car
+    attr_accessor :is_certified
+
+    # Distance of the car's location from the specified user lcoation
+    attr_accessor :distance
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'heading' => :'heading',
+        
+        :'vin' => :'vin',
+        
+        :'price' => :'price',
+        
+        :'miles' => :'miles',
+        
+        :'last_seen_at' => :'last_seen_at',
+        
+        :'ref_price' => :'ref_price',
+        
+        :'ref_miles' => :'ref_miles',
+        
+        :'ref_price_dt' => :'ref_price_dt',
+        
+        :'ref_miles_dt' => :'ref_miles_dt',
+        
+        :'dom' => :'dom',
+        
+        :'exterior_color' => :'exterior_color',
+        
+        :'interior_color' => :'interior_color',
+        
+        :'vdp_url' => :'vdp_url',
+        
+        :'source' => :'source',
+        
+        :'media' => :'media',
+        
+        :'build' => :'build',
+        
+        :'dealer' => :'dealer',
+        
+        :'is_certified' => :'is_certified',
+        
+        :'distance' => :'distance'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'heading' => :'String',
+        :'vin' => :'String',
+        :'price' => :'String',
+        :'miles' => :'String',
+        :'last_seen_at' => :'Float',
+        :'ref_price' => :'String',
+        :'ref_miles' => :'String',
+        :'ref_price_dt' => :'Integer',
+        :'ref_miles_dt' => :'Integer',
+        :'dom' => :'Float',
+        :'exterior_color' => :'String',
+        :'interior_color' => :'String',
+        :'vdp_url' => :'String',
+        :'source' => :'String',
+        :'media' => :'ListingMedia',
+        :'build' => :'Build',
+        :'dealer' => :'Dealer',
+        :'is_certified' => :'Integer',
+        :'distance' => :'Float'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'heading']
+        self.heading = attributes[:'heading']
+      end
+      
+      if attributes[:'vin']
+        self.vin = attributes[:'vin']
+      end
+      
+      if attributes[:'price']
+        self.price = attributes[:'price']
+      end
+      
+      if attributes[:'miles']
+        self.miles = attributes[:'miles']
+      end
+      
+      if attributes[:'last_seen_at']
+        self.last_seen_at = attributes[:'last_seen_at']
+      end
+      
+      if attributes[:'ref_price']
+        self.ref_price = attributes[:'ref_price']
+      end
+      
+      if attributes[:'ref_miles']
+        self.ref_miles = attributes[:'ref_miles']
+      end
+      
+      if attributes[:'ref_price_dt']
+        self.ref_price_dt = attributes[:'ref_price_dt']
+      end
+      
+      if attributes[:'ref_miles_dt']
+        self.ref_miles_dt = attributes[:'ref_miles_dt']
+      end
+      
+      if attributes[:'dom']
+        self.dom = attributes[:'dom']
+      end
+      
+      if attributes[:'exterior_color']
+        self.exterior_color = attributes[:'exterior_color']
+      end
+      
+      if attributes[:'interior_color']
+        self.interior_color = attributes[:'interior_color']
+      end
+      
+      if attributes[:'vdp_url']
+        self.vdp_url = attributes[:'vdp_url']
+      end
+      
+      if attributes[:'source']
+        self.source = attributes[:'source']
+      end
+      
+      if attributes[:'media']
+        self.media = attributes[:'media']
+      end
+      
+      if attributes[:'build']
+        self.build = attributes[:'build']
+      end
+      
+      if attributes[:'dealer']
+        self.dealer = attributes[:'dealer']
+      end
+      
+      if attributes[:'is_certified']
+        self.is_certified = attributes[:'is_certified']
+      end
+      
+      if attributes[:'distance']
+        self.distance = attributes[:'distance']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          heading == o.heading &&
+          vin == o.vin &&
+          price == o.price &&
+          miles == o.miles &&
+          last_seen_at == o.last_seen_at &&
+          ref_price == o.ref_price &&
+          ref_miles == o.ref_miles &&
+          ref_price_dt == o.ref_price_dt &&
+          ref_miles_dt == o.ref_miles_dt &&
+          dom == o.dom &&
+          exterior_color == o.exterior_color &&
+          interior_color == o.interior_color &&
+          vdp_url == o.vdp_url &&
+          source == o.source &&
+          media == o.media &&
+          build == o.build &&
+          dealer == o.dealer &&
+          is_certified == o.is_certified &&
+          distance == o.distance
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [id, heading, vin, price, miles, last_seen_at, ref_price, ref_miles, ref_price_dt, ref_miles_dt, dom, exterior_color, interior_color, vdp_url, source, media, build, dealer, is_certified, distance].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = SwaggerClient.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end