Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.48 KB

README.md

File metadata and controls

71 lines (47 loc) · 2.48 KB

Vonage Sub Accounts SDK for Node.js

GitHub Workflow Status Codecov Latest Release Contributor Covenant License

Vonage

This is the Vonage Sub Accounts 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.

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

Installation

With NPM

npm install @vonage/subaccounts

With Yarn

yarn add @vonage/subaccounts

Usage

Unlike the other SDK's this package is not include in the Vonage Server SDK for Node.js

const { Auth } = require('@vonage/auth')
const { SubAccounts } = require('@vonage/subaccounts')

const credentials = new Auth({
  applicationId: APP_ID,
  privateKey: PRIAVTE_KEY,
})
const options = {}
const subAccountClient = new SubAccounts(credentials, options)

Where 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.

const resp = await subAccountClient.listSubAccounts()

subAccountClient
  .listSubAccounts()
  .then((resp) => console.log(resp))
  .catch((err) => console.error(err))

Testing

Run:

npm run test