Skip to content

Latest commit

 

History

History
223 lines (154 loc) · 6.86 KB

devices.md

File metadata and controls

223 lines (154 loc) · 6.86 KB
Raw

Devices

$devicesApi = $client->getDevicesApi();

Class Name

DevicesApi

Methods

List Devices

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

function listDevices(
    ?string $cursor = null,
    ?string $sortOrder = null,
    ?int $limit = null,
    ?string $locationId = null
): ApiResponse

Parameters

Parameter Type Tags Description
cursor ?string Query, Optional 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 for more information.
sortOrder ?string(SortOrder) Query, Optional The order in which results are listed.

- ASC - Oldest to newest.
- DESC - Newest to oldest (default).
limit ?int Query, Optional The number of results to return in a single page.
locationId ?string Query, Optional If present, only returns devices at the target location.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListDevicesResponse.

Example Usage

$apiResponse = $devicesApi->listDevices();

if ($apiResponse->isSuccess()) {
    $listDevicesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

List Device Codes

Lists all DeviceCodes associated with the merchant.

function listDeviceCodes(
    ?string $cursor = null,
    ?string $locationId = null,
    ?string $productType = null,
    ?string $status = null
): ApiResponse

Parameters

Parameter Type Tags Description
cursor ?string Query, Optional 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 for more information.
locationId ?string Query, Optional If specified, only returns DeviceCodes of the specified location.
Returns DeviceCodes of all locations if empty.
productType ?string(ProductType) Query, Optional If specified, only returns DeviceCodes targeting the specified product type.
Returns DeviceCodes of all product types if empty.
status ?string(DeviceCodeStatus) Query, Optional If specified, returns DeviceCodes with the specified statuses.
Returns DeviceCodes of status PAIRED and UNPAIRED if empty.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListDeviceCodesResponse.

Example Usage

$apiResponse = $devicesApi->listDeviceCodes();

if ($apiResponse->isSuccess()) {
    $listDeviceCodesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Create Device Code

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

function createDeviceCode(CreateDeviceCodeRequest $body): ApiResponse

Parameters

Parameter Type Tags Description
body CreateDeviceCodeRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type CreateDeviceCodeResponse.

Example Usage

$body = CreateDeviceCodeRequestBuilder::init(
    '01bb00a6-0c86-4770-94ed-f5fca973cd56',
    DeviceCodeBuilder::init()
        ->name('Counter 1')
        ->locationId('B5E4484SHHNYH')
        ->build()
)->build();

$apiResponse = $devicesApi->createDeviceCode($body);

if ($apiResponse->isSuccess()) {
    $createDeviceCodeResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Get Device Code

Retrieves DeviceCode with the associated ID.

function getDeviceCode(string $id): ApiResponse

Parameters

Parameter Type Tags Description
id string Template, Required The unique identifier for the device code.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type GetDeviceCodeResponse.

Example Usage

$id = 'id0';

$apiResponse = $devicesApi->getDeviceCode($id);

if ($apiResponse->isSuccess()) {
    $getDeviceCodeResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Get Device

Retrieves Device with the associated device_id.

function getDevice(string $deviceId): ApiResponse

Parameters

Parameter Type Tags Description
deviceId string Template, Required The unique ID for the desired Device.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type GetDeviceResponse.

Example Usage

$deviceId = 'device_id6';

$apiResponse = $devicesApi->getDevice($deviceId);

if ($apiResponse->isSuccess()) {
    $getDeviceResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());