the_sms_works_api

TheSmsWorksApi - JavaScript client for the_sms_works_api The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed UK messages are refunded. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.9.0
• Package version: 1.9.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://thesmsworks.co.uk/contact

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 the_sms_works_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your the_sms_works_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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.

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 TheSmsWorksApi = require('the_sms_works_api');

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

var api = new TheSmsWorksApi.BatchMessagesApi()
var messages = {key: null}; // {Object} An array of messages
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchAnyPost(messages, callback);

Documentation for API Endpoints

All URIs are relative to https://api.thesmsworks.co.uk/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TheSmsWorksApi.BatchMessagesApi | batchAnyPost | POST /batch/any | TheSmsWorksApi.BatchMessagesApi | batchBatchidGet | GET /batch/{batchid} | TheSmsWorksApi.BatchMessagesApi | batchSchedulePost | POST /batch/schedule | TheSmsWorksApi.BatchMessagesApi | batchSendPost | POST /batch/send | TheSmsWorksApi.BatchMessagesApi | batchesScheduleBatchidDelete | DELETE /batches/schedule/{batchid} | TheSmsWorksApi.CreditsApi | creditsBalanceGet | GET /credits/balance | TheSmsWorksApi.MessagesApi | messageSchedulePost | POST /message/schedule | TheSmsWorksApi.MessagesApi | messageSendPost | POST /message/send | TheSmsWorksApi.MessagesApi | messagesFailedPost | POST /messages/failed | TheSmsWorksApi.MessagesApi | messagesInboxPost | POST /messages/inbox | TheSmsWorksApi.MessagesApi | messagesMessageidDelete | DELETE /messages/{messageid} | TheSmsWorksApi.MessagesApi | messagesMessageidGet | GET /messages/{messageid} | TheSmsWorksApi.MessagesApi | messagesPost | POST /messages | TheSmsWorksApi.MessagesApi | messagesScheduleGet | GET /messages/schedule | TheSmsWorksApi.MessagesApi | messagesScheduleMessageidDelete | DELETE /messages/schedule/{messageid} | TheSmsWorksApi.MessagesApi | sendFlashMessage | POST /message/flash | TheSmsWorksApi.OneTimePasswordApi | otpMessageidGet | GET /otp/{messageid} | TheSmsWorksApi.OneTimePasswordApi | otpSendPost | POST /otp/send | TheSmsWorksApi.OneTimePasswordApi | otpVerifyPost | POST /otp/verify | TheSmsWorksApi.UtilsApi | utilsErrorsErrorcodeGet | GET /utils/errors/{errorcode} | TheSmsWorksApi.UtilsApi | utilsTestGet | GET /utils/test |

Documentation for Models

• TheSmsWorksApi.BatchMessage
• TheSmsWorksApi.BatchMessageResponse
• TheSmsWorksApi.CancelledMessageResponse
• TheSmsWorksApi.CreditsResponse
• TheSmsWorksApi.DeletedMessageResponse
• TheSmsWorksApi.ErrorModel
• TheSmsWorksApi.ExtendedErrorModel
• TheSmsWorksApi.Message
• TheSmsWorksApi.MessageMetadata
• TheSmsWorksApi.MessageResponse
• TheSmsWorksApi.MessageResponseFailurereason
• TheSmsWorksApi.MetaData
• TheSmsWorksApi.OTP
• TheSmsWorksApi.OTPResponse
• TheSmsWorksApi.OTPVerify
• TheSmsWorksApi.OTPVerifyResponse
• TheSmsWorksApi.Query
• TheSmsWorksApi.QueryMetadata
• TheSmsWorksApi.ScheduledBatchResponse
• TheSmsWorksApi.ScheduledMessage
• TheSmsWorksApi.ScheduledMessageResponse
• TheSmsWorksApi.ScheduledMessagesResponse
• TheSmsWorksApi.ScheduledMessagesResponseMessage
• TheSmsWorksApi.SendMessageResponse
• TheSmsWorksApi.TestResponse

Documentation for Authorization

Authentication schemes defined for the API:

JWT

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