Vonage Accounts SDK for Node.js

!GitHub Workflow Status  !Latest Release  ![License][license]

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

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

If you are updating from V2 to V3, please check the migration guide found here

* Installation
* Usage
* Promises
* Testing

Installation

We recommend using this SDK as part of the overall @vonage/server-sdk package. Please see the main package for installation.

You can also use this SDK standalone if you only need access to just the Accounts API.

$3

``bash
npm install @vonage/accounts
`

$3

`bash
yarn add @vonage/accounts
`

Usage

$3

If you are using this SDK as part of the Vonage Server SDK, you can access it as the accounts property off of the client that you instantiate.

`js
const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage(
{
apiKey: API_KEY,
apiSecret: API_SECRET,
privateKey: PRIVATE_KEY_PATH,
signatureSecret: SIGNATURE_SECRET,
signatureMethod: SIGNATURE_METHOD
},
options
);

const balance = await vonage.accounts.getBalance();
`

$3

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

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

const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET,
});

const options = {}

const accountClient = new Accounts(credentials, options);
`

credentials is any option from @vonage/auth,
and options is any option from @vonage/server-client

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 balance = await accountClient.getBalance();

accountClient.getBalance()
.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]: ../../LICENSE.txt