Api

Class DeviceSearchApi

java.lang.Object

Api.DeviceSearchApi

public class DeviceSearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DeviceSearchApi()
DeviceSearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse2005	postSearchQuery(PostDeviceSearchRequest postDeviceSearchRequest) Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.
okhttp3.Call	postSearchQueryAsync(PostDeviceSearchRequest postDeviceSearchRequest, ApiCallback<InlineResponse2005> callback) Retrieve List of Devices for a given search query V2 (asynchronously) Retrieves list of terminals in paginated format.
okhttp3.Call	postSearchQueryCall(PostDeviceSearchRequest postDeviceSearchRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postSearchQuery
InlineResponse2007	postSearchQueryV3(PostDeviceSearchRequestV3 postDeviceSearchRequestV3) Retrieve List of Devices for a given search query Search for devices matching a given search query.
okhttp3.Call	postSearchQueryV3Async(PostDeviceSearchRequestV3 postDeviceSearchRequestV3, ApiCallback<InlineResponse2007> callback) Retrieve List of Devices for a given search query (asynchronously) Search for devices matching a given search query.
okhttp3.Call	postSearchQueryV3Call(PostDeviceSearchRequestV3 postDeviceSearchRequestV3, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postSearchQueryV3
ApiResponse<InlineResponse2007>	postSearchQueryV3WithHttpInfo(PostDeviceSearchRequestV3 postDeviceSearchRequestV3) Retrieve List of Devices for a given search query Search for devices matching a given search query.
ApiResponse<InlineResponse2005>	postSearchQueryWithHttpInfo(PostDeviceSearchRequest postDeviceSearchRequest) Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceSearchApi

public DeviceSearchApi()

DeviceSearchApi

public DeviceSearchApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

postSearchQueryCall

public okhttp3.Call postSearchQueryCall(PostDeviceSearchRequest postDeviceSearchRequest,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for postSearchQuery

Parameters:

postDeviceSearchRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postSearchQuery

public InlineResponse2005 postSearchQuery(PostDeviceSearchRequest postDeviceSearchRequest)
                                   throws ApiException

Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.

Parameters:

postDeviceSearchRequest - (required)

Returns:

InlineResponse2005

Throws:

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

postSearchQueryWithHttpInfo

public ApiResponse<InlineResponse2005> postSearchQueryWithHttpInfo(PostDeviceSearchRequest postDeviceSearchRequest)
                                                            throws ApiException

Retrieve List of Devices for a given search query V2 Retrieves list of terminals in paginated format.

Parameters:

postDeviceSearchRequest - (required)

Returns:

ApiResponse<InlineResponse2005>

Throws:

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

postSearchQueryAsync

public okhttp3.Call postSearchQueryAsync(PostDeviceSearchRequest postDeviceSearchRequest,
                                         ApiCallback<InlineResponse2005> callback)
                                  throws ApiException

Retrieve List of Devices for a given search query V2 (asynchronously) Retrieves list of terminals in paginated format.

Parameters:

postDeviceSearchRequest - (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

postSearchQueryV3Call

public okhttp3.Call postSearchQueryV3Call(PostDeviceSearchRequestV3 postDeviceSearchRequestV3,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException

Build call for postSearchQueryV3

Parameters:

postDeviceSearchRequestV3 - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postSearchQueryV3

public InlineResponse2007 postSearchQueryV3(PostDeviceSearchRequestV3 postDeviceSearchRequestV3)
                                     throws ApiException

Retrieve List of Devices for a given search query Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

Parameters:

postDeviceSearchRequestV3 - (required)

Returns:

InlineResponse2007

Throws:

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

postSearchQueryV3WithHttpInfo

public ApiResponse<InlineResponse2007> postSearchQueryV3WithHttpInfo(PostDeviceSearchRequestV3 postDeviceSearchRequestV3)
                                                              throws ApiException

Retrieve List of Devices for a given search query Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

Parameters:

postDeviceSearchRequestV3 - (required)

Returns:

ApiResponse<InlineResponse2007>

Throws:

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

postSearchQueryV3Async

public okhttp3.Call postSearchQueryV3Async(PostDeviceSearchRequestV3 postDeviceSearchRequestV3,
                                           ApiCallback<InlineResponse2007> callback)
                                    throws ApiException

Retrieve List of Devices for a given search query (asynchronously) Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.

Parameters:

postDeviceSearchRequestV3 - (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