magfa-sdk

MagFa JavaScript SDK

MagFa is a SMS provider.

How to use this package

So, let's have a quick review of our steps.

• Installation
• Configuration
• Methods

Installation

To install MagFa SDK use npm command like below:

$ npm i magfa-sdk

Configuration

Now you installed package. You need to initial it. Just require it and use MagFa class with 3 values.

• username
• password
• domain

const MagFa = require("magfa-sdk");

const sms = new MagFa("username", "password", "domain");

Methods

This SDK has 3 main methods.

• balance
• messages
• send

Balance

Balance just return you how much money your account has.

const balance = await sms.balance();

if (balance.status === 0) {
  console.log({ balance: balance.balance });
} else {
  console.log({ message: sms.error(balance.status) });
}

Messages

To get input messages use this method.

const messages = await sms.messages();

if (messages.status === 0) {
  console.log(messages.messages);
} else {
  console.log({ message: sms.error(messages.status) });
}

Send

Now you want to send a message, or many messages. Ok, have fun with this method!

const recipients = ["09014784362", "09363158232"];
const messages = ["Hey", "Hi"];

const send = await sms.send(recipients, messages);

if (send.status === 0) {
  console.log(send.messages);
} else {
  console.log({ message: sms.error(send.status) });
}

Status

When you send a message, you will check that is message arrived or not or anything like this. So, use status method that return you the status of the message.

const status = await sms.status("120990667412");

if (status.status === 0) {
  console.log(status.dlrs);
} else {
  console.log({ message: sms.error(status.status) });
}

Error

Magfa has some errors and we created an error method that get code from you and return the message.

const message = sms.error("status code");

Development

If you want to develop the package, it is so simple. just follow steps below.

• Clone the project
• Install dependencies by running $ npm install
• Start changing!
  • Link package
  • Test

Before you start: **Remember the base or code are stored in lib/magfa.js. You need to edit there.

Cloning the project

To clone the project, you need to have git installed. Ok, now clone it same as command below.

$ git clone https://gitlab.com/BlackIQ/magfa-sdk

installing dependencies

Next, install what package uses with npm i or npm install.

$ npm i

Changing

To change package or anything, your need a testing environment to use linked package. Just follow steps.

Link package

We asoume you are in lib directory. Right. You can open a tmux or in another terminal to cd in test directory.

In lib directory enter link command:

$ npm link

So, in other terminal, or other tmux part, link your development package to your test directory. If you are in the test directory ok, if not, just say cd test and enter the linking command:

$ npm link magfa-sdk

Linking step is done.

Test

Your test app is linked. Change anything in package and test it in test directory.

Change log

Version 2.2.1

• Added status method.
• Added error method.
• Added new functionalities.
• Clean code and better architect.
• Using Async/Await methods.