README.md

@lethean/sdp-apollo

@LetheanSdpApollo - JavaScript client for @lethean/sdp-apollo Functionality to simplify using LTHN This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.2
• Package version: 1.2.2
• Build package: org.openapitools.codegen.languages.JavascriptApolloClientCodegen For more information, please visit https://lt.hn

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 @lethean/sdp-apollo --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 @lethean/sdp-apollo 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/LetheanMovement/sdp-api-javascript-apollo then install it via:

    npm install LetheanMovement/sdp-api-javascript-apollo --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 @LetheanSdpApollo = require('@lethean/sdp-apollo');


var api = new @LetheanSdpApollo.VpnApi()
var dataDir = "dataDir_example"; // {String} Returns the binary version
var opts = {
  'version': true // {Boolean} Returns the binary version
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startLetheand(dataDir, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
@LetheanSdpApollo.VpnApi	startLetheand	GET /letheand/start

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.