All Known Implementing Classes:

DefaultInterFAXClient
```
public interface InterFAX
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`APIResponse`	`cancelDocumentUploadSession(String documentId)`	Cancel a document upload and tear down the upload session, or delete a previous upload
`APIResponse`	`cancelFax(String id)`	Cancel a fax in progress
`void`	`closeClient()`	Close underlying client and free up any held system resources
`Double`	`getAccountCredits()`	Determine the remaining faxing credits in your account
`OutboundFaxStructure[]`	`getCompletedFaxList(String[] ids)`	Get details for a subset of completed faxes from a submitted list.
`OutboundFaxStructure[]`	`getFaxList()`	Get a list of recent outbound faxes (which does not include batch faxes)
`OutboundFaxStructure[]`	`getFaxList(Optional<GetFaxListOptions> options)`	Get a list of recent outbound faxes (which does not include batch faxes) with `GetFaxListOptions`
`InboundFaxesEmailsStructure`	`getInboundFaxForwardingEmails(String id)`	Retrieve the list of email addresses to which a fax was forwarded
`byte[]`	`getInboundFaxImage(long id)`	Retrieves a single fax's image
`InboundFaxStructure[]`	`getInboundFaxList()`	Retrieves a user's list of inbound faxes.
`InboundFaxStructure[]`	`getInboundFaxList(Optional<GetInboundFaxListOptions> options)`	Retrieves a user's list of inbound faxes.
`InboundFaxStructure`	`getInboundFaxRecord(String id)`	Retrieves a single fax's metadata (receive time, sender number, etc.)
`byte[]`	`getOutboundFaxImage(String id)`	Retrieve the fax image (TIFF file) of a submitted fax
`OutboundFaxStructure`	`getOutboundFaxRecord(String id)`	Retrieves information regarding a previously-submitted fax, including its current status
`UploadedDocumentStatus[]`	`getUploadedDocumentsList()`	Get a list of previous document uploads which are currently available
`UploadedDocumentStatus[]`	`getUploadedDocumentsList(Optional<GetUploadedDocumentsListOptions> options)`	Get a list of previous document uploads which are currently available with `GetUploadedDocumentsListOptions`
`UploadedDocumentStatus`	`getUploadedDocumentStatus(String documentId)`	Get the current status of a specific document upload
`APIResponse`	`hideFax(String id)`	Hide a fax from listing in queries (there is no way to unhide a fax)
`APIResponse`	`markInboundFax(String id, Optional<Boolean> unread)`	Mark a transaction as read/unread
`APIResponse`	`resendFax(String id, Optional<String> faxNumber)`	Resend a previously-submitted fax, without needing to re-upload the original document
`APIResponse`	`resendInboundFax(String id, Optional<String> email)`	Resend an inbound fax to a specific email address
`OutboundFaxStructure[]`	`searchFaxList()`	Search for outbound faxes
`OutboundFaxStructure[]`	`searchFaxList(Optional<SearchFaxOptions> options)`	Search for outbound faxes with `SearchFaxOptions`
`APIResponse`	`sendFax(String faxNumber, File fileToSendAsFax)`	Send a single file as fax
`APIResponse`	`sendFax(String faxNumber, File[] filesToSendAsFax)`	Send an array of files as a fax
`APIResponse`	`sendFax(String faxNumber, File[] filesToSendAsFax, Optional<SendFaxOptions> options)`	Send an array of files as a fax with additional `SendFaxOptions`
`APIResponse`	`sendFax(String faxNumber, File fileToSendAsFax, Optional<SendFaxOptions> options)`	Send a single file as fax with additional `SendFaxOptions`
`APIResponse`	`sendFax(String faxNumber, InputStream[] streamsToSendAsFax, String[] fileNames)`	Send an array of input streams as a fax
`APIResponse`	`sendFax(String faxNumber, InputStream[] streamsToSendAsFax, String[] mediaTypes, Optional<SendFaxOptions> options)`	Send an array of input streams as a fax with additional `SendFaxOptions`
`APIResponse`	`sendFax(String faxNumber, String urlOfDoc)`	Send a pre-uploaded document, available on a HTTP url, as a fax
`APIResponse`	`sendFax(String faxNumber, String urlOfDoc, Optional<SendFaxOptions> options)`	Send a pre-uploaded document, available on a HTTP url, as a fax with additional `SendFaxOptions`
`APIResponse`	`uploadChunk(String uploadChunkToDocumentEndpoint, byte[] bytesToUpload, int startByteRange, int endByteRange, boolean lastChunk)`	Upload chunks to an existing document upload session
`APIResponse`	`uploadDocument(File fileToUpload)`	Upload contents of file as a document to send later as a fax.
`APIResponse`	`uploadDocument(File fileToUpload, Optional<DocumentUploadSessionOptions> options)`	Upload contents of file as a document to send later as a fax, with `DocumentUploadSessionOptions`.

- Method Detail
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    File fileToSendAsFax)
             throws IOException,
                    URISyntaxException
```
    Send a single file as fax
    
    Parameters:
    
    faxNumber - number to fax to
    
    fileToSendAsFax - file to send as fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    File fileToSendAsFax,
                    Optional<SendFaxOptions> options)
             throws IOException,
                    URISyntaxException
