@seamapi/types 1.405.0 → 1.406.1
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 +2217 -559
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +7283 -405
- package/lib/seam/connect/models/devices/capabilities-supported.js +3 -1
- package/lib/seam/connect/models/devices/capabilities-supported.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +53 -21
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/lock.js +20 -4
- package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js +175 -31
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.js +455 -191
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.js +8 -6
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +171 -80
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone-properties.js +5 -7
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +22 -8
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +35 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/devices.d.ts +4 -4
- package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +2 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -0
- package/lib/seam/connect/models/partner/resources.d.ts +42 -0
- package/lib/seam/connect/models/partner/resources.js +19 -0
- package/lib/seam/connect/models/partner/resources.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +979 -47
- package/lib/seam/connect/openapi.js +1331 -205
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +6264 -318
- package/package.json +2 -2
- package/src/lib/seam/connect/models/devices/capabilities-supported.ts +3 -1
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +64 -34
- package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +20 -4
- package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +175 -31
- package/src/lib/seam/connect/models/devices/device-metadata.ts +457 -193
- package/src/lib/seam/connect/models/devices/device-type.ts +10 -6
- package/src/lib/seam/connect/models/devices/device.ts +173 -96
- package/src/lib/seam/connect/models/devices/phone-properties.ts +34 -36
- package/src/lib/seam/connect/models/devices/phone.ts +22 -19
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +35 -1
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/models/partner/resources.ts +24 -0
- package/src/lib/seam/connect/openapi.ts +1577 -210
- package/src/lib/seam/connect/route-types.ts +6267 -318
|
@@ -7743,8 +7743,10 @@ export default {
|
|
|
7743
7743
|
can_turn_off_hvac: { type: 'boolean' },
|
|
7744
7744
|
capabilities_supported: {
|
|
7745
7745
|
description:
|
|
7746
|
-
'Collection of capabilities that the device supports when connected to Seam. Values are
|
|
7746
|
+
'\n 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
7747
7747
|
items: {
|
|
7748
|
+
description:
|
|
7749
|
+
'\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
7748
7750
|
enum: [
|
|
7749
7751
|
'access_code',
|
|
7750
7752
|
'lock',
|
|
@@ -7786,6 +7788,7 @@ export default {
|
|
|
7786
7788
|
description: 'Type of the device.',
|
|
7787
7789
|
oneOf: [
|
|
7788
7790
|
{
|
|
7791
|
+
description: 'Device type for smartlocks.\n ',
|
|
7789
7792
|
enum: [
|
|
7790
7793
|
'akuvox_lock',
|
|
7791
7794
|
'august_lock',
|
|
@@ -7818,10 +7821,12 @@ export default {
|
|
|
7818
7821
|
type: 'string',
|
|
7819
7822
|
},
|
|
7820
7823
|
{
|
|
7824
|
+
description: 'Device type for noise sensors.\n ',
|
|
7821
7825
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
7822
7826
|
type: 'string',
|
|
7823
7827
|
},
|
|
7824
7828
|
{
|
|
7829
|
+
description: 'Device type for thermostats.\n ',
|
|
7825
7830
|
enum: [
|
|
7826
7831
|
'ecobee_thermostat',
|
|
7827
7832
|
'nest_thermostat',
|
|
@@ -7833,7 +7838,7 @@ export default {
|
|
|
7833
7838
|
type: 'string',
|
|
7834
7839
|
},
|
|
7835
7840
|
{
|
|
7836
|
-
description: '
|
|
7841
|
+
description: 'Device type for phones.\n ',
|
|
7837
7842
|
enum: ['ios_phone', 'android_phone'],
|
|
7838
7843
|
type: 'string',
|
|
7839
7844
|
},
|
|
@@ -8216,15 +8221,16 @@ export default {
|
|
|
8216
8221
|
nullable: true,
|
|
8217
8222
|
properties: {
|
|
8218
8223
|
location_name: {
|
|
8219
|
-
description: 'Name of the device location
|
|
8224
|
+
description: 'Name of the device location.\n ',
|
|
8220
8225
|
type: 'string',
|
|
8221
8226
|
},
|
|
8222
8227
|
timezone: {
|
|
8223
|
-
description: 'Time zone of the device location
|
|
8228
|
+
description: 'Time zone of the device location.\n ',
|
|
8224
8229
|
type: 'string',
|
|
8225
8230
|
},
|
|
8226
8231
|
},
|
|
8227
8232
|
type: 'object',
|
|
8233
|
+
'x-property-group-key': 'hardware',
|
|
8228
8234
|
},
|
|
8229
8235
|
nickname: {
|
|
8230
8236
|
description:
|
|
@@ -8241,11 +8247,11 @@ export default {
|
|
|
8241
8247
|
properties: {
|
|
8242
8248
|
accessory_keypad: {
|
|
8243
8249
|
description:
|
|
8244
|
-
'
|
|
8250
|
+
'Accessory keypad properties and state.',
|
|
8245
8251
|
properties: {
|
|
8246
8252
|
battery: {
|
|
8247
8253
|
description:
|
|
8248
|
-
'
|
|
8254
|
+
'Keypad battery properties.\n ',
|
|
8249
8255
|
properties: {
|
|
8250
8256
|
level: {
|
|
8251
8257
|
format: 'float',
|
|
@@ -8259,14 +8265,17 @@ export default {
|
|
|
8259
8265
|
},
|
|
8260
8266
|
is_connected: {
|
|
8261
8267
|
description:
|
|
8262
|
-
'Indicates if
|
|
8268
|
+
'Indicates if an accessory keypad is connected to the device.\n ',
|
|
8263
8269
|
type: 'boolean',
|
|
8264
8270
|
},
|
|
8265
8271
|
},
|
|
8266
8272
|
required: ['is_connected'],
|
|
8267
8273
|
type: 'object',
|
|
8274
|
+
'x-property-group-key': 'hardware',
|
|
8268
8275
|
},
|
|
8269
8276
|
appearance: {
|
|
8277
|
+
description:
|
|
8278
|
+
'Appearance-related properties, as reported by the device.',
|
|
8270
8279
|
properties: {
|
|
8271
8280
|
name: {
|
|
8272
8281
|
description:
|
|
@@ -8276,24 +8285,30 @@ export default {
|
|
|
8276
8285
|
},
|
|
8277
8286
|
required: ['name'],
|
|
8278
8287
|
type: 'object',
|
|
8288
|
+
'x-property-group-key': 'hardware',
|
|
8279
8289
|
},
|
|
8280
8290
|
battery: {
|
|
8281
8291
|
description:
|
|
8282
|
-
'Represents the current status of the battery charge level.
|
|
8292
|
+
'Represents the current status of the battery charge level.',
|
|
8283
8293
|
properties: {
|
|
8284
8294
|
level: {
|
|
8295
|
+
description:
|
|
8296
|
+
'Battery charge level as a value between 0 and 1, inclusive.\n ',
|
|
8285
8297
|
format: 'float',
|
|
8286
8298
|
maximum: 1,
|
|
8287
8299
|
minimum: 0,
|
|
8288
8300
|
type: 'number',
|
|
8289
8301
|
},
|
|
8290
8302
|
status: {
|
|
8303
|
+
description:
|
|
8304
|
+
'Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ',
|
|
8291
8305
|
enum: ['critical', 'low', 'good', 'full'],
|
|
8292
8306
|
type: 'string',
|
|
8293
8307
|
},
|
|
8294
8308
|
},
|
|
8295
8309
|
required: ['level', 'status'],
|
|
8296
8310
|
type: 'object',
|
|
8311
|
+
'x-property-group-key': 'hardware',
|
|
8297
8312
|
},
|
|
8298
8313
|
battery_level: {
|
|
8299
8314
|
description:
|
|
@@ -8302,33 +8317,40 @@ export default {
|
|
|
8302
8317
|
maximum: 1,
|
|
8303
8318
|
minimum: 0,
|
|
8304
8319
|
type: 'number',
|
|
8320
|
+
'x-property-group-key': 'hardware',
|
|
8305
8321
|
},
|
|
8306
8322
|
currently_triggering_noise_threshold_ids: {
|
|
8307
8323
|
description:
|
|
8308
8324
|
'Array of noise threshold IDs that are currently triggering.',
|
|
8309
8325
|
items: { type: 'string' },
|
|
8310
8326
|
type: 'array',
|
|
8327
|
+
'x-property-group-key': 'noise_sensors',
|
|
8311
8328
|
},
|
|
8312
8329
|
has_direct_power: {
|
|
8313
8330
|
description:
|
|
8314
8331
|
'Indicates whether the device has direct power.',
|
|
8315
8332
|
type: 'boolean',
|
|
8333
|
+
'x-property-group-key': 'hardware',
|
|
8316
8334
|
},
|
|
8317
8335
|
image_alt_text: {
|
|
8318
8336
|
description: 'Alt text for the device image.',
|
|
8319
8337
|
type: 'string',
|
|
8338
|
+
'x-property-group-key': 'hardware',
|
|
8320
8339
|
},
|
|
8321
8340
|
image_url: {
|
|
8322
8341
|
description: 'Image URL for the device.',
|
|
8323
8342
|
format: 'uri',
|
|
8324
8343
|
type: 'string',
|
|
8344
|
+
'x-property-group-key': 'hardware',
|
|
8325
8345
|
},
|
|
8326
8346
|
manufacturer: {
|
|
8327
8347
|
description:
|
|
8328
8348
|
'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
|
|
8329
8349
|
type: 'string',
|
|
8350
|
+
'x-property-group-key': 'hardware',
|
|
8330
8351
|
},
|
|
8331
8352
|
model: {
|
|
8353
|
+
description: 'Device model-related properties.',
|
|
8332
8354
|
properties: {
|
|
8333
8355
|
accessory_keypad_supported: {
|
|
8334
8356
|
deprecated: true,
|
|
@@ -8338,33 +8360,35 @@ export default {
|
|
|
8338
8360
|
},
|
|
8339
8361
|
can_connect_accessory_keypad: {
|
|
8340
8362
|
description:
|
|
8341
|
-
'Indicates whether the device can connect a accessory keypad
|
|
8363
|
+
'\n Indicates whether the device can connect a accessory keypad.\n ',
|
|
8342
8364
|
type: 'boolean',
|
|
8343
8365
|
},
|
|
8344
8366
|
display_name: {
|
|
8345
8367
|
description:
|
|
8346
|
-
'Display name of the device model
|
|
8368
|
+
'\n Display name of the device model.\n ',
|
|
8347
8369
|
type: 'string',
|
|
8348
8370
|
},
|
|
8349
8371
|
has_built_in_keypad: {
|
|
8350
8372
|
description:
|
|
8351
|
-
'Indicates whether the device has a built in accessory keypad
|
|
8373
|
+
'\n Indicates whether the device has a built in accessory keypad.\n ',
|
|
8352
8374
|
type: 'boolean',
|
|
8353
8375
|
},
|
|
8354
8376
|
manufacturer_display_name: {
|
|
8355
8377
|
description:
|
|
8356
|
-
'Display name that corresponds to the manufacturer-specific terminology for the device
|
|
8378
|
+
'\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ',
|
|
8357
8379
|
type: 'string',
|
|
8358
8380
|
},
|
|
8359
8381
|
offline_access_codes_supported: {
|
|
8360
|
-
|
|
8361
|
-
'Indicates whether the device supports offline access codes.',
|
|
8382
|
+
deprecated: true,
|
|
8362
8383
|
type: 'boolean',
|
|
8384
|
+
'x-deprecated':
|
|
8385
|
+
'use device.can_program_offline_access_codes.',
|
|
8363
8386
|
},
|
|
8364
8387
|
online_access_codes_supported: {
|
|
8365
|
-
|
|
8366
|
-
'Indicates whether the device supports online access codes.',
|
|
8388
|
+
deprecated: true,
|
|
8367
8389
|
type: 'boolean',
|
|
8390
|
+
'x-deprecated':
|
|
8391
|
+
'use device.can_program_online_access_codes.',
|
|
8368
8392
|
},
|
|
8369
8393
|
},
|
|
8370
8394
|
required: [
|
|
@@ -8384,11 +8408,13 @@ export default {
|
|
|
8384
8408
|
'Indicates current noise level in decibels, if the device supports noise detection.',
|
|
8385
8409
|
format: 'float',
|
|
8386
8410
|
type: 'number',
|
|
8411
|
+
'x-property-group-key': 'noise_sensors',
|
|
8387
8412
|
},
|
|
8388
8413
|
offline_access_codes_enabled: {
|
|
8389
8414
|
description:
|
|
8390
8415
|
'Indicates whether it is currently possible to use offline access codes for the device.',
|
|
8391
8416
|
type: 'boolean',
|
|
8417
|
+
'x-property-group-key': 'access_codes',
|
|
8392
8418
|
},
|
|
8393
8419
|
online: {
|
|
8394
8420
|
description:
|
|
@@ -8399,28 +8425,33 @@ export default {
|
|
|
8399
8425
|
description:
|
|
8400
8426
|
'Indicates whether it is currently possible to use online access codes for the device.',
|
|
8401
8427
|
type: 'boolean',
|
|
8428
|
+
'x-property-group-key': 'access_codes',
|
|
8402
8429
|
},
|
|
8403
8430
|
serial_number: {
|
|
8404
8431
|
description: 'Serial number of the device.',
|
|
8405
8432
|
type: 'string',
|
|
8433
|
+
'x-property-group-key': 'hardware',
|
|
8406
8434
|
},
|
|
8407
8435
|
supports_accessory_keypad: {
|
|
8408
8436
|
deprecated: true,
|
|
8409
8437
|
type: 'boolean',
|
|
8410
8438
|
'x-deprecated':
|
|
8411
8439
|
'use device.properties.model.can_connect_accessory_keypad',
|
|
8440
|
+
'x-property-group-key': 'access_codes',
|
|
8412
8441
|
},
|
|
8413
8442
|
supports_offline_access_codes: {
|
|
8414
8443
|
deprecated: true,
|
|
8415
8444
|
type: 'boolean',
|
|
8416
8445
|
'x-deprecated': 'use offline_access_codes_enabled',
|
|
8446
|
+
'x-property-group-key': 'access_codes',
|
|
8417
8447
|
},
|
|
8418
8448
|
},
|
|
8419
8449
|
required: ['online', 'name', 'appearance', 'model'],
|
|
8420
8450
|
type: 'object',
|
|
8421
8451
|
},
|
|
8422
8452
|
{
|
|
8423
|
-
description:
|
|
8453
|
+
description:
|
|
8454
|
+
'\n Properties of the phone.\n ',
|
|
8424
8455
|
properties: {
|
|
8425
8456
|
assa_abloy_credential_service_metadata: {
|
|
8426
8457
|
description:
|
|
@@ -8475,31 +8506,88 @@ export default {
|
|
|
8475
8506
|
],
|
|
8476
8507
|
},
|
|
8477
8508
|
{
|
|
8509
|
+
description: 'Provider-specific metadata.',
|
|
8478
8510
|
properties: {
|
|
8479
8511
|
akiles_metadata: {
|
|
8512
|
+
description:
|
|
8513
|
+
'Metadata for an Akiles device.\n ',
|
|
8480
8514
|
properties: {
|
|
8481
|
-
_member_group_id: {
|
|
8482
|
-
|
|
8483
|
-
|
|
8484
|
-
|
|
8515
|
+
_member_group_id: {
|
|
8516
|
+
description:
|
|
8517
|
+
'Group ID to which to add users for an Akiles device.\n ',
|
|
8518
|
+
type: 'string',
|
|
8519
|
+
},
|
|
8520
|
+
gadget_id: {
|
|
8521
|
+
description:
|
|
8522
|
+
'Gadget ID for an Akiles device.\n ',
|
|
8523
|
+
type: 'string',
|
|
8524
|
+
},
|
|
8525
|
+
gadget_name: {
|
|
8526
|
+
description:
|
|
8527
|
+
'Gadget name for an Akiles device.\n ',
|
|
8528
|
+
type: 'string',
|
|
8529
|
+
},
|
|
8530
|
+
product_name: {
|
|
8531
|
+
description:
|
|
8532
|
+
'Product name for an Akiles device.\n ',
|
|
8533
|
+
type: 'string',
|
|
8534
|
+
},
|
|
8485
8535
|
},
|
|
8486
8536
|
required: ['gadget_name', 'gadget_id', 'product_name'],
|
|
8487
8537
|
type: 'object',
|
|
8488
8538
|
},
|
|
8489
8539
|
assa_abloy_vostio_metadata: {
|
|
8490
|
-
|
|
8540
|
+
description:
|
|
8541
|
+
'Metadata for an ASSA ABLOY Vostio system.\n ',
|
|
8542
|
+
properties: {
|
|
8543
|
+
encoder_name: {
|
|
8544
|
+
description:
|
|
8545
|
+
'Encoder name for an ASSA ABLOY Vostio system.\n ',
|
|
8546
|
+
type: 'string',
|
|
8547
|
+
},
|
|
8548
|
+
},
|
|
8491
8549
|
required: ['encoder_name'],
|
|
8492
8550
|
type: 'object',
|
|
8493
8551
|
},
|
|
8494
8552
|
august_metadata: {
|
|
8553
|
+
description:
|
|
8554
|
+
'Metadata for an August device.\n ',
|
|
8495
8555
|
properties: {
|
|
8496
|
-
has_keypad: {
|
|
8497
|
-
|
|
8498
|
-
|
|
8499
|
-
|
|
8500
|
-
|
|
8501
|
-
|
|
8502
|
-
|
|
8556
|
+
has_keypad: {
|
|
8557
|
+
description:
|
|
8558
|
+
'Indicates whether an August device has a keypad.\n ',
|
|
8559
|
+
type: 'boolean',
|
|
8560
|
+
},
|
|
8561
|
+
house_id: {
|
|
8562
|
+
description:
|
|
8563
|
+
'House ID for an August device.\n ',
|
|
8564
|
+
type: 'string',
|
|
8565
|
+
},
|
|
8566
|
+
house_name: {
|
|
8567
|
+
description:
|
|
8568
|
+
'House name for an August device.\n ',
|
|
8569
|
+
type: 'string',
|
|
8570
|
+
},
|
|
8571
|
+
keypad_battery_level: {
|
|
8572
|
+
description:
|
|
8573
|
+
'Keypad battery level for an August device.\n ',
|
|
8574
|
+
type: 'string',
|
|
8575
|
+
},
|
|
8576
|
+
lock_id: {
|
|
8577
|
+
description:
|
|
8578
|
+
'Lock ID for an August device.\n ',
|
|
8579
|
+
type: 'string',
|
|
8580
|
+
},
|
|
8581
|
+
lock_name: {
|
|
8582
|
+
description:
|
|
8583
|
+
'Lock name for an August device.\n ',
|
|
8584
|
+
type: 'string',
|
|
8585
|
+
},
|
|
8586
|
+
model: {
|
|
8587
|
+
description:
|
|
8588
|
+
'Model for an August device.\n ',
|
|
8589
|
+
type: 'string',
|
|
8590
|
+
},
|
|
8503
8591
|
},
|
|
8504
8592
|
required: [
|
|
8505
8593
|
'lock_id',
|
|
@@ -8510,17 +8598,47 @@ export default {
|
|
|
8510
8598
|
type: 'object',
|
|
8511
8599
|
},
|
|
8512
8600
|
avigilon_alta_metadata: {
|
|
8601
|
+
description:
|
|
8602
|
+
'Metadata for an Avigilon Alta system.\n ',
|
|
8513
8603
|
properties: {
|
|
8514
|
-
entry_name: {
|
|
8604
|
+
entry_name: {
|
|
8605
|
+
description:
|
|
8606
|
+
'Entry name for an Avigilon Alta system.\n ',
|
|
8607
|
+
type: 'string',
|
|
8608
|
+
},
|
|
8515
8609
|
entry_relays_total_count: {
|
|
8610
|
+
description:
|
|
8611
|
+
'Total count of entry relays for an Avigilon Alta system.\n ',
|
|
8516
8612
|
format: 'float',
|
|
8517
8613
|
type: 'number',
|
|
8518
8614
|
},
|
|
8519
|
-
org_name: {
|
|
8520
|
-
|
|
8521
|
-
|
|
8522
|
-
|
|
8523
|
-
|
|
8615
|
+
org_name: {
|
|
8616
|
+
description:
|
|
8617
|
+
'Organization name for an Avigilon Alta system.\n ',
|
|
8618
|
+
type: 'string',
|
|
8619
|
+
},
|
|
8620
|
+
site_id: {
|
|
8621
|
+
description:
|
|
8622
|
+
'Site ID for an Avigilon Alta system.\n ',
|
|
8623
|
+
format: 'float',
|
|
8624
|
+
type: 'number',
|
|
8625
|
+
},
|
|
8626
|
+
site_name: {
|
|
8627
|
+
description:
|
|
8628
|
+
'Site name for an Avigilon Alta system.\n ',
|
|
8629
|
+
type: 'string',
|
|
8630
|
+
},
|
|
8631
|
+
zone_id: {
|
|
8632
|
+
description:
|
|
8633
|
+
'Zone ID for an Avigilon Alta system.\n ',
|
|
8634
|
+
format: 'float',
|
|
8635
|
+
type: 'number',
|
|
8636
|
+
},
|
|
8637
|
+
zone_name: {
|
|
8638
|
+
description:
|
|
8639
|
+
'Zone name for an Avigilon Alta system.\n ',
|
|
8640
|
+
type: 'string',
|
|
8641
|
+
},
|
|
8524
8642
|
},
|
|
8525
8643
|
required: [
|
|
8526
8644
|
'entry_name',
|
|
@@ -8534,50 +8652,134 @@ export default {
|
|
|
8534
8652
|
type: 'object',
|
|
8535
8653
|
},
|
|
8536
8654
|
brivo_metadata: {
|
|
8537
|
-
|
|
8655
|
+
description: 'Metadata for a Brivo device.\n ',
|
|
8656
|
+
properties: {
|
|
8657
|
+
device_name: {
|
|
8658
|
+
description:
|
|
8659
|
+
'Device name for a Brivo device.\n ',
|
|
8660
|
+
type: 'string',
|
|
8661
|
+
},
|
|
8662
|
+
},
|
|
8538
8663
|
required: ['device_name'],
|
|
8539
8664
|
type: 'object',
|
|
8540
8665
|
},
|
|
8541
8666
|
controlbyweb_metadata: {
|
|
8667
|
+
description:
|
|
8668
|
+
'Metadata for a ControlByWeb device.\n ',
|
|
8542
8669
|
properties: {
|
|
8543
|
-
device_id: {
|
|
8544
|
-
|
|
8545
|
-
|
|
8670
|
+
device_id: {
|
|
8671
|
+
description:
|
|
8672
|
+
'Device ID for a ControlByWeb device.\n ',
|
|
8673
|
+
type: 'string',
|
|
8674
|
+
},
|
|
8675
|
+
device_name: {
|
|
8676
|
+
description:
|
|
8677
|
+
'Device name for a ControlByWeb device.\n ',
|
|
8678
|
+
type: 'string',
|
|
8679
|
+
},
|
|
8680
|
+
relay_name: {
|
|
8681
|
+
description:
|
|
8682
|
+
'Relay name for a ControlByWeb device.\n ',
|
|
8683
|
+
nullable: true,
|
|
8684
|
+
type: 'string',
|
|
8685
|
+
},
|
|
8546
8686
|
},
|
|
8547
8687
|
required: ['device_id', 'device_name', 'relay_name'],
|
|
8548
8688
|
type: 'object',
|
|
8549
8689
|
},
|
|
8550
8690
|
dormakaba_oracode_metadata: {
|
|
8691
|
+
description:
|
|
8692
|
+
'Metadata for a dormakaba Oracode device.\n ',
|
|
8551
8693
|
properties: {
|
|
8552
8694
|
device_id: {
|
|
8695
|
+
description:
|
|
8696
|
+
'Device ID for a dormakaba Oracode device.\n ',
|
|
8553
8697
|
oneOf: [
|
|
8554
8698
|
{ format: 'float', type: 'number' },
|
|
8555
8699
|
{ type: 'string' },
|
|
8556
8700
|
],
|
|
8557
8701
|
},
|
|
8558
|
-
door_id: {
|
|
8559
|
-
|
|
8560
|
-
|
|
8561
|
-
|
|
8702
|
+
door_id: {
|
|
8703
|
+
description:
|
|
8704
|
+
'Door ID for a dormakaba Oracode device.\n ',
|
|
8705
|
+
format: 'float',
|
|
8706
|
+
type: 'number',
|
|
8707
|
+
},
|
|
8708
|
+
door_is_wireless: {
|
|
8709
|
+
description:
|
|
8710
|
+
'Indicates whether a door is wireless for a dormakaba Oracode device.\n ',
|
|
8711
|
+
type: 'boolean',
|
|
8712
|
+
},
|
|
8713
|
+
door_name: {
|
|
8714
|
+
description:
|
|
8715
|
+
'Door name for a dormakaba Oracode device.\n ',
|
|
8716
|
+
type: 'string',
|
|
8717
|
+
},
|
|
8718
|
+
iana_timezone: {
|
|
8719
|
+
description:
|
|
8720
|
+
'IANA time zone for a dormakaba Oracode device.\n ',
|
|
8721
|
+
type: 'string',
|
|
8722
|
+
},
|
|
8562
8723
|
predefined_time_slots: {
|
|
8724
|
+
description:
|
|
8725
|
+
'Predefined time slots for a dormakaba Oracode device.\n ',
|
|
8563
8726
|
items: {
|
|
8727
|
+
description:
|
|
8728
|
+
'Time slot for a dormakaba Oracode device.\n ',
|
|
8564
8729
|
properties: {
|
|
8565
|
-
check_in_time: {
|
|
8566
|
-
|
|
8730
|
+
check_in_time: {
|
|
8731
|
+
description:
|
|
8732
|
+
'Check in time for a time slot for a dormakaba Oracode device.\n ',
|
|
8733
|
+
type: 'string',
|
|
8734
|
+
},
|
|
8735
|
+
check_out_time: {
|
|
8736
|
+
description:
|
|
8737
|
+
'Checkout time for a time slot for a dormakaba Oracode device.\n ',
|
|
8738
|
+
type: 'string',
|
|
8739
|
+
},
|
|
8567
8740
|
dormakaba_oracode_user_level_id: {
|
|
8741
|
+
description:
|
|
8742
|
+
'ID of a user level for a dormakaba Oracode device.\n ',
|
|
8568
8743
|
format: 'uuid',
|
|
8569
8744
|
type: 'string',
|
|
8570
8745
|
},
|
|
8571
8746
|
ext_dormakaba_oracode_user_level_prefix: {
|
|
8747
|
+
description:
|
|
8748
|
+
'Prefix for a user level for a dormakaba Oracode device.\n ',
|
|
8749
|
+
format: 'float',
|
|
8750
|
+
type: 'number',
|
|
8751
|
+
},
|
|
8752
|
+
is_24_hour: {
|
|
8753
|
+
description:
|
|
8754
|
+
'Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.\n ',
|
|
8755
|
+
type: 'boolean',
|
|
8756
|
+
},
|
|
8757
|
+
is_biweekly_mode: {
|
|
8758
|
+
description:
|
|
8759
|
+
'Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.\n ',
|
|
8760
|
+
type: 'boolean',
|
|
8761
|
+
},
|
|
8762
|
+
is_master: {
|
|
8763
|
+
description:
|
|
8764
|
+
'Indicates whether a time slot for a dormakaba Oracode device is a master time slot.\n ',
|
|
8765
|
+
type: 'boolean',
|
|
8766
|
+
},
|
|
8767
|
+
is_one_shot: {
|
|
8768
|
+
description:
|
|
8769
|
+
'Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.\n ',
|
|
8770
|
+
type: 'boolean',
|
|
8771
|
+
},
|
|
8772
|
+
name: {
|
|
8773
|
+
description:
|
|
8774
|
+
'Name of a time slot for a dormakaba Oracode device.\n ',
|
|
8775
|
+
type: 'string',
|
|
8776
|
+
},
|
|
8777
|
+
prefix: {
|
|
8778
|
+
description:
|
|
8779
|
+
'Prefix for a time slot for a dormakaba Oracode device.\n ',
|
|
8572
8780
|
format: 'float',
|
|
8573
8781
|
type: 'number',
|
|
8574
8782
|
},
|
|
8575
|
-
is_24_hour: { type: 'boolean' },
|
|
8576
|
-
is_biweekly_mode: { type: 'boolean' },
|
|
8577
|
-
is_master: { type: 'boolean' },
|
|
8578
|
-
is_one_shot: { type: 'boolean' },
|
|
8579
|
-
name: { type: 'string' },
|
|
8580
|
-
prefix: { format: 'float', type: 'number' },
|
|
8581
8783
|
},
|
|
8582
8784
|
required: [
|
|
8583
8785
|
'name',
|
|
@@ -8596,12 +8798,20 @@ export default {
|
|
|
8596
8798
|
type: 'array',
|
|
8597
8799
|
},
|
|
8598
8800
|
site_id: {
|
|
8599
|
-
|
|
8801
|
+
deprecated: true,
|
|
8802
|
+
description:
|
|
8803
|
+
'Site ID for a dormakaba Oracode device.',
|
|
8600
8804
|
format: 'float',
|
|
8601
8805
|
nullable: true,
|
|
8602
8806
|
type: 'number',
|
|
8807
|
+
'x-deprecated':
|
|
8808
|
+
'Previously marked as "@DEPRECATED."',
|
|
8809
|
+
},
|
|
8810
|
+
site_name: {
|
|
8811
|
+
description:
|
|
8812
|
+
'Site name for a dormakaba Oracode device.\n ',
|
|
8813
|
+
type: 'string',
|
|
8603
8814
|
},
|
|
8604
|
-
site_name: { type: 'string' },
|
|
8605
8815
|
},
|
|
8606
8816
|
required: [
|
|
8607
8817
|
'door_name',
|
|
@@ -8612,18 +8822,41 @@ export default {
|
|
|
8612
8822
|
type: 'object',
|
|
8613
8823
|
},
|
|
8614
8824
|
ecobee_metadata: {
|
|
8825
|
+
description:
|
|
8826
|
+
'Metadata for an ecobee device.\n ',
|
|
8615
8827
|
properties: {
|
|
8616
|
-
device_name: {
|
|
8617
|
-
|
|
8828
|
+
device_name: {
|
|
8829
|
+
description:
|
|
8830
|
+
'Device name for an ecobee device.\n ',
|
|
8831
|
+
type: 'string',
|
|
8832
|
+
},
|
|
8833
|
+
ecobee_device_id: {
|
|
8834
|
+
description:
|
|
8835
|
+
'Device ID for an ecobee device.\n ',
|
|
8836
|
+
type: 'string',
|
|
8837
|
+
},
|
|
8618
8838
|
},
|
|
8619
8839
|
required: ['ecobee_device_id', 'device_name'],
|
|
8620
8840
|
type: 'object',
|
|
8621
8841
|
},
|
|
8622
8842
|
four_suites_metadata: {
|
|
8843
|
+
description:
|
|
8844
|
+
'Metadata for a 4SUITES device.\n ',
|
|
8623
8845
|
properties: {
|
|
8624
|
-
device_id: {
|
|
8625
|
-
|
|
8846
|
+
device_id: {
|
|
8847
|
+
description:
|
|
8848
|
+
'Device ID for a 4SUITES device.\n ',
|
|
8849
|
+
format: 'float',
|
|
8850
|
+
type: 'number',
|
|
8851
|
+
},
|
|
8852
|
+
device_name: {
|
|
8853
|
+
description:
|
|
8854
|
+
'Device name for a 4SUITES device.\n ',
|
|
8855
|
+
type: 'string',
|
|
8856
|
+
},
|
|
8626
8857
|
reclose_delay_in_seconds: {
|
|
8858
|
+
description:
|
|
8859
|
+
'Reclose delay, in seconds, for a 4SUITES device.\n ',
|
|
8627
8860
|
format: 'float',
|
|
8628
8861
|
type: 'number',
|
|
8629
8862
|
},
|
|
@@ -8636,17 +8869,36 @@ export default {
|
|
|
8636
8869
|
type: 'object',
|
|
8637
8870
|
},
|
|
8638
8871
|
genie_metadata: {
|
|
8872
|
+
description: 'Metadata for a Genie device.\n ',
|
|
8639
8873
|
properties: {
|
|
8640
|
-
device_name: {
|
|
8641
|
-
|
|
8874
|
+
device_name: {
|
|
8875
|
+
description:
|
|
8876
|
+
'Lock name for a Genie device.\n ',
|
|
8877
|
+
type: 'string',
|
|
8878
|
+
},
|
|
8879
|
+
door_name: {
|
|
8880
|
+
description:
|
|
8881
|
+
'Door name for a Genie device.\n ',
|
|
8882
|
+
type: 'string',
|
|
8883
|
+
},
|
|
8642
8884
|
},
|
|
8643
8885
|
required: ['device_name', 'door_name'],
|
|
8644
8886
|
type: 'object',
|
|
8645
8887
|
},
|
|
8646
8888
|
honeywell_resideo_metadata: {
|
|
8889
|
+
description:
|
|
8890
|
+
'Metadata for a Honeywell Resideo device.\n ',
|
|
8647
8891
|
properties: {
|
|
8648
|
-
device_name: {
|
|
8649
|
-
|
|
8892
|
+
device_name: {
|
|
8893
|
+
description:
|
|
8894
|
+
'Device name for a Honeywell Resideo device.\n ',
|
|
8895
|
+
type: 'string',
|
|
8896
|
+
},
|
|
8897
|
+
honeywell_resideo_device_id: {
|
|
8898
|
+
description:
|
|
8899
|
+
'Device ID for a Honeywell Resideo device.\n ',
|
|
8900
|
+
type: 'string',
|
|
8901
|
+
},
|
|
8650
8902
|
},
|
|
8651
8903
|
required: [
|
|
8652
8904
|
'honeywell_resideo_device_id',
|
|
@@ -8655,94 +8907,238 @@ export default {
|
|
|
8655
8907
|
type: 'object',
|
|
8656
8908
|
},
|
|
8657
8909
|
hubitat_metadata: {
|
|
8910
|
+
description:
|
|
8911
|
+
'Metadata for a Hubitat device.\n ',
|
|
8658
8912
|
properties: {
|
|
8659
|
-
device_id: {
|
|
8660
|
-
|
|
8661
|
-
|
|
8913
|
+
device_id: {
|
|
8914
|
+
description:
|
|
8915
|
+
'Device ID for a Hubitat device.\n ',
|
|
8916
|
+
type: 'string',
|
|
8917
|
+
},
|
|
8918
|
+
device_label: {
|
|
8919
|
+
description:
|
|
8920
|
+
'Device label for a Hubitat device.\n ',
|
|
8921
|
+
type: 'string',
|
|
8922
|
+
},
|
|
8923
|
+
device_name: {
|
|
8924
|
+
description:
|
|
8925
|
+
'Device name for a Hubitat device.\n ',
|
|
8926
|
+
type: 'string',
|
|
8927
|
+
},
|
|
8662
8928
|
},
|
|
8663
8929
|
required: ['device_id', 'device_name', 'device_label'],
|
|
8664
8930
|
type: 'object',
|
|
8665
8931
|
},
|
|
8666
8932
|
igloo_metadata: {
|
|
8933
|
+
description:
|
|
8934
|
+
'Metadata for an igloo device.\n ',
|
|
8667
8935
|
properties: {
|
|
8668
|
-
bridge_id: {
|
|
8669
|
-
|
|
8670
|
-
|
|
8936
|
+
bridge_id: {
|
|
8937
|
+
description:
|
|
8938
|
+
'Bridge ID for an igloo device.\n ',
|
|
8939
|
+
type: 'string',
|
|
8940
|
+
},
|
|
8941
|
+
device_id: {
|
|
8942
|
+
description:
|
|
8943
|
+
'Device ID for an igloo device.\n ',
|
|
8944
|
+
type: 'string',
|
|
8945
|
+
},
|
|
8946
|
+
model: {
|
|
8947
|
+
description:
|
|
8948
|
+
'Model for an igloo device.\n ',
|
|
8949
|
+
type: 'string',
|
|
8950
|
+
},
|
|
8671
8951
|
},
|
|
8672
8952
|
required: ['device_id', 'bridge_id'],
|
|
8673
8953
|
type: 'object',
|
|
8674
8954
|
},
|
|
8675
8955
|
igloohome_metadata: {
|
|
8956
|
+
description:
|
|
8957
|
+
'Metadata for an igloohome device.\n ',
|
|
8676
8958
|
properties: {
|
|
8677
|
-
bridge_id: {
|
|
8678
|
-
|
|
8679
|
-
|
|
8680
|
-
|
|
8681
|
-
|
|
8959
|
+
bridge_id: {
|
|
8960
|
+
description:
|
|
8961
|
+
'Bridge ID for an igloohome device.\n ',
|
|
8962
|
+
type: 'string',
|
|
8963
|
+
},
|
|
8964
|
+
bridge_name: {
|
|
8965
|
+
description:
|
|
8966
|
+
'Bridge name for an igloohome device.\n ',
|
|
8967
|
+
type: 'string',
|
|
8968
|
+
},
|
|
8969
|
+
device_id: {
|
|
8970
|
+
description:
|
|
8971
|
+
'Device ID for an igloohome device.\n ',
|
|
8972
|
+
type: 'string',
|
|
8973
|
+
},
|
|
8974
|
+
device_name: {
|
|
8975
|
+
description:
|
|
8976
|
+
'Device name for an igloohome device.\n ',
|
|
8977
|
+
type: 'string',
|
|
8978
|
+
},
|
|
8979
|
+
keypad_id: {
|
|
8980
|
+
description:
|
|
8981
|
+
'Keypad ID for an igloohome device.\n ',
|
|
8982
|
+
type: 'string',
|
|
8983
|
+
},
|
|
8682
8984
|
},
|
|
8683
8985
|
required: ['device_id', 'device_name'],
|
|
8684
8986
|
type: 'object',
|
|
8685
8987
|
},
|
|
8686
8988
|
kwikset_metadata: {
|
|
8989
|
+
description:
|
|
8990
|
+
'Metadata for a Kwikset device.\n ',
|
|
8687
8991
|
properties: {
|
|
8688
|
-
device_id: {
|
|
8689
|
-
|
|
8690
|
-
|
|
8992
|
+
device_id: {
|
|
8993
|
+
description:
|
|
8994
|
+
'Device ID for a Kwikset device.\n ',
|
|
8995
|
+
type: 'string',
|
|
8996
|
+
},
|
|
8997
|
+
device_name: {
|
|
8998
|
+
description:
|
|
8999
|
+
'Device name for a Kwikset device.\n ',
|
|
9000
|
+
type: 'string',
|
|
9001
|
+
},
|
|
9002
|
+
model_number: {
|
|
9003
|
+
description:
|
|
9004
|
+
'Model number for a Kwikset device.\n ',
|
|
9005
|
+
type: 'string',
|
|
9006
|
+
},
|
|
8691
9007
|
},
|
|
8692
9008
|
required: ['device_id', 'device_name', 'model_number'],
|
|
8693
9009
|
type: 'object',
|
|
8694
9010
|
},
|
|
8695
9011
|
lockly_metadata: {
|
|
9012
|
+
description:
|
|
9013
|
+
'Metadata for a Lockly device.\n ',
|
|
8696
9014
|
properties: {
|
|
8697
|
-
device_id: {
|
|
8698
|
-
|
|
8699
|
-
|
|
9015
|
+
device_id: {
|
|
9016
|
+
description:
|
|
9017
|
+
'Device ID for a Lockly device.\n ',
|
|
9018
|
+
type: 'string',
|
|
9019
|
+
},
|
|
9020
|
+
device_name: {
|
|
9021
|
+
description:
|
|
9022
|
+
'Device name for a Lockly device.\n ',
|
|
9023
|
+
type: 'string',
|
|
9024
|
+
},
|
|
9025
|
+
model: {
|
|
9026
|
+
description:
|
|
9027
|
+
'Model for a Lockly device.\n ',
|
|
9028
|
+
type: 'string',
|
|
9029
|
+
},
|
|
8700
9030
|
},
|
|
8701
9031
|
required: ['device_id', 'device_name'],
|
|
8702
9032
|
type: 'object',
|
|
8703
9033
|
},
|
|
8704
9034
|
minut_metadata: {
|
|
9035
|
+
description: 'Metadata for a Minut device.\n ',
|
|
8705
9036
|
properties: {
|
|
8706
|
-
device_id: {
|
|
8707
|
-
|
|
9037
|
+
device_id: {
|
|
9038
|
+
description:
|
|
9039
|
+
'Device ID for a Minut device.\n ',
|
|
9040
|
+
type: 'string',
|
|
9041
|
+
},
|
|
9042
|
+
device_name: {
|
|
9043
|
+
description:
|
|
9044
|
+
'Device name for a Minut device.\n ',
|
|
9045
|
+
type: 'string',
|
|
9046
|
+
},
|
|
8708
9047
|
latest_sensor_values: {
|
|
9048
|
+
description:
|
|
9049
|
+
'Latest sensor values for a Minut device.\n ',
|
|
8709
9050
|
properties: {
|
|
8710
9051
|
accelerometer_z: {
|
|
9052
|
+
description:
|
|
9053
|
+
'Latest accelerometer Z-axis reading for a Minut device.\n ',
|
|
8711
9054
|
properties: {
|
|
8712
|
-
time: {
|
|
8713
|
-
|
|
9055
|
+
time: {
|
|
9056
|
+
description:
|
|
9057
|
+
'Time of latest accelerometer Z-axis reading for a Minut device.\n ',
|
|
9058
|
+
type: 'string',
|
|
9059
|
+
},
|
|
9060
|
+
value: {
|
|
9061
|
+
description:
|
|
9062
|
+
'Value of latest accelerometer Z-axis reading for a Minut device.\n ',
|
|
9063
|
+
format: 'float',
|
|
9064
|
+
type: 'number',
|
|
9065
|
+
},
|
|
8714
9066
|
},
|
|
8715
9067
|
required: ['time', 'value'],
|
|
8716
9068
|
type: 'object',
|
|
8717
9069
|
},
|
|
8718
9070
|
humidity: {
|
|
9071
|
+
description:
|
|
9072
|
+
'Latest humidity reading for a Minut device.\n ',
|
|
8719
9073
|
properties: {
|
|
8720
|
-
time: {
|
|
8721
|
-
|
|
9074
|
+
time: {
|
|
9075
|
+
description:
|
|
9076
|
+
'Time of latest humidity reading for a Minut device.\n ',
|
|
9077
|
+
type: 'string',
|
|
9078
|
+
},
|
|
9079
|
+
value: {
|
|
9080
|
+
description:
|
|
9081
|
+
'Value of latest humidity reading for a Minut device.\n ',
|
|
9082
|
+
format: 'float',
|
|
9083
|
+
type: 'number',
|
|
9084
|
+
},
|
|
8722
9085
|
},
|
|
8723
9086
|
required: ['time', 'value'],
|
|
8724
9087
|
type: 'object',
|
|
8725
9088
|
},
|
|
8726
9089
|
pressure: {
|
|
9090
|
+
description:
|
|
9091
|
+
'Latest pressure reading for a Minut device.\n ',
|
|
8727
9092
|
properties: {
|
|
8728
|
-
time: {
|
|
8729
|
-
|
|
9093
|
+
time: {
|
|
9094
|
+
description:
|
|
9095
|
+
'Time of latest pressure reading for a Minut device.\n ',
|
|
9096
|
+
type: 'string',
|
|
9097
|
+
},
|
|
9098
|
+
value: {
|
|
9099
|
+
description:
|
|
9100
|
+
'Value of latest pressure reading for a Minut device.\n ',
|
|
9101
|
+
format: 'float',
|
|
9102
|
+
type: 'number',
|
|
9103
|
+
},
|
|
8730
9104
|
},
|
|
8731
9105
|
required: ['time', 'value'],
|
|
8732
9106
|
type: 'object',
|
|
8733
9107
|
},
|
|
8734
9108
|
sound: {
|
|
9109
|
+
description:
|
|
9110
|
+
'Latest sound reading for a Minut device.\n ',
|
|
8735
9111
|
properties: {
|
|
8736
|
-
time: {
|
|
8737
|
-
|
|
9112
|
+
time: {
|
|
9113
|
+
description:
|
|
9114
|
+
'Time of latest sound reading for a Minut device.\n ',
|
|
9115
|
+
type: 'string',
|
|
9116
|
+
},
|
|
9117
|
+
value: {
|
|
9118
|
+
description:
|
|
9119
|
+
'Value of latest sound reading for a Minut device.\n ',
|
|
9120
|
+
format: 'float',
|
|
9121
|
+
type: 'number',
|
|
9122
|
+
},
|
|
8738
9123
|
},
|
|
8739
9124
|
required: ['time', 'value'],
|
|
8740
9125
|
type: 'object',
|
|
8741
9126
|
},
|
|
8742
9127
|
temperature: {
|
|
9128
|
+
description:
|
|
9129
|
+
'Latest temperature reading for a Minut device.\n ',
|
|
8743
9130
|
properties: {
|
|
8744
|
-
time: {
|
|
8745
|
-
|
|
9131
|
+
time: {
|
|
9132
|
+
description:
|
|
9133
|
+
'Time of latest temperature reading for a Minut device.\n ',
|
|
9134
|
+
type: 'string',
|
|
9135
|
+
},
|
|
9136
|
+
value: {
|
|
9137
|
+
description:
|
|
9138
|
+
'Value of latest temperature reading for a Minut device.\n ',
|
|
9139
|
+
format: 'float',
|
|
9140
|
+
type: 'number',
|
|
9141
|
+
},
|
|
8746
9142
|
},
|
|
8747
9143
|
required: ['time', 'value'],
|
|
8748
9144
|
type: 'object',
|
|
@@ -8766,11 +9162,29 @@ export default {
|
|
|
8766
9162
|
type: 'object',
|
|
8767
9163
|
},
|
|
8768
9164
|
nest_metadata: {
|
|
9165
|
+
description:
|
|
9166
|
+
'Metadata for a Google Nest device.\n ',
|
|
8769
9167
|
properties: {
|
|
8770
|
-
device_custom_name: {
|
|
8771
|
-
|
|
8772
|
-
|
|
8773
|
-
|
|
9168
|
+
device_custom_name: {
|
|
9169
|
+
description:
|
|
9170
|
+
'Custom device name for a Google Nest device. The device owner sets this value.\n ',
|
|
9171
|
+
type: 'string',
|
|
9172
|
+
},
|
|
9173
|
+
device_name: {
|
|
9174
|
+
description:
|
|
9175
|
+
'Device name for a Google Nest device. Google sets this value.\n ',
|
|
9176
|
+
type: 'string',
|
|
9177
|
+
},
|
|
9178
|
+
display_name: {
|
|
9179
|
+
description:
|
|
9180
|
+
'Display name for a Google Nest device.\n ',
|
|
9181
|
+
type: 'string',
|
|
9182
|
+
},
|
|
9183
|
+
nest_device_id: {
|
|
9184
|
+
description:
|
|
9185
|
+
'Device ID for a Google Nest device.\n ',
|
|
9186
|
+
type: 'string',
|
|
9187
|
+
},
|
|
8774
9188
|
},
|
|
8775
9189
|
required: [
|
|
8776
9190
|
'nest_device_id',
|
|
@@ -8780,18 +9194,37 @@ export default {
|
|
|
8780
9194
|
type: 'object',
|
|
8781
9195
|
},
|
|
8782
9196
|
noiseaware_metadata: {
|
|
9197
|
+
description:
|
|
9198
|
+
'Metadata for a NoiseAware device.\n ',
|
|
8783
9199
|
properties: {
|
|
8784
|
-
device_id: {
|
|
9200
|
+
device_id: {
|
|
9201
|
+
description:
|
|
9202
|
+
'Device ID for a NoiseAware device.\n ',
|
|
9203
|
+
type: 'string',
|
|
9204
|
+
},
|
|
8785
9205
|
device_model: {
|
|
9206
|
+
description:
|
|
9207
|
+
'Device model for a NoiseAware device.\n ',
|
|
8786
9208
|
enum: ['indoor', 'outdoor'],
|
|
8787
9209
|
type: 'string',
|
|
8788
9210
|
},
|
|
8789
|
-
device_name: {
|
|
9211
|
+
device_name: {
|
|
9212
|
+
description:
|
|
9213
|
+
'Device name for a NoiseAware device.\n ',
|
|
9214
|
+
type: 'string',
|
|
9215
|
+
},
|
|
8790
9216
|
noise_level_decibel: {
|
|
9217
|
+
description:
|
|
9218
|
+
'Noise level, in decibels, for a NoiseAware device.\n ',
|
|
9219
|
+
format: 'float',
|
|
9220
|
+
type: 'number',
|
|
9221
|
+
},
|
|
9222
|
+
noise_level_nrs: {
|
|
9223
|
+
description:
|
|
9224
|
+
'Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.\n ',
|
|
8791
9225
|
format: 'float',
|
|
8792
9226
|
type: 'number',
|
|
8793
9227
|
},
|
|
8794
|
-
noise_level_nrs: { format: 'float', type: 'number' },
|
|
8795
9228
|
},
|
|
8796
9229
|
required: [
|
|
8797
9230
|
'device_model',
|
|
@@ -8803,24 +9236,71 @@ export default {
|
|
|
8803
9236
|
type: 'object',
|
|
8804
9237
|
},
|
|
8805
9238
|
nuki_metadata: {
|
|
9239
|
+
description: 'Metadata for a Nuki device.\n ',
|
|
8806
9240
|
properties: {
|
|
8807
|
-
device_id: {
|
|
8808
|
-
|
|
8809
|
-
|
|
8810
|
-
|
|
8811
|
-
|
|
9241
|
+
device_id: {
|
|
9242
|
+
description:
|
|
9243
|
+
'Device ID for a Nuki device.\n ',
|
|
9244
|
+
type: 'string',
|
|
9245
|
+
},
|
|
9246
|
+
device_name: {
|
|
9247
|
+
description:
|
|
9248
|
+
'Device name for a Nuki device.\n ',
|
|
9249
|
+
type: 'string',
|
|
9250
|
+
},
|
|
9251
|
+
keypad_2_paired: {
|
|
9252
|
+
description:
|
|
9253
|
+
'Indicates whether keypad 2 is paired for a Nuki device.\n ',
|
|
9254
|
+
type: 'boolean',
|
|
9255
|
+
},
|
|
9256
|
+
keypad_battery_critical: {
|
|
9257
|
+
description:
|
|
9258
|
+
'Indicates whether the keypad battery is in a critical state for a Nuki device.\n ',
|
|
9259
|
+
type: 'boolean',
|
|
9260
|
+
},
|
|
9261
|
+
keypad_paired: {
|
|
9262
|
+
description:
|
|
9263
|
+
'Indicates whether the keypad is paired for a Nuki device.\n ',
|
|
9264
|
+
type: 'boolean',
|
|
9265
|
+
},
|
|
8812
9266
|
},
|
|
8813
9267
|
required: ['device_id', 'device_name'],
|
|
8814
9268
|
type: 'object',
|
|
8815
9269
|
},
|
|
8816
9270
|
salto_ks_metadata: {
|
|
9271
|
+
description:
|
|
9272
|
+
'Metadata for a Salto KS device.\n ',
|
|
8817
9273
|
properties: {
|
|
8818
|
-
battery_level: {
|
|
8819
|
-
|
|
8820
|
-
|
|
8821
|
-
|
|
8822
|
-
|
|
8823
|
-
|
|
9274
|
+
battery_level: {
|
|
9275
|
+
description:
|
|
9276
|
+
'Battery level for a Salto KS device.\n ',
|
|
9277
|
+
type: 'string',
|
|
9278
|
+
},
|
|
9279
|
+
customer_reference: {
|
|
9280
|
+
description:
|
|
9281
|
+
'Customer reference for a Salto KS device.\n ',
|
|
9282
|
+
type: 'string',
|
|
9283
|
+
},
|
|
9284
|
+
lock_id: {
|
|
9285
|
+
description:
|
|
9286
|
+
'Lock ID for a Salto KS device.\n ',
|
|
9287
|
+
type: 'string',
|
|
9288
|
+
},
|
|
9289
|
+
lock_type: {
|
|
9290
|
+
description:
|
|
9291
|
+
'Lock type for a Salto KS device.\n ',
|
|
9292
|
+
type: 'string',
|
|
9293
|
+
},
|
|
9294
|
+
locked_state: {
|
|
9295
|
+
description:
|
|
9296
|
+
'Locked state for a Salto KS device.\n ',
|
|
9297
|
+
type: 'string',
|
|
9298
|
+
},
|
|
9299
|
+
model: {
|
|
9300
|
+
description:
|
|
9301
|
+
'Model for a Salto KS device.\n ',
|
|
9302
|
+
type: 'string',
|
|
9303
|
+
},
|
|
8824
9304
|
},
|
|
8825
9305
|
required: [
|
|
8826
9306
|
'lock_id',
|
|
@@ -8832,15 +9312,39 @@ export default {
|
|
|
8832
9312
|
type: 'object',
|
|
8833
9313
|
},
|
|
8834
9314
|
salto_metadata: {
|
|
8835
|
-
|
|
8836
|
-
|
|
9315
|
+
deprecated: true,
|
|
9316
|
+
description: 'Metada for a Salto device.',
|
|
8837
9317
|
properties: {
|
|
8838
|
-
battery_level: {
|
|
8839
|
-
|
|
8840
|
-
|
|
8841
|
-
|
|
8842
|
-
|
|
8843
|
-
|
|
9318
|
+
battery_level: {
|
|
9319
|
+
description:
|
|
9320
|
+
'Battery level for a Salto device.\n ',
|
|
9321
|
+
type: 'string',
|
|
9322
|
+
},
|
|
9323
|
+
customer_reference: {
|
|
9324
|
+
description:
|
|
9325
|
+
'Customer reference for a Salto device.\n ',
|
|
9326
|
+
type: 'string',
|
|
9327
|
+
},
|
|
9328
|
+
lock_id: {
|
|
9329
|
+
description:
|
|
9330
|
+
'Lock ID for a Salto device.\n ',
|
|
9331
|
+
type: 'string',
|
|
9332
|
+
},
|
|
9333
|
+
lock_type: {
|
|
9334
|
+
description:
|
|
9335
|
+
'Lock type for a Salto device.\n ',
|
|
9336
|
+
type: 'string',
|
|
9337
|
+
},
|
|
9338
|
+
locked_state: {
|
|
9339
|
+
description:
|
|
9340
|
+
'Locked state for a Salto device.\n ',
|
|
9341
|
+
type: 'string',
|
|
9342
|
+
},
|
|
9343
|
+
model: {
|
|
9344
|
+
description:
|
|
9345
|
+
'Model for a Salto device.\n ',
|
|
9346
|
+
type: 'string',
|
|
9347
|
+
},
|
|
8844
9348
|
},
|
|
8845
9349
|
required: [
|
|
8846
9350
|
'lock_id',
|
|
@@ -8850,21 +9354,47 @@ export default {
|
|
|
8850
9354
|
'locked_state',
|
|
8851
9355
|
],
|
|
8852
9356
|
type: 'object',
|
|
9357
|
+
'x-deprecated': 'Use `salto_ks_metadata ` instead.',
|
|
8853
9358
|
},
|
|
8854
9359
|
schlage_metadata: {
|
|
9360
|
+
description:
|
|
9361
|
+
'Metadata for a Schlage device.\n ',
|
|
8855
9362
|
properties: {
|
|
8856
|
-
device_id: {
|
|
8857
|
-
|
|
8858
|
-
|
|
9363
|
+
device_id: {
|
|
9364
|
+
description:
|
|
9365
|
+
'Device ID for a Schlage device.\n ',
|
|
9366
|
+
type: 'string',
|
|
9367
|
+
},
|
|
9368
|
+
device_name: {
|
|
9369
|
+
description:
|
|
9370
|
+
'Device name for a Schlage device.\n ',
|
|
9371
|
+
type: 'string',
|
|
9372
|
+
},
|
|
9373
|
+
model: {
|
|
9374
|
+
description:
|
|
9375
|
+
'Model for a Schlage device.\n ',
|
|
9376
|
+
type: 'string',
|
|
9377
|
+
},
|
|
8859
9378
|
},
|
|
8860
9379
|
required: ['device_id', 'device_name'],
|
|
8861
9380
|
type: 'object',
|
|
8862
9381
|
},
|
|
8863
9382
|
seam_bridge_metadata: {
|
|
9383
|
+
description: 'Metadata for Seam Bridge.\n ',
|
|
8864
9384
|
properties: {
|
|
8865
|
-
device_num: {
|
|
8866
|
-
|
|
9385
|
+
device_num: {
|
|
9386
|
+
description:
|
|
9387
|
+
'Device number for Seam Bridge.\n ',
|
|
9388
|
+
format: 'float',
|
|
9389
|
+
type: 'number',
|
|
9390
|
+
},
|
|
9391
|
+
name: {
|
|
9392
|
+
description: 'Name for Seam Bridge.\n ',
|
|
9393
|
+
type: 'string',
|
|
9394
|
+
},
|
|
8867
9395
|
unlock_method: {
|
|
9396
|
+
description:
|
|
9397
|
+
'Unlock method for Seam Bridge.\n ',
|
|
8868
9398
|
enum: ['bridge', 'doorking'],
|
|
8869
9399
|
type: 'string',
|
|
8870
9400
|
},
|
|
@@ -8873,41 +9403,113 @@ export default {
|
|
|
8873
9403
|
type: 'object',
|
|
8874
9404
|
},
|
|
8875
9405
|
sensi_metadata: {
|
|
9406
|
+
description: 'Metadata for a Sensi device.\n ',
|
|
8876
9407
|
properties: {
|
|
8877
|
-
device_id: {
|
|
8878
|
-
|
|
8879
|
-
|
|
9408
|
+
device_id: {
|
|
9409
|
+
description:
|
|
9410
|
+
'Device ID for a Sensi device.\n ',
|
|
9411
|
+
type: 'string',
|
|
9412
|
+
},
|
|
9413
|
+
device_name: {
|
|
9414
|
+
description:
|
|
9415
|
+
'Device name for a Sensi device.\n ',
|
|
9416
|
+
type: 'string',
|
|
9417
|
+
},
|
|
9418
|
+
product_type: {
|
|
9419
|
+
description:
|
|
9420
|
+
'Product type for a Sensi device.\n ',
|
|
9421
|
+
type: 'string',
|
|
9422
|
+
},
|
|
8880
9423
|
},
|
|
8881
9424
|
required: ['device_id', 'device_name', 'product_type'],
|
|
8882
9425
|
type: 'object',
|
|
8883
9426
|
},
|
|
8884
9427
|
smartthings_metadata: {
|
|
9428
|
+
description:
|
|
9429
|
+
'Metadata for a SmartThings device.\n ',
|
|
8885
9430
|
properties: {
|
|
8886
|
-
device_id: {
|
|
8887
|
-
|
|
8888
|
-
|
|
8889
|
-
|
|
9431
|
+
device_id: {
|
|
9432
|
+
description:
|
|
9433
|
+
'Device ID for a SmartThings device.\n ',
|
|
9434
|
+
type: 'string',
|
|
9435
|
+
},
|
|
9436
|
+
device_name: {
|
|
9437
|
+
description:
|
|
9438
|
+
'Device name for a SmartThings device.\n ',
|
|
9439
|
+
type: 'string',
|
|
9440
|
+
},
|
|
9441
|
+
location_id: {
|
|
9442
|
+
description:
|
|
9443
|
+
'Location ID for a SmartThings device.\n ',
|
|
9444
|
+
type: 'string',
|
|
9445
|
+
},
|
|
9446
|
+
model: {
|
|
9447
|
+
description:
|
|
9448
|
+
'Model for a SmartThings device.\n ',
|
|
9449
|
+
type: 'string',
|
|
9450
|
+
},
|
|
8890
9451
|
},
|
|
8891
9452
|
required: ['device_id', 'device_name'],
|
|
8892
9453
|
type: 'object',
|
|
8893
9454
|
},
|
|
8894
9455
|
tado_metadata: {
|
|
9456
|
+
description: 'Metadata for a tado° device.\n ',
|
|
8895
9457
|
properties: {
|
|
8896
|
-
device_type: {
|
|
8897
|
-
|
|
9458
|
+
device_type: {
|
|
9459
|
+
description:
|
|
9460
|
+
'Device type for a tado° device.\n ',
|
|
9461
|
+
type: 'string',
|
|
9462
|
+
},
|
|
9463
|
+
serial_no: {
|
|
9464
|
+
description:
|
|
9465
|
+
'Serial number for a tado° device.\n ',
|
|
9466
|
+
type: 'string',
|
|
9467
|
+
},
|
|
8898
9468
|
},
|
|
8899
9469
|
required: ['serial_no', 'device_type'],
|
|
8900
9470
|
type: 'object',
|
|
8901
9471
|
},
|
|
8902
9472
|
tedee_metadata: {
|
|
9473
|
+
description: 'Metadata for a Tedee device.\n ',
|
|
8903
9474
|
properties: {
|
|
8904
|
-
bridge_id: {
|
|
8905
|
-
|
|
8906
|
-
|
|
8907
|
-
|
|
8908
|
-
|
|
8909
|
-
|
|
8910
|
-
|
|
9475
|
+
bridge_id: {
|
|
9476
|
+
description:
|
|
9477
|
+
'Bridge ID for a Tedee device.\n ',
|
|
9478
|
+
format: 'float',
|
|
9479
|
+
type: 'number',
|
|
9480
|
+
},
|
|
9481
|
+
bridge_name: {
|
|
9482
|
+
description:
|
|
9483
|
+
'Bridge name for a Tedee device.\n ',
|
|
9484
|
+
type: 'string',
|
|
9485
|
+
},
|
|
9486
|
+
device_id: {
|
|
9487
|
+
description:
|
|
9488
|
+
'Device ID for a Tedee device.\n ',
|
|
9489
|
+
format: 'float',
|
|
9490
|
+
type: 'number',
|
|
9491
|
+
},
|
|
9492
|
+
device_model: {
|
|
9493
|
+
description:
|
|
9494
|
+
'Device model for a Tedee device.\n ',
|
|
9495
|
+
type: 'string',
|
|
9496
|
+
},
|
|
9497
|
+
device_name: {
|
|
9498
|
+
description:
|
|
9499
|
+
'Device name for a Tedee device.\n ',
|
|
9500
|
+
type: 'string',
|
|
9501
|
+
},
|
|
9502
|
+
keypad_id: {
|
|
9503
|
+
description:
|
|
9504
|
+
'Keypad ID for a Tedee device.\n ',
|
|
9505
|
+
format: 'float',
|
|
9506
|
+
type: 'number',
|
|
9507
|
+
},
|
|
9508
|
+
serial_number: {
|
|
9509
|
+
description:
|
|
9510
|
+
'Serial number for a Tedee device.\n ',
|
|
9511
|
+
type: 'string',
|
|
9512
|
+
},
|
|
8911
9513
|
},
|
|
8912
9514
|
required: [
|
|
8913
9515
|
'device_id',
|
|
@@ -8920,16 +9522,48 @@ export default {
|
|
|
8920
9522
|
type: 'object',
|
|
8921
9523
|
},
|
|
8922
9524
|
ttlock_metadata: {
|
|
9525
|
+
description:
|
|
9526
|
+
'Metadata for a TTLock device.\n ',
|
|
8923
9527
|
properties: {
|
|
8924
|
-
feature_value: {
|
|
9528
|
+
feature_value: {
|
|
9529
|
+
description:
|
|
9530
|
+
'Feature value for a TTLock device.\n ',
|
|
9531
|
+
type: 'string',
|
|
9532
|
+
},
|
|
8925
9533
|
features: {
|
|
9534
|
+
description:
|
|
9535
|
+
'Features for a TTLock device.\n ',
|
|
8926
9536
|
properties: {
|
|
8927
|
-
incomplete_keyboard_passcode: {
|
|
8928
|
-
|
|
8929
|
-
|
|
8930
|
-
|
|
8931
|
-
|
|
8932
|
-
|
|
9537
|
+
incomplete_keyboard_passcode: {
|
|
9538
|
+
description:
|
|
9539
|
+
'Indicates whether a TTLock device supports an incomplete keyboard passcode.\n ',
|
|
9540
|
+
type: 'boolean',
|
|
9541
|
+
},
|
|
9542
|
+
lock_command: {
|
|
9543
|
+
description:
|
|
9544
|
+
'Indicates whether a TTLock device supports the lock command.\n ',
|
|
9545
|
+
type: 'boolean',
|
|
9546
|
+
},
|
|
9547
|
+
passcode: {
|
|
9548
|
+
description:
|
|
9549
|
+
'Indicates whether a TTLock device supports a passcode.\n ',
|
|
9550
|
+
type: 'boolean',
|
|
9551
|
+
},
|
|
9552
|
+
passcode_management: {
|
|
9553
|
+
description:
|
|
9554
|
+
'Indicates whether a TTLock device supports passcode management.\n ',
|
|
9555
|
+
type: 'boolean',
|
|
9556
|
+
},
|
|
9557
|
+
unlock_via_gateway: {
|
|
9558
|
+
description:
|
|
9559
|
+
'Indicates whether a TTLock device supports unlock via gateway.\n ',
|
|
9560
|
+
type: 'boolean',
|
|
9561
|
+
},
|
|
9562
|
+
wifi: {
|
|
9563
|
+
description:
|
|
9564
|
+
'Indicates whether a TTLock device supports Wi-Fi.\n ',
|
|
9565
|
+
type: 'boolean',
|
|
9566
|
+
},
|
|
8933
9567
|
},
|
|
8934
9568
|
required: [
|
|
8935
9569
|
'passcode',
|
|
@@ -8941,17 +9575,38 @@ export default {
|
|
|
8941
9575
|
],
|
|
8942
9576
|
type: 'object',
|
|
8943
9577
|
},
|
|
8944
|
-
has_gateway: {
|
|
8945
|
-
|
|
8946
|
-
|
|
9578
|
+
has_gateway: {
|
|
9579
|
+
description:
|
|
9580
|
+
'Indicates whether a TTLock device has a gateway.\n ',
|
|
9581
|
+
type: 'boolean',
|
|
9582
|
+
},
|
|
9583
|
+
lock_alias: {
|
|
9584
|
+
description:
|
|
9585
|
+
'Lock alias for a TTLock device.\n ',
|
|
9586
|
+
type: 'string',
|
|
9587
|
+
},
|
|
9588
|
+
lock_id: {
|
|
9589
|
+
description:
|
|
9590
|
+
'Lock ID for a TTLock device.\n ',
|
|
9591
|
+
format: 'float',
|
|
9592
|
+
type: 'number',
|
|
9593
|
+
},
|
|
8947
9594
|
wireless_keypads: {
|
|
9595
|
+
description:
|
|
9596
|
+
'Wireless keypads for a TTLock device.\n ',
|
|
8948
9597
|
items: {
|
|
8949
9598
|
properties: {
|
|
8950
9599
|
wireless_keypad_id: {
|
|
9600
|
+
description:
|
|
9601
|
+
'ID for a wireless keypad for a TTLock device.\n ',
|
|
8951
9602
|
format: 'float',
|
|
8952
9603
|
type: 'number',
|
|
8953
9604
|
},
|
|
8954
|
-
wireless_keypad_name: {
|
|
9605
|
+
wireless_keypad_name: {
|
|
9606
|
+
description:
|
|
9607
|
+
'Name for a wireless keypad for a TTLock device.\n ',
|
|
9608
|
+
type: 'string',
|
|
9609
|
+
},
|
|
8955
9610
|
},
|
|
8956
9611
|
required: [
|
|
8957
9612
|
'wireless_keypad_id',
|
|
@@ -8971,31 +9626,80 @@ export default {
|
|
|
8971
9626
|
type: 'object',
|
|
8972
9627
|
},
|
|
8973
9628
|
two_n_metadata: {
|
|
9629
|
+
description: 'Metadata for a 2N device.\n ',
|
|
8974
9630
|
properties: {
|
|
8975
|
-
device_id: {
|
|
8976
|
-
|
|
9631
|
+
device_id: {
|
|
9632
|
+
description:
|
|
9633
|
+
'Device ID for a 2N device.\n ',
|
|
9634
|
+
format: 'float',
|
|
9635
|
+
type: 'number',
|
|
9636
|
+
},
|
|
9637
|
+
device_name: {
|
|
9638
|
+
description:
|
|
9639
|
+
'Device name for a 2N device.\n ',
|
|
9640
|
+
type: 'string',
|
|
9641
|
+
},
|
|
8977
9642
|
},
|
|
8978
9643
|
required: ['device_id', 'device_name'],
|
|
8979
9644
|
type: 'object',
|
|
8980
9645
|
},
|
|
8981
9646
|
visionline_metadata: {
|
|
8982
|
-
|
|
9647
|
+
description:
|
|
9648
|
+
'Metadata for an ASSA ABLOY Visionline system.\n ',
|
|
9649
|
+
properties: {
|
|
9650
|
+
encoder_id: {
|
|
9651
|
+
description:
|
|
9652
|
+
'Encoder ID for an ASSA ABLOY Visionline system.\n ',
|
|
9653
|
+
type: 'string',
|
|
9654
|
+
},
|
|
9655
|
+
},
|
|
8983
9656
|
required: ['encoder_id'],
|
|
8984
9657
|
type: 'object',
|
|
8985
9658
|
},
|
|
8986
9659
|
wyze_metadata: {
|
|
9660
|
+
description: 'Metadata for a Wyze device.\n ',
|
|
8987
9661
|
properties: {
|
|
8988
|
-
device_id: {
|
|
8989
|
-
|
|
8990
|
-
|
|
8991
|
-
|
|
9662
|
+
device_id: {
|
|
9663
|
+
description:
|
|
9664
|
+
'Device ID for a Wyze device.\n ',
|
|
9665
|
+
type: 'string',
|
|
9666
|
+
},
|
|
9667
|
+
device_info_model: {
|
|
9668
|
+
description:
|
|
9669
|
+
'Device information model for a Wyze device.\n ',
|
|
9670
|
+
type: 'string',
|
|
9671
|
+
},
|
|
9672
|
+
device_name: {
|
|
9673
|
+
description:
|
|
9674
|
+
'Device name for a Wyze device.\n ',
|
|
9675
|
+
type: 'string',
|
|
9676
|
+
},
|
|
9677
|
+
keypad_uuid: {
|
|
9678
|
+
description:
|
|
9679
|
+
'Keypad UUID for a Wyze device.\n ',
|
|
9680
|
+
type: 'string',
|
|
9681
|
+
},
|
|
8992
9682
|
locker_status_hardlock: {
|
|
9683
|
+
description:
|
|
9684
|
+
'Locker status (hardlock) for a Wyze device.\n ',
|
|
8993
9685
|
format: 'float',
|
|
8994
9686
|
type: 'number',
|
|
8995
9687
|
},
|
|
8996
|
-
product_model: {
|
|
8997
|
-
|
|
8998
|
-
|
|
9688
|
+
product_model: {
|
|
9689
|
+
description:
|
|
9690
|
+
'Product model for a Wyze device.\n ',
|
|
9691
|
+
type: 'string',
|
|
9692
|
+
},
|
|
9693
|
+
product_name: {
|
|
9694
|
+
description:
|
|
9695
|
+
'Product name for a Wyze device.\n ',
|
|
9696
|
+
type: 'string',
|
|
9697
|
+
},
|
|
9698
|
+
product_type: {
|
|
9699
|
+
description:
|
|
9700
|
+
'Product type for a Wyze device.\n ',
|
|
9701
|
+
type: 'string',
|
|
9702
|
+
},
|
|
8999
9703
|
},
|
|
9000
9704
|
required: [
|
|
9001
9705
|
'device_id',
|
|
@@ -9009,6 +9713,7 @@ export default {
|
|
|
9009
9713
|
},
|
|
9010
9714
|
},
|
|
9011
9715
|
type: 'object',
|
|
9716
|
+
'x-property-group-key': 'provider_metadata',
|
|
9012
9717
|
},
|
|
9013
9718
|
],
|
|
9014
9719
|
},
|
|
@@ -9019,15 +9724,20 @@ export default {
|
|
|
9019
9724
|
_experimental_supported_code_from_access_codes_lengths: {
|
|
9020
9725
|
items: { format: 'float', type: 'number' },
|
|
9021
9726
|
type: 'array',
|
|
9727
|
+
'x-undocumented': 'Marked as experimental.',
|
|
9022
9728
|
},
|
|
9023
9729
|
code_constraints: {
|
|
9024
9730
|
description:
|
|
9025
9731
|
'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.',
|
|
9026
9732
|
items: {
|
|
9733
|
+
description: 'Access code constraint.',
|
|
9027
9734
|
oneOf: [
|
|
9028
9735
|
{
|
|
9736
|
+
description: 'Code constraint for access codes.',
|
|
9029
9737
|
properties: {
|
|
9030
9738
|
constraint_type: {
|
|
9739
|
+
description:
|
|
9740
|
+
'Code constraint type for access codes.',
|
|
9031
9741
|
enum: [
|
|
9032
9742
|
'no_zeros',
|
|
9033
9743
|
'cannot_start_with_12',
|
|
@@ -9047,13 +9757,24 @@ export default {
|
|
|
9047
9757
|
type: 'object',
|
|
9048
9758
|
},
|
|
9049
9759
|
{
|
|
9760
|
+
description: 'Name constraint for access codes.',
|
|
9050
9761
|
properties: {
|
|
9051
9762
|
constraint_type: {
|
|
9052
9763
|
enum: ['name_length', 'name_must_be_unique'],
|
|
9053
9764
|
type: 'string',
|
|
9054
9765
|
},
|
|
9055
|
-
max_length: {
|
|
9056
|
-
|
|
9766
|
+
max_length: {
|
|
9767
|
+
description:
|
|
9768
|
+
'Maximum name length constraint for access codes.',
|
|
9769
|
+
format: 'float',
|
|
9770
|
+
type: 'number',
|
|
9771
|
+
},
|
|
9772
|
+
min_length: {
|
|
9773
|
+
description:
|
|
9774
|
+
'Minimum name length constraint for access codes.',
|
|
9775
|
+
format: 'float',
|
|
9776
|
+
type: 'number',
|
|
9777
|
+
},
|
|
9057
9778
|
},
|
|
9058
9779
|
required: ['constraint_type'],
|
|
9059
9780
|
type: 'object',
|
|
@@ -9061,26 +9782,57 @@ export default {
|
|
|
9061
9782
|
],
|
|
9062
9783
|
},
|
|
9063
9784
|
type: 'array',
|
|
9785
|
+
'x-property-group-key': 'access_codes',
|
|
9786
|
+
},
|
|
9787
|
+
door_open: {
|
|
9788
|
+
description: 'Indicates whether the door is open.',
|
|
9789
|
+
type: 'boolean',
|
|
9790
|
+
'x-property-group-key': 'locks',
|
|
9791
|
+
},
|
|
9792
|
+
has_native_entry_events: {
|
|
9793
|
+
description:
|
|
9794
|
+
'Indicates whether the device supports native entry events.',
|
|
9795
|
+
type: 'boolean',
|
|
9796
|
+
'x-property-group-key': 'access_codes',
|
|
9064
9797
|
},
|
|
9065
|
-
door_open: { type: 'boolean' },
|
|
9066
|
-
has_native_entry_events: { type: 'boolean' },
|
|
9067
9798
|
keypad_battery: {
|
|
9799
|
+
description: 'Keypad battery status.',
|
|
9068
9800
|
properties: {
|
|
9069
|
-
level: {
|
|
9801
|
+
level: {
|
|
9802
|
+
description:
|
|
9803
|
+
'Keypad battery charge level.\n ',
|
|
9804
|
+
format: 'float',
|
|
9805
|
+
type: 'number',
|
|
9806
|
+
},
|
|
9070
9807
|
},
|
|
9071
9808
|
required: ['level'],
|
|
9072
9809
|
type: 'object',
|
|
9810
|
+
'x-property-group-key': 'access_codes',
|
|
9811
|
+
},
|
|
9812
|
+
locked: {
|
|
9813
|
+
description: 'Indicates whether the lock is locked.',
|
|
9814
|
+
type: 'boolean',
|
|
9815
|
+
'x-property-group-key': 'locks',
|
|
9073
9816
|
},
|
|
9074
|
-
locked: { type: 'boolean' },
|
|
9075
9817
|
max_active_codes_supported: {
|
|
9818
|
+
description:
|
|
9819
|
+
'Maximum number of active access codes that the device supports.',
|
|
9076
9820
|
format: 'float',
|
|
9077
9821
|
type: 'number',
|
|
9822
|
+
'x-property-group-key': 'access_codes',
|
|
9078
9823
|
},
|
|
9079
9824
|
supported_code_lengths: {
|
|
9825
|
+
description: 'Supported code lengths for access codes.',
|
|
9080
9826
|
items: { format: 'float', type: 'number' },
|
|
9081
9827
|
type: 'array',
|
|
9828
|
+
'x-property-group-key': 'access_codes',
|
|
9829
|
+
},
|
|
9830
|
+
supports_backup_access_code_pool: {
|
|
9831
|
+
description:
|
|
9832
|
+
'Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).',
|
|
9833
|
+
type: 'boolean',
|
|
9834
|
+
'x-property-group-key': 'access_codes',
|
|
9082
9835
|
},
|
|
9083
|
-
supports_backup_access_code_pool: { type: 'boolean' },
|
|
9084
9836
|
},
|
|
9085
9837
|
type: 'object',
|
|
9086
9838
|
},
|
|
@@ -9089,7 +9841,7 @@ export default {
|
|
|
9089
9841
|
active_thermostat_schedule: {
|
|
9090
9842
|
default: null,
|
|
9091
9843
|
description:
|
|
9092
|
-
'
|
|
9844
|
+
'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
9093
9845
|
nullable: true,
|
|
9094
9846
|
properties: {
|
|
9095
9847
|
climate_preset_key: {
|
|
@@ -9186,9 +9938,12 @@ export default {
|
|
|
9186
9938
|
'errors',
|
|
9187
9939
|
],
|
|
9188
9940
|
type: 'object',
|
|
9941
|
+
'x-property-group-key': 'thermostats',
|
|
9189
9942
|
'x-route-path': '/thermostats/schedules',
|
|
9190
9943
|
},
|
|
9191
9944
|
available_climate_presets: {
|
|
9945
|
+
description:
|
|
9946
|
+
'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
|
|
9192
9947
|
items: {
|
|
9193
9948
|
properties: {
|
|
9194
9949
|
can_delete: {
|
|
@@ -9279,22 +10034,30 @@ export default {
|
|
|
9279
10034
|
type: 'object',
|
|
9280
10035
|
},
|
|
9281
10036
|
type: 'array',
|
|
10037
|
+
'x-property-group-key': 'thermostats',
|
|
9282
10038
|
},
|
|
9283
10039
|
available_fan_mode_settings: {
|
|
10040
|
+
description:
|
|
10041
|
+
'Fan mode settings that the thermostat supports.',
|
|
9284
10042
|
items: {
|
|
9285
10043
|
enum: ['auto', 'on', 'circulate'],
|
|
9286
10044
|
type: 'string',
|
|
9287
10045
|
},
|
|
9288
10046
|
type: 'array',
|
|
10047
|
+
'x-property-group-key': 'thermostats',
|
|
9289
10048
|
},
|
|
9290
10049
|
available_hvac_mode_settings: {
|
|
10050
|
+
description:
|
|
10051
|
+
'HVAC mode settings that the thermostat supports.',
|
|
9291
10052
|
items: {
|
|
9292
10053
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
9293
10054
|
type: 'string',
|
|
9294
10055
|
},
|
|
9295
10056
|
type: 'array',
|
|
10057
|
+
'x-property-group-key': 'thermostats',
|
|
9296
10058
|
},
|
|
9297
10059
|
current_climate_setting: {
|
|
10060
|
+
description: 'Current climate setting.',
|
|
9298
10061
|
properties: {
|
|
9299
10062
|
can_delete: {
|
|
9300
10063
|
description:
|
|
@@ -9374,6 +10137,7 @@ export default {
|
|
|
9374
10137
|
},
|
|
9375
10138
|
},
|
|
9376
10139
|
type: 'object',
|
|
10140
|
+
'x-property-group-key': 'thermostats',
|
|
9377
10141
|
},
|
|
9378
10142
|
default_climate_setting: {
|
|
9379
10143
|
deprecated: true,
|
|
@@ -9458,93 +10222,168 @@ export default {
|
|
|
9458
10222
|
type: 'object',
|
|
9459
10223
|
'x-deprecated':
|
|
9460
10224
|
'use fallback_climate_preset_key to specify a fallback climate preset instead.',
|
|
10225
|
+
'x-property-group-key': 'thermostats',
|
|
9461
10226
|
},
|
|
9462
10227
|
fallback_climate_preset_key: {
|
|
9463
10228
|
default: null,
|
|
10229
|
+
description:
|
|
10230
|
+
'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.',
|
|
9464
10231
|
minLength: 1,
|
|
9465
10232
|
nullable: true,
|
|
9466
10233
|
type: 'string',
|
|
10234
|
+
'x-property-group-key': 'thermostats',
|
|
9467
10235
|
},
|
|
9468
10236
|
fan_mode_setting: {
|
|
9469
10237
|
deprecated: true,
|
|
9470
10238
|
enum: ['auto', 'on', 'circulate'],
|
|
9471
10239
|
type: 'string',
|
|
9472
10240
|
'x-deprecated':
|
|
9473
|
-
'
|
|
10241
|
+
'Use `current_climate_setting.fan_mode_setting` instead.',
|
|
10242
|
+
'x-property-group-key': 'thermostats',
|
|
10243
|
+
},
|
|
10244
|
+
is_cooling: {
|
|
10245
|
+
description:
|
|
10246
|
+
'Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.',
|
|
10247
|
+
type: 'boolean',
|
|
10248
|
+
'x-property-group-key': 'thermostats',
|
|
10249
|
+
},
|
|
10250
|
+
is_fan_running: {
|
|
10251
|
+
description:
|
|
10252
|
+
'Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.',
|
|
10253
|
+
type: 'boolean',
|
|
10254
|
+
'x-property-group-key': 'thermostats',
|
|
10255
|
+
},
|
|
10256
|
+
is_heating: {
|
|
10257
|
+
description:
|
|
10258
|
+
'Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.',
|
|
10259
|
+
type: 'boolean',
|
|
10260
|
+
'x-property-group-key': 'thermostats',
|
|
10261
|
+
},
|
|
10262
|
+
is_temporary_manual_override_active: {
|
|
10263
|
+
description:
|
|
10264
|
+
'Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.',
|
|
10265
|
+
type: 'boolean',
|
|
10266
|
+
'x-property-group-key': 'thermostats',
|
|
9474
10267
|
},
|
|
9475
|
-
is_cooling: { type: 'boolean' },
|
|
9476
|
-
is_fan_running: { type: 'boolean' },
|
|
9477
|
-
is_heating: { type: 'boolean' },
|
|
9478
|
-
is_temporary_manual_override_active: { type: 'boolean' },
|
|
9479
10268
|
max_cooling_set_point_celsius: {
|
|
10269
|
+
description:
|
|
10270
|
+
'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.',
|
|
9480
10271
|
format: 'float',
|
|
9481
10272
|
type: 'number',
|
|
10273
|
+
'x-property-group-key': 'thermostats',
|
|
9482
10274
|
},
|
|
9483
10275
|
max_cooling_set_point_fahrenheit: {
|
|
10276
|
+
description:
|
|
10277
|
+
'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.',
|
|
9484
10278
|
format: 'float',
|
|
9485
10279
|
type: 'number',
|
|
10280
|
+
'x-property-group-key': 'thermostats',
|
|
9486
10281
|
},
|
|
9487
10282
|
max_heating_set_point_celsius: {
|
|
10283
|
+
description:
|
|
10284
|
+
'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.',
|
|
9488
10285
|
format: 'float',
|
|
9489
10286
|
type: 'number',
|
|
10287
|
+
'x-property-group-key': 'thermostats',
|
|
9490
10288
|
},
|
|
9491
10289
|
max_heating_set_point_fahrenheit: {
|
|
10290
|
+
description:
|
|
10291
|
+
'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.',
|
|
9492
10292
|
format: 'float',
|
|
9493
10293
|
type: 'number',
|
|
10294
|
+
'x-property-group-key': 'thermostats',
|
|
9494
10295
|
},
|
|
9495
10296
|
min_cooling_set_point_celsius: {
|
|
10297
|
+
description:
|
|
10298
|
+
'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.',
|
|
9496
10299
|
format: 'float',
|
|
9497
10300
|
type: 'number',
|
|
10301
|
+
'x-property-group-key': 'thermostats',
|
|
9498
10302
|
},
|
|
9499
10303
|
min_cooling_set_point_fahrenheit: {
|
|
10304
|
+
description:
|
|
10305
|
+
'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.',
|
|
9500
10306
|
format: 'float',
|
|
9501
10307
|
type: 'number',
|
|
10308
|
+
'x-property-group-key': 'thermostats',
|
|
9502
10309
|
},
|
|
9503
10310
|
min_heating_cooling_delta_celsius: {
|
|
10311
|
+
description:
|
|
10312
|
+
'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.',
|
|
9504
10313
|
format: 'float',
|
|
9505
10314
|
type: 'number',
|
|
10315
|
+
'x-property-group-key': 'thermostats',
|
|
9506
10316
|
},
|
|
9507
10317
|
min_heating_cooling_delta_fahrenheit: {
|
|
10318
|
+
description:
|
|
10319
|
+
'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.',
|
|
9508
10320
|
format: 'float',
|
|
9509
10321
|
type: 'number',
|
|
10322
|
+
'x-property-group-key': 'thermostats',
|
|
9510
10323
|
},
|
|
9511
10324
|
min_heating_set_point_celsius: {
|
|
10325
|
+
description:
|
|
10326
|
+
'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.',
|
|
9512
10327
|
format: 'float',
|
|
9513
10328
|
type: 'number',
|
|
10329
|
+
'x-property-group-key': 'thermostats',
|
|
9514
10330
|
},
|
|
9515
10331
|
min_heating_set_point_fahrenheit: {
|
|
10332
|
+
description:
|
|
10333
|
+
'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.',
|
|
9516
10334
|
format: 'float',
|
|
9517
10335
|
type: 'number',
|
|
10336
|
+
'x-property-group-key': 'thermostats',
|
|
9518
10337
|
},
|
|
9519
10338
|
relative_humidity: {
|
|
10339
|
+
description:
|
|
10340
|
+
'Reported relative humidity, as a value between 0 and 1, inclusive.',
|
|
9520
10341
|
format: 'float',
|
|
9521
10342
|
maximum: 1,
|
|
9522
10343
|
minimum: 0,
|
|
9523
10344
|
type: 'number',
|
|
10345
|
+
'x-property-group-key': 'thermostats',
|
|
10346
|
+
},
|
|
10347
|
+
temperature_celsius: {
|
|
10348
|
+
description: 'Reported temperature in °C.',
|
|
10349
|
+
format: 'float',
|
|
10350
|
+
type: 'number',
|
|
10351
|
+
'x-property-group-key': 'thermostats',
|
|
9524
10352
|
},
|
|
9525
|
-
temperature_celsius: { format: 'float', type: 'number' },
|
|
9526
10353
|
temperature_fahrenheit: {
|
|
10354
|
+
description: 'Reported temperature in °F.',
|
|
9527
10355
|
format: 'float',
|
|
9528
10356
|
type: 'number',
|
|
10357
|
+
'x-property-group-key': 'thermostats',
|
|
9529
10358
|
},
|
|
9530
10359
|
temperature_threshold: {
|
|
10360
|
+
description:
|
|
10361
|
+
'Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.',
|
|
9531
10362
|
properties: {
|
|
9532
10363
|
lower_limit_celsius: {
|
|
10364
|
+
description:
|
|
10365
|
+
'Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
|
|
9533
10366
|
format: 'float',
|
|
9534
10367
|
nullable: true,
|
|
9535
10368
|
type: 'number',
|
|
9536
10369
|
},
|
|
9537
10370
|
lower_limit_fahrenheit: {
|
|
10371
|
+
description:
|
|
10372
|
+
'Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
|
|
9538
10373
|
format: 'float',
|
|
9539
10374
|
nullable: true,
|
|
9540
10375
|
type: 'number',
|
|
9541
10376
|
},
|
|
9542
10377
|
upper_limit_celsius: {
|
|
10378
|
+
description:
|
|
10379
|
+
'Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
|
|
9543
10380
|
format: 'float',
|
|
9544
10381
|
nullable: true,
|
|
9545
10382
|
type: 'number',
|
|
9546
10383
|
},
|
|
9547
10384
|
upper_limit_fahrenheit: {
|
|
10385
|
+
description:
|
|
10386
|
+
'Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
|
|
9548
10387
|
format: 'float',
|
|
9549
10388
|
nullable: true,
|
|
9550
10389
|
type: 'number',
|
|
@@ -9557,8 +10396,11 @@ export default {
|
|
|
9557
10396
|
'upper_limit_fahrenheit',
|
|
9558
10397
|
],
|
|
9559
10398
|
type: 'object',
|
|
10399
|
+
'x-property-group-key': 'thermostats',
|
|
9560
10400
|
},
|
|
9561
10401
|
thermostat_daily_programs: {
|
|
10402
|
+
description:
|
|
10403
|
+
'Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.',
|
|
9562
10404
|
items: {
|
|
9563
10405
|
description:
|
|
9564
10406
|
'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
|
|
@@ -9635,8 +10477,11 @@ export default {
|
|
|
9635
10477
|
'/thermostats/thermostat_daily_programs',
|
|
9636
10478
|
},
|
|
9637
10479
|
type: 'array',
|
|
10480
|
+
'x-property-group-key': 'thermostats',
|
|
9638
10481
|
},
|
|
9639
10482
|
thermostat_weekly_program: {
|
|
10483
|
+
description:
|
|
10484
|
+
'Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.',
|
|
9640
10485
|
nullable: true,
|
|
9641
10486
|
properties: {
|
|
9642
10487
|
created_at: {
|
|
@@ -9706,6 +10551,7 @@ export default {
|
|
|
9706
10551
|
'created_at',
|
|
9707
10552
|
],
|
|
9708
10553
|
type: 'object',
|
|
10554
|
+
'x-property-group-key': 'thermostats',
|
|
9709
10555
|
},
|
|
9710
10556
|
},
|
|
9711
10557
|
type: 'object',
|
|
@@ -9714,6 +10560,15 @@ export default {
|
|
|
9714
10560
|
},
|
|
9715
10561
|
],
|
|
9716
10562
|
description: 'Properties of the device.',
|
|
10563
|
+
'x-property-groups': {
|
|
10564
|
+
access_codes: { name: 'Access Codes' },
|
|
10565
|
+
hardware: { name: 'Hardware' },
|
|
10566
|
+
locks: { name: 'Locks' },
|
|
10567
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
10568
|
+
phones: { name: 'Phones' },
|
|
10569
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
10570
|
+
thermostats: { name: 'Thermostats' },
|
|
10571
|
+
},
|
|
9717
10572
|
},
|
|
9718
10573
|
warnings: {
|
|
9719
10574
|
description:
|
|
@@ -10009,6 +10864,15 @@ export default {
|
|
|
10009
10864
|
'custom_metadata',
|
|
10010
10865
|
],
|
|
10011
10866
|
type: 'object',
|
|
10867
|
+
'x-property-groups': {
|
|
10868
|
+
access_codes: { name: 'Access Codes' },
|
|
10869
|
+
hardware: { name: 'Hardware' },
|
|
10870
|
+
locks: { name: 'Locks' },
|
|
10871
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
10872
|
+
phones: { name: 'Phones' },
|
|
10873
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
10874
|
+
thermostats: { name: 'Thermostats' },
|
|
10875
|
+
},
|
|
10012
10876
|
'x-route-path': '/devices',
|
|
10013
10877
|
},
|
|
10014
10878
|
device_provider: {
|
|
@@ -15220,7 +16084,7 @@ export default {
|
|
|
15220
16084
|
description: "Represents an app user's mobile phone.",
|
|
15221
16085
|
properties: {
|
|
15222
16086
|
created_at: {
|
|
15223
|
-
description: 'Date and time at which the
|
|
16087
|
+
description: 'Date and time at which the phone was created.\n ',
|
|
15224
16088
|
format: 'date-time',
|
|
15225
16089
|
type: 'string',
|
|
15226
16090
|
},
|
|
@@ -15229,26 +16093,26 @@ export default {
|
|
|
15229
16093
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15230
16094
|
},
|
|
15231
16095
|
description:
|
|
15232
|
-
'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone
|
|
16096
|
+
'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.\n ',
|
|
15233
16097
|
type: 'object',
|
|
15234
16098
|
},
|
|
15235
16099
|
device_id: {
|
|
15236
|
-
description: 'ID of the
|
|
16100
|
+
description: 'ID of the phone.\n ',
|
|
15237
16101
|
format: 'uuid',
|
|
15238
16102
|
type: 'string',
|
|
15239
16103
|
},
|
|
15240
16104
|
device_type: {
|
|
15241
|
-
description: '
|
|
16105
|
+
description: 'Device type for phones.\n ',
|
|
15242
16106
|
enum: ['ios_phone', 'android_phone'],
|
|
15243
16107
|
type: 'string',
|
|
15244
16108
|
},
|
|
15245
16109
|
display_name: {
|
|
15246
16110
|
description:
|
|
15247
|
-
'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
|
|
16111
|
+
'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.\n ',
|
|
15248
16112
|
type: 'string',
|
|
15249
16113
|
},
|
|
15250
16114
|
errors: {
|
|
15251
|
-
description: 'Errors associated with the
|
|
16115
|
+
description: 'Errors associated with the phone.',
|
|
15252
16116
|
items: {
|
|
15253
16117
|
properties: {
|
|
15254
16118
|
error_code: { type: 'string' },
|
|
@@ -15261,11 +16125,11 @@ export default {
|
|
|
15261
16125
|
},
|
|
15262
16126
|
nickname: {
|
|
15263
16127
|
description:
|
|
15264
|
-
'Optional nickname to describe the phone, settable through Seam
|
|
16128
|
+
'Optional nickname to describe the phone, settable through Seam.\n ',
|
|
15265
16129
|
type: 'string',
|
|
15266
16130
|
},
|
|
15267
16131
|
properties: {
|
|
15268
|
-
description: 'Properties of the phone
|
|
16132
|
+
description: '\n Properties of the phone.\n ',
|
|
15269
16133
|
properties: {
|
|
15270
16134
|
assa_abloy_credential_service_metadata: {
|
|
15271
16135
|
description:
|
|
@@ -15316,7 +16180,7 @@ export default {
|
|
|
15316
16180
|
type: 'object',
|
|
15317
16181
|
},
|
|
15318
16182
|
warnings: {
|
|
15319
|
-
description: 'Warnings associated with the
|
|
16183
|
+
description: 'Warnings associated with the phone.',
|
|
15320
16184
|
items: {
|
|
15321
16185
|
properties: {
|
|
15322
16186
|
message: { type: 'string' },
|
|
@@ -15329,7 +16193,7 @@ export default {
|
|
|
15329
16193
|
},
|
|
15330
16194
|
workspace_id: {
|
|
15331
16195
|
description:
|
|
15332
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
16196
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone.\n ',
|
|
15333
16197
|
format: 'uuid',
|
|
15334
16198
|
type: 'string',
|
|
15335
16199
|
},
|
|
@@ -15346,6 +16210,7 @@ export default {
|
|
|
15346
16210
|
'properties',
|
|
15347
16211
|
],
|
|
15348
16212
|
type: 'object',
|
|
16213
|
+
'x-property-groups': { phones: { name: 'Phones' } },
|
|
15349
16214
|
'x-route-path': '/phones',
|
|
15350
16215
|
},
|
|
15351
16216
|
phone_registration: {
|
|
@@ -18731,8 +19596,10 @@ export default {
|
|
|
18731
19596
|
can_turn_off_hvac: { type: 'boolean' },
|
|
18732
19597
|
capabilities_supported: {
|
|
18733
19598
|
description:
|
|
18734
|
-
'Collection of capabilities that the device supports when connected to Seam. Values are
|
|
19599
|
+
'\n 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
18735
19600
|
items: {
|
|
19601
|
+
description:
|
|
19602
|
+
'\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
|
|
18736
19603
|
enum: [
|
|
18737
19604
|
'access_code',
|
|
18738
19605
|
'lock',
|
|
@@ -18766,6 +19633,7 @@ export default {
|
|
|
18766
19633
|
description: 'Type of the device.',
|
|
18767
19634
|
oneOf: [
|
|
18768
19635
|
{
|
|
19636
|
+
description: 'Device type for smartlocks.\n ',
|
|
18769
19637
|
enum: [
|
|
18770
19638
|
'akuvox_lock',
|
|
18771
19639
|
'august_lock',
|
|
@@ -18798,10 +19666,12 @@ export default {
|
|
|
18798
19666
|
type: 'string',
|
|
18799
19667
|
},
|
|
18800
19668
|
{
|
|
19669
|
+
description: 'Device type for noise sensors.\n ',
|
|
18801
19670
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
18802
19671
|
type: 'string',
|
|
18803
19672
|
},
|
|
18804
19673
|
{
|
|
19674
|
+
description: 'Device type for thermostats.\n ',
|
|
18805
19675
|
enum: [
|
|
18806
19676
|
'ecobee_thermostat',
|
|
18807
19677
|
'nest_thermostat',
|
|
@@ -18813,7 +19683,7 @@ export default {
|
|
|
18813
19683
|
type: 'string',
|
|
18814
19684
|
},
|
|
18815
19685
|
{
|
|
18816
|
-
description: '
|
|
19686
|
+
description: 'Device type for phones.\n ',
|
|
18817
19687
|
enum: ['ios_phone', 'android_phone'],
|
|
18818
19688
|
type: 'string',
|
|
18819
19689
|
},
|
|
@@ -19187,23 +20057,25 @@ export default {
|
|
|
19187
20057
|
nullable: true,
|
|
19188
20058
|
properties: {
|
|
19189
20059
|
location_name: {
|
|
19190
|
-
description: 'Name of the device location
|
|
20060
|
+
description: 'Name of the device location.\n ',
|
|
19191
20061
|
type: 'string',
|
|
19192
20062
|
},
|
|
19193
20063
|
timezone: {
|
|
19194
|
-
description: 'Time zone of the device location
|
|
20064
|
+
description: 'Time zone of the device location.\n ',
|
|
19195
20065
|
type: 'string',
|
|
19196
20066
|
},
|
|
19197
20067
|
},
|
|
19198
20068
|
type: 'object',
|
|
20069
|
+
'x-property-group-key': 'hardware',
|
|
19199
20070
|
},
|
|
19200
20071
|
properties: {
|
|
20072
|
+
description: 'properties of the device.',
|
|
19201
20073
|
properties: {
|
|
19202
20074
|
accessory_keypad: {
|
|
19203
|
-
description: '
|
|
20075
|
+
description: 'Accessory keypad properties and state.',
|
|
19204
20076
|
properties: {
|
|
19205
20077
|
battery: {
|
|
19206
|
-
description: '
|
|
20078
|
+
description: 'Keypad battery properties.\n ',
|
|
19207
20079
|
properties: {
|
|
19208
20080
|
level: {
|
|
19209
20081
|
format: 'float',
|
|
@@ -19217,30 +20089,36 @@ export default {
|
|
|
19217
20089
|
},
|
|
19218
20090
|
is_connected: {
|
|
19219
20091
|
description:
|
|
19220
|
-
'Indicates if
|
|
20092
|
+
'Indicates if an accessory keypad is connected to the device.\n ',
|
|
19221
20093
|
type: 'boolean',
|
|
19222
20094
|
},
|
|
19223
20095
|
},
|
|
19224
20096
|
required: ['is_connected'],
|
|
19225
20097
|
type: 'object',
|
|
20098
|
+
'x-property-group-key': 'hardware',
|
|
19226
20099
|
},
|
|
19227
20100
|
battery: {
|
|
19228
20101
|
description:
|
|
19229
|
-
'Represents the current status of the battery charge level.
|
|
20102
|
+
'Represents the current status of the battery charge level.',
|
|
19230
20103
|
properties: {
|
|
19231
20104
|
level: {
|
|
20105
|
+
description:
|
|
20106
|
+
'Battery charge level as a value between 0 and 1, inclusive.\n ',
|
|
19232
20107
|
format: 'float',
|
|
19233
20108
|
maximum: 1,
|
|
19234
20109
|
minimum: 0,
|
|
19235
20110
|
type: 'number',
|
|
19236
20111
|
},
|
|
19237
20112
|
status: {
|
|
20113
|
+
description:
|
|
20114
|
+
'Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ',
|
|
19238
20115
|
enum: ['critical', 'low', 'good', 'full'],
|
|
19239
20116
|
type: 'string',
|
|
19240
20117
|
},
|
|
19241
20118
|
},
|
|
19242
20119
|
required: ['level', 'status'],
|
|
19243
20120
|
type: 'object',
|
|
20121
|
+
'x-property-group-key': 'hardware',
|
|
19244
20122
|
},
|
|
19245
20123
|
battery_level: {
|
|
19246
20124
|
description:
|
|
@@ -19249,22 +20127,27 @@ export default {
|
|
|
19249
20127
|
maximum: 1,
|
|
19250
20128
|
minimum: 0,
|
|
19251
20129
|
type: 'number',
|
|
20130
|
+
'x-property-group-key': 'hardware',
|
|
19252
20131
|
},
|
|
19253
20132
|
image_alt_text: {
|
|
19254
20133
|
description: 'Alt text for the device image.',
|
|
19255
20134
|
type: 'string',
|
|
20135
|
+
'x-property-group-key': 'hardware',
|
|
19256
20136
|
},
|
|
19257
20137
|
image_url: {
|
|
19258
20138
|
description: 'Image URL for the device.',
|
|
19259
20139
|
format: 'uri',
|
|
19260
20140
|
type: 'string',
|
|
20141
|
+
'x-property-group-key': 'hardware',
|
|
19261
20142
|
},
|
|
19262
20143
|
manufacturer: {
|
|
19263
20144
|
description:
|
|
19264
20145
|
'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
|
|
19265
20146
|
type: 'string',
|
|
20147
|
+
'x-property-group-key': 'hardware',
|
|
19266
20148
|
},
|
|
19267
20149
|
model: {
|
|
20150
|
+
description: 'Device model-related properties.',
|
|
19268
20151
|
properties: {
|
|
19269
20152
|
accessory_keypad_supported: {
|
|
19270
20153
|
deprecated: true,
|
|
@@ -19274,32 +20157,35 @@ export default {
|
|
|
19274
20157
|
},
|
|
19275
20158
|
can_connect_accessory_keypad: {
|
|
19276
20159
|
description:
|
|
19277
|
-
'Indicates whether the device can connect a accessory keypad
|
|
20160
|
+
'\n Indicates whether the device can connect a accessory keypad.\n ',
|
|
19278
20161
|
type: 'boolean',
|
|
19279
20162
|
},
|
|
19280
20163
|
display_name: {
|
|
19281
|
-
description:
|
|
20164
|
+
description:
|
|
20165
|
+
'\n Display name of the device model.\n ',
|
|
19282
20166
|
type: 'string',
|
|
19283
20167
|
},
|
|
19284
20168
|
has_built_in_keypad: {
|
|
19285
20169
|
description:
|
|
19286
|
-
'Indicates whether the device has a built in accessory keypad
|
|
20170
|
+
'\n Indicates whether the device has a built in accessory keypad.\n ',
|
|
19287
20171
|
type: 'boolean',
|
|
19288
20172
|
},
|
|
19289
20173
|
manufacturer_display_name: {
|
|
19290
20174
|
description:
|
|
19291
|
-
'Display name that corresponds to the manufacturer-specific terminology for the device
|
|
20175
|
+
'\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ',
|
|
19292
20176
|
type: 'string',
|
|
19293
20177
|
},
|
|
19294
20178
|
offline_access_codes_supported: {
|
|
19295
|
-
|
|
19296
|
-
'Indicates whether the device supports offline access codes.',
|
|
20179
|
+
deprecated: true,
|
|
19297
20180
|
type: 'boolean',
|
|
20181
|
+
'x-deprecated':
|
|
20182
|
+
'use device.can_program_offline_access_codes.',
|
|
19298
20183
|
},
|
|
19299
20184
|
online_access_codes_supported: {
|
|
19300
|
-
|
|
19301
|
-
'Indicates whether the device supports online access codes.',
|
|
20185
|
+
deprecated: true,
|
|
19302
20186
|
type: 'boolean',
|
|
20187
|
+
'x-deprecated':
|
|
20188
|
+
'use device.can_program_online_access_codes.',
|
|
19303
20189
|
},
|
|
19304
20190
|
},
|
|
19305
20191
|
required: ['display_name', 'manufacturer_display_name'],
|
|
@@ -19315,6 +20201,7 @@ export default {
|
|
|
19315
20201
|
description:
|
|
19316
20202
|
'Indicates whether it is currently possible to use offline access codes for the device.',
|
|
19317
20203
|
type: 'boolean',
|
|
20204
|
+
'x-property-group-key': 'access_codes',
|
|
19318
20205
|
},
|
|
19319
20206
|
online: {
|
|
19320
20207
|
description: 'Indicates whether the device is online.',
|
|
@@ -19324,10 +20211,20 @@ export default {
|
|
|
19324
20211
|
description:
|
|
19325
20212
|
'Indicates whether it is currently possible to use online access codes for the device.',
|
|
19326
20213
|
type: 'boolean',
|
|
20214
|
+
'x-property-group-key': 'access_codes',
|
|
19327
20215
|
},
|
|
19328
20216
|
},
|
|
19329
20217
|
required: ['name', 'online', 'model'],
|
|
19330
20218
|
type: 'object',
|
|
20219
|
+
'x-property-groups': {
|
|
20220
|
+
access_codes: { name: 'access codes' },
|
|
20221
|
+
hardware: { name: 'hardware' },
|
|
20222
|
+
locks: { name: 'locks' },
|
|
20223
|
+
noise_sensors: { name: 'noise sensors' },
|
|
20224
|
+
phones: { name: 'phones' },
|
|
20225
|
+
provider_metadata: { name: 'provider metadata' },
|
|
20226
|
+
thermostats: { name: 'thermostats' },
|
|
20227
|
+
},
|
|
19331
20228
|
},
|
|
19332
20229
|
warnings: {
|
|
19333
20230
|
description:
|
|
@@ -19621,6 +20518,15 @@ export default {
|
|
|
19621
20518
|
'properties',
|
|
19622
20519
|
],
|
|
19623
20520
|
type: 'object',
|
|
20521
|
+
'x-property-groups': {
|
|
20522
|
+
access_codes: { name: 'Access Codes' },
|
|
20523
|
+
hardware: { name: 'Hardware' },
|
|
20524
|
+
locks: { name: 'Locks' },
|
|
20525
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
20526
|
+
phones: { name: 'Phones' },
|
|
20527
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
20528
|
+
thermostats: { name: 'Thermostats' },
|
|
20529
|
+
},
|
|
19624
20530
|
'x-route-path': '/devices/unmanaged',
|
|
19625
20531
|
},
|
|
19626
20532
|
user_identity: {
|
|
@@ -19769,6 +20675,11 @@ export default {
|
|
|
19769
20675
|
scheme: 'bearer',
|
|
19770
20676
|
type: 'http',
|
|
19771
20677
|
},
|
|
20678
|
+
customer_client_session: {
|
|
20679
|
+
bearerFormat: 'Customer Client Session Token',
|
|
20680
|
+
scheme: 'bearer',
|
|
20681
|
+
type: 'http',
|
|
20682
|
+
},
|
|
19772
20683
|
pat_with_workspace: {
|
|
19773
20684
|
bearerFormat: 'API Token',
|
|
19774
20685
|
scheme: 'bearer',
|
|
@@ -26122,6 +27033,8 @@ export default {
|
|
|
26122
27033
|
items: { type: 'string' },
|
|
26123
27034
|
type: 'array',
|
|
26124
27035
|
},
|
|
27036
|
+
customer_id: { type: 'string' },
|
|
27037
|
+
customer_key: { type: 'string' },
|
|
26125
27038
|
expires_at: {
|
|
26126
27039
|
description:
|
|
26127
27040
|
'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -26202,6 +27115,8 @@ export default {
|
|
|
26202
27115
|
items: { type: 'string' },
|
|
26203
27116
|
type: 'array',
|
|
26204
27117
|
},
|
|
27118
|
+
customer_id: { type: 'string' },
|
|
27119
|
+
customer_key: { type: 'string' },
|
|
26205
27120
|
expires_at: {
|
|
26206
27121
|
description:
|
|
26207
27122
|
'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -26836,6 +27751,7 @@ export default {
|
|
|
26836
27751
|
'URL that you want to redirect the user to after the provider login is complete.',
|
|
26837
27752
|
type: 'string',
|
|
26838
27753
|
},
|
|
27754
|
+
customer_id: { format: 'uuid', type: 'string' },
|
|
26839
27755
|
device_selection_mode: {
|
|
26840
27756
|
enum: ['none', 'single', 'multiple'],
|
|
26841
27757
|
type: 'string',
|
|
@@ -26889,6 +27805,7 @@ export default {
|
|
|
26889
27805
|
},
|
|
26890
27806
|
security: [
|
|
26891
27807
|
{ client_session: [] },
|
|
27808
|
+
{ customer_client_session: [] },
|
|
26892
27809
|
{ pat_with_workspace: [] },
|
|
26893
27810
|
{ console_session_with_workspace: [] },
|
|
26894
27811
|
{ api_key: [] },
|
|
@@ -27031,6 +27948,7 @@ export default {
|
|
|
27031
27948
|
'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
|
|
27032
27949
|
type: 'object',
|
|
27033
27950
|
},
|
|
27951
|
+
customer_id: { type: 'string' },
|
|
27034
27952
|
limit: {
|
|
27035
27953
|
default: 500,
|
|
27036
27954
|
description:
|
|
@@ -27073,6 +27991,7 @@ export default {
|
|
|
27073
27991
|
},
|
|
27074
27992
|
security: [
|
|
27075
27993
|
{ client_session: [] },
|
|
27994
|
+
{ customer_client_session: [] },
|
|
27076
27995
|
{ pat_with_workspace: [] },
|
|
27077
27996
|
{ console_session_with_workspace: [] },
|
|
27078
27997
|
{ api_key: [] },
|
|
@@ -27302,6 +28221,58 @@ export default {
|
|
|
27302
28221
|
'x-title': 'List Connected Accounts',
|
|
27303
28222
|
},
|
|
27304
28223
|
},
|
|
28224
|
+
'/connected_accounts/sync': {
|
|
28225
|
+
post: {
|
|
28226
|
+
description:
|
|
28227
|
+
'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified connected_account_id.',
|
|
28228
|
+
operationId: 'connectedAccountsSyncPost',
|
|
28229
|
+
requestBody: {
|
|
28230
|
+
content: {
|
|
28231
|
+
'application/json': {
|
|
28232
|
+
schema: {
|
|
28233
|
+
properties: {
|
|
28234
|
+
connected_account_id: {
|
|
28235
|
+
description:
|
|
28236
|
+
'ID of the connected account that you want to sync.',
|
|
28237
|
+
format: 'uuid',
|
|
28238
|
+
type: 'string',
|
|
28239
|
+
},
|
|
28240
|
+
},
|
|
28241
|
+
required: ['connected_account_id'],
|
|
28242
|
+
type: 'object',
|
|
28243
|
+
},
|
|
28244
|
+
},
|
|
28245
|
+
},
|
|
28246
|
+
},
|
|
28247
|
+
responses: {
|
|
28248
|
+
200: {
|
|
28249
|
+
content: {
|
|
28250
|
+
'application/json': {
|
|
28251
|
+
schema: {
|
|
28252
|
+
properties: { ok: { type: 'boolean' } },
|
|
28253
|
+
required: ['ok'],
|
|
28254
|
+
type: 'object',
|
|
28255
|
+
},
|
|
28256
|
+
},
|
|
28257
|
+
},
|
|
28258
|
+
description: 'OK',
|
|
28259
|
+
},
|
|
28260
|
+
400: { description: 'Bad Request' },
|
|
28261
|
+
401: { description: 'Unauthorized' },
|
|
28262
|
+
},
|
|
28263
|
+
security: [
|
|
28264
|
+
{ api_key: [] },
|
|
28265
|
+
{ pat_with_workspace: [] },
|
|
28266
|
+
{ console_session_with_workspace: [] },
|
|
28267
|
+
],
|
|
28268
|
+
summary: '/connected_accounts/sync',
|
|
28269
|
+
tags: ['/connected_accounts'],
|
|
28270
|
+
'x-fern-sdk-group-name': ['connected_accounts'],
|
|
28271
|
+
'x-fern-sdk-method-name': 'sync',
|
|
28272
|
+
'x-response-key': null,
|
|
28273
|
+
'x-title': 'Sync a Connected Account',
|
|
28274
|
+
},
|
|
28275
|
+
},
|
|
27305
28276
|
'/connected_accounts/update': {
|
|
27306
28277
|
post: {
|
|
27307
28278
|
description:
|
|
@@ -27547,6 +28518,7 @@ export default {
|
|
|
27547
28518
|
'Device type for which you want to list devices.',
|
|
27548
28519
|
oneOf: [
|
|
27549
28520
|
{
|
|
28521
|
+
description: 'Device type for smartlocks.\n ',
|
|
27550
28522
|
enum: [
|
|
27551
28523
|
'akuvox_lock',
|
|
27552
28524
|
'august_lock',
|
|
@@ -27579,10 +28551,13 @@ export default {
|
|
|
27579
28551
|
type: 'string',
|
|
27580
28552
|
},
|
|
27581
28553
|
{
|
|
28554
|
+
description:
|
|
28555
|
+
'Device type for noise sensors.\n ',
|
|
27582
28556
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
27583
28557
|
type: 'string',
|
|
27584
28558
|
},
|
|
27585
28559
|
{
|
|
28560
|
+
description: 'Device type for thermostats.\n ',
|
|
27586
28561
|
enum: [
|
|
27587
28562
|
'ecobee_thermostat',
|
|
27588
28563
|
'nest_thermostat',
|
|
@@ -27594,7 +28569,7 @@ export default {
|
|
|
27594
28569
|
type: 'string',
|
|
27595
28570
|
},
|
|
27596
28571
|
{
|
|
27597
|
-
description: '
|
|
28572
|
+
description: 'Device type for phones.\n ',
|
|
27598
28573
|
enum: ['ios_phone', 'android_phone'],
|
|
27599
28574
|
type: 'string',
|
|
27600
28575
|
},
|
|
@@ -27606,6 +28581,8 @@ export default {
|
|
|
27606
28581
|
items: {
|
|
27607
28582
|
oneOf: [
|
|
27608
28583
|
{
|
|
28584
|
+
description:
|
|
28585
|
+
'Device type for smartlocks.\n ',
|
|
27609
28586
|
enum: [
|
|
27610
28587
|
'akuvox_lock',
|
|
27611
28588
|
'august_lock',
|
|
@@ -27638,10 +28615,14 @@ export default {
|
|
|
27638
28615
|
type: 'string',
|
|
27639
28616
|
},
|
|
27640
28617
|
{
|
|
28618
|
+
description:
|
|
28619
|
+
'Device type for noise sensors.\n ',
|
|
27641
28620
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
27642
28621
|
type: 'string',
|
|
27643
28622
|
},
|
|
27644
28623
|
{
|
|
28624
|
+
description:
|
|
28625
|
+
'Device type for thermostats.\n ',
|
|
27645
28626
|
enum: [
|
|
27646
28627
|
'ecobee_thermostat',
|
|
27647
28628
|
'nest_thermostat',
|
|
@@ -27653,7 +28634,7 @@ export default {
|
|
|
27653
28634
|
type: 'string',
|
|
27654
28635
|
},
|
|
27655
28636
|
{
|
|
27656
|
-
description: '
|
|
28637
|
+
description: 'Device type for phones.\n ',
|
|
27657
28638
|
enum: ['ios_phone', 'android_phone'],
|
|
27658
28639
|
type: 'string',
|
|
27659
28640
|
},
|
|
@@ -28156,6 +29137,7 @@ export default {
|
|
|
28156
29137
|
'Device type for which you want to list devices.',
|
|
28157
29138
|
oneOf: [
|
|
28158
29139
|
{
|
|
29140
|
+
description: 'Device type for smartlocks.\n ',
|
|
28159
29141
|
enum: [
|
|
28160
29142
|
'akuvox_lock',
|
|
28161
29143
|
'august_lock',
|
|
@@ -28188,10 +29170,13 @@ export default {
|
|
|
28188
29170
|
type: 'string',
|
|
28189
29171
|
},
|
|
28190
29172
|
{
|
|
29173
|
+
description:
|
|
29174
|
+
'Device type for noise sensors.\n ',
|
|
28191
29175
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
28192
29176
|
type: 'string',
|
|
28193
29177
|
},
|
|
28194
29178
|
{
|
|
29179
|
+
description: 'Device type for thermostats.\n ',
|
|
28195
29180
|
enum: [
|
|
28196
29181
|
'ecobee_thermostat',
|
|
28197
29182
|
'nest_thermostat',
|
|
@@ -28203,7 +29188,7 @@ export default {
|
|
|
28203
29188
|
type: 'string',
|
|
28204
29189
|
},
|
|
28205
29190
|
{
|
|
28206
|
-
description: '
|
|
29191
|
+
description: 'Device type for phones.\n ',
|
|
28207
29192
|
enum: ['ios_phone', 'android_phone'],
|
|
28208
29193
|
type: 'string',
|
|
28209
29194
|
},
|
|
@@ -28215,6 +29200,8 @@ export default {
|
|
|
28215
29200
|
items: {
|
|
28216
29201
|
oneOf: [
|
|
28217
29202
|
{
|
|
29203
|
+
description:
|
|
29204
|
+
'Device type for smartlocks.\n ',
|
|
28218
29205
|
enum: [
|
|
28219
29206
|
'akuvox_lock',
|
|
28220
29207
|
'august_lock',
|
|
@@ -28247,10 +29234,14 @@ export default {
|
|
|
28247
29234
|
type: 'string',
|
|
28248
29235
|
},
|
|
28249
29236
|
{
|
|
29237
|
+
description:
|
|
29238
|
+
'Device type for noise sensors.\n ',
|
|
28250
29239
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
28251
29240
|
type: 'string',
|
|
28252
29241
|
},
|
|
28253
29242
|
{
|
|
29243
|
+
description:
|
|
29244
|
+
'Device type for thermostats.\n ',
|
|
28254
29245
|
enum: [
|
|
28255
29246
|
'ecobee_thermostat',
|
|
28256
29247
|
'nest_thermostat',
|
|
@@ -28262,7 +29253,7 @@ export default {
|
|
|
28262
29253
|
type: 'string',
|
|
28263
29254
|
},
|
|
28264
29255
|
{
|
|
28265
|
-
description: '
|
|
29256
|
+
description: 'Device type for phones.\n ',
|
|
28266
29257
|
enum: ['ios_phone', 'android_phone'],
|
|
28267
29258
|
type: 'string',
|
|
28268
29259
|
},
|
|
@@ -29177,6 +30168,7 @@ export default {
|
|
|
29177
30168
|
description:
|
|
29178
30169
|
'Array of device types by which to filter devices.',
|
|
29179
30170
|
items: {
|
|
30171
|
+
description: 'Device type for smartlocks.\n ',
|
|
29180
30172
|
enum: [
|
|
29181
30173
|
'akuvox_lock',
|
|
29182
30174
|
'august_lock',
|
|
@@ -29713,6 +30705,7 @@ export default {
|
|
|
29713
30705
|
description:
|
|
29714
30706
|
'Array of device types by which to filter devices.',
|
|
29715
30707
|
items: {
|
|
30708
|
+
description: 'Device type for noise sensors.\n ',
|
|
29716
30709
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
29717
30710
|
type: 'string',
|
|
29718
30711
|
},
|
|
@@ -31848,6 +32841,85 @@ export default {
|
|
|
31848
32841
|
'x-undocumented': 'Mobile SDK only.',
|
|
31849
32842
|
},
|
|
31850
32843
|
},
|
|
32844
|
+
'/seam/partner/v1/resources/list': {
|
|
32845
|
+
post: {
|
|
32846
|
+
description: 'List partner resources that have been pushed to Seam.',
|
|
32847
|
+
operationId: 'seamPartnerV1ResourcesListPost',
|
|
32848
|
+
requestBody: {
|
|
32849
|
+
content: {
|
|
32850
|
+
'application/json': {
|
|
32851
|
+
schema: {
|
|
32852
|
+
properties: {
|
|
32853
|
+
resource_type_alias: {
|
|
32854
|
+
description: 'Filter by resource type alias.',
|
|
32855
|
+
type: 'string',
|
|
32856
|
+
},
|
|
32857
|
+
},
|
|
32858
|
+
type: 'object',
|
|
32859
|
+
},
|
|
32860
|
+
},
|
|
32861
|
+
},
|
|
32862
|
+
},
|
|
32863
|
+
responses: {
|
|
32864
|
+
200: {
|
|
32865
|
+
content: {
|
|
32866
|
+
'application/json': {
|
|
32867
|
+
schema: {
|
|
32868
|
+
properties: {
|
|
32869
|
+
ok: { type: 'boolean' },
|
|
32870
|
+
partner_resources: {
|
|
32871
|
+
items: {
|
|
32872
|
+
properties: {
|
|
32873
|
+
custom_metadata: {
|
|
32874
|
+
additionalProperties: { type: 'string' },
|
|
32875
|
+
type: 'object',
|
|
32876
|
+
},
|
|
32877
|
+
customer_key: { type: 'string' },
|
|
32878
|
+
description: { type: 'string' },
|
|
32879
|
+
email_address: { type: 'string' },
|
|
32880
|
+
ends_at: { type: 'string' },
|
|
32881
|
+
location_keys: {
|
|
32882
|
+
items: { type: 'string' },
|
|
32883
|
+
type: 'array',
|
|
32884
|
+
},
|
|
32885
|
+
name: { type: 'string' },
|
|
32886
|
+
partner_resource_key: { type: 'string' },
|
|
32887
|
+
partner_resource_type: { type: 'string' },
|
|
32888
|
+
phone_number: { type: 'string' },
|
|
32889
|
+
starts_at: { type: 'string' },
|
|
32890
|
+
user_identity_key: { type: 'string' },
|
|
32891
|
+
},
|
|
32892
|
+
required: [
|
|
32893
|
+
'partner_resource_type',
|
|
32894
|
+
'partner_resource_key',
|
|
32895
|
+
'customer_key',
|
|
32896
|
+
],
|
|
32897
|
+
type: 'object',
|
|
32898
|
+
},
|
|
32899
|
+
type: 'array',
|
|
32900
|
+
},
|
|
32901
|
+
},
|
|
32902
|
+
required: ['partner_resources', 'ok'],
|
|
32903
|
+
type: 'object',
|
|
32904
|
+
},
|
|
32905
|
+
},
|
|
32906
|
+
},
|
|
32907
|
+
description: 'OK',
|
|
32908
|
+
},
|
|
32909
|
+
400: { description: 'Bad Request' },
|
|
32910
|
+
401: { description: 'Unauthorized' },
|
|
32911
|
+
},
|
|
32912
|
+
security: [{ customer_client_session: [] }],
|
|
32913
|
+
summary: '/seam/partner/v1/resources/list',
|
|
32914
|
+
tags: [],
|
|
32915
|
+
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
32916
|
+
'x-fern-sdk-method-name': 'list',
|
|
32917
|
+
'x-fern-sdk-return-value': 'partner_resources',
|
|
32918
|
+
'x-response-key': 'partner_resources',
|
|
32919
|
+
'x-title': 'List partner resources at Seam',
|
|
32920
|
+
'x-undocumented': 'Partner building blocks/UI only.',
|
|
32921
|
+
},
|
|
32922
|
+
},
|
|
31851
32923
|
'/thermostats/activate_climate_preset': {
|
|
31852
32924
|
post: {
|
|
31853
32925
|
description:
|
|
@@ -32835,6 +33907,7 @@ export default {
|
|
|
32835
33907
|
description:
|
|
32836
33908
|
'Array of device types by which to filter thermostat devices.',
|
|
32837
33909
|
items: {
|
|
33910
|
+
description: 'Device type for thermostats.\n ',
|
|
32838
33911
|
enum: [
|
|
32839
33912
|
'ecobee_thermostat',
|
|
32840
33913
|
'nest_thermostat',
|
|
@@ -34715,7 +35788,59 @@ export default {
|
|
|
34715
35788
|
},
|
|
34716
35789
|
ok: { type: 'boolean' },
|
|
34717
35790
|
},
|
|
34718
|
-
required: ['access_grant', 'ok'],
|
|
35791
|
+
required: ['access_grant', 'ok'],
|
|
35792
|
+
type: 'object',
|
|
35793
|
+
},
|
|
35794
|
+
},
|
|
35795
|
+
},
|
|
35796
|
+
description: 'OK',
|
|
35797
|
+
},
|
|
35798
|
+
400: { description: 'Bad Request' },
|
|
35799
|
+
401: { description: 'Unauthorized' },
|
|
35800
|
+
},
|
|
35801
|
+
security: [
|
|
35802
|
+
{ pat_with_workspace: [] },
|
|
35803
|
+
{ console_session_with_workspace: [] },
|
|
35804
|
+
{ api_key: [] },
|
|
35805
|
+
],
|
|
35806
|
+
summary: '/unstable_access_grants/create',
|
|
35807
|
+
tags: [],
|
|
35808
|
+
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
35809
|
+
'x-fern-sdk-method-name': 'create',
|
|
35810
|
+
'x-fern-sdk-return-value': 'access_grant',
|
|
35811
|
+
'x-response-key': 'access_grant',
|
|
35812
|
+
'x-title': 'Create an Access Grant',
|
|
35813
|
+
'x-undocumented': 'Unreleased.',
|
|
35814
|
+
},
|
|
35815
|
+
},
|
|
35816
|
+
'/unstable_access_grants/delete': {
|
|
35817
|
+
post: {
|
|
35818
|
+
description: 'Delete an access grant.',
|
|
35819
|
+
operationId: 'unstableAccessGrantsDeletePost',
|
|
35820
|
+
requestBody: {
|
|
35821
|
+
content: {
|
|
35822
|
+
'application/json': {
|
|
35823
|
+
schema: {
|
|
35824
|
+
properties: {
|
|
35825
|
+
access_grant_id: {
|
|
35826
|
+
description: 'ID of access grant to delete.',
|
|
35827
|
+
format: 'uuid',
|
|
35828
|
+
type: 'string',
|
|
35829
|
+
},
|
|
35830
|
+
},
|
|
35831
|
+
required: ['access_grant_id'],
|
|
35832
|
+
type: 'object',
|
|
35833
|
+
},
|
|
35834
|
+
},
|
|
35835
|
+
},
|
|
35836
|
+
},
|
|
35837
|
+
responses: {
|
|
35838
|
+
200: {
|
|
35839
|
+
content: {
|
|
35840
|
+
'application/json': {
|
|
35841
|
+
schema: {
|
|
35842
|
+
properties: { ok: { type: 'boolean' } },
|
|
35843
|
+
required: ['ok'],
|
|
34719
35844
|
type: 'object',
|
|
34720
35845
|
},
|
|
34721
35846
|
},
|
|
@@ -34730,13 +35855,12 @@ export default {
|
|
|
34730
35855
|
{ console_session_with_workspace: [] },
|
|
34731
35856
|
{ api_key: [] },
|
|
34732
35857
|
],
|
|
34733
|
-
summary: '/unstable_access_grants/
|
|
35858
|
+
summary: '/unstable_access_grants/delete',
|
|
34734
35859
|
tags: [],
|
|
34735
35860
|
'x-fern-sdk-group-name': ['unstable_access_grants'],
|
|
34736
|
-
'x-fern-sdk-method-name': '
|
|
34737
|
-
'x-
|
|
34738
|
-
'x-
|
|
34739
|
-
'x-title': 'Create an Access Grant',
|
|
35861
|
+
'x-fern-sdk-method-name': 'delete',
|
|
35862
|
+
'x-response-key': null,
|
|
35863
|
+
'x-title': 'Delete an Access Grant',
|
|
34740
35864
|
'x-undocumented': 'Unreleased.',
|
|
34741
35865
|
},
|
|
34742
35866
|
},
|
|
@@ -35059,6 +36183,57 @@ export default {
|
|
|
35059
36183
|
'x-undocumented': 'Unreleased.',
|
|
35060
36184
|
},
|
|
35061
36185
|
},
|
|
36186
|
+
'/unstable_access_methods/delete': {
|
|
36187
|
+
post: {
|
|
36188
|
+
description: 'Delete an access method.',
|
|
36189
|
+
operationId: 'unstableAccessMethodsDeletePost',
|
|
36190
|
+
requestBody: {
|
|
36191
|
+
content: {
|
|
36192
|
+
'application/json': {
|
|
36193
|
+
schema: {
|
|
36194
|
+
properties: {
|
|
36195
|
+
access_method_id: {
|
|
36196
|
+
description: 'ID of access method to get.',
|
|
36197
|
+
format: 'uuid',
|
|
36198
|
+
type: 'string',
|
|
36199
|
+
},
|
|
36200
|
+
},
|
|
36201
|
+
required: ['access_method_id'],
|
|
36202
|
+
type: 'object',
|
|
36203
|
+
},
|
|
36204
|
+
},
|
|
36205
|
+
},
|
|
36206
|
+
},
|
|
36207
|
+
responses: {
|
|
36208
|
+
200: {
|
|
36209
|
+
content: {
|
|
36210
|
+
'application/json': {
|
|
36211
|
+
schema: {
|
|
36212
|
+
properties: { ok: { type: 'boolean' } },
|
|
36213
|
+
required: ['ok'],
|
|
36214
|
+
type: 'object',
|
|
36215
|
+
},
|
|
36216
|
+
},
|
|
36217
|
+
},
|
|
36218
|
+
description: 'OK',
|
|
36219
|
+
},
|
|
36220
|
+
400: { description: 'Bad Request' },
|
|
36221
|
+
401: { description: 'Unauthorized' },
|
|
36222
|
+
},
|
|
36223
|
+
security: [
|
|
36224
|
+
{ pat_with_workspace: [] },
|
|
36225
|
+
{ console_session_with_workspace: [] },
|
|
36226
|
+
{ api_key: [] },
|
|
36227
|
+
],
|
|
36228
|
+
summary: '/unstable_access_methods/delete',
|
|
36229
|
+
tags: [],
|
|
36230
|
+
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
36231
|
+
'x-fern-sdk-method-name': 'delete',
|
|
36232
|
+
'x-response-key': null,
|
|
36233
|
+
'x-title': 'Delete an Access Method',
|
|
36234
|
+
'x-undocumented': 'Unreleased.',
|
|
36235
|
+
},
|
|
36236
|
+
},
|
|
35062
36237
|
'/unstable_access_methods/get': {
|
|
35063
36238
|
post: {
|
|
35064
36239
|
description: 'Get an access method.',
|
|
@@ -36242,6 +37417,200 @@ export default {
|
|
|
36242
37417
|
'x-undocumented': 'Experimental locations.',
|
|
36243
37418
|
},
|
|
36244
37419
|
},
|
|
37420
|
+
'/unstable_partner/building_blocks/generate_link': {
|
|
37421
|
+
post: {
|
|
37422
|
+
description: 'Creates a new bridge client session.',
|
|
37423
|
+
operationId: 'unstablePartnerBuildingBlocksGenerateLinkPost',
|
|
37424
|
+
requestBody: {
|
|
37425
|
+
content: {
|
|
37426
|
+
'application/json': {
|
|
37427
|
+
schema: {
|
|
37428
|
+
properties: {
|
|
37429
|
+
bridge_client_machine_identifier_key: { type: 'string' },
|
|
37430
|
+
bridge_client_name: { type: 'string' },
|
|
37431
|
+
bridge_client_time_zone: { type: 'string' },
|
|
37432
|
+
},
|
|
37433
|
+
required: [
|
|
37434
|
+
'bridge_client_name',
|
|
37435
|
+
'bridge_client_time_zone',
|
|
37436
|
+
'bridge_client_machine_identifier_key',
|
|
37437
|
+
],
|
|
37438
|
+
type: 'object',
|
|
37439
|
+
},
|
|
37440
|
+
},
|
|
37441
|
+
},
|
|
37442
|
+
},
|
|
37443
|
+
responses: {
|
|
37444
|
+
200: {
|
|
37445
|
+
content: {
|
|
37446
|
+
'application/json': {
|
|
37447
|
+
schema: {
|
|
37448
|
+
properties: {
|
|
37449
|
+
bridge_client_session: {
|
|
37450
|
+
properties: {
|
|
37451
|
+
bridge_client_machine_identifier_key: {
|
|
37452
|
+
type: 'string',
|
|
37453
|
+
},
|
|
37454
|
+
bridge_client_name: { type: 'string' },
|
|
37455
|
+
bridge_client_session_id: {
|
|
37456
|
+
format: 'uuid',
|
|
37457
|
+
type: 'string',
|
|
37458
|
+
},
|
|
37459
|
+
bridge_client_session_token: { type: 'string' },
|
|
37460
|
+
bridge_client_time_zone: { type: 'string' },
|
|
37461
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
37462
|
+
errors: {
|
|
37463
|
+
items: {
|
|
37464
|
+
description:
|
|
37465
|
+
'Error associated with the `bridge_client_session`.',
|
|
37466
|
+
discriminator: { propertyName: 'error_code' },
|
|
37467
|
+
oneOf: [
|
|
37468
|
+
{
|
|
37469
|
+
description:
|
|
37470
|
+
"Seam cannot reach the bridge's LAN",
|
|
37471
|
+
properties: {
|
|
37472
|
+
can_tailscale_proxy_reach_bridge: {
|
|
37473
|
+
description:
|
|
37474
|
+
'Tailscale proxy cannot reach the bridge',
|
|
37475
|
+
nullable: true,
|
|
37476
|
+
type: 'boolean',
|
|
37477
|
+
},
|
|
37478
|
+
can_tailscale_proxy_reach_tailscale_network: {
|
|
37479
|
+
description:
|
|
37480
|
+
'Tailscale proxy cannot reach the Tailscale network',
|
|
37481
|
+
nullable: true,
|
|
37482
|
+
type: 'boolean',
|
|
37483
|
+
},
|
|
37484
|
+
created_at: {
|
|
37485
|
+
format: 'date-time',
|
|
37486
|
+
type: 'string',
|
|
37487
|
+
},
|
|
37488
|
+
error_code: {
|
|
37489
|
+
description:
|
|
37490
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
37491
|
+
enum: ['bridge_lan_unreachable'],
|
|
37492
|
+
type: 'string',
|
|
37493
|
+
},
|
|
37494
|
+
is_bridge_socks_server_healthy: {
|
|
37495
|
+
description:
|
|
37496
|
+
"Bridge's SOCKS server is unhealthy",
|
|
37497
|
+
nullable: true,
|
|
37498
|
+
type: 'boolean',
|
|
37499
|
+
},
|
|
37500
|
+
is_tailscale_proxy_reachable: {
|
|
37501
|
+
description:
|
|
37502
|
+
'Seam cannot reach the tailscale proxy',
|
|
37503
|
+
nullable: true,
|
|
37504
|
+
type: 'boolean',
|
|
37505
|
+
},
|
|
37506
|
+
is_tailscale_proxy_socks_server_healthy: {
|
|
37507
|
+
description:
|
|
37508
|
+
"Tailscale proxy's SOCKS server is unhealthy",
|
|
37509
|
+
nullable: true,
|
|
37510
|
+
type: 'boolean',
|
|
37511
|
+
},
|
|
37512
|
+
message: { type: 'string' },
|
|
37513
|
+
},
|
|
37514
|
+
required: [
|
|
37515
|
+
'message',
|
|
37516
|
+
'created_at',
|
|
37517
|
+
'error_code',
|
|
37518
|
+
'is_tailscale_proxy_reachable',
|
|
37519
|
+
'is_tailscale_proxy_socks_server_healthy',
|
|
37520
|
+
'can_tailscale_proxy_reach_tailscale_network',
|
|
37521
|
+
'can_tailscale_proxy_reach_bridge',
|
|
37522
|
+
'is_bridge_socks_server_healthy',
|
|
37523
|
+
],
|
|
37524
|
+
type: 'object',
|
|
37525
|
+
},
|
|
37526
|
+
{
|
|
37527
|
+
description:
|
|
37528
|
+
'Bridge has stopped communicating with Seam',
|
|
37529
|
+
properties: {
|
|
37530
|
+
created_at: {
|
|
37531
|
+
format: 'date-time',
|
|
37532
|
+
type: 'string',
|
|
37533
|
+
},
|
|
37534
|
+
error_code: {
|
|
37535
|
+
description:
|
|
37536
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
37537
|
+
enum: ['no_communication_from_bridge'],
|
|
37538
|
+
type: 'string',
|
|
37539
|
+
},
|
|
37540
|
+
message: { type: 'string' },
|
|
37541
|
+
},
|
|
37542
|
+
required: [
|
|
37543
|
+
'message',
|
|
37544
|
+
'created_at',
|
|
37545
|
+
'error_code',
|
|
37546
|
+
],
|
|
37547
|
+
type: 'object',
|
|
37548
|
+
},
|
|
37549
|
+
],
|
|
37550
|
+
},
|
|
37551
|
+
type: 'array',
|
|
37552
|
+
},
|
|
37553
|
+
pairing_code: {
|
|
37554
|
+
maxLength: 6,
|
|
37555
|
+
minLength: 6,
|
|
37556
|
+
type: 'string',
|
|
37557
|
+
},
|
|
37558
|
+
pairing_code_expires_at: {
|
|
37559
|
+
format: 'date-time',
|
|
37560
|
+
type: 'string',
|
|
37561
|
+
},
|
|
37562
|
+
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
37563
|
+
tailscale_hostname: { type: 'string' },
|
|
37564
|
+
telemetry_token: { nullable: true, type: 'string' },
|
|
37565
|
+
telemetry_token_expires_at: {
|
|
37566
|
+
format: 'date-time',
|
|
37567
|
+
nullable: true,
|
|
37568
|
+
type: 'string',
|
|
37569
|
+
},
|
|
37570
|
+
telemetry_url: { nullable: true, type: 'string' },
|
|
37571
|
+
},
|
|
37572
|
+
required: [
|
|
37573
|
+
'created_at',
|
|
37574
|
+
'bridge_client_session_id',
|
|
37575
|
+
'bridge_client_session_token',
|
|
37576
|
+
'pairing_code',
|
|
37577
|
+
'pairing_code_expires_at',
|
|
37578
|
+
'tailscale_hostname',
|
|
37579
|
+
'tailscale_auth_key',
|
|
37580
|
+
'bridge_client_name',
|
|
37581
|
+
'bridge_client_time_zone',
|
|
37582
|
+
'bridge_client_machine_identifier_key',
|
|
37583
|
+
'errors',
|
|
37584
|
+
'telemetry_token',
|
|
37585
|
+
'telemetry_token_expires_at',
|
|
37586
|
+
'telemetry_url',
|
|
37587
|
+
],
|
|
37588
|
+
type: 'object',
|
|
37589
|
+
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
37590
|
+
'x-undocumented': 'Seam Bridge Client only.',
|
|
37591
|
+
},
|
|
37592
|
+
ok: { type: 'boolean' },
|
|
37593
|
+
},
|
|
37594
|
+
required: ['bridge_client_session', 'ok'],
|
|
37595
|
+
type: 'object',
|
|
37596
|
+
},
|
|
37597
|
+
},
|
|
37598
|
+
},
|
|
37599
|
+
description: 'OK',
|
|
37600
|
+
},
|
|
37601
|
+
400: { description: 'Bad Request' },
|
|
37602
|
+
401: { description: 'Unauthorized' },
|
|
37603
|
+
},
|
|
37604
|
+
security: [{ certified_client: [] }],
|
|
37605
|
+
summary: '/unstable_partner/building_blocks/generate_link',
|
|
37606
|
+
tags: [],
|
|
37607
|
+
'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
|
|
37608
|
+
'x-fern-sdk-method-name': 'generate_link',
|
|
37609
|
+
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
37610
|
+
'x-response-key': 'bridge_client_session',
|
|
37611
|
+
'x-title': 'Generate a building block magic link',
|
|
37612
|
+
},
|
|
37613
|
+
},
|
|
36245
37614
|
'/unstable_partner/resources/push': {
|
|
36246
37615
|
post: {
|
|
36247
37616
|
description: 'Send Seam some of your resources.',
|
|
@@ -36262,7 +37631,6 @@ export default {
|
|
|
36262
37631
|
description: { type: 'string' },
|
|
36263
37632
|
email_address: { type: 'string' },
|
|
36264
37633
|
ends_at: { type: 'string' },
|
|
36265
|
-
icon_url: { type: 'string' },
|
|
36266
37634
|
location_keys: {
|
|
36267
37635
|
items: { type: 'string' },
|
|
36268
37636
|
type: 'array',
|
|
@@ -36288,7 +37656,6 @@ export default {
|
|
|
36288
37656
|
description: { type: 'string' },
|
|
36289
37657
|
email_address: { type: 'string' },
|
|
36290
37658
|
ends_at: { type: 'string' },
|
|
36291
|
-
icon_url: { type: 'string' },
|
|
36292
37659
|
location_keys: {
|
|
36293
37660
|
items: { type: 'string' },
|
|
36294
37661
|
type: 'array',
|