Nozomi_api NPM

nozomi_api

NozomiApi - JavaScript client for nozomi_api

This SDK is automatically generated by the Swagger Codegen project:

API version: 5
Package version: 5
Build package: io.swagger.codegen.v3.generators.javascript.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 nozomi_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/nozomi-ai/nozomi.js then install it via:

    npm install nozomi-ai/nozomi.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.

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 NozomiApi = require('nozomi_api');
var defaultClient = NozomiApi.ApiClient.instance;

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

var api = new NozomiApi.ComponentApi()
var opts = { 
  'requestGuid': "requestGuid_example", // {String} The unique identifier of the request that contains this component.
  'index': 0 // {Number} The 'page' of the list of results in 100s
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.componentAllGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.nozomi.ai

Class	Method	HTTP request	Description
NozomiApi.ComponentApi	componentAllGet	GET /Component/All	Obtain all components you have created.
NozomiApi.ComponentApi	componentCreatePost	POST /Component/Create	Create a component.
NozomiApi.ComponentApi	componentDeleteDelete	DELETE /Component/Delete	Delete a component.
NozomiApi.ComponentApi	componentGetGuidGet	GET /Component/Get/{guid}	Obtain the component and its historical values.
NozomiApi.ComponentApi	componentUpdatePut	PUT /Component/Update	Update a component.
NozomiApi.ComponentHistoricItemApi	componentHistoricItemAllComponentGuidGet	GET /ComponentHistoricItem/All/{componentGuid}	Obtain all the component historical values created
NozomiApi.ComponentTypeApi	componentTypeAllGet	GET /ComponentType/All	Obtain all of the component types that are publicly available or the ones that you own.
NozomiApi.ComputeApi	computeAllIndexGet	GET /Compute/All/{index}	Obtains all of the relevant computes you own.
NozomiApi.ComputeApi	computeGetGuidGet	GET /Compute/Get/{guid}	Obtains the specific compute.
NozomiApi.ComputeExpressionApi	computeExpressionAllIndexGet	GET /ComputeExpression/All/{index}	Obtains all of the relevant compute expressions you own.
NozomiApi.ComputeExpressionApi	computeExpressionGetGuidGet	GET /ComputeExpression/Get/{guid}	Obtains the specific compute expression.
NozomiApi.ComputeValueApi	computeValueAllIndexGet	GET /ComputeValue/All/{index}	Obtain all compute value generated.
NozomiApi.ComputeValueApi	computeValueGetGuidGet	GET /ComputeValue/Get/{guid}	Obtain the compute value specified.
NozomiApi.ComputeValueApi	computeValueLastComputeGuidGet	GET /ComputeValue/Last/{computeGuid}	Obtain the last compute value of the compute in question.
NozomiApi.ConnectApi	connectValidateHead	HEAD /Connect/Validate	Allows the client to validate his API key.
NozomiApi.ItemApi	itemAllIndexGet	GET /Item/All/{index}	Obtains all of the relevant items you own.
NozomiApi.ItemApi	itemCreatePost	POST /Item/Create	Create an item.
NozomiApi.ItemApi	itemExistsSlugGet	GET /Item/Exists/{slug}	Validates if the slug is being used.
NozomiApi.ItemApi	itemGetBySlugSlugGet	GET /Item/GetBySlug/{slug}	Obtains the specified item.
NozomiApi.ItemApi	itemGetItemGuidGet	GET /Item/Get/{itemGuid}	Obtains the specified item.
NozomiApi.ItemApi	itemUpdatePut	PUT /Item/Update	Update the specified item.
NozomiApi.RequestApi	requestAllGet	GET /Request/All	Retrieves all requests owned by the stated user with a pagination of 100 items.
NozomiApi.RequestApi	requestCreatePost	POST /Request/Create	Create a request.
NozomiApi.RequestApi	requestDeleteGuidDelete	DELETE /Request/Delete/{guid}	Delete a request.
NozomiApi.RequestApi	requestGetGuidGet	GET /Request/Get/{guid}	Retrieves the request with the mentioned guid.
NozomiApi.RequestApi	requestUpdatePut	PUT /Request/Update	Update a request.
NozomiApi.RequestPropertyApi	requestPropertyAllByRequestGet	GET /RequestProperty/AllByRequest	Obtain all analysed components you have created, relative to that specific request.
NozomiApi.RequestPropertyApi	requestPropertyAllGet	GET /RequestProperty/All	Obtain all request properties you have created/own.
NozomiApi.RequestPropertyApi	requestPropertyCreatePost	POST /RequestProperty/Create	Create a request property.
NozomiApi.RequestPropertyApi	requestPropertyDeleteGuidDelete	DELETE /RequestProperty/Delete/{guid}	Delete a request property
NozomiApi.RequestPropertyApi	requestPropertyUpdatePut	PUT /RequestProperty/Update	Update a request property.
NozomiApi.SubComputeApi	subComputeAllByChildChildComputeGuidGet	GET /SubCompute/AllByChild/{childComputeGuid}	Obtains all of the relevant parent computes the child compute has.
NozomiApi.SubComputeApi	subComputeAllByParentParentComputeGuidGet	GET /SubCompute/AllByParent/{parentComputeGuid}	Obtains all of the relevant child computes the parent compute has.
NozomiApi.SubComputeApi	subComputeAllIndexGet	GET /SubCompute/All/{index}	Obtains all of the relevant Sub Computes you own.
NozomiApi.SubComputeApi	subComputeGetGet	GET /SubCompute/Get	Obtains the specific sub compute.
NozomiApi.WebsocketCommandApi	websocketCommandAllByRequestGet	GET /WebsocketCommand/AllByRequest	Obtain all of the websocket commands created, relative to the request.
NozomiApi.WebsocketCommandApi	websocketCommandAllGet	GET /WebsocketCommand/All	Obtain all websocket commands you have created/own.
NozomiApi.WebsocketCommandPropertyApi	websocketCommandPropertyAllByCommandGet	GET /WebsocketCommandProperty/AllByCommand	Retrieves all websocket command properties relevant to its parent command.
NozomiApi.WebsocketCommandPropertyApi	websocketCommandPropertyAllGet	GET /WebsocketCommandProperty/All	Retrieves all websocket command properties owned by the stated user with a pagination of 1000 items.

Documentation for Models

Documentation for Authorization

API Key

Type: API key
API key parameter name: X-Api-Key
Location: HTTP header

babel babel-cli superagent

@infinitebrahmanuniverse/nolb-noz @everything-registry/sub-chunk-2336

1.0.0

3 years ago