@nabcellent/wasiliana v0.3.0

Wasiliana Api

This is a Typescript package that interfaces with the Wasiliana Api. The API enables you to initiate mobile SMS notifications.

Documentation

Installation

You can install the package via yarn or npm:

yarn add @nabcellent/wasiliana

npm i @nabcellent/wasiliana

Getting Started

Initialize the Wasiliana class with your config.

import { Wasiliana, WasilianaConfig } from '@nabcellent/wasiliana';

let config: WasilianaConfig = {
    apiKey   : process.env.WASILIANA_SMS_API_KEY,
    senderId : process.env.WASILIANA_SMS_SENDER_ID
};

const wasiliana = new Wasiliana(config);

• Sms

  Enables you to send text messages

1. Send Sms

const response = await wasiliana.sms.text('#WasilianaTest').to(254123456789).send()
    //  OR
const response = await wasiliana.sms.text('#WasilianaTest').to([254123456789]).send()

//  Expected responses

//  --  SUCCESS
{
    status: 'success',
    data: 'Successfully Dispatched the sms to process'
}

//  --  FAILED
{
    status: 'failed',
    data: 'App does not match your api key'
}
OR
{
    status: 'failed',
    data: 'Wrong sender id sent'
}
OR
{
    status: 'failed',
    data: 'Short code does not exist'
}
OR
{
    status: 'failed',
    data: 'App does not exist'
}
OR
{
    status: 'failed',
    data: 'ApiKey must be present in the header'
}

2. Calculate SMS Cost

Provide the text message.

const response = wasiliana.sms.cost('Hello World.')

//  Expected response(number)
0.2

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email nabcellent.dev@gmail.com instead of using the issue tracker.

Credits

• Nabcellent

comment: <> (- All Contributors(../../contributors))

License

The MIT License (MIT). Please see License File for more information.