Package com.mypurecloud.sdk.v2.api

Class FaxApi

java.lang.Object

com.mypurecloud.sdk.v2.api.FaxApi

public class FaxApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FaxApi()
FaxApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteFaxDocument(DeleteFaxDocumentRequest request)	Delete a fax document.
ApiResponse<Void>	deleteFaxDocument(ApiRequest<Void> request)	Delete a fax document.
void	deleteFaxDocument(String documentId)	Delete a fax document.
ApiResponse<Void>	deleteFaxDocumentWithHttpInfo(String documentId)	Delete a fax document.
FaxDocument	getFaxDocument(GetFaxDocumentRequest request)	Get a document.
ApiResponse<FaxDocument>	getFaxDocument(ApiRequest<Void> request)	Get a document.
FaxDocument	getFaxDocument(String documentId)	Get a document.
DownloadResponse	getFaxDocumentContent(GetFaxDocumentContentRequest request)	Download a fax document.
ApiResponse<DownloadResponse>	getFaxDocumentContent(ApiRequest<Void> request)	Download a fax document.
DownloadResponse	getFaxDocumentContent(String documentId)	Download a fax document.
ApiResponse<DownloadResponse>	getFaxDocumentContentWithHttpInfo(String documentId)	Download a fax document.
FaxDocumentEntityListing	getFaxDocuments(GetFaxDocumentsRequest request)	Get a list of fax documents.
ApiResponse<FaxDocumentEntityListing>	getFaxDocuments(ApiRequest<Void> request)	Get a list of fax documents.
FaxDocumentEntityListing	getFaxDocuments(Integer pageSize, Integer pageNumber)	Get a list of fax documents.
ApiResponse<FaxDocumentEntityListing>	getFaxDocumentsWithHttpInfo(Integer pageSize, Integer pageNumber)	Get a list of fax documents.
ApiResponse<FaxDocument>	getFaxDocumentWithHttpInfo(String documentId)	Get a document.
FaxConfig	getFaxSettings()	Get organization config for given organization
FaxConfig	getFaxSettings(GetFaxSettingsRequest request)	Get organization config for given organization
ApiResponse<FaxConfig>	getFaxSettings(ApiRequest<Void> request)	Get organization config for given organization
ApiResponse<FaxConfig>	getFaxSettingsWithHttpInfo()	Get organization config for given organization
FaxSummary	getFaxSummary()	Get fax summary
FaxSummary	getFaxSummary(GetFaxSummaryRequest request)	Get fax summary
ApiResponse<FaxSummary>	getFaxSummary(ApiRequest<Void> request)	Get fax summary
ApiResponse<FaxSummary>	getFaxSummaryWithHttpInfo()	Get fax summary
FaxDocument	putFaxDocument(PutFaxDocumentRequest request)	Update a fax document.
ApiResponse<FaxDocument>	putFaxDocument(ApiRequest<FaxDocument> request)	Update a fax document.
FaxDocument	putFaxDocument(String documentId, FaxDocument body)	Update a fax document.
ApiResponse<FaxDocument>	putFaxDocumentWithHttpInfo(String documentId, FaxDocument body)	Update a fax document.
FaxConfig	putFaxSettings(PutFaxSettingsRequest request)	Update/write organization config for given organization
ApiResponse<FaxConfig>	putFaxSettings(ApiRequest<FaxConfig> request)	Update/write organization config for given organization
FaxConfig	putFaxSettings(FaxConfig body)	Update/write organization config for given organization
ApiResponse<FaxConfig>	putFaxSettingsWithHttpInfo(FaxConfig body)	Update/write organization config for given organization

Methods inherited from class java.lang.Object

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

Constructor Details

FaxApi

public FaxApi()

FaxApi

public FaxApi(ApiClient apiClient)

Method Details

deleteFaxDocument

public void deleteFaxDocument(String documentId)
                       throws IOException,
ApiException

Delete a fax document.

Parameters:

documentId - Document ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFaxDocumentWithHttpInfo

public ApiResponse<Void> deleteFaxDocumentWithHttpInfo(String documentId)
                                                throws IOException

Delete a fax document.

Parameters:

documentId - Document ID (required)

Throws:

IOException - if the request fails to be processed

deleteFaxDocument

public void deleteFaxDocument(DeleteFaxDocumentRequest request)
                       throws IOException,
ApiException

Delete a fax document.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFaxDocument

public ApiResponse<Void> deleteFaxDocument(ApiRequest<Void> request)
                                    throws IOException

Delete a fax document.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFaxDocument

public FaxDocument getFaxDocument(String documentId)
                           throws IOException,
ApiException

Get a document.

Parameters:

documentId - Document ID (required)

Returns:

FaxDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocumentWithHttpInfo

public ApiResponse<FaxDocument> getFaxDocumentWithHttpInfo(String documentId)
                                                    throws IOException

Get a document.

Parameters:

documentId - Document ID (required)

Returns:

FaxDocument

Throws:

IOException - if the request fails to be processed

getFaxDocument

public FaxDocument getFaxDocument(GetFaxDocumentRequest request)
                           throws IOException,
ApiException

Get a document.

Parameters:

request - The request object

Returns:

FaxDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocument

public ApiResponse<FaxDocument> getFaxDocument(ApiRequest<Void> request)
                                        throws IOException

