java.lang.Object
- net.interfax.rest.client.impl.AbstractInterFAXClient
- - net.interfax.rest.client.impl.DefaultInterFAXClient

All Implemented Interfaces:: InterFAX

public class DefaultInterFAXClient
extends AbstractInterFAXClient
implements InterFAX

Field Summary
- Fields inherited from class net.interfax.rest.client.impl.AbstractInterFAXClient
  accountsBalanceEndpoint, hostname, inboundFaxesEmailsEndpoint, inboundFaxesEndpoint, inboundFaxesImageEndpoint, inboundFaxesMarkEndpoint, inboundFaxesResendEndpoint, outboundDocumentsEndpoint, outboundFaxesCancelEndpoint, outboundFaxesCompletedEndpoint, outboundFaxesEndpoint, outboundFaxesHideEndpoint, outboundFaxesRecordEndpoint, outboundFaxesResendEndpoint, outboundFaxImageEndpoint, outboundSearchEndpoint, password, port, scheme, username

Constructor Summary

Constructors
Constructor Description

DefaultInterFAXClient()

DefaultInterFAXClient(String username, String password)

Method Summary

All Methods Instance Methods Concrete 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`.

Methods inherited from class net.interfax.rest.client.impl.AbstractInterFAXClient
getOutboundDocumentsUri, getSendFaxUri, getUploadedDocumentListUri, initialiseCredentials, readConfigAndInitializeEndpoints

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultInterFAXClient
```
public DefaultInterFAXClient(String username,
                             String password)
```
  - DefaultInterFAXClient
```
public DefaultInterFAXClient()
```
- Method Detail
  - sendFax
```
public APIResponse sendFax(String faxNumber,
                           File fileToSendAsFax)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send a single file as fax
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           File fileToSendAsFax,
                           Optional<SendFaxOptions> options)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send a single file as fax with additional SendFaxOptions
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           File[] filesToSendAsFax)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send an array of files as a fax
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           InputStream[] streamsToSendAsFax,
                           String[] fileNames)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send an array of input streams as a fax
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           File[] filesToSendAsFax,
                           Optional<SendFaxOptions> options)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send an array of files as a fax with additional SendFaxOptions
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           InputStream[] streamsToSendAsFax,
                           String[] mediaTypes,
                           Optional<SendFaxOptions> options)
                    throws IOException,
                           URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send an array of input streams as a fax with additional SendFaxOptions
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse sendFax(String faxNumber,
                           String urlOfDoc)
                    throws URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send a pre-uploaded document, available on a HTTP url, as a fax
    
    Specified by:
    
    sendFax in interface InterFAX
    
    Parameters:
    
    faxNumber - number to fax to
    
    urlOfDoc - url of doc to send as fax
    
    Returns:
    
    APIResponse
    
    Throws:
    
    URISyntaxException
  - sendFax
```
public APIResponse sendFax(String faxNumber,
                           String urlOfDoc,
                           Optional<SendFaxOptions> options)
                    throws URISyntaxException
```
    Description copied from interface: InterFAX
    
    Send a pre-uploaded document, available on a HTTP url, as a fax with additional SendFaxOptions
    
    Specified by:
    
    sendFax in interface InterFAX
    
    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
```
public APIResponse resendFax(String id,
                             Optional<String> faxNumber)
```
    Description copied from interface: InterFAX
    
    Resend a previously-submitted fax, without needing to re-upload the original document
    
    Specified by:
    
    resendFax in interface InterFAX
    
    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
  - hideFax
```
public APIResponse hideFax(String id)
```
    Description copied from interface: InterFAX
    
    Hide a fax from listing in queries (there is no way to unhide a fax)
    
    Specified by:
    
    hideFax in interface InterFAX
    
    Parameters:
    
    id - ID of fax to be hidden
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2940
  - getFaxList
```
public OutboundFaxStructure[] getFaxList()
                                  throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get a list of recent outbound faxes (which does not include batch faxes)
    
    Specified by:
    
    getFaxList in interface InterFAX
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2920
  - getFaxList
```
public OutboundFaxStructure[] getFaxList(Optional<GetFaxListOptions> options)
                                  throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get a list of recent outbound faxes (which does not include batch faxes) with GetFaxListOptions
    
    Specified by:
    
    getFaxList in interface InterFAX
    
    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
```
public OutboundFaxStructure[] getCompletedFaxList(String[] ids)
                                           throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get details for a subset of completed faxes from a submitted list. (Submitted id's which have not completed are ignored).
    
    Specified by:
    
    getCompletedFaxList in interface InterFAX
    
    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
```
public OutboundFaxStructure getOutboundFaxRecord(String id)
                                          throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieves information regarding a previously-submitted fax, including its current status
    
    Specified by:
    
    getOutboundFaxRecord in interface InterFAX
    
    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
```
public byte[] getOutboundFaxImage(String id)
                           throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieve the fax image (TIFF file) of a submitted fax
    
    Specified by:
    
    getOutboundFaxImage in interface InterFAX
    
    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
```
public APIResponse cancelFax(String id)
```
    Description copied from interface: InterFAX
    
    Cancel a fax in progress
    
    Specified by:
    
    cancelFax in interface InterFAX
    
    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
```
public OutboundFaxStructure[] searchFaxList()
                                     throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Search for outbound faxes
    
    Specified by:
    
    searchFaxList in interface InterFAX
    
    Returns:
    
    array of OutboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2959
  - searchFaxList
