DeviceCode

April 22, 2020 ยท View on GitHub

Description

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe unique id for this device code.[optional]
namegetName()setName($value)stringAn optional user-defined name for the device code.[optional]
codegetCode()setCode($value)stringThe unique code that can be used to login.[optional]
device_idgetDeviceId()setDeviceId($value)stringThe unique id of the device that used this code. Populated when the device is paired up.[optional]
product_typegetProductType()setProductType($value)stringThe targeting product type of the device code. See ProductType for possible values
location_idgetLocationId()setLocationId($value)stringThe location assigned to this code.[optional]
statusgetStatus()setStatus($value)stringThe pairing status of the device code. See DeviceCodeStatus for possible values[optional]
pair_bygetPairBy()setPairBy($value)stringWhen this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.[optional]
created_atgetCreatedAt()setCreatedAt($value)stringWhen this DeviceCode was created. Timestamp in RFC 3339 format.[optional]
status_changed_atgetStatusChangedAt()setStatusChangedAt($value)stringWhen this DeviceCode's status was last changed. Timestamp in RFC 3339 format.[optional]
paired_atgetPairedAt()setPairedAt($value)stringWhen this DeviceCode was paired. Timestamp in RFC 3339 format.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]