ClickSend.Api

Class InboundFaxRulesApi

java.lang.Object

ClickSend.Api.InboundFaxRulesApi

public class InboundFaxRulesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
InboundFaxRulesApi()
InboundFaxRulesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
String	faxInboundAutomationDelete(Integer inboundRuleId) Delete inbound fax automation Delete inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationDeleteAsync(Integer inboundRuleId, ApiCallback<String> callback) Delete inbound fax automation (asynchronously) Delete inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationDeleteCall(Integer inboundRuleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxInboundAutomationDelete
ApiResponse<String>	faxInboundAutomationDeleteWithHttpInfo(Integer inboundRuleId) Delete inbound fax automation Delete inbound fax automation
String	faxInboundAutomationGet(Integer inboundRuleId) Get specific inbound fax automation Get specific inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationGetAsync(Integer inboundRuleId, ApiCallback<String> callback) Get specific inbound fax automation (asynchronously) Get specific inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationGetCall(Integer inboundRuleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxInboundAutomationGet
ApiResponse<String>	faxInboundAutomationGetWithHttpInfo(Integer inboundRuleId) Get specific inbound fax automation Get specific inbound fax automation
String	faxInboundAutomationPost(InboundFaxRule inboundFaxRule) Create new inbound fax automation Create new inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationPostAsync(InboundFaxRule inboundFaxRule, ApiCallback<String> callback) Create new inbound fax automation (asynchronously) Create new inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationPostCall(InboundFaxRule inboundFaxRule, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxInboundAutomationPost
ApiResponse<String>	faxInboundAutomationPostWithHttpInfo(InboundFaxRule inboundFaxRule) Create new inbound fax automation Create new inbound fax automation
String	faxInboundAutomationPut(Integer inboundRuleId, InboundFaxRule inboundFaxRule) Update inbound fax automation Update inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationPutAsync(Integer inboundRuleId, InboundFaxRule inboundFaxRule, ApiCallback<String> callback) Update inbound fax automation (asynchronously) Update inbound fax automation
com.squareup.okhttp.Call	faxInboundAutomationPutCall(Integer inboundRuleId, InboundFaxRule inboundFaxRule, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxInboundAutomationPut
ApiResponse<String>	faxInboundAutomationPutWithHttpInfo(Integer inboundRuleId, InboundFaxRule inboundFaxRule) Update inbound fax automation Update inbound fax automation
String	faxInboundAutomationsGet(String q, Integer page, Integer limit) Get all inbound fax automations Get all inbound fax automations
com.squareup.okhttp.Call	faxInboundAutomationsGetAsync(String q, Integer page, Integer limit, ApiCallback<String> callback) Get all inbound fax automations (asynchronously) Get all inbound fax automations
com.squareup.okhttp.Call	faxInboundAutomationsGetCall(String q, Integer page, Integer limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for faxInboundAutomationsGet
ApiResponse<String>	faxInboundAutomationsGetWithHttpInfo(String q, Integer page, Integer limit) Get all inbound fax automations Get all inbound fax automations
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

InboundFaxRulesApi

public InboundFaxRulesApi()

InboundFaxRulesApi

public InboundFaxRulesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

faxInboundAutomationDeleteCall

public com.squareup.okhttp.Call faxInboundAutomationDeleteCall(Integer inboundRuleId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for faxInboundAutomationDelete

Parameters:

inboundRuleId - Inbound rule id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxInboundAutomationDelete

public String faxInboundAutomationDelete(Integer inboundRuleId)
                                  throws ApiException

Delete inbound fax automation Delete inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationDeleteWithHttpInfo

public ApiResponse<String> faxInboundAutomationDeleteWithHttpInfo(Integer inboundRuleId)
                                                           throws ApiException

Delete inbound fax automation Delete inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationDeleteAsync

public com.squareup.okhttp.Call faxInboundAutomationDeleteAsync(Integer inboundRuleId,
                                                                ApiCallback<String> callback)
                                                         throws ApiException

Delete inbound fax automation (asynchronously) Delete inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

faxInboundAutomationGetCall

public com.squareup.okhttp.Call faxInboundAutomationGetCall(Integer inboundRuleId,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for faxInboundAutomationGet

Parameters:

inboundRuleId - Inbound rule id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxInboundAutomationGet

public String faxInboundAutomationGet(Integer inboundRuleId)
                               throws ApiException

Get specific inbound fax automation Get specific inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationGetWithHttpInfo

public ApiResponse<String> faxInboundAutomationGetWithHttpInfo(Integer inboundRuleId)
                                                        throws ApiException

Get specific inbound fax automation Get specific inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationGetAsync

public com.squareup.okhttp.Call faxInboundAutomationGetAsync(Integer inboundRuleId,
                                                             ApiCallback<String> callback)
                                                      throws ApiException

Get specific inbound fax automation (asynchronously) Get specific inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

faxInboundAutomationPostCall

public com.squareup.okhttp.Call faxInboundAutomationPostCall(InboundFaxRule inboundFaxRule,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for faxInboundAutomationPost

Parameters:

inboundFaxRule - Inbound fax rule model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxInboundAutomationPost

public String faxInboundAutomationPost(InboundFaxRule inboundFaxRule)
                                throws ApiException

Create new inbound fax automation Create new inbound fax automation

Parameters:

inboundFaxRule - Inbound fax rule model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationPostWithHttpInfo

public ApiResponse<String> faxInboundAutomationPostWithHttpInfo(InboundFaxRule inboundFaxRule)
                                                         throws ApiException

Create new inbound fax automation Create new inbound fax automation

Parameters:

inboundFaxRule - Inbound fax rule model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationPostAsync

public com.squareup.okhttp.Call faxInboundAutomationPostAsync(InboundFaxRule inboundFaxRule,
                                                              ApiCallback<String> callback)
                                                       throws ApiException

Create new inbound fax automation (asynchronously) Create new inbound fax automation

Parameters:

inboundFaxRule - Inbound fax rule model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

faxInboundAutomationPutCall

public com.squareup.okhttp.Call faxInboundAutomationPutCall(Integer inboundRuleId,
                                                            InboundFaxRule inboundFaxRule,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for faxInboundAutomationPut

Parameters:

inboundRuleId - Inbound rule id (required)

inboundFaxRule - Inbound fax rule model (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxInboundAutomationPut

public String faxInboundAutomationPut(Integer inboundRuleId,
                                      InboundFaxRule inboundFaxRule)
                               throws ApiException

Update inbound fax automation Update inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

inboundFaxRule - Inbound fax rule model (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationPutWithHttpInfo

public ApiResponse<String> faxInboundAutomationPutWithHttpInfo(Integer inboundRuleId,
                                                               InboundFaxRule inboundFaxRule)
                                                        throws ApiException

Update inbound fax automation Update inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

inboundFaxRule - Inbound fax rule model (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationPutAsync

public com.squareup.okhttp.Call faxInboundAutomationPutAsync(Integer inboundRuleId,
                                                             InboundFaxRule inboundFaxRule,
                                                             ApiCallback<String> callback)
                                                      throws ApiException

Update inbound fax automation (asynchronously) Update inbound fax automation

Parameters:

inboundRuleId - Inbound rule id (required)

inboundFaxRule - Inbound fax rule model (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

faxInboundAutomationsGetCall

public com.squareup.okhttp.Call faxInboundAutomationsGetCall(String q,
                                                             Integer page,
                                                             Integer limit,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for faxInboundAutomationsGet

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

faxInboundAutomationsGet

public String faxInboundAutomationsGet(String q,
                                       Integer page,
                                       Integer limit)
                                throws ApiException

Get all inbound fax automations Get all inbound fax automations

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationsGetWithHttpInfo

public ApiResponse<String> faxInboundAutomationsGetWithHttpInfo(String q,
                                                                Integer page,
                                                                Integer limit)
                                                         throws ApiException

Get all inbound fax automations Get all inbound fax automations

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

faxInboundAutomationsGetAsync

public com.squareup.okhttp.Call faxInboundAutomationsGetAsync(String q,
                                                              Integer page,
                                                              Integer limit,
                                                              ApiCallback<String> callback)
                                                       throws ApiException

Get all inbound fax automations (asynchronously) Get all inbound fax automations

Parameters:

q - Your keyword or query. (optional)

page - Page number (optional, default to 1)

limit - Number of records per page (optional, default to 10)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object