auto_tec_services_api

AutoTecServicesApi - JavaScript client for auto_tec_services_api API for methods pertaining to all AutoTec services This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.0
• Package version: 2.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install auto_tec_services_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your auto_tec_services_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('auto_tec_services_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AutoTecServicesApi = require('auto_tec_services_api');

var defaultClient = AutoTecServicesApi.ApiClient.instance;

// Configure API key authorization: CustomerAuthorizer
var CustomerAuthorizer = defaultClient.authentications['CustomerAuthorizer'];
CustomerAuthorizer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CustomerAuthorizer.apiKeyPrefix['Unused'] = "Token"

var api = new AutoTecServicesApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vehicleAnnouncementOptions(callback);

Documentation for API Endpoints

All URIs are relative to https://api.prod.autotec.com/2_0_0

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AutoTecServicesApi.DefaultApi | vehicleAnnouncementOptions | OPTIONS /vehicle/announcement | AutoTecServicesApi.DefaultApi | vehicleHistoryAccidentOptions | OPTIONS /vehicle/history/accident | AutoTecServicesApi.DefaultApi | vehicleHistoryAnnouncementOptions | OPTIONS /vehicle/history/announcement | AutoTecServicesApi.DefaultApi | vehicleHistoryCanadianOptions | OPTIONS /vehicle/history/canadian | AutoTecServicesApi.DefaultApi | vehicleHistoryCanadianPlusOptions | OPTIONS /vehicle/history/canadian/plus | AutoTecServicesApi.DefaultApi | vehicleHistoryCompromisedOptions | OPTIONS /vehicle/history/compromised | AutoTecServicesApi.DefaultApi | vehicleHistoryDisasterOptions | OPTIONS /vehicle/history/disaster | AutoTecServicesApi.DefaultApi | vehicleHistoryDiscrepancyOptions | OPTIONS /vehicle/history/discrepancy | AutoTecServicesApi.DefaultApi | vehicleHistoryExceptionOptions | OPTIONS /vehicle/history/exception | AutoTecServicesApi.DefaultApi | vehicleHistoryFullOptions | OPTIONS /vehicle/history/full | AutoTecServicesApi.DefaultApi | vehicleHistoryRecallOptions | OPTIONS /vehicle/history/recall | AutoTecServicesApi.DefaultApi | vehicleHistoryTheftOptions | OPTIONS /vehicle/history/theft | AutoTecServicesApi.DefaultApi | vehicleRiskOptions | OPTIONS /vehicle/risk | AutoTecServicesApi.VehicleApi | announcement | POST /vehicle/announcement | Sends Vehicle Announcement Data. AutoTecServicesApi.VehicleApi | calcRisk | POST /vehicle/risk | Calculates Risk of Loss for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyAccident | POST /vehicle/history/accident | Retrieves Historical Accident Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyAnnouncement | POST /vehicle/history/announcement | Retrieves Historical Auction Announcement Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyCanadian | POST /vehicle/history/canadian | Retrieves Historical Canadian Registration Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyCanadianPlus | POST /vehicle/history/canadian/plus | Retrieves Canadian Registration Activity Plus the Most Recent US Registration Event for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyCompromised | POST /vehicle/history/compromised | Retrieves Compromised Historical Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyDisaster | POST /vehicle/history/disaster | Retrieves Historical Activity that has occurred within a Disaster Area for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyDiscrepancy | POST /vehicle/history/discrepancy | Retrieves Odometer Discrepancy Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyException | POST /vehicle/history/exception | Retrieves Exception Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyFull | POST /vehicle/history/full | Retrieves Historical Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyRecall | POST /vehicle/history/recall | Retrieves Recall Activity for Requested Vehicles AutoTecServicesApi.VehicleHistoryApi | historyTheft | POST /vehicle/history/theft | Retrieves Theft Activity for Requested Vehicles

Documentation for Models

• AutoTecServicesApi.Empty
• AutoTecServicesApi.HistoryRecord
• AutoTecServicesApi.HistoryRequest
• AutoTecServicesApi.HistoryResponse
• AutoTecServicesApi.RecallRecord
• AutoTecServicesApi.RiskCalculationRequest
• AutoTecServicesApi.RiskCalculationResponse
• AutoTecServicesApi.Vehicle
• AutoTecServicesApi.VehicleAnnouncement
• AutoTecServicesApi.VehicleHistory
• AutoTecServicesApi.VehicleInformation
• AutoTecServicesApi.VehicleOwnershipActivity
• AutoTecServicesApi.VehicleRecall
• AutoTecServicesApi.VehicleRequestAttribute
• AutoTecServicesApi.VehicleRiskRequestAttribute
• AutoTecServicesApi.VehicleRiskResult
• AutoTecServicesApi.VehicleScoring

Documentation for Authorization

CustomerAuthorizer

• Type: API key
• API key parameter name: Unused
• Location: HTTP header

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header