Vonage Redact

Documentation

---

Documentation / 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

Enumerations

ProductType

Defined in: redact/lib/enums/product.ts:4

Enum representing different product types for redaction requests.

Enumeration Members

Enumeration Member	Value	Description	Defined in
NumberInsight	"NumberInsight"	Represents the Number Insight product.	redact/lib/enums/product.ts:18
SMS	"SMS"	Represents the SMS product.	redact/lib/enums/product.ts:8
Verify	"Verify"	Represents the Verify product.	redact/lib/enums/product.ts:23
VerifySDK	"VerifySDK"	Represents the Verify SDK product.	redact/lib/enums/product.ts:28
Voice	"Voice"	Represents the Voice product.	redact/lib/enums/product.ts:13

---

Type

Defined in: redact/lib/enums/type.ts:4

Enum representing different message types for redaction requests.

Enumeration Members

Enumeration Member	Value	Description	Defined in
INBOUND	"Inbound"	Represents an inbound message type.	redact/lib/enums/type.ts:8
OUTBOUND	"Outbound"	Represents an outbound message type.	redact/lib/enums/type.ts:13

Classes

Redact

Defined in: redact/lib/redact.ts:7

Represents a client for the Redact API that extends the Vonage Client.

Extends

• Client

Constructors

Constructor

new Redact(credentials, options?): Redact;

Defined in: server-client/dist/lib/client.d.ts:35

Creates a new instance of the Client.

Parameters

credentials

The authentication credentials or an authentication instance.

AuthInterface | AuthParams

options?

ConfigParams

Optional configuration settings for the client.

Returns

Redact

Inherited from

Client.constructor

Properties

auth

protected auth: AuthInterface;

Defined in: server-client/dist/lib/client.d.ts:24

The authentication instance responsible for generating authentication headers and query parameters.

Inherited from

Client.auth

authType

protected authType: AuthenticationType = AuthenticationType.BASIC;

Defined in: redact/lib/redact.ts:11

The authentication type used for Redact API requests.

Overrides

Client.authType

config

protected config: ConfigParams;

Defined in: server-client/dist/lib/client.d.ts:28

Configuration settings for the client, including default hosts for various services and other request settings.

Inherited from

Client.config

transformers

static transformers: object;

Defined in: server-client/dist/lib/client.d.ts:11

Static property containing utility transformers.

camelCaseObjectKeys

camelCaseObjectKeys: PartialTransformFunction;

kebabCaseObjectKeys

kebabCaseObjectKeys: PartialTransformFunction;

omit()

omit: (keys, obj) => TransformedObject;

Parameters

keys

string[]

obj

ObjectToTransform

Returns

TransformedObject

snakeCaseObjectKeys

snakeCaseObjectKeys: PartialTransformFunction;

Inherited from

Client.transformers

Methods

addAuthenticationToRequest()

