pip-clients-smssettings-node

Node.js client sdk for pip-services-smssettings microservice

Usage no npm install needed!

<script type="module">
  import pipClientsSmssettingsNode from 'https://cdn.skypack.dev/pip-clients-smssettings-node';
</script>

README

Sms Settings Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-smssettings microservice. It provides an easy to use abstraction over communication protocols:

  • HTTP client
  • Seneca client (see http://www.senecajs.org)
  • Direct client for monolythic deployments
  • Null client to be used in testing
  • Memory client to be used in testing

Quick Links:

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-smssettings-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-smssettings-node');

Define client configuration parameters.

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.SmsSettingsHttpClient(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Send sms message to address
client.sendMessage(
    null,
    { 
        to: 'somebody@somewhere.com',
        subject: 'Test',
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);

// Send sms message to users
client.sendMessageToRecipients(
    null,
    [
        { id: '123' },
        { id: '321' }
    ],
    'test',
    { 
        subject: 'Test',
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.