1.1.2 • Published 6 years ago

pho-js-client v1.1.2

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
6 years ago

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

ClassMethodHTTP requestDescription
phonetworks.DefaultApiaddAttributePOST /{uuid}/attribute/{key}updates (or creates) an attribute
phonetworks.DefaultApidelAttributeDELETE /{uuid}/attribute/{key}deletes an attribute
phonetworks.DefaultApidelEntityDELETE /{uuid}deletes an entity
phonetworks.DefaultApigetAllEdgesGET /{uuid}/edges/allretrieves the edges of a node
phonetworks.DefaultApigetAttributeGET /{uuid}/attribute/{key}retrieves the value of an entity attribute
phonetworks.DefaultApigetAttributesGET /{uuid}/attributesretrieves the existing attribute keys of an entity (edge or node)
phonetworks.DefaultApigetEdgeGET /edge/{uuid}retrieves an edge
phonetworks.DefaultApigetEdgeGettersGET /{uuid}/edges/gettersretrieves the edge getter methods of a node
phonetworks.DefaultApigetEdgeSettersGET /{uuid}/edges/settersretrieves the edge setter methods of a node
phonetworks.DefaultApigetFounderGET /founderretrieves the Graph Founder
phonetworks.DefaultApigetGraphGET /graphretrieves the main Graph
phonetworks.DefaultApigetIncomingEdgesGET /{uuid}/edges/inretrieves the incoming edges of a node
phonetworks.DefaultApigetNodeGET /{uuid}retrieves a node
phonetworks.DefaultApigetNodeEdgeGET /{uuid}/{edge}edge getter
phonetworks.DefaultApigetOutgoingEdgesGET /{uuid}/edges/outretrieves the outgoing edges of a node
phonetworks.DefaultApigetSpaceGET /spaceretrieves the Space
phonetworks.DefaultApigetTypeGET /{uuid}/typefetches entity type
phonetworks.DefaultApimakeActorPOST /actorcreates an Actor object
phonetworks.DefaultApimakeEdgePOST /{uuid}/{edge}creates an edge
phonetworks.DefaultApisetAttributePUT /{uuid}/attribute/{key}updates (or creates) an attribute

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.