@apiverve/vindecoder 1.2.2 → 1.2.4

package/README.md

@@ -59,7 +59,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
 var query = {
   vin: "1HGCM82633A004352",
   recalls: true,
-  safetyRating: true
+  safetyRating: true,
+  fuelEconomy: true
 };
 
 api.execute(query, function (error, data) {
@@ -81,7 +82,8 @@ You can also use promises to make requests. The API returns a promise that you c
 var query = {
   vin: "1HGCM82633A004352",
   recalls: true,
-  safetyRating: true
+  safetyRating: true,
+  fuelEconomy: true
 };
 
 api.execute(query)
@@ -104,7 +106,8 @@ async function makeRequest() {
     var query = {
   vin: "1HGCM82633A004352",
   recalls: true,
-  safetyRating: true
+  safetyRating: true,
+  fuelEconomy: true
 };
 
     try {
@@ -313,6 +316,54 @@ async function makeRequest() {
         "forwardCollisionWarning": "notAvailable",
         "laneDepartureWarning": "notAvailable"
       }
+    },
+    "fuelEconomy": {
+      "unit": "MPG",
+      "city": {
+        "min": 19,
+        "max": 19,
+        "value": 19
+      },
+      "highway": {
+        "min": 27,
+        "max": 27,
+        "value": 27
+      },
+      "combined": {
+        "min": 22,
+        "max": 22,
+        "value": 22
+      },
+      "exact": true,
+      "variantsMatched": 1,
+      "electricRangeMiles": null,
+      "co2GramsPerMile": {
+        "min": 404,
+        "max": 404,
+        "value": 404
+      },
+      "annualFuelCostUsd": {
+        "min": 3050,
+        "max": 3050,
+        "value": 3050
+      },
+      "variants": [
+        {
+          "epaId": 18657,
+          "model": "Accord",
+          "vehicleClass": "Midsize Cars",
+          "powertrain": "Gasoline",
+          "fuelType": "Regular",
+          "displacementL": 3,
+          "cylinders": 6,
+          "drive": "Front-Wheel Drive",
+          "transmission": "Automatic 5-spd",
+          "cityMpg": 19,
+          "highwayMpg": 27,
+          "combinedMpg": 22,
+          "electricRangeMiles": null
+        }
+      ]
     }
   }
 }

package/index.d.ts

@@ -45,6 +45,7 @@ declare module '@apiverve/vindecoder' {
       validation:        Validation;
       recalls:           Recalls;
       safetyRating:      SafetyRating;
+      fuelEconomy:       FuelEconomy;
   }
   
   interface Engine {
@@ -84,6 +85,41 @@ declare module '@apiverve/vindecoder' {
       frontAirBagLocations:     null | string;
   }
   
+  interface FuelEconomy {
+      unit:               null | string;
+      city:               AnnualFuelCostUsd;
+      highway:            AnnualFuelCostUsd;
+      combined:           AnnualFuelCostUsd;
+      exact:              boolean | null;
+      variantsMatched:    number | null;
+      electricRangeMiles: null;
+      co2GramsPerMile:    AnnualFuelCostUsd;
+      annualFuelCostUsd:  AnnualFuelCostUsd;
+      variants:           Variant[];
+  }
+  
+  interface AnnualFuelCostUsd {
+      min:   number | null;
+      max:   number | null;
+      value: number | null;
+  }
+  
+  interface Variant {
+      epaID:              number | null;
+      model:              null | string;
+      vehicleClass:       null | string;
+      powertrain:         null | string;
+      fuelType:           null | string;
+      displacementL:      number | null;
+      cylinders:          number | null;
+      drive:              null | string;
+      transmission:       null | string;
+      cityMpg:            number | null;
+      highwayMpg:         number | null;
+      combinedMpg:        number | null;
+      electricRangeMiles: null;
+  }
+  
   interface Plant {
       state:   null | string;
       country: null | string;

package/index.js

@@ -30,7 +30,7 @@ class vindecoderWrapper {
         this.baseURL = 'https://api.apiverve.com/v1/vindecoder';
 
         // Validation rules for parameters (generated from schema)
-        this.validationRules = {"vin":{"type":"string","required":true,"minLength":1,"maxLength":17},"recalls":{"type":"boolean","required":false},"safetyRating":{"type":"boolean","required":false}};
+        this.validationRules = {"vin":{"type":"string","required":true,"minLength":1,"maxLength":17},"recalls":{"type":"boolean","required":false},"safetyRating":{"type":"boolean","required":false},"fuelEconomy":{"type":"boolean","required":false}};
     }
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiverve/vindecoder",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "VIN Decoder turns a 17-character Vehicle Identification Number into the vehicle it identifies. Returns make, model, year, trim, body class and manufacturer, plus engine specifications, plant of manufacture, and the safety equipment fitted to that specific build. Optionally adds every safety recall issued for that vehicle and its NHTSA 5-star crash-test rating.",
   "main": "index.js",
   "types": "index.d.ts",