@seamapi/types 1.345.0 → 1.345.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +262 -699
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +149 -499
- package/lib/seam/connect/models/devices/device-type.js +3 -1
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/phone-properties.js +7 -3
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +29 -2450
- package/lib/seam/connect/models/devices/phone.js +36 -15
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +104 -158
- package/lib/seam/connect/openapi.js +68 -503
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +45 -341
- package/package.json +2 -2
- package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
- package/src/lib/seam/connect/models/devices/phone-properties.ts +36 -32
- package/src/lib/seam/connect/models/devices/phone.ts +53 -15
- package/src/lib/seam/connect/openapi.ts +250 -723
- package/src/lib/seam/connect/route-types.ts +45 -419
|
@@ -5048,7 +5048,11 @@ export default {
|
|
|
5048
5048
|
],
|
|
5049
5049
|
type: 'string',
|
|
5050
5050
|
},
|
|
5051
|
-
{
|
|
5051
|
+
{
|
|
5052
|
+
description: 'Type of phone.',
|
|
5053
|
+
enum: ['ios_phone', 'android_phone'],
|
|
5054
|
+
type: 'string',
|
|
5055
|
+
},
|
|
5052
5056
|
],
|
|
5053
5057
|
},
|
|
5054
5058
|
display_name: {
|
|
@@ -5466,6 +5470,7 @@ export default {
|
|
|
5466
5470
|
type: 'object',
|
|
5467
5471
|
},
|
|
5468
5472
|
{
|
|
5473
|
+
description: 'Properties of the phone.',
|
|
5469
5474
|
properties: {
|
|
5470
5475
|
assa_abloy_credential_service_metadata: {
|
|
5471
5476
|
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
@@ -10954,36 +10959,10 @@ export default {
|
|
|
10954
10959
|
'x-route-path': '/noise_sensors/noise_thresholds',
|
|
10955
10960
|
},
|
|
10956
10961
|
phone: {
|
|
10957
|
-
description: '
|
|
10962
|
+
description: "Represents an app user's mobile phone.",
|
|
10958
10963
|
properties: {
|
|
10959
|
-
can_hvac_cool: { type: 'boolean' },
|
|
10960
|
-
can_hvac_heat: { type: 'boolean' },
|
|
10961
|
-
can_hvac_heat_cool: { type: 'boolean' },
|
|
10962
|
-
can_program_offline_access_codes: { type: 'boolean' },
|
|
10963
|
-
can_program_online_access_codes: { type: 'boolean' },
|
|
10964
|
-
can_remotely_lock: { type: 'boolean' },
|
|
10965
|
-
can_remotely_unlock: { type: 'boolean' },
|
|
10966
|
-
can_simulate_connection: { type: 'boolean' },
|
|
10967
|
-
can_simulate_disconnection: { type: 'boolean' },
|
|
10968
|
-
can_simulate_removal: { type: 'boolean' },
|
|
10969
|
-
can_turn_off_hvac: { type: 'boolean' },
|
|
10970
|
-
capabilities_supported: {
|
|
10971
|
-
description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
|
|
10972
|
-
items: {
|
|
10973
|
-
enum: [
|
|
10974
|
-
'access_code',
|
|
10975
|
-
'lock',
|
|
10976
|
-
'noise_detection',
|
|
10977
|
-
'thermostat',
|
|
10978
|
-
'battery',
|
|
10979
|
-
'phone',
|
|
10980
|
-
],
|
|
10981
|
-
type: 'string',
|
|
10982
|
-
},
|
|
10983
|
-
type: 'array',
|
|
10984
|
-
},
|
|
10985
10964
|
created_at: {
|
|
10986
|
-
description: 'Date and time at which the
|
|
10965
|
+
description: 'Date and time at which the `phone` was created.',
|
|
10987
10966
|
format: 'date-time',
|
|
10988
10967
|
type: 'string',
|
|
10989
10968
|
},
|
|
@@ -10991,266 +10970,41 @@ export default {
|
|
|
10991
10970
|
additionalProperties: {
|
|
10992
10971
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
10993
10972
|
},
|
|
10973
|
+
description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.',
|
|
10994
10974
|
type: 'object',
|
|
10995
10975
|
},
|
|
10996
10976
|
device_id: {
|
|
10997
|
-
description: '
|
|
10977
|
+
description: 'ID of the `phone`.',
|
|
10998
10978
|
format: 'uuid',
|
|
10999
10979
|
type: 'string',
|
|
11000
10980
|
},
|
|
11001
10981
|
device_type: {
|
|
11002
10982
|
description: 'Type of phone.',
|
|
11003
|
-
enum: ['
|
|
10983
|
+
enum: ['ios_phone', 'android_phone'],
|
|
11004
10984
|
type: 'string',
|
|
11005
10985
|
},
|
|
11006
10986
|
display_name: {
|
|
11007
|
-
description: 'Display name of the
|
|
10987
|
+
description: 'Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.',
|
|
11008
10988
|
type: 'string',
|
|
11009
10989
|
},
|
|
11010
10990
|
errors: {
|
|
11011
|
-
description: '
|
|
10991
|
+
description: 'Errors associated with the `phone`.',
|
|
11012
10992
|
items: {
|
|
11013
|
-
|
|
11014
|
-
|
|
11015
|
-
{
|
|
11016
|
-
description: 'Device is offline',
|
|
11017
|
-
properties: {
|
|
11018
|
-
error_code: {
|
|
11019
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11020
|
-
enum: ['device_offline'],
|
|
11021
|
-
type: 'string',
|
|
11022
|
-
},
|
|
11023
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11024
|
-
message: { type: 'string' },
|
|
11025
|
-
},
|
|
11026
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11027
|
-
type: 'object',
|
|
11028
|
-
},
|
|
11029
|
-
{
|
|
11030
|
-
description: 'Device has been removed',
|
|
11031
|
-
properties: {
|
|
11032
|
-
error_code: {
|
|
11033
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11034
|
-
enum: ['device_removed'],
|
|
11035
|
-
type: 'string',
|
|
11036
|
-
},
|
|
11037
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11038
|
-
message: { type: 'string' },
|
|
11039
|
-
},
|
|
11040
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11041
|
-
type: 'object',
|
|
11042
|
-
},
|
|
11043
|
-
{
|
|
11044
|
-
description: 'Hub is disconnected',
|
|
11045
|
-
properties: {
|
|
11046
|
-
error_code: {
|
|
11047
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11048
|
-
enum: ['hub_disconnected'],
|
|
11049
|
-
type: 'string',
|
|
11050
|
-
},
|
|
11051
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11052
|
-
message: { type: 'string' },
|
|
11053
|
-
},
|
|
11054
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11055
|
-
type: 'object',
|
|
11056
|
-
},
|
|
11057
|
-
{
|
|
11058
|
-
description: 'Device is disconnected',
|
|
11059
|
-
properties: {
|
|
11060
|
-
error_code: {
|
|
11061
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11062
|
-
enum: ['device_disconnected'],
|
|
11063
|
-
type: 'string',
|
|
11064
|
-
},
|
|
11065
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11066
|
-
message: { type: 'string' },
|
|
11067
|
-
},
|
|
11068
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11069
|
-
type: 'object',
|
|
11070
|
-
},
|
|
11071
|
-
{
|
|
11072
|
-
description: 'The backup access code pool is empty.',
|
|
11073
|
-
properties: {
|
|
11074
|
-
error_code: {
|
|
11075
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11076
|
-
enum: ['empty_backup_access_code_pool'],
|
|
11077
|
-
type: 'string',
|
|
11078
|
-
},
|
|
11079
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11080
|
-
message: { type: 'string' },
|
|
11081
|
-
},
|
|
11082
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11083
|
-
type: 'object',
|
|
11084
|
-
},
|
|
11085
|
-
{
|
|
11086
|
-
description: 'User is not authorized to use the August Lock.',
|
|
11087
|
-
properties: {
|
|
11088
|
-
error_code: {
|
|
11089
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11090
|
-
enum: ['august_lock_not_authorized'],
|
|
11091
|
-
type: 'string',
|
|
11092
|
-
},
|
|
11093
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11094
|
-
message: { type: 'string' },
|
|
11095
|
-
},
|
|
11096
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11097
|
-
type: 'object',
|
|
11098
|
-
},
|
|
11099
|
-
{
|
|
11100
|
-
description: 'Lock is not connected to the Seam Bridge.',
|
|
11101
|
-
properties: {
|
|
11102
|
-
error_code: {
|
|
11103
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11104
|
-
enum: ['august_lock_missing_bridge'],
|
|
11105
|
-
type: 'string',
|
|
11106
|
-
},
|
|
11107
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11108
|
-
message: { type: 'string' },
|
|
11109
|
-
},
|
|
11110
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11111
|
-
type: 'object',
|
|
11112
|
-
},
|
|
11113
|
-
{
|
|
11114
|
-
description: 'Salto site user limit reached.',
|
|
11115
|
-
properties: {
|
|
11116
|
-
error_code: {
|
|
11117
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11118
|
-
enum: ['salto_site_user_limit_reached'],
|
|
11119
|
-
type: 'string',
|
|
11120
|
-
},
|
|
11121
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11122
|
-
message: { type: 'string' },
|
|
11123
|
-
},
|
|
11124
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11125
|
-
type: 'object',
|
|
11126
|
-
},
|
|
11127
|
-
{
|
|
11128
|
-
description: 'Lock is not paired with a Gateway.',
|
|
11129
|
-
properties: {
|
|
11130
|
-
error_code: {
|
|
11131
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11132
|
-
enum: ['ttlock_lock_not_paired_to_gateway'],
|
|
11133
|
-
type: 'string',
|
|
11134
|
-
},
|
|
11135
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11136
|
-
message: { type: 'string' },
|
|
11137
|
-
},
|
|
11138
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11139
|
-
type: 'object',
|
|
11140
|
-
},
|
|
11141
|
-
{
|
|
11142
|
-
description: 'Missing device credentials.',
|
|
11143
|
-
properties: {
|
|
11144
|
-
error_code: {
|
|
11145
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11146
|
-
enum: ['missing_device_credentials'],
|
|
11147
|
-
type: 'string',
|
|
11148
|
-
},
|
|
11149
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11150
|
-
message: { type: 'string' },
|
|
11151
|
-
},
|
|
11152
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11153
|
-
type: 'object',
|
|
11154
|
-
},
|
|
11155
|
-
{
|
|
11156
|
-
description: 'The auxiliary heat is running.',
|
|
11157
|
-
properties: {
|
|
11158
|
-
error_code: {
|
|
11159
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11160
|
-
enum: ['auxiliary_heat_running'],
|
|
11161
|
-
type: 'string',
|
|
11162
|
-
},
|
|
11163
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11164
|
-
message: { type: 'string' },
|
|
11165
|
-
},
|
|
11166
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11167
|
-
type: 'object',
|
|
11168
|
-
},
|
|
11169
|
-
{
|
|
11170
|
-
description: 'Subscription required to connect.',
|
|
11171
|
-
properties: {
|
|
11172
|
-
error_code: {
|
|
11173
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11174
|
-
enum: ['subscription_required'],
|
|
11175
|
-
type: 'string',
|
|
11176
|
-
},
|
|
11177
|
-
is_device_error: { enum: [true], type: 'boolean' },
|
|
11178
|
-
message: { type: 'string' },
|
|
11179
|
-
},
|
|
11180
|
-
required: ['message', 'is_device_error', 'error_code'],
|
|
11181
|
-
type: 'object',
|
|
11182
|
-
},
|
|
11183
|
-
{
|
|
11184
|
-
description: 'Account is disconnected.',
|
|
11185
|
-
properties: {
|
|
11186
|
-
error_code: {
|
|
11187
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11188
|
-
enum: ['account_disconnected'],
|
|
11189
|
-
type: 'string',
|
|
11190
|
-
},
|
|
11191
|
-
is_connected_account_error: {
|
|
11192
|
-
enum: [true],
|
|
11193
|
-
type: 'boolean',
|
|
11194
|
-
},
|
|
11195
|
-
message: { type: 'string' },
|
|
11196
|
-
},
|
|
11197
|
-
required: [
|
|
11198
|
-
'message',
|
|
11199
|
-
'is_connected_account_error',
|
|
11200
|
-
'error_code',
|
|
11201
|
-
],
|
|
11202
|
-
type: 'object',
|
|
11203
|
-
},
|
|
11204
|
-
{
|
|
11205
|
-
description: 'Credentials provided were invalid.',
|
|
11206
|
-
properties: {
|
|
11207
|
-
error_code: {
|
|
11208
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
11209
|
-
enum: ['invalid_credentials'],
|
|
11210
|
-
type: 'string',
|
|
11211
|
-
},
|
|
11212
|
-
is_connected_account_error: {
|
|
11213
|
-
enum: [true],
|
|
11214
|
-
type: 'boolean',
|
|
11215
|
-
},
|
|
11216
|
-
message: { type: 'string' },
|
|
11217
|
-
},
|
|
11218
|
-
required: [
|
|
11219
|
-
'message',
|
|
11220
|
-
'is_connected_account_error',
|
|
11221
|
-
'error_code',
|
|
11222
|
-
],
|
|
11223
|
-
type: 'object',
|
|
11224
|
-
},
|
|
11225
|
-
],
|
|
11226
|
-
},
|
|
11227
|
-
type: 'array',
|
|
11228
|
-
},
|
|
11229
|
-
is_managed: {
|
|
11230
|
-
description: 'Indicates whether Seam manages the device.',
|
|
11231
|
-
enum: [true],
|
|
11232
|
-
type: 'boolean',
|
|
11233
|
-
},
|
|
11234
|
-
location: {
|
|
11235
|
-
description: 'Location information for the device.',
|
|
11236
|
-
nullable: true,
|
|
11237
|
-
properties: {
|
|
11238
|
-
location_name: {
|
|
11239
|
-
description: 'Name of the device location.',
|
|
11240
|
-
type: 'string',
|
|
11241
|
-
},
|
|
11242
|
-
timezone: {
|
|
11243
|
-
description: 'Time zone of the device location.',
|
|
11244
|
-
type: 'string',
|
|
10993
|
+
properties: {
|
|
10994
|
+
error_code: { type: 'string' },
|
|
10995
|
+
message: { type: 'string' },
|
|
11245
10996
|
},
|
|
10997
|
+
required: ['error_code', 'message'],
|
|
10998
|
+
type: 'object',
|
|
11246
10999
|
},
|
|
11247
|
-
type: '
|
|
11000
|
+
type: 'array',
|
|
11248
11001
|
},
|
|
11249
11002
|
nickname: {
|
|
11250
|
-
description: 'Optional nickname to describe the
|
|
11003
|
+
description: 'Optional nickname to describe the phone, settable through Seam.',
|
|
11251
11004
|
type: 'string',
|
|
11252
11005
|
},
|
|
11253
11006
|
properties: {
|
|
11007
|
+
description: 'Properties of the phone.',
|
|
11254
11008
|
properties: {
|
|
11255
11009
|
assa_abloy_credential_service_metadata: {
|
|
11256
11010
|
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
@@ -11296,255 +11050,37 @@ export default {
|
|
|
11296
11050
|
type: 'object',
|
|
11297
11051
|
},
|
|
11298
11052
|
warnings: {
|
|
11299
|
-
description: '
|
|
11053
|
+
description: 'Warnings associated with the `phone`.',
|
|
11300
11054
|
items: {
|
|
11301
|
-
|
|
11302
|
-
|
|
11303
|
-
{
|
|
11304
|
-
|
|
11305
|
-
|
|
11306
|
-
|
|
11307
|
-
warning_code: {
|
|
11308
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11309
|
-
enum: ['partial_backup_access_code_pool'],
|
|
11310
|
-
type: 'string',
|
|
11311
|
-
},
|
|
11312
|
-
},
|
|
11313
|
-
required: ['message', 'warning_code'],
|
|
11314
|
-
type: 'object',
|
|
11315
|
-
},
|
|
11316
|
-
{
|
|
11317
|
-
description: 'Too many backup codes.',
|
|
11318
|
-
properties: {
|
|
11319
|
-
message: { type: 'string' },
|
|
11320
|
-
warning_code: {
|
|
11321
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11322
|
-
enum: ['many_active_backup_codes'],
|
|
11323
|
-
type: 'string',
|
|
11324
|
-
},
|
|
11325
|
-
},
|
|
11326
|
-
required: ['message', 'warning_code'],
|
|
11327
|
-
type: 'object',
|
|
11328
|
-
},
|
|
11329
|
-
{
|
|
11330
|
-
description: 'A Salto Lock displaying an unknown device type.',
|
|
11331
|
-
properties: {
|
|
11332
|
-
message: { type: 'string' },
|
|
11333
|
-
warning_code: {
|
|
11334
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11335
|
-
enum: ['salto_unknown_device_type'],
|
|
11336
|
-
type: 'string',
|
|
11337
|
-
},
|
|
11338
|
-
},
|
|
11339
|
-
required: ['message', 'warning_code'],
|
|
11340
|
-
type: 'object',
|
|
11341
|
-
},
|
|
11342
|
-
{
|
|
11343
|
-
description: 'Wyze Lock is not connected to a gateway.',
|
|
11344
|
-
properties: {
|
|
11345
|
-
message: { type: 'string' },
|
|
11346
|
-
warning_code: {
|
|
11347
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11348
|
-
enum: ['wyze_device_missing_gateway'],
|
|
11349
|
-
type: 'string',
|
|
11350
|
-
},
|
|
11351
|
-
},
|
|
11352
|
-
required: ['message', 'warning_code'],
|
|
11353
|
-
type: 'object',
|
|
11354
|
-
},
|
|
11355
|
-
{
|
|
11356
|
-
description: 'Device is offline, but has some functionality available.',
|
|
11357
|
-
properties: {
|
|
11358
|
-
message: { type: 'string' },
|
|
11359
|
-
warning_code: {
|
|
11360
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11361
|
-
enum: ['functional_offline_device'],
|
|
11362
|
-
type: 'string',
|
|
11363
|
-
},
|
|
11364
|
-
},
|
|
11365
|
-
required: ['message', 'warning_code'],
|
|
11366
|
-
type: 'object',
|
|
11367
|
-
},
|
|
11368
|
-
{
|
|
11369
|
-
description: 'Third-party integration detected.',
|
|
11370
|
-
properties: {
|
|
11371
|
-
message: { type: 'string' },
|
|
11372
|
-
warning_code: {
|
|
11373
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11374
|
-
enum: ['third_party_integration_detected'],
|
|
11375
|
-
type: 'string',
|
|
11376
|
-
},
|
|
11377
|
-
},
|
|
11378
|
-
required: ['message', 'warning_code'],
|
|
11379
|
-
type: 'object',
|
|
11380
|
-
},
|
|
11381
|
-
{
|
|
11382
|
-
description: 'Nest thermostat in manual eco mode.',
|
|
11383
|
-
properties: {
|
|
11384
|
-
message: { type: 'string' },
|
|
11385
|
-
warning_code: {
|
|
11386
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11387
|
-
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
11388
|
-
type: 'string',
|
|
11389
|
-
},
|
|
11390
|
-
},
|
|
11391
|
-
required: ['message', 'warning_code'],
|
|
11392
|
-
type: 'object',
|
|
11393
|
-
},
|
|
11394
|
-
{
|
|
11395
|
-
description: 'Remote Unlock feature not enabled in settings.',
|
|
11396
|
-
properties: {
|
|
11397
|
-
message: { type: 'string' },
|
|
11398
|
-
warning_code: {
|
|
11399
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11400
|
-
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
11401
|
-
type: 'string',
|
|
11402
|
-
},
|
|
11403
|
-
},
|
|
11404
|
-
required: ['message', 'warning_code'],
|
|
11405
|
-
type: 'object',
|
|
11406
|
-
},
|
|
11407
|
-
{
|
|
11408
|
-
description: 'Gateway signal is weak.',
|
|
11409
|
-
properties: {
|
|
11410
|
-
message: { type: 'string' },
|
|
11411
|
-
warning_code: {
|
|
11412
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11413
|
-
enum: ['ttlock_weak_gateway_signal'],
|
|
11414
|
-
type: 'string',
|
|
11415
|
-
},
|
|
11416
|
-
},
|
|
11417
|
-
required: ['message', 'warning_code'],
|
|
11418
|
-
type: 'object',
|
|
11419
|
-
},
|
|
11420
|
-
{
|
|
11421
|
-
description: 'Temperature threshold exceeded.',
|
|
11422
|
-
properties: {
|
|
11423
|
-
message: { type: 'string' },
|
|
11424
|
-
warning_code: {
|
|
11425
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11426
|
-
enum: ['temperature_threshold_exceeded'],
|
|
11427
|
-
type: 'string',
|
|
11428
|
-
},
|
|
11429
|
-
},
|
|
11430
|
-
required: ['message', 'warning_code'],
|
|
11431
|
-
type: 'object',
|
|
11432
|
-
},
|
|
11433
|
-
{
|
|
11434
|
-
description: 'Device appears to be unresponsive.',
|
|
11435
|
-
properties: {
|
|
11436
|
-
message: { type: 'string' },
|
|
11437
|
-
warning_code: {
|
|
11438
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11439
|
-
enum: ['device_communication_degraded'],
|
|
11440
|
-
type: 'string',
|
|
11441
|
-
},
|
|
11442
|
-
},
|
|
11443
|
-
required: ['message', 'warning_code'],
|
|
11444
|
-
type: 'object',
|
|
11445
|
-
},
|
|
11446
|
-
{
|
|
11447
|
-
description: 'Scheduled maintenance window detected.',
|
|
11448
|
-
properties: {
|
|
11449
|
-
message: { type: 'string' },
|
|
11450
|
-
warning_code: {
|
|
11451
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11452
|
-
enum: ['scheduled_maintenance_window'],
|
|
11453
|
-
type: 'string',
|
|
11454
|
-
},
|
|
11455
|
-
},
|
|
11456
|
-
required: ['message', 'warning_code'],
|
|
11457
|
-
type: 'object',
|
|
11458
|
-
},
|
|
11459
|
-
{
|
|
11460
|
-
description: 'Device has flaky connection.',
|
|
11461
|
-
properties: {
|
|
11462
|
-
message: { type: 'string' },
|
|
11463
|
-
warning_code: {
|
|
11464
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11465
|
-
enum: ['device_has_flaky_connection'],
|
|
11466
|
-
type: 'string',
|
|
11467
|
-
},
|
|
11468
|
-
},
|
|
11469
|
-
required: ['message', 'warning_code'],
|
|
11470
|
-
type: 'object',
|
|
11471
|
-
},
|
|
11472
|
-
{
|
|
11473
|
-
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
11474
|
-
properties: {
|
|
11475
|
-
message: { type: 'string' },
|
|
11476
|
-
warning_code: {
|
|
11477
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11478
|
-
enum: ['salto_office_mode'],
|
|
11479
|
-
type: 'string',
|
|
11480
|
-
},
|
|
11481
|
-
},
|
|
11482
|
-
required: ['message', 'warning_code'],
|
|
11483
|
-
type: 'object',
|
|
11484
|
-
},
|
|
11485
|
-
{
|
|
11486
|
-
description: 'Lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
11487
|
-
properties: {
|
|
11488
|
-
message: { type: 'string' },
|
|
11489
|
-
warning_code: {
|
|
11490
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11491
|
-
enum: ['salto_privacy_mode'],
|
|
11492
|
-
type: 'string',
|
|
11493
|
-
},
|
|
11494
|
-
},
|
|
11495
|
-
required: ['message', 'warning_code'],
|
|
11496
|
-
type: 'object',
|
|
11497
|
-
},
|
|
11498
|
-
{
|
|
11499
|
-
description: 'An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone.',
|
|
11500
|
-
properties: {
|
|
11501
|
-
message: { type: 'string' },
|
|
11502
|
-
warning_code: {
|
|
11503
|
-
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11504
|
-
enum: ['unknown_issue_with_phone'],
|
|
11505
|
-
type: 'string',
|
|
11506
|
-
},
|
|
11507
|
-
},
|
|
11508
|
-
required: ['message', 'warning_code'],
|
|
11509
|
-
type: 'object',
|
|
11510
|
-
},
|
|
11511
|
-
],
|
|
11055
|
+
properties: {
|
|
11056
|
+
message: { type: 'string' },
|
|
11057
|
+
warning_code: { type: 'string' },
|
|
11058
|
+
},
|
|
11059
|
+
required: ['warning_code', 'message'],
|
|
11060
|
+
type: 'object',
|
|
11512
11061
|
},
|
|
11513
11062
|
type: 'array',
|
|
11514
11063
|
},
|
|
11515
11064
|
workspace_id: {
|
|
11516
|
-
description: '
|
|
11065
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.',
|
|
11517
11066
|
format: 'uuid',
|
|
11518
11067
|
type: 'string',
|
|
11519
11068
|
},
|
|
11520
11069
|
},
|
|
11521
11070
|
required: [
|
|
11522
11071
|
'device_id',
|
|
11523
|
-
'device_type',
|
|
11524
11072
|
'display_name',
|
|
11525
|
-
'capabilities_supported',
|
|
11526
|
-
'properties',
|
|
11527
|
-
'location',
|
|
11528
11073
|
'workspace_id',
|
|
11529
|
-
'errors',
|
|
11530
|
-
'warnings',
|
|
11531
11074
|
'created_at',
|
|
11532
|
-
'is_managed',
|
|
11533
11075
|
'custom_metadata',
|
|
11076
|
+
'errors',
|
|
11077
|
+
'warnings',
|
|
11078
|
+
'device_type',
|
|
11079
|
+
'properties',
|
|
11534
11080
|
],
|
|
11535
11081
|
type: 'object',
|
|
11536
11082
|
'x-route-path': '/phones',
|
|
11537
11083
|
},
|
|
11538
|
-
service_health: {
|
|
11539
|
-
properties: {
|
|
11540
|
-
description: { type: 'string' },
|
|
11541
|
-
service: { type: 'string' },
|
|
11542
|
-
status: { enum: ['healthy', 'degraded', 'down'], type: 'string' },
|
|
11543
|
-
},
|
|
11544
|
-
required: ['service', 'status', 'description'],
|
|
11545
|
-
type: 'object',
|
|
11546
|
-
'x-route-path': '/health',
|
|
11547
|
-
},
|
|
11548
11084
|
thermostat_schedule: {
|
|
11549
11085
|
description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
|
|
11550
11086
|
properties: {
|
|
@@ -13098,7 +12634,11 @@ export default {
|
|
|
13098
12634
|
],
|
|
13099
12635
|
type: 'string',
|
|
13100
12636
|
},
|
|
13101
|
-
{
|
|
12637
|
+
{
|
|
12638
|
+
description: 'Type of phone.',
|
|
12639
|
+
enum: ['ios_phone', 'android_phone'],
|
|
12640
|
+
type: 'string',
|
|
12641
|
+
},
|
|
13102
12642
|
],
|
|
13103
12643
|
},
|
|
13104
12644
|
errors: {
|
|
@@ -19874,7 +19414,11 @@ export default {
|
|
|
19874
19414
|
],
|
|
19875
19415
|
type: 'string',
|
|
19876
19416
|
},
|
|
19877
|
-
{
|
|
19417
|
+
{
|
|
19418
|
+
description: 'Type of phone.',
|
|
19419
|
+
enum: ['ios_phone', 'android_phone'],
|
|
19420
|
+
type: 'string',
|
|
19421
|
+
},
|
|
19878
19422
|
],
|
|
19879
19423
|
},
|
|
19880
19424
|
device_types: {
|
|
@@ -19927,6 +19471,7 @@ export default {
|
|
|
19927
19471
|
type: 'string',
|
|
19928
19472
|
},
|
|
19929
19473
|
{
|
|
19474
|
+
description: 'Type of phone.',
|
|
19930
19475
|
enum: ['ios_phone', 'android_phone'],
|
|
19931
19476
|
type: 'string',
|
|
19932
19477
|
},
|
|
@@ -20392,7 +19937,11 @@ export default {
|
|
|
20392
19937
|
],
|
|
20393
19938
|
type: 'string',
|
|
20394
19939
|
},
|
|
20395
|
-
{
|
|
19940
|
+
{
|
|
19941
|
+
description: 'Type of phone.',
|
|
19942
|
+
enum: ['ios_phone', 'android_phone'],
|
|
19943
|
+
type: 'string',
|
|
19944
|
+
},
|
|
20396
19945
|
],
|
|
20397
19946
|
},
|
|
20398
19947
|
device_types: {
|
|
@@ -20445,6 +19994,7 @@ export default {
|
|
|
20445
19994
|
type: 'string',
|
|
20446
19995
|
},
|
|
20447
19996
|
{
|
|
19997
|
+
description: 'Type of phone.',
|
|
20448
19998
|
enum: ['ios_phone', 'android_phone'],
|
|
20449
19999
|
type: 'string',
|
|
20450
20000
|
},
|
|
@@ -21225,7 +20775,11 @@ export default {
|
|
|
21225
20775
|
],
|
|
21226
20776
|
type: 'string',
|
|
21227
20777
|
},
|
|
21228
|
-
{
|
|
20778
|
+
{
|
|
20779
|
+
description: 'Type of phone.',
|
|
20780
|
+
enum: ['ios_phone', 'android_phone'],
|
|
20781
|
+
type: 'string',
|
|
20782
|
+
},
|
|
21229
20783
|
],
|
|
21230
20784
|
},
|
|
21231
20785
|
device_types: {
|
|
@@ -21278,6 +20832,7 @@ export default {
|
|
|
21278
20832
|
type: 'string',
|
|
21279
20833
|
},
|
|
21280
20834
|
{
|
|
20835
|
+
description: 'Type of phone.',
|
|
21281
20836
|
enum: ['ios_phone', 'android_phone'],
|
|
21282
20837
|
type: 'string',
|
|
21283
20838
|
},
|
|
@@ -21706,7 +21261,11 @@ export default {
|
|
|
21706
21261
|
],
|
|
21707
21262
|
type: 'string',
|
|
21708
21263
|
},
|
|
21709
|
-
{
|
|
21264
|
+
{
|
|
21265
|
+
description: 'Type of phone.',
|
|
21266
|
+
enum: ['ios_phone', 'android_phone'],
|
|
21267
|
+
type: 'string',
|
|
21268
|
+
},
|
|
21710
21269
|
],
|
|
21711
21270
|
},
|
|
21712
21271
|
device_types: {
|
|
@@ -21759,6 +21318,7 @@ export default {
|
|
|
21759
21318
|
type: 'string',
|
|
21760
21319
|
},
|
|
21761
21320
|
{
|
|
21321
|
+
description: 'Type of phone.',
|
|
21762
21322
|
enum: ['ios_phone', 'android_phone'],
|
|
21763
21323
|
type: 'string',
|
|
21764
21324
|
},
|
|
@@ -23151,7 +22711,11 @@ export default {
|
|
|
23151
22711
|
],
|
|
23152
22712
|
type: 'string',
|
|
23153
22713
|
},
|
|
23154
|
-
{
|
|
22714
|
+
{
|
|
22715
|
+
description: 'Type of phone.',
|
|
22716
|
+
enum: ['ios_phone', 'android_phone'],
|
|
22717
|
+
type: 'string',
|
|
22718
|
+
},
|
|
23155
22719
|
],
|
|
23156
22720
|
},
|
|
23157
22721
|
device_types: {
|
|
@@ -23204,6 +22768,7 @@ export default {
|
|
|
23204
22768
|
type: 'string',
|
|
23205
22769
|
},
|
|
23206
22770
|
{
|
|
22771
|
+
description: 'Type of phone.',
|
|
23207
22772
|
enum: ['ios_phone', 'android_phone'],
|
|
23208
22773
|
type: 'string',
|
|
23209
22774
|
},
|