Package api

Class DevicesApi

java.lang.Object

api.DevicesApi

public class DevicesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DevicesApi()
DevicesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
Device	create(String merchantId, CreateDevice createDevice)	Create a Device Create a `Device` under a `Merchant`.
okhttp3.Call	createMerchantDeviceAsync(String merchantId, CreateDevice createDevice, ApiCallback<Device> _callback)	Create a Device (asynchronously) Create a `Device` under a `Merchant`.
okhttp3.Call	createMerchantDeviceCall(String merchantId, CreateDevice createDevice, ApiCallback _callback)	Build call for createMerchantDevice
ApiResponse<Device>	createMerchantDeviceWithHttpInfo(String merchantId, CreateDevice createDevice)	Create a Device Create a `Device` under a `Merchant`.
Device	get(String deviceId)	Get Device Retrieve the details of an existing `Device`.
String	getCustomBaseUrl()
okhttp3.Call	getDeviceAsync(String deviceId, ApiCallback<Device> _callback)	Get Device (asynchronously) Retrieve the details of an existing `Device`.
okhttp3.Call	getDeviceCall(String deviceId, ApiCallback _callback)	Build call for getDevice
ApiResponse<Device>	getDeviceWithHttpInfo(String deviceId)	Get Device Retrieve the details of an existing `Device`.
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	putDeviceAsync(String deviceId, Object body, ApiCallback<Device> _callback)	Update a Device (asynchronously) Update a `Device` to activate or deactivate it.
okhttp3.Call	putDeviceCall(String deviceId, Object body, ApiCallback _callback)	Build call for putDevice
ApiResponse<Device>	putDeviceWithHttpInfo(String deviceId, Object body)	Update a Device Update a `Device` to activate or deactivate it.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
Device	update(String deviceId, Object body)	Update a Device Update a `Device` to activate or deactivate it.

Methods inherited from class java.lang.Object

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

Constructor Details

DevicesApi

public DevicesApi()

DevicesApi

public DevicesApi(FinixClient finixClient)

Method Details

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createMerchantDeviceCall

public okhttp3.Call createMerchantDeviceCall(String merchantId,
 CreateDevice createDevice,
 ApiCallback _callback)
                                      throws ApiException

Build call for createMerchantDevice

Parameters:

merchantId - ID of the `Merchant` object. (required)

createDevice - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

create

public Device create(String merchantId,
 CreateDevice createDevice)
              throws ApiException

Create a Device Create a `Device` under a `Merchant`.

Parameters:

merchantId - ID of the `Merchant` object. (required)

createDevice - (optional)

Returns:

Device

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createMerchantDeviceWithHttpInfo

public ApiResponse<Device> createMerchantDeviceWithHttpInfo(String merchantId,
 CreateDevice createDevice)
                                                     throws ApiException

Create a Device Create a `Device` under a `Merchant`.

Parameters:

merchantId - ID of the `Merchant` object. (required)

createDevice - (optional)

Returns:

ApiResponse<Device>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createMerchantDeviceAsync

public okhttp3.Call createMerchantDeviceAsync(String merchantId,
 CreateDevice createDevice,
 ApiCallback<Device> _callback)
                                       throws ApiException

Create a Device (asynchronously) Create a `Device` under a `Merchant`.

Parameters:

merchantId - ID of the `Merchant` object. (required)

createDevice - (optional)

_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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDeviceCall

public okhttp3.Call getDeviceCall(String deviceId,
 ApiCallback _callback)
                           throws ApiException

Build call for getDevice

Parameters:

deviceId - ID of the `Device`. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public Device get(String deviceId)
           throws ApiException

Get Device Retrieve the details of an existing `Device`. To check the connectivity of the device, include `?include_connection\\=true \\` at the end of the request endpoint.

Parameters:

deviceId - ID of the `Device`. (required)

Returns:

Device

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDeviceWithHttpInfo

public ApiResponse<Device> getDeviceWithHttpInfo(String deviceId)
                                          throws ApiException

Get Device Retrieve the details of an existing `Device`. To check the connectivity of the device, include `?include_connection\\=true \\` at the end of the request endpoint.

Parameters:

deviceId - ID of the `Device`. (required)

Returns:

ApiResponse<Device>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getDeviceAsync

public okhttp3.Call getDeviceAsync(String deviceId,
 ApiCallback<Device> _callback)
                            throws ApiException

Get Device (asynchronously) Retrieve the details of an existing `Device`. To check the connectivity of the device, include `?include_connection\\=true \\` at the end of the request endpoint.

Parameters:

deviceId - ID of the `Device`. (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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putDeviceCall

public okhttp3.Call putDeviceCall(String deviceId,
 Object body,
 ApiCallback _callback)
                           throws ApiException

Build call for putDevice

Parameters:

deviceId - ID of the `Device`. (required)

body - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

update

public Device update(String deviceId,
 Object body)
              throws ApiException

Update a Device Update a `Device` to activate or deactivate it.

Parameters:

deviceId - ID of the `Device`. (required)

body - (optional)

Returns:

Device

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putDeviceWithHttpInfo

public ApiResponse<Device> putDeviceWithHttpInfo(String deviceId,
 Object body)
                                          throws ApiException

Update a Device Update a `Device` to activate or deactivate it.

Parameters:

deviceId - ID of the `Device`. (required)

body - (optional)

Returns:

ApiResponse<Device>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

putDeviceAsync

public okhttp3.Call putDeviceAsync(String deviceId,
 Object body,
 ApiCallback<Device> _callback)
                            throws ApiException

Update a Device (asynchronously) Update a `Device` to activate or deactivate it.

Parameters:

deviceId - ID of the `Device`. (required)

body - (optional)

_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

Http Response Details:

Status Code	Description	Response Headers
200	Single Device object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -