# sonetel-node

> NodeJS library for Sonetel APIs

Latest version **1.0.1** (published 2023-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install sonetel-node
pnpm add sonetel-node
yarn add sonetel-node
bun add sonetel-node
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-06-15 |
| First published | 2023-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Aashish Joshi |
| Maintainers | aashish.joe |
| Keywords | sonetel, communication api, voice apps, telecom, communication |

## Links

- npm: https://www.npmjs.com/package/sonetel-node
- Repository: https://github.com/aashish-joshi/sonetel-node
- Homepage: https://github.com/aashish-joshi/sonetel-node#readme
- Issues: https://github.com/aashish-joshi/sonetel-node/issues
- npm.io page: https://npm.io/package/sonetel-node

## Recent versions

- 1.0.1 (latest) — 2023-06-15
- 1.0.0 — 2023-06-15

## README

# Sonetel-Node

Sonetel-Node is a NodeJS library which provides a wrapper for using Sonetel's REST API's. It is written in TypeScript and can be installed using NPM.

This library supports the following functions:

1. Generate tokens for API authentication
2. View and update account information
3. Manage phone numbers, user accounts, voice apps and call recordings
4. Make phone calls
5. View usage records
6. Use the Text-to-speech service
7. Personalize suggested answers provided by our AI


## Installation

You can install this library using NPM by running the following commands:

```shell
npm i sonetel-node
```

## Usage

First, you need to import `Sonetel` class from the library:

```ts
import { Sonetel } from "sonetel-node";
```

Then, you need to initialize an instance:

```ts
const sonetel = new Sonetel({
  username: "your-email-address",
  password: "your-sonetel-password",
});
```

Now, you can use any endpoint that is supported by this library:

```ts
await sonetel.generateToken();
await sonetel.getAccount();
await sonetel.listUsers();
```

## Documentation

For detailed API documentation, please visit the [Sonetel-Node documentation website](https://your-documentation-website.com).

## Contributing

If you want to contribute to this project, please follow the [Contributing Guidelines](CONTRIBUTING.md).

## License

This code is licensed under the [MIT License](LICENSE).

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