com.nexmo.client.account

Class AccountClient

java.lang.Object

com.nexmo.client.AbstractClient

com.nexmo.client.account.AccountClient

public class AccountClient
extends AbstractClient

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BalanceEndpoint	balance
protected PrefixPricingEndpoint	prefixPricing
protected com.nexmo.client.account.PricingEndpoint	pricing
protected TopUpEndpoint	topUp

Fields inherited from class com.nexmo.client.AbstractClient

httpWrapper

Constructor Summary

Constructors

Constructor and Description
AccountClient(HttpWrapper httpWrapper) Constructor.

Method Summary

Modifier and Type	Method and Description
BalanceResponse	getBalance()
PrefixPricingResponse	getPrefixPrice(ServiceType type, java.lang.String prefix) Retrieve the pricing for a specified prefix.
PricingResponse	getSmsPrice(java.lang.String country) Retrieve the SMS pricing for a specified country.
PricingResponse	getVoicePrice(java.lang.String country) Retrieve the voice pricing for a specified country.
void	topUp(java.lang.String transaction) Top-up your account when you have enabled auto-reload in the dashboard.

Methods inherited from class java.lang.Object

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

Field Detail

balance

protected BalanceEndpoint balance

pricing

protected com.nexmo.client.account.PricingEndpoint pricing

prefixPricing

protected PrefixPricingEndpoint prefixPricing

topUp

protected TopUpEndpoint topUp

Constructor Detail

AccountClient

public AccountClient(HttpWrapper httpWrapper)

Constructor.

Parameters:

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

Method Detail

getBalance

public BalanceResponse getBalance()
                           throws java.io.IOException,
                                  NexmoClientException

Throws:

java.io.IOException

NexmoClientException

getVoicePrice

public PricingResponse getVoicePrice(java.lang.String country)
                              throws java.io.IOException,
                                     NexmoClientException

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:

java.io.IOException - if a network error occurred contacting the Nexmo Account API.

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

getSmsPrice

public PricingResponse getSmsPrice(java.lang.String country)
                            throws java.io.IOException,
                                   NexmoClientException

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:

java.io.IOException - if a network error occurred contacting the Nexmo Account API.

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

getPrefixPrice

public PrefixPricingResponse getPrefixPrice(ServiceType type,
                                            java.lang.String prefix)
                                     throws java.io.IOException,
                                            NexmoClientException

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:

java.io.IOException - if a network error occurred contacting the Nexmo Account API.

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

topUp

public void topUp(java.lang.String transaction)
           throws java.io.IOException,
                  NexmoClientException

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:

java.io.IOException - if a network error occurred contacting the Nexmo Account API.

NexmoClientException - if there was a problem with the Nexmo request or response object indicating that the request was unsuccessful.