com.plivo.api.models.address

Class Address

java.lang.Object

com.plivo.api.models.base.BaseResource

com.plivo.api.models.address.Address

public class Address
extends BaseResource

Field Summary

Fields inherited from class com.plivo.api.models.base.BaseResource

plivoClient

Constructor Summary

Constructors

Constructor and Description
Address()

Method Summary

Modifier and Type	Method and Description
static AddressCreator	creator(java.lang.String countryIso, java.lang.String salutation, java.lang.String firstName, java.lang.String lastName, java.lang.String addressLine1, java.lang.String addressLine2, java.lang.String city, java.lang.String region, java.lang.String postalCode)
static AddressDeleter	deleter(java.lang.String id)
java.lang.String	getAccount()
java.lang.String	getAddressLine1()
java.lang.String	getAddressLine2()
java.lang.String	getAddressProofType()
java.lang.String	getAlias()
java.lang.String	getCity()
java.lang.String	getCountryIso()
com.fasterxml.jackson.databind.JsonNode	getDocumentDetails()
java.lang.String	getFirstName()
java.lang.String	getFiscalIdentificationCode()
java.lang.String	getId()
java.lang.String	getLastName()
java.lang.String	getMunicipalCode()
java.lang.String	getPostalCode()
java.lang.String	getRegion()
java.lang.String	getSalutation()
java.lang.String	getStreetCode()
java.lang.String	getSubaccount()
static AddressGetter	getter(java.lang.String id)
java.lang.String	getUrl()
java.lang.String	getValidationStatus()
java.lang.String	getVerificationStatus()
static AddressLister	lister()
static AddressUpdater	updater(java.lang.String id)

Methods inherited from class com.plivo.api.models.base.BaseResource

getApiId, getPlivoClient, setPlivoClient, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address()

Method Detail

creator

public static AddressCreator creator(java.lang.String countryIso,
                                     java.lang.String salutation,
                                     java.lang.String firstName,
                                     java.lang.String lastName,
                                     java.lang.String addressLine1,
                                     java.lang.String addressLine2,
                                     java.lang.String city,
                                     java.lang.String region,
                                     java.lang.String postalCode)

updater

public static AddressUpdater updater(java.lang.String id)

getter

public static AddressGetter getter(java.lang.String id)

deleter

public static AddressDeleter deleter(java.lang.String id)

lister

public static AddressLister lister()

getAccount

public java.lang.String getAccount()

Returns:

Account the address belongs to.

getCountryIso

public java.lang.String getCountryIso()

Returns:

Country ISO 2 code.

getAlias

public java.lang.String getAlias()

Returns:

Alias name of the address.

getSalutation

public java.lang.String getSalutation()

getFirstName

public java.lang.String getFirstName()

Returns:

First name of the user for whom the identity is created.

getLastName

public java.lang.String getLastName()

Returns:

Last name of the user for whom the identity is created.

getAddressLine1

public java.lang.String getAddressLine1()

Returns:

Building name/number.

getAddressLine2

public java.lang.String getAddressLine2()

Returns:

The street name/number of the address.

getCity

public java.lang.String getCity()

Returns:

The city of the address for which the address proof is created.

getRegion

public java.lang.String getRegion()

Returns:

The region of the address for which the address proof is created.

getDocumentDetails

public com.fasterxml.jackson.databind.JsonNode getDocumentDetails()

Returns:

The document details json object of the address.

getPostalCode

public java.lang.String getPostalCode()

Returns:

The postal code of the address that is being created.

getFiscalIdentificationCode

public java.lang.String getFiscalIdentificationCode()

Returns:

The code is available for businesses alone and will be available for spain mobile numbers. If not present, return null.

getStreetCode

public java.lang.String getStreetCode()

Returns:

Street code of the address. Return null if not present.

getMunicipalCode

public java.lang.String getMunicipalCode()

Returns:

Municipal code of the address. Return null if not present.

getValidationStatus

public java.lang.String getValidationStatus()

Returns:

Can take the following values: pending. accepted, rejected, null.

getVerificationStatus

public java.lang.String getVerificationStatus()

Returns:

Can take the following values: pending. verified, rejected, null.

getSubaccount

public java.lang.String getSubaccount()

Returns:

The link to the subaccount resource associated with the application. If the application belongs to the main account, this field will be null.

getUrl

public java.lang.String getUrl()

Returns:

A plivo wrapped link to the document stored in the Plivo CDN.

getAddressProofType

public java.lang.String getAddressProofType()

Returns:

The type of document that is provided as address proof.

getId

public java.lang.String getId()

Specified by:

getId in class BaseResource