@seamapi/types 1.1101.0 → 1.1103.0
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/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
- package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
- package/lib/seam/connect/models/devices/phone.js +4 -19
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
- package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +1329 -214
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1319 -353
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
- package/src/lib/seam/connect/models/devices/phone.ts +4 -27
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
- package/src/lib/seam/connect/openapi.ts +1505 -203
- package/src/lib/seam/connect/route-types.ts +1526 -428
|
@@ -2220,7 +2220,8 @@ const openapi: OpenAPISpec = {
|
|
|
2220
2220
|
},
|
|
2221
2221
|
error_code: {
|
|
2222
2222
|
description:
|
|
2223
|
-
'Reason the access code could not be revoked
|
|
2223
|
+
'Reason the access code could not be revoked.',
|
|
2224
|
+
enum: ['offline_access_code_not_revocable'],
|
|
2224
2225
|
type: 'string',
|
|
2225
2226
|
},
|
|
2226
2227
|
message: {
|
|
@@ -4413,25 +4414,37 @@ const openapi: OpenAPISpec = {
|
|
|
4413
4414
|
description:
|
|
4414
4415
|
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
4415
4416
|
items: {
|
|
4416
|
-
|
|
4417
|
-
|
|
4418
|
-
|
|
4419
|
-
|
|
4420
|
-
|
|
4421
|
-
},
|
|
4422
|
-
error_code: {
|
|
4423
|
-
description:
|
|
4424
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
4425
|
-
type: 'string',
|
|
4426
|
-
},
|
|
4427
|
-
message: {
|
|
4417
|
+
description:
|
|
4418
|
+
'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
4419
|
+
discriminator: { propertyName: 'error_code' },
|
|
4420
|
+
oneOf: [
|
|
4421
|
+
{
|
|
4428
4422
|
description:
|
|
4429
|
-
'
|
|
4430
|
-
|
|
4423
|
+
'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
4424
|
+
properties: {
|
|
4425
|
+
created_at: {
|
|
4426
|
+
description:
|
|
4427
|
+
'Date and time at which Seam created the error.',
|
|
4428
|
+
format: 'date-time',
|
|
4429
|
+
type: 'string',
|
|
4430
|
+
},
|
|
4431
|
+
error_code: {
|
|
4432
|
+
description:
|
|
4433
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
4434
|
+
enum: ['entrance_removed'],
|
|
4435
|
+
type: 'string',
|
|
4436
|
+
},
|
|
4437
|
+
message: {
|
|
4438
|
+
description:
|
|
4439
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
4440
|
+
type: 'string',
|
|
4441
|
+
},
|
|
4442
|
+
},
|
|
4443
|
+
required: ['created_at', 'message', 'error_code'],
|
|
4444
|
+
type: 'object',
|
|
4445
|
+
'x-resource-type': 'acs_entrance',
|
|
4431
4446
|
},
|
|
4432
|
-
|
|
4433
|
-
required: ['error_code', 'message', 'created_at'],
|
|
4434
|
-
type: 'object',
|
|
4447
|
+
],
|
|
4435
4448
|
},
|
|
4436
4449
|
type: 'array',
|
|
4437
4450
|
},
|
|
@@ -30217,181 +30230,1458 @@ const openapi: OpenAPISpec = {
|
|
|
30217
30230
|
type: 'string',
|
|
30218
30231
|
},
|
|
30219
30232
|
errors: {
|
|
30220
|
-
description:
|
|
30233
|
+
description:
|
|
30234
|
+
'Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
30221
30235
|
items: {
|
|
30222
|
-
|
|
30223
|
-
|
|
30224
|
-
|
|
30225
|
-
|
|
30226
|
-
|
|
30227
|
-
|
|
30228
|
-
|
|
30229
|
-
|
|
30230
|
-
|
|
30236
|
+
discriminator: { propertyName: 'error_code' },
|
|
30237
|
+
oneOf: [
|
|
30238
|
+
{
|
|
30239
|
+
description: 'Indicates that the account is disconnected.',
|
|
30240
|
+
properties: {
|
|
30241
|
+
created_at: {
|
|
30242
|
+
description:
|
|
30243
|
+
'Date and time at which Seam created the error.',
|
|
30244
|
+
format: 'date-time',
|
|
30245
|
+
type: 'string',
|
|
30246
|
+
},
|
|
30247
|
+
error_code: {
|
|
30248
|
+
description:
|
|
30249
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30250
|
+
enum: ['account_disconnected'],
|
|
30251
|
+
type: 'string',
|
|
30252
|
+
},
|
|
30253
|
+
is_connected_account_error: {
|
|
30254
|
+
description:
|
|
30255
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
30256
|
+
enum: [true],
|
|
30257
|
+
type: 'boolean',
|
|
30258
|
+
},
|
|
30259
|
+
is_device_error: {
|
|
30260
|
+
description:
|
|
30261
|
+
'Indicates that the error is not a device error.',
|
|
30262
|
+
enum: [false],
|
|
30263
|
+
type: 'boolean',
|
|
30264
|
+
},
|
|
30265
|
+
message: {
|
|
30266
|
+
description:
|
|
30267
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30268
|
+
type: 'string',
|
|
30269
|
+
},
|
|
30270
|
+
},
|
|
30271
|
+
required: [
|
|
30272
|
+
'message',
|
|
30273
|
+
'is_device_error',
|
|
30274
|
+
'created_at',
|
|
30275
|
+
'error_code',
|
|
30276
|
+
'is_connected_account_error',
|
|
30277
|
+
],
|
|
30278
|
+
type: 'object',
|
|
30279
|
+
'x-resource-type': 'connected_account',
|
|
30231
30280
|
},
|
|
30232
|
-
|
|
30233
|
-
description:
|
|
30234
|
-
|
|
30281
|
+
{
|
|
30282
|
+
description:
|
|
30283
|
+
'Indicates that the Salto site user limit has been reached.',
|
|
30284
|
+
properties: {
|
|
30285
|
+
created_at: {
|
|
30286
|
+
description:
|
|
30287
|
+
'Date and time at which Seam created the error.',
|
|
30288
|
+
format: 'date-time',
|
|
30289
|
+
type: 'string',
|
|
30290
|
+
},
|
|
30291
|
+
error_code: {
|
|
30292
|
+
description:
|
|
30293
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30294
|
+
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
30295
|
+
type: 'string',
|
|
30296
|
+
},
|
|
30297
|
+
is_connected_account_error: {
|
|
30298
|
+
description:
|
|
30299
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
30300
|
+
enum: [true],
|
|
30301
|
+
type: 'boolean',
|
|
30302
|
+
},
|
|
30303
|
+
is_device_error: {
|
|
30304
|
+
description:
|
|
30305
|
+
'Indicates that the error is not a device error.',
|
|
30306
|
+
enum: [false],
|
|
30307
|
+
type: 'boolean',
|
|
30308
|
+
},
|
|
30309
|
+
message: {
|
|
30310
|
+
description:
|
|
30311
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30312
|
+
type: 'string',
|
|
30313
|
+
},
|
|
30314
|
+
},
|
|
30315
|
+
required: [
|
|
30316
|
+
'message',
|
|
30317
|
+
'is_device_error',
|
|
30318
|
+
'created_at',
|
|
30319
|
+
'error_code',
|
|
30320
|
+
'is_connected_account_error',
|
|
30321
|
+
],
|
|
30322
|
+
type: 'object',
|
|
30323
|
+
'x-resource-type': 'connected_account',
|
|
30324
|
+
'x-variant-group-key': 'locks',
|
|
30235
30325
|
},
|
|
30236
|
-
|
|
30237
|
-
|
|
30238
|
-
|
|
30239
|
-
|
|
30240
|
-
|
|
30241
|
-
|
|
30242
|
-
|
|
30243
|
-
|
|
30244
|
-
|
|
30245
|
-
|
|
30246
|
-
|
|
30247
|
-
|
|
30248
|
-
|
|
30249
|
-
|
|
30250
|
-
|
|
30251
|
-
|
|
30252
|
-
|
|
30253
|
-
|
|
30254
|
-
|
|
30255
|
-
|
|
30256
|
-
|
|
30257
|
-
|
|
30258
|
-
|
|
30259
|
-
|
|
30260
|
-
|
|
30261
|
-
|
|
30262
|
-
|
|
30263
|
-
|
|
30264
|
-
|
|
30265
|
-
|
|
30266
|
-
|
|
30267
|
-
|
|
30268
|
-
type: 'object',
|
|
30326
|
+
{
|
|
30327
|
+
description:
|
|
30328
|
+
"Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
|
|
30329
|
+
properties: {
|
|
30330
|
+
created_at: {
|
|
30331
|
+
description:
|
|
30332
|
+
'Date and time at which Seam created the error.',
|
|
30333
|
+
format: 'date-time',
|
|
30334
|
+
type: 'string',
|
|
30335
|
+
},
|
|
30336
|
+
error_code: {
|
|
30337
|
+
description:
|
|
30338
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30339
|
+
enum: ['insufficient_permissions'],
|
|
30340
|
+
type: 'string',
|
|
30341
|
+
},
|
|
30342
|
+
is_connected_account_error: {
|
|
30343
|
+
description:
|
|
30344
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
30345
|
+
enum: [true],
|
|
30346
|
+
type: 'boolean',
|
|
30347
|
+
},
|
|
30348
|
+
is_device_error: {
|
|
30349
|
+
description:
|
|
30350
|
+
'Indicates that the error is not a device error.',
|
|
30351
|
+
enum: [false],
|
|
30352
|
+
type: 'boolean',
|
|
30353
|
+
},
|
|
30354
|
+
message: {
|
|
30355
|
+
description:
|
|
30356
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30357
|
+
type: 'string',
|
|
30269
30358
|
},
|
|
30270
|
-
type: 'array',
|
|
30271
30359
|
},
|
|
30272
|
-
|
|
30273
|
-
|
|
30274
|
-
|
|
30275
|
-
|
|
30360
|
+
required: [
|
|
30361
|
+
'message',
|
|
30362
|
+
'is_device_error',
|
|
30363
|
+
'created_at',
|
|
30364
|
+
'error_code',
|
|
30365
|
+
'is_connected_account_error',
|
|
30366
|
+
],
|
|
30367
|
+
type: 'object',
|
|
30368
|
+
'x-resource-type': 'connected_account',
|
|
30369
|
+
},
|
|
30370
|
+
{
|
|
30371
|
+
description:
|
|
30372
|
+
'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
|
|
30373
|
+
properties: {
|
|
30374
|
+
created_at: {
|
|
30375
|
+
description:
|
|
30376
|
+
'Date and time at which Seam created the error.',
|
|
30377
|
+
format: 'date-time',
|
|
30378
|
+
type: 'string',
|
|
30379
|
+
},
|
|
30380
|
+
error_code: {
|
|
30381
|
+
description:
|
|
30382
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30383
|
+
enum: ['dormakaba_sites_disconnected'],
|
|
30384
|
+
type: 'string',
|
|
30385
|
+
},
|
|
30386
|
+
is_connected_account_error: {
|
|
30387
|
+
description:
|
|
30388
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
30389
|
+
enum: [true],
|
|
30390
|
+
type: 'boolean',
|
|
30391
|
+
},
|
|
30392
|
+
is_device_error: {
|
|
30393
|
+
description:
|
|
30394
|
+
'Indicates that the error is not a device error.',
|
|
30395
|
+
enum: [false],
|
|
30396
|
+
type: 'boolean',
|
|
30397
|
+
},
|
|
30398
|
+
message: {
|
|
30399
|
+
description:
|
|
30400
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30401
|
+
type: 'string',
|
|
30402
|
+
},
|
|
30276
30403
|
},
|
|
30404
|
+
required: [
|
|
30405
|
+
'message',
|
|
30406
|
+
'is_device_error',
|
|
30407
|
+
'created_at',
|
|
30408
|
+
'error_code',
|
|
30409
|
+
'is_connected_account_error',
|
|
30410
|
+
],
|
|
30411
|
+
type: 'object',
|
|
30412
|
+
'x-resource-type': 'connected_account',
|
|
30413
|
+
'x-variant-group-key': 'locks',
|
|
30277
30414
|
},
|
|
30278
|
-
|
|
30279
|
-
|
|
30280
|
-
|
|
30281
|
-
|
|
30282
|
-
|
|
30283
|
-
|
|
30284
|
-
|
|
30285
|
-
|
|
30286
|
-
|
|
30287
|
-
|
|
30415
|
+
{
|
|
30416
|
+
deprecated: true,
|
|
30417
|
+
description: 'Indicates that the device is offline.',
|
|
30418
|
+
properties: {
|
|
30419
|
+
created_at: {
|
|
30420
|
+
description:
|
|
30421
|
+
'Date and time at which Seam created the error.',
|
|
30422
|
+
format: 'date-time',
|
|
30423
|
+
type: 'string',
|
|
30424
|
+
},
|
|
30425
|
+
error_code: {
|
|
30426
|
+
description:
|
|
30427
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30428
|
+
enum: ['device_offline'],
|
|
30429
|
+
type: 'string',
|
|
30430
|
+
},
|
|
30431
|
+
is_device_error: {
|
|
30432
|
+
description:
|
|
30433
|
+
'Indicates that the error is a device error.',
|
|
30434
|
+
enum: [true],
|
|
30435
|
+
type: 'boolean',
|
|
30436
|
+
},
|
|
30437
|
+
message: {
|
|
30438
|
+
description:
|
|
30439
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30440
|
+
type: 'string',
|
|
30441
|
+
},
|
|
30288
30442
|
},
|
|
30443
|
+
required: [
|
|
30444
|
+
'message',
|
|
30445
|
+
'is_device_error',
|
|
30446
|
+
'created_at',
|
|
30447
|
+
'error_code',
|
|
30448
|
+
],
|
|
30449
|
+
type: 'object',
|
|
30450
|
+
'x-deprecated': 'Use `device_disconnected` instead.',
|
|
30451
|
+
'x-resource-type': 'device',
|
|
30289
30452
|
},
|
|
30290
|
-
|
|
30291
|
-
|
|
30292
|
-
|
|
30293
|
-
|
|
30294
|
-
|
|
30295
|
-
|
|
30296
|
-
|
|
30297
|
-
|
|
30298
|
-
|
|
30299
|
-
|
|
30300
|
-
|
|
30301
|
-
|
|
30302
|
-
|
|
30303
|
-
|
|
30453
|
+
{
|
|
30454
|
+
description: 'Indicates that the device has been removed.',
|
|
30455
|
+
properties: {
|
|
30456
|
+
created_at: {
|
|
30457
|
+
description:
|
|
30458
|
+
'Date and time at which Seam created the error.',
|
|
30459
|
+
format: 'date-time',
|
|
30460
|
+
type: 'string',
|
|
30461
|
+
},
|
|
30462
|
+
error_code: {
|
|
30463
|
+
description:
|
|
30464
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30465
|
+
enum: ['device_removed'],
|
|
30466
|
+
type: 'string',
|
|
30467
|
+
},
|
|
30468
|
+
is_device_error: {
|
|
30469
|
+
description:
|
|
30470
|
+
'Indicates that the error is a device error.',
|
|
30471
|
+
enum: [true],
|
|
30472
|
+
type: 'boolean',
|
|
30473
|
+
},
|
|
30474
|
+
message: {
|
|
30475
|
+
description:
|
|
30476
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30477
|
+
type: 'string',
|
|
30478
|
+
},
|
|
30479
|
+
},
|
|
30480
|
+
required: [
|
|
30481
|
+
'message',
|
|
30482
|
+
'is_device_error',
|
|
30483
|
+
'created_at',
|
|
30484
|
+
'error_code',
|
|
30485
|
+
],
|
|
30486
|
+
type: 'object',
|
|
30487
|
+
'x-resource-type': 'device',
|
|
30304
30488
|
},
|
|
30305
|
-
|
|
30306
|
-
description: '
|
|
30307
|
-
|
|
30489
|
+
{
|
|
30490
|
+
description: 'Indicates that the hub is disconnected.',
|
|
30491
|
+
properties: {
|
|
30492
|
+
created_at: {
|
|
30493
|
+
description:
|
|
30494
|
+
'Date and time at which Seam created the error.',
|
|
30495
|
+
format: 'date-time',
|
|
30496
|
+
type: 'string',
|
|
30497
|
+
},
|
|
30498
|
+
error_code: {
|
|
30499
|
+
description:
|
|
30500
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30501
|
+
enum: ['hub_disconnected'],
|
|
30502
|
+
type: 'string',
|
|
30503
|
+
},
|
|
30504
|
+
is_device_error: {
|
|
30505
|
+
description:
|
|
30506
|
+
'Indicates that the error is a device error.',
|
|
30507
|
+
enum: [true],
|
|
30508
|
+
type: 'boolean',
|
|
30509
|
+
},
|
|
30510
|
+
message: {
|
|
30511
|
+
description:
|
|
30512
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30513
|
+
type: 'string',
|
|
30514
|
+
},
|
|
30515
|
+
},
|
|
30516
|
+
required: [
|
|
30517
|
+
'message',
|
|
30518
|
+
'is_device_error',
|
|
30519
|
+
'created_at',
|
|
30520
|
+
'error_code',
|
|
30521
|
+
],
|
|
30522
|
+
type: 'object',
|
|
30523
|
+
'x-resource-type': 'device',
|
|
30308
30524
|
},
|
|
30309
|
-
|
|
30310
|
-
description: '
|
|
30311
|
-
|
|
30525
|
+
{
|
|
30526
|
+
description: 'Indicates that the device is disconnected.',
|
|
30527
|
+
properties: {
|
|
30528
|
+
created_at: {
|
|
30529
|
+
description:
|
|
30530
|
+
'Date and time at which Seam created the error.',
|
|
30531
|
+
format: 'date-time',
|
|
30532
|
+
type: 'string',
|
|
30533
|
+
},
|
|
30534
|
+
error_code: {
|
|
30535
|
+
description:
|
|
30536
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30537
|
+
enum: ['device_disconnected'],
|
|
30538
|
+
type: 'string',
|
|
30539
|
+
},
|
|
30540
|
+
is_device_error: {
|
|
30541
|
+
description:
|
|
30542
|
+
'Indicates that the error is a device error.',
|
|
30543
|
+
enum: [true],
|
|
30544
|
+
type: 'boolean',
|
|
30545
|
+
},
|
|
30546
|
+
message: {
|
|
30547
|
+
description:
|
|
30548
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30549
|
+
type: 'string',
|
|
30550
|
+
},
|
|
30551
|
+
},
|
|
30552
|
+
required: [
|
|
30553
|
+
'message',
|
|
30554
|
+
'is_device_error',
|
|
30555
|
+
'created_at',
|
|
30556
|
+
'error_code',
|
|
30557
|
+
],
|
|
30558
|
+
type: 'object',
|
|
30559
|
+
'x-resource-type': 'device',
|
|
30312
30560
|
},
|
|
30313
|
-
|
|
30314
|
-
required: ['warning_code', 'message', 'created_at'],
|
|
30315
|
-
type: 'object',
|
|
30316
|
-
},
|
|
30317
|
-
type: 'array',
|
|
30318
|
-
},
|
|
30319
|
-
workspace_id: {
|
|
30320
|
-
description: 'ID of the workspace that contains the phone.\n ',
|
|
30321
|
-
format: 'uuid',
|
|
30322
|
-
type: 'string',
|
|
30323
|
-
},
|
|
30324
|
-
},
|
|
30325
|
-
required: [
|
|
30326
|
-
'device_id',
|
|
30327
|
-
'display_name',
|
|
30328
|
-
'workspace_id',
|
|
30329
|
-
'created_at',
|
|
30330
|
-
'custom_metadata',
|
|
30331
|
-
'errors',
|
|
30332
|
-
'warnings',
|
|
30333
|
-
'device_type',
|
|
30334
|
-
'properties',
|
|
30335
|
-
],
|
|
30336
|
-
type: 'object',
|
|
30337
|
-
'x-property-groups': { phones: { name: 'Phones' } },
|
|
30338
|
-
'x-route-path': '/phones',
|
|
30339
|
-
},
|
|
30340
|
-
phone_registration: {
|
|
30341
|
-
description: 'Represents a mobile phone registration.',
|
|
30342
|
-
properties: {
|
|
30343
|
-
is_being_activated: {
|
|
30344
|
-
description: 'Indicates whether the phone is being activated.',
|
|
30345
|
-
type: 'boolean',
|
|
30346
|
-
},
|
|
30347
|
-
phone_registration_id: {
|
|
30348
|
-
description: 'Registration ID for the phone.',
|
|
30349
|
-
type: 'string',
|
|
30350
|
-
},
|
|
30351
|
-
provider_name: {
|
|
30352
|
-
description: 'Provider name for the phone.',
|
|
30353
|
-
nullable: true,
|
|
30354
|
-
type: 'string',
|
|
30355
|
-
},
|
|
30356
|
-
provider_state: {
|
|
30357
|
-
additionalProperties: {},
|
|
30358
|
-
description: 'Provider state for the phone.',
|
|
30359
|
-
nullable: true,
|
|
30360
|
-
type: 'object',
|
|
30361
|
-
},
|
|
30362
|
-
},
|
|
30363
|
-
required: [
|
|
30364
|
-
'phone_registration_id',
|
|
30365
|
-
'provider_state',
|
|
30366
|
-
'provider_name',
|
|
30367
|
-
'is_being_activated',
|
|
30368
|
-
],
|
|
30369
|
-
type: 'object',
|
|
30370
|
-
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
30371
|
-
'x-undocumented': 'Seam Mobile SDK only.',
|
|
30372
|
-
},
|
|
30373
|
-
phone_session: {
|
|
30374
|
-
description: 'Represents a mobile phone session.',
|
|
30375
|
-
properties: {
|
|
30376
|
-
is_sandbox_workspace: {
|
|
30377
|
-
description: 'Whether the workspace is in sandbox mode.',
|
|
30378
|
-
type: 'boolean',
|
|
30379
|
-
},
|
|
30380
|
-
provider_sessions: {
|
|
30381
|
-
description: 'Phone provider sessions.',
|
|
30382
|
-
items: {
|
|
30383
|
-
description: 'Phone provider session.',
|
|
30384
|
-
properties: {
|
|
30385
|
-
acs_credentials: {
|
|
30561
|
+
{
|
|
30386
30562
|
description:
|
|
30387
|
-
'
|
|
30388
|
-
|
|
30389
|
-
|
|
30390
|
-
|
|
30391
|
-
|
|
30392
|
-
|
|
30393
|
-
|
|
30394
|
-
|
|
30563
|
+
'Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
|
|
30564
|
+
properties: {
|
|
30565
|
+
created_at: {
|
|
30566
|
+
description:
|
|
30567
|
+
'Date and time at which Seam created the error.',
|
|
30568
|
+
format: 'date-time',
|
|
30569
|
+
type: 'string',
|
|
30570
|
+
},
|
|
30571
|
+
error_code: {
|
|
30572
|
+
description:
|
|
30573
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30574
|
+
enum: ['empty_backup_access_code_pool'],
|
|
30575
|
+
type: 'string',
|
|
30576
|
+
},
|
|
30577
|
+
is_device_error: {
|
|
30578
|
+
description:
|
|
30579
|
+
'Indicates that the error is a device error.',
|
|
30580
|
+
enum: [true],
|
|
30581
|
+
type: 'boolean',
|
|
30582
|
+
},
|
|
30583
|
+
message: {
|
|
30584
|
+
description:
|
|
30585
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30586
|
+
type: 'string',
|
|
30587
|
+
},
|
|
30588
|
+
},
|
|
30589
|
+
required: [
|
|
30590
|
+
'message',
|
|
30591
|
+
'is_device_error',
|
|
30592
|
+
'created_at',
|
|
30593
|
+
'error_code',
|
|
30594
|
+
],
|
|
30595
|
+
type: 'object',
|
|
30596
|
+
'x-resource-type': 'device',
|
|
30597
|
+
'x-variant-group-key': 'access_codes',
|
|
30598
|
+
},
|
|
30599
|
+
{
|
|
30600
|
+
description:
|
|
30601
|
+
'Indicates that the user is not authorized to use the August lock.',
|
|
30602
|
+
properties: {
|
|
30603
|
+
created_at: {
|
|
30604
|
+
description:
|
|
30605
|
+
'Date and time at which Seam created the error.',
|
|
30606
|
+
format: 'date-time',
|
|
30607
|
+
type: 'string',
|
|
30608
|
+
},
|
|
30609
|
+
error_code: {
|
|
30610
|
+
description:
|
|
30611
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30612
|
+
enum: ['august_lock_not_authorized'],
|
|
30613
|
+
type: 'string',
|
|
30614
|
+
},
|
|
30615
|
+
is_device_error: {
|
|
30616
|
+
description:
|
|
30617
|
+
'Indicates that the error is a device error.',
|
|
30618
|
+
enum: [true],
|
|
30619
|
+
type: 'boolean',
|
|
30620
|
+
},
|
|
30621
|
+
message: {
|
|
30622
|
+
description:
|
|
30623
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30624
|
+
type: 'string',
|
|
30625
|
+
},
|
|
30626
|
+
},
|
|
30627
|
+
required: [
|
|
30628
|
+
'message',
|
|
30629
|
+
'is_device_error',
|
|
30630
|
+
'created_at',
|
|
30631
|
+
'error_code',
|
|
30632
|
+
],
|
|
30633
|
+
type: 'object',
|
|
30634
|
+
'x-resource-type': 'device',
|
|
30635
|
+
'x-variant-group-key': 'locks',
|
|
30636
|
+
},
|
|
30637
|
+
{
|
|
30638
|
+
description: 'Indicates that device credentials are missing.',
|
|
30639
|
+
properties: {
|
|
30640
|
+
created_at: {
|
|
30641
|
+
description:
|
|
30642
|
+
'Date and time at which Seam created the error.',
|
|
30643
|
+
format: 'date-time',
|
|
30644
|
+
type: 'string',
|
|
30645
|
+
},
|
|
30646
|
+
error_code: {
|
|
30647
|
+
description:
|
|
30648
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30649
|
+
enum: ['missing_device_credentials'],
|
|
30650
|
+
type: 'string',
|
|
30651
|
+
},
|
|
30652
|
+
is_device_error: {
|
|
30653
|
+
description:
|
|
30654
|
+
'Indicates that the error is a device error.',
|
|
30655
|
+
enum: [true],
|
|
30656
|
+
type: 'boolean',
|
|
30657
|
+
},
|
|
30658
|
+
message: {
|
|
30659
|
+
description:
|
|
30660
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30661
|
+
type: 'string',
|
|
30662
|
+
},
|
|
30663
|
+
},
|
|
30664
|
+
required: [
|
|
30665
|
+
'message',
|
|
30666
|
+
'is_device_error',
|
|
30667
|
+
'created_at',
|
|
30668
|
+
'error_code',
|
|
30669
|
+
],
|
|
30670
|
+
type: 'object',
|
|
30671
|
+
'x-resource-type': 'device',
|
|
30672
|
+
},
|
|
30673
|
+
{
|
|
30674
|
+
description: 'Indicates that the auxiliary heat is running.',
|
|
30675
|
+
properties: {
|
|
30676
|
+
created_at: {
|
|
30677
|
+
description:
|
|
30678
|
+
'Date and time at which Seam created the error.',
|
|
30679
|
+
format: 'date-time',
|
|
30680
|
+
type: 'string',
|
|
30681
|
+
},
|
|
30682
|
+
error_code: {
|
|
30683
|
+
description:
|
|
30684
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30685
|
+
enum: ['auxiliary_heat_running'],
|
|
30686
|
+
type: 'string',
|
|
30687
|
+
},
|
|
30688
|
+
is_device_error: {
|
|
30689
|
+
description:
|
|
30690
|
+
'Indicates that the error is a device error.',
|
|
30691
|
+
enum: [true],
|
|
30692
|
+
type: 'boolean',
|
|
30693
|
+
},
|
|
30694
|
+
message: {
|
|
30695
|
+
description:
|
|
30696
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30697
|
+
type: 'string',
|
|
30698
|
+
},
|
|
30699
|
+
},
|
|
30700
|
+
required: [
|
|
30701
|
+
'message',
|
|
30702
|
+
'is_device_error',
|
|
30703
|
+
'created_at',
|
|
30704
|
+
'error_code',
|
|
30705
|
+
],
|
|
30706
|
+
type: 'object',
|
|
30707
|
+
'x-resource-type': 'device',
|
|
30708
|
+
'x-variant-group-key': 'thermostats',
|
|
30709
|
+
},
|
|
30710
|
+
{
|
|
30711
|
+
description:
|
|
30712
|
+
'Indicates that a subscription is required to connect.',
|
|
30713
|
+
properties: {
|
|
30714
|
+
created_at: {
|
|
30715
|
+
description:
|
|
30716
|
+
'Date and time at which Seam created the error.',
|
|
30717
|
+
format: 'date-time',
|
|
30718
|
+
type: 'string',
|
|
30719
|
+
},
|
|
30720
|
+
error_code: {
|
|
30721
|
+
description:
|
|
30722
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30723
|
+
enum: ['subscription_required'],
|
|
30724
|
+
type: 'string',
|
|
30725
|
+
},
|
|
30726
|
+
is_device_error: {
|
|
30727
|
+
description:
|
|
30728
|
+
'Indicates that the error is a device error.',
|
|
30729
|
+
enum: [true],
|
|
30730
|
+
type: 'boolean',
|
|
30731
|
+
},
|
|
30732
|
+
message: {
|
|
30733
|
+
description:
|
|
30734
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30735
|
+
type: 'string',
|
|
30736
|
+
},
|
|
30737
|
+
},
|
|
30738
|
+
required: [
|
|
30739
|
+
'message',
|
|
30740
|
+
'is_device_error',
|
|
30741
|
+
'created_at',
|
|
30742
|
+
'error_code',
|
|
30743
|
+
],
|
|
30744
|
+
type: 'object',
|
|
30745
|
+
'x-resource-type': 'device',
|
|
30746
|
+
},
|
|
30747
|
+
{
|
|
30748
|
+
description:
|
|
30749
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
30750
|
+
properties: {
|
|
30751
|
+
created_at: {
|
|
30752
|
+
description:
|
|
30753
|
+
'Date and time at which Seam created the error.',
|
|
30754
|
+
format: 'date-time',
|
|
30755
|
+
type: 'string',
|
|
30756
|
+
},
|
|
30757
|
+
error_code: {
|
|
30758
|
+
description:
|
|
30759
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30760
|
+
enum: ['bridge_disconnected'],
|
|
30761
|
+
type: 'string',
|
|
30762
|
+
},
|
|
30763
|
+
is_bridge_error: {
|
|
30764
|
+
description:
|
|
30765
|
+
'Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).',
|
|
30766
|
+
type: 'boolean',
|
|
30767
|
+
},
|
|
30768
|
+
is_connected_account_error: {
|
|
30769
|
+
description:
|
|
30770
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
30771
|
+
type: 'boolean',
|
|
30772
|
+
},
|
|
30773
|
+
message: {
|
|
30774
|
+
description:
|
|
30775
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
30776
|
+
type: 'string',
|
|
30777
|
+
},
|
|
30778
|
+
},
|
|
30779
|
+
required: ['created_at', 'message', 'error_code'],
|
|
30780
|
+
type: 'object',
|
|
30781
|
+
'x-resource-type': 'connected_account',
|
|
30782
|
+
},
|
|
30783
|
+
],
|
|
30784
|
+
},
|
|
30785
|
+
type: 'array',
|
|
30786
|
+
'x-variant-groups': {
|
|
30787
|
+
access_codes: { name: 'Access Codes' },
|
|
30788
|
+
hardware: { name: 'Hardware' },
|
|
30789
|
+
locks: { name: 'Locks' },
|
|
30790
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
30791
|
+
phones: { name: 'Phones' },
|
|
30792
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
30793
|
+
thermostats: { name: 'Thermostats' },
|
|
30794
|
+
},
|
|
30795
|
+
},
|
|
30796
|
+
nickname: {
|
|
30797
|
+
description:
|
|
30798
|
+
'Optional nickname to describe the phone, settable through Seam.\n ',
|
|
30799
|
+
type: 'string',
|
|
30800
|
+
},
|
|
30801
|
+
properties: {
|
|
30802
|
+
description: 'Properties of the phone.',
|
|
30803
|
+
properties: {
|
|
30804
|
+
assa_abloy_credential_service_metadata: {
|
|
30805
|
+
description:
|
|
30806
|
+
'ASSA ABLOY Credential Service metadata for the phone.',
|
|
30807
|
+
properties: {
|
|
30808
|
+
endpoints: {
|
|
30809
|
+
description: 'Endpoints associated with the phone.',
|
|
30810
|
+
items: {
|
|
30811
|
+
properties: {
|
|
30812
|
+
endpoint_id: {
|
|
30813
|
+
description: 'ID of the associated endpoint.',
|
|
30814
|
+
type: 'string',
|
|
30815
|
+
},
|
|
30816
|
+
is_active: {
|
|
30817
|
+
description:
|
|
30818
|
+
'Indicated whether the endpoint is active.',
|
|
30819
|
+
type: 'boolean',
|
|
30820
|
+
},
|
|
30821
|
+
},
|
|
30822
|
+
type: 'object',
|
|
30823
|
+
},
|
|
30824
|
+
type: 'array',
|
|
30825
|
+
},
|
|
30826
|
+
has_active_endpoint: {
|
|
30827
|
+
description:
|
|
30828
|
+
'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
30829
|
+
type: 'boolean',
|
|
30830
|
+
},
|
|
30831
|
+
},
|
|
30832
|
+
type: 'object',
|
|
30833
|
+
},
|
|
30834
|
+
salto_space_credential_service_metadata: {
|
|
30835
|
+
description:
|
|
30836
|
+
'Salto Space credential service metadata for the phone.',
|
|
30837
|
+
properties: {
|
|
30838
|
+
has_active_phone: {
|
|
30839
|
+
description:
|
|
30840
|
+
'Indicates whether the credential service has an active associated phone.',
|
|
30841
|
+
type: 'boolean',
|
|
30842
|
+
},
|
|
30843
|
+
},
|
|
30844
|
+
type: 'object',
|
|
30845
|
+
},
|
|
30846
|
+
},
|
|
30847
|
+
type: 'object',
|
|
30848
|
+
},
|
|
30849
|
+
warnings: {
|
|
30850
|
+
description:
|
|
30851
|
+
'Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
30852
|
+
items: {
|
|
30853
|
+
discriminator: { propertyName: 'warning_code' },
|
|
30854
|
+
oneOf: [
|
|
30855
|
+
{
|
|
30856
|
+
description:
|
|
30857
|
+
'Indicates that the backup access code is unhealthy.',
|
|
30858
|
+
properties: {
|
|
30859
|
+
created_at: {
|
|
30860
|
+
description:
|
|
30861
|
+
'Date and time at which Seam created the warning.',
|
|
30862
|
+
format: 'date-time',
|
|
30863
|
+
type: 'string',
|
|
30864
|
+
},
|
|
30865
|
+
message: {
|
|
30866
|
+
description:
|
|
30867
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30868
|
+
type: 'string',
|
|
30869
|
+
},
|
|
30870
|
+
warning_code: {
|
|
30871
|
+
description:
|
|
30872
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30873
|
+
enum: ['partial_backup_access_code_pool'],
|
|
30874
|
+
type: 'string',
|
|
30875
|
+
},
|
|
30876
|
+
},
|
|
30877
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
30878
|
+
type: 'object',
|
|
30879
|
+
'x-variant-group-key': 'access_codes',
|
|
30880
|
+
},
|
|
30881
|
+
{
|
|
30882
|
+
description:
|
|
30883
|
+
'Indicates that there are too many backup codes.',
|
|
30884
|
+
properties: {
|
|
30885
|
+
created_at: {
|
|
30886
|
+
description:
|
|
30887
|
+
'Date and time at which Seam created the warning.',
|
|
30888
|
+
format: 'date-time',
|
|
30889
|
+
type: 'string',
|
|
30890
|
+
},
|
|
30891
|
+
message: {
|
|
30892
|
+
description:
|
|
30893
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30894
|
+
type: 'string',
|
|
30895
|
+
},
|
|
30896
|
+
warning_code: {
|
|
30897
|
+
description:
|
|
30898
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30899
|
+
enum: ['many_active_backup_codes'],
|
|
30900
|
+
type: 'string',
|
|
30901
|
+
},
|
|
30902
|
+
},
|
|
30903
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
30904
|
+
type: 'object',
|
|
30905
|
+
'x-variant-group-key': 'access_codes',
|
|
30906
|
+
},
|
|
30907
|
+
{
|
|
30908
|
+
description:
|
|
30909
|
+
'Indicates that a third-party integration has been detected.',
|
|
30910
|
+
properties: {
|
|
30911
|
+
created_at: {
|
|
30912
|
+
description:
|
|
30913
|
+
'Date and time at which Seam created the warning.',
|
|
30914
|
+
format: 'date-time',
|
|
30915
|
+
type: 'string',
|
|
30916
|
+
},
|
|
30917
|
+
message: {
|
|
30918
|
+
description:
|
|
30919
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30920
|
+
type: 'string',
|
|
30921
|
+
},
|
|
30922
|
+
warning_code: {
|
|
30923
|
+
description:
|
|
30924
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30925
|
+
enum: ['third_party_integration_detected'],
|
|
30926
|
+
type: 'string',
|
|
30927
|
+
},
|
|
30928
|
+
},
|
|
30929
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
30930
|
+
type: 'object',
|
|
30931
|
+
},
|
|
30932
|
+
{
|
|
30933
|
+
description:
|
|
30934
|
+
'Indicates that the Remote Unlock feature is not enabled in the settings."',
|
|
30935
|
+
properties: {
|
|
30936
|
+
created_at: {
|
|
30937
|
+
description:
|
|
30938
|
+
'Date and time at which Seam created the warning.',
|
|
30939
|
+
format: 'date-time',
|
|
30940
|
+
type: 'string',
|
|
30941
|
+
},
|
|
30942
|
+
message: {
|
|
30943
|
+
description:
|
|
30944
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30945
|
+
type: 'string',
|
|
30946
|
+
},
|
|
30947
|
+
warning_code: {
|
|
30948
|
+
description:
|
|
30949
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30950
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
30951
|
+
type: 'string',
|
|
30952
|
+
},
|
|
30953
|
+
},
|
|
30954
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
30955
|
+
type: 'object',
|
|
30956
|
+
'x-variant-group-key': 'locks',
|
|
30957
|
+
},
|
|
30958
|
+
{
|
|
30959
|
+
description: 'Indicates that the gateway signal is weak.',
|
|
30960
|
+
properties: {
|
|
30961
|
+
created_at: {
|
|
30962
|
+
description:
|
|
30963
|
+
'Date and time at which Seam created the warning.',
|
|
30964
|
+
format: 'date-time',
|
|
30965
|
+
type: 'string',
|
|
30966
|
+
},
|
|
30967
|
+
message: {
|
|
30968
|
+
description:
|
|
30969
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30970
|
+
type: 'string',
|
|
30971
|
+
},
|
|
30972
|
+
warning_code: {
|
|
30973
|
+
description:
|
|
30974
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30975
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
30976
|
+
type: 'string',
|
|
30977
|
+
},
|
|
30978
|
+
},
|
|
30979
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
30980
|
+
type: 'object',
|
|
30981
|
+
'x-variant-group-key': 'locks',
|
|
30982
|
+
},
|
|
30983
|
+
{
|
|
30984
|
+
description:
|
|
30985
|
+
'Indicates that the device is in power saving mode and may have limited functionality.',
|
|
30986
|
+
properties: {
|
|
30987
|
+
created_at: {
|
|
30988
|
+
description:
|
|
30989
|
+
'Date and time at which Seam created the warning.',
|
|
30990
|
+
format: 'date-time',
|
|
30991
|
+
type: 'string',
|
|
30992
|
+
},
|
|
30993
|
+
message: {
|
|
30994
|
+
description:
|
|
30995
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
30996
|
+
type: 'string',
|
|
30997
|
+
},
|
|
30998
|
+
warning_code: {
|
|
30999
|
+
description:
|
|
31000
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31001
|
+
enum: ['power_saving_mode'],
|
|
31002
|
+
type: 'string',
|
|
31003
|
+
},
|
|
31004
|
+
},
|
|
31005
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31006
|
+
type: 'object',
|
|
31007
|
+
'x-variant-group-key': 'locks',
|
|
31008
|
+
},
|
|
31009
|
+
{
|
|
31010
|
+
description:
|
|
31011
|
+
'Indicates that the temperature threshold has been exceeded.',
|
|
31012
|
+
properties: {
|
|
31013
|
+
created_at: {
|
|
31014
|
+
description:
|
|
31015
|
+
'Date and time at which Seam created the warning.',
|
|
31016
|
+
format: 'date-time',
|
|
31017
|
+
type: 'string',
|
|
31018
|
+
},
|
|
31019
|
+
message: {
|
|
31020
|
+
description:
|
|
31021
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31022
|
+
type: 'string',
|
|
31023
|
+
},
|
|
31024
|
+
warning_code: {
|
|
31025
|
+
description:
|
|
31026
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31027
|
+
enum: ['temperature_threshold_exceeded'],
|
|
31028
|
+
type: 'string',
|
|
31029
|
+
},
|
|
31030
|
+
},
|
|
31031
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31032
|
+
type: 'object',
|
|
31033
|
+
'x-variant-group-key': 'thermostats',
|
|
31034
|
+
},
|
|
31035
|
+
{
|
|
31036
|
+
description:
|
|
31037
|
+
'Indicates that the device appears to be unresponsive.',
|
|
31038
|
+
properties: {
|
|
31039
|
+
created_at: {
|
|
31040
|
+
description:
|
|
31041
|
+
'Date and time at which Seam created the warning.',
|
|
31042
|
+
format: 'date-time',
|
|
31043
|
+
type: 'string',
|
|
31044
|
+
},
|
|
31045
|
+
message: {
|
|
31046
|
+
description:
|
|
31047
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31048
|
+
type: 'string',
|
|
31049
|
+
},
|
|
31050
|
+
warning_code: {
|
|
31051
|
+
description:
|
|
31052
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31053
|
+
enum: ['device_communication_degraded'],
|
|
31054
|
+
type: 'string',
|
|
31055
|
+
},
|
|
31056
|
+
},
|
|
31057
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31058
|
+
type: 'object',
|
|
31059
|
+
},
|
|
31060
|
+
{
|
|
31061
|
+
description:
|
|
31062
|
+
'Indicates that a scheduled maintenance window has been detected.',
|
|
31063
|
+
properties: {
|
|
31064
|
+
created_at: {
|
|
31065
|
+
description:
|
|
31066
|
+
'Date and time at which Seam created the warning.',
|
|
31067
|
+
format: 'date-time',
|
|
31068
|
+
type: 'string',
|
|
31069
|
+
},
|
|
31070
|
+
message: {
|
|
31071
|
+
description:
|
|
31072
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31073
|
+
type: 'string',
|
|
31074
|
+
},
|
|
31075
|
+
warning_code: {
|
|
31076
|
+
description:
|
|
31077
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31078
|
+
enum: ['scheduled_maintenance_window'],
|
|
31079
|
+
type: 'string',
|
|
31080
|
+
},
|
|
31081
|
+
},
|
|
31082
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31083
|
+
type: 'object',
|
|
31084
|
+
},
|
|
31085
|
+
{
|
|
31086
|
+
description:
|
|
31087
|
+
'Indicates that the device has a flaky connection.',
|
|
31088
|
+
properties: {
|
|
31089
|
+
created_at: {
|
|
31090
|
+
description:
|
|
31091
|
+
'Date and time at which Seam created the warning.',
|
|
31092
|
+
format: 'date-time',
|
|
31093
|
+
type: 'string',
|
|
31094
|
+
},
|
|
31095
|
+
message: {
|
|
31096
|
+
description:
|
|
31097
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31098
|
+
type: 'string',
|
|
31099
|
+
},
|
|
31100
|
+
warning_code: {
|
|
31101
|
+
description:
|
|
31102
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31103
|
+
enum: ['device_has_flaky_connection'],
|
|
31104
|
+
type: 'string',
|
|
31105
|
+
},
|
|
31106
|
+
},
|
|
31107
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31108
|
+
type: 'object',
|
|
31109
|
+
},
|
|
31110
|
+
{
|
|
31111
|
+
description:
|
|
31112
|
+
'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.',
|
|
31113
|
+
properties: {
|
|
31114
|
+
created_at: {
|
|
31115
|
+
description:
|
|
31116
|
+
'Date and time at which Seam created the warning.',
|
|
31117
|
+
format: 'date-time',
|
|
31118
|
+
type: 'string',
|
|
31119
|
+
},
|
|
31120
|
+
message: {
|
|
31121
|
+
description:
|
|
31122
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31123
|
+
type: 'string',
|
|
31124
|
+
},
|
|
31125
|
+
warning_code: {
|
|
31126
|
+
description:
|
|
31127
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31128
|
+
enum: ['salto_ks_office_mode'],
|
|
31129
|
+
type: 'string',
|
|
31130
|
+
},
|
|
31131
|
+
},
|
|
31132
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31133
|
+
type: 'object',
|
|
31134
|
+
'x-variant-group-key': 'access_codes',
|
|
31135
|
+
},
|
|
31136
|
+
{
|
|
31137
|
+
deprecated: true,
|
|
31138
|
+
description:
|
|
31139
|
+
'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
31140
|
+
properties: {
|
|
31141
|
+
created_at: {
|
|
31142
|
+
description:
|
|
31143
|
+
'Date and time at which Seam created the warning.',
|
|
31144
|
+
format: 'date-time',
|
|
31145
|
+
type: 'string',
|
|
31146
|
+
},
|
|
31147
|
+
message: {
|
|
31148
|
+
description:
|
|
31149
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31150
|
+
type: 'string',
|
|
31151
|
+
},
|
|
31152
|
+
warning_code: {
|
|
31153
|
+
description:
|
|
31154
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31155
|
+
enum: ['salto_ks_privacy_mode'],
|
|
31156
|
+
type: 'string',
|
|
31157
|
+
},
|
|
31158
|
+
},
|
|
31159
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31160
|
+
type: 'object',
|
|
31161
|
+
'x-deprecated': 'Use `privacy_mode` instead.',
|
|
31162
|
+
'x-variant-group-key': 'access_codes',
|
|
31163
|
+
},
|
|
31164
|
+
{
|
|
31165
|
+
description:
|
|
31166
|
+
'Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.',
|
|
31167
|
+
properties: {
|
|
31168
|
+
created_at: {
|
|
31169
|
+
description:
|
|
31170
|
+
'Date and time at which Seam created the warning.',
|
|
31171
|
+
format: 'date-time',
|
|
31172
|
+
type: 'string',
|
|
31173
|
+
},
|
|
31174
|
+
message: {
|
|
31175
|
+
description:
|
|
31176
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31177
|
+
type: 'string',
|
|
31178
|
+
},
|
|
31179
|
+
warning_code: {
|
|
31180
|
+
description:
|
|
31181
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31182
|
+
enum: ['privacy_mode'],
|
|
31183
|
+
type: 'string',
|
|
31184
|
+
},
|
|
31185
|
+
},
|
|
31186
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31187
|
+
type: 'object',
|
|
31188
|
+
'x-variant-group-key': 'access_codes',
|
|
31189
|
+
},
|
|
31190
|
+
{
|
|
31191
|
+
description:
|
|
31192
|
+
'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
|
|
31193
|
+
properties: {
|
|
31194
|
+
created_at: {
|
|
31195
|
+
description:
|
|
31196
|
+
'Date and time at which Seam created the warning.',
|
|
31197
|
+
format: 'date-time',
|
|
31198
|
+
type: 'string',
|
|
31199
|
+
},
|
|
31200
|
+
message: {
|
|
31201
|
+
description:
|
|
31202
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31203
|
+
type: 'string',
|
|
31204
|
+
},
|
|
31205
|
+
warning_code: {
|
|
31206
|
+
description:
|
|
31207
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31208
|
+
enum: ['salto_ks_subscription_limit_almost_reached'],
|
|
31209
|
+
type: 'string',
|
|
31210
|
+
},
|
|
31211
|
+
},
|
|
31212
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31213
|
+
type: 'object',
|
|
31214
|
+
'x-variant-group-key': 'locks',
|
|
31215
|
+
},
|
|
31216
|
+
{
|
|
31217
|
+
description:
|
|
31218
|
+
'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
|
|
31219
|
+
properties: {
|
|
31220
|
+
created_at: {
|
|
31221
|
+
description:
|
|
31222
|
+
'Date and time at which Seam created the warning.',
|
|
31223
|
+
format: 'date-time',
|
|
31224
|
+
type: 'string',
|
|
31225
|
+
},
|
|
31226
|
+
message: {
|
|
31227
|
+
description:
|
|
31228
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31229
|
+
type: 'string',
|
|
31230
|
+
},
|
|
31231
|
+
warning_code: {
|
|
31232
|
+
description:
|
|
31233
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31234
|
+
enum: ['salto_ks_lock_access_code_support_removed'],
|
|
31235
|
+
type: 'string',
|
|
31236
|
+
},
|
|
31237
|
+
},
|
|
31238
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31239
|
+
type: 'object',
|
|
31240
|
+
'x-variant-group-key': 'access_codes',
|
|
31241
|
+
},
|
|
31242
|
+
{
|
|
31243
|
+
description:
|
|
31244
|
+
'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.',
|
|
31245
|
+
properties: {
|
|
31246
|
+
created_at: {
|
|
31247
|
+
description:
|
|
31248
|
+
'Date and time at which Seam created the warning.',
|
|
31249
|
+
format: 'date-time',
|
|
31250
|
+
type: 'string',
|
|
31251
|
+
},
|
|
31252
|
+
message: {
|
|
31253
|
+
description:
|
|
31254
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31255
|
+
type: 'string',
|
|
31256
|
+
},
|
|
31257
|
+
warning_code: {
|
|
31258
|
+
description:
|
|
31259
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31260
|
+
enum: ['unknown_issue_with_phone'],
|
|
31261
|
+
type: 'string',
|
|
31262
|
+
},
|
|
31263
|
+
},
|
|
31264
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31265
|
+
type: 'object',
|
|
31266
|
+
'x-variant-group-key': 'phones',
|
|
31267
|
+
},
|
|
31268
|
+
{
|
|
31269
|
+
description:
|
|
31270
|
+
'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
|
|
31271
|
+
properties: {
|
|
31272
|
+
created_at: {
|
|
31273
|
+
description:
|
|
31274
|
+
'Date and time at which Seam created the warning.',
|
|
31275
|
+
format: 'date-time',
|
|
31276
|
+
type: 'string',
|
|
31277
|
+
},
|
|
31278
|
+
message: {
|
|
31279
|
+
description:
|
|
31280
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31281
|
+
type: 'string',
|
|
31282
|
+
},
|
|
31283
|
+
warning_code: {
|
|
31284
|
+
description:
|
|
31285
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31286
|
+
enum: ['lockly_time_zone_not_configured'],
|
|
31287
|
+
type: 'string',
|
|
31288
|
+
},
|
|
31289
|
+
},
|
|
31290
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31291
|
+
type: 'object',
|
|
31292
|
+
'x-variant-group-key': 'locks',
|
|
31293
|
+
},
|
|
31294
|
+
{
|
|
31295
|
+
description:
|
|
31296
|
+
'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
|
|
31297
|
+
properties: {
|
|
31298
|
+
created_at: {
|
|
31299
|
+
description:
|
|
31300
|
+
'Date and time at which Seam created the warning.',
|
|
31301
|
+
format: 'date-time',
|
|
31302
|
+
type: 'string',
|
|
31303
|
+
},
|
|
31304
|
+
message: {
|
|
31305
|
+
description:
|
|
31306
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31307
|
+
type: 'string',
|
|
31308
|
+
},
|
|
31309
|
+
warning_code: {
|
|
31310
|
+
description:
|
|
31311
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31312
|
+
enum: ['ultraloq_time_zone_unknown'],
|
|
31313
|
+
type: 'string',
|
|
31314
|
+
},
|
|
31315
|
+
},
|
|
31316
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31317
|
+
type: 'object',
|
|
31318
|
+
'x-variant-group-key': 'locks',
|
|
31319
|
+
},
|
|
31320
|
+
{
|
|
31321
|
+
description:
|
|
31322
|
+
"Indicates that Seam does not know the device's time zone. Set a time zone to enable time-bound access codes.",
|
|
31323
|
+
properties: {
|
|
31324
|
+
created_at: {
|
|
31325
|
+
description:
|
|
31326
|
+
'Date and time at which Seam created the warning.',
|
|
31327
|
+
format: 'date-time',
|
|
31328
|
+
type: 'string',
|
|
31329
|
+
},
|
|
31330
|
+
message: {
|
|
31331
|
+
description:
|
|
31332
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31333
|
+
type: 'string',
|
|
31334
|
+
},
|
|
31335
|
+
warning_code: {
|
|
31336
|
+
description:
|
|
31337
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31338
|
+
enum: ['time_zone_unknown'],
|
|
31339
|
+
type: 'string',
|
|
31340
|
+
},
|
|
31341
|
+
},
|
|
31342
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31343
|
+
type: 'object',
|
|
31344
|
+
'x-variant-group-key': 'locks',
|
|
31345
|
+
},
|
|
31346
|
+
{
|
|
31347
|
+
description:
|
|
31348
|
+
"Indicates that the device's configured time zone does not match its hardware UTC offset. Time-bound access codes may activate at the wrong local time.",
|
|
31349
|
+
properties: {
|
|
31350
|
+
created_at: {
|
|
31351
|
+
description:
|
|
31352
|
+
'Date and time at which Seam created the warning.',
|
|
31353
|
+
format: 'date-time',
|
|
31354
|
+
type: 'string',
|
|
31355
|
+
},
|
|
31356
|
+
message: {
|
|
31357
|
+
description:
|
|
31358
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31359
|
+
type: 'string',
|
|
31360
|
+
},
|
|
31361
|
+
warning_code: {
|
|
31362
|
+
description:
|
|
31363
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31364
|
+
enum: ['time_zone_mismatch'],
|
|
31365
|
+
type: 'string',
|
|
31366
|
+
},
|
|
31367
|
+
},
|
|
31368
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31369
|
+
type: 'object',
|
|
31370
|
+
'x-variant-group-key': 'locks',
|
|
31371
|
+
},
|
|
31372
|
+
{
|
|
31373
|
+
description:
|
|
31374
|
+
'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
|
|
31375
|
+
properties: {
|
|
31376
|
+
created_at: {
|
|
31377
|
+
description:
|
|
31378
|
+
'Date and time at which Seam created the warning.',
|
|
31379
|
+
format: 'date-time',
|
|
31380
|
+
type: 'string',
|
|
31381
|
+
},
|
|
31382
|
+
message: {
|
|
31383
|
+
description:
|
|
31384
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31385
|
+
type: 'string',
|
|
31386
|
+
},
|
|
31387
|
+
warning_code: {
|
|
31388
|
+
description:
|
|
31389
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31390
|
+
enum: ['two_n_device_missing_timezone'],
|
|
31391
|
+
type: 'string',
|
|
31392
|
+
},
|
|
31393
|
+
},
|
|
31394
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31395
|
+
type: 'object',
|
|
31396
|
+
'x-variant-group-key': 'locks',
|
|
31397
|
+
},
|
|
31398
|
+
{
|
|
31399
|
+
description:
|
|
31400
|
+
'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
|
|
31401
|
+
properties: {
|
|
31402
|
+
created_at: {
|
|
31403
|
+
description:
|
|
31404
|
+
'Date and time at which Seam created the warning.',
|
|
31405
|
+
format: 'date-time',
|
|
31406
|
+
type: 'string',
|
|
31407
|
+
},
|
|
31408
|
+
message: {
|
|
31409
|
+
description:
|
|
31410
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31411
|
+
type: 'string',
|
|
31412
|
+
},
|
|
31413
|
+
warning_code: {
|
|
31414
|
+
description:
|
|
31415
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31416
|
+
enum: ['hub_required_for_additional_capabilities'],
|
|
31417
|
+
type: 'string',
|
|
31418
|
+
},
|
|
31419
|
+
},
|
|
31420
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31421
|
+
type: 'object',
|
|
31422
|
+
'x-variant-group-key': 'locks',
|
|
31423
|
+
},
|
|
31424
|
+
{
|
|
31425
|
+
description:
|
|
31426
|
+
'Indicates a provider-specific issue that may affect device functionality.',
|
|
31427
|
+
properties: {
|
|
31428
|
+
created_at: {
|
|
31429
|
+
description:
|
|
31430
|
+
'Date and time at which Seam created the warning.',
|
|
31431
|
+
format: 'date-time',
|
|
31432
|
+
type: 'string',
|
|
31433
|
+
},
|
|
31434
|
+
message: {
|
|
31435
|
+
description:
|
|
31436
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31437
|
+
type: 'string',
|
|
31438
|
+
},
|
|
31439
|
+
warning_code: {
|
|
31440
|
+
description:
|
|
31441
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31442
|
+
enum: ['provider_issue'],
|
|
31443
|
+
type: 'string',
|
|
31444
|
+
},
|
|
31445
|
+
},
|
|
31446
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31447
|
+
type: 'object',
|
|
31448
|
+
'x-variant-group-key': 'access_codes',
|
|
31449
|
+
},
|
|
31450
|
+
{
|
|
31451
|
+
description:
|
|
31452
|
+
'Indicates that the key is in a locker that does not support the access codes API.',
|
|
31453
|
+
properties: {
|
|
31454
|
+
created_at: {
|
|
31455
|
+
description:
|
|
31456
|
+
'Date and time at which Seam created the warning.',
|
|
31457
|
+
format: 'date-time',
|
|
31458
|
+
type: 'string',
|
|
31459
|
+
},
|
|
31460
|
+
message: {
|
|
31461
|
+
description:
|
|
31462
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31463
|
+
type: 'string',
|
|
31464
|
+
},
|
|
31465
|
+
warning_code: {
|
|
31466
|
+
description:
|
|
31467
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31468
|
+
enum: ['keynest_unsupported_locker'],
|
|
31469
|
+
type: 'string',
|
|
31470
|
+
},
|
|
31471
|
+
},
|
|
31472
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31473
|
+
type: 'object',
|
|
31474
|
+
'x-variant-group-key': 'locks',
|
|
31475
|
+
},
|
|
31476
|
+
{
|
|
31477
|
+
description:
|
|
31478
|
+
'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.',
|
|
31479
|
+
properties: {
|
|
31480
|
+
created_at: {
|
|
31481
|
+
description:
|
|
31482
|
+
'Date and time at which Seam created the warning.',
|
|
31483
|
+
format: 'date-time',
|
|
31484
|
+
type: 'string',
|
|
31485
|
+
},
|
|
31486
|
+
message: {
|
|
31487
|
+
description:
|
|
31488
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31489
|
+
type: 'string',
|
|
31490
|
+
},
|
|
31491
|
+
warning_code: {
|
|
31492
|
+
description:
|
|
31493
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31494
|
+
enum: ['accessory_keypad_setup_required'],
|
|
31495
|
+
type: 'string',
|
|
31496
|
+
},
|
|
31497
|
+
},
|
|
31498
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31499
|
+
type: 'object',
|
|
31500
|
+
'x-variant-group-key': 'locks',
|
|
31501
|
+
},
|
|
31502
|
+
{
|
|
31503
|
+
description:
|
|
31504
|
+
'Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.',
|
|
31505
|
+
properties: {
|
|
31506
|
+
created_at: {
|
|
31507
|
+
description:
|
|
31508
|
+
'Date and time at which Seam created the warning.',
|
|
31509
|
+
format: 'date-time',
|
|
31510
|
+
type: 'string',
|
|
31511
|
+
},
|
|
31512
|
+
message: {
|
|
31513
|
+
description:
|
|
31514
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31515
|
+
type: 'string',
|
|
31516
|
+
},
|
|
31517
|
+
warning_code: {
|
|
31518
|
+
description:
|
|
31519
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31520
|
+
enum: ['accessory_keypad_low_battery'],
|
|
31521
|
+
type: 'string',
|
|
31522
|
+
},
|
|
31523
|
+
},
|
|
31524
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31525
|
+
type: 'object',
|
|
31526
|
+
'x-variant-group-key': 'locks',
|
|
31527
|
+
},
|
|
31528
|
+
{
|
|
31529
|
+
description:
|
|
31530
|
+
'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
|
|
31531
|
+
properties: {
|
|
31532
|
+
created_at: {
|
|
31533
|
+
description:
|
|
31534
|
+
'Date and time at which Seam created the warning.',
|
|
31535
|
+
format: 'date-time',
|
|
31536
|
+
type: 'string',
|
|
31537
|
+
},
|
|
31538
|
+
message: {
|
|
31539
|
+
description:
|
|
31540
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31541
|
+
type: 'string',
|
|
31542
|
+
},
|
|
31543
|
+
warning_code: {
|
|
31544
|
+
description:
|
|
31545
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31546
|
+
enum: ['unreliable_online_status'],
|
|
31547
|
+
type: 'string',
|
|
31548
|
+
},
|
|
31549
|
+
},
|
|
31550
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31551
|
+
type: 'object',
|
|
31552
|
+
'x-variant-group-key': 'locks',
|
|
31553
|
+
},
|
|
31554
|
+
{
|
|
31555
|
+
description:
|
|
31556
|
+
'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
|
|
31557
|
+
properties: {
|
|
31558
|
+
active_access_code_count: {
|
|
31559
|
+
description:
|
|
31560
|
+
'Number of active access codes on the device when the warning was set.',
|
|
31561
|
+
type: 'integer',
|
|
31562
|
+
},
|
|
31563
|
+
created_at: {
|
|
31564
|
+
description:
|
|
31565
|
+
'Date and time at which Seam created the warning.',
|
|
31566
|
+
format: 'date-time',
|
|
31567
|
+
type: 'string',
|
|
31568
|
+
},
|
|
31569
|
+
max_active_access_code_count: {
|
|
31570
|
+
description:
|
|
31571
|
+
'Maximum number of active access codes supported by the device.',
|
|
31572
|
+
type: 'integer',
|
|
31573
|
+
},
|
|
31574
|
+
message: {
|
|
31575
|
+
description:
|
|
31576
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31577
|
+
type: 'string',
|
|
31578
|
+
},
|
|
31579
|
+
warning_code: {
|
|
31580
|
+
description:
|
|
31581
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31582
|
+
enum: ['max_access_codes_reached'],
|
|
31583
|
+
type: 'string',
|
|
31584
|
+
},
|
|
31585
|
+
},
|
|
31586
|
+
required: [
|
|
31587
|
+
'message',
|
|
31588
|
+
'created_at',
|
|
31589
|
+
'warning_code',
|
|
31590
|
+
'active_access_code_count',
|
|
31591
|
+
'max_active_access_code_count',
|
|
31592
|
+
],
|
|
31593
|
+
type: 'object',
|
|
31594
|
+
'x-variant-group-key': 'access_codes',
|
|
31595
|
+
},
|
|
31596
|
+
],
|
|
31597
|
+
},
|
|
31598
|
+
type: 'array',
|
|
31599
|
+
'x-variant-groups': {
|
|
31600
|
+
access_codes: { name: 'Access Codes' },
|
|
31601
|
+
hardware: { name: 'Hardware' },
|
|
31602
|
+
locks: { name: 'Locks' },
|
|
31603
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
31604
|
+
phones: { name: 'Phones' },
|
|
31605
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
31606
|
+
thermostats: { name: 'Thermostats' },
|
|
31607
|
+
},
|
|
31608
|
+
},
|
|
31609
|
+
workspace_id: {
|
|
31610
|
+
description: 'ID of the workspace that contains the phone.\n ',
|
|
31611
|
+
format: 'uuid',
|
|
31612
|
+
type: 'string',
|
|
31613
|
+
},
|
|
31614
|
+
},
|
|
31615
|
+
required: [
|
|
31616
|
+
'device_id',
|
|
31617
|
+
'display_name',
|
|
31618
|
+
'workspace_id',
|
|
31619
|
+
'created_at',
|
|
31620
|
+
'custom_metadata',
|
|
31621
|
+
'errors',
|
|
31622
|
+
'warnings',
|
|
31623
|
+
'device_type',
|
|
31624
|
+
'properties',
|
|
31625
|
+
],
|
|
31626
|
+
type: 'object',
|
|
31627
|
+
'x-property-groups': { phones: { name: 'Phones' } },
|
|
31628
|
+
'x-route-path': '/phones',
|
|
31629
|
+
},
|
|
31630
|
+
phone_registration: {
|
|
31631
|
+
description: 'Represents a mobile phone registration.',
|
|
31632
|
+
properties: {
|
|
31633
|
+
is_being_activated: {
|
|
31634
|
+
description: 'Indicates whether the phone is being activated.',
|
|
31635
|
+
type: 'boolean',
|
|
31636
|
+
},
|
|
31637
|
+
phone_registration_id: {
|
|
31638
|
+
description: 'Registration ID for the phone.',
|
|
31639
|
+
type: 'string',
|
|
31640
|
+
},
|
|
31641
|
+
provider_name: {
|
|
31642
|
+
description: 'Provider name for the phone.',
|
|
31643
|
+
nullable: true,
|
|
31644
|
+
type: 'string',
|
|
31645
|
+
},
|
|
31646
|
+
provider_state: {
|
|
31647
|
+
additionalProperties: {},
|
|
31648
|
+
description: 'Provider state for the phone.',
|
|
31649
|
+
nullable: true,
|
|
31650
|
+
type: 'object',
|
|
31651
|
+
},
|
|
31652
|
+
},
|
|
31653
|
+
required: [
|
|
31654
|
+
'phone_registration_id',
|
|
31655
|
+
'provider_state',
|
|
31656
|
+
'provider_name',
|
|
31657
|
+
'is_being_activated',
|
|
31658
|
+
],
|
|
31659
|
+
type: 'object',
|
|
31660
|
+
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
31661
|
+
'x-undocumented': 'Seam Mobile SDK only.',
|
|
31662
|
+
},
|
|
31663
|
+
phone_session: {
|
|
31664
|
+
description: 'Represents a mobile phone session.',
|
|
31665
|
+
properties: {
|
|
31666
|
+
is_sandbox_workspace: {
|
|
31667
|
+
description: 'Whether the workspace is in sandbox mode.',
|
|
31668
|
+
type: 'boolean',
|
|
31669
|
+
},
|
|
31670
|
+
provider_sessions: {
|
|
31671
|
+
description: 'Phone provider sessions.',
|
|
31672
|
+
items: {
|
|
31673
|
+
description: 'Phone provider session.',
|
|
31674
|
+
properties: {
|
|
31675
|
+
acs_credentials: {
|
|
31676
|
+
description:
|
|
31677
|
+
'Access system credentials associated with the phone provider session.',
|
|
31678
|
+
items: {
|
|
31679
|
+
description:
|
|
31680
|
+
'Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
|
|
31681
|
+
properties: {
|
|
31682
|
+
access_method: {
|
|
31683
|
+
description:
|
|
31684
|
+
'Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
30395
31685
|
enum: ['code', 'card', 'mobile_key', 'cloud_key'],
|
|
30396
31686
|
type: 'string',
|
|
30397
31687
|
},
|
|
@@ -30636,30 +31926,41 @@ const openapi: OpenAPISpec = {
|
|
|
30636
31926
|
description:
|
|
30637
31927
|
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
30638
31928
|
items: {
|
|
30639
|
-
|
|
30640
|
-
|
|
30641
|
-
|
|
30642
|
-
|
|
30643
|
-
|
|
30644
|
-
type: 'string',
|
|
30645
|
-
},
|
|
30646
|
-
error_code: {
|
|
30647
|
-
description:
|
|
30648
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30649
|
-
type: 'string',
|
|
30650
|
-
},
|
|
30651
|
-
message: {
|
|
31929
|
+
description:
|
|
31930
|
+
'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
31931
|
+
discriminator: { propertyName: 'error_code' },
|
|
31932
|
+
oneOf: [
|
|
31933
|
+
{
|
|
30652
31934
|
description:
|
|
30653
|
-
'
|
|
30654
|
-
|
|
31935
|
+
'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
31936
|
+
properties: {
|
|
31937
|
+
created_at: {
|
|
31938
|
+
description:
|
|
31939
|
+
'Date and time at which Seam created the error.',
|
|
31940
|
+
format: 'date-time',
|
|
31941
|
+
type: 'string',
|
|
31942
|
+
},
|
|
31943
|
+
error_code: {
|
|
31944
|
+
description:
|
|
31945
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31946
|
+
enum: ['entrance_removed'],
|
|
31947
|
+
type: 'string',
|
|
31948
|
+
},
|
|
31949
|
+
message: {
|
|
31950
|
+
description:
|
|
31951
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31952
|
+
type: 'string',
|
|
31953
|
+
},
|
|
31954
|
+
},
|
|
31955
|
+
required: [
|
|
31956
|
+
'created_at',
|
|
31957
|
+
'message',
|
|
31958
|
+
'error_code',
|
|
31959
|
+
],
|
|
31960
|
+
type: 'object',
|
|
31961
|
+
'x-resource-type': 'acs_entrance',
|
|
30655
31962
|
},
|
|
30656
|
-
},
|
|
30657
|
-
required: [
|
|
30658
|
-
'error_code',
|
|
30659
|
-
'message',
|
|
30660
|
-
'created_at',
|
|
30661
31963
|
],
|
|
30662
|
-
type: 'object',
|
|
30663
31964
|
},
|
|
30664
31965
|
type: 'array',
|
|
30665
31966
|
},
|
|
@@ -34075,7 +35376,8 @@ const openapi: OpenAPISpec = {
|
|
|
34075
35376
|
},
|
|
34076
35377
|
error_code: {
|
|
34077
35378
|
description:
|
|
34078
|
-
'Reason the access code could not be revoked
|
|
35379
|
+
'Reason the access code could not be revoked.',
|
|
35380
|
+
enum: ['offline_access_code_not_revocable'],
|
|
34079
35381
|
type: 'string',
|
|
34080
35382
|
},
|
|
34081
35383
|
message: {
|
|
@@ -50086,7 +51388,7 @@ const openapi: OpenAPISpec = {
|
|
|
50086
51388
|
'/customers/delete_data': {
|
|
50087
51389
|
delete: {
|
|
50088
51390
|
description:
|
|
50089
|
-
'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).',
|
|
51391
|
+
'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).\nSpace keys also match spaces created directly with a `space_key` (for example, through `/spaces/create`).',
|
|
50090
51392
|
operationId: 'customersDeleteDataDelete',
|
|
50091
51393
|
parameters: [
|
|
50092
51394
|
{
|