Class RefundService

java.lang.Object

com.easypost.service.RefundService

public class RefundService
extends Object

Method Summary

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

Create a Refund object from a map of parameters.

Parameters:

params - Map of parameters

Returns:

Refund object

Throws:

EasyPostException - when the request fails.

retrieve

public Refund retrieve(String id)
                throws EasyPostException

Retrieve a Refund object from the API.

Parameters:

id - ID of refund to retrieve

Returns:

Refund object

Throws:

EasyPostException - when the request fails.

all

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

List all Refunds objects.

Parameters:

params - Map of parameters

Returns:

RefundCollection object

Throws:

EasyPostException - when the request fails.

getNextPage

public RefundCollection getNextPage(RefundCollection collection)
                             throws EndOfPaginationError

Get the next page of an RefundCollection.

Parameters:

collection - RefundCollection to get next page of.

Returns:

RefundCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an RefundCollection.

Parameters:

collection - RefundCollection to get next page of.

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

Returns:

RefundCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.