Voice-sdk-api-client NPM

symblai_ap_is

SymblaiApIs - JavaScript client for symblai_ap_is

API version: 1.0
Package version: 1.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 symblai_ap_is --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 symblai_ap_is from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('symblai_ap_is') 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/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, 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 SymblaiApIs = require('symblai_ap_is');

var api = new SymblaiApIs.AuthenticationApi()

var body = new SymblaiApIs.Grant(); // {Grant} Authentication details for either password based authentication or app authentication


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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
SymblaiApIs.AuthenticationApi	generateToken	POST /oauth2/token:generate	Generates the token from the given credentials
SymblaiApIs.AuthenticationApi	refreshToken	POST /oauth2/token:refresh	Authenticate and refresh the current valid token
SymblaiApIs.AuthenticationApi	revokeToken	DELETE /oauth2/token:revoke	Revoke the given token
SymblaiApIs.ConnectionToEndpointApi	connectToEndpoint	POST /v1/endpoint:connect	Connect to your SIP or PSTN endpoint, and control the connection
SymblaiApIs.ExternalEventWebHookApi	externalEventWebHook	POST /v1/event/{connectionId}	WebHook for external events
SymblaiApIs.LanguageInsightsApi	generateInsights	POST /v1/insights	Generate insights from the given message in the request
SymblaiApIs.MetricApi	addMetricEntry	POST /v1/metric/{metricId}/entry	Add new Metric Entry
SymblaiApIs.MetricApi	getMetricById	GET /v1/metric/{metricId}	Retrieve Metric
SymblaiApIs.MetricEntryApi	addMetricEntry	POST /v1/metric/{metricId}/entry	Add new Metric Entry

Documentation for Models

Documentation for Authorization

jwt

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

symbl voice

1.0.0

6 years ago