Class ClaimService

java.lang.Object

com.easypost.service.ClaimService

public class ClaimService
extends Object

Method Summary

Modifier and Type	Method	Description
ClaimCollection	all(Map<String,Object> params)	Get a list of Claims.
Claim	cancel(String id)	Cancel an Claim from the API.
Claim	create(Map<String,Object> params)	Create a new claim object from a map of parameters.
ClaimCollection	getNextPage(ClaimCollection collection)	Get the next page of an ClaimCollection.
ClaimCollection	getNextPage(ClaimCollection collection, Integer pageSize)	Get the next page of an ClaimCollection.
Claim	retrieve(String id)	Retrieve an Claim 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 Claim create(Map<String,Object> params)
             throws EasyPostException

Create a new claim object from a map of parameters.

Parameters:

params - Map of parameters.

Returns:

Claim object

Throws:

EasyPostException - when the request fails.

retrieve

public Claim retrieve(String id)
               throws EasyPostException

Retrieve an Claim from the API.

Parameters:

id - The ID of the Claim to retrieve.

Returns:

Claim object

Throws:

EasyPostException - when the request fails.

all

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

Get a list of Claims.

Parameters:

params - a map of parameters

Returns:

ClaimCollection object

Throws:

EasyPostException - when the request fails.

cancel

public Claim cancel(String id)
             throws EasyPostException

Cancel an Claim from the API.

Parameters:

id - The ID of the Claim to cancel.

Returns:

Claim object

Throws:

EasyPostException - when the request fails.

getNextPage

public ClaimCollection getNextPage(ClaimCollection collection)
                            throws EndOfPaginationError

Get the next page of an ClaimCollection.

Parameters:

collection - ClaimCollection to get next page of.

Returns:

ClaimCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an ClaimCollection.

Parameters:

collection - ClaimCollection to get next page of.

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

Returns:

ClaimCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.