# sendpk-sms-client

> This package provides a simple and efficient client for sending SMS messages via the send.pk SMS service provider in Pakistan.

Latest version **1.2.0** (published 2023-04-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install sendpk-sms-client
pnpm add sendpk-sms-client
yarn add sendpk-sms-client
bun add sendpk-sms-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2023-04-07 |
| First published | 2023-03-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Faisal Jan |
| Maintainers | faisaljan |
| Keywords | send.pk, sms, api, messaging, pakistan, marketing, nodejs, mobile |

## Links

- npm: https://www.npmjs.com/package/sendpk-sms-client
- Repository: https://github.com/FaisaljanBaloch/sendpk-sms-client
- Issues: https://github.com/FaisaljanBaloch/sendpk-sms-client/issues
- npm.io page: https://npm.io/package/sendpk-sms-client

## Dependencies (2)

- [eslint](https://npm.io/package/eslint.md) ^8.36.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.1

## Recent versions

- 1.2.0 (latest) — 2023-04-07
- 1.1.0 — 2023-03-27
- 1.0.1 — 2023-03-26
- 1.0.0 — 2023-03-26

## README

# SendPK SMS Client
This package provides a simple and efficient client for sending SMS messages via the [Send.pk](https://sendpk.com/) SMS service provider in Pakistan.

## Installation
You must have Nodejs v8.0.0 or higher and NPM package manager.
```sh
npm install sendpk-sms-client
```

## Loading and Configuring the module
### ES Modules (ESM)

```js
import { SMSClient } from "sendpk-sms-client"
const client = new SMSClient("Your API KEY", "BrandName");
```
### CommonJS
If you are still using `require()` to import you modules.

```js
const { SMSClient } = require("sendpk-sms-client");
const client = new SMSClient("Your API KEY", "BrandName");
```

## Documentation
The Basic Usage
* [Send a message](https://github.com/FaisaljanBaloch/sendpk-sms-client/blob/main/docs/basic_usage.md#send-a-message)
* [Check balance/points](https://github.com/FaisaljanBaloch/sendpk-sms-client/blob/main/docs/basic_usage.md#check-balance)

## Contribution
Unfortunately, the project doesn't follow any contribution template. So, It means you can easily work on an issue or create a new issue (if doesn't already exist), fix issue and create a pull request (PR).

**Note**
Make a separate branch and name identical of your branches to any issue you solved. Every contribution you make will be highly appreciated by us!

## Author
This project was founded by **Faisal Jan**. A student and a developer who loves to create software programs that help any individual or organization.
* You can follow him on [Twitter](https://twitter.com/justFaisaljan)

> Thank you, And have a nice day!

---
_Source: https://npm.io/package/sendpk-sms-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._