# smsapipl

> Oficjalny klient JavaScript pozwalający na wysyłanie wiadomości SMS, MMS, VMS oraz zarządzanie kontem w serwisie SMSAPI.pl

Latest version **1.0.0** (published 2015-07-21) · Apache 2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install smsapipl
pnpm add smsapipl
yarn add smsapipl
bun add smsapipl
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-07-21 |
| First published | 2015-07-21 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Adrian Olczyk |
| Maintainers | smsapi |

## Links

- npm: https://www.npmjs.com/package/smsapipl
- npm.io page: https://npm.io/package/smsapipl

## Dependencies (5)

- [MD5](https://npm.io/package/MD5.md) ^1.2.2
- [rsvp](https://npm.io/package/rsvp.md) ^3.0.18
- [js-base64](https://npm.io/package/js-base64.md) ^2.1.8
- [superagent](https://npm.io/package/superagent.md) ^1.2.0
- [underscore](https://npm.io/package/underscore.md) ^1.8.3

## Recent versions

- 1.0.0 (latest) — 2015-07-21

## README

# SMSAPI JavaScript Client

Klient JavaScript pozwalający na wysyłanie wiadomości SMS, MMS, VMS oraz zarządzanie kontem w serwisie SMSAPI.pl

## Instalacja (node.js)

```bash

$ npm install smsapipl --save

```

## Przykład użycia

```javascript

var SMSAPI = require('smsapi'),
    smsapi = new SMSAPI();

smsapi.authentication
    .login('username', 'password')
    .then(sendEcoMessage)
    .then(displayResult)
    .catch(displayError);

function sendEcoMessage(){
    return smsapi.message
        .sms()
        .eco()
        .to('605xxxxxx')
        .test()
        .message('My first message!')
        .execute(); // return Promise
}

function displayResult(result){
    console.log(result);
}

function displayError(err){
    console.error(err);
}

```

# Dokumentacja

Dokumentacja interfejsu REST API znajduje się pod adresem [http://www.smsapi.pl/rest](http://www.smsapi.pl/rest).

Wszystkie odwołania do API zwracają obiekt `Promise` zgodny ze standardem [Promises/A+](https://promisesaplus.com). Użyta implementacja: https://github.com/tildeio/rsvp.js

## Dostępne operacje

* message
    * sms
    * mms
    * vms
* points
    * get
* sender
    * add
    * delete
    * status
    * default
    * list
* hlr
    * check
* user
    * add
    * delete
    * update
    * get
    * list
* phonebook (deprecated)
    * contact
        * add
        * get
        * update
        * list
        * delete
    * group
        * get
        * add
        * update
        * list
        * delete
* contacts
    * list
    * add
    * get
    * update
    * delete
    * fields
        * list
        * add
        * update
        * delete
    * groups
        * list
        * add
        * get
        * update
        * delete
        * assignments
            * list
            * add
            * get
            * delete
        * permissions
            * list
            * add
            * get
            * update
            * delete
        * members
            * add
            * get
            * delete

## Przykłady

Dodatkowe przykłady użycia dostępnych operacji można znaleźć w testach (./test).

## Testy

```bash

$ npm install mocha -g
$ npm install .
$ npm test

```

# Licencja

[Apache 2.0 License](LICENSE)

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