Class TrackerService

java.lang.Object

com.easypost.service.TrackerService

public class TrackerService
extends Object

Method Summary

Modifier and Type	Method	Description
TrackerCollection	all(Map<String,Object> params)	Get a list of all Tracker objects.
Tracker	create(Map<String,Object> params)	Create a new Tracker object using a map of parameters.
TrackerCollection	getNextPage(TrackerCollection collection)	Get the next page of an TrackerCollection.
TrackerCollection	getNextPage(TrackerCollection collection, Integer pageSize)	Get the next page of an TrackerCollection.
Tracker	retrieve(String id)	Retrieve a Tracker object from the API.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Create a new Tracker object using a map of parameters.

Parameters:

params - Map of parameters used to create the Tracker.

Returns:

Tracker object.

Throws:

EasyPostException - when the request fails.

retrieve

public Tracker retrieve(String id)
                 throws EasyPostException

Retrieve a Tracker object from the API.

Parameters:

id - ID of the Tracker to retrieve.

Returns:

Tracker object.

Throws:

EasyPostException - when the request fails.

all

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

Get a list of all Tracker objects.

Parameters:

params - Map of parameters used to filter the list of Trackers.

Returns:

TrackerCollection object.

Throws:

EasyPostException - when the request fails.

getNextPage

public TrackerCollection getNextPage(TrackerCollection collection)
                              throws EndOfPaginationError

Get the next page of an TrackerCollection.

Parameters:

collection - TrackerCollection to get next page of.

Returns:

TrackerCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an TrackerCollection.

Parameters:

collection - TrackerCollection to get next page of.

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

Returns:

TrackerCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.