-
Notifications
You must be signed in to change notification settings - Fork 182
Vonage Redact
Documentation / Vonage Redact
Defined in: redact/lib/enums/product.ts:4
Enum representing different product types for redaction requests.
| 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 |
Defined in: redact/lib/enums/type.ts:4
Enum representing different message types for redaction requests.
| 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 |
Defined in: redact/lib/redact.ts:7
Represents a client for the Redact API that extends the Vonage Client.
new Redact(credentials, options?): RedactDefined in: server-client/dist/lib/client.d.ts:35
Creates a new instance of the Client.
The authentication credentials or an authentication instance.
Optional configuration settings for the client.
protected auth: AuthInterface;Defined in: server-client/dist/lib/client.d.ts:24
The authentication instance responsible for generating authentication headers and query parameters.
protected authType: AuthenticationType = AuthenticationType.BASIC;Defined in: redact/lib/redact.ts:11
The authentication type used for Redact API requests.
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.
static transformers: object;Defined in: server-client/dist/lib/client.d.ts:11
Static property containing utility transformers.
camelCaseObjectKeys: PartialTransformFunction;kebabCaseObjectKeys: PartialTransformFunction;omit: (keys, obj) => TransformedObject;string[]
snakeCaseObjectKeys: PartialTransformFunction;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.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addAuthenticationToRequest
protected addBasicAuthToRequest(request): Promise<VetchOptions>Defined in: server-client/dist/lib/client.d.ts:71
Adds basic authentication headers to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
protected addJWTToRequest(request): Promise<VetchOptions>Defined in: server-client/dist/lib/client.d.ts:64
Adds a JWT to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>Defined in: server-client/dist/lib/client.d.ts:57
Adds API key and secret to the request.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequest
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>Defined in: server-client/dist/lib/client.d.ts:50
Adds API key and secret to the request body.
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequestBody
getConfig(): ConfigParamsDefined in: server-client/dist/lib/client.d.ts:36
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.
• T
The expected type of the parsed response data.
The request options.
Response
The raw response from the request.
Promise<VetchResponse<T>>
- The parsed response.
protected prepareBody(request): undefined | stringDefined in: server-client/dist/lib/client.d.ts:158
Prepares the body for the request based on the content type.
The request options.
undefined | string
- The prepared request body as a string or undefined.
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.
The initial request options.
Promise<VetchOptions>
- The modified request options.
redactMessage(params): Promise<void>Defined in: redact/lib/redact.ts:21
Redacts a specific message using the provided parameters.
Parameters for redacting a message.
Promise<void>
A Promise that resolves when the redaction is successful.
If there is an error in processing the redaction request.
sendDeleteRequest<T>(url): Promise<VetchResponse<T>>Defined in: server-client/dist/lib/client.d.ts:78
Sends a DELETE request to the specified URL.
• T
string
The URL endpoint for the DELETE request.
Promise<VetchResponse<T>>
- The response from the DELETE request.
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.
• T
string
The URL endpoint for the POST request.
Record<string, undefined | string>
Optional payload containing form data to send with the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
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.
• T
string
The URL endpoint for the GET request.
Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.
Promise<VetchResponse<T>>
- The response from the GET request.
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.
• T
string
The URL endpoint for the PATCH request.
Optional payload to be sent as the body of the PATCH request.
Promise<VetchResponse<T>>
- The response from the PATCH request.
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.
• T
string
The URL endpoint for the POST request.
Optional payload to be sent as the body of the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
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.
• T
string
The URL endpoint for the PUT request.
Optional payload to be sent as the body of the PUT request.
Promise<VetchResponse<T>>
- The response from the PUT request.
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.
• T
The options defining the request, including URL, method, headers, and data.
Promise<VetchResponse<T>>
- The parsed response from the request.
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.
• T
The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).
string
The URL endpoint for the request.
Optional payload to be sent as the body of the request, JSON-encoded.
Promise<VetchResponse<T>>
- The response from the request.
Defined in: redact/lib/interfaces/response/errorResponse.ts:4
Represents an error response.
detail: string;Defined in: redact/lib/interfaces/response/errorResponse.ts:18
A detailed description of the error.
instance: string;Defined in: redact/lib/interfaces/response/errorResponse.ts:23
An instance identifier associated with the error.
title: string;Defined in: redact/lib/interfaces/response/errorResponse.ts:13
A short title or summary of the error.
type: string;Defined in: redact/lib/interfaces/response/errorResponse.ts:8
The type of error.
Defined in: redact/lib/interfaces/request/transactionRequest.ts:6
Represents a request to redact a specific message.
id: string;Defined in: redact/lib/interfaces/request/transactionRequest.ts:10
The transaction ID to redact.
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;Defined in: redact/lib/interfaces/request/transactionRequest.ts:21
Required if redacting SMS data. Must be one of: inbound, outbound.
type TransactionParams = object;Defined in: redact/lib/types/transactionParams.ts:6
Represents parameters for a transaction redaction request.
id: string;The transaction ID to redact.
product: ProductType;Product name that the ID provided relates to. Must be one of: sms, voice, number-insight, verify, verify-sdk, messages.
optional type: Type;Required if redacting SMS data. Must be one of: inbound, outbound.