```
public class DevicesApi
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class DevicesApi.APIgetDeviceRequest

Constructor Summary

Constructors
Constructor Description

DevicesApi()

DevicesApi(FinixClient finixClient)

Method Summary

All Methods Instance Methods Concrete Methods
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, GetDeviceQueryParams getDeviceQueryParams)`	Fetch a Device Retrieve the details of an existing `Device`.
`String`	`getCustomBaseUrl()`
`FinixClient`	`getFinixClient()`
`int`	`getHostIndex()`
`void`	`setCustomBaseUrl(String customBaseUrl)`
`void`	`setFinixClient(FinixClient finixClient)`
`void`	`setHostIndex(int hostIndex)`
`Device`	`update(String deviceId, UpdateDeviceRequest updateDeviceRequest)`	Initiate Action on Device Initiate an action on a `Device`.
`okhttp3.Call`	`updateDeviceAsync(String deviceId, UpdateDeviceRequest updateDeviceRequest, ApiCallback<Device> _callback)`	Initiate Action on Device (asynchronously) Initiate an action on a `Device`.
`okhttp3.Call`	`updateDeviceCall(String deviceId, UpdateDeviceRequest updateDeviceRequest, ApiCallback _callback)`	Build call for updateDevice
`ApiResponse<Device>`	`updateDeviceWithHttpInfo(String deviceId, UpdateDeviceRequest updateDeviceRequest)`	Initiate Action on Device Initiate an action on a `Device`.

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

Constructor Detail

DevicesApi
```
public DevicesApi()
```

DevicesApi

public DevicesApi(FinixClient finixClient)

Method Detail

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 -

get

public Device get(String deviceId,
                  GetDeviceQueryParams getDeviceQueryParams)
           throws ApiException

Fetch a 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:

APIgetDeviceRequest

Throws:

ApiException

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 -

updateDeviceCall

public okhttp3.Call updateDeviceCall(String deviceId,
                                     UpdateDeviceRequest updateDeviceRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for updateDevice

Parameters:

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

updateDeviceRequest - (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,
                     UpdateDeviceRequest updateDeviceRequest)
              throws ApiException

Initiate Action on Device Initiate an action on a `Device`. These actions include activation, rebooting, setting an idle message, or deactivate it.

Parameters:

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

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

updateDeviceWithHttpInfo

public ApiResponse<Device> updateDeviceWithHttpInfo(String deviceId,
                                                    UpdateDeviceRequest updateDeviceRequest)
                                             throws ApiException

Initiate Action on Device Initiate an action on a `Device`. These actions include activation, rebooting, setting an idle message, or deactivate it.

Parameters:

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

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

updateDeviceAsync

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

Initiate Action on Device (asynchronously) Initiate an action on a `Device`. These actions include activation, rebooting, setting an idle message, or deactivate it.

Parameters:

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

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

Class DevicesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DevicesApi

DevicesApi

Method Detail

getFinixClient

setFinixClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

createMerchantDeviceCall

create

createMerchantDeviceWithHttpInfo

createMerchantDeviceAsync

get

updateDeviceCall

update

updateDeviceWithHttpInfo

updateDeviceAsync