Socket
Socket
Sign inDemoInstall

@vonage/accounts

Package Overview
Dependencies
44
Maintainers
44
Versions
41
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vonage/accounts

Vonage Account Management API


Version published
Maintainers
44
Weekly downloads
22,015
decreased by-8.6%

Weekly downloads

Readme

Source

Vonage Accounts SDK for Node.js

GitHub Workflow Status Codecov Latest Release Contributor Covenant License

Vonage

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.

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

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.

With NPM

npm install @vonage/accounts

With Yarn

yarn add @vonage/accounts

Usage

As part of the Vonage Server SDK

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.

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();

Standalone

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.

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.

const balance = await accountClient.getBalance();

accountClient.getBalance()
  .then(resp => console.log(resp))
  .catch(err => console.error(err));

Testing

Run:

npm run test

FAQs

Last updated on 21 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc