Class ReportService

java.lang.Object

com.easypost.service.ReportService

public class ReportService
extends Object

Method Summary

Modifier and Type	Method	Description
ReportCollection	all(Map<String,Object> params)	Get a list of Reports from the API.
Report	create(Map<String,Object> params)	Create a Report from a map of parameters.
ReportCollection	getNextPage(ReportCollection collection)	Get the next page of an ReportCollection.
ReportCollection	getNextPage(ReportCollection collection, Integer pageSize)	Get the next page of an ReportCollection.
protected String	reportURL(String type)	Generate a report URL.
Report	retrieve(String id)	Retrieve a Report 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 Report create(Map<String,Object> params)
              throws EasyPostException

Create a Report from a map of parameters.

Parameters:

params - a map of parameters.

Returns:

Report object.

Throws:

EncodingError - if the parameters cannot be encoded.

MissingParameterError - if required parameters are missing.

EasyPostException - when the request fails.

reportURL

protected String reportURL(String type)
                    throws EasyPostException

Generate a report URL.

Parameters:

type - the type of report to generate.

Returns:

the URL to generate the report.

Throws:

EncodingError - when the request cannot be encoded properly.

EasyPostException

retrieve

public Report retrieve(String id)
                throws EasyPostException

Retrieve a Report from the API.

Parameters:

id - the ID of the Report to retrieve.

Returns:

Report object.

Throws:

EasyPostException - when the request fails.

all

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

Get a list of Reports from the API.

Parameters:

params - a map of parameters.

Returns:

ReportCollection object.

Throws:

EasyPostException - when the request fails.

getNextPage

public ReportCollection getNextPage(ReportCollection collection)
                             throws EndOfPaginationError

Get the next page of an ReportCollection.

Parameters:

collection - ReportCollection to get next page of.

Returns:

ReportCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an ReportCollection.

Parameters:

collection - ReportCollection to get next page of.

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

Returns:

ReportCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.