transmitsms_sdk v1.0.3
transmitsms_sdk
TransmitsmsSdk - JavaScript client for transmitsms_sdk all current transmitsms api available in the api docs This SDK is automatically generated by the Swagger Codegen project:
- API version:
- 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 transmitsms_sdk --save
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):
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 TransmitsmsSdk = require('transmitsms_sdk');
var defaultClient = TransmitsmsSdk.ApiClient.instance;
// Configure HTTP basic authorization: c51ed49bcbec114ad42239009538e8ff
var c51ed49bcbec114ad42239009538e8ff = defaultClient.authentications['c51ed49bcbec114ad42239009538e8ff'];
c51ed49bcbec114ad42239009538e8ff.username = 'YOUR USERNAME'
c51ed49bcbec114ad42239009538e8ff.password = 'YOUR PASSWORD'
var api = new TransmitsmsSdk.NumbersApi()
var opts = {
'filter': "filter_example", // {String}
'page': 3.4, // {Number}
'max': 3.4 // {Number}
};
api.getNumbers(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://api.stage.aws.burstage.com
Class | Method | HTTP request | Description |
---|---|---|---|
TransmitsmsSdk.NumbersApi | getNumbers | GET /get-numbers.json | get_numbers |
TransmitsmsSdk.NumbersApi | getSenderIds | GET /get-sender-ids.json | get_sender_ids |
TransmitsmsSdk.SMSApi | getSmsResponses | GET /get-sms-responses.json | get_sms_responses |
TransmitsmsSdk.SMSApi | getSmsStats | GET /get-sms-stats.json | get_sms_stats |
TransmitsmsSdk.SMSApi | sendSms | GET /send-sms.json | send_sms |
Documentation for Models
- TransmitsmsSdk.InlineResponse200
- TransmitsmsSdk.InlineResponse2001
- TransmitsmsSdk.InlineResponse2001Stats
- TransmitsmsSdk.InlineResponse2002
- TransmitsmsSdk.InlineResponse2002Page
- TransmitsmsSdk.InlineResponse2002Responses
- TransmitsmsSdk.InlineResponse2003
- TransmitsmsSdk.InlineResponse2003Result
- TransmitsmsSdk.InlineResponse2003ResultCallerIds
- TransmitsmsSdk.InlineResponse2004
- TransmitsmsSdk.InlineResponse2004Numbers
- TransmitsmsSdk.InlineResponse200DeliveryStats
- TransmitsmsSdk.InlineResponse200Error
- TransmitsmsSdk.InlineResponse400
- TransmitsmsSdk.InlineResponse4001
- TransmitsmsSdk.InlineResponse400Error
- TransmitsmsSdk.InlineResponse400ErrorDescription
Documentation for Authorization
c51ed49bcbec114ad42239009538e8ff
- Type: HTTP basic authentication