Package com.nexmo.client.redact

Class RedactClient

java.lang.Object

com.nexmo.client.AbstractClient

com.nexmo.client.redact.RedactClient

public class RedactClient
extends AbstractClient

A client for talking to the Nexmo Redact API. The standard way to obtain an instance of this class is to use NexmoClient.getRedactClient().

Field Summary

Fields inherited from class com.nexmo.client.AbstractClient

httpWrapper

Constructor Summary

Constructors

Constructor	Description
RedactClient(HttpWrapper httpWrapper)

Method Summary

Modifier and Type	Method	Description
void	redactTransaction(RedactRequest redactRequest)	Submit a request to the Redact API to redact a transaction.
void	redactTransaction(java.lang.String id, RedactRequest.Product product)	Submit a request to the Redact API to redact a transaction.
void	redactTransaction(java.lang.String id, RedactRequest.Product product, RedactRequest.Type type)	Submit a request to the Redact API to redact a transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedactClient

public RedactClient(HttpWrapper httpWrapper)

Method Detail

redactTransaction

public void redactTransaction(java.lang.String id,
                              RedactRequest.Product product)
                       throws NexmoResponseParseException,
                              NexmoClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

id - The transaction id to redact.

product - The RedactRequest.Product which corresponds to the transaction.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

NexmoResponseParseException - if the response from the API could not be parsed.

redactTransaction

public void redactTransaction(java.lang.String id,
                              RedactRequest.Product product,
                              RedactRequest.Type type)
                       throws NexmoResponseParseException,
                              NexmoClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

id - The transaction id to redact.

product - The RedactRequest.Product which corresponds to the transaction.

type - The RedactRequest.Type which is required if redacting SMS data.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

NexmoResponseParseException - if the response from the API could not be parsed.

redactTransaction

public void redactTransaction(RedactRequest redactRequest)
                       throws NexmoResponseParseException,
                              NexmoClientException

Submit a request to the Redact API to redact a transaction.

Parameters:

redactRequest - a RedactRequest object which contains the request parameters.

Throws:

NexmoClientException - if there was a problem with the Nexmo request or response objects.

NexmoResponseParseException - if the response from the API could not be parsed.