com.phaxio.repositories

Class FaxRepository

java.lang.Object

com.phaxio.repositories.FaxRepository

public class FaxRepository
extends Object

Constructor Summary

Constructors

Constructor and Description
FaxRepository(Requests client)

Method Summary

Modifier and Type	Method and Description
Fax	create(Map<String,Object> options) Sends a fax
Iterable<Fax>	list() Lists sent faxes
Iterable<Fax>	list(Map<String,Object> filters) Lists sent faxes that match the given filters
Fax	retrieve(int id) Retrieves a fax by id
void	testReceiveCallback(Map<String,Object> options) Sends a request to Phaxio to test a callback (web hook).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaxRepository

public FaxRepository(Requests client)

Method Detail

create

public Fax create(Map<String,Object> options)

Sends a fax

Parameters:

options - A HashMap representing all the parameters for the fax. See the Phaxio documentation for the exact parameter names. Note that for fields that allow multiple items, use square brackets in the key and a Collection as the value. Files can be added as File, a String file path or wrapped in new FileStream(inputStream, fileName).

Returns:

The newly created Fax

retrieve

public Fax retrieve(int id)

Retrieves a fax by id

Parameters:

id - The ID of the fax you'd like to retrieve

Returns:

The fax

list

public Iterable<Fax> list()

Lists sent faxes

Returns:

A list of faxes

list

public Iterable<Fax> list(Map<String,Object> filters)

Lists sent faxes that match the given filters

Parameters:

filters - The filters to apply (see the API documentation for parameters)

Returns:

A list of faxes

testReceiveCallback

public void testReceiveCallback(Map<String,Object> options)

Sends a request to Phaxio to test a callback (web hook).

Parameters:

options - The options for the callback - see the API documentation for the parameter names