Skip to content

devices.md

Latest commit

 

History

History
146 lines (104 loc) · 4.33 KB

devices.md

File metadata and controls

146 lines (104 loc) · 4.33 KB

Devices

$devicesApi = $client->getDevicesApi();

Class Name

DevicesApi

Methods

List Device Codes

Lists all DeviceCodes associated with the merchant.

function listDeviceCodes(
    ?string $cursor = null,
    ?string $locationId = null,
    ?string $productType = 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.

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

$cursor = 'cursor6';
$locationId = 'location_id4';
$productType = Models\ProductType::TERMINAL_API;

$apiResponse = $devicesApi->listDeviceCodes($cursor, $locationId, $productType);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $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_idempotencyKey = '01bb00a6-0c86-4770-94ed-f5fca973cd56';
$body_deviceCode_productType = 'TERMINAL_API';
$body_deviceCode = new Models\DeviceCode(
    $body_deviceCode_productType
);
$body_deviceCode->setId('id0');
$body_deviceCode->setName('Counter 1');
$body_deviceCode->setCode('code8');
$body_deviceCode->setDeviceId('device_id6');
$body_deviceCode->setLocationId('B5E4484SHHNYH');
$body = new Models\CreateDeviceCodeRequest(
    $body_idempotencyKey,
    $body_deviceCode
);

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

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $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();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();