addAuthenticationToRequest(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:43

Adds the appropriate authentication headers or parameters to the request based on the authentication type.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

• The request options with the added authentication.

Inherited from

Client.addAuthenticationToRequest

addBasicAuthToRequest()

protected addBasicAuthToRequest(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:71

Adds basic authentication headers to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

• The request options with the added authentication.

Inherited from

Client.addBasicAuthToRequest

addJWTToRequest()

protected addJWTToRequest(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:64

Adds a JWT to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

• The request options with the added authentication.

Inherited from

Client.addJWTToRequest

addQueryKeySecretToRequest()

protected addQueryKeySecretToRequest(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:57

Adds API key and secret to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

• The request options with the added authentication.

Inherited from

Client.addQueryKeySecretToRequest

addQueryKeySecretToRequestBody()

protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:50

Adds API key and secret to the request body.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

• The request options with the added authentication.

Inherited from

Client.addQueryKeySecretToRequestBody

getConfig()

getConfig(): ConfigParams;

Defined in: server-client/dist/lib/client.d.ts:36

Returns

ConfigParams

Inherited from

Client.getConfig

parseResponse()

protected parseResponse<T>(request, response): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:168

Parses the response based on its content type.

Type Parameters

T

T

The expected type of the parsed response data.

Parameters

request

VetchOptions

The request options.

response

Response

The raw response from the request.

Returns

Promise<VetchResponse<T>>

• The parsed response.

Inherited from

Client.parseResponse

prepareBody()

protected prepareBody(request): undefined | string;

Defined in: server-client/dist/lib/client.d.ts:158

Prepares the body for the request based on the content type.

Parameters

request

VetchOptions

The request options.

Returns

undefined | string

• The prepared request body as a string or undefined.

Inherited from

Client.prepareBody

prepareRequest()

protected prepareRequest(request): Promise<VetchOptions>;

Defined in: server-client/dist/lib/client.d.ts:151

Prepares the request with necessary headers, authentication, and query parameters.

Parameters

request

VetchOptions

The initial request options.

Returns

Promise<VetchOptions>

• The modified request options.

Inherited from

Client.prepareRequest

redactMessage()

redactMessage(params): Promise<void>;

Defined in: redact/lib/redact.ts:21

Redacts a specific message using the provided parameters.

Parameters

params

TransactionParams

Parameters for redacting a message.

Returns

Promise<void>

A Promise that resolves when the redaction is successful.

Throws

If there is an error in processing the redaction request.

sendDeleteRequest()

sendDeleteRequest<T>(url): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:78

Sends a DELETE request to the specified URL.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the DELETE request.

Returns

Promise<VetchResponse<T>>

• The response from the DELETE request.

Inherited from

Client.sendDeleteRequest

sendFormSubmitRequest()

sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:86

Sends a POST request with form data to the specified URL.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the POST request.

payload?

Record<string, undefined | string>

Optional payload containing form data to send with the POST request.

Returns

Promise<VetchResponse<T>>

• The response from the POST request.

Inherited from

Client.sendFormSubmitRequest

sendGetRequest()

sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:94

Sends a GET request to the specified URL with optional query parameters.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the GET request.

queryParams?

Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.

Returns

Promise<VetchResponse<T>>

• The response from the GET request.

Inherited from

Client.sendGetRequest

sendPatchRequest()

sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:104

Sends a PATCH request to the specified URL with an optional payload.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the PATCH request.

payload?

Optional payload to be sent as the body of the PATCH request.

Returns

Promise<VetchResponse<T>>

• The response from the PATCH request.

Inherited from

Client.sendPatchRequest

sendPostRequest()

sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:114

Sends a POST request to the specified URL with an optional payload.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the POST request.

payload?

Optional payload to be sent as the body of the POST request.

Returns

Promise<VetchResponse<T>>

• The response from the POST request.

Inherited from

Client.sendPostRequest

sendPutRequest()

sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:124

Sends a PUT request to the specified URL with an optional payload.

Type Parameters

T

T

Parameters

url

string

The URL endpoint for the PUT request.

payload?

Optional payload to be sent as the body of the PUT request.

Returns

Promise<VetchResponse<T>>

• The response from the PUT request.

Inherited from

Client.sendPutRequest

sendRequest()

sendRequest<T>(request): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:144

Sends a request adding necessary headers, handling authentication, and parsing the response.

Type Parameters

T

T

Parameters

request

VetchOptions

The options defining the request, including URL, method, headers, and data.

Returns

Promise<VetchResponse<T>>

• The parsed response from the request.

Inherited from

Client.sendRequest

sendRequestWithData()

sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>;

Defined in: server-client/dist/lib/client.d.ts:135

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

Type Parameters

T

T

Parameters

method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

POST | PUT | PATCH

url

string

The URL endpoint for the request.

payload?

Optional payload to be sent as the body of the request, JSON-encoded.

Returns

Promise<VetchResponse<T>>

• The response from the request.

Inherited from

Client.sendRequestWithData

Interfaces

ErrorResponse

Defined in: redact/lib/interfaces/response/errorResponse.ts:4

Represents an error response.

Properties

detail

detail: string;

Defined in: redact/lib/interfaces/response/errorResponse.ts:18

A detailed description of the error.

instance

instance: string;

Defined in: redact/lib/interfaces/response/errorResponse.ts:23

An instance identifier associated with the error.

title

title: string;

Defined in: redact/lib/interfaces/response/errorResponse.ts:13

A short title or summary of the error.

type

type: string;

Defined in: redact/lib/interfaces/response/errorResponse.ts:8

The type of error.

---

TransactionRequest

Defined in: redact/lib/interfaces/request/transactionRequest.ts:6

Represents a request to redact a specific message.

Properties

id

id: string;

Defined in: redact/lib/interfaces/request/transactionRequest.ts:10

The transaction ID to redact.

product

product: ProductType;

Defined in: redact/lib/interfaces/request/transactionRequest.ts:16

Product name that the ID provided relates to. Must be one of: sms, voice, number-insight, verify, verify-sdk, messages.

type

type: Type;

Defined in: redact/lib/interfaces/request/transactionRequest.ts:21

Required if redacting SMS data. Must be one of: inbound, outbound.

Type Aliases

TransactionParams

type TransactionParams = object;

Defined in: redact/lib/types/transactionParams.ts:6

Represents parameters for a transaction redaction request.

Properties

id

id: string;

Defined in: redact/lib/types/transactionParams.ts:10

The transaction ID to redact.

product

product: ProductType;

Defined in: redact/lib/types/transactionParams.ts:16

Product name that the ID provided relates to. Must be one of: sms, voice, number-insight, verify, verify-sdk, messages.

type?

optional type: Type;

Defined in: redact/lib/types/transactionParams.ts:21

Required if redacting SMS data. Must be one of: inbound, outbound.