Class EventService

java.lang.Object

com.easypost.service.EventService

public class EventService
extends Object

Method Summary

Modifier and Type	Method	Description
EventCollection	all(Map<String,Object> params)	Get a list of Events.
EventCollection	getNextPage(EventCollection collection)	Get the next page of an EventCollection.
EventCollection	getNextPage(EventCollection collection, Integer pageSize)	Get the next page of an EventCollection.
Event	retrieve(String id)	Retrieve a Event from the API.
List<Payload>	retrieveAllPayloads(String eventId)	Retrieve all payloads.
Payload	retrievePayload(String eventId, String payloadId)	Retrieve a payload.

Methods inherited from class java.lang.Object

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

Method Details

retrieve

public Event retrieve(String id)
               throws EasyPostException

Retrieve a Event from the API.

Parameters:

id - ID of the Event to retrieve

Returns:

Event object

Throws:

EasyPostException - when the request fails.

all

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

Get a list of Events.

Parameters:

params - A map of parameters to pass to the API.

Returns:

EventCollection object

Throws:

EasyPostException - when the request fails.

getNextPage

public EventCollection getNextPage(EventCollection collection)
                            throws EndOfPaginationError

Get the next page of an EventCollection.

Parameters:

collection - EventCollection to get next page of.

Returns:

EventCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an EventCollection.

Parameters:

collection - EventCollection to get next page of.

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

Returns:

EventCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

retrieveAllPayloads

public List<Payload> retrieveAllPayloads(String eventId)
                                  throws EasyPostException

Retrieve all payloads.

Parameters:

eventId - The ID of event.

Returns:

List of Payload objects.

Throws:

EasyPostException - when the request fails.

retrievePayload

public Payload retrievePayload(String eventId,
 String payloadId)
                        throws EasyPostException

Retrieve a payload.

Parameters:

eventId - The ID of event.

payloadId - The ID of payload.

Returns:

PayloadCollection object

Throws:

EasyPostException - when the request fails.