Class AddressService

java.lang.Object

com.easypost.service.AddressService

public class AddressService
extends Object

Method Summary

Modifier and Type	Method	Description
AddressCollection	all(Map<String,Object> params)	List all Address objects.
Address	create(Map<String,Object> params)	Create Address object from parameter map.
Address	createAndVerify(Map<String,Object> params)	Create Address object from parameter map and immediately verify it.
AddressCollection	getNextPage(AddressCollection collection)	Get the next page of an AddressCollection.
AddressCollection	getNextPage(AddressCollection collection, Integer pageSize)	Get the next page of an AddressCollection.
Address	retrieve(String id)	Retrieve Address object from API.
Address	verify(String id)	Verify this Address object.

Methods inherited from class java.lang.Object

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

Method Details

create

public Address create(Map<String,Object> params)
               throws EasyPostException

Create Address object from parameter map.

Parameters:

params - Map of address parameters.

Returns:

Address object.

Throws:

EasyPostException - when the request fails.

retrieve

public Address retrieve(String id)
                 throws EasyPostException

Retrieve Address object from API.

Parameters:

id - ID of address to retrieve.

Returns:

Address object.

Throws:

EasyPostException - when the request fails.

all

public AddressCollection all(Map<String,Object> params)
                      throws EasyPostException

List all Address objects.

Parameters:

params - Map of parameters.

Returns:

AddressCollection object.

Throws:

EasyPostException - when the request fails.

getNextPage

public AddressCollection getNextPage(AddressCollection collection)
                              throws EndOfPaginationError

Get the next page of an AddressCollection.

Parameters:

collection - AddressCollection to get next page of.

Returns:

AddressCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

public AddressCollection getNextPage(AddressCollection collection,
 Integer pageSize)
                              throws EndOfPaginationError

Get the next page of an AddressCollection.

Parameters:

collection - AddressCollection to get next page of.

pageSize - The number of results to return on the next page.

Returns:

AddressCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

createAndVerify

public Address createAndVerify(Map<String,Object> params)
                        throws EasyPostException

Create Address object from parameter map and immediately verify it.

Parameters:

params - Map of address parameters.

Returns:

Address object.

Throws:

EasyPostException - when the request fails.

verify

public Address verify(String id)
               throws EasyPostException

Verify this Address object.

Parameters:

id - The ID of address.

Returns:

Address object.

Throws:

EasyPostException - when the request fails.