README

vasp_gateway

VaspGateway - JavaScript client for vasp_gateway The interaction a VASP's HTTP client would have with the Bulletin Board web-server or another VASP This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.0.1
Package version: 0.0.1
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 vasp_gateway --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 vasp_gateway 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 VaspGateway = require('vasp_gateway');


var api = new VaspGateway.BaseP2pApi()
var txClaim = new VaspGateway.TxClaim(); // {TxClaim} 
api.claimAddress(txClaim).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
VaspGateway.BaseP2pApi	claimAddress	POST /claim	To be used by VASPs to claim an address
VaspGateway.BaseP2pApi	sendPii	POST /pii	To be used by VASPs to send PII to another VASP
VaspGateway.DefaultApi	getTransaction	GET /transactions/{eventUuid}	To be used by VASP(S) to retrieve information about a specific transaction
VaspGateway.DefaultApi	getTransactions	GET /transactions	To be used by VASP(R) to retrieve transactions awaiting PII
VaspGateway.DefaultApi	getVaspInfo	GET /vasps/{vaspUuid}	To be used by VASPs to get information about other VASPs’ PII and claim endpoints
VaspGateway.DefaultApi	postTransaction	POST /transactions	To be used by VASP(S) to post eligible transactions

Documentation for Models

Documentation for Authorization

BulletinBoardAuth

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

vasp-gateway

Usage no npm install needed!