sms_api

SmsApi - JavaScript client for sms_api sms API documentation This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.1
• 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 sms_api --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 sms_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('sms_api') 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 SmsApi = require('sms_api');

var api = new SmsApi.MessageresourceApi()

var messageDTO = new SmsApi.MessageDTO(); // {MessageDTO} messageDTO


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

Documentation for API Endpoints

All URIs are relative to https://dev.eyun.online:8079/sms

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SmsApi.MessageresourceApi | createMessageUsingPOST | POST /api/messages | createMessage SmsApi.MessageresourceApi | deleteMessageUsingDELETE | DELETE /api/messages/{id} | deleteMessage SmsApi.MessageresourceApi | getAllMessagesUsingGET | GET /api/messages | getAllMessages SmsApi.MessageresourceApi | getMessageUsingGET | GET /api/messages/{id} | getMessage SmsApi.MessageresourceApi | updateMessageUsingPUT | PUT /api/messages | updateMessage SmsApi.ProfileinforesourceApi | getActiveProfilesUsingGET | GET /api/profile-info | getActiveProfiles SmsApi.SourceresourceApi | createSourceUsingPOST | POST /api/sources | createSource SmsApi.SourceresourceApi | deleteSourceUsingDELETE | DELETE /api/sources/{id} | deleteSource SmsApi.SourceresourceApi | getAllSourcesUsingGET | GET /api/sources | getAllSources SmsApi.SourceresourceApi | getSourceUsingGET | GET /api/sources/{id} | getSource SmsApi.SourceresourceApi | updateSourceUsingPUT | PUT /api/sources | updateSource

Documentation for Models

• SmsApi.MessageDTO
• SmsApi.ProfileInfoVM
• SmsApi.SourceDTO

Documentation for Authorization

All endpoints do not require authorization.