WinSMS - JavaScript Client

• API version: 1.0.0
• Package version: 1.0.0

For more information, please visit http://support.winsms.co.za/

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 winsms --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 winsms from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('winsms') 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/winsms then install it via:

    npm install YOUR_USERNAME/winsms --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 Winsms = require('winsms');

var defaultClient = Winsms.ApiClient.instance;

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

var api = new Winsms.CreditsApi()

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

Documentation for API Endpoints

All URIs are relative to https://www.winsms.co.za/api/rest/v1

Documentation for Models

• Winsms.CreditBalanceResponse
• Winsms.CreditTransferDetails
• Winsms.CreditTransferResponse
• Winsms.DeleteScheduledResponse
• Winsms.DeletedMessageStatus
• Winsms.ErrorDetails
• Winsms.IncomingMessage
• Winsms.IncomingMessageResponse
• Winsms.IncomingOptoutMessage
• Winsms.MessageRecipientDetails
• Winsms.MessageRecipientResponse
• Winsms.MessageStatus
• Winsms.MessageStatusResponse
• Winsms.NewMessageDetails
• Winsms.NewMessageResponse
• Winsms.OptoutMessageResponse
• Winsms.ScheduledMessage
• Winsms.ScheduledMessageResponse
• Winsms.ShortcodeMessage
• Winsms.ShortcodeMessageResponse
• Winsms.SubAccount
• Winsms.SubAccountsResponse

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: AUTHORIZATION
• Location: HTTP header