# vxc_api_js_client

> API_for_methods_pertaining_to_all_VXC_services

Latest version **1.0.0** (published 2019-01-08) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install vxc_api_js_client
pnpm add vxc_api_js_client
yarn add vxc_api_js_client
bun add vxc_api_js_client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-01-08 |
| First published | 2019-01-08 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 163.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | autotec |

## Links

- npm: https://www.npmjs.com/package/vxc_api_js_client
- npm.io page: https://npm.io/package/vxc_api_js_client

## Dependencies (2)

- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.1
- [superagent](https://npm.io/package/superagent.md) 3.5.2

## Recent versions

- 1.0.0 (latest) — 2019-01-08

## README

# vxc_services_api

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

- API version: 1.0.0
- Package version: 1.0.0
- 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 vxc_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:

```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 vxc_services_api from, and run:

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

You should now be able to `require('vxc_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:

```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 VxcServicesApi = require('vxc_services_api');

var defaultClient = VxcServicesApi.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 VxcServicesApi.BrickFTPApi()

var opts = { 
  'xApiKey': "xApiKey_example", // {String} the AutoTec assigned authentication credential for the calling customer
  'xAutotecId': "xAutotecId_example" // {String} the AutoTec assigned identification id for the calling customer
};

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

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*VxcServicesApi.BrickFTPApi* | [**brickftp**](docs/BrickFTPApi.md#brickftp) | **GET** /webhook/brickftp/vxc | Webhook for VXC BrickFTP implementations
*VxcServicesApi.DefaultApi* | [**vehicleFinancialPortfolioAddOptions**](docs/DefaultApi.md#vehicleFinancialPortfolioAddOptions) | **OPTIONS** /vehicle/financial/portfolio/add | 
*VxcServicesApi.DefaultApi* | [**vehicleFinancialPortfolioAlertsOptions**](docs/DefaultApi.md#vehicleFinancialPortfolioAlertsOptions) | **OPTIONS** /vehicle/financial/portfolio/alerts | 
*VxcServicesApi.DefaultApi* | [**vehicleFinancialPortfolioRemoveOptions**](docs/DefaultApi.md#vehicleFinancialPortfolioRemoveOptions) | **OPTIONS** /vehicle/financial/portfolio/remove | 
*VxcServicesApi.DefaultApi* | [**webhookBrickftpVxcOptions**](docs/DefaultApi.md#webhookBrickftpVxcOptions) | **OPTIONS** /webhook/brickftp/vxc | 
*VxcServicesApi.VehicleFinanceApi* | [**addFinancialPortfolio**](docs/VehicleFinanceApi.md#addFinancialPortfolio) | **POST** /vehicle/financial/portfolio/add | Add financial portfolios
*VxcServicesApi.VehicleFinanceApi* | [**financialPortfolioAlerts**](docs/VehicleFinanceApi.md#financialPortfolioAlerts) | **GET** /vehicle/financial/portfolio/alerts | Retrieve financial portfolio alerts
*VxcServicesApi.VehicleFinanceApi* | [**removeFinancialPortfolio**](docs/VehicleFinanceApi.md#removeFinancialPortfolio) | **POST** /vehicle/financial/portfolio/remove | Remove financial portfolios


## Documentation for Models

 - [VxcServicesApi.Empty](docs/Empty.md)
 - [VxcServicesApi.FinancialPortfolioAddRequest](docs/FinancialPortfolioAddRequest.md)
 - [VxcServicesApi.FinancialPortfolioRequest](docs/FinancialPortfolioRequest.md)
 - [VxcServicesApi.FinancialPortfolioResponse](docs/FinancialPortfolioResponse.md)
 - [VxcServicesApi.FinancialPortfolioResponseErrors](docs/FinancialPortfolioResponseErrors.md)
 - [VxcServicesApi.Request](docs/Request.md)
 - [VxcServicesApi.Request1](docs/Request1.md)
 - [VxcServicesApi.VehicleFinanceDealer](docs/VehicleFinanceDealer.md)
 - [VxcServicesApi.VehicleFinanceDetails](docs/VehicleFinanceDetails.md)
 - [VxcServicesApi.VehicleFinanceLocation](docs/VehicleFinanceLocation.md)
 - [VxcServicesApi.VehicleFinanceOdometer](docs/VehicleFinanceOdometer.md)
 - [VxcServicesApi.VehicleFinancePortfolio](docs/VehicleFinancePortfolio.md)
 - [VxcServicesApi.VehicleFinanceRecord](docs/VehicleFinanceRecord.md)
 - [VxcServicesApi.VehiclefinancialportfolioremoveRecords](docs/VehiclefinancialportfolioremoveRecords.md)


## 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

---
_Source: https://npm.io/package/vxc_api_js_client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._