```
    Send a single file as fax with additional SendFaxOptions
    
    Parameters:
    
    faxNumber - number to fax to
    
    fileToSendAsFax - file to send as fax
    
    options - SendFaxOptions to use when sending the fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    File[] filesToSendAsFax)
             throws IOException,
                    URISyntaxException
```
    Send an array of files as a fax
    
    Parameters:
    
    faxNumber - number to fax to
    
    filesToSendAsFax - array of files to send as fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    InputStream[] streamsToSendAsFax,
                    String[] fileNames)
             throws IOException,
                    URISyntaxException
```
    Send an array of input streams as a fax
    
    Parameters:
    
    faxNumber - number to fax to
    
    streamsToSendAsFax - array of input streams to send as fax
    
    fileNames - array of file names corresponding to the input streams (for mime detection)
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    File[] filesToSendAsFax,
                    Optional<SendFaxOptions> options)
             throws IOException,
                    URISyntaxException
```
    Send an array of files as a fax with additional SendFaxOptions
    
    Parameters:
    
    faxNumber - number to fax to
    
    filesToSendAsFax - array of files to send as fax
    
    options - SendFaxOptions to use when sending the fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    InputStream[] streamsToSendAsFax,
                    String[] mediaTypes,
                    Optional<SendFaxOptions> options)
             throws IOException,
                    URISyntaxException
```
    Send an array of input streams as a fax with additional SendFaxOptions
    
    Parameters:
    
    faxNumber - number to fax to
    
    streamsToSendAsFax - array of input streams to send as fax
    
    mediaTypes - array of strings representing the MediaType corresponding to the input streams
    
    options - SendFaxOptions to use when sending the fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    IOException
    
    URISyntaxException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2918
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    String urlOfDoc)
             throws URISyntaxException
```
    Send a pre-uploaded document, available on a HTTP url, as a fax
    
    Parameters:
    
    faxNumber - number to fax to
    
    urlOfDoc - url of doc to send as fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    URISyntaxException
  - sendFax
```
APIResponse sendFax(String faxNumber,
                    String urlOfDoc,
                    Optional<SendFaxOptions> options)
             throws URISyntaxException
```
    Send a pre-uploaded document, available on a HTTP url, as a fax with additional SendFaxOptions
    
    Parameters:
    
    faxNumber - number to fax to
    
    urlOfDoc - url of doc to send as fax
    
    options - SendFaxOptions to use when sending the fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    URISyntaxException
  - resendFax
```
APIResponse resendFax(String id,
                      Optional<String> faxNumber)
```
    Resend a previously-submitted fax, without needing to re-upload the original document
    
    Parameters:
    
    id - the ID of the fax to be resent.
    
    faxNumber - optional faxNumber to resend to; if not provided defaults to the fax number to which this fax was previously sent.
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2908
  - getFaxList
```
OutboundFaxStructure[] getFaxList()
                           throws UnsuccessfulStatusCodeException
```
    Get a list of recent outbound faxes (which does not include batch faxes)
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2920
  - getFaxList
