@vonage/redact

Vonage Redact SDK for Node.js

This is the Vonage Redact (for version 1) 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
• 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 Redact API.

With NPM

npm install @vonage/redact

With Yarn

yarn add @vonage/redact

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 redact property off of the client that you instantiate.

const { Vonage } = require('@vonage/server-sdk')
const { ProductType, Type } = require('@vonage/redact');

const credentials = {
  apiKey: API_KEY,
  apiSecret: API_SECRET,
}

const options = {}
const vonage = new Vonage(credentials, options)

vonage.redact
  .redactMessage({
    id: '209ab3c7536542b91e8b5aef032f6861',
    product: ProductType.SMS,
    type: Type.INBOUND,
  })
  .then((resp) => console.log(resp))
  .catch((err) => console.error(err))

Standalone

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

const { Auth } = require('@vonage/auth')
const { Redact } = require('@vonage/redact')

const credentials = new Auth({
    apiKey: API_KEY,
    apiSecret: API_SECRET,
})
const options = {}
const redactClient = new Redact(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 eitherresolve these yourself, or use await to wait for a response.

const resp = await vonage.redact
  .redactMessage({
    id: '209ab3c7536542b91e8b5aef032f6861',
    product: ProductType.SMS,
    type: Type.INBOUND,
  });

vonage.redact
  .redactMessage({
    id: '209ab3c7536542b91e8b5aef032f6861',
    product: ProductType.SMS,
    type: Type.INBOUND,
  })
  .then((resp) => console.log(resp))
  .catch((err) => console.error(err))

Testing

Run:

npm run test