-
Notifications
You must be signed in to change notification settings - Fork 178
Vonage Redact
Vonage Redact • Docs
Documentation / Vonage Redact
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 |
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 |
Represents a client for the Redact API that extends the Vonage Client.
new Redact(credentials, options?): RedactCreates a new instance of the Client.
• credentials: AuthInterface | AuthParams
The authentication credentials or an authentication instance.
• options?: ConfigParams
Optional configuration settings for the client.
server-client/dist/client.d.ts:30
protected auth: AuthInterface;The authentication instance responsible for generating authentication headers and query parameters.
server-client/dist/client.d.ts:19
protected authType: AuthenticationType = AuthenticationType.BASIC;The authentication type used for Redact API requests.
protected config: ConfigParams;Configuration settings for the client, including default hosts for various services and other request settings.
server-client/dist/client.d.ts:23
static transformers: __module;Static property containing utility transformers.
server-client/dist/client.d.ts:11
addAuthenticationToRequest(request): Promise<VetchOptions>Adds the appropriate authentication headers or parameters to the request based on the authentication type.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addAuthenticationToRequest
server-client/dist/client.d.ts:37
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>Parses the response based on its content type.
• T
The expected type of the parsed response data.
• request: VetchOptions
The request options.
• response: Response
The raw response from the request.
Promise<VetchResponse<T>>
- The parsed response.
server-client/dist/client.d.ts:134
protected prepareBody(request): undefined | stringPrepares the body for the request based on the content type.
• request: VetchOptions
The request options.
undefined | string
- The prepared request body as a string or undefined.
server-client/dist/client.d.ts:124
protected prepareRequest(request): Promise<VetchOptions>Prepares the request with necessary headers, authentication, and query parameters.
• request: VetchOptions
The initial request options.
Promise<VetchOptions>
- The modified request options.
server-client/dist/client.d.ts:117
redactMessage(params): Promise<void>Redacts a specific message using the provided parameters.
• params: TransactionParams
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>>Sends a DELETE request to the specified URL.
• T
• url: string
The URL endpoint for the DELETE request.
Promise<VetchResponse<T>>
- The response from the DELETE request.
server-client/dist/client.d.ts:44
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request with form data to the specified URL.
• T
• url: string
The URL endpoint for the POST request.
• payload?: Record<string, string>
Optional payload containing form data to send with the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/client.d.ts:52
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>Sends a GET request to the specified URL with optional query parameters.
• T
• 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.
Promise<VetchResponse<T>>
- The response from the GET request.
server-client/dist/client.d.ts:60
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PATCH request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PATCH request.
• payload?
Optional payload to be sent as the body of the PATCH request.
Promise<VetchResponse<T>>
- The response from the PATCH request.
server-client/dist/client.d.ts:70
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the POST request.
• payload?
Optional payload to be sent as the body of the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/client.d.ts:80
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PUT request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PUT request.
• payload?
Optional payload to be sent as the body of the PUT request.
Promise<VetchResponse<T>>
- The response from the PUT request.
server-client/dist/client.d.ts:90
sendRequest<T>(request): Promise<VetchResponse<T>>Sends a request adding necessary headers, handling authentication, and parsing the response.
• T
• request: VetchOptions
The options defining the request, including URL, method, headers, and data.
Promise<VetchResponse<T>>
- The parsed response from the request.
server-client/dist/client.d.ts:110
sendRequestWithData<T>(
method,
url,
payload?): Promise<VetchResponse<T>>Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.
• T
• method: POST | PUT | PATCH
The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).
• url: string
The URL endpoint for the request.
• payload?
Optional payload to be sent as the body of the request, JSON-encoded.
Promise<VetchResponse<T>>
- The response from the request.
server-client/dist/client.d.ts:101
Represents an error response.
detail: string;A detailed description of the error.
redact/lib/interfaces/response/errorResponse.ts:18
instance: string;An instance identifier associated with the error.
redact/lib/interfaces/response/errorResponse.ts:23
title: string;A short title or summary of the error.
redact/lib/interfaces/response/errorResponse.ts:13
type: string;The type of error.
redact/lib/interfaces/response/errorResponse.ts:8
Represents a request to redact a specific message.
id: string;The transaction ID to redact.
redact/lib/interfaces/request/transactionRequest.ts:10
product: ProductType;Product name that the ID provided relates to. Must be one of: sms, voice, number-insight, verify, verify-sdk, messages.
redact/lib/interfaces/request/transactionRequest.ts:16
type: Type;Required if redacting SMS data. Must be one of: inbound, outbound.
redact/lib/interfaces/request/transactionRequest.ts:21
type TransactionParams: object;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.
type: Type;Required if redacting SMS data. Must be one of: inbound, outbound.