enable_x
v1.0.0
Published
enablex api
Downloads
5
Readme
enable_x
EnableX - JavaScript client for enable_x No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) 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 enable_x --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 enable_x from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('enable_x')
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/enable_x then install it via:
npm install YOUR_USERNAME/enable_x --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 EnableX = require('enable_x');
var defaultClient = EnableX.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new EnableX.CallsApi()
var body = new EnableX.Call(); // {Call} Call object to make an outbound call
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.makeCall(body, callback);
Documentation for API Endpoints
All URIs are relative to https://api.enablex.io
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EnableX.CallsApi | makeCall | POST /voice/v1/calls | Make an outbound call
Documentation for Models
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication