frac_tel_api_212 v2.1.2
frac_tel_api_212
FracTelApi212 - JavaScript client for frac_tel_api_212 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: 2.1.2
- Package version: 2.1.2
- 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 frac_tel_api_212 --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 frac_tel_api_212 from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('frac_tel_api_212')
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 FracTelApi212 = require('frac_tel_api_212');
var api = new FracTelApi212.AuthApi()
var username = "username_example"; // {String} FracTEL username
var password = "password_example"; // {String} FracTEL password
var opts = {
'expires': 56 // {Number} FracTEL Token Life Time in Seconds | Default is 3600 seconds | Maximum is 24 hours
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.postAuth(username, password, opts, callback);
Documentation for API Endpoints
All URIs are relative to http://api.fonestorm.com/v2
Class | Method | HTTP request | Description |
---|---|---|---|
FracTelApi212.AuthApi | postAuth | POST /auth | Obtain a FracTEL Auth token. |
FracTelApi212.FonenumbersApi | deleteFonenumbersFonenumber | DELETE /fonenumbers/{fonenumber} | Remove fonenumber from the account. |
FracTelApi212.FonenumbersApi | getFonenumbers | GET /fonenumbers | Get all active fonenumbers listed under the account. |
FracTelApi212.FonenumbersApi | getFonenumbersFonenumber | GET /fonenumbers/{fonenumber} | Get a single fonenumber listed under the account. |
FracTelApi212.FonenumbersApi | postFonenumbers | POST /fonenumbers | Order quick fonenumber for the account. |
FracTelApi212.FonenumbersApi | putFonenumbersFonenumber | PUT /fonenumbers/{fonenumber} | Configure the service type for an account fonenumber. |
FracTelApi212.MessagesApi | postMessagesReceive | POST /messages/receive | Configure the delivery service type used as the destination for received messages. |
FracTelApi212.MessagesApi | postMessagesReceiveNotify | POST /messages/receive_notify | Configure the callback URL to notify when a message is received. |
FracTelApi212.MessagesApi | postMessagesSend | POST /messages/send | Send an SMS or MMS message to a recipient. |
FracTelApi212.MessagesApi | postMessagesSendNotify | POST /messages/send_notify | Configure the callback URL to notify when a message is sent. |
Documentation for Models
Documentation for Authorization
jwt
- Type: API key
- API key parameter name: token
- Location: HTTP header
7 years ago