Class InsuranceService

java.lang.Object

com.easypost.service.InsuranceService

public class InsuranceService
extends Object

Method Summary

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

Create a new Insurance object from a map of parameters.

Parameters:

params - Map of parameters.

Returns:

Insurance object

Throws:

EasyPostException - when the request fails.

retrieve

public Insurance retrieve(String id)
                   throws EasyPostException

Retrieve an Insurance from the API.

Parameters:

id - The ID of the Insurance to retrieve.

Returns:

Insurance object

Throws:

EasyPostException - when the request fails.

all

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

Get a list of Insurances.

Parameters:

params - a map of parameters

Returns:

InsuranceCollection object

Throws:

EasyPostException - when the request fails.

refund

public Insurance refund(String id)
                 throws EasyPostException

Refund an Insurance from the API.

Parameters:

id - The ID of the Insurance to refund.

Returns:

Insurance object

Throws:

EasyPostException - when the request fails.

getNextPage

public InsuranceCollection getNextPage(InsuranceCollection collection)
                                throws EndOfPaginationError

Get the next page of an InsuranceCollection.

Parameters:

collection - InsuranceCollection to get next page of.

Returns:

InsuranceCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an InsuranceCollection.

Parameters:

collection - InsuranceCollection to get next page of.

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

Returns:

InsuranceCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.