Package com.vonage.client.account

Class AccountClient

java.lang.Object

com.vonage.client.account.AccountClient

public class AccountClient
extends Object

A client for talking to the Vonage Account API. The standard way to obtain an instance of this class is to use VonageClient.getAccountClient().

Constructor Summary

Constructors

Constructor	Description
AccountClient(HttpWrapper wrapper)	Constructor.

Method Summary

Modifier and Type	Method	Description
SecretResponse	createSecret(String secret)	Create a secret to be used with this account's main API key.
SecretResponse	createSecret(String apiKey, String secret)	Create a secret to be used with a specific API key.
BalanceResponse	getBalance()	Obtains the current account remaining balance.
PrefixPricingResponse	getPrefixPrice(ServiceType type, String prefix)	Retrieve the pricing for a specified prefix.
SecretResponse	getSecret(String secretId)	Get information for a specific secret id associated with this account's main API key.
SecretResponse	getSecret(String apiKey, String secretId)	Get information for a specific secret id associated to a given API key.
PricingResponse	getSmsPrice(String country)	Retrieve the SMS pricing for a specified country.
PricingResponse	getVoicePrice(String country)	Retrieve the voice pricing for a specified country.
List<PricingResponse>	listPriceAllCountries(ServiceType service)	Obtain pricing data on all supported countries for a specific service type.
ListSecretsResponse	listSecrets()	List the ID of each secret associated with this account's main API key.
ListSecretsResponse	listSecrets(String apiKey)	List the ID of each secret associated to the given API key.
void	revokeSecret(String secretId)	Revoke a secret associated with this account's main API key.
void	revokeSecret(String apiKey, String secretId)	Revoke a secret associated with a specific API key.
void	topUp(String transaction)	Top-up your account when you have enabled auto-reload in the dashboard.
SettingsResponse	updateDeliveryReceiptUrl(String url)	Updates the account-level delivery receipt URL (mainly used by the SMS API).
SettingsResponse	updateSettings(SettingsRequest request)	Deprecated. Use updateSmsIncomingUrl(String) or updateDeliveryReceiptUrl(String) instead.
SettingsResponse	updateSmsIncomingUrl(String url)	Updates the account-level incoming SMS URL, as used by the SMS API.

Methods inherited from class java.lang.Object

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

Constructor Details

AccountClient

public AccountClient(HttpWrapper wrapper)

Constructor.

Parameters:

wrapper - (required) shared HTTP wrapper object used for making REST calls.

Method Details

getBalance

public BalanceResponse getBalance()
                           throws AccountResponseException

Obtains the current account remaining balance.

Returns:

The account balance along with other metadata.

Throws:

AccountResponseException - If the balance could not be retrieved.

listPriceAllCountries

public List<PricingResponse> listPriceAllCountries(ServiceType service)

Obtain pricing data on all supported countries for a specific service type.

Parameters:

service - The service type to retrieve pricing and network information for.

Returns:

The list of pricing information for all supported countries.

Throws:

AccountResponseException - If the pricing data could not be retrieved.

Since:

v7.9.0

getVoicePrice

public PricingResponse getVoicePrice(String country)
                              throws AccountResponseException

Retrieve the voice pricing for a specified country.

Parameters:

country - The two-character country code for which you would like to retrieve pricing.

Returns:

PricingResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

getSmsPrice

public PricingResponse getSmsPrice(String country)
                            throws AccountResponseException

Retrieve the SMS pricing for a specified country.

Parameters:

country - The two-character country code for which you would like to retrieve pricing.

Returns:

PricingResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

getPrefixPrice

public PrefixPricingResponse getPrefixPrice(ServiceType type,
 String prefix)
                                     throws AccountResponseException

Retrieve the pricing for a specified prefix.

Parameters:

type - The type of service to retrieve pricing for.

prefix - The prefix to retrieve the pricing for.

Returns:

PrefixPricingResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

topUp

public void topUp(String transaction)
           throws AccountResponseException

Top-up your account when you have enabled auto-reload in the dashboard. Amount added is based on your initial reload-enabled payment.

Parameters:

transaction - The ID associated with your original auto-reload transaction

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

listSecrets

public ListSecretsResponse listSecrets()
                                throws AccountResponseException

List the ID of each secret associated with this account's main API key.

Returns:

ListSecretsResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

Since:

7.9.0

listSecrets

public ListSecretsResponse listSecrets(String apiKey)
                                throws AccountResponseException

List the ID of each secret associated to the given API key.

Parameters:

apiKey - The API key to look up secrets for.

Returns:

ListSecretsResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

getSecret

public SecretResponse getSecret(String secretId)
                         throws AccountResponseException

Get information for a specific secret id associated with this account's main API key.

Parameters:

secretId - The id of the secret to get information on.

Returns:

SecretResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

Since:

7.9.0

getSecret

public SecretResponse getSecret(String apiKey,
 String secretId)
                         throws AccountResponseException

Get information for a specific secret id associated to a given API key.

Parameters:

apiKey - The API key that the secret is associated to.

secretId - The id of the secret to get information on.

Returns:

SecretResponse object which contains the results from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

createSecret

public SecretResponse createSecret(String secret)
                            throws AccountResponseException

Create a secret to be used with this account's main API key.

Parameters:

secret - The contents of the secret.

Returns:

SecretResponse object which contains the created secret from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

Since:

7.9.0

createSecret

public SecretResponse createSecret(String apiKey,
 String secret)
                            throws AccountResponseException

Create a secret to be used with a specific API key.

Parameters:

apiKey - The API key that the secret is to be used with.

secret - The contents of the secret.

Returns:

SecretResponse object which contains the created secret from the API.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

revokeSecret

public void revokeSecret(String secretId)
                  throws AccountResponseException

Revoke a secret associated with this account's main API key.

Parameters:

secretId - The id of the secret to revoke.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

Since:

7.9.0

revokeSecret

public void revokeSecret(String apiKey,
 String secretId)
                  throws AccountResponseException

Revoke a secret associated with a specific API key.

Parameters:

apiKey - The API key that the secret is associated to.

secretId - The id of the secret to revoke.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

updateSmsIncomingUrl

public SettingsResponse updateSmsIncomingUrl(String url)
                                      throws AccountResponseException

Updates the account-level incoming SMS URL, as used by the SMS API.

Parameters:

url - The URL where Vonage will send a webhook when an incoming SMS is received when a number-specific URL is not configured. Set to an empty string to unset the value.

Returns:

A SettingsResponse containing the newly-updated account settings.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

updateDeliveryReceiptUrl

public SettingsResponse updateDeliveryReceiptUrl(String url)
                                          throws AccountResponseException

Updates the account-level delivery receipt URL (mainly used by the SMS API).

Parameters:

url - The URL where Vonage will send a webhook when an incoming SMS is received when a number-specific URL is not configured. Set to an empty string to unset the value.

Returns:

A SettingsResponse containing the newly-updated account settings.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.

updateSettings

@Deprecated
public SettingsResponse updateSettings(SettingsRequest request)
                                throws AccountResponseException

Deprecated.

Use updateSmsIncomingUrl(String) or updateDeliveryReceiptUrl(String) instead.

Updates the account-level settings.

Parameters:

request - The SettingsRequest containing the fields to update.

Returns:

A SettingsResponse containing the newly-updated account settings.

Throws:

AccountResponseException - If there was an error making the request or retrieving the response.