Get a document.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFaxDocumentContent

public DownloadResponse getFaxDocumentContent(String documentId)
                                       throws IOException,
ApiException

Download a fax document.

Parameters:

documentId - Document ID (required)

Returns:

DownloadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocumentContentWithHttpInfo

public ApiResponse<DownloadResponse> getFaxDocumentContentWithHttpInfo(String documentId)
                                                                throws IOException

Download a fax document.

Parameters:

documentId - Document ID (required)

Returns:

DownloadResponse

Throws:

IOException - if the request fails to be processed

getFaxDocumentContent

public DownloadResponse getFaxDocumentContent(GetFaxDocumentContentRequest request)
                                       throws IOException,
ApiException

Download a fax document.

Parameters:

request - The request object

Returns:

DownloadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocumentContent

public ApiResponse<DownloadResponse> getFaxDocumentContent(ApiRequest<Void> request)
                                                    throws IOException

Download a fax document.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFaxDocuments

public FaxDocumentEntityListing getFaxDocuments(Integer pageSize,
 Integer pageNumber)
                                         throws IOException,
ApiException

Get a list of fax documents.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

FaxDocumentEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocumentsWithHttpInfo

public ApiResponse<FaxDocumentEntityListing> getFaxDocumentsWithHttpInfo(Integer pageSize,
 Integer pageNumber)
                                                                  throws IOException

Get a list of fax documents.

Parameters:

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

Returns:

FaxDocumentEntityListing

Throws:

IOException - if the request fails to be processed

getFaxDocuments

public FaxDocumentEntityListing getFaxDocuments(GetFaxDocumentsRequest request)
                                         throws IOException,
ApiException

Get a list of fax documents.

Parameters:

request - The request object

Returns:

FaxDocumentEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxDocuments

public ApiResponse<FaxDocumentEntityListing> getFaxDocuments(ApiRequest<Void> request)
                                                      throws IOException

Get a list of fax documents.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFaxSettings

public FaxConfig getFaxSettings()
                         throws IOException,
ApiException

Get organization config for given organization

Returns:

FaxConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxSettingsWithHttpInfo

public ApiResponse<FaxConfig> getFaxSettingsWithHttpInfo()
                                                  throws IOException

Get organization config for given organization

Returns:

FaxConfig

Throws:

IOException - if the request fails to be processed

getFaxSettings

public FaxConfig getFaxSettings(GetFaxSettingsRequest request)
                         throws IOException,
ApiException

Get organization config for given organization

Parameters:

request - The request object

Returns:

FaxConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxSettings

public ApiResponse<FaxConfig> getFaxSettings(ApiRequest<Void> request)
                                      throws IOException

Get organization config for given organization

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFaxSummary

public FaxSummary getFaxSummary()
                         throws IOException,
ApiException

Get fax summary

Returns:

FaxSummary

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxSummaryWithHttpInfo

public ApiResponse<FaxSummary> getFaxSummaryWithHttpInfo()
                                                  throws IOException

Get fax summary

Returns:

FaxSummary

Throws:

IOException - if the request fails to be processed

getFaxSummary

public FaxSummary getFaxSummary(GetFaxSummaryRequest request)
                         throws IOException,
ApiException

Get fax summary

Parameters:

request - The request object

Returns:

FaxSummary

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFaxSummary

public ApiResponse<FaxSummary> getFaxSummary(ApiRequest<Void> request)
                                      throws IOException

Get fax summary

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFaxDocument

public FaxDocument putFaxDocument(String documentId,
 FaxDocument body)
                           throws IOException,
ApiException

Update a fax document.

Parameters:

documentId - Document ID (required)

body - Document (required)

Returns:

FaxDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFaxDocumentWithHttpInfo

public ApiResponse<FaxDocument> putFaxDocumentWithHttpInfo(String documentId,
 FaxDocument body)
                                                    throws IOException

Update a fax document.

Parameters:

documentId - Document ID (required)

body - Document (required)

Returns:

FaxDocument

Throws:

IOException - if the request fails to be processed

putFaxDocument

public FaxDocument putFaxDocument(PutFaxDocumentRequest request)
                           throws IOException,
ApiException

Update a fax document.

Parameters:

request - The request object

Returns:

FaxDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFaxDocument

public ApiResponse<FaxDocument> putFaxDocument(ApiRequest<FaxDocument> request)
                                        throws IOException

Update a fax document.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFaxSettings

public FaxConfig putFaxSettings(FaxConfig body)
                         throws IOException,
ApiException

Update/write organization config for given organization

Parameters:

body - (optional)

Returns:

FaxConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFaxSettingsWithHttpInfo

public ApiResponse<FaxConfig> putFaxSettingsWithHttpInfo(FaxConfig body)
                                                  throws IOException

Update/write organization config for given organization

Parameters:

body - (optional)

Returns:

FaxConfig

Throws:

IOException - if the request fails to be processed

putFaxSettings

public FaxConfig putFaxSettings(PutFaxSettingsRequest request)
                         throws IOException,
ApiException

Update/write organization config for given organization

Parameters:

request - The request object

Returns:

FaxConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFaxSettings

public ApiResponse<FaxConfig> putFaxSettings(ApiRequest<FaxConfig> request)
                                      throws IOException

Update/write organization config for given organization

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed