webconfig_api v0.0.4

webconfig_api

WebconfigApi - JavaScript client for webconfig_api Webconfig API description This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.4
• Package version: 0.0.4
• Build package: org.openapitools.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 webconfig_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your webconfig_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 WebconfigApi = require('webconfig_api');


var api = new WebconfigApi.AuthenticationApi()
var user = "user_example"; // {String} The username to authenticate with.
var pass = "pass_example"; // {String} The password corresponding to the username.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(user, pass, callback);

Documentation for API Endpoints

All URIs are relative to /api/v1

Documentation for Models

• WebconfigApi.ChargingInfo
• WebconfigApi.Dtc
• WebconfigApi.DtcFreezeframe
• WebconfigApi.Dtcs
• WebconfigApi.Login200Response
• WebconfigApi.ServerSentEventsMessage
• WebconfigApi.ServerSentEventsMessageData
• WebconfigApi.SoftwareInfo
• WebconfigApi.SoftwareUpdateState
• WebconfigApi.SystemInfo
• WebconfigApi.SystemInfoPartsInner

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)