Skip to content

Latest commit

 

History

History
203 lines (136 loc) · 5.82 KB

devices.md

File metadata and controls

203 lines (136 loc) · 5.82 KB
Raw

Devices

devices_api = client.devices

Class Name

DevicesApi

Methods

List Devices

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

def list_devices(cursor: nil,
                 sort_order: nil,
                 limit: nil,
                 location_id: nil)

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.
sort_order String (Sort Order) Query, Optional The order in which results are listed.

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

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type List Devices Response Hash.

Example Usage

result = devices_api.list_devices

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

List Device Codes

Lists all DeviceCodes associated with the merchant.

def list_device_codes(cursor: nil,
                      location_id: nil,
                      product_type: nil,
                      status: nil)

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.
location_id String Query, Optional If specified, only returns DeviceCodes of the specified location.
Returns DeviceCodes of all locations if empty.
product_type String (Product Type) Query, Optional If specified, only returns DeviceCodes targeting the specified product type.
Returns DeviceCodes of all product types if empty.
status String (Device Code Status) 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 \ApiResponse instance. The data property in this instance returns the response data which is of type List Device Codes Response Hash.

Example Usage

result = devices_api.list_device_codes

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Create Device Code

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

def create_device_code(body:)

Parameters

Parameter Type Tags Description
body Create Device Code Request Hash 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 \ApiResponse instance. The data property in this instance returns the response data which is of type Create Device Code Response Hash.

Example Usage

body = {
  :idempotency_key => '01bb00a6-0c86-4770-94ed-f5fca973cd56',
  :device_code => {
    :product_type => 'TERMINAL_API',
    :name => 'Counter 1',
    :location_id => 'B5E4484SHHNYH'
  }
}


result = devices_api.create_device_code(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Get Device Code

Retrieves DeviceCode with the associated ID.

def get_device_code(id:)

Parameters

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

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Get Device Code Response Hash.

Example Usage

id = 'id0'


result = devices_api.get_device_code(id: id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Get Device

Retrieves Device with the associated device_id.

def get_device(device_id:)

Parameters

Parameter Type Tags Description
device_id String Template, Required The unique ID for the desired Device.

Response Type

This method returns a \ApiResponse instance. The data property in this instance returns the response data which is of type Get Device Response Hash.

Example Usage

device_id = 'device_id6'


result = devices_api.get_device(device_id: device_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end