@seamapi/types 0.17.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/lib/seam/connect/route-types.d.ts +877 -12
  2. package/lib/seam/connect/unstable/model-types.d.ts +1 -1
  3. package/lib/seam/connect/unstable/models/capability-properties/access-code.d.ts +70 -0
  4. package/lib/seam/connect/unstable/models/capability-properties/access-code.js +28 -0
  5. package/lib/seam/connect/unstable/models/capability-properties/access-code.js.map +1 -0
  6. package/lib/seam/connect/unstable/models/capability-properties/index.d.ts +286 -0
  7. package/lib/seam/connect/unstable/models/capability-properties/index.js +10 -0
  8. package/lib/seam/connect/unstable/models/capability-properties/index.js.map +1 -0
  9. package/lib/seam/connect/unstable/models/capability-properties/lock.d.ts +24 -0
  10. package/lib/seam/connect/unstable/models/capability-properties/lock.js +11 -0
  11. package/lib/seam/connect/unstable/models/capability-properties/lock.js.map +1 -0
  12. package/lib/seam/connect/unstable/models/capability-properties/thermostat.d.ts +302 -0
  13. package/lib/seam/connect/unstable/models/capability-properties/thermostat.js +46 -0
  14. package/lib/seam/connect/unstable/models/capability-properties/thermostat.js.map +1 -0
  15. package/lib/seam/connect/unstable/models/device-metadata.d.ts +722 -0
  16. package/lib/seam/connect/unstable/models/device-metadata.js +143 -0
  17. package/lib/seam/connect/unstable/models/device-metadata.js.map +1 -0
  18. package/lib/seam/connect/unstable/models/index.d.ts +1 -0
  19. package/lib/seam/connect/unstable/models/index.js +1 -0
  20. package/lib/seam/connect/unstable/models/index.js.map +1 -1
  21. package/lib/seam/connect/unstable/models/managed-device.d.ts +1549 -7
  22. package/lib/seam/connect/unstable/models/managed-device.js +31 -9
  23. package/lib/seam/connect/unstable/models/managed-device.js.map +1 -1
  24. package/lib/seam/connect/unstable/schemas.d.ts +1 -1
  25. package/lib/seam/connect/unstable/schemas.js +1 -1
  26. package/lib/seam/connect/unstable/schemas.js.map +1 -1
  27. package/package.json +4 -1
  28. package/src/lib/seam/connect/route-types.ts +1201 -12
  29. package/src/lib/seam/connect/unstable/model-types.ts +4 -0
  30. package/src/lib/seam/connect/unstable/models/capability-properties/access-code.ts +33 -0
  31. package/src/lib/seam/connect/unstable/models/capability-properties/index.ts +26 -0
  32. package/src/lib/seam/connect/unstable/models/capability-properties/lock.ts +11 -0
  33. package/src/lib/seam/connect/unstable/models/capability-properties/thermostat.ts +53 -0
  34. package/src/lib/seam/connect/unstable/models/device-metadata.ts +162 -0
  35. package/src/lib/seam/connect/unstable/models/index.ts +1 -0
  36. package/src/lib/seam/connect/unstable/models/managed-device.ts +44 -9
  37. package/src/lib/seam/connect/unstable/schemas.ts +5 -1
