com.telapi.api.domain
Class Account

java.lang.Object
  com.telapi.api.domain.Account

public class Account
extends Object

An account resource provides information about a single TelAPI account.

Constructor Summary

Account()

Method Summary

BigDecimal	getAccountBalance()
Date	getDateCreated()
Date	getDateUpdated()
String	getFriendlyName()
String	getMaxOutboundLimit()
String	getSid()
String	getStatus()
SubresourceUris	getSubresourceUris()
String	getTimeZone()
String	getType()
String	getUri()
void	setAccountBalance(BigDecimal accountBalance)
void	setDateCreated(Date dateCreated)
void	setDateUpdated(Date dateUpdated)
void	setFriendlyName(String friendlyName)
void	setMaxOutboundLimit(String maxOutboundLimit)
void	setSid(String sid)
void	setStatus(String status)
void	setSubresourceUris(SubresourceUris subresourceUris)
void	setTimeZone(String timeZone)
void	setType(String type)
void	setUri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

Account

public Account()

Method Detail

getSid

public String getSid()

Returns:

An alphanumeric string identifying the account.

setSid

public void setSid(String sid)

getFriendlyName

public String getFriendlyName()

Returns:

This is an alias that can be created for TelAPI accounts. By default, it is the email used to create the account but a custom name can be used as long as it is shorter than 64 characters.

setFriendlyName

public void setFriendlyName(String friendlyName)

getStatus

public String getStatus()

Returns:

This is the status of the TelAPI account being requested. The state of the status can be either active, suspended, or closed.

setStatus

public void setStatus(String status)

getAccountBalance

public BigDecimal getAccountBalance()

Returns:

The current balance of an account.

setAccountBalance

public void setAccountBalance(BigDecimal accountBalance)

getDateCreated

public Date getDateCreated()

Returns:

Date of account creation. Dates are returned in UTC format.

setDateCreated

public void setDateCreated(Date dateCreated)

getDateUpdated

public Date getDateUpdated()

Returns:

Date of most recent account update. Dates are returned in UTC format.

setDateUpdated

public void setDateUpdated(Date dateUpdated)

getUri

public String getUri()

Returns:

The path appended to the base TelAPI URL, https://api.telapi.com, where the resource is located.

setUri

public void setUri(String uri)

getMaxOutboundLimit

public String getMaxOutboundLimit()

Returns:

setMaxOutboundLimit

public void setMaxOutboundLimit(String maxOutboundLimit)

getType

public String getType()

Returns:

The type of account being requested. If the account is not yet funded Type is Trial. Otherwise, Type for upgraded accounts is Full.

setType

public void setType(String type)

getTimeZone

public String getTimeZone()

Returns:

The name of an accounts timezone.

setTimeZone

public void setTimeZone(String timeZone)

getSubresourceUris

public SubresourceUris getSubresourceUris()

Returns:

List of an accounts various subresources and their URI path. Examples of subresources are things like calls that occurred through the account, sms messages, purchased phone numbers, etc.

setSubresourceUris

public void setSubresourceUris(SubresourceUris subresourceUris)