whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
square
/
square
/
doc
/
apis
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/square/square/doc/apis/devices.md
# Devices ```php $devicesApi = $client->getDevicesApi(); ``` ## Class Name `DevicesApi` ## Methods * [List Device Codes](../../doc/apis/devices.md#list-device-codes) * [Create Device Code](../../doc/apis/devices.md#create-device-code) * [Get Device Code](../../doc/apis/devices.md#get-device-code) # List Device Codes Lists all DeviceCodes associated with the merchant. ```php 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.<br>Provide this to retrieve the next set of results for your original query.<br><br>See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | | `locationId` | `?string` | Query, Optional | If specified, only returns DeviceCodes of the specified location.<br>Returns DeviceCodes of all locations if empty. | | `productType` | [`?string(ProductType)`](../../doc/models/product-type.md) | Query, Optional | If specified, only returns DeviceCodes targeting the specified product type.<br>Returns DeviceCodes of all product types if empty. | | `status` | [`?string(DeviceCodeStatus)`](../../doc/models/device-code-status.md) | Query, Optional | If specified, returns DeviceCodes with the specified statuses.<br>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`](../../doc/models/list-device-codes-response.md). ## Example Usage ```php $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. ```php function createDeviceCode(CreateDeviceCodeRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`CreateDeviceCodeRequest`](../../doc/models/create-device-code-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>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`](../../doc/models/create-device-code-response.md). ## Example Usage ```php $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. ```php 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`](../../doc/models/get-device-code-response.md). ## Example Usage ```php $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()); ```
Copyright ©2021 || Defacer Indonesia