```
OutboundFaxStructure[] getFaxList(Optional<GetFaxListOptions> options)
                           throws UnsuccessfulStatusCodeException
```
    Get a list of recent outbound faxes (which does not include batch faxes) with GetFaxListOptions
    
    Parameters:
    
    options - GetFaxListOptions to make the request with
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2920
  - getCompletedFaxList
```
OutboundFaxStructure[] getCompletedFaxList(String[] ids)
                                    throws UnsuccessfulStatusCodeException
```
    Get details for a subset of completed faxes from a submitted list. (Submitted id's which have not completed are ignored).
    
    Parameters:
    
    ids - comma-delimited list of fax id's to retrieve, if they have completed.
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2972
  - getOutboundFaxRecord
```
OutboundFaxStructure getOutboundFaxRecord(String id)
                                   throws UnsuccessfulStatusCodeException
```
    Retrieves information regarding a previously-submitted fax, including its current status
    
    Parameters:
    
    id - the ID of the fax for which to retrieve data.
    
    Returns:
    
    OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2921
  - getOutboundFaxImage
```
byte[] getOutboundFaxImage(String id)
                    throws UnsuccessfulStatusCodeException
```
    Retrieve the fax image (TIFF file) of a submitted fax
    
    Parameters:
    
    id - the ID of the fax for which to retrieve the image.
    
    Returns:
    
    byte[] representation of the image
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2941
  - cancelFax
```
APIResponse cancelFax(String id)
```
    Cancel a fax in progress
    
    Parameters:
    
    id - ID of the fax to be cancelled. Note: This operation may be applied to single faxes or to individual faxes in a batch.
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2939
  - searchFaxList
```
OutboundFaxStructure[] searchFaxList()
                              throws UnsuccessfulStatusCodeException
```
    Search for outbound faxes
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2959
  - searchFaxList
```
OutboundFaxStructure[] searchFaxList(Optional<SearchFaxOptions> options)
                              throws UnsuccessfulStatusCodeException
```
    Search for outbound faxes with SearchFaxOptions
    
    Parameters:
    
    options - SearchFaxOptions to make the request with
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2959
  - hideFax
```
APIResponse hideFax(String id)
```
    Hide a fax from listing in queries (there is no way to unhide a fax)
    
    Parameters:
    
    id - ID of fax to be hidden
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2940
  - uploadDocument
```
APIResponse uploadDocument(File fileToUpload)
```
    Upload contents of file as a document to send later as a fax. Suitable for large files as the upload process automatically breaks the document into 1 MB chunks and uploads them
    
    Parameters:
    
    fileToUpload - file to upload
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2963
  - uploadDocument
```
APIResponse uploadDocument(File fileToUpload,
                           Optional<DocumentUploadSessionOptions> options)
```
    Upload contents of file as a document to send later as a fax, with DocumentUploadSessionOptions. Suitable for large files as the upload process automatically breaks the document into 1 MB chunks and uploads them
    
    Parameters:
    
    fileToUpload - file to upload
    
    options - DocumentUploadSessionOptions
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2963
  - uploadChunk
```
APIResponse uploadChunk(String uploadChunkToDocumentEndpoint,
                        byte[] bytesToUpload,
                        int startByteRange,
                        int endByteRange,
                        boolean lastChunk)
```
    Upload chunks to an existing document upload session
    
    Parameters:
    
    uploadChunkToDocumentEndpoint -
    
    bytesToUpload -
    
    startByteRange -
    
    endByteRange -
    
    lastChunk -
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2966
  - getUploadedDocumentsList
```
UploadedDocumentStatus[] getUploadedDocumentsList()
                                           throws UnsuccessfulStatusCodeException
```
    Get a list of previous document uploads which are currently available
    
    Returns:
    
    array of UploadedDocumentStatus
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2968
  - getUploadedDocumentsList
```
UploadedDocumentStatus[] getUploadedDocumentsList(Optional<GetUploadedDocumentsListOptions> options)
                                           throws UnsuccessfulStatusCodeException
```
    Get a list of previous document uploads which are currently available with GetUploadedDocumentsListOptions
    
    Parameters:
    
    options - GetUploadedDocumentsListOptions to make the request with
    
    Returns:
    
    array of UploadedDocumentStatus
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2968
  - getUploadedDocumentStatus
```
UploadedDocumentStatus getUploadedDocumentStatus(String documentId)
                                          throws UnsuccessfulStatusCodeException
```
    Get the current status of a specific document upload
    
    Parameters:
    
    documentId - the ID of the upload to be queried
    
    Returns:
    
    UploadedDocumentStatus
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2965
  - cancelDocumentUploadSession
```
APIResponse cancelDocumentUploadSession(String documentId)
```
    Cancel a document upload and tear down the upload session, or delete a previous upload
    
    Parameters:
    
    documentId - the ID of the document upload session to be closed
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2964
  - getAccountCredits
```
Double getAccountCredits()
                  throws UnsuccessfulStatusCodeException
```
    Determine the remaining faxing credits in your account
    
    Returns:
    
    Value of outstanding outbound credits in account, in the account's currency
    
    Throws:
    
    UnsuccessfulStatusCodeException - exception with status code and response body if present
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/3001
  - getInboundFaxList
```
InboundFaxStructure[] getInboundFaxList()
                                 throws UnsuccessfulStatusCodeException
```
    Retrieves a user's list of inbound faxes. (Sort order is always in descending ID)
    
    Returns:
    
    array of InboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2935
  - getInboundFaxList
```
InboundFaxStructure[] getInboundFaxList(Optional<GetInboundFaxListOptions> options)
                                 throws UnsuccessfulStatusCodeException
```
    Retrieves a user's list of inbound faxes. (Sort order is always in descending ID) with GetInboundFaxListOptions
    
    Parameters:
    
    options - GetInboundFaxListOptions to make the request with
    
    Returns:
    
    array of InboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2935
  - getInboundFaxRecord
```
InboundFaxStructure getInboundFaxRecord(String id)
                                 throws UnsuccessfulStatusCodeException
```
    Retrieves a single fax's metadata (receive time, sender number, etc.)
    
    Parameters:
    
    id - the ID of the fax data to be retrieved
    
    Returns:
    
    InboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2938
  - getInboundFaxImage
```
byte[] getInboundFaxImage(long id)
                   throws UnsuccessfulStatusCodeException
```
    Retrieves a single fax's image
    
    Parameters:
    
    id - the ID of the fax image to be retrieved
    
    Returns:
    
    byte array representation of the fax image
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2937
  - getInboundFaxForwardingEmails
```
InboundFaxesEmailsStructure getInboundFaxForwardingEmails(String id)
                                                   throws UnsuccessfulStatusCodeException
```
    Retrieve the list of email addresses to which a fax was forwarded
    
    Parameters:
    
    id - the ID of the fax for which forwarding addresses are to be retrieved
    
    Returns:
    
    InboundFaxesEmailsStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2930
  - markInboundFax
```
APIResponse markInboundFax(String id,
                           Optional<Boolean> unread)
```
    Mark a transaction as read/unread
    
    Parameters:
    
    id - the ID of the fax to be marked
    
    unread - FALSE = mark as read, TRUE = mark as unread.
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2936
  - resendInboundFax
```
APIResponse resendInboundFax(String id,
                             Optional<String> email)
```
    Resend an inbound fax to a specific email address
    
    Parameters:
    
    id - the ID of the fax to be resent by email
    
    email - email address to which to forward the inbound fax
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2929
  - closeClient
```
void closeClient()
```
    Close underlying client and free up any held system resources

Interface InterFAX

Method Summary

Method Detail

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

resendFax

getFaxList

getFaxList

getCompletedFaxList

getOutboundFaxRecord

getOutboundFaxImage

cancelFax

searchFaxList

searchFaxList

hideFax

uploadDocument

uploadDocument

uploadChunk

getUploadedDocumentsList

getUploadedDocumentsList

getUploadedDocumentStatus

cancelDocumentUploadSession

getAccountCredits

getInboundFaxList

getInboundFaxList

getInboundFaxRecord

getInboundFaxImage

getInboundFaxForwardingEmails

markInboundFax

resendInboundFax

closeClient