pho-js-client

phonetworks - JavaScript client for pho-js-client Pho Networks REST API This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1.1
• Package version: 1.1.1
• Build package: class 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 pho-js-client --save

git

    npm install https://github.com/pho-clients/js --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.

Getting Started

Please follow the installation instruction and execute the following JS code:

var phonetworks = require('pho-js-client');

var api = new phonetworks.DefaultApi()

var opts = { 
  'value': "value_example" // {String} The value to update the key with.
};

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

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0

Class	Method	HTTP request	Description
phonetworks.DefaultApi	addAttribute	POST /{uuid}/attribute/{key}	updates (or creates) an attribute
phonetworks.DefaultApi	delAttribute	DELETE /{uuid}/attribute/{key}	deletes an attribute
phonetworks.DefaultApi	delEntity	DELETE /{uuid}	deletes an entity
phonetworks.DefaultApi	getAllEdges	GET /{uuid}/edges/all	retrieves the edges of a node
phonetworks.DefaultApi	getAttribute	GET /{uuid}/attribute/{key}	retrieves the value of an entity attribute
phonetworks.DefaultApi	getAttributes	GET /{uuid}/attributes	retrieves the existing attribute keys of an entity (edge or node)
phonetworks.DefaultApi	getEdge	GET /edge/{uuid}	retrieves an edge
phonetworks.DefaultApi	getEdgeGetters	GET /{uuid}/edges/getters	retrieves the edge getter methods of a node
phonetworks.DefaultApi	getEdgeSetters	GET /{uuid}/edges/setters	retrieves the edge setter methods of a node
phonetworks.DefaultApi	getFounder	GET /founder	retrieves the Graph Founder
phonetworks.DefaultApi	getGraph	GET /graph	retrieves the main Graph
phonetworks.DefaultApi	getIncomingEdges	GET /{uuid}/edges/in	retrieves the incoming edges of a node
phonetworks.DefaultApi	getNode	GET /{uuid}	retrieves a node
phonetworks.DefaultApi	getNodeEdge	GET /{uuid}/{edge}	edge getter
phonetworks.DefaultApi	getOutgoingEdges	GET /{uuid}/edges/out	retrieves the outgoing edges of a node
phonetworks.DefaultApi	getSpace	GET /space	retrieves the Space
phonetworks.DefaultApi	getType	GET /{uuid}/type	fetches entity type
phonetworks.DefaultApi	makeActor	POST /actor	creates an Actor object
phonetworks.DefaultApi	makeEdge	POST /{uuid}/{edge}	creates an edge
phonetworks.DefaultApi	setAttribute	PUT /{uuid}/attribute/{key}	updates (or creates) an attribute

Documentation for Models

• phonetworks.Edge
• phonetworks.InlineResponse200
• phonetworks.InlineResponse2001
• phonetworks.InlineResponse2002
• phonetworks.InlineResponse2003
• phonetworks.InlineResponse2003In
• phonetworks.InlineResponse2004
• phonetworks.Node
• phonetworks.NodeEdge

Documentation for Authorization

All endpoints do not require authorization.