Address (Shippo Java Client v2.1.1 API)

java.lang.Object
- com.shippo.serialization.ShippoObject
- - com.shippo.net.APIResource
  - - com.shippo.model.Address

public class Address
extends APIResource

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Address.ValidationMessage

class Address.ValidationResults
- Nested classes/interfaces inherited from class com.shippo.net.APIResource
  APIResource.RequestMethod

Nested Classes
Modifier and Type	Class and Description
`class`	`Address.ValidationMessage`
`class`	`Address.ValidationResults`

Field Summary
- Fields inherited from class com.shippo.net.APIResource
  CHARSET
- Fields inherited from class com.shippo.serialization.ShippoObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Address()

Constructors
Constructor and Description
`Address()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AddressCollection`	`all(Map<String,Object> params)`
`static AddressCollection`	`all(Map<String,Object> params, String apiKey)`
`static Address`	`create(Map<String,Object> params)`
`static Address`	`create(Map<String,Object> params, String apiKey)`
`static Address`	`createForPurchase(String name, String street1, String city, String zip, String state, String country, String email)`
`Object`	`getCity()`
`Object`	`getCompany()`
`Object`	`getCountry()`
`Object`	`getEmail()`
`Object`	`getIs_Residential()`
`boolean`	`getIsComplete()`
`Object`	`getMessages()`
`Object`	`getMetadata()`
`Object`	`getName()`
`Object`	`getObjectCreated()`
`String`	`getObjectId()`
`String`	`getObjectOwner()`
`Object`	`getObjectUpdated()`
`Object`	`getPhone()`
`Object`	`getState()`
`Object`	`getStreet1()`
`Object`	`getStreet2()`
`Object`	`getStreetNo()`
`Address.ValidationResults`	`getValidationResults()`
`Object`	`getZip()`
`static Address`	`retrieve(String id)`
`static Address`	`retrieve(String id, String apiKey)`
`void`	`setCity(Object city)`
`void`	`setCompany(Object company)`
`void`	`setCountry(Object country)`
`void`	`setEmail(Object email)`
`void`	`setIs_Residential(Object is_residential)`
`void`	`setIsComplete(boolean isComplete)`
`void`	`setMessages(Object messages)`
`void`	`setMetadata(Object metadata)`
`void`	`setName(Object name)`
`void`	`setObjectCreated(Object objectCreated)`
`void`	`setObjectId(String objectId)`
`void`	`setObjectOwner(String objectOwner)`
`void`	`setObjectUpdated(Object objectUpdated)`
`void`	`setPhone(Object phone)`
`void`	`setState(Object state)`
`void`	`setStreet1(Object street1)`
`void`	`setStreet2(Object street2)`
`void`	`setStreetNo(Object streetNo)`
`void`	`setValidationResults(Address.ValidationResults validation_results)`
`void`	`setZip(Object zip)`
`static Address`	`validate(String id)`
`static Address`	`validate(String id, String apiKey)`

Methods inherited from class com.shippo.net.APIResource
_request, classURL, classURLWithTrailingSlash, instanceURL, request, singleClassURL, urlEncode

Methods inherited from class com.shippo.serialization.ShippoObject
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

createForPurchase

public static Address createForPurchase(String name,
                                        String street1,
                                        String city,
                                        String zip,
                                        String state,
                                        String country,
                                        String email)

validate

public static Address validate(String id)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

validate

public static Address validate(String id,
                               String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

create

public static Address create(Map<String,Object> params)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

create

public static Address create(Map<String,Object> params,
                             String apiKey)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

retrieve

public static Address retrieve(String id)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

retrieve

public static Address retrieve(String id,
                               String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

all

public static AddressCollection all(Map<String,Object> params)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

all

public static AddressCollection all(Map<String,Object> params,
                                    String apiKey)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; APIException

getIsComplete
```
public boolean getIsComplete()
```

setIsComplete

public void setIsComplete(boolean isComplete)

getObjectId
```
public String getObjectId()
```

setObjectId

public void setObjectId(String objectId)

getObjectOwner
```
public String getObjectOwner()
```

setObjectOwner

public void setObjectOwner(String objectOwner)

getObjectCreated
```
public Object getObjectCreated()
```

setObjectCreated

public void setObjectCreated(Object objectCreated)

getObjectUpdated
```
public Object getObjectUpdated()
```

setObjectUpdated

public void setObjectUpdated(Object objectUpdated)

getName
```
public Object getName()
```

setName
```
public void setName(Object name)
```

getCompany
```
public Object getCompany()
```

setCompany

public void setCompany(Object company)

getStreet1
```
public Object getStreet1()
```

setStreet1

public void setStreet1(Object street1)

getStreetNo
```
public Object getStreetNo()
```

setStreetNo

public void setStreetNo(Object streetNo)

getStreet2
```
public Object getStreet2()
```

setStreet2

public void setStreet2(Object street2)

getCity
```
public Object getCity()
```

setCity
```
public void setCity(Object city)
```

getState
```
public Object getState()
```

setState
```
public void setState(Object state)
```

getZip
```
public Object getZip()
```

setZip
```
public void setZip(Object zip)
```

getCountry
```
public Object getCountry()
```

setCountry

public void setCountry(Object country)

getPhone
```
public Object getPhone()
```

setPhone
```
public void setPhone(Object phone)
```

getEmail
```
public Object getEmail()
```

setEmail
```
public void setEmail(Object email)
```

getIs_Residential
```
public Object getIs_Residential()
```

setIs_Residential

public void setIs_Residential(Object is_residential)

getMetadata
```
public Object getMetadata()
```

setMetadata

public void setMetadata(Object metadata)

getMessages
```
public Object getMessages()
```

setMessages

public void setMessages(Object messages)

setValidationResults

public void setValidationResults(Address.ValidationResults validation_results)

getValidationResults

public Address.ValidationResults getValidationResults()

Class Address

Nested Class Summary

Nested classes/interfaces inherited from class com.shippo.net.APIResource

Field Summary

Fields inherited from class com.shippo.net.APIResource

Fields inherited from class com.shippo.serialization.ShippoObject

Constructor Summary

Method Summary

Methods inherited from class com.shippo.net.APIResource

Methods inherited from class com.shippo.serialization.ShippoObject

Methods inherited from class java.lang.Object

Constructor Detail

Address

Method Detail

createForPurchase

validate

validate

create

create

retrieve

retrieve

all

all

getIsComplete

setIsComplete

getObjectId

setObjectId

getObjectOwner

setObjectOwner

getObjectCreated

setObjectCreated

getObjectUpdated

setObjectUpdated

getName

setName

getCompany

setCompany

getStreet1

setStreet1

getStreetNo

setStreetNo

getStreet2

setStreet2

getCity

setCity

getState

setState

getZip

setZip

getCountry

setCountry

getPhone

setPhone

getEmail

setEmail

getIs_Residential

setIs_Residential

getMetadata

setMetadata

getMessages

setMessages

setValidationResults

getValidationResults