twine

Twine - JavaScript client for twine Twine server REST Api definition This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.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 twine --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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your twine from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('twine') 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/YOUR_USERNAME/twine then install it via:

    npm install YOUR_USERNAME/twine --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, that's to say your javascript file where you actually use this library):

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 Twine = require('twine');

var defaultClient = Twine.ApiClient.instance;

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

var api = new Twine.NodesApi()

var nodeId = "nodeId_example"; // {String} ID of node to delete


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

Documentation for API Endpoints

All URIs are relative to http://0.0.0.0:4000

Class	Method	HTTP request	Description
Twine.NodesApi	deleteNode	DELETE /nodes/{nodeId}	Delete node by ID
Twine.NodesApi	getNode	GET /nodes/{nodeId}	Find node by ID
Twine.NodesApi	getNodes	GET /nodes	Get list of registered nodes
Twine.NodesApi	registerNode	POST /nodes	Register a new node
Twine.NodesApi	updateNode	PATCH /nodes/{nodeId}	Patch node by ID
Twine.ServersApi	deleteServer	DELETE /servers/{serverId}	Delete server by ID
Twine.ServersApi	getServer	GET /servers/{serverId}	Find server by ID
Twine.ServersApi	getServers	GET /servers	Get list of available servers
Twine.ServersApi	registerServer	POST /servers	Register a new server
Twine.ServersApi	updateServer	PATCH /servers/{serverId}	Patch server by ID

Documentation for Models

• Twine.Error
• Twine.Node
• Twine.OK
• Twine.Registered
• Twine.Server

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header