com.squareup.square.api

Interface DevicesApi

All Known Implementing Classes:

DefaultDevicesApi

public interface DevicesApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CreateDeviceCodeResponse	createDeviceCode(CreateDeviceCodeRequest body) Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
CompletableFuture<CreateDeviceCodeResponse>	createDeviceCodeAsync(CreateDeviceCodeRequest body) Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
GetDeviceResponse	getDevice(String deviceId) Retrieves Device with the associated `device_id`.
CompletableFuture<GetDeviceResponse>	getDeviceAsync(String deviceId) Retrieves Device with the associated `device_id`.
GetDeviceCodeResponse	getDeviceCode(String id) Retrieves DeviceCode with the associated ID.
CompletableFuture<GetDeviceCodeResponse>	getDeviceCodeAsync(String id) Retrieves DeviceCode with the associated ID.
ListDeviceCodesResponse	listDeviceCodes(String cursor, String locationId, String productType, String status) Lists all DeviceCodes associated with the merchant.
CompletableFuture<ListDeviceCodesResponse>	listDeviceCodesAsync(String cursor, String locationId, String productType, String status) Lists all DeviceCodes associated with the merchant.
ListDevicesResponse	listDevices(String cursor, String sortOrder, Integer limit, String locationId) List devices associated with the merchant.
CompletableFuture<ListDevicesResponse>	listDevicesAsync(String cursor, String sortOrder, Integer limit, String locationId) List devices associated with the merchant.

Method Detail

listDevices

ListDevicesResponse listDevices(String cursor,
                                String sortOrder,
                                Integer limit,
                                String locationId)
                         throws ApiException,
                                IOException

List devices associated with the merchant. Currently, only Terminal API devices are supported.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.

sortOrder - Optional parameter: The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

limit - Optional parameter: The number of results to return in a single page.

locationId - Optional parameter: If present, only returns devices at the target location.

Returns:

Returns the ListDevicesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listDevicesAsync

CompletableFuture<ListDevicesResponse> listDevicesAsync(String cursor,
                                                        String sortOrder,
                                                        Integer limit,
                                                        String locationId)

List devices associated with the merchant. Currently, only Terminal API devices are supported.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.

sortOrder - Optional parameter: The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

limit - Optional parameter: The number of results to return in a single page.

locationId - Optional parameter: If present, only returns devices at the target location.

Returns:

Returns the ListDevicesResponse response from the API call

listDeviceCodes

ListDeviceCodesResponse listDeviceCodes(String cursor,
                                        String locationId,
                                        String productType,
                                        String status)
                                 throws ApiException,
                                        IOException

Lists all DeviceCodes associated with the merchant.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

locationId - Optional parameter: If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.

productType - Optional parameter: If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.

status - Optional parameter: If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.

Returns:

Returns the ListDeviceCodesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listDeviceCodesAsync

CompletableFuture<ListDeviceCodesResponse> listDeviceCodesAsync(String cursor,
                                                                String locationId,
                                                                String productType,
                                                                String status)

Lists all DeviceCodes associated with the merchant.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

locationId - Optional parameter: If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.

productType - Optional parameter: If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.

status - Optional parameter: If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.

Returns:

Returns the ListDeviceCodesResponse response from the API call

createDeviceCode

CreateDeviceCodeResponse createDeviceCode(CreateDeviceCodeRequest body)
                                   throws ApiException,
                                          IOException

Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateDeviceCodeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createDeviceCodeAsync

CompletableFuture<CreateDeviceCodeResponse> createDeviceCodeAsync(CreateDeviceCodeRequest body)

Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateDeviceCodeResponse response from the API call

getDeviceCode

GetDeviceCodeResponse getDeviceCode(String id)
                             throws ApiException,
                                    IOException

Retrieves DeviceCode with the associated ID.

Parameters:

id - Required parameter: The unique identifier for the device code.

Returns:

Returns the GetDeviceCodeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getDeviceCodeAsync

CompletableFuture<GetDeviceCodeResponse> getDeviceCodeAsync(String id)

Retrieves DeviceCode with the associated ID.

Parameters:

id - Required parameter: The unique identifier for the device code.

Returns:

Returns the GetDeviceCodeResponse response from the API call

getDevice

GetDeviceResponse getDevice(String deviceId)
                     throws ApiException,
                            IOException

Retrieves Device with the associated `device_id`.

Parameters:

deviceId - Required parameter: The unique ID for the desired `Device`.

Returns:

Returns the GetDeviceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getDeviceAsync

CompletableFuture<GetDeviceResponse> getDeviceAsync(String deviceId)

Retrieves Device with the associated `device_id`.

Parameters:

deviceId - Required parameter: The unique ID for the desired `Device`.

Returns:

Returns the GetDeviceResponse response from the API call