@@ -581,6 +581,7 @@ export interface Routes {
581
581
  commonParams: {
582
582
  client_session_id?: string | undefined
583
583
  user_identifier_key?: string | undefined
584
+ connect_webview_id?: string | undefined
584
585
  without_user_identifier_key?: boolean | undefined
585
586
  }
586
587
  formData: {}
@@ -863,14 +864,311 @@ export interface Routes {
863
864
  capabilities_supported: Array<
864
865
  'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
865
866
  >
866
- properties: {
867
+ properties: ({
867
868
  online: boolean
868
869
  name: string
869
870
  model: {
870
871
  display_name: string
871
872
  }
872
- } & Record<string, any>
873
- location?: any
873
+ has_direct_power?: boolean | undefined
874
+ battery_level?: number | undefined
875
+ battery?:
876
+ | {
877
+ level: number
878
+ status: 'critical' | 'low' | 'good' | 'full'
879
+ }
880
+ | undefined
881
+ manufacturer?: string | undefined
882
+ image_url?: string | undefined
883
+ image_alt_text?: string | undefined
884
+ serial_number?: string | undefined
885
+ } & {
886
+ august_metadata?:
887
+ | {
888
+ lock_id: string
889
+ lock_name: string
890
+ house_name: string
891
+ has_keypad: boolean
892
+ keypad_battery_level?: string | undefined
893
+ model?: string | undefined
894
+ house_id?: string | undefined
895
+ }
896
+ | undefined
897
+ schlage_metadata?:
898
+ | {
899
+ device_id: string
900
+ device_name: string
901
+ access_code_length: number
902
+ model?: string | undefined
903
+ }
904
+ | undefined
905
+ smartthings_metadata?:
906
+ | {
907
+ device_id: string
908
+ device_name: string
909
+ model?: string | undefined
910
+ location_id?: string | undefined
911
+ }
912
+ | undefined
913
+ lockly_metadata?:
914
+ | {
915
+ device_id: string
916
+ device_name: string
917
+ model?: string | undefined
918
+ }
919
+ | undefined
920
+ nuki_metadata?:
921
+ | {
922
+ device_id: string
923
+ device_name: string
924
+ keypad_battery_critical?: boolean | undefined
925
+ }
926
+ | undefined
927
+ kwikset_metadata?:
928
+ | {
929
+ device_id: string
930
+ device_name: string
931
+ model_number: string
932
+ }
933
+ | undefined
934
+ salto_metadata?:
935
+ | {
936
+ lock_id: string
937
+ customer_reference: string
938
+ lock_type: string
939
+ battery_level: string
940
+ locked_state: string
941
+ model?: string | undefined
942
+ }
943
+ | undefined
944
+ genie_metadata?:
945
+ | {
946
+ device_name: string
947
+ door_name: string
948
+ }
949
+ | undefined
950
+ brivo_metadata?:
951
+ | {
952
+ device_name: string
953
+ }
954
+ | undefined
955
+ igloo_metadata?:
956
+ | {
957
+ device_id: string
958
+ bridge_id: string
959
+ model?: string | undefined
960
+ }
961
+ | undefined
962
+ noiseaware_metadata?:
963
+ | {
964
+ device_model: 'indoor' | 'outdoor'
965
+ noise_level_nrs: number
966
+ noise_level_decibel: number
967
+ device_name: string
968
+ device_id: string
969
+ }
970
+ | undefined
971
+ minut_metadata?:
972
+ | {
973
+ device_id: string
974
+ device_name: string
975
+ latest_sensor_values: {
976
+ temperature: {
977
+ time: string
978
+ value: number
979
+ }
980
+ sound: {
981
+ time: string
982
+ value: number
983
+ }
984
+ humidity: {
985
+ time: string
986
+ value: number
987
+ }
988
+ pressure: {
989
+ time: string
990
+ value: number
991
+ }
992
+ accelerometer_z: {
993
+ time: string
994
+ value: number
995
+ }
996
+ }
997
+ }
998
+ | undefined
999
+ two_n_metadata?:
1000
+ | {
1001
+ device_id: number
1002
+ device_name: string
1003
+ }
1004
+ | undefined
1005
+ controlbyweb_metadata?:
1006
+ | {
1007
+ device_id: string
1008
+ device_name: string
1009
+ relay_name: string | null
1010
+ }
1011
+ | undefined
1012
+ ttlock_metadata?:
1013
+ | {
1014
+ lock_id: number
1015
+ lock_alias: string
1016
+ }
1017
+ | undefined
1018
+ seam_bridge_metadata?:
1019
+ | {
1020
+ unlock_method?: ('bridge' | 'doorking') | undefined
1021
+ device_num: number
1022
+ name: string
1023
+ }
1024
+ | undefined
1025
+ igloohome_metadata?:
1026
+ | {
1027
+ device_id: string
1028
+ bridge_id: string
1029
+ device_name: string
1030
+ bridge_name: string
1031
+ }
1032
+ | undefined
1033
+ nest_metadata?:
1034
+ | {
1035
+ nest_device_id: string
1036
+ device_name: string
1037
+ custom_name: string
1038
+ }
1039
+ | undefined
1040
+ ecobee_metadata?:
1041
+ | {
1042
+ ecobee_device_id: string
1043
+ device_name: string
1044
+ min_heating_set_point_fahrenheit?: number | undefined
1045
+ max_heating_set_point_fahrenheit?: number | undefined
1046
+ min_cooling_set_point_fahrenheit?: number | undefined
1047
+ max_cooling_set_point_fahrenheit?: number | undefined
1048
+ min_heating_set_point_celsius?: number | undefined
1049
+ max_heating_set_point_celsius?: number | undefined
1050
+ min_cooling_set_point_celsius?: number | undefined
1051
+ max_cooling_set_point_celsius?: number | undefined
1052
+ min_delta_heat_cool_set_points_fahrenheit?: number | undefined
1053
+ min_delta_heat_cool_set_points_celsius?: number | undefined
1054
+ }
1055
+ | undefined
1056
+ hubitat_metadata?:
1057
+ | {
1058
+ device_id: string
1059
+ device_name: string
1060
+ device_label: string
1061
+ }
1062
+ | undefined
1063
+ }) & {
1064
+ code_constraints?:
1065
+ | (
1066
+ | Array<
1067
+ | {
1068
+ constraint_type:
1069
+ | 'no_zeros'
1070
+ | 'cannot_start_with_12'
1071
+ | 'no_triple_consecutive_ints'
1072
+ | 'cannot_specify_pin_code'
1073
+ | 'pin_code_matches_existing_set'
1074
+ | 'start_date_in_future'
1075
+ }
1076
+ | {
1077
+ constraint_type: 'name_length'
1078
+ min_length?: number | undefined
1079
+ max_length?: number | undefined
1080
+ }
1081
+ >
1082
+ | undefined
1083
+ )
1084
+ | undefined
1085
+ supported_code_lengths?: (number[] | undefined) | undefined
1086
+ max_active_codes_supported?: (number | undefined) | undefined
1087
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
1088
+ has_native_entry_events?: (boolean | undefined) | undefined
1089
+ locked?: (boolean | undefined) | undefined
1090
+ keypad_battery?:
1091
+ | (
1092
+ | {
1093
+ level: number
1094
+ }
1095
+ | undefined
1096
+ )
1097
+ | undefined
1098
+ door_open?: (boolean | undefined) | undefined
1099
+ temperature_fahrenheit?: number | undefined
1100
+ temperature_celsius?: number | undefined
1101
+ relative_humidity?: number | undefined
1102
+ can_enable_automatic_heating?: boolean | undefined
1103
+ can_enable_automatic_cooling?: boolean | undefined
1104
+ available_hvac_mode_settings?:
1105
+ | Array<'off' | 'heat' | 'cool' | 'heatcool'>
1106
+ | undefined
1107
+ is_heating?: boolean | undefined
1108
+ is_cooling?: boolean | undefined
1109
+ is_fan_running?: boolean | undefined
1110
+ is_temporary_manual_override_active?: boolean | undefined
1111
+ current_climate_setting?:
1112
+ | {
1113
+ automatic_heating_enabled: boolean
1114
+ automatic_cooling_enabled: boolean
1115
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
1116
+ cooling_set_point_celsius?: number | undefined
1117
+ heating_set_point_celsius?: number | undefined
1118
+ cooling_set_point_fahrenheit?: number | undefined
1119
+ heating_set_point_fahrenheit?: number | undefined
1120
+ manual_override_allowed: boolean
1121
+ }
1122
+ | undefined
1123
+ default_climate_setting?:
1124
+ | (
1125
+ | {
1126
+ automatic_heating_enabled: boolean
1127
+ automatic_cooling_enabled: boolean
1128
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
1129
+ cooling_set_point_celsius?: number | undefined
1130
+ heating_set_point_celsius?: number | undefined
1131
+ cooling_set_point_fahrenheit?: number | undefined
1132
+ heating_set_point_fahrenheit?: number | undefined
1133
+ manual_override_allowed: boolean
1134
+ }
1135
+ | undefined
1136
+ )
1137
+ | undefined
1138
+ is_climate_setting_schedule_active?: boolean | undefined
1139
+ active_climate_setting_schedule?:
1140
+ | (
1141
+ | {
1142
+ climate_setting_schedule_id: string
1143
+ schedule_type: 'time_bound'
1144
+ device_id: string
1145
+ name?: string | undefined
1146
+ schedule_starts_at: string
1147
+ schedule_ends_at: string
1148
+ created_at: string
1149
+ automatic_heating_enabled?: boolean | undefined
1150
+ automatic_cooling_enabled?: boolean | undefined
1151
+ hvac_mode_setting?:
1152
+ | ('off' | 'heat' | 'cool' | 'heatcool')
1153
+ | undefined
1154
+ cooling_set_point_celsius?: (number | undefined) | undefined
1155
+ heating_set_point_celsius?: (number | undefined) | undefined
1156
+ cooling_set_point_fahrenheit?:
1157
+ | (number | undefined)
1158
+ | undefined
1159
+ heating_set_point_fahrenheit?:
1160
+ | (number | undefined)
1161
+ | undefined
1162
+ manual_override_allowed?: boolean | undefined
1163
+ }
1164
+ | undefined
1165
+ )
1166
+ | undefined
1167
+ }
1168
+ location: {
1169
+ location_name?: string | undefined
1170
+ timezone?: string | undefined
1171
+ } | null
874
1172
  connected_account_id: string
875
1173
  workspace_id: string
876
1174
  errors: Array<{
@@ -1022,14 +1320,311 @@ export interface Routes {
1022
1320
  capabilities_supported: Array<
1023
1321
  'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
1024
1322
  >
1025
- properties: {
1323
+ properties: ({
1026
1324
  online: boolean
1027
1325
  name: string
1028
1326
  model: {
1029
1327
  display_name: string
1030
1328
  }
1031
- } & Record<string, any>
1032
- location?: any
1329
+ has_direct_power?: boolean | undefined
1330
+ battery_level?: number | undefined
1331
+ battery?:
1332
+ | {
1333
+ level: number
1334
+ status: 'critical' | 'low' | 'good' | 'full'
1335
+ }
1336
+ | undefined
1337
+ manufacturer?: string | undefined
1338
+ image_url?: string | undefined
1339
+ image_alt_text?: string | undefined
1340
+ serial_number?: string | undefined
1341
+ } & {
1342
+ august_metadata?:
1343
+ | {
1344
+ lock_id: string
1345
+ lock_name: string
1346
+ house_name: string
1347
+ has_keypad: boolean
1348
+ keypad_battery_level?: string | undefined
1349
+ model?: string | undefined
1350
+ house_id?: string | undefined
1351
+ }
1352
+ | undefined
1353
+ schlage_metadata?:
1354
+ | {
1355
+ device_id: string
1356
+ device_name: string
1357
+ access_code_length: number
1358
+ model?: string | undefined
1359
+ }
1360
+ | undefined
1361
+ smartthings_metadata?:
1362
+ | {
1363
+ device_id: string
1364
+ device_name: string
1365
+ model?: string | undefined
1366
+ location_id?: string | undefined
1367
+ }
1368
+ | undefined
1369
+ lockly_metadata?:
1370
+ | {
1371
+ device_id: string
1372
+ device_name: string
1373
+ model?: string | undefined
1374
+ }
1375
+ | undefined
1376
+ nuki_metadata?:
1377
+ | {
1378
+ device_id: string
1379
+ device_name: string
1380
+ keypad_battery_critical?: boolean | undefined
1381
+ }
1382
+ | undefined
1383
+ kwikset_metadata?:
1384
+ | {
1385
+ device_id: string
1386
+ device_name: string
1387
+ model_number: string
1388
+ }
1389
+ | undefined
1390
+ salto_metadata?:
1391
+ | {
1392
+ lock_id: string
1393
+ customer_reference: string
1394
+ lock_type: string
1395
+ battery_level: string
1396
+ locked_state: string
1397
+ model?: string | undefined
1398
+ }
1399
+ | undefined
1400
+ genie_metadata?:
1401
+ | {
1402
+ device_name: string
1403
+ door_name: string
1404
+ }
1405
+ | undefined
1406
+ brivo_metadata?:
1407
+ | {
1408
+ device_name: string
1409
+ }
1410
+ | undefined
1411
+ igloo_metadata?:
1412
+ | {
1413
+ device_id: string
1414
+ bridge_id: string
1415
+ model?: string | undefined
1416
+ }
1417
+ | undefined
1418
+ noiseaware_metadata?:
1419
+ | {
1420
+ device_model: 'indoor' | 'outdoor'
1421
+ noise_level_nrs: number
1422
+ noise_level_decibel: number
1423
+ device_name: string
1424
+ device_id: string
1425
+ }
1426
+ | undefined
1427
+ minut_metadata?:
1428
+ | {
1429
+ device_id: string
1430
+ device_name: string
1431
+ latest_sensor_values: {
1432
+ temperature: {
1433
+ time: string
1434
+ value: number
1435
+ }
1436
+ sound: {
1437
+ time: string
1438
+ value: number
1439
+ }
1440
+ humidity: {
1441
+ time: string
1442
+ value: number
1443
+ }
1444
+ pressure: {
1445
+ time: string
1446
+ value: number
1447
+ }
1448
+ accelerometer_z: {
1449
+ time: string
1450
+ value: number
1451
+ }
1452
+ }
1453
+ }
1454
+ | undefined
1455
+ two_n_metadata?:
1456
+ | {
1457
+ device_id: number
1458
+ device_name: string
1459
+ }
1460
+ | undefined
1461
+ controlbyweb_metadata?:
1462
+ | {
1463
+ device_id: string
1464
+ device_name: string
1465
+ relay_name: string | null
1466
+ }
1467
+ | undefined
1468
+ ttlock_metadata?:
1469
+ | {
1470
+ lock_id: number
1471
+ lock_alias: string
1472
+ }
1473
+ | undefined
1474
+ seam_bridge_metadata?:
1475
+ | {
1476
+ unlock_method?: ('bridge' | 'doorking') | undefined
1477
+ device_num: number
1478
+ name: string
1479
+ }
1480
+ | undefined
1481
+ igloohome_metadata?:
1482
+ | {
1483
+ device_id: string
1484
+ bridge_id: string
1485
+ device_name: string
1486
+ bridge_name: string
1487
+ }
1488
+ | undefined
1489
+ nest_metadata?:
1490
+ | {
1491
+ nest_device_id: string
1492
+ device_name: string
1493
+ custom_name: string
1494
+ }
1495
+ | undefined
1496
+ ecobee_metadata?:
1497
+ | {
1498
+ ecobee_device_id: string
1499
+ device_name: string
1500
+ min_heating_set_point_fahrenheit?: number | undefined
1501
+ max_heating_set_point_fahrenheit?: number | undefined
1502
+ min_cooling_set_point_fahrenheit?: number | undefined
1503
+ max_cooling_set_point_fahrenheit?: number | undefined
1504
+ min_heating_set_point_celsius?: number | undefined
1505
+ max_heating_set_point_celsius?: number | undefined
1506
+ min_cooling_set_point_celsius?: number | undefined
1507
+ max_cooling_set_point_celsius?: number | undefined
1508
+ min_delta_heat_cool_set_points_fahrenheit?: number | undefined
1509
+ min_delta_heat_cool_set_points_celsius?: number | undefined
1510
+ }
1511
+ | undefined
1512
+ hubitat_metadata?:
1513
+ | {
1514
+ device_id: string
1515
+ device_name: string
1516
+ device_label: string
1517
+ }
1518
+ | undefined
1519
+ }) & {
1520
+ code_constraints?:
1521
+ | (
1522
+ | Array<
1523
+ | {
1524
+ constraint_type:
1525
+ | 'no_zeros'
1526
+ | 'cannot_start_with_12'
1527
+ | 'no_triple_consecutive_ints'
1528
+ | 'cannot_specify_pin_code'
1529
+ | 'pin_code_matches_existing_set'
1530
+ | 'start_date_in_future'
1531
+ }
1532
+ | {
1533
+ constraint_type: 'name_length'
1534
+ min_length?: number | undefined
1535
+ max_length?: number | undefined
1536
+ }
1537
+ >
1538
+ | undefined
1539
+ )
1540
+ | undefined
1541
+ supported_code_lengths?: (number[] | undefined) | undefined
1542
+ max_active_codes_supported?: (number | undefined) | undefined
1543
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
1544
+ has_native_entry_events?: (boolean | undefined) | undefined
1545
+ locked?: (boolean | undefined) | undefined
1546
+ keypad_battery?:
1547
+ | (
1548
+ | {
1549
+ level: number
1550
+ }
1551
+ | undefined
1552
+ )
1553
+ | undefined
1554
+ door_open?: (boolean | undefined) | undefined
1555
+ temperature_fahrenheit?: number | undefined
1556
+ temperature_celsius?: number | undefined
1557
+ relative_humidity?: number | undefined
1558
+ can_enable_automatic_heating?: boolean | undefined
1559
+ can_enable_automatic_cooling?: boolean | undefined
1560
+ available_hvac_mode_settings?:
1561
+ | Array<'off' | 'heat' | 'cool' | 'heatcool'>
1562
+ | undefined
1563
+ is_heating?: boolean | undefined
1564
+ is_cooling?: boolean | undefined
1565
+ is_fan_running?: boolean | undefined
1566
+ is_temporary_manual_override_active?: boolean | undefined
1567
+ current_climate_setting?:
1568
+ | {
1569
+ automatic_heating_enabled: boolean
1570
+ automatic_cooling_enabled: boolean
1571
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
1572
+ cooling_set_point_celsius?: number | undefined
1573
+ heating_set_point_celsius?: number | undefined
1574
+ cooling_set_point_fahrenheit?: number | undefined
1575
+ heating_set_point_fahrenheit?: number | undefined
1576
+ manual_override_allowed: boolean
1577
+ }
1578
+ | undefined
1579
+ default_climate_setting?:
1580
+ | (
1581
+ | {
1582
+ automatic_heating_enabled: boolean
1583
+ automatic_cooling_enabled: boolean
1584
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
1585
+ cooling_set_point_celsius?: number | undefined
1586
+ heating_set_point_celsius?: number | undefined
1587
+ cooling_set_point_fahrenheit?: number | undefined
1588
+ heating_set_point_fahrenheit?: number | undefined
1589
+ manual_override_allowed: boolean
1590
+ }
1591
+ | undefined
1592
+ )
1593
+ | undefined
1594
+ is_climate_setting_schedule_active?: boolean | undefined
1595
+ active_climate_setting_schedule?:
1596
+ | (
1597
+ | {
1598
+ climate_setting_schedule_id: string
1599
+ schedule_type: 'time_bound'
1600
+ device_id: string
1601
+ name?: string | undefined
1602
+ schedule_starts_at: string
1603
+ schedule_ends_at: string
1604
+ created_at: string
1605
+ automatic_heating_enabled?: boolean | undefined
1606
+ automatic_cooling_enabled?: boolean | undefined
1607
+ hvac_mode_setting?:
1608
+ | ('off' | 'heat' | 'cool' | 'heatcool')
1609
+ | undefined
1610
+ cooling_set_point_celsius?: (number | undefined) | undefined
1611
+ heating_set_point_celsius?: (number | undefined) | undefined
1612
+ cooling_set_point_fahrenheit?:
1613
+ | (number | undefined)
1614
+ | undefined
1615
+ heating_set_point_fahrenheit?:
1616
+ | (number | undefined)
1617
+ | undefined
1618
+ manual_override_allowed?: boolean | undefined
1619
+ }
1620
+ | undefined
1621
+ )
1622
+ | undefined
1623
+ }
1624
+ location: {
1625
+ location_name?: string | undefined
1626
+ timezone?: string | undefined
1627
+ } | null
1033
1628
  connected_account_id: string
1034
1629
  workspace_id: string
1035
1630
  errors: Array<{
@@ -2042,14 +2637,311 @@ export interface Routes {
2042
2637
  capabilities_supported: Array<
2043
2638
  'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
2044
2639
  >
2045
- properties: {
2640
+ properties: ({
2046
2641
  online: boolean
2047
2642
  name: string
2048
2643
  model: {
2049
2644
  display_name: string
2050
2645
  }
2051
- } & Record<string, any>
2052
- location?: any
2646
+ has_direct_power?: boolean | undefined
2647
+ battery_level?: number | undefined
2648
+ battery?:
2649
+ | {
2650
+ level: number
2651
+ status: 'critical' | 'low' | 'good' | 'full'
2652
+ }
2653
+ | undefined
2654
+ manufacturer?: string | undefined
2655
+ image_url?: string | undefined
2656
+ image_alt_text?: string | undefined
2657
+ serial_number?: string | undefined
2658
+ } & {
2659
+ august_metadata?:
2660
+ | {
2661
+ lock_id: string
2662
+ lock_name: string
2663
+ house_name: string
2664
+ has_keypad: boolean
2665
+ keypad_battery_level?: string | undefined
2666
+ model?: string | undefined
2667
+ house_id?: string | undefined
2668
+ }
2669
+ | undefined
2670
+ schlage_metadata?:
2671
+ | {
2672
+ device_id: string
2673
+ device_name: string
2674
+ access_code_length: number
2675
+ model?: string | undefined
2676
+ }
2677
+ | undefined
2678
+ smartthings_metadata?:
2679
+ | {
2680
+ device_id: string
2681
+ device_name: string
2682
+ model?: string | undefined
2683
+ location_id?: string | undefined
2684
+ }
2685
+ | undefined
2686
+ lockly_metadata?:
2687
+ | {
2688
+ device_id: string
2689
+ device_name: string
2690
+ model?: string | undefined
2691
+ }
2692
+ | undefined
2693
+ nuki_metadata?:
2694
+ | {
2695
+ device_id: string
2696
+ device_name: string
2697
+ keypad_battery_critical?: boolean | undefined
2698
+ }
2699
+ | undefined
2700
+ kwikset_metadata?:
2701
+ | {
2702
+ device_id: string
2703
+ device_name: string
2704
+ model_number: string
2705
+ }
2706
+ | undefined
2707
+ salto_metadata?:
2708
+ | {
2709
+ lock_id: string
2710
+ customer_reference: string
2711
+ lock_type: string
2712
+ battery_level: string
2713
+ locked_state: string
2714
+ model?: string | undefined
2715
+ }
2716
+ | undefined
2717
+ genie_metadata?:
2718
+ | {
2719
+ device_name: string
2720
+ door_name: string
2721
+ }
2722
+ | undefined
2723
+ brivo_metadata?:
2724
+ | {
2725
+ device_name: string
2726
+ }
2727
+ | undefined
2728
+ igloo_metadata?:
2729
+ | {
2730
+ device_id: string
2731
+ bridge_id: string
2732
+ model?: string | undefined
2733
+ }
2734
+ | undefined
2735
+ noiseaware_metadata?:
2736
+ | {
2737
+ device_model: 'indoor' | 'outdoor'
2738
+ noise_level_nrs: number
2739
+ noise_level_decibel: number
2740
+ device_name: string
2741
+ device_id: string
2742
+ }
2743
+ | undefined
2744
+ minut_metadata?:
2745
+ | {
2746
+ device_id: string
2747
+ device_name: string
2748
+ latest_sensor_values: {
2749
+ temperature: {
2750
+ time: string
2751
+ value: number
2752
+ }
2753
+ sound: {
2754
+ time: string
2755
+ value: number
2756
+ }
2757
+ humidity: {
2758
+ time: string
2759
+ value: number
2760
+ }
2761
+ pressure: {
2762
+ time: string
2763
+ value: number
2764
+ }
2765
+ accelerometer_z: {
2766
+ time: string
2767
+ value: number
2768
+ }
2769
+ }
2770
+ }
2771
+ | undefined
2772
+ two_n_metadata?:
2773
+ | {
2774
+ device_id: number
2775
+ device_name: string
2776
+ }
2777
+ | undefined
2778
+ controlbyweb_metadata?:
2779
+ | {
2780
+ device_id: string
2781
+ device_name: string
2782
+ relay_name: string | null
2783
+ }
2784
+ | undefined
2785
+ ttlock_metadata?:
2786
+ | {
2787
+ lock_id: number
2788
+ lock_alias: string
2789
+ }
2790
+ | undefined
2791
+ seam_bridge_metadata?:
2792
+ | {
2793
+ unlock_method?: ('bridge' | 'doorking') | undefined
2794
+ device_num: number
2795
+ name: string
2796
+ }
2797
+ | undefined
2798
+ igloohome_metadata?:
2799
+ | {
2800
+ device_id: string
2801
+ bridge_id: string
2802
+ device_name: string
2803
+ bridge_name: string
2804
+ }
2805
+ | undefined
2806
+ nest_metadata?:
2807
+ | {
2808
+ nest_device_id: string
2809
+ device_name: string
2810
+ custom_name: string
2811
+ }
2812
+ | undefined
2813
+ ecobee_metadata?:
2814
+ | {
2815
+ ecobee_device_id: string
2816
+ device_name: string
2817
+ min_heating_set_point_fahrenheit?: number | undefined
2818
+ max_heating_set_point_fahrenheit?: number | undefined
2819
+ min_cooling_set_point_fahrenheit?: number | undefined
2820
+ max_cooling_set_point_fahrenheit?: number | undefined
2821
+ min_heating_set_point_celsius?: number | undefined
2822
+ max_heating_set_point_celsius?: number | undefined
2823
+ min_cooling_set_point_celsius?: number | undefined
2824
+ max_cooling_set_point_celsius?: number | undefined
2825
+ min_delta_heat_cool_set_points_fahrenheit?: number | undefined
2826
+ min_delta_heat_cool_set_points_celsius?: number | undefined
2827
+ }
2828
+ | undefined
2829
+ hubitat_metadata?:
2830
+ | {
2831
+ device_id: string
2832
+ device_name: string
2833
+ device_label: string
2834
+ }
2835
+ | undefined
2836
+ }) & {
2837
+ code_constraints?:
2838
+ | (
2839
+ | Array<
2840
+ | {
2841
+ constraint_type:
2842
+ | 'no_zeros'
2843
+ | 'cannot_start_with_12'
2844
+ | 'no_triple_consecutive_ints'
2845
+ | 'cannot_specify_pin_code'
2846
+ | 'pin_code_matches_existing_set'
2847
+ | 'start_date_in_future'
2848
+ }
2849
+ | {
2850
+ constraint_type: 'name_length'
2851
+ min_length?: number | undefined
2852
+ max_length?: number | undefined
2853
+ }
2854
+ >
2855
+ | undefined
2856
+ )
2857
+ | undefined
2858
+ supported_code_lengths?: (number[] | undefined) | undefined
2859
+ max_active_codes_supported?: (number | undefined) | undefined
2860
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
2861
+ has_native_entry_events?: (boolean | undefined) | undefined
2862
+ locked?: (boolean | undefined) | undefined
2863
+ keypad_battery?:
2864
+ | (
2865
+ | {
2866
+ level: number
2867
+ }
2868
+ | undefined
2869
+ )
2870
+ | undefined
2871
+ door_open?: (boolean | undefined) | undefined
2872
+ temperature_fahrenheit?: number | undefined
2873
+ temperature_celsius?: number | undefined
2874
+ relative_humidity?: number | undefined
2875
+ can_enable_automatic_heating?: boolean | undefined
2876
+ can_enable_automatic_cooling?: boolean | undefined
2877
+ available_hvac_mode_settings?:
2878
+ | Array<'off' | 'heat' | 'cool' | 'heatcool'>
2879
+ | undefined
2880
+ is_heating?: boolean | undefined
2881
+ is_cooling?: boolean | undefined
2882
+ is_fan_running?: boolean | undefined
2883
+ is_temporary_manual_override_active?: boolean | undefined
2884
+ current_climate_setting?:
2885
+ | {
2886
+ automatic_heating_enabled: boolean
2887
+ automatic_cooling_enabled: boolean
2888
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
2889
+ cooling_set_point_celsius?: number | undefined
2890
+ heating_set_point_celsius?: number | undefined
2891
+ cooling_set_point_fahrenheit?: number | undefined
2892
+ heating_set_point_fahrenheit?: number | undefined
2893
+ manual_override_allowed: boolean
2894
+ }
2895
+ | undefined
2896
+ default_climate_setting?:
2897
+ | (
2898
+ | {
2899
+ automatic_heating_enabled: boolean
2900
+ automatic_cooling_enabled: boolean
2901
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
2902
+ cooling_set_point_celsius?: number | undefined
2903
+ heating_set_point_celsius?: number | undefined
2904
+ cooling_set_point_fahrenheit?: number | undefined
2905
+ heating_set_point_fahrenheit?: number | undefined
2906
+ manual_override_allowed: boolean
2907
+ }
2908
+ | undefined
2909
+ )
2910
+ | undefined
2911
+ is_climate_setting_schedule_active?: boolean | undefined
2912
+ active_climate_setting_schedule?:
2913
+ | (
2914
+ | {
2915
+ climate_setting_schedule_id: string
2916
+ schedule_type: 'time_bound'
2917
+ device_id: string
2918
+ name?: string | undefined
2919
+ schedule_starts_at: string
2920
+ schedule_ends_at: string
2921
+ created_at: string
2922
+ automatic_heating_enabled?: boolean | undefined
2923
+ automatic_cooling_enabled?: boolean | undefined
2924
+ hvac_mode_setting?:
2925
+ | ('off' | 'heat' | 'cool' | 'heatcool')
2926
+ | undefined
2927
+ cooling_set_point_celsius?: (number | undefined) | undefined
2928
+ heating_set_point_celsius?: (number | undefined) | undefined
2929
+ cooling_set_point_fahrenheit?:
2930
+ | (number | undefined)
2931
+ | undefined
2932
+ heating_set_point_fahrenheit?:
2933
+ | (number | undefined)
2934
+ | undefined
2935
+ manual_override_allowed?: boolean | undefined
2936
+ }
2937
+ | undefined
2938
+ )
2939
+ | undefined
2940
+ }
2941
+ location: {
2942
+ location_name?: string | undefined
2943
+ timezone?: string | undefined
2944
+ } | null
2053
2945
  connected_account_id: string
2054
2946
  workspace_id: string
2055
2947
  errors: Array<{
@@ -2231,14 +3123,311 @@ export interface Routes {
2231
3123
  capabilities_supported: Array<
2232
3124
  'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
2233
3125
  >
2234
- properties: {
3126
+ properties: ({
2235
3127
  online: boolean
2236
3128
  name: string
2237
3129
  model: {
2238
3130
  display_name: string
2239
3131
  }
2240
- } & Record<string, any>
2241
- location?: any
3132
+ has_direct_power?: boolean | undefined
3133
+ battery_level?: number | undefined
3134
+ battery?:
3135
+ | {
3136
+ level: number
3137
+ status: 'critical' | 'low' | 'good' | 'full'
3138
+ }
3139
+ | undefined
3140
+ manufacturer?: string | undefined
3141
+ image_url?: string | undefined
3142
+ image_alt_text?: string | undefined
3143
+ serial_number?: string | undefined
3144
+ } & {
3145
+ august_metadata?:
3146
+ | {
3147
+ lock_id: string
3148
+ lock_name: string
3149
+ house_name: string
3150
+ has_keypad: boolean
3151
+ keypad_battery_level?: string | undefined
3152
+ model?: string | undefined
3153
+ house_id?: string | undefined
3154
+ }
3155
+ | undefined
3156
+ schlage_metadata?:
3157
+ | {
3158
+ device_id: string
3159
+ device_name: string
3160
+ access_code_length: number
3161
+ model?: string | undefined
3162
+ }
3163
+ | undefined
3164
+ smartthings_metadata?:
3165
+ | {
3166
+ device_id: string
3167
+ device_name: string
3168
+ model?: string | undefined
3169
+ location_id?: string | undefined
3170
+ }
3171
+ | undefined
3172
+ lockly_metadata?:
3173
+ | {
3174
+ device_id: string
3175
+ device_name: string
3176
+ model?: string | undefined
3177
+ }
3178
+ | undefined
3179
+ nuki_metadata?:
3180
+ | {
3181
+ device_id: string
3182
+ device_name: string
3183
+ keypad_battery_critical?: boolean | undefined
3184
+ }
3185
+ | undefined
3186
+ kwikset_metadata?:
3187
+ | {
3188
+ device_id: string
3189
+ device_name: string
3190
+ model_number: string
3191
+ }
3192
+ | undefined
3193
+ salto_metadata?:
3194
+ | {
3195
+ lock_id: string
3196
+ customer_reference: string
3197
+ lock_type: string
3198
+ battery_level: string
3199
+ locked_state: string
3200
+ model?: string | undefined
3201
+ }
3202
+ | undefined
3203
+ genie_metadata?:
3204
+ | {
3205
+ device_name: string
3206
+ door_name: string
3207
+ }
3208
+ | undefined
3209
+ brivo_metadata?:
3210
+ | {
3211
+ device_name: string
3212
+ }
3213
+ | undefined
3214
+ igloo_metadata?:
3215
+ | {
3216
+ device_id: string
3217
+ bridge_id: string
3218
+ model?: string | undefined
3219
+ }
3220
+ | undefined
3221
+ noiseaware_metadata?:
3222
+ | {
3223
+ device_model: 'indoor' | 'outdoor'
3224
+ noise_level_nrs: number
3225
+ noise_level_decibel: number
3226
+ device_name: string
3227
+ device_id: string
3228
+ }
3229
+ | undefined
3230
+ minut_metadata?:
3231
+ | {
3232
+ device_id: string
3233
+ device_name: string
3234
+ latest_sensor_values: {
3235
+ temperature: {
3236
+ time: string
3237
+ value: number
3238
+ }
3239
+ sound: {
3240
+ time: string
3241
+ value: number
3242
+ }
3243
+ humidity: {
3244
+ time: string
3245
+ value: number
3246
+ }
3247
+ pressure: {
3248
+ time: string
3249
+ value: number
3250
+ }
3251
+ accelerometer_z: {
3252
+ time: string
3253
+ value: number
3254
+ }
3255
+ }
3256
+ }
3257
+ | undefined
3258
+ two_n_metadata?:
3259
+ | {
3260
+ device_id: number
3261
+ device_name: string
3262
+ }
3263
+ | undefined
3264
+ controlbyweb_metadata?:
3265
+ | {
3266
+ device_id: string
3267
+ device_name: string
3268
+ relay_name: string | null
3269
+ }
3270
+ | undefined
3271
+ ttlock_metadata?:
3272
+ | {
3273
+ lock_id: number
3274
+ lock_alias: string
3275
+ }
3276
+ | undefined
3277
+ seam_bridge_metadata?:
3278
+ | {
3279
+ unlock_method?: ('bridge' | 'doorking') | undefined
3280
+ device_num: number
3281
+ name: string
3282
+ }
3283
+ | undefined
3284
+ igloohome_metadata?:
3285
+ | {
3286
+ device_id: string
3287
+ bridge_id: string
3288
+ device_name: string
3289
+ bridge_name: string
3290
+ }
3291
+ | undefined
3292
+ nest_metadata?:
3293
+ | {
3294
+ nest_device_id: string
3295
+ device_name: string
3296
+ custom_name: string
3297
+ }
3298
+ | undefined
3299
+ ecobee_metadata?:
3300
+ | {
3301
+ ecobee_device_id: string
3302
+ device_name: string
3303
+ min_heating_set_point_fahrenheit?: number | undefined
3304
+ max_heating_set_point_fahrenheit?: number | undefined
3305
+ min_cooling_set_point_fahrenheit?: number | undefined
3306
+ max_cooling_set_point_fahrenheit?: number | undefined
3307
+ min_heating_set_point_celsius?: number | undefined
3308
+ max_heating_set_point_celsius?: number | undefined
3309
+ min_cooling_set_point_celsius?: number | undefined
3310
+ max_cooling_set_point_celsius?: number | undefined
3311
+ min_delta_heat_cool_set_points_fahrenheit?: number | undefined
3312
+ min_delta_heat_cool_set_points_celsius?: number | undefined
3313
+ }
3314
+ | undefined
3315
+ hubitat_metadata?:
3316
+ | {
3317
+ device_id: string
3318
+ device_name: string
3319
+ device_label: string
3320
+ }
3321
+ | undefined
3322
+ }) & {
3323
+ code_constraints?:
3324
+ | (
3325
+ | Array<
3326
+ | {
3327
+ constraint_type:
3328
+ | 'no_zeros'
3329
+ | 'cannot_start_with_12'
3330
+ | 'no_triple_consecutive_ints'
3331
+ | 'cannot_specify_pin_code'
3332
+ | 'pin_code_matches_existing_set'
3333
+ | 'start_date_in_future'
3334
+ }
3335
+ | {
3336
+ constraint_type: 'name_length'
3337
+ min_length?: number | undefined
3338
+ max_length?: number | undefined
3339
+ }
3340
+ >
3341
+ | undefined
3342
+ )
3343
+ | undefined
3344
+ supported_code_lengths?: (number[] | undefined) | undefined
3345
+ max_active_codes_supported?: (number | undefined) | undefined
3346
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
3347
+ has_native_entry_events?: (boolean | undefined) | undefined
3348
+ locked?: (boolean | undefined) | undefined
3349
+ keypad_battery?:
3350
+ | (
3351
+ | {
3352
+ level: number
3353
+ }
3354
+ | undefined
3355
+ )
3356
+ | undefined
3357
+ door_open?: (boolean | undefined) | undefined
3358
+ temperature_fahrenheit?: number | undefined
3359
+ temperature_celsius?: number | undefined
3360
+ relative_humidity?: number | undefined
3361
+ can_enable_automatic_heating?: boolean | undefined
3362
+ can_enable_automatic_cooling?: boolean | undefined
3363
+ available_hvac_mode_settings?:
3364
+ | Array<'off' | 'heat' | 'cool' | 'heatcool'>
3365
+ | undefined
3366
+ is_heating?: boolean | undefined
3367
+ is_cooling?: boolean | undefined
3368
+ is_fan_running?: boolean | undefined
3369
+ is_temporary_manual_override_active?: boolean | undefined
3370
+ current_climate_setting?:
3371
+ | {
3372
+ automatic_heating_enabled: boolean
3373
+ automatic_cooling_enabled: boolean
3374
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
3375
+ cooling_set_point_celsius?: number | undefined
3376
+ heating_set_point_celsius?: number | undefined
3377
+ cooling_set_point_fahrenheit?: number | undefined
3378
+ heating_set_point_fahrenheit?: number | undefined
3379
+ manual_override_allowed: boolean
3380
+ }
3381
+ | undefined
3382
+ default_climate_setting?:
3383
+ | (
3384
+ | {
3385
+ automatic_heating_enabled: boolean
3386
+ automatic_cooling_enabled: boolean
3387
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heatcool'
3388
+ cooling_set_point_celsius?: number | undefined
3389
+ heating_set_point_celsius?: number | undefined
3390
+ cooling_set_point_fahrenheit?: number | undefined
3391
+ heating_set_point_fahrenheit?: number | undefined
3392
+ manual_override_allowed: boolean
3393
+ }
3394
+ | undefined
3395
+ )
3396
+ | undefined
3397
+ is_climate_setting_schedule_active?: boolean | undefined
3398
+ active_climate_setting_schedule?:
3399
+ | (
3400
+ | {
3401
+ climate_setting_schedule_id: string
3402
+ schedule_type: 'time_bound'
3403
+ device_id: string
3404
+ name?: string | undefined
3405
+ schedule_starts_at: string
3406
+ schedule_ends_at: string
3407
+ created_at: string
3408
+ automatic_heating_enabled?: boolean | undefined
3409
+ automatic_cooling_enabled?: boolean | undefined
3410
+ hvac_mode_setting?:
3411
+ | ('off' | 'heat' | 'cool' | 'heatcool')
3412
+ | undefined
3413
+ cooling_set_point_celsius?: (number | undefined) | undefined
3414
+ heating_set_point_celsius?: (number | undefined) | undefined
3415
+ cooling_set_point_fahrenheit?:
3416
+ | (number | undefined)
3417
+ | undefined
3418
+ heating_set_point_fahrenheit?:
3419
+ | (number | undefined)
3420
+ | undefined
3421
+ manual_override_allowed?: boolean | undefined
3422
+ }
3423
+ | undefined
3424
+ )
3425
+ | undefined
3426
+ }
3427
+ location: {
3428
+ location_name?: string | undefined
3429
+ timezone?: string | undefined
3430
+ } | null
2242
3431
  connected_account_id: string
2243
3432
  workspace_id: string
2244
3433
  errors: Array<{