```
public OutboundFaxStructure[] searchFaxList(Optional<SearchFaxOptions> options)
                                     throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Search for outbound faxes with SearchFaxOptions
    
    Specified by:
    
    searchFaxList in interface InterFAX
    
    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
  - uploadDocument
```
public APIResponse uploadDocument(File fileToUpload)
```
    Description copied from interface: InterFAX
    
    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
    
    Specified by:
    
    uploadDocument in interface InterFAX
    
    Parameters:
    
    fileToUpload - file to upload
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2963
  - uploadDocument
```
public APIResponse uploadDocument(File fileToUpload,
                                  Optional<DocumentUploadSessionOptions> options)
```
    Description copied from interface: InterFAX
    
    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
    
    Specified by:
    
    uploadDocument in interface InterFAX
    
    Parameters:
    
    fileToUpload - file to upload
    
    options - DocumentUploadSessionOptions
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2963
  - uploadChunk
```
public APIResponse uploadChunk(String uploadChunkToDocumentEndpoint,
                               byte[] bytesToUpload,
                               int startByteRange,
                               int endByteRange,
                               boolean lastChunk)
```
    Description copied from interface: InterFAX
    
    Upload chunks to an existing document upload session
    
    Specified by:
    
    uploadChunk in interface InterFAX
    
    Returns:
    
    APIResponse
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2966
  - getUploadedDocumentsList
```
public UploadedDocumentStatus[] getUploadedDocumentsList()
                                                  throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get a list of previous document uploads which are currently available
    
    Specified by:
    
    getUploadedDocumentsList in interface InterFAX
    
    Returns:
    
    array of UploadedDocumentStatus
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2968
  - getUploadedDocumentsList
```
public UploadedDocumentStatus[] getUploadedDocumentsList(Optional<GetUploadedDocumentsListOptions> options)
                                                  throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get a list of previous document uploads which are currently available with GetUploadedDocumentsListOptions
    
    Specified by:
    
    getUploadedDocumentsList in interface InterFAX
    
    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
```
public UploadedDocumentStatus getUploadedDocumentStatus(String documentId)
                                                 throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Get the current status of a specific document upload
    
    Specified by:
    
    getUploadedDocumentStatus in interface InterFAX
    
    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
```
public APIResponse cancelDocumentUploadSession(String documentId)
```
    Description copied from interface: InterFAX
    
    Cancel a document upload and tear down the upload session, or delete a previous upload
    
    Specified by:
    
    cancelDocumentUploadSession in interface InterFAX
    
    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
```
public Double getAccountCredits()
                         throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Determine the remaining faxing credits in your account
    
    Specified by:
    
    getAccountCredits in interface InterFAX
    
    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
```
public InboundFaxStructure[] getInboundFaxList()
                                        throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieves a user's list of inbound faxes. (Sort order is always in descending ID)
    
    Specified by:
    
    getInboundFaxList in interface InterFAX
    
    Returns:
    
    array of InboundFaxStructure
    
    Throws:
    
    UnsuccessfulStatusCodeException
    
    See Also:
    
    https://www.interfax.net/en/dev/rest/reference/2935
  - getInboundFaxList
```
public InboundFaxStructure[] getInboundFaxList(Optional<GetInboundFaxListOptions> options)
                                        throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieves a user's list of inbound faxes. (Sort order is always in descending ID) with GetInboundFaxListOptions
    
    Specified by:
    
    getInboundFaxList in interface InterFAX
    
    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
```
public InboundFaxStructure getInboundFaxRecord(String id)
                                        throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieves a single fax's metadata (receive time, sender number, etc.)
    
    Specified by:
    
    getInboundFaxRecord in interface InterFAX
    
    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
```
public byte[] getInboundFaxImage(long id)
                          throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieves a single fax's image
    
    Specified by:
    
    getInboundFaxImage in interface InterFAX
    
    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
```
public InboundFaxesEmailsStructure getInboundFaxForwardingEmails(String id)
                                                          throws UnsuccessfulStatusCodeException
```
    Description copied from interface: InterFAX
    
    Retrieve the list of email addresses to which a fax was forwarded
    
    Specified by:
    
    getInboundFaxForwardingEmails in interface InterFAX
    
    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
```
public APIResponse markInboundFax(String id,
                                  Optional<Boolean> unread)
```
    Description copied from interface: InterFAX
    
    Mark a transaction as read/unread
    
    Specified by:
    
    markInboundFax in interface InterFAX
    
    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
```
public APIResponse resendInboundFax(String id,
                                    Optional<String> email)
```
    Description copied from interface: InterFAX
    
    Resend an inbound fax to a specific email address
    
    Specified by:
    
    resendInboundFax in interface InterFAX
    
    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
```
public void closeClient()
```
    Description copied from interface: InterFAX
    
    Close underlying client and free up any held system resources
    
    Specified by:
    
    closeClient in interface InterFAX

Constructor	Description
`DefaultInterFAXClient()`
`DefaultInterFAXClient(String username, String password)`

Class DefaultInterFAXClient

Field Summary

Fields inherited from class net.interfax.rest.client.impl.AbstractInterFAXClient

Constructor Summary

Method Summary

Methods inherited from class net.interfax.rest.client.impl.AbstractInterFAXClient

Methods inherited from class java.lang.Object

Constructor Detail

DefaultInterFAXClient

DefaultInterFAXClient

Method Detail

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

sendFax

resendFax

hideFax

getFaxList

getFaxList

getCompletedFaxList

getOutboundFaxRecord

getOutboundFaxImage

cancelFax

searchFaxList

searchFaxList

uploadDocument

uploadDocument

uploadChunk

getUploadedDocumentsList

getUploadedDocumentsList

getUploadedDocumentStatus

cancelDocumentUploadSession

getAccountCredits

getInboundFaxList

getInboundFaxList

getInboundFaxRecord

getInboundFaxImage

getInboundFaxForwardingEmails

markInboundFax

resendInboundFax

closeClient