Class PickupService

java.lang.Object

com.easypost.service.PickupService

public class PickupService
extends Object

Method Summary

Modifier and Type	Method	Description
PickupCollection	all(Map<String,Object> params)	Get a list of all Pickup objects.
Pickup	buy(String id)	Buy this Pickup.
Pickup	buy(String id, PickupRate pickupRate)	Buy this Pickup.
Pickup	buy(String id, Map<String,Object> params)	Buy this Pickup.
Pickup	cancel(String id)	Cancel this Pickup.
Pickup	cancel(String id, Map<String,Object> params)	Cancel this Pickup.
Pickup	create(Map<String,Object> params)	Create a new Pickup object from a map of parameters.
PickupCollection	getNextPage(PickupCollection collection)	Get the next page of an PickupCollection.
PickupCollection	getNextPage(PickupCollection collection, Integer pageSize)	Get the next page of an PickupCollection.
Pickup	retrieve(String id)	Retrieve a Pickup from the API.

Methods inherited from class java.lang.Object

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

Method Details

all

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

Get a list of all Pickup objects.

Parameters:

params - The options for the query.

Returns:

PickupCollection object

Throws:

EasyPostException - when the request fails.

getNextPage

public PickupCollection getNextPage(PickupCollection collection)
                             throws EndOfPaginationError

Get the next page of an PickupCollection.

Parameters:

collection - PickupCollection to get next page of.

Returns:

PickupCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an PickupCollection.

Parameters:

collection - PickupCollection to get next page of.

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

Returns:

PickupCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

create

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

Create a new Pickup object from a map of parameters.

Parameters:

params - Map of parameters.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

retrieve

public Pickup retrieve(String id)
                throws EasyPostException

Retrieve a Pickup from the API.

Parameters:

id - ID of Pickup to retrieve.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

buy

public Pickup buy(String id)
           throws EasyPostException

Buy this Pickup.

Parameters:

id - The ID of pickup.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

buy

public Pickup buy(String id,
 Map<String,Object> params)
           throws EasyPostException

Buy this Pickup.

Parameters:

id - The ID of pickup.

params - Map of parameters.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

buy

public Pickup buy(String id,
 PickupRate pickupRate)
           throws EasyPostException

Buy this Pickup.

Parameters:

id - The ID of pickup.

pickupRate - PickupRate to buy.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

cancel

public Pickup cancel(String id)
              throws EasyPostException

Cancel this Pickup.

Parameters:

id - The ID of pickup.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.

cancel

public Pickup cancel(String id,
 Map<String,Object> params)
              throws EasyPostException

Cancel this Pickup.

Parameters:

id - The ID of pickup.

params - Map of parameters.

Returns:

Pickup object.

Throws:

EasyPostException - when the request fails.