# autotec-api-js-client

AutotecApiJsClient - JavaScript client for autotec-api-js-client
API for methods pertaining to all AutoTec services
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.1
- Package version: 1.0.1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install autotec-api-js-client --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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your autotec-api-js-client from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('autotec-api-js-client')` 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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var AutotecApiJsClient = require('autotec-api-js-client');

var defaultClient = AutotecApiJsClient.ApiClient.instance;

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

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

var api = new AutotecApiJsClient.VehicleApi()

var request = new AutotecApiJsClient.RiskCalculationRequest(); // {RiskCalculationRequest} The calculation request


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

```

## Documentation for API Endpoints

All URIs are relative to *https://api.prod.autotec.com/1_0_1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AutotecApiJsClient.VehicleApi* | [**calcRisk**](docs/VehicleApi.md#calcRisk) | **POST** /vehicle/risk | Calculates Risk of Loss for Requested Vehicles
*AutotecApiJsClient.VehicleApi* | [**historyFull**](docs/VehicleApi.md#historyFull) | **POST** /vehicle/history/full | 


## Documentation for Models

 - [AutotecApiJsClient.FullHistoryResponse](docs/FullHistoryResponse.md)
 - [AutotecApiJsClient.HistoryRecord](docs/HistoryRecord.md)
 - [AutotecApiJsClient.HistoryRequest](docs/HistoryRequest.md)
 - [AutotecApiJsClient.RiskCalculationRequest](docs/RiskCalculationRequest.md)
 - [AutotecApiJsClient.RiskCalculationResponse](docs/RiskCalculationResponse.md)
 - [AutotecApiJsClient.VINDate](docs/VINDate.md)
 - [AutotecApiJsClient.VINDateResult](docs/VINDateResult.md)
 - [AutotecApiJsClient.Vehicle](docs/Vehicle.md)
 - [AutotecApiJsClient.VehicleHistory](docs/VehicleHistory.md)
 - [AutotecApiJsClient.VehicleInformation](docs/VehicleInformation.md)
 - [AutotecApiJsClient.VehicleOwnershipActivity](docs/VehicleOwnershipActivity.md)
 - [AutotecApiJsClient.VehicleScoring](docs/VehicleScoring.md)


## Documentation for Authorization


### OrganizationAuthorizer

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

### api_key

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