Vonage Users SDK for Node.js

!GitHub Workflow Status (branch)  !Latest Release  

This is the Vonage Users SDK for Node.js for use with Vonage APIs. To use it you will need a Vonage account. Sign up [for free][signup] at vonage.com.

For full API documentation refer to developer.nexmo.com.

* Installation
* Usage
* Promises

Installation

$3

``bash
npm install @vonage/users
`

$3

`bash
yarn add @vonage/users
`

Usage

The SDK can be used standalone from the main Vonage Server SDK for Node.js
if you only need to use the Users API. All you need to do
is require('@vonage/users'), and use the returned object to create your own
client.

`js
const {Auth} = require('@vonage/auth');
const {User} = require('@vonage/user');

const usersClient = new User(new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
applicationId: APP_ID,
privateKey: PRIVATE_KEY_PATH,
}), options);
`

Promises

Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use await to
wait for a response.

`js
const resp = await usersClient.getUser(USER_ID);

usersClient.getUser(USER_ID)
.then(resp => console.log(resp))
.catch(err => console.error(err));
`

Testing

Run:

`bash
npm run test
``

[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk

[license]: https://github.com/Vonage/vonage-node-sdk/blob/3.x/LICENSE.txt