Class ScanformService

java.lang.Object

com.easypost.service.ScanformService

public class ScanformService
extends Object

Method Summary

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

Create a ScanForm from a map of parameters.

Parameters:

params - the map of parameters.

Returns:

ScanForm object.

Throws:

EasyPostException - when the request fails. when the request fails.

retrieve

public ScanForm retrieve(String id)
                  throws EasyPostException

Retrieve a ScanForm from the API.

Parameters:

id - the id of the ScanForm to retrieve.

Returns:

ScanForm object.

Throws:

EasyPostException - when the request fails. when the request fails.

all

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

Get a list of ScanForms from the API.

Parameters:

params - the parameters to send to the API.

Returns:

ScanFormCollection object.

Throws:

EasyPostException - when the request fails. when the request fails.

getNextPage

public ScanFormCollection getNextPage(ScanFormCollection collection)
                               throws EndOfPaginationError

Get the next page of an ScanFormCollection.

Parameters:

collection - ScanFormCollection to get next page of.

Returns:

ScanFormCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.

getNextPage

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

Get the next page of an ScanFormCollection.

Parameters:

collection - ScanFormCollection to get next page of.

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

Returns:

ScanFormCollection object.

Throws:

EndOfPaginationError - when there are no more pages to retrieve.