@seamapi/http 2.49.0 → 2.51.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 (66) hide show
  1. package/lib/resources/access-grant.d.ts +0 -4
  2. package/lib/resources/acs-access-group.d.ts +0 -8
  3. package/lib/resources/acs-system.d.ts +14 -16
  4. package/lib/resources/acs-user.d.ts +0 -4
  5. package/lib/resources/client-session.d.ts +0 -5
  6. package/lib/resources/connect-webview.d.ts +1 -1
  7. package/lib/resources/connected-account.d.ts +1 -27
  8. package/lib/resources/device-provider.d.ts +1 -1
  9. package/lib/resources/device.d.ts +208 -241
  10. package/lib/resources/event.d.ts +4 -43
  11. package/lib/resources/phone.d.ts +30 -0
  12. package/lib/resources/unmanaged-access-grant.d.ts +0 -4
  13. package/lib/resources/unmanaged-device.d.ts +34 -31
  14. package/lib/resources/workspace.d.ts +0 -5
  15. package/lib/routes/access-codes/access-codes.d.ts +0 -4
  16. package/lib/routes/access-grants/access-grants.d.ts +0 -25
  17. package/lib/routes/acs/entrances/entrances.d.ts +0 -4
  18. package/lib/routes/acs/users/users.d.ts +1 -9
  19. package/lib/routes/acs/users/users.js +0 -1
  20. package/lib/routes/acs/users/users.js.map +1 -1
  21. package/lib/routes/client-sessions/client-sessions.d.ts +1 -16
  22. package/lib/routes/client-sessions/client-sessions.js +0 -1
  23. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  24. package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
  25. package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
  26. package/lib/routes/customers/customers.d.ts +4 -12
  27. package/lib/routes/devices/devices.d.ts +3 -7
  28. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  29. package/lib/routes/locks/locks.d.ts +3 -3
  30. package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
  31. package/lib/routes/spaces/spaces.d.ts +13 -0
  32. package/lib/routes/thermostats/thermostats.d.ts +3 -13
  33. package/lib/routes/workspaces/workspaces.d.ts +0 -21
  34. package/lib/version.d.ts +1 -1
  35. package/lib/version.js +1 -1
  36. package/package.json +2 -2
  37. package/src/lib/resources/access-grant.ts +0 -5
  38. package/src/lib/resources/acs-access-group.ts +0 -20
  39. package/src/lib/resources/acs-system.ts +17 -35
  40. package/src/lib/resources/acs-user.ts +0 -4
  41. package/src/lib/resources/client-session.ts +0 -6
  42. package/src/lib/resources/connect-webview.ts +1 -0
  43. package/src/lib/resources/connected-account.ts +1 -28
  44. package/src/lib/resources/device-provider.ts +4 -0
  45. package/src/lib/resources/device.ts +2351 -2388
  46. package/src/lib/resources/event.ts +4 -53
  47. package/src/lib/resources/phone.ts +36 -0
  48. package/src/lib/resources/unmanaged-access-grant.ts +0 -5
  49. package/src/lib/resources/unmanaged-device.ts +119 -105
  50. package/src/lib/resources/workspace.ts +0 -6
  51. package/src/lib/routes/access-codes/access-codes.ts +0 -4
  52. package/src/lib/routes/access-grants/access-grants.ts +0 -27
  53. package/src/lib/routes/acs/entrances/entrances.ts +0 -4
  54. package/src/lib/routes/acs/users/users.ts +0 -10
  55. package/src/lib/routes/client-sessions/client-sessions.ts +0 -17
  56. package/src/lib/routes/connect-webviews/connect-webviews.ts +5 -0
  57. package/src/lib/routes/connected-accounts/connected-accounts.ts +1 -0
  58. package/src/lib/routes/customers/customers.ts +4 -14
  59. package/src/lib/routes/devices/devices.ts +14 -4
  60. package/src/lib/routes/devices/unmanaged/unmanaged.ts +14 -0
  61. package/src/lib/routes/locks/locks.ts +3 -0
  62. package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
  63. package/src/lib/routes/spaces/spaces.ts +16 -0
  64. package/src/lib/routes/thermostats/thermostats.ts +3 -10
  65. package/src/lib/routes/workspaces/workspaces.ts +0 -21
  66. package/src/lib/version.ts +1 -1
@@ -7,6 +7,10 @@
7
7
  * Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
8
8
  */
9
9
  export type Device = {
10
+ /**
11
+ * Air quality index, if the device measures it.
12
+ */
13
+ air_quality_index?: number | undefined
10
14
  /**
11
15
  * Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
12
16
  */
@@ -105,8 +109,17 @@ export type Device = {
105
109
  | 'thermostat'
106
110
  | 'battery'
107
111
  | 'phone'
112
+ | 'pool'
108
113
  >
109
114
 
115
+ /**
116
+ * Carbon dioxide concentration in parts per million, if the device measures it.
117
+ */
118
+ co2_ppm?: number | undefined
119
+ /**
120
+ * Carbon monoxide concentration in parts per million, if the device measures it.
121
+ */
122
+ co_ppm?: number | undefined
110
123
  /**
111
124
  * Unique identifier for the account associated with the device.
112
125
  */
@@ -210,6 +223,7 @@ export type Device = {
210
223
  | 'omnitec_lock'
211
224
  | 'kisi_lock'
212
225
  | 'aqara_lock'
226
+ | 'tuya_lock'
213
227
  | 'eufy_lock'
214
228
  | 'keynest_key'
215
229
  | 'noiseaware_activity_zone'
@@ -219,6 +233,7 @@ export type Device = {
219
233
  | 'honeywell_resideo_thermostat'
220
234
  | 'tado_thermostat'
221
235
  | 'sensi_thermostat'
236
+ | 'sensibo_thermostat'
222
237
  | 'smartthings_thermostat'
223
238
  | 'ios_phone'
224
239
  | 'android_phone'
@@ -228,6 +243,9 @@ export type Device = {
228
243
  | 'reolink_camera'
229
244
  | 'unifi_protect_camera'
230
245
  | 'sonos_speaker'
246
+ | 'alertify_sensor'
247
+ | 'hayward_pool_system'
248
+ | 'hayward_pool'
231
249
 
232
250
  /**
233
251
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
@@ -586,11 +604,23 @@ export type Device = {
586
604
  }
587
605
  >
588
606
 
607
+ /**
608
+ * Estimated number of occupants detected by the device.
609
+ */
610
+ estimated_occupant_count?: number | undefined
589
611
  /**
590
612
  * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
591
613
  */
592
614
  is_managed: true
593
615
 
616
+ /**
617
+ * Indicates whether the device detects occupancy.
618
+ */
619
+ is_occupancy_detected?: boolean | undefined
620
+ /**
621
+ * Indicates whether the device detects smoking, if the device measures it.
622
+ */
623
+ is_smoking_detected?: boolean | undefined
594
624
  /**
595
625
  * Location information for the device.
596
626
  */
@@ -608,2426 +638,2323 @@ export type Device = {
608
638
  * Time zone of the device location.
609
639
  */
610
640
  time_zone?: string | undefined
641
+ }
642
+ | undefined
643
+ /**
644
+ * Mold risk level as reported by the device, if the device measures it.
645
+ */
646
+ mold_risk_level?: string | undefined
647
+ /**
648
+ * Additional sensors of the same kind on the device, each with a stable `sensor_name`. Present only when the device has more than one sensor of a kind or no single main sensor.
649
+ */
650
+ named_sensors?:
651
+ | Array<{
611
652
  /**
612
- * Time zone of the device location.
613
- * @deprecated Use `time_zone` instead.
653
+ * Air quality index, if the device measures it.
614
654
  */
615
- timezone?: string | undefined
616
- }
655
+ air_quality_index?: number | undefined
656
+ /**
657
+ * Carbon dioxide concentration in parts per million, if the device measures it.
658
+ */
659
+ co2_ppm?: number | undefined
660
+ /**
661
+ * Carbon monoxide concentration in parts per million, if the device measures it.
662
+ */
663
+ co_ppm?: number | undefined
664
+ /**
665
+ * Display name of the sensor. Defaults to `sensor_name`.
666
+ */
667
+ display_name: string
668
+
669
+ /**
670
+ * Estimated number of occupants detected by the device.
671
+ */
672
+ estimated_occupant_count?: number | undefined
673
+ /**
674
+ * Indicates whether the device detects occupancy.
675
+ */
676
+ is_occupancy_detected?: boolean | undefined
677
+ /**
678
+ * Indicates whether the device detects smoking, if the device measures it.
679
+ */
680
+ is_smoking_detected?: boolean | undefined
681
+ /**
682
+ * Mold risk level as reported by the device, if the device measures it.
683
+ */
684
+ mold_risk_level?: string | undefined
685
+ /**
686
+ * Noise level in decibels, if the device measures noise.
687
+ */
688
+ noise_level_decibels?: number | undefined
689
+ /**
690
+ * Noise level as a Noise Risk Score (NRS), if the device reports one.
691
+ */
692
+ noise_level_nrs?: number | undefined
693
+ /**
694
+ * Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
695
+ */
696
+ relative_humidity?: number | undefined
697
+ /**
698
+ * Stable, hardware-defined name of the sensor, such as a port number.
699
+ */
700
+ sensor_name: string
701
+
702
+ /**
703
+ * Temperature in °C, if the device measures temperature.
704
+ */
705
+ temperature_celsius?: number | undefined
706
+ /**
707
+ * Temperature in °F, if the device measures temperature.
708
+ */
709
+ temperature_fahrenheit?: number | undefined
710
+ }>
617
711
  | undefined
618
712
  /**
619
713
  * Optional nickname to describe the device, settable through Seam.
620
714
  */
621
715
  nickname?: string | undefined
716
+ /**
717
+ * Noise level in decibels, if the device measures noise.
718
+ */
719
+ noise_level_decibels?: number | undefined
720
+ /**
721
+ * Noise level as a Noise Risk Score (NRS), if the device reports one.
722
+ */
723
+ noise_level_nrs?: number | undefined
622
724
  /**
623
725
  * Properties of the device.
624
726
  */
625
- properties: {
626
- /**
627
- * Accessory keypad properties and state.
628
- */
629
- accessory_keypad?:
630
- | {
631
- /**
632
- * Keypad battery properties.
633
- */
634
- battery?:
635
- | {
636
- level: number
637
- }
638
- | undefined
727
+ properties?:
728
+ | {
729
+ /**
730
+ * Accessory keypad properties and state.
731
+ */
732
+ accessory_keypad?:
733
+ | {
734
+ /**
735
+ * Keypad battery properties.
736
+ */
737
+ battery?:
738
+ | {
739
+ level: number
740
+ }
741
+ | undefined
742
+ /**
743
+ * Indicates if an accessory keypad is connected to the device.
744
+ */
745
+ is_connected: boolean
746
+ }
747
+ | undefined
748
+ /**
749
+ * Appearance-related properties, as reported by the device.
750
+ */
751
+ appearance: {
639
752
  /**
640
- * Indicates if an accessory keypad is connected to the device.
753
+ * Name of the device as seen from the provider API and application, not settable through Seam.
641
754
  */
642
- is_connected: boolean
755
+ name: string
643
756
  }
644
- | undefined
645
- /**
646
- * Appearance-related properties, as reported by the device.
647
- */
648
- appearance: {
649
- /**
650
- * Name of the device as seen from the provider API and application, not settable through Seam.
651
- */
652
- name: string
653
- }
654
757
 
655
- /**
656
- * Represents the current status of the battery charge level.
657
- */
658
- battery?:
659
- | {
758
+ /**
759
+ * Represents the current status of the battery charge level.
760
+ */
761
+ battery?:
762
+ | {
763
+ /**
764
+ * Battery charge level as a value between 0 and 1, inclusive.
765
+ */
766
+ level: number
767
+
768
+ /**
769
+ * 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.
770
+ */
771
+ status: 'critical' | 'low' | 'good' | 'full'
772
+ }
773
+ | undefined
774
+ /**
775
+ * Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
776
+ */
777
+ battery_level?: number | undefined
778
+ /**
779
+ * Array of noise threshold IDs that are currently triggering.
780
+ */
781
+ currently_triggering_noise_threshold_ids?: Array<string> | undefined
782
+ /**
783
+ * Indicates whether the device has direct power.
784
+ */
785
+ has_direct_power?: boolean | undefined
786
+ /**
787
+ * Alt text for the device image.
788
+ */
789
+ image_alt_text?: string | undefined
790
+ /**
791
+ * Image URL for the device.
792
+ */
793
+ image_url?: string | undefined
794
+ /**
795
+ * 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.
796
+ */
797
+ manufacturer?: string | undefined
798
+ /**
799
+ * Device model-related properties.
800
+ */
801
+ model: {
660
802
  /**
661
- * Battery charge level as a value between 0 and 1, inclusive.
803
+ * Indicates whether the device can connect a accessory keypad.
662
804
  */
663
- level: number
805
+ can_connect_accessory_keypad?: boolean | undefined
806
+ /**
807
+ * Display name of the device model.
808
+ */
809
+ display_name: string
664
810
 
665
811
  /**
666
- * 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.
812
+ * Indicates whether the device has a built in accessory keypad.
813
+ */
814
+ has_built_in_keypad?: boolean | undefined
815
+ /**
816
+ * Display name that corresponds to the manufacturer-specific terminology for the device.
667
817
  */
668
- status: 'critical' | 'low' | 'good' | 'full'
818
+ manufacturer_display_name: string
669
819
  }
670
- | undefined
671
- /**
672
- * Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
673
- */
674
- battery_level?: number | undefined
675
- /**
676
- * Array of noise threshold IDs that are currently triggering.
677
- */
678
- currently_triggering_noise_threshold_ids?: Array<string> | undefined
679
- /**
680
- * Indicates whether the device has direct power.
681
- */
682
- has_direct_power?: boolean | undefined
683
- /**
684
- * Alt text for the device image.
685
- */
686
- image_alt_text?: string | undefined
687
- /**
688
- * Image URL for the device.
689
- */
690
- image_url?: string | undefined
691
- /**
692
- * 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.
693
- */
694
- manufacturer?: string | undefined
695
- /**
696
- * Device model-related properties.
697
- */
698
- model: {
699
- /**
700
- * @deprecated use device.properties.model.can_connect_accessory_keypad
701
- */
702
- accessory_keypad_supported?: boolean | undefined
703
- /**
704
- * Indicates whether the device can connect a accessory keypad.
705
- */
706
- can_connect_accessory_keypad?: boolean | undefined
707
- /**
708
- * Display name of the device model.
709
- */
710
- display_name: string
711
-
712
- /**
713
- * Indicates whether the device has a built in accessory keypad.
714
- */
715
- has_built_in_keypad?: boolean | undefined
716
- /**
717
- * Display name that corresponds to the manufacturer-specific terminology for the device.
718
- */
719
- manufacturer_display_name: string
720
-
721
- /**
722
- * @deprecated use device.can_program_offline_access_codes.
723
- */
724
- offline_access_codes_supported?: boolean | undefined
725
- /**
726
- * @deprecated use device.can_program_online_access_codes.
727
- */
728
- online_access_codes_supported?: boolean | undefined
729
- }
730
820
 
731
- /**
732
- * Name of the device.
733
- * @deprecated use device.display_name instead
734
- */
735
- name: string
821
+ /**
822
+ * Name of the device.
823
+ * @deprecated use device.display_name instead
824
+ */
825
+ name: string
826
+
827
+ /**
828
+ * Indicates current noise level in decibels, if the device supports noise detection.
829
+ */
830
+ noise_level_decibels?: number | undefined
831
+ /**
832
+ * Indicates whether the device is online.
833
+ */
834
+ online: boolean
835
+
836
+ /**
837
+ * Serial number of the device.
838
+ */
839
+ serial_number?: string | undefined
840
+ /**
841
+ * ASSA ABLOY Credential Service metadata for the phone.
842
+ */
843
+ assa_abloy_credential_service_metadata?:
844
+ | {
845
+ /**
846
+ * Endpoints associated with the phone.
847
+ */
848
+ endpoints?:
849
+ | Array<{
850
+ /**
851
+ * ID of the associated endpoint.
852
+ */
853
+ endpoint_id?: string | undefined
854
+ /**
855
+ * Indicated whether the endpoint is active.
856
+ */
857
+ is_active?: boolean | undefined
858
+ }>
859
+ | undefined
860
+ /**
861
+ * Indicates whether the credential service has active endpoints associated with the phone.
862
+ */
863
+ has_active_endpoint?: boolean | undefined
864
+ }
865
+ | undefined
866
+ /**
867
+ * Salto Space credential service metadata for the phone.
868
+ */
869
+ salto_space_credential_service_metadata?:
870
+ | {
871
+ /**
872
+ * Indicates whether the credential service has an active associated phone.
873
+ */
874
+ has_active_phone?: boolean | undefined
875
+ }
876
+ | undefined
877
+ /**
878
+ * Metadata for an Akiles device.
879
+ */
880
+ akiles_metadata?:
881
+ | {
882
+ /**
883
+ * Gadget ID for an Akiles device.
884
+ */
885
+ gadget_id?: string | undefined
886
+ /**
887
+ * Gadget name for an Akiles device.
888
+ */
889
+ gadget_name?: string | undefined
890
+ /**
891
+ * Product name for an Akiles device.
892
+ */
893
+ product_name?: string | undefined
894
+ }
895
+ | undefined
896
+ /**
897
+ * Metadata for an Aqara device.
898
+ */
899
+ aqara_metadata?:
900
+ | {
901
+ /**
902
+ * Device name for an Aqara device.
903
+ */
904
+ device_name?: string | undefined
905
+ /**
906
+ * Device ID (did) for an Aqara device.
907
+ */
908
+ did?: string | undefined
909
+ /**
910
+ * Firmware version for an Aqara device.
911
+ */
912
+ firmware_version?: string | null | undefined
913
+ /**
914
+ * Model identifier for an Aqara device.
915
+ */
916
+ model?: string | undefined
917
+ /**
918
+ * Model type for an Aqara device.
919
+ */
920
+ model_type?: number | undefined
921
+ /**
922
+ * Parent gateway device ID for an Aqara device.
923
+ */
924
+ parent_did?: string | undefined
925
+ /**
926
+ * Position (room) ID for an Aqara device.
927
+ */
928
+ position_id?: string | null | undefined
929
+ /**
930
+ * Time zone reported for an Aqara device (e.g. GMT-07:00).
931
+ */
932
+ time_zone?: string | null | undefined
933
+ }
934
+ | undefined
935
+ /**
936
+ * Metadata for an Arlo camera.
937
+ */
938
+ arlo_metadata?:
939
+ | {
940
+ /**
941
+ * Device ID reported by Arlo.
942
+ */
943
+ device_id?: string | undefined
944
+ /**
945
+ * Device name reported by Arlo.
946
+ */
947
+ device_name?: string | undefined
948
+ /**
949
+ * Firmware version reported by Arlo.
950
+ */
951
+ firmware_version?: string | undefined
952
+ /**
953
+ * Hardware version reported by Arlo.
954
+ */
955
+ hardware_version?: string | undefined
956
+ /**
957
+ * Model ID reported by Arlo.
958
+ */
959
+ model_id?: string | undefined
960
+ }
961
+ | undefined
962
+ /**
963
+ * Metadata for an ASSA ABLOY Vostio system.
964
+ */
965
+ assa_abloy_vostio_metadata?:
966
+ | {
967
+ /**
968
+ * Encoder name for an ASSA ABLOY Vostio system.
969
+ */
970
+ encoder_name?: string | undefined
971
+ }
972
+ | undefined
973
+ /**
974
+ * Metadata for an August device.
975
+ */
976
+ august_metadata?:
977
+ | {
978
+ /**
979
+ * Indicates whether an August device has a keypad.
980
+ */
981
+ has_keypad?: boolean | undefined
982
+ /**
983
+ * House ID for an August device.
984
+ */
985
+ house_id?: string | undefined
986
+ /**
987
+ * House name for an August device.
988
+ */
989
+ house_name?: string | undefined
990
+ /**
991
+ * Keypad battery level for an August device.
992
+ */
993
+ keypad_battery_level?: string | undefined
994
+ /**
995
+ * Lock ID for an August device.
996
+ */
997
+ lock_id?: string | undefined
998
+ /**
999
+ * Lock name for an August device.
1000
+ */
1001
+ lock_name?: string | undefined
1002
+ /**
1003
+ * Model for an August device.
1004
+ */
1005
+ model?: string | undefined
1006
+ }
1007
+ | undefined
1008
+ /**
1009
+ * Metadata for an Avigilon Alta system.
1010
+ */
1011
+ avigilon_alta_metadata?:
1012
+ | {
1013
+ /**
1014
+ * Entry name for an Avigilon Alta system.
1015
+ */
1016
+ entry_name?: string | undefined
1017
+ /**
1018
+ * Total count of entry relays for an Avigilon Alta system.
1019
+ */
1020
+ entry_relays_total_count?: number | undefined
1021
+ /**
1022
+ * Organization name for an Avigilon Alta system.
1023
+ */
1024
+ org_name?: string | undefined
1025
+ /**
1026
+ * Site ID for an Avigilon Alta system.
1027
+ */
1028
+ site_id?: number | undefined
1029
+ /**
1030
+ * Site name for an Avigilon Alta system.
1031
+ */
1032
+ site_name?: string | undefined
1033
+ /**
1034
+ * Zone ID for an Avigilon Alta system.
1035
+ */
1036
+ zone_id?: number | undefined
1037
+ /**
1038
+ * Zone name for an Avigilon Alta system.
1039
+ */
1040
+ zone_name?: string | undefined
1041
+ }
1042
+ | undefined
1043
+ /**
1044
+ * Metadata for a Brivo device.
1045
+ */
1046
+ brivo_metadata?:
1047
+ | {
1048
+ /**
1049
+ * Indicates whether the Brivo access point has activation (remote unlock) enabled.
1050
+ */
1051
+ activation_enabled?: boolean | undefined
1052
+ /**
1053
+ * Device name for a Brivo device.
1054
+ */
1055
+ device_name?: string | undefined
1056
+ }
1057
+ | undefined
1058
+ /**
1059
+ * Metadata for a ControlByWeb device.
1060
+ */
1061
+ controlbyweb_metadata?:
1062
+ | {
1063
+ /**
1064
+ * Device ID for a ControlByWeb device.
1065
+ */
1066
+ device_id?: string | undefined
1067
+ /**
1068
+ * Device name for a ControlByWeb device.
1069
+ */
1070
+ device_name?: string | undefined
1071
+ /**
1072
+ * Relay name for a ControlByWeb device.
1073
+ */
1074
+ relay_name?: string | null | undefined
1075
+ }
1076
+ | undefined
1077
+ /**
1078
+ * Metadata for a dormakaba Oracode Homeowner's Portal device.
1079
+ */
1080
+ dormakaba_oracode_iho_metadata?:
1081
+ | {
1082
+ /**
1083
+ * Door ID for a dormakaba Oracode Homeowner's Portal device.
1084
+ */
1085
+ door_id?: number | undefined
1086
+ /**
1087
+ * Name of the door for a dormakaba Oracode Homeowner's Portal device.
1088
+ */
1089
+ door_name?: string | undefined
1090
+ /**
1091
+ * IANA time zone for a dormakaba Oracode Homeowner's Portal device.
1092
+ */
1093
+ iana_timezone?: string | undefined
1094
+ /**
1095
+ * User levels for a dormakaba Oracode Homeowner's Portal device.
1096
+ */
1097
+ user_levels?:
1098
+ | Array<{
1099
+ user_level?: number | undefined
1100
+
1101
+ user_level_check_in_time?: string | undefined
1102
+
1103
+ user_level_check_out_time?: string | undefined
1104
+
1105
+ user_level_name?: string | undefined
1106
+
1107
+ user_level_type?: string | undefined
1108
+ }>
1109
+ | undefined
1110
+ }
1111
+ | undefined
1112
+ /**
1113
+ * Metadata for a dormakaba Oracode device.
1114
+ */
1115
+ dormakaba_oracode_metadata?:
1116
+ | {
1117
+ /**
1118
+ * Device ID for a dormakaba Oracode device.
1119
+ */
1120
+ device_id?: string | undefined
1121
+ /**
1122
+ * Door ID for a dormakaba Oracode device.
1123
+ */
1124
+ door_id?: number | undefined
1125
+ /**
1126
+ * Indicates whether a door is wireless for a dormakaba Oracode device.
1127
+ */
1128
+ door_is_wireless?: boolean | undefined
1129
+ /**
1130
+ * Door name for a dormakaba Oracode device.
1131
+ */
1132
+ door_name?: string | undefined
1133
+ /**
1134
+ * IANA time zone for a dormakaba Oracode device.
1135
+ */
1136
+ iana_timezone?: string | undefined
1137
+ /**
1138
+ * Predefined time slots for a dormakaba Oracode device.
1139
+ */
1140
+ predefined_time_slots?:
1141
+ | Array<{
1142
+ /**
1143
+ * Check in time for a time slot for a dormakaba Oracode device.
1144
+ */
1145
+ check_in_time?: string | undefined
1146
+ /**
1147
+ * Checkout time for a time slot for a dormakaba Oracode device.
1148
+ */
1149
+ check_out_time?: string | undefined
1150
+ /**
1151
+ * ID of a user level for a dormakaba Oracode device.
1152
+ */
1153
+ dormakaba_oracode_user_level_id?: string | undefined
1154
+ /**
1155
+ * Prefix for a user level for a dormakaba Oracode device.
1156
+ */
1157
+ dormakaba_oracode_user_level_prefix?: number | undefined
1158
+ /**
1159
+ * Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.
1160
+ */
1161
+ is_24_hour?: boolean | undefined
1162
+ /**
1163
+ * Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.
1164
+ */
1165
+ is_biweekly_mode?: boolean | undefined
1166
+ /**
1167
+ * Indicates whether a time slot for a dormakaba Oracode device is a master time slot.
1168
+ */
1169
+ is_master?: boolean | undefined
1170
+ /**
1171
+ * Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.
1172
+ */
1173
+ is_one_shot?: boolean | undefined
1174
+ /**
1175
+ * Name of a time slot for a dormakaba Oracode device.
1176
+ */
1177
+ name?: string | undefined
1178
+ /**
1179
+ * Prefix for a time slot for a dormakaba Oracode device.
1180
+ */
1181
+ prefix?: number | undefined
1182
+ }>
1183
+ | undefined
1184
+ /**
1185
+ * Site name for a dormakaba Oracode device.
1186
+ */
1187
+ site_name?: string | undefined
1188
+ }
1189
+ | undefined
1190
+ /**
1191
+ * Metadata for an ecobee device.
1192
+ */
1193
+ ecobee_metadata?:
1194
+ | {
1195
+ /**
1196
+ * Device name for an ecobee device.
1197
+ */
1198
+ device_name?: string | undefined
1199
+ /**
1200
+ * Device ID for an ecobee device.
1201
+ */
1202
+ ecobee_device_id?: string | undefined
1203
+ }
1204
+ | undefined
1205
+ /**
1206
+ * Metadata for a Eufy device.
1207
+ */
1208
+ eufy_metadata?:
1209
+ | {
1210
+ device_id?: string | undefined
1211
+
1212
+ device_name?: string | undefined
1213
+
1214
+ model?: string | undefined
1215
+ }
1216
+ | undefined
1217
+ /**
1218
+ * Metadata for a 4SUITES device.
1219
+ */
1220
+ four_suites_metadata?:
1221
+ | {
1222
+ /**
1223
+ * Device ID for a 4SUITES device.
1224
+ */
1225
+ device_id?: number | undefined
1226
+ /**
1227
+ * Device name for a 4SUITES device.
1228
+ */
1229
+ device_name?: string | undefined
1230
+ /**
1231
+ * Reclose delay, in seconds, for a 4SUITES device.
1232
+ */
1233
+ reclose_delay_in_seconds?: number | undefined
1234
+ }
1235
+ | undefined
1236
+ /**
1237
+ * Metadata for a Genie device.
1238
+ */
1239
+ genie_metadata?:
1240
+ | {
1241
+ /**
1242
+ * Lock name for a Genie device.
1243
+ */
1244
+ device_name?: string | undefined
1245
+ /**
1246
+ * Door name for a Genie device.
1247
+ */
1248
+ door_name?: string | undefined
1249
+ }
1250
+ | undefined
1251
+ /**
1252
+ * Metadata for a Honeywell Resideo device.
1253
+ */
1254
+ honeywell_resideo_metadata?:
1255
+ | {
1256
+ /**
1257
+ * Device name for a Honeywell Resideo device.
1258
+ */
1259
+ device_name?: string | undefined
1260
+ /**
1261
+ * Device ID for a Honeywell Resideo device.
1262
+ */
1263
+ honeywell_resideo_device_id?: string | undefined
1264
+ }
1265
+ | undefined
1266
+ /**
1267
+ * Metadata for an igloo device.
1268
+ */
1269
+ igloo_metadata?:
1270
+ | {
1271
+ /**
1272
+ * Bridge ID for an igloo device.
1273
+ */
1274
+ bridge_id?: string | undefined
1275
+ /**
1276
+ * Device ID for an igloo device.
1277
+ */
1278
+ device_id?: string | undefined
1279
+ /**
1280
+ * Model for an igloo device.
1281
+ */
1282
+ model?: string | undefined
1283
+ }
1284
+ | undefined
1285
+ /**
1286
+ * Metadata for an igloohome device.
1287
+ */
1288
+ igloohome_metadata?:
1289
+ | {
1290
+ /**
1291
+ * Bridge ID for an igloohome device.
1292
+ */
1293
+ bridge_id?: string | undefined
1294
+ /**
1295
+ * Bridge name for an igloohome device.
1296
+ */
1297
+ bridge_name?: string | undefined
1298
+ /**
1299
+ * Device ID for an igloohome device.
1300
+ */
1301
+ device_id?: string | undefined
1302
+ /**
1303
+ * Device name for an igloohome device.
1304
+ */
1305
+ device_name?: string | undefined
1306
+ /**
1307
+ * Indicates whether a keypad is linked to a bridge for an igloohome device.
1308
+ */
1309
+ is_accessory_keypad_linked_to_bridge?: boolean | undefined
1310
+ /**
1311
+ * Keypad ID for an igloohome device.
1312
+ */
1313
+ keypad_id?: string | undefined
1314
+ }
1315
+ | undefined
1316
+ /**
1317
+ * Metadata for a KeyNest device.
1318
+ */
1319
+ keynest_metadata?:
1320
+ | {
1321
+ /**
1322
+ * Address for a KeyNest device.
1323
+ */
1324
+ address?: string | null | undefined
1325
+ /**
1326
+ * Current or last store ID for a KeyNest device.
1327
+ */
1328
+ current_or_last_store_id?: number | undefined
1329
+ /**
1330
+ * Current status for a KeyNest device.
1331
+ */
1332
+ current_status?: string | null | undefined
1333
+ /**
1334
+ * Current user company for a KeyNest device.
1335
+ */
1336
+ current_user_company?: string | null | undefined
1337
+ /**
1338
+ * Current user email for a KeyNest device.
1339
+ */
1340
+ current_user_email?: string | null | undefined
1341
+ /**
1342
+ * Current user name for a KeyNest device.
1343
+ */
1344
+ current_user_name?: string | null | undefined
1345
+ /**
1346
+ * Current user phone number for a KeyNest device.
1347
+ */
1348
+ current_user_phone_number?: string | null | undefined
1349
+ /**
1350
+ * Default office ID for a KeyNest device.
1351
+ */
1352
+ default_office_id?: number | undefined
1353
+ /**
1354
+ * Device name for a KeyNest device.
1355
+ */
1356
+ device_name?: string | undefined
1357
+ /**
1358
+ * Fob ID for a KeyNest device.
1359
+ */
1360
+ fob_id?: number | undefined
1361
+ /**
1362
+ * Handover method for a KeyNest device.
1363
+ */
1364
+ handover_method?: string | null | undefined
1365
+ /**
1366
+ * Whether the KeyNest device has a photo.
1367
+ */
1368
+ has_photo?: boolean | undefined
1369
+ /**
1370
+ * Whether the key is in a locker that does not support the access codes API.
1371
+ */
1372
+ is_quadient_locker?: boolean | undefined
1373
+ /**
1374
+ * Key ID for a KeyNest device.
1375
+ */
1376
+ key_id?: string | undefined
1377
+ /**
1378
+ * Key notes for a KeyNest device.
1379
+ */
1380
+ key_notes?: string | null | undefined
1381
+ /**
1382
+ * KeyNest app user for a KeyNest device.
1383
+ */
1384
+ keynest_app_user?: string | null | undefined
1385
+ /**
1386
+ * Last movement timestamp for a KeyNest device.
1387
+ */
1388
+ last_movement?: string | undefined
1389
+ /**
1390
+ * Property ID for a KeyNest device.
1391
+ */
1392
+ property_id?: string | null | undefined
1393
+ /**
1394
+ * Property postcode for a KeyNest device.
1395
+ */
1396
+ property_postcode?: string | null | undefined
1397
+ /**
1398
+ * Status type for a KeyNest device.
1399
+ */
1400
+ status_type?: string | undefined
1401
+ /**
1402
+ * Subscription plan for a KeyNest device.
1403
+ */
1404
+ subscription_plan?: string | undefined
1405
+ }
1406
+ | undefined
1407
+ /**
1408
+ * Metadata for a Kisi device.
1409
+ */
1410
+ kisi_metadata?:
1411
+ | {
1412
+ /**
1413
+ * Description for a Kisi device.
1414
+ */
1415
+ description?: string | null | undefined
1416
+ /**
1417
+ * Lock ID for a Kisi device.
1418
+ */
1419
+ lock_id?: number | undefined
1420
+ /**
1421
+ * Lock name for a Kisi device.
1422
+ */
1423
+ lock_name?: string | undefined
1424
+ /**
1425
+ * Place name for a Kisi device.
1426
+ */
1427
+ place_name?: string | null | undefined
1428
+ }
1429
+ | undefined
1430
+ /**
1431
+ * Metadata for a Korelock device.
1432
+ */
1433
+ korelock_metadata?:
1434
+ | {
1435
+ /**
1436
+ * Device ID for a Korelock device.
1437
+ */
1438
+ device_id?: string | undefined
1439
+ /**
1440
+ * Device name for a Korelock device.
1441
+ */
1442
+ device_name?: string | undefined
1443
+ /**
1444
+ * Firmware version for a Korelock device.
1445
+ */
1446
+ firmware_version?: string | undefined
1447
+ /**
1448
+ * Location ID for a Korelock device. Required for timebound access codes.
1449
+ */
1450
+ location_id?: string | null | undefined
1451
+ /**
1452
+ * Model code for a Korelock device.
1453
+ */
1454
+ model_code?: string | undefined
1455
+ /**
1456
+ * Serial number for a Korelock device.
1457
+ */
1458
+ serial_number?: string | undefined
1459
+ /**
1460
+ * WiFi signal strength (0-1) for a Korelock device.
1461
+ */
1462
+ wifi_signal_strength?: number | undefined
1463
+ }
1464
+ | undefined
1465
+ /**
1466
+ * Metadata for a Kwikset device.
1467
+ */
1468
+ kwikset_metadata?:
1469
+ | {
1470
+ /**
1471
+ * Device ID for a Kwikset device.
1472
+ */
1473
+ device_id?: string | undefined
1474
+ /**
1475
+ * Device name for a Kwikset device.
1476
+ */
1477
+ device_name?: string | undefined
1478
+ /**
1479
+ * Model number for a Kwikset device.
1480
+ */
1481
+ model_number?: string | undefined
1482
+ }
1483
+ | undefined
1484
+ /**
1485
+ * Metadata for a Lockly device.
1486
+ */
1487
+ lockly_metadata?:
1488
+ | {
1489
+ /**
1490
+ * Device ID for a Lockly device.
1491
+ */
1492
+ device_id?: string | undefined
1493
+ /**
1494
+ * Device name for a Lockly device.
1495
+ */
1496
+ device_name?: string | undefined
1497
+ /**
1498
+ * Model for a Lockly device.
1499
+ */
1500
+ model?: string | undefined
1501
+ }
1502
+ | undefined
1503
+ /**
1504
+ * Metadata for a Minut device.
1505
+ */
1506
+ minut_metadata?:
1507
+ | {
1508
+ /**
1509
+ * Device ID for a Minut device.
1510
+ */
1511
+ device_id?: string | undefined
1512
+ /**
1513
+ * Device name for a Minut device.
1514
+ */
1515
+ device_name?: string | undefined
1516
+ /**
1517
+ * Latest sensor values for a Minut device.
1518
+ */
1519
+ latest_sensor_values?:
1520
+ | {
1521
+ /**
1522
+ * Latest accelerometer Z-axis reading for a Minut device.
1523
+ */
1524
+ accelerometer_z?:
1525
+ | {
1526
+ /**
1527
+ * Time of latest accelerometer Z-axis reading for a Minut device.
1528
+ */
1529
+ time?: string | undefined
1530
+ /**
1531
+ * Value of latest accelerometer Z-axis reading for a Minut device.
1532
+ */
1533
+ value?: number | undefined
1534
+ }
1535
+ | undefined
1536
+ /**
1537
+ * Latest humidity reading for a Minut device.
1538
+ */
1539
+ humidity?:
1540
+ | {
1541
+ /**
1542
+ * Time of latest humidity reading for a Minut device.
1543
+ */
1544
+ time?: string | undefined
1545
+ /**
1546
+ * Value of latest humidity reading for a Minut device.
1547
+ */
1548
+ value?: number | undefined
1549
+ }
1550
+ | undefined
1551
+ /**
1552
+ * Latest pressure reading for a Minut device.
1553
+ */
1554
+ pressure?:
1555
+ | {
1556
+ /**
1557
+ * Time of latest pressure reading for a Minut device.
1558
+ */
1559
+ time?: string | undefined
1560
+ /**
1561
+ * Value of latest pressure reading for a Minut device.
1562
+ */
1563
+ value?: number | undefined
1564
+ }
1565
+ | undefined
1566
+ /**
1567
+ * Latest sound reading for a Minut device.
1568
+ */
1569
+ sound?:
1570
+ | {
1571
+ /**
1572
+ * Time of latest sound reading for a Minut device.
1573
+ */
1574
+ time?: string | undefined
1575
+ /**
1576
+ * Value of latest sound reading for a Minut device.
1577
+ */
1578
+ value?: number | undefined
1579
+ }
1580
+ | undefined
1581
+ /**
1582
+ * Latest temperature reading for a Minut device.
1583
+ */
1584
+ temperature?:
1585
+ | {
1586
+ /**
1587
+ * Time of latest temperature reading for a Minut device.
1588
+ */
1589
+ time?: string | undefined
1590
+ /**
1591
+ * Value of latest temperature reading for a Minut device.
1592
+ */
1593
+ value?: number | undefined
1594
+ }
1595
+ | undefined
1596
+ }
1597
+ | undefined
1598
+ }
1599
+ | undefined
1600
+ /**
1601
+ * Metadata for a Google Nest device.
1602
+ */
1603
+ nest_metadata?:
1604
+ | {
1605
+ /**
1606
+ * Custom device name for a Google Nest device. The device owner sets this value.
1607
+ */
1608
+ device_custom_name?: string | undefined
1609
+ /**
1610
+ * Device name for a Google Nest device. Google sets this value.
1611
+ */
1612
+ device_name?: string | undefined
1613
+ /**
1614
+ * Name of the Google Home room containing the device. The device owner sets this value.
1615
+ */
1616
+ display_name?: string | undefined
1617
+ /**
1618
+ * Device ID for a Google Nest device.
1619
+ */
1620
+ nest_device_id?: string | undefined
1621
+ /**
1622
+ * ID of the Google Nest structure containing the device.
1623
+ */
1624
+ nest_structure_id?: string | undefined
1625
+ /**
1626
+ * Name of the Google Nest structure containing the device. The device owner sets this value.
1627
+ */
1628
+ structure_name?: string | undefined
1629
+ }
1630
+ | undefined
1631
+ /**
1632
+ * Metadata for a NoiseAware device.
1633
+ */
1634
+ noiseaware_metadata?:
1635
+ | {
1636
+ /**
1637
+ * Device ID for a NoiseAware device.
1638
+ */
1639
+ device_id?: string | undefined
1640
+ /**
1641
+ * Device model for a NoiseAware device.
1642
+ */
1643
+ device_model?: 'indoor' | 'outdoor' | undefined
1644
+ /**
1645
+ * Device name for a NoiseAware device.
1646
+ */
1647
+ device_name?: string | undefined
1648
+ /**
1649
+ * Noise level, in decibels, for a NoiseAware device.
1650
+ */
1651
+ noise_level_decibel?: number | undefined
1652
+ /**
1653
+ * Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.
1654
+ */
1655
+ noise_level_nrs?: number | undefined
1656
+ }
1657
+ | undefined
1658
+ /**
1659
+ * Metadata for a Nuki device.
1660
+ */
1661
+ nuki_metadata?:
1662
+ | {
1663
+ /**
1664
+ * Device ID for a Nuki device.
1665
+ */
1666
+ device_id?: string | undefined
1667
+ /**
1668
+ * Device name for a Nuki device.
1669
+ */
1670
+ device_name?: string | undefined
1671
+ /**
1672
+ * Indicates whether keypad 2 is paired for a Nuki device.
1673
+ */
1674
+ keypad_2_paired?: boolean | undefined
1675
+ /**
1676
+ * Indicates whether the keypad battery is in a critical state for a Nuki device.
1677
+ */
1678
+ keypad_battery_critical?: boolean | undefined
1679
+ /**
1680
+ * Indicates whether the keypad is paired for a Nuki device.
1681
+ */
1682
+ keypad_paired?: boolean | undefined
1683
+ }
1684
+ | undefined
1685
+ /**
1686
+ * Metadata for an Omnitec device.
1687
+ */
1688
+ omnitec_metadata?:
1689
+ | {
1690
+ /**
1691
+ * Whether the Omnitec lock has a connected gateway for remote operations.
1692
+ */
1693
+ has_gateway?: boolean | undefined
1694
+ /**
1695
+ * Operator-assigned alias for an Omnitec device.
1696
+ */
1697
+ lock_alias?: string | undefined
1698
+ /**
1699
+ * Lock ID for an Omnitec device.
1700
+ */
1701
+ lock_id?: number | undefined
1702
+ /**
1703
+ * Bluetooth MAC address for an Omnitec device.
1704
+ */
1705
+ lock_mac?: string | undefined
1706
+ /**
1707
+ * Lock name for an Omnitec device.
1708
+ */
1709
+ lock_name?: string | undefined
1710
+ /**
1711
+ * IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).
1712
+ */
1713
+ time_zone?: string | null | undefined
1714
+ /**
1715
+ * Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.
1716
+ */
1717
+ timezone_raw_offset_ms?: number | undefined
1718
+ }
1719
+ | undefined
1720
+ /**
1721
+ * Metadata for a Reolink camera.
1722
+ */
1723
+ reolink_metadata?:
1724
+ | {
1725
+ /**
1726
+ * Firmware version reported by the camera.
1727
+ */
1728
+ firmware_version?: string | undefined
1729
+ /**
1730
+ * Hardware version reported by the camera.
1731
+ */
1732
+ hardware_version?: string | undefined
1733
+ /**
1734
+ * Model reported by the Reolink camera.
1735
+ */
1736
+ model?: string | undefined
1737
+ }
1738
+ | undefined
1739
+ /**
1740
+ * Metadata for a Ring device.
1741
+ */
1742
+ ring_metadata?:
1743
+ | {
1744
+ /**
1745
+ * Device ID for a Ring device.
1746
+ */
1747
+ device_id?: string | undefined
1748
+ /**
1749
+ * Device name for a Ring device.
1750
+ */
1751
+ device_name?: string | undefined
1752
+ }
1753
+ | undefined
1754
+ /**
1755
+ * Metadata for a Salto KS device.
1756
+ */
1757
+ salto_ks_metadata?:
1758
+ | {
1759
+ /**
1760
+ * Battery level for a Salto KS device.
1761
+ */
1762
+ battery_level?: string | undefined
1763
+ /**
1764
+ * Customer reference for a Salto KS device.
1765
+ */
1766
+ customer_reference?: string | undefined
1767
+ /**
1768
+ * Indicates whether the site has a Salto KS subscription that supports custom PINs.
1769
+ */
1770
+ has_custom_pin_subscription?: boolean | undefined
1771
+ /**
1772
+ * Lock ID for a Salto KS device.
1773
+ */
1774
+ lock_id?: string | undefined
1775
+ /**
1776
+ * Lock type for a Salto KS device.
1777
+ */
1778
+ lock_type?: string | undefined
1779
+ /**
1780
+ * Locked state for a Salto KS device.
1781
+ */
1782
+ locked_state?: string | undefined
1783
+ /**
1784
+ * Model for a Salto KS device.
1785
+ */
1786
+ model?: string | undefined
1787
+ /**
1788
+ * Site ID for the Salto KS site to which the device belongs.
1789
+ */
1790
+ site_id?: string | undefined
1791
+ /**
1792
+ * Site name for the Salto KS site to which the device belongs.
1793
+ */
1794
+ site_name?: string | undefined
1795
+ }
1796
+ | undefined
1797
+ /**
1798
+ * Metadata for a Schlage device.
1799
+ */
1800
+ schlage_metadata?:
1801
+ | {
1802
+ /**
1803
+ * Device ID for a Schlage device.
1804
+ */
1805
+ device_id?: string | undefined
1806
+ /**
1807
+ * Device name for a Schlage device.
1808
+ */
1809
+ device_name?: string | undefined
1810
+ /**
1811
+ * Model for a Schlage device.
1812
+ */
1813
+ model?: string | undefined
1814
+ }
1815
+ | undefined
1816
+ /**
1817
+ * Metadata for Seam Bridge.
1818
+ */
1819
+ seam_bridge_metadata?:
1820
+ | {
1821
+ /**
1822
+ * Device number for Seam Bridge.
1823
+ */
1824
+ device_num?: number | undefined
1825
+ /**
1826
+ * Name for Seam Bridge.
1827
+ */
1828
+ name?: string | undefined
1829
+ /**
1830
+ * Unlock method for Seam Bridge.
1831
+ */
1832
+ unlock_method?: 'bridge' | 'doorking' | undefined
1833
+ }
1834
+ | undefined
1835
+ /**
1836
+ * Metadata for a Sensi device.
1837
+ */
1838
+ sensi_metadata?:
1839
+ | {
1840
+ /**
1841
+ * Device ID for a Sensi device.
1842
+ */
1843
+ device_id?: string | undefined
1844
+ /**
1845
+ * Device name for a Sensi device.
1846
+ */
1847
+ device_name?: string | undefined
1848
+ /**
1849
+ * Product type for a Sensi device.
1850
+ */
1851
+ product_type?: string | undefined
1852
+ }
1853
+ | undefined
1854
+ /**
1855
+ * Metadata for a Sensibo device.
1856
+ */
1857
+ sensibo_metadata?:
1858
+ | {
1859
+ /**
1860
+ * Firmware version of the Sensibo device.
1861
+ */
1862
+ firmware_version?: string | undefined
1863
+ /**
1864
+ * MAC address of the Sensibo device.
1865
+ */
1866
+ mac_address?: string | undefined
1867
+ /**
1868
+ * ID of the Sensibo device, which Sensibo calls a pod.
1869
+ */
1870
+ pod_id?: string | undefined
1871
+ /**
1872
+ * Product model of the Sensibo device, such as `skyv2` or `air`.
1873
+ */
1874
+ product_model?: string | undefined
1875
+ /**
1876
+ * Name of the room that the Sensibo device is in.
1877
+ */
1878
+ room_name?: string | undefined
1879
+ /**
1880
+ * Serial number of the Sensibo device.
1881
+ */
1882
+ serial_number?: string | undefined
1883
+ /**
1884
+ * Temperature unit that the Sensibo device displays: `C` or `F`.
1885
+ */
1886
+ temperature_unit?: string | undefined
1887
+ }
1888
+ | undefined
1889
+ /**
1890
+ * Metadata for a SmartThings device.
1891
+ */
1892
+ smartthings_metadata?:
1893
+ | {
1894
+ /**
1895
+ * Device ID for a SmartThings device.
1896
+ */
1897
+ device_id?: string | undefined
1898
+ /**
1899
+ * Device name for a SmartThings device.
1900
+ */
1901
+ device_name?: string | undefined
1902
+ /**
1903
+ * Location ID for a SmartThings device.
1904
+ */
1905
+ location_id?: string | undefined
1906
+ /**
1907
+ * Model for a SmartThings device.
1908
+ */
1909
+ model?: string | undefined
1910
+ }
1911
+ | undefined
1912
+ /**
1913
+ * Metadata for a tado° device.
1914
+ */
1915
+ tado_metadata?:
1916
+ | {
1917
+ /**
1918
+ * Serial numbers of all tado° devices in the zone.
1919
+ */
1920
+ device_serial_numbers?: Array<string> | undefined
1921
+ /**
1922
+ * Device type of the main tado° device in the zone, such as `RU02`, `VA02` or `WR02`.
1923
+ */
1924
+ device_type?: string | undefined
1925
+ /**
1926
+ * Generation of the tado° home, such as `PRE_LINE_X`.
1927
+ */
1928
+ home_generation?: string | undefined
1929
+ /**
1930
+ * ID of the tado° home.
1931
+ */
1932
+ home_id?: string | undefined
1933
+ /**
1934
+ * Name of the tado° home.
1935
+ */
1936
+ home_name?: string | undefined
1937
+ /**
1938
+ * Serial number of the main tado° device in the zone, such as its wall thermostat or Smart AC Control.
1939
+ */
1940
+ serial_no?: string | undefined
1941
+ /**
1942
+ * ID of the tado° zone within its home.
1943
+ */
1944
+ zone_id?: string | undefined
1945
+ /**
1946
+ * Name of the tado° zone.
1947
+ */
1948
+ zone_name?: string | undefined
1949
+ /**
1950
+ * Type of the tado° zone: `HEATING` or `AIR_CONDITIONING`.
1951
+ */
1952
+ zone_type?: string | undefined
1953
+ }
1954
+ | undefined
1955
+ /**
1956
+ * Metadata for a Tapo camera.
1957
+ */
1958
+ tapo_metadata?:
1959
+ | {
1960
+ /**
1961
+ * Firmware version reported by the camera.
1962
+ */
1963
+ firmware_version?: string | undefined
1964
+ /**
1965
+ * Hardware version reported by the camera.
1966
+ */
1967
+ hardware_version?: string | undefined
1968
+ /**
1969
+ * Model reported by the Tapo camera.
1970
+ */
1971
+ model?: string | undefined
1972
+ }
1973
+ | undefined
1974
+ /**
1975
+ * Metadata for a Tedee device.
1976
+ */
1977
+ tedee_metadata?:
1978
+ | {
1979
+ /**
1980
+ * Bridge ID for a Tedee device.
1981
+ */
1982
+ bridge_id?: number | undefined
1983
+ /**
1984
+ * Bridge name for a Tedee device.
1985
+ */
1986
+ bridge_name?: string | undefined
1987
+ /**
1988
+ * Device ID for a Tedee device.
1989
+ */
1990
+ device_id?: number | undefined
1991
+ /**
1992
+ * Device model for a Tedee device.
1993
+ */
1994
+ device_model?: string | undefined
1995
+ /**
1996
+ * Device name for a Tedee device.
1997
+ */
1998
+ device_name?: string | undefined
1999
+ /**
2000
+ * Keypad ID for a Tedee device.
2001
+ */
2002
+ keypad_id?: number | undefined
2003
+ /**
2004
+ * Serial number for a Tedee device.
2005
+ */
2006
+ serial_number?: string | undefined
2007
+ }
2008
+ | undefined
2009
+ /**
2010
+ * Metadata for a TTLock device.
2011
+ */
2012
+ ttlock_metadata?:
2013
+ | {
2014
+ /**
2015
+ * Feature value for a TTLock device.
2016
+ */
2017
+ feature_value?: string | undefined
2018
+ /**
2019
+ * Features for a TTLock device.
2020
+ */
2021
+ features?:
2022
+ | {
2023
+ /**
2024
+ * Indicates whether a TTLock device supports auto-lock time configuration.
2025
+ */
2026
+ auto_lock_time_config?: boolean | undefined
2027
+ /**
2028
+ * Indicates whether a TTLock device supports an incomplete keyboard passcode.
2029
+ */
2030
+ incomplete_keyboard_passcode?: boolean | undefined
2031
+ /**
2032
+ * Indicates whether a TTLock device supports the lock command.
2033
+ */
2034
+ lock_command?: boolean | undefined
2035
+ /**
2036
+ * Indicates whether a TTLock device supports a passcode.
2037
+ */
2038
+ passcode?: boolean | undefined
2039
+ /**
2040
+ * Indicates whether a TTLock device supports passcode management.
2041
+ */
2042
+ passcode_management?: boolean | undefined
2043
+ /**
2044
+ * Indicates whether a TTLock device supports unlock via gateway.
2045
+ */
2046
+ unlock_via_gateway?: boolean | undefined
2047
+ /**
2048
+ * Indicates whether a TTLock device supports Wi-Fi.
2049
+ */
2050
+ wifi?: boolean | undefined
2051
+ }
2052
+ | undefined
2053
+ /**
2054
+ * Indicates whether a TTLock device has a gateway.
2055
+ */
2056
+ has_gateway?: boolean | undefined
2057
+ /**
2058
+ * Lock alias for a TTLock device.
2059
+ */
2060
+ lock_alias?: string | undefined
2061
+ /**
2062
+ * Lock ID for a TTLock device.
2063
+ */
2064
+ lock_id?: number | undefined
2065
+ /**
2066
+ * Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock's wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer "codes offset by N hours" reports. Diagnostic only; Seam does not convert times based on this value.
2067
+ */
2068
+ timezone_raw_offset_ms?: number | null | undefined
2069
+ /**
2070
+ * Wireless keypads for a TTLock device.
2071
+ */
2072
+ wireless_keypads?:
2073
+ | Array<{
2074
+ /**
2075
+ * ID for a wireless keypad for a TTLock device.
2076
+ */
2077
+ wireless_keypad_id?: number | undefined
2078
+ /**
2079
+ * Name for a wireless keypad for a TTLock device.
2080
+ */
2081
+ wireless_keypad_name?: string | undefined
2082
+ }>
2083
+ | undefined
2084
+ }
2085
+ | undefined
2086
+ /**
2087
+ * Metadata for a Tuya device.
2088
+ */
2089
+ tuya_metadata?:
2090
+ | {
2091
+ /**
2092
+ * Tuya product category code for the device (e.g. ms).
2093
+ */
2094
+ category?: string | undefined
2095
+ /**
2096
+ * Device ID for a Tuya device.
2097
+ */
2098
+ device_id?: string | undefined
2099
+ /**
2100
+ * Device name for a Tuya device.
2101
+ */
2102
+ device_name?: string | undefined
2103
+ /**
2104
+ * Model reported for a Tuya device.
2105
+ */
2106
+ model?: string | null | undefined
2107
+ /**
2108
+ * Tuya product ID for the device.
2109
+ */
2110
+ product_id?: string | undefined
2111
+ /**
2112
+ * Tuya product name for the device.
2113
+ */
2114
+ product_name?: string | undefined
2115
+ /**
2116
+ * Time zone reported for a Tuya device (e.g. +08:00).
2117
+ */
2118
+ time_zone?: string | null | undefined
2119
+ }
2120
+ | undefined
2121
+ /**
2122
+ * Metadata for a 2N device.
2123
+ */
2124
+ two_n_metadata?:
2125
+ | {
2126
+ /**
2127
+ * Device ID for a 2N device.
2128
+ */
2129
+ device_id?: number | undefined
2130
+ /**
2131
+ * Device name for a 2N device.
2132
+ */
2133
+ device_name?: string | undefined
2134
+ }
2135
+ | undefined
2136
+ /**
2137
+ * Metadata for an Ultraloq device.
2138
+ */
2139
+ ultraloq_metadata?:
2140
+ | {
2141
+ /**
2142
+ * Device ID for an Ultraloq device.
2143
+ */
2144
+ device_id?: string | undefined
2145
+ /**
2146
+ * Device name for an Ultraloq device.
2147
+ */
2148
+ device_name?: string | undefined
2149
+ /**
2150
+ * Device type for an Ultraloq device.
2151
+ */
2152
+ device_type?: string | undefined
2153
+ /**
2154
+ * IANA timezone for the Ultraloq device.
2155
+ */
2156
+ time_zone?: string | null | undefined
2157
+ }
2158
+ | undefined
2159
+ /**
2160
+ * Metadata for a UniFi Protect camera.
2161
+ */
2162
+ unifi_protect_metadata?:
2163
+ | {
2164
+ /**
2165
+ * Camera ID reported by UniFi Protect.
2166
+ */
2167
+ camera_id?: string | undefined
2168
+ /**
2169
+ * Camera name reported by UniFi Protect.
2170
+ */
2171
+ camera_name?: string | undefined
2172
+ /**
2173
+ * Whether the camera has a microphone.
2174
+ */
2175
+ has_mic?: boolean | undefined
2176
+ /**
2177
+ * MAC address reported by the UniFi Protect camera.
2178
+ */
2179
+ mac?: string | undefined
2180
+ /**
2181
+ * Model reported by the UniFi Protect camera.
2182
+ */
2183
+ model?: string | undefined
2184
+ /**
2185
+ * Name of the UniFi Protect console that manages the camera.
2186
+ */
2187
+ nvr_name?: string | undefined
2188
+ }
2189
+ | undefined
2190
+ /**
2191
+ * Metadata for an ASSA ABLOY Visionline system.
2192
+ */
2193
+ visionline_metadata?:
2194
+ | {
2195
+ /**
2196
+ * Encoder ID for an ASSA ABLOY Visionline system.
2197
+ */
2198
+ encoder_id?: string | undefined
2199
+ }
2200
+ | undefined
2201
+ /**
2202
+ * Metadata for a Wyze device.
2203
+ */
2204
+ wyze_metadata?:
2205
+ | {
2206
+ /**
2207
+ * Device ID for a Wyze device.
2208
+ */
2209
+ device_id?: string | undefined
2210
+ /**
2211
+ * Device information model for a Wyze device.
2212
+ */
2213
+ device_info_model?: string | undefined
2214
+ /**
2215
+ * Device name for a Wyze device.
2216
+ */
2217
+ device_name?: string | undefined
2218
+ /**
2219
+ * Keypad UUID for a Wyze device.
2220
+ */
2221
+ keypad_uuid?: string | undefined
2222
+ /**
2223
+ * Locker status (hardlock) for a Wyze device.
2224
+ */
2225
+ locker_status_hardlock?: number | undefined
2226
+ /**
2227
+ * Product model for a Wyze device.
2228
+ */
2229
+ product_model?: string | undefined
2230
+ /**
2231
+ * Product name for a Wyze device.
2232
+ */
2233
+ product_name?: string | undefined
2234
+ /**
2235
+ * Product type for a Wyze device.
2236
+ */
2237
+ product_type?: string | undefined
2238
+ }
2239
+ | undefined
2240
+ /**
2241
+ * Metadata for a Yacan device.
2242
+ */
2243
+ yacan_metadata?:
2244
+ | {
2245
+ /**
2246
+ * Device ID for a Yacan device.
2247
+ */
2248
+ device_id?: string | undefined
2249
+ /**
2250
+ * Device name for a Yacan device.
2251
+ */
2252
+ device_name?: string | undefined
2253
+ /**
2254
+ * Device type for a Yacan device.
2255
+ */
2256
+ device_type?: string | undefined
2257
+ /**
2258
+ * Serial number for a Yacan device.
2259
+ */
2260
+ serial_number?: string | undefined
2261
+ }
2262
+ | undefined
2263
+ /**
2264
+ * Metadata for a Yale Connect lock.
2265
+ */
2266
+ yale_connect_metadata?:
2267
+ | {
2268
+ /**
2269
+ * Device ID for a Yale Connect lock.
2270
+ */
2271
+ device_id?: string | undefined
2272
+ /**
2273
+ * Device name for a Yale Connect lock.
2274
+ */
2275
+ device_name?: string | undefined
2276
+ /**
2277
+ * Firmware version reported by the Yale Connect lock.
2278
+ */
2279
+ firmware_version?: string | undefined
2280
+ /**
2281
+ * Name of the Yale Connect home that contains the lock.
2282
+ */
2283
+ home_name?: string | undefined
2284
+ /**
2285
+ * Model reported by the Yale Connect lock.
2286
+ */
2287
+ model?: string | undefined
2288
+ /**
2289
+ * Time zone of the Yale Connect home, as Yale reports it.
2290
+ */
2291
+ time_zone_description?: string | undefined
2292
+ }
2293
+ | undefined
2294
+ /**
2295
+ * The delay in seconds before the lock automatically locks after being unlocked.
2296
+ */
2297
+ auto_lock_delay_seconds?: number | undefined
2298
+ /**
2299
+ * Indicates whether automatic locking is enabled.
2300
+ */
2301
+ auto_lock_enabled?: boolean | undefined
2302
+ /**
2303
+ * Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update).
2304
+ */
2305
+ backup_access_code_pool_enabled?: boolean | undefined
2306
+ /**
2307
+ * 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.
2308
+ */
2309
+ code_constraints?:
2310
+ | Array<{
2311
+ constraint_type:
2312
+ | 'no_zeros'
2313
+ | 'cannot_start_with_12'
2314
+ | 'no_triple_consecutive_ints'
2315
+ | 'cannot_specify_pin_code'
2316
+ | 'pin_code_matches_existing_set'
2317
+ | 'start_date_in_future'
2318
+ | 'no_ascending_or_descending_sequence'
2319
+ | 'at_least_three_unique_digits'
2320
+ | 'cannot_contain_089'
2321
+ | 'cannot_contain_0789'
2322
+ | 'unique_first_four_digits'
2323
+ | 'no_all_same_digits'
2324
+ | 'name_length'
2325
+ | 'name_must_be_unique'
2326
+
2327
+ /**
2328
+ * Maximum name length constraint for access codes.
2329
+ */
2330
+ max_length?: number | undefined
2331
+ /**
2332
+ * Minimum name length constraint for access codes.
2333
+ */
2334
+ min_length?: number | undefined
2335
+ }>
2336
+ | undefined
2337
+ /**
2338
+ * Indicates whether the door is open.
2339
+ */
2340
+ door_open?: boolean | undefined
2341
+ /**
2342
+ * Indicates whether the device supports native entry events.
2343
+ */
2344
+ has_native_entry_events?: boolean | undefined
2345
+ /**
2346
+ * Keypad battery status.
2347
+ */
2348
+ keypad_battery?:
2349
+ | {
2350
+ /**
2351
+ * Keypad battery charge level.
2352
+ */
2353
+ level: number
2354
+ }
2355
+ | undefined
2356
+ /**
2357
+ * Indicates whether the lock is locked.
2358
+ */
2359
+ locked?: boolean | undefined
2360
+ /**
2361
+ * Maximum number of active access codes that the device supports.
2362
+ */
2363
+ max_active_codes_supported?: number | undefined
2364
+ /**
2365
+ * Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.
2366
+ */
2367
+ offline_time_frame_options?:
2368
+ | Array<{
2369
+ /**
2370
+ * Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).
2371
+ */
2372
+ display_name: string
2373
+
2374
+ /**
2375
+ * iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.
2376
+ */
2377
+ end_date_recurrence_rule?: string | undefined
2378
+ /**
2379
+ * When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
2380
+ */
2381
+ matching_start_end_time?: true | undefined
2382
+ /**
2383
+ * Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
2384
+ */
2385
+ max_duration?: string | undefined
2386
+ /**
2387
+ * Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.
2388
+ */
2389
+ min_duration?: string | undefined
2390
+ /**
2391
+ * iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.
2392
+ */
2393
+ start_date_recurrence_rule?: string | undefined
2394
+ /**
2395
+ * Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.
2396
+ */
2397
+ time_pairs?:
2398
+ | Array<{
2399
+ /**
2400
+ * Label for the start/end time pairing.
2401
+ */
2402
+ display_name: string
2403
+
2404
+ /**
2405
+ * End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.
2406
+ */
2407
+ end_time: string
2408
+
2409
+ /**
2410
+ * Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.
2411
+ */
2412
+ start_time: string
2413
+ }>
2414
+ | undefined
2415
+ /**
2416
+ * IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.
2417
+ */
2418
+ time_zone?: string | undefined
2419
+ }>
2420
+ | undefined
2421
+ /**
2422
+ * Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.
2423
+ */
2424
+ online_time_frame_options?:
2425
+ | Array<{
2426
+ /**
2427
+ * Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).
2428
+ */
2429
+ display_name: string
2430
+
2431
+ /**
2432
+ * iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.
2433
+ */
2434
+ end_date_recurrence_rule?: string | undefined
2435
+ /**
2436
+ * When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
2437
+ */
2438
+ matching_start_end_time?: true | undefined
2439
+ /**
2440
+ * Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
2441
+ */
2442
+ max_duration?: string | undefined
2443
+ /**
2444
+ * Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.
2445
+ */
2446
+ min_duration?: string | undefined
2447
+ /**
2448
+ * iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.
2449
+ */
2450
+ start_date_recurrence_rule?: string | undefined
2451
+ /**
2452
+ * Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.
2453
+ */
2454
+ time_pairs?:
2455
+ | Array<{
2456
+ /**
2457
+ * Label for the start/end time pairing.
2458
+ */
2459
+ display_name: string
2460
+
2461
+ /**
2462
+ * End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.
2463
+ */
2464
+ end_time: string
2465
+
2466
+ /**
2467
+ * Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.
2468
+ */
2469
+ start_time: string
2470
+ }>
2471
+ | undefined
2472
+ /**
2473
+ * IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.
2474
+ */
2475
+ time_zone?: string | undefined
2476
+ }>
2477
+ | undefined
2478
+ /**
2479
+ * Supported code lengths for access codes.
2480
+ */
2481
+ supported_code_lengths?: Array<number> | undefined
2482
+ /**
2483
+ * Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
2484
+ */
2485
+ supports_backup_access_code_pool?: boolean | undefined
2486
+ /**
2487
+ * ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2488
+ */
2489
+ active_thermostat_schedule_id?: string | null | undefined
2490
+ /**
2491
+ * Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
2492
+ */
2493
+ available_climate_preset_modes?:
2494
+ | Array<
2495
+ 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied'
2496
+ >
2497
+ | undefined
2498
+ /**
2499
+ * Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
2500
+ */
2501
+ available_climate_presets?:
2502
+ | Array<{
2503
+ /**
2504
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2505
+ */
2506
+ can_delete: boolean
2507
+
2508
+ /**
2509
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2510
+ */
2511
+ can_edit: boolean
2512
+
2513
+ /**
2514
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2515
+ */
2516
+ can_use_with_thermostat_daily_programs: boolean
2517
+
2518
+ /**
2519
+ * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2520
+ */
2521
+ climate_preset_key: string
2522
+
2523
+ /**
2524
+ * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2525
+ */
2526
+ climate_preset_mode?:
2527
+ | 'home'
2528
+ | 'away'
2529
+ | 'wake'
2530
+ | 'sleep'
2531
+ | 'occupied'
2532
+ | 'unoccupied'
2533
+ | undefined
2534
+ /**
2535
+ * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2536
+ */
2537
+ cooling_set_point_celsius?: number | undefined
2538
+ /**
2539
+ * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2540
+ */
2541
+ cooling_set_point_fahrenheit?: number | undefined
2542
+ /**
2543
+ * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2544
+ */
2545
+ display_name: string
2546
+
2547
+ /**
2548
+ * Metadata specific to the Ecobee climate, if applicable.
2549
+ */
2550
+ ecobee_metadata?:
2551
+ | {
2552
+ /**
2553
+ * Reference to the Ecobee climate, if applicable.
2554
+ */
2555
+ climate_ref?: string | undefined
2556
+ /**
2557
+ * Indicates if the climate preset is optimized by Ecobee.
2558
+ */
2559
+ is_optimized?: boolean | undefined
2560
+ /**
2561
+ * Indicates whether the climate preset is owned by the user or the system.
2562
+ */
2563
+ owner?: 'user' | 'system' | undefined
2564
+ }
2565
+ | undefined
2566
+ /**
2567
+ * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2568
+ */
2569
+ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2570
+ /**
2571
+ * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2572
+ */
2573
+ heating_set_point_celsius?: number | undefined
2574
+ /**
2575
+ * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2576
+ */
2577
+ heating_set_point_fahrenheit?: number | undefined
2578
+ /**
2579
+ * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2580
+ */
2581
+ hvac_mode_setting?:
2582
+ 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
2583
+ /**
2584
+ * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2585
+ */
2586
+ name?: string | null | undefined
2587
+ }>
2588
+ | undefined
2589
+ /**
2590
+ * Fan mode settings that the thermostat supports.
2591
+ */
2592
+ available_fan_mode_settings?:
2593
+ Array<'auto' | 'on' | 'circulate'> | undefined
2594
+ /**
2595
+ * HVAC mode settings that the thermostat supports.
2596
+ */
2597
+ available_hvac_mode_settings?:
2598
+ Array<'off' | 'heat' | 'cool' | 'heat_cool' | 'eco'> | undefined
2599
+ /**
2600
+ * Current climate setting.
2601
+ */
2602
+ current_climate_setting?:
2603
+ | {
2604
+ /**
2605
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2606
+ */
2607
+ can_delete?: boolean | undefined
2608
+ /**
2609
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2610
+ */
2611
+ can_edit?: boolean | undefined
2612
+ /**
2613
+ * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2614
+ */
2615
+ can_use_with_thermostat_daily_programs?: boolean | undefined
2616
+ /**
2617
+ * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2618
+ */
2619
+ climate_preset_key?: string | undefined
2620
+ /**
2621
+ * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2622
+ */
2623
+ climate_preset_mode?:
2624
+ | 'home'
2625
+ | 'away'
2626
+ | 'wake'
2627
+ | 'sleep'
2628
+ | 'occupied'
2629
+ | 'unoccupied'
2630
+ | undefined
2631
+ /**
2632
+ * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2633
+ */
2634
+ cooling_set_point_celsius?: number | undefined
2635
+ /**
2636
+ * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2637
+ */
2638
+ cooling_set_point_fahrenheit?: number | undefined
2639
+ /**
2640
+ * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2641
+ */
2642
+ display_name?: string | undefined
2643
+ /**
2644
+ * Metadata specific to the Ecobee climate, if applicable.
2645
+ */
2646
+ ecobee_metadata?:
2647
+ | {
2648
+ /**
2649
+ * Reference to the Ecobee climate, if applicable.
2650
+ */
2651
+ climate_ref?: string | undefined
2652
+ /**
2653
+ * Indicates if the climate preset is optimized by Ecobee.
2654
+ */
2655
+ is_optimized?: boolean | undefined
2656
+ /**
2657
+ * Indicates whether the climate preset is owned by the user or the system.
2658
+ */
2659
+ owner?: 'user' | 'system' | undefined
2660
+ }
2661
+ | undefined
2662
+ /**
2663
+ * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2664
+ */
2665
+ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2666
+ /**
2667
+ * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2668
+ */
2669
+ heating_set_point_celsius?: number | undefined
2670
+ /**
2671
+ * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2672
+ */
2673
+ heating_set_point_fahrenheit?: number | undefined
2674
+ /**
2675
+ * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2676
+ */
2677
+ hvac_mode_setting?:
2678
+ 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
2679
+ /**
2680
+ * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2681
+ */
2682
+ name?: string | null | undefined
2683
+ }
2684
+ | undefined
2685
+ /**
2686
+ * Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
2687
+ */
2688
+ fallback_climate_preset_key?: string | null | undefined
2689
+ /**
2690
+ * Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
2691
+ */
2692
+ is_cooling?: boolean | undefined
2693
+ /**
2694
+ * Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.
2695
+ */
2696
+ is_fan_running?: boolean | undefined
2697
+ /**
2698
+ * Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.
2699
+ */
2700
+ is_heating?: boolean | undefined
2701
+ /**
2702
+ * 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`.
2703
+ */
2704
+ is_temporary_manual_override_active?: boolean | undefined
2705
+ /**
2706
+ * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
2707
+ */
2708
+ max_cooling_set_point_celsius?: number | undefined
2709
+ /**
2710
+ * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
2711
+ */
2712
+ max_cooling_set_point_fahrenheit?: number | undefined
2713
+ /**
2714
+ * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
2715
+ */
2716
+ max_heating_set_point_celsius?: number | undefined
2717
+ /**
2718
+ * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
2719
+ */
2720
+ max_heating_set_point_fahrenheit?: number | undefined
2721
+ /**
2722
+ * Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.
2723
+ */
2724
+ max_thermostat_daily_program_periods_per_day?: number | undefined
2725
+ /**
2726
+ * Maximum number of climate presets that the thermostat can support for weekly programming.
2727
+ */
2728
+ max_unique_climate_presets_per_thermostat_weekly_program?:
2729
+ number | undefined
2730
+ /**
2731
+ * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
2732
+ */
2733
+ min_cooling_set_point_celsius?: number | undefined
2734
+ /**
2735
+ * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
2736
+ */
2737
+ min_cooling_set_point_fahrenheit?: number | undefined
2738
+ /**
2739
+ * Minimum [temperature difference](https://www.seam.co/docs/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.
2740
+ */
2741
+ min_heating_cooling_delta_celsius?: number | undefined
2742
+ /**
2743
+ * Minimum [temperature difference](https://www.seam.co/docs/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.
2744
+ */
2745
+ min_heating_cooling_delta_fahrenheit?: number | undefined
2746
+ /**
2747
+ * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
2748
+ */
2749
+ min_heating_set_point_celsius?: number | undefined
2750
+ /**
2751
+ * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
2752
+ */
2753
+ min_heating_set_point_fahrenheit?: number | undefined
2754
+ /**
2755
+ * Reported relative humidity, as a value between 0 and 1, inclusive.
2756
+ */
2757
+ relative_humidity?: number | undefined
2758
+ /**
2759
+ * Reported temperature in °C.
2760
+ */
2761
+ temperature_celsius?: number | undefined
2762
+ /**
2763
+ * Reported temperature in °F.
2764
+ */
2765
+ temperature_fahrenheit?: number | undefined
2766
+ /**
2767
+ * Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2768
+ */
2769
+ temperature_threshold?:
2770
+ | {
2771
+ /**
2772
+ * Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2773
+ */
2774
+ lower_limit_celsius: number | null
2775
+ /**
2776
+ * Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2777
+ */
2778
+ lower_limit_fahrenheit: number | null
2779
+ /**
2780
+ * Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2781
+ */
2782
+ upper_limit_celsius: number | null
2783
+ /**
2784
+ * Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2785
+ */
2786
+ upper_limit_fahrenheit: number | null
2787
+ }
2788
+ | undefined
2789
+ /**
2790
+ * Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.
2791
+ */
2792
+ thermostat_daily_program_period_precision_minutes?: number | undefined
2793
+ /**
2794
+ * Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
2795
+ */
2796
+ thermostat_daily_programs?:
2797
+ | Array<{
2798
+ /**
2799
+ * Date and time at which the thermostat daily program was created.
2800
+ */
2801
+ created_at: string
736
2802
 
737
- /**
738
- * Indicates current noise level in decibels, if the device supports noise detection.
739
- */
740
- noise_level_decibels?: number | undefined
741
- /**
742
- * Indicates whether it is currently possible to use offline access codes for the device.
743
- * @deprecated use device.can_program_offline_access_codes
744
- */
745
- offline_access_codes_enabled?: boolean | undefined
746
- /**
747
- * Indicates whether the device is online.
748
- */
749
- online: boolean
2803
+ /**
2804
+ * ID of the thermostat device on which the thermostat daily program is configured.
2805
+ */
2806
+ device_id: string
750
2807
 
751
- /**
752
- * Indicates whether it is currently possible to use online access codes for the device.
753
- * @deprecated use device.can_program_online_access_codes
754
- */
755
- online_access_codes_enabled?: boolean | undefined
756
- /**
757
- * Serial number of the device.
758
- */
759
- serial_number?: string | undefined
760
- /**
761
- * @deprecated use device.properties.model.can_connect_accessory_keypad
762
- */
763
- supports_accessory_keypad?: boolean | undefined
764
- /**
765
- * @deprecated use offline_access_codes_enabled
766
- */
767
- supports_offline_access_codes?: boolean | undefined
768
- /**
769
- * ASSA ABLOY Credential Service metadata for the phone.
770
- */
771
- assa_abloy_credential_service_metadata?:
772
- | {
773
- /**
774
- * Endpoints associated with the phone.
775
- */
776
- endpoints?:
777
- | Array<{
2808
+ /**
2809
+ * User-friendly name to identify the thermostat daily program.
2810
+ */
2811
+ name: string | null
2812
+ /**
2813
+ * Array of thermostat daily program periods.
2814
+ */
2815
+ periods: Array<{
778
2816
  /**
779
- * ID of the associated endpoint.
2817
+ * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
780
2818
  */
781
- endpoint_id?: string | undefined
2819
+ climate_preset_key: string
2820
+
782
2821
  /**
783
- * Indicated whether the endpoint is active.
2822
+ * Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
784
2823
  */
785
- is_active?: boolean | undefined
2824
+ starts_at_time: string
786
2825
  }>
787
- | undefined
788
- /**
789
- * Indicates whether the credential service has active endpoints associated with the phone.
790
- */
791
- has_active_endpoint?: boolean | undefined
792
- }
793
- | undefined
2826
+
2827
+ /**
2828
+ * ID of the thermostat daily program.
2829
+ */
2830
+ thermostat_daily_program_id: string
2831
+
2832
+ /**
2833
+ * ID of the workspace that contains the thermostat daily program.
2834
+ */
2835
+ workspace_id: string
2836
+ }>
2837
+ | undefined
2838
+ /**
2839
+ * Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
2840
+ */
2841
+ thermostat_weekly_program?:
2842
+ | {
2843
+ /**
2844
+ * Date and time at which the thermostat weekly program was created.
2845
+ */
2846
+ created_at: string
2847
+
2848
+ /**
2849
+ * ID of the thermostat daily program to run on Fridays.
2850
+ */
2851
+ friday_program_id: string | null
2852
+ /**
2853
+ * ID of the thermostat daily program to run on Mondays.
2854
+ */
2855
+ monday_program_id: string | null
2856
+ /**
2857
+ * ID of the thermostat daily program to run on Saturdays.
2858
+ */
2859
+ saturday_program_id: string | null
2860
+ /**
2861
+ * ID of the thermostat daily program to run on Sundays.
2862
+ */
2863
+ sunday_program_id: string | null
2864
+ /**
2865
+ * ID of the thermostat daily program to run on Thursdays.
2866
+ */
2867
+ thursday_program_id: string | null
2868
+ /**
2869
+ * ID of the thermostat daily program to run on Tuesdays.
2870
+ */
2871
+ tuesday_program_id: string | null
2872
+ /**
2873
+ * ID of the thermostat daily program to run on Wednesdays.
2874
+ */
2875
+ wednesday_program_id: string | null
2876
+ }
2877
+ | null
2878
+ | undefined
2879
+ }
2880
+ | undefined
2881
+ /**
2882
+ * Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
2883
+ */
2884
+ relative_humidity?: number | undefined
2885
+ /**
2886
+ * IDs of the spaces the device is in.
2887
+ */
2888
+ space_ids: Array<string>
2889
+
2890
+ /**
2891
+ * Temperature in °C, if the device measures temperature.
2892
+ */
2893
+ temperature_celsius?: number | undefined
2894
+ /**
2895
+ * Temperature in °F, if the device measures temperature.
2896
+ */
2897
+ temperature_fahrenheit?: number | undefined
2898
+ /**
2899
+ * Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
2900
+ */
2901
+ warnings: Array<
794
2902
  /**
795
- * Salto Space credential service metadata for the phone.
2903
+ * Indicates that the backup access code is unhealthy.
796
2904
  */
797
- salto_space_credential_service_metadata?:
798
- | {
799
- /**
800
- * Indicates whether the credential service has an active associated phone.
801
- */
802
- has_active_phone?: boolean | undefined
803
- }
804
- | undefined
805
- /**
806
- * Metadata for an Akiles device.
2905
+ | {
2906
+ /**
2907
+ * Date and time at which Seam created the warning.
2908
+ */
2909
+ created_at: string
2910
+
2911
+ /**
2912
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2913
+ */
2914
+ message: string
2915
+
2916
+ /**
2917
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2918
+ */
2919
+ warning_code: 'partial_backup_access_code_pool'
2920
+ } /**
2921
+ * Indicates that there are too many backup codes.
807
2922
  */
808
- akiles_metadata?:
809
- | {
810
- /**
811
- * Gadget ID for an Akiles device.
812
- */
813
- gadget_id?: string | undefined
814
- /**
815
- * Gadget name for an Akiles device.
816
- */
817
- gadget_name?: string | undefined
818
- /**
819
- * Product name for an Akiles device.
820
- */
821
- product_name?: string | undefined
822
- }
823
- | undefined
824
- /**
825
- * Metadata for an Aqara device.
2923
+ | {
2924
+ /**
2925
+ * Date and time at which Seam created the warning.
2926
+ */
2927
+ created_at: string
2928
+
2929
+ /**
2930
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2931
+ */
2932
+ message: string
2933
+
2934
+ /**
2935
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2936
+ */
2937
+ warning_code: 'many_active_backup_codes'
2938
+ } /**
2939
+ * Indicates that a third-party integration has been detected.
826
2940
  */
827
- aqara_metadata?:
828
- | {
829
- /**
830
- * Device name for an Aqara device.
831
- */
832
- device_name?: string | undefined
833
- /**
834
- * Device ID (did) for an Aqara device.
835
- */
836
- did?: string | undefined
837
- /**
838
- * Firmware version for an Aqara device.
839
- */
840
- firmware_version?: string | null | undefined
841
- /**
842
- * Model identifier for an Aqara device.
843
- */
844
- model?: string | undefined
845
- /**
846
- * Model type for an Aqara device.
847
- */
848
- model_type?: number | undefined
849
- /**
850
- * Parent gateway device ID for an Aqara device.
851
- */
852
- parent_did?: string | undefined
853
- /**
854
- * Position (room) ID for an Aqara device.
855
- */
856
- position_id?: string | null | undefined
857
- /**
858
- * Time zone reported for an Aqara device (e.g. GMT-07:00).
859
- */
860
- time_zone?: string | null | undefined
861
- }
862
- | undefined
863
- /**
864
- * Metadata for an Arlo camera.
865
- */
866
- arlo_metadata?:
867
- | {
868
- /**
869
- * Device ID reported by Arlo.
870
- */
871
- device_id?: string | undefined
872
- /**
873
- * Device name reported by Arlo.
874
- */
875
- device_name?: string | undefined
876
- /**
877
- * Firmware version reported by Arlo.
878
- */
879
- firmware_version?: string | undefined
880
- /**
881
- * Hardware version reported by Arlo.
882
- */
883
- hardware_version?: string | undefined
884
- /**
885
- * Model ID reported by Arlo.
886
- */
887
- model_id?: string | undefined
888
- }
889
- | undefined
890
- /**
891
- * Metadata for an ASSA ABLOY Vostio system.
892
- */
893
- assa_abloy_vostio_metadata?:
894
- | {
895
- /**
896
- * Encoder name for an ASSA ABLOY Vostio system.
897
- */
898
- encoder_name?: string | undefined
899
- }
900
- | undefined
901
- /**
902
- * Metadata for an August device.
903
- */
904
- august_metadata?:
905
- | {
906
- /**
907
- * Indicates whether an August device has a keypad.
908
- */
909
- has_keypad?: boolean | undefined
910
- /**
911
- * House ID for an August device.
912
- */
913
- house_id?: string | undefined
914
- /**
915
- * House name for an August device.
916
- */
917
- house_name?: string | undefined
918
- /**
919
- * Keypad battery level for an August device.
920
- */
921
- keypad_battery_level?: string | undefined
922
- /**
923
- * Lock ID for an August device.
924
- */
925
- lock_id?: string | undefined
926
- /**
927
- * Lock name for an August device.
928
- */
929
- lock_name?: string | undefined
930
- /**
931
- * Model for an August device.
932
- */
933
- model?: string | undefined
934
- }
935
- | undefined
936
- /**
937
- * Metadata for an Avigilon Alta system.
938
- */
939
- avigilon_alta_metadata?:
940
- | {
941
- /**
942
- * Entry name for an Avigilon Alta system.
943
- */
944
- entry_name?: string | undefined
945
- /**
946
- * Total count of entry relays for an Avigilon Alta system.
947
- */
948
- entry_relays_total_count?: number | undefined
949
- /**
950
- * Organization name for an Avigilon Alta system.
951
- */
952
- org_name?: string | undefined
953
- /**
954
- * Site ID for an Avigilon Alta system.
955
- */
956
- site_id?: number | undefined
957
- /**
958
- * Site name for an Avigilon Alta system.
959
- */
960
- site_name?: string | undefined
961
- /**
962
- * Zone ID for an Avigilon Alta system.
963
- */
964
- zone_id?: number | undefined
965
- /**
966
- * Zone name for an Avigilon Alta system.
967
- */
968
- zone_name?: string | undefined
969
- }
970
- | undefined
971
- /**
972
- * Metadata for a Brivo device.
973
- */
974
- brivo_metadata?:
975
- | {
976
- /**
977
- * Indicates whether the Brivo access point has activation (remote unlock) enabled.
978
- */
979
- activation_enabled?: boolean | undefined
980
- /**
981
- * Device name for a Brivo device.
982
- */
983
- device_name?: string | undefined
984
- }
985
- | undefined
986
- /**
987
- * Metadata for a ControlByWeb device.
988
- */
989
- controlbyweb_metadata?:
990
- | {
991
- /**
992
- * Device ID for a ControlByWeb device.
993
- */
994
- device_id?: string | undefined
995
- /**
996
- * Device name for a ControlByWeb device.
997
- */
998
- device_name?: string | undefined
999
- /**
1000
- * Relay name for a ControlByWeb device.
1001
- */
1002
- relay_name?: string | null | undefined
1003
- }
1004
- | undefined
1005
- /**
1006
- * Metadata for a dormakaba Oracode Homeowner's Portal device.
1007
- */
1008
- dormakaba_oracode_iho_metadata?:
1009
- | {
1010
- /**
1011
- * Door ID for a dormakaba Oracode Homeowner's Portal device.
1012
- */
1013
- door_id?: number | undefined
1014
- /**
1015
- * Name of the door for a dormakaba Oracode Homeowner's Portal device.
1016
- */
1017
- door_name?: string | undefined
1018
- /**
1019
- * IANA time zone for a dormakaba Oracode Homeowner's Portal device.
1020
- */
1021
- iana_timezone?: string | undefined
1022
- /**
1023
- * User levels for a dormakaba Oracode Homeowner's Portal device.
1024
- */
1025
- user_levels?:
1026
- | Array<{
1027
- user_level?: number | undefined
1028
-
1029
- user_level_check_in_time?: string | undefined
1030
-
1031
- user_level_check_out_time?: string | undefined
1032
-
1033
- user_level_name?: string | undefined
1034
-
1035
- user_level_type?: string | undefined
1036
- }>
1037
- | undefined
1038
- }
1039
- | undefined
1040
- /**
1041
- * Metadata for a dormakaba Oracode device.
1042
- */
1043
- dormakaba_oracode_metadata?:
1044
- | {
1045
- /**
1046
- * Device ID for a dormakaba Oracode device.
1047
- */
1048
- device_id?: string | undefined
1049
- /**
1050
- * Door ID for a dormakaba Oracode device.
1051
- */
1052
- door_id?: number | undefined
1053
- /**
1054
- * Indicates whether a door is wireless for a dormakaba Oracode device.
1055
- */
1056
- door_is_wireless?: boolean | undefined
1057
- /**
1058
- * Door name for a dormakaba Oracode device.
1059
- */
1060
- door_name?: string | undefined
1061
- /**
1062
- * IANA time zone for a dormakaba Oracode device.
1063
- */
1064
- iana_timezone?: string | undefined
1065
- /**
1066
- * Predefined time slots for a dormakaba Oracode device.
1067
- */
1068
- predefined_time_slots?:
1069
- | Array<{
1070
- /**
1071
- * Check in time for a time slot for a dormakaba Oracode device.
1072
- */
1073
- check_in_time?: string | undefined
1074
- /**
1075
- * Checkout time for a time slot for a dormakaba Oracode device.
1076
- */
1077
- check_out_time?: string | undefined
1078
- /**
1079
- * ID of a user level for a dormakaba Oracode device.
1080
- */
1081
- dormakaba_oracode_user_level_id?: string | undefined
1082
- /**
1083
- * Prefix for a user level for a dormakaba Oracode device.
1084
- */
1085
- dormakaba_oracode_user_level_prefix?: number | undefined
1086
- /**
1087
- * Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.
1088
- */
1089
- is_24_hour?: boolean | undefined
1090
- /**
1091
- * Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.
1092
- */
1093
- is_biweekly_mode?: boolean | undefined
1094
- /**
1095
- * Indicates whether a time slot for a dormakaba Oracode device is a master time slot.
1096
- */
1097
- is_master?: boolean | undefined
1098
- /**
1099
- * Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.
1100
- */
1101
- is_one_shot?: boolean | undefined
1102
- /**
1103
- * Name of a time slot for a dormakaba Oracode device.
1104
- */
1105
- name?: string | undefined
1106
- /**
1107
- * Prefix for a time slot for a dormakaba Oracode device.
1108
- */
1109
- prefix?: number | undefined
1110
- }>
1111
- | undefined
1112
- /**
1113
- * Site ID for a dormakaba Oracode device.
1114
- * @deprecated Previously marked as "@DEPRECATED."
1115
- */
1116
- site_id?: number | null | undefined
1117
- /**
1118
- * Site name for a dormakaba Oracode device.
1119
- */
1120
- site_name?: string | undefined
1121
- }
1122
- | undefined
1123
- /**
1124
- * Metadata for an ecobee device.
1125
- */
1126
- ecobee_metadata?:
1127
- | {
1128
- /**
1129
- * Device name for an ecobee device.
1130
- */
1131
- device_name?: string | undefined
1132
- /**
1133
- * Device ID for an ecobee device.
1134
- */
1135
- ecobee_device_id?: string | undefined
1136
- }
1137
- | undefined
1138
- /**
1139
- * Metadata for a Eufy device.
1140
- */
1141
- eufy_metadata?:
1142
- | {
1143
- device_id?: string | undefined
1144
-
1145
- device_name?: string | undefined
1146
-
1147
- model?: string | undefined
1148
- }
1149
- | undefined
1150
- /**
1151
- * Metadata for a 4SUITES device.
1152
- */
1153
- four_suites_metadata?:
1154
- | {
1155
- /**
1156
- * Device ID for a 4SUITES device.
1157
- */
1158
- device_id?: number | undefined
1159
- /**
1160
- * Device name for a 4SUITES device.
1161
- */
1162
- device_name?: string | undefined
1163
- /**
1164
- * Reclose delay, in seconds, for a 4SUITES device.
1165
- */
1166
- reclose_delay_in_seconds?: number | undefined
1167
- }
1168
- | undefined
1169
- /**
1170
- * Metadata for a Genie device.
1171
- */
1172
- genie_metadata?:
1173
- | {
1174
- /**
1175
- * Lock name for a Genie device.
1176
- */
1177
- device_name?: string | undefined
1178
- /**
1179
- * Door name for a Genie device.
1180
- */
1181
- door_name?: string | undefined
1182
- }
1183
- | undefined
1184
- /**
1185
- * Metadata for a Honeywell Resideo device.
1186
- */
1187
- honeywell_resideo_metadata?:
1188
- | {
1189
- /**
1190
- * Device name for a Honeywell Resideo device.
1191
- */
1192
- device_name?: string | undefined
1193
- /**
1194
- * Device ID for a Honeywell Resideo device.
1195
- */
1196
- honeywell_resideo_device_id?: string | undefined
1197
- }
1198
- | undefined
1199
- /**
1200
- * Metadata for an igloo device.
1201
- */
1202
- igloo_metadata?:
1203
- | {
1204
- /**
1205
- * Bridge ID for an igloo device.
1206
- */
1207
- bridge_id?: string | undefined
1208
- /**
1209
- * Device ID for an igloo device.
1210
- */
1211
- device_id?: string | undefined
1212
- /**
1213
- * Model for an igloo device.
1214
- */
1215
- model?: string | undefined
1216
- }
1217
- | undefined
1218
- /**
1219
- * Metadata for an igloohome device.
1220
- */
1221
- igloohome_metadata?:
1222
- | {
1223
- /**
1224
- * Bridge ID for an igloohome device.
1225
- */
1226
- bridge_id?: string | undefined
1227
- /**
1228
- * Bridge name for an igloohome device.
1229
- */
1230
- bridge_name?: string | undefined
1231
- /**
1232
- * Device ID for an igloohome device.
1233
- */
1234
- device_id?: string | undefined
1235
- /**
1236
- * Device name for an igloohome device.
1237
- */
1238
- device_name?: string | undefined
1239
- /**
1240
- * Indicates whether a keypad is linked to a bridge for an igloohome device.
1241
- */
1242
- is_accessory_keypad_linked_to_bridge?: boolean | undefined
1243
- /**
1244
- * Keypad ID for an igloohome device.
1245
- */
1246
- keypad_id?: string | undefined
1247
- }
1248
- | undefined
1249
- /**
1250
- * Metadata for a KeyNest device.
1251
- */
1252
- keynest_metadata?:
1253
- | {
1254
- /**
1255
- * Address for a KeyNest device.
1256
- */
1257
- address?: string | null | undefined
1258
- /**
1259
- * Current or last store ID for a KeyNest device.
1260
- */
1261
- current_or_last_store_id?: number | undefined
1262
- /**
1263
- * Current status for a KeyNest device.
1264
- */
1265
- current_status?: string | null | undefined
1266
- /**
1267
- * Current user company for a KeyNest device.
1268
- */
1269
- current_user_company?: string | null | undefined
1270
- /**
1271
- * Current user email for a KeyNest device.
1272
- */
1273
- current_user_email?: string | null | undefined
1274
- /**
1275
- * Current user name for a KeyNest device.
1276
- */
1277
- current_user_name?: string | null | undefined
1278
- /**
1279
- * Current user phone number for a KeyNest device.
1280
- */
1281
- current_user_phone_number?: string | null | undefined
1282
- /**
1283
- * Default office ID for a KeyNest device.
1284
- */
1285
- default_office_id?: number | undefined
1286
- /**
1287
- * Device name for a KeyNest device.
1288
- */
1289
- device_name?: string | undefined
1290
- /**
1291
- * Fob ID for a KeyNest device.
1292
- */
1293
- fob_id?: number | undefined
1294
- /**
1295
- * Handover method for a KeyNest device.
1296
- */
1297
- handover_method?: string | null | undefined
1298
- /**
1299
- * Whether the KeyNest device has a photo.
1300
- */
1301
- has_photo?: boolean | undefined
1302
- /**
1303
- * Whether the key is in a locker that does not support the access codes API.
1304
- */
1305
- is_quadient_locker?: boolean | undefined
1306
- /**
1307
- * Key ID for a KeyNest device.
1308
- */
1309
- key_id?: string | undefined
1310
- /**
1311
- * Key notes for a KeyNest device.
1312
- */
1313
- key_notes?: string | null | undefined
1314
- /**
1315
- * KeyNest app user for a KeyNest device.
1316
- */
1317
- keynest_app_user?: string | null | undefined
1318
- /**
1319
- * Last movement timestamp for a KeyNest device.
1320
- */
1321
- last_movement?: string | undefined
1322
- /**
1323
- * Property ID for a KeyNest device.
1324
- */
1325
- property_id?: string | null | undefined
1326
- /**
1327
- * Property postcode for a KeyNest device.
1328
- */
1329
- property_postcode?: string | null | undefined
1330
- /**
1331
- * Status type for a KeyNest device.
1332
- */
1333
- status_type?: string | undefined
1334
- /**
1335
- * Subscription plan for a KeyNest device.
1336
- */
1337
- subscription_plan?: string | undefined
1338
- }
1339
- | undefined
1340
- /**
1341
- * Metadata for a Kisi device.
1342
- */
1343
- kisi_metadata?:
1344
- | {
1345
- /**
1346
- * Description for a Kisi device.
1347
- */
1348
- description?: string | null | undefined
1349
- /**
1350
- * Lock ID for a Kisi device.
1351
- */
1352
- lock_id?: number | undefined
1353
- /**
1354
- * Lock name for a Kisi device.
1355
- */
1356
- lock_name?: string | undefined
1357
- /**
1358
- * Place name for a Kisi device.
1359
- */
1360
- place_name?: string | null | undefined
1361
- }
1362
- | undefined
1363
- /**
1364
- * Metadata for a Korelock device.
1365
- */
1366
- korelock_metadata?:
1367
- | {
1368
- /**
1369
- * Device ID for a Korelock device.
1370
- */
1371
- device_id?: string | undefined
1372
- /**
1373
- * Device name for a Korelock device.
1374
- */
1375
- device_name?: string | undefined
1376
- /**
1377
- * Firmware version for a Korelock device.
1378
- */
1379
- firmware_version?: string | undefined
1380
- /**
1381
- * Location ID for a Korelock device. Required for timebound access codes.
1382
- */
1383
- location_id?: string | null | undefined
1384
- /**
1385
- * Model code for a Korelock device.
1386
- */
1387
- model_code?: string | undefined
1388
- /**
1389
- * Serial number for a Korelock device.
1390
- */
1391
- serial_number?: string | undefined
1392
- /**
1393
- * WiFi signal strength (0-1) for a Korelock device.
1394
- */
1395
- wifi_signal_strength?: number | undefined
1396
- }
1397
- | undefined
1398
- /**
1399
- * Metadata for a Kwikset device.
1400
- */
1401
- kwikset_metadata?:
1402
- | {
1403
- /**
1404
- * Device ID for a Kwikset device.
1405
- */
1406
- device_id?: string | undefined
1407
- /**
1408
- * Device name for a Kwikset device.
1409
- */
1410
- device_name?: string | undefined
1411
- /**
1412
- * Model number for a Kwikset device.
1413
- */
1414
- model_number?: string | undefined
1415
- }
1416
- | undefined
1417
- /**
1418
- * Metadata for a Lockly device.
1419
- */
1420
- lockly_metadata?:
1421
- | {
1422
- /**
1423
- * Device ID for a Lockly device.
1424
- */
1425
- device_id?: string | undefined
1426
- /**
1427
- * Device name for a Lockly device.
1428
- */
1429
- device_name?: string | undefined
1430
- /**
1431
- * Model for a Lockly device.
1432
- */
1433
- model?: string | undefined
1434
- }
1435
- | undefined
1436
- /**
1437
- * Metadata for a Minut device.
1438
- */
1439
- minut_metadata?:
1440
- | {
1441
- /**
1442
- * Device ID for a Minut device.
1443
- */
1444
- device_id?: string | undefined
1445
- /**
1446
- * Device name for a Minut device.
1447
- */
1448
- device_name?: string | undefined
1449
- /**
1450
- * Latest sensor values for a Minut device.
1451
- */
1452
- latest_sensor_values?:
1453
- | {
1454
- /**
1455
- * Latest accelerometer Z-axis reading for a Minut device.
1456
- */
1457
- accelerometer_z?:
1458
- | {
1459
- /**
1460
- * Time of latest accelerometer Z-axis reading for a Minut device.
1461
- */
1462
- time?: string | undefined
1463
- /**
1464
- * Value of latest accelerometer Z-axis reading for a Minut device.
1465
- */
1466
- value?: number | undefined
1467
- }
1468
- | undefined
1469
- /**
1470
- * Latest humidity reading for a Minut device.
1471
- */
1472
- humidity?:
1473
- | {
1474
- /**
1475
- * Time of latest humidity reading for a Minut device.
1476
- */
1477
- time?: string | undefined
1478
- /**
1479
- * Value of latest humidity reading for a Minut device.
1480
- */
1481
- value?: number | undefined
1482
- }
1483
- | undefined
1484
- /**
1485
- * Latest pressure reading for a Minut device.
1486
- */
1487
- pressure?:
1488
- | {
1489
- /**
1490
- * Time of latest pressure reading for a Minut device.
1491
- */
1492
- time?: string | undefined
1493
- /**
1494
- * Value of latest pressure reading for a Minut device.
1495
- */
1496
- value?: number | undefined
1497
- }
1498
- | undefined
1499
- /**
1500
- * Latest sound reading for a Minut device.
1501
- */
1502
- sound?:
1503
- | {
1504
- /**
1505
- * Time of latest sound reading for a Minut device.
1506
- */
1507
- time?: string | undefined
1508
- /**
1509
- * Value of latest sound reading for a Minut device.
1510
- */
1511
- value?: number | undefined
1512
- }
1513
- | undefined
1514
- /**
1515
- * Latest temperature reading for a Minut device.
1516
- */
1517
- temperature?:
1518
- | {
1519
- /**
1520
- * Time of latest temperature reading for a Minut device.
1521
- */
1522
- time?: string | undefined
1523
- /**
1524
- * Value of latest temperature reading for a Minut device.
1525
- */
1526
- value?: number | undefined
1527
- }
1528
- | undefined
1529
- }
1530
- | undefined
1531
- }
1532
- | undefined
1533
- /**
1534
- * Metadata for a Google Nest device.
1535
- */
1536
- nest_metadata?:
1537
- | {
1538
- /**
1539
- * Custom device name for a Google Nest device. The device owner sets this value.
1540
- */
1541
- device_custom_name?: string | undefined
1542
- /**
1543
- * Device name for a Google Nest device. Google sets this value.
1544
- */
1545
- device_name?: string | undefined
1546
- /**
1547
- * Name of the Google Home room containing the device. The device owner sets this value.
1548
- */
1549
- display_name?: string | undefined
1550
- /**
1551
- * Device ID for a Google Nest device.
1552
- */
1553
- nest_device_id?: string | undefined
1554
- /**
1555
- * ID of the Google Nest structure containing the device.
1556
- */
1557
- nest_structure_id?: string | undefined
1558
- /**
1559
- * Name of the Google Nest structure containing the device. The device owner sets this value.
1560
- */
1561
- structure_name?: string | undefined
1562
- }
1563
- | undefined
1564
- /**
1565
- * Metadata for a NoiseAware device.
1566
- */
1567
- noiseaware_metadata?:
1568
- | {
1569
- /**
1570
- * Device ID for a NoiseAware device.
1571
- */
1572
- device_id?: string | undefined
1573
- /**
1574
- * Device model for a NoiseAware device.
1575
- */
1576
- device_model?: 'indoor' | 'outdoor' | undefined
1577
- /**
1578
- * Device name for a NoiseAware device.
1579
- */
1580
- device_name?: string | undefined
1581
- /**
1582
- * Noise level, in decibels, for a NoiseAware device.
1583
- */
1584
- noise_level_decibel?: number | undefined
1585
- /**
1586
- * Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.
1587
- */
1588
- noise_level_nrs?: number | undefined
1589
- }
1590
- | undefined
1591
- /**
1592
- * Metadata for a Nuki device.
1593
- */
1594
- nuki_metadata?:
1595
- | {
1596
- /**
1597
- * Device ID for a Nuki device.
1598
- */
1599
- device_id?: string | undefined
1600
- /**
1601
- * Device name for a Nuki device.
1602
- */
1603
- device_name?: string | undefined
1604
- /**
1605
- * Indicates whether keypad 2 is paired for a Nuki device.
1606
- */
1607
- keypad_2_paired?: boolean | undefined
1608
- /**
1609
- * Indicates whether the keypad battery is in a critical state for a Nuki device.
1610
- */
1611
- keypad_battery_critical?: boolean | undefined
1612
- /**
1613
- * Indicates whether the keypad is paired for a Nuki device.
1614
- */
1615
- keypad_paired?: boolean | undefined
1616
- }
1617
- | undefined
1618
- /**
1619
- * Metadata for an Omnitec device.
1620
- */
1621
- omnitec_metadata?:
1622
- | {
1623
- /**
1624
- * Whether the Omnitec lock has a connected gateway for remote operations.
1625
- */
1626
- has_gateway?: boolean | undefined
1627
- /**
1628
- * Operator-assigned alias for an Omnitec device.
1629
- */
1630
- lock_alias?: string | undefined
1631
- /**
1632
- * Lock ID for an Omnitec device.
1633
- */
1634
- lock_id?: number | undefined
1635
- /**
1636
- * Bluetooth MAC address for an Omnitec device.
1637
- */
1638
- lock_mac?: string | undefined
1639
- /**
1640
- * Lock name for an Omnitec device.
1641
- */
1642
- lock_name?: string | undefined
1643
- /**
1644
- * IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).
1645
- */
1646
- time_zone?: string | null | undefined
1647
- /**
1648
- * Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.
1649
- */
1650
- timezone_raw_offset_ms?: number | undefined
1651
- }
1652
- | undefined
1653
- /**
1654
- * Metadata for a Reolink camera.
1655
- */
1656
- reolink_metadata?:
1657
- | {
1658
- /**
1659
- * Firmware version reported by the camera.
1660
- */
1661
- firmware_version?: string | undefined
1662
- /**
1663
- * Hardware version reported by the camera.
1664
- */
1665
- hardware_version?: string | undefined
1666
- /**
1667
- * Model reported by the Reolink camera.
1668
- */
1669
- model?: string | undefined
1670
- }
1671
- | undefined
1672
- /**
1673
- * Metadata for a Ring device.
1674
- */
1675
- ring_metadata?:
1676
- | {
1677
- /**
1678
- * Device ID for a Ring device.
1679
- */
1680
- device_id?: string | undefined
1681
- /**
1682
- * Device name for a Ring device.
1683
- */
1684
- device_name?: string | undefined
1685
- }
1686
- | undefined
1687
- /**
1688
- * Metadata for a Salto KS device.
1689
- */
1690
- salto_ks_metadata?:
1691
- | {
1692
- /**
1693
- * Battery level for a Salto KS device.
1694
- */
1695
- battery_level?: string | undefined
1696
- /**
1697
- * Customer reference for a Salto KS device.
1698
- */
1699
- customer_reference?: string | undefined
1700
- /**
1701
- * Indicates whether the site has a Salto KS subscription that supports custom PINs.
1702
- */
1703
- has_custom_pin_subscription?: boolean | undefined
1704
- /**
1705
- * Lock ID for a Salto KS device.
1706
- */
1707
- lock_id?: string | undefined
1708
- /**
1709
- * Lock type for a Salto KS device.
1710
- */
1711
- lock_type?: string | undefined
1712
- /**
1713
- * Locked state for a Salto KS device.
1714
- */
1715
- locked_state?: string | undefined
1716
- /**
1717
- * Model for a Salto KS device.
1718
- */
1719
- model?: string | undefined
1720
- /**
1721
- * Site ID for the Salto KS site to which the device belongs.
1722
- */
1723
- site_id?: string | undefined
1724
- /**
1725
- * Site name for the Salto KS site to which the device belongs.
1726
- */
1727
- site_name?: string | undefined
1728
- }
1729
- | undefined
1730
- /**
1731
- * Metada for a Salto device.
1732
- * @deprecated Use `salto_ks_metadata` instead.
1733
- */
1734
- salto_metadata?:
1735
- | {
1736
- /**
1737
- * Battery level for a Salto device.
1738
- */
1739
- battery_level?: string | undefined
1740
- /**
1741
- * Customer reference for a Salto device.
1742
- */
1743
- customer_reference?: string | undefined
1744
- /**
1745
- * Lock ID for a Salto device.
1746
- */
1747
- lock_id?: string | undefined
1748
- /**
1749
- * Lock type for a Salto device.
1750
- */
1751
- lock_type?: string | undefined
1752
- /**
1753
- * Locked state for a Salto device.
1754
- */
1755
- locked_state?: string | undefined
1756
- /**
1757
- * Model for a Salto device.
1758
- */
1759
- model?: string | undefined
1760
- /**
1761
- * Site ID for the Salto KS site to which the device belongs.
1762
- */
1763
- site_id?: string | undefined
1764
- /**
1765
- * Site name for the Salto KS site to which the device belongs.
1766
- */
1767
- site_name?: string | undefined
1768
- }
1769
- | undefined
1770
- /**
1771
- * Metadata for a Schlage device.
1772
- */
1773
- schlage_metadata?:
1774
- | {
1775
- /**
1776
- * Device ID for a Schlage device.
1777
- */
1778
- device_id?: string | undefined
1779
- /**
1780
- * Device name for a Schlage device.
1781
- */
1782
- device_name?: string | undefined
1783
- /**
1784
- * Model for a Schlage device.
1785
- */
1786
- model?: string | undefined
1787
- }
1788
- | undefined
1789
- /**
1790
- * Metadata for Seam Bridge.
1791
- */
1792
- seam_bridge_metadata?:
1793
- | {
1794
- /**
1795
- * Device number for Seam Bridge.
1796
- */
1797
- device_num?: number | undefined
1798
- /**
1799
- * Name for Seam Bridge.
1800
- */
1801
- name?: string | undefined
1802
- /**
1803
- * Unlock method for Seam Bridge.
1804
- */
1805
- unlock_method?: 'bridge' | 'doorking' | undefined
1806
- }
1807
- | undefined
1808
- /**
1809
- * Metadata for a Sensi device.
1810
- */
1811
- sensi_metadata?:
1812
- | {
1813
- /**
1814
- * Device ID for a Sensi device.
1815
- */
1816
- device_id?: string | undefined
1817
- /**
1818
- * Device name for a Sensi device.
1819
- */
1820
- device_name?: string | undefined
1821
- /**
1822
- * Deprecated. Seam no longer sets this field.
1823
- */
1824
- dual_setpoints_not_supported?: boolean | undefined
1825
- /**
1826
- * Product type for a Sensi device.
1827
- */
1828
- product_type?: string | undefined
1829
- }
1830
- | undefined
1831
- /**
1832
- * Metadata for a SmartThings device.
1833
- */
1834
- smartthings_metadata?:
1835
- | {
1836
- /**
1837
- * Device ID for a SmartThings device.
1838
- */
1839
- device_id?: string | undefined
1840
- /**
1841
- * Device name for a SmartThings device.
1842
- */
1843
- device_name?: string | undefined
1844
- /**
1845
- * Location ID for a SmartThings device.
1846
- */
1847
- location_id?: string | undefined
1848
- /**
1849
- * Model for a SmartThings device.
1850
- */
1851
- model?: string | undefined
1852
- }
1853
- | undefined
1854
- /**
1855
- * Metadata for a tado° device.
1856
- */
1857
- tado_metadata?:
1858
- | {
1859
- /**
1860
- * Serial numbers of all tado° devices in the zone.
1861
- */
1862
- device_serial_numbers?: Array<string> | undefined
1863
- /**
1864
- * Device type of the main tado° device in the zone, such as `RU02`, `VA02` or `WR02`.
1865
- */
1866
- device_type?: string | undefined
1867
- /**
1868
- * Generation of the tado° home, such as `PRE_LINE_X`.
1869
- */
1870
- home_generation?: string | undefined
1871
- /**
1872
- * ID of the tado° home.
1873
- */
1874
- home_id?: string | undefined
1875
- /**
1876
- * Name of the tado° home.
1877
- */
1878
- home_name?: string | undefined
1879
- /**
1880
- * Serial number of the main tado° device in the zone, such as its wall thermostat or Smart AC Control.
1881
- */
1882
- serial_no?: string | undefined
1883
- /**
1884
- * ID of the tado° zone within its home.
1885
- */
1886
- zone_id?: string | undefined
1887
- /**
1888
- * Name of the tado° zone.
1889
- */
1890
- zone_name?: string | undefined
1891
- /**
1892
- * Type of the tado° zone: `HEATING` or `AIR_CONDITIONING`.
1893
- */
1894
- zone_type?: string | undefined
1895
- }
1896
- | undefined
1897
- /**
1898
- * Metadata for a Tapo camera.
1899
- */
1900
- tapo_metadata?:
1901
- | {
1902
- /**
1903
- * Firmware version reported by the camera.
1904
- */
1905
- firmware_version?: string | undefined
1906
- /**
1907
- * Hardware version reported by the camera.
1908
- */
1909
- hardware_version?: string | undefined
1910
- /**
1911
- * Model reported by the Tapo camera.
1912
- */
1913
- model?: string | undefined
1914
- }
1915
- | undefined
1916
- /**
1917
- * Metadata for a Tedee device.
1918
- */
1919
- tedee_metadata?:
1920
- | {
1921
- /**
1922
- * Bridge ID for a Tedee device.
1923
- */
1924
- bridge_id?: number | undefined
1925
- /**
1926
- * Bridge name for a Tedee device.
1927
- */
1928
- bridge_name?: string | undefined
1929
- /**
1930
- * Device ID for a Tedee device.
1931
- */
1932
- device_id?: number | undefined
1933
- /**
1934
- * Device model for a Tedee device.
1935
- */
1936
- device_model?: string | undefined
1937
- /**
1938
- * Device name for a Tedee device.
1939
- */
1940
- device_name?: string | undefined
1941
- /**
1942
- * Keypad ID for a Tedee device.
1943
- */
1944
- keypad_id?: number | undefined
1945
- /**
1946
- * Serial number for a Tedee device.
1947
- */
1948
- serial_number?: string | undefined
1949
- }
1950
- | undefined
1951
- /**
1952
- * Metadata for a TTLock device.
1953
- */
1954
- ttlock_metadata?:
1955
- | {
1956
- /**
1957
- * Feature value for a TTLock device.
1958
- */
1959
- feature_value?: string | undefined
1960
- /**
1961
- * Features for a TTLock device.
1962
- */
1963
- features?:
1964
- | {
1965
- /**
1966
- * Indicates whether a TTLock device supports auto-lock time configuration.
1967
- */
1968
- auto_lock_time_config?: boolean | undefined
1969
- /**
1970
- * Indicates whether a TTLock device supports an incomplete keyboard passcode.
1971
- */
1972
- incomplete_keyboard_passcode?: boolean | undefined
1973
- /**
1974
- * Indicates whether a TTLock device supports the lock command.
1975
- */
1976
- lock_command?: boolean | undefined
1977
- /**
1978
- * Indicates whether a TTLock device supports a passcode.
1979
- */
1980
- passcode?: boolean | undefined
1981
- /**
1982
- * Indicates whether a TTLock device supports passcode management.
1983
- */
1984
- passcode_management?: boolean | undefined
1985
- /**
1986
- * Indicates whether a TTLock device supports unlock via gateway.
1987
- */
1988
- unlock_via_gateway?: boolean | undefined
1989
- /**
1990
- * Indicates whether a TTLock device supports Wi-Fi.
1991
- */
1992
- wifi?: boolean | undefined
1993
- }
1994
- | undefined
1995
- /**
1996
- * Indicates whether a TTLock device has a gateway.
1997
- */
1998
- has_gateway?: boolean | undefined
1999
- /**
2000
- * Lock alias for a TTLock device.
2001
- */
2002
- lock_alias?: string | undefined
2003
- /**
2004
- * Lock ID for a TTLock device.
2005
- */
2006
- lock_id?: number | undefined
2007
- /**
2008
- * Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock's wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer "codes offset by N hours" reports. Diagnostic only; Seam does not convert times based on this value.
2009
- */
2010
- timezone_raw_offset_ms?: number | null | undefined
2011
- /**
2012
- * Wireless keypads for a TTLock device.
2013
- */
2014
- wireless_keypads?:
2015
- | Array<{
2016
- /**
2017
- * ID for a wireless keypad for a TTLock device.
2018
- */
2019
- wireless_keypad_id?: number | undefined
2020
- /**
2021
- * Name for a wireless keypad for a TTLock device.
2022
- */
2023
- wireless_keypad_name?: string | undefined
2024
- }>
2025
- | undefined
2026
- }
2027
- | undefined
2028
- /**
2029
- * Metadata for a 2N device.
2030
- */
2031
- two_n_metadata?:
2032
- | {
2033
- /**
2034
- * Device ID for a 2N device.
2035
- */
2036
- device_id?: number | undefined
2037
- /**
2038
- * Device name for a 2N device.
2039
- */
2040
- device_name?: string | undefined
2041
- }
2042
- | undefined
2043
- /**
2044
- * Metadata for an Ultraloq device.
2045
- */
2046
- ultraloq_metadata?:
2047
- | {
2048
- /**
2049
- * Device ID for an Ultraloq device.
2050
- */
2051
- device_id?: string | undefined
2052
- /**
2053
- * Device name for an Ultraloq device.
2054
- */
2055
- device_name?: string | undefined
2056
- /**
2057
- * Device type for an Ultraloq device.
2058
- */
2059
- device_type?: string | undefined
2060
- /**
2061
- * IANA timezone for the Ultraloq device.
2062
- */
2063
- time_zone?: string | null | undefined
2064
- }
2065
- | undefined
2066
- /**
2067
- * Metadata for a UniFi Protect camera.
2068
- */
2069
- unifi_protect_metadata?:
2070
- | {
2071
- /**
2072
- * Camera ID reported by UniFi Protect.
2073
- */
2074
- camera_id?: string | undefined
2075
- /**
2076
- * Camera name reported by UniFi Protect.
2077
- */
2078
- camera_name?: string | undefined
2079
- /**
2080
- * Whether the camera has a microphone.
2081
- */
2082
- has_mic?: boolean | undefined
2083
- /**
2084
- * MAC address reported by the UniFi Protect camera.
2085
- */
2086
- mac?: string | undefined
2087
- /**
2088
- * Model reported by the UniFi Protect camera.
2089
- */
2090
- model?: string | undefined
2091
- /**
2092
- * Name of the UniFi Protect console that manages the camera.
2093
- */
2094
- nvr_name?: string | undefined
2095
- }
2096
- | undefined
2097
- /**
2098
- * Metadata for an ASSA ABLOY Visionline system.
2099
- */
2100
- visionline_metadata?:
2101
- | {
2102
- /**
2103
- * Encoder ID for an ASSA ABLOY Visionline system.
2104
- */
2105
- encoder_id?: string | undefined
2106
- }
2107
- | undefined
2108
- /**
2109
- * Metadata for a Wyze device.
2110
- */
2111
- wyze_metadata?:
2112
- | {
2113
- /**
2114
- * Device ID for a Wyze device.
2115
- */
2116
- device_id?: string | undefined
2117
- /**
2118
- * Device information model for a Wyze device.
2119
- */
2120
- device_info_model?: string | undefined
2121
- /**
2122
- * Device name for a Wyze device.
2123
- */
2124
- device_name?: string | undefined
2125
- /**
2126
- * Keypad UUID for a Wyze device.
2127
- */
2128
- keypad_uuid?: string | undefined
2129
- /**
2130
- * Locker status (hardlock) for a Wyze device.
2131
- */
2132
- locker_status_hardlock?: number | undefined
2133
- /**
2134
- * Product model for a Wyze device.
2135
- */
2136
- product_model?: string | undefined
2137
- /**
2138
- * Product name for a Wyze device.
2139
- */
2140
- product_name?: string | undefined
2141
- /**
2142
- * Product type for a Wyze device.
2143
- */
2144
- product_type?: string | undefined
2145
- }
2146
- | undefined
2147
- /**
2148
- * Metadata for a Yacan device.
2149
- */
2150
- yacan_metadata?:
2151
- | {
2152
- /**
2153
- * Device ID for a Yacan device.
2154
- */
2155
- device_id?: string | undefined
2156
- /**
2157
- * Device name for a Yacan device.
2158
- */
2159
- device_name?: string | undefined
2160
- /**
2161
- * Device type for a Yacan device.
2162
- */
2163
- device_type?: string | undefined
2164
- /**
2165
- * Serial number for a Yacan device.
2166
- */
2167
- serial_number?: string | undefined
2168
- }
2169
- | undefined
2170
- /**
2171
- * Metadata for a Yale Connect lock.
2172
- */
2173
- yale_connect_metadata?:
2174
- | {
2175
- /**
2176
- * Device ID for a Yale Connect lock.
2177
- */
2178
- device_id?: string | undefined
2179
- /**
2180
- * Device name for a Yale Connect lock.
2181
- */
2182
- device_name?: string | undefined
2183
- /**
2184
- * Firmware version reported by the Yale Connect lock.
2185
- */
2186
- firmware_version?: string | undefined
2187
- /**
2188
- * Name of the Yale Connect home that contains the lock.
2189
- */
2190
- home_name?: string | undefined
2191
- /**
2192
- * Model reported by the Yale Connect lock.
2193
- */
2194
- model?: string | undefined
2195
- /**
2196
- * Time zone of the Yale Connect home, as Yale reports it.
2197
- */
2198
- time_zone_description?: string | undefined
2199
- }
2200
- | undefined
2201
- /**
2202
- * The delay in seconds before the lock automatically locks after being unlocked.
2203
- */
2204
- auto_lock_delay_seconds?: number | undefined
2205
- /**
2206
- * Indicates whether automatic locking is enabled.
2207
- */
2208
- auto_lock_enabled?: boolean | undefined
2209
- /**
2210
- * Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update).
2211
- */
2212
- backup_access_code_pool_enabled?: boolean | undefined
2213
- /**
2214
- * 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.
2215
- */
2216
- code_constraints?:
2217
- | Array<{
2218
- constraint_type:
2219
- | 'no_zeros'
2220
- | 'cannot_start_with_12'
2221
- | 'no_triple_consecutive_ints'
2222
- | 'cannot_specify_pin_code'
2223
- | 'pin_code_matches_existing_set'
2224
- | 'start_date_in_future'
2225
- | 'no_ascending_or_descending_sequence'
2226
- | 'at_least_three_unique_digits'
2227
- | 'cannot_contain_089'
2228
- | 'cannot_contain_0789'
2229
- | 'unique_first_four_digits'
2230
- | 'no_all_same_digits'
2231
- | 'name_length'
2232
- | 'name_must_be_unique'
2233
-
2234
- /**
2235
- * Maximum name length constraint for access codes.
2236
- */
2237
- max_length?: number | undefined
2238
- /**
2239
- * Minimum name length constraint for access codes.
2240
- */
2241
- min_length?: number | undefined
2242
- }>
2243
- | undefined
2244
- /**
2245
- * Indicates whether the door is open.
2246
- */
2247
- door_open?: boolean | undefined
2248
- /**
2249
- * Indicates whether the device supports native entry events.
2250
- */
2251
- has_native_entry_events?: boolean | undefined
2252
- /**
2253
- * Keypad battery status.
2254
- */
2255
- keypad_battery?:
2256
- | {
2257
- /**
2258
- * Keypad battery charge level.
2259
- */
2260
- level: number
2261
- }
2262
- | undefined
2263
- /**
2264
- * Indicates whether the lock is locked.
2265
- */
2266
- locked?: boolean | undefined
2267
- /**
2268
- * Maximum number of active access codes that the device supports.
2269
- */
2270
- max_active_codes_supported?: number | undefined
2271
- /**
2272
- * Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.
2273
- */
2274
- offline_time_frame_options?:
2275
- | Array<{
2276
- /**
2277
- * Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).
2278
- */
2279
- display_name: string
2280
-
2281
- /**
2282
- * iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.
2283
- */
2284
- end_date_recurrence_rule?: string | undefined
2285
- /**
2286
- * When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
2287
- */
2288
- matching_start_end_time?: true | undefined
2289
- /**
2290
- * Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
2291
- */
2292
- max_duration?: string | undefined
2293
- /**
2294
- * Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.
2295
- */
2296
- min_duration?: string | undefined
2297
- /**
2298
- * iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.
2299
- */
2300
- start_date_recurrence_rule?: string | undefined
2301
- /**
2302
- * Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.
2303
- */
2304
- time_pairs?:
2305
- | Array<{
2306
- /**
2307
- * Label for the start/end time pairing.
2308
- */
2309
- display_name: string
2310
-
2311
- /**
2312
- * End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.
2313
- */
2314
- end_time: string
2315
-
2316
- /**
2317
- * Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.
2318
- */
2319
- start_time: string
2320
- }>
2321
- | undefined
2322
- /**
2323
- * IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.
2324
- */
2325
- time_zone?: string | undefined
2326
- }>
2327
- | undefined
2328
- /**
2329
- * Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.
2330
- */
2331
- online_time_frame_options?:
2332
- | Array<{
2333
- /**
2334
- * Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).
2335
- */
2336
- display_name: string
2337
-
2338
- /**
2339
- * iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.
2340
- */
2341
- end_date_recurrence_rule?: string | undefined
2342
- /**
2343
- * When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
2344
- */
2345
- matching_start_end_time?: true | undefined
2346
- /**
2347
- * Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
2348
- */
2349
- max_duration?: string | undefined
2350
- /**
2351
- * Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.
2352
- */
2353
- min_duration?: string | undefined
2354
- /**
2355
- * iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.
2356
- */
2357
- start_date_recurrence_rule?: string | undefined
2358
- /**
2359
- * Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.
2360
- */
2361
- time_pairs?:
2362
- | Array<{
2363
- /**
2364
- * Label for the start/end time pairing.
2365
- */
2366
- display_name: string
2367
-
2368
- /**
2369
- * End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.
2370
- */
2371
- end_time: string
2372
-
2373
- /**
2374
- * Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.
2375
- */
2376
- start_time: string
2377
- }>
2378
- | undefined
2379
- /**
2380
- * IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.
2381
- */
2382
- time_zone?: string | undefined
2383
- }>
2384
- | undefined
2385
- /**
2386
- * Supported code lengths for access codes.
2387
- */
2388
- supported_code_lengths?: Array<number> | undefined
2389
- /**
2390
- * Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
2391
- */
2392
- supports_backup_access_code_pool?: boolean | undefined
2393
- /**
2394
- * Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2395
- * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
2396
- */
2397
- active_thermostat_schedule?:
2398
- | {
2399
- /**
2400
- * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2401
- */
2402
- climate_preset_key: string
2403
-
2404
- /**
2405
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
2406
- */
2407
- created_at: string
2408
-
2409
- /**
2410
- * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
2411
- */
2412
- device_id: string
2413
-
2414
- /**
2415
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2416
- */
2417
- ends_at: string
2418
-
2419
- /**
2420
- * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2421
- */
2422
- errors: Array<{
2423
- /**
2424
- * Date and time at which Seam created the error.
2425
- */
2426
- created_at: string
2427
-
2428
- /**
2429
- * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
2430
- */
2431
- error_code: string
2432
-
2433
- /**
2434
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2435
- */
2436
- message: string
2437
- }>
2438
-
2439
- /**
2440
- * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
2441
- */
2442
- is_override_allowed?: boolean | undefined
2443
- /**
2444
- * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
2445
- */
2446
- max_override_period_minutes?: number | null | undefined
2447
- /**
2448
- * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2449
- */
2450
- name: string | null
2451
- /**
2452
- * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2453
- */
2454
- starts_at: string
2455
-
2456
- /**
2457
- * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2458
- */
2459
- thermostat_schedule_id: string
2460
-
2461
- /**
2462
- * ID of the workspace that contains the thermostat schedule.
2463
- */
2464
- workspace_id: string
2465
- }
2466
- | null
2467
- | undefined
2468
- /**
2469
- * ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
2470
- */
2471
- active_thermostat_schedule_id?: string | null | undefined
2472
- /**
2473
- * Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
2474
- */
2475
- available_climate_preset_modes?:
2476
- | Array<'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied'>
2477
- | undefined
2478
- /**
2479
- * Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
2480
- */
2481
- available_climate_presets?:
2482
- | Array<{
2483
- /**
2484
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2485
- */
2486
- can_delete: boolean
2487
-
2488
- /**
2489
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2490
- */
2491
- can_edit: boolean
2492
-
2493
- /**
2494
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2495
- */
2496
- can_use_with_thermostat_daily_programs: boolean
2497
-
2498
- /**
2499
- * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2500
- */
2501
- climate_preset_key: string
2502
-
2503
- /**
2504
- * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2505
- */
2506
- climate_preset_mode?:
2507
- | 'home'
2508
- | 'away'
2509
- | 'wake'
2510
- | 'sleep'
2511
- | 'occupied'
2512
- | 'unoccupied'
2513
- | undefined
2514
- /**
2515
- * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2516
- */
2517
- cooling_set_point_celsius?: number | undefined
2518
- /**
2519
- * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2520
- */
2521
- cooling_set_point_fahrenheit?: number | undefined
2522
- /**
2523
- * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2524
- */
2525
- display_name: string
2526
-
2527
- /**
2528
- * Metadata specific to the Ecobee climate, if applicable.
2529
- */
2530
- ecobee_metadata?:
2531
- | {
2532
- /**
2533
- * Reference to the Ecobee climate, if applicable.
2534
- */
2535
- climate_ref?: string | undefined
2536
- /**
2537
- * Indicates if the climate preset is optimized by Ecobee.
2538
- */
2539
- is_optimized?: boolean | undefined
2540
- /**
2541
- * Indicates whether the climate preset is owned by the user or the system.
2542
- */
2543
- owner?: 'user' | 'system' | undefined
2544
- }
2545
- | undefined
2546
- /**
2547
- * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2548
- */
2549
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2550
- /**
2551
- * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2552
- */
2553
- heating_set_point_celsius?: number | undefined
2554
- /**
2555
- * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2556
- */
2557
- heating_set_point_fahrenheit?: number | undefined
2558
- /**
2559
- * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2560
- */
2561
- hvac_mode_setting?:
2562
- 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
2563
- /**
2564
- * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
2565
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2566
- */
2567
- manual_override_allowed: boolean
2568
-
2569
- /**
2570
- * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2571
- */
2572
- name?: string | null | undefined
2573
- }>
2574
- | undefined
2575
- /**
2576
- * Fan mode settings that the thermostat supports.
2577
- */
2578
- available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined
2579
- /**
2580
- * HVAC mode settings that the thermostat supports.
2581
- */
2582
- available_hvac_mode_settings?:
2583
- Array<'off' | 'heat' | 'cool' | 'heat_cool' | 'eco'> | undefined
2584
- /**
2585
- * Current climate setting.
2586
- */
2587
- current_climate_setting?:
2588
- | {
2589
- /**
2590
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2591
- */
2592
- can_delete?: boolean | undefined
2593
- /**
2594
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2595
- */
2596
- can_edit?: boolean | undefined
2597
- /**
2598
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2599
- */
2600
- can_use_with_thermostat_daily_programs?: boolean | undefined
2601
- /**
2602
- * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2603
- */
2604
- climate_preset_key?: string | undefined
2605
- /**
2606
- * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2607
- */
2608
- climate_preset_mode?:
2609
- | 'home'
2610
- | 'away'
2611
- | 'wake'
2612
- | 'sleep'
2613
- | 'occupied'
2614
- | 'unoccupied'
2615
- | undefined
2616
- /**
2617
- * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2618
- */
2619
- cooling_set_point_celsius?: number | undefined
2620
- /**
2621
- * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2622
- */
2623
- cooling_set_point_fahrenheit?: number | undefined
2624
- /**
2625
- * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2626
- */
2627
- display_name?: string | undefined
2628
- /**
2629
- * Metadata specific to the Ecobee climate, if applicable.
2630
- */
2631
- ecobee_metadata?:
2632
- | {
2633
- /**
2634
- * Reference to the Ecobee climate, if applicable.
2635
- */
2636
- climate_ref?: string | undefined
2637
- /**
2638
- * Indicates if the climate preset is optimized by Ecobee.
2639
- */
2640
- is_optimized?: boolean | undefined
2641
- /**
2642
- * Indicates whether the climate preset is owned by the user or the system.
2643
- */
2644
- owner?: 'user' | 'system' | undefined
2645
- }
2646
- | undefined
2647
- /**
2648
- * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2649
- */
2650
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2651
- /**
2652
- * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2653
- */
2654
- heating_set_point_celsius?: number | undefined
2655
- /**
2656
- * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2657
- */
2658
- heating_set_point_fahrenheit?: number | undefined
2659
- /**
2660
- * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2661
- */
2662
- hvac_mode_setting?:
2663
- 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
2664
- /**
2665
- * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
2666
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2667
- */
2668
- manual_override_allowed?: boolean | undefined
2669
- /**
2670
- * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2671
- */
2672
- name?: string | null | undefined
2673
- }
2674
- | undefined
2675
- /**
2676
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead.
2677
- */
2678
- default_climate_setting?:
2679
- | {
2680
- /**
2681
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
2682
- */
2683
- can_delete?: boolean | undefined
2684
- /**
2685
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
2686
- */
2687
- can_edit?: boolean | undefined
2688
- /**
2689
- * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
2690
- */
2691
- can_use_with_thermostat_daily_programs?: boolean | undefined
2692
- /**
2693
- * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2694
- */
2695
- climate_preset_key?: string | undefined
2696
- /**
2697
- * The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
2698
- */
2699
- climate_preset_mode?:
2700
- | 'home'
2701
- | 'away'
2702
- | 'wake'
2703
- | 'sleep'
2704
- | 'occupied'
2705
- | 'unoccupied'
2706
- | undefined
2707
- /**
2708
- * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2709
- */
2710
- cooling_set_point_celsius?: number | undefined
2711
- /**
2712
- * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2713
- */
2714
- cooling_set_point_fahrenheit?: number | undefined
2715
- /**
2716
- * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2717
- */
2718
- display_name?: string | undefined
2719
- /**
2720
- * Metadata specific to the Ecobee climate, if applicable.
2721
- */
2722
- ecobee_metadata?:
2723
- | {
2724
- /**
2725
- * Reference to the Ecobee climate, if applicable.
2726
- */
2727
- climate_ref?: string | undefined
2728
- /**
2729
- * Indicates if the climate preset is optimized by Ecobee.
2730
- */
2731
- is_optimized?: boolean | undefined
2732
- /**
2733
- * Indicates whether the climate preset is owned by the user or the system.
2734
- */
2735
- owner?: 'user' | 'system' | undefined
2736
- }
2737
- | undefined
2738
- /**
2739
- * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
2740
- */
2741
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2742
- /**
2743
- * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2744
- */
2745
- heating_set_point_celsius?: number | undefined
2746
- /**
2747
- * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
2748
- */
2749
- heating_set_point_fahrenheit?: number | undefined
2750
- /**
2751
- * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
2752
- */
2753
- hvac_mode_setting?:
2754
- 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
2755
- /**
2756
- * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
2757
- * @deprecated Use 'thermostat_schedule.is_override_allowed'
2758
- */
2759
- manual_override_allowed?: boolean | undefined
2760
- /**
2761
- * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
2762
- */
2763
- name?: string | null | undefined
2764
- }
2765
- | undefined
2766
- /**
2767
- * Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
2768
- */
2769
- fallback_climate_preset_key?: string | null | undefined
2770
- /**
2771
- * @deprecated Use `current_climate_setting.fan_mode_setting` instead.
2772
- */
2773
- fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
2774
- /**
2775
- * Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
2776
- */
2777
- is_cooling?: boolean | undefined
2778
- /**
2779
- * Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.
2780
- */
2781
- is_fan_running?: boolean | undefined
2782
- /**
2783
- * Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.
2784
- */
2785
- is_heating?: boolean | undefined
2786
- /**
2787
- * 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`.
2788
- */
2789
- is_temporary_manual_override_active?: boolean | undefined
2790
- /**
2791
- * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
2792
- */
2793
- max_cooling_set_point_celsius?: number | undefined
2794
- /**
2795
- * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
2796
- */
2797
- max_cooling_set_point_fahrenheit?: number | undefined
2798
- /**
2799
- * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
2800
- */
2801
- max_heating_set_point_celsius?: number | undefined
2802
- /**
2803
- * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
2804
- */
2805
- max_heating_set_point_fahrenheit?: number | undefined
2806
- /**
2807
- * Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.
2808
- */
2809
- max_thermostat_daily_program_periods_per_day?: number | undefined
2810
- /**
2811
- * Maximum number of climate presets that the thermostat can support for weekly programming.
2812
- */
2813
- max_unique_climate_presets_per_thermostat_weekly_program?:
2814
- number | undefined
2815
- /**
2816
- * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
2817
- */
2818
- min_cooling_set_point_celsius?: number | undefined
2819
- /**
2820
- * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
2821
- */
2822
- min_cooling_set_point_fahrenheit?: number | undefined
2823
- /**
2824
- * Minimum [temperature difference](https://www.seam.co/docs/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.
2825
- */
2826
- min_heating_cooling_delta_celsius?: number | undefined
2827
- /**
2828
- * Minimum [temperature difference](https://www.seam.co/docs/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.
2829
- */
2830
- min_heating_cooling_delta_fahrenheit?: number | undefined
2831
- /**
2832
- * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
2833
- */
2834
- min_heating_set_point_celsius?: number | undefined
2835
- /**
2836
- * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
2837
- */
2838
- min_heating_set_point_fahrenheit?: number | undefined
2839
- /**
2840
- * Reported relative humidity, as a value between 0 and 1, inclusive.
2841
- */
2842
- relative_humidity?: number | undefined
2843
- /**
2844
- * Reported temperature in °C.
2845
- */
2846
- temperature_celsius?: number | undefined
2847
- /**
2848
- * Reported temperature in °F.
2849
- */
2850
- temperature_fahrenheit?: number | undefined
2851
- /**
2852
- * Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2853
- */
2854
- temperature_threshold?:
2855
- | {
2856
- /**
2857
- * Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2858
- */
2859
- lower_limit_celsius: number | null
2860
- /**
2861
- * Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2862
- */
2863
- lower_limit_fahrenheit: number | null
2864
- /**
2865
- * Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2866
- */
2867
- upper_limit_celsius: number | null
2868
- /**
2869
- * Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
2870
- */
2871
- upper_limit_fahrenheit: number | null
2872
- }
2873
- | undefined
2874
- /**
2875
- * Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.
2876
- */
2877
- thermostat_daily_program_period_precision_minutes?: number | undefined
2878
- /**
2879
- * Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
2880
- */
2881
- thermostat_daily_programs?:
2882
- | Array<{
2883
- /**
2884
- * Date and time at which the thermostat daily program was created.
2885
- */
2886
- created_at: string
2887
-
2888
- /**
2889
- * ID of the thermostat device on which the thermostat daily program is configured.
2890
- */
2891
- device_id: string
2892
-
2893
- /**
2894
- * User-friendly name to identify the thermostat daily program.
2895
- */
2896
- name: string | null
2897
- /**
2898
- * Array of thermostat daily program periods.
2899
- */
2900
- periods: Array<{
2901
- /**
2902
- * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
2903
- */
2904
- climate_preset_key: string
2905
-
2906
- /**
2907
- * Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2908
- */
2909
- starts_at_time: string
2910
- }>
2911
-
2912
- /**
2913
- * ID of the thermostat daily program.
2914
- */
2915
- thermostat_daily_program_id: string
2916
-
2917
- /**
2918
- * ID of the workspace that contains the thermostat daily program.
2919
- */
2920
- workspace_id: string
2921
- }>
2922
- | undefined
2923
- /**
2924
- * Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
2925
- */
2926
- thermostat_weekly_program?:
2927
- | {
2928
- /**
2929
- * Date and time at which the thermostat weekly program was created.
2930
- */
2931
- created_at: string
2932
-
2933
- /**
2934
- * ID of the thermostat daily program to run on Fridays.
2935
- */
2936
- friday_program_id: string | null
2937
- /**
2938
- * ID of the thermostat daily program to run on Mondays.
2939
- */
2940
- monday_program_id: string | null
2941
- /**
2942
- * ID of the thermostat daily program to run on Saturdays.
2943
- */
2944
- saturday_program_id: string | null
2945
- /**
2946
- * ID of the thermostat daily program to run on Sundays.
2947
- */
2948
- sunday_program_id: string | null
2949
- /**
2950
- * ID of the thermostat daily program to run on Thursdays.
2951
- */
2952
- thursday_program_id: string | null
2953
- /**
2954
- * ID of the thermostat daily program to run on Tuesdays.
2955
- */
2956
- tuesday_program_id: string | null
2957
- /**
2958
- * ID of the thermostat daily program to run on Wednesdays.
2959
- */
2960
- wednesday_program_id: string | null
2961
- }
2962
- | null
2963
- | undefined
2964
- }
2965
-
2966
- /**
2967
- * IDs of the spaces the device is in.
2968
- */
2969
- space_ids: Array<string>
2970
-
2971
- /**
2972
- * Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
2973
- */
2974
- warnings: Array<
2975
- /**
2976
- * Indicates that the backup access code is unhealthy.
2977
- */
2978
- | {
2979
- /**
2980
- * Date and time at which Seam created the warning.
2981
- */
2982
- created_at: string
2983
-
2984
- /**
2985
- * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2986
- */
2987
- message: string
2988
-
2989
- /**
2990
- * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2991
- */
2992
- warning_code: 'partial_backup_access_code_pool'
2993
- } /**
2994
- * Indicates that there are too many backup codes.
2995
- */
2996
- | {
2997
- /**
2998
- * Date and time at which Seam created the warning.
2999
- */
3000
- created_at: string
3001
-
3002
- /**
3003
- * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
3004
- */
3005
- message: string
3006
-
3007
- /**
3008
- * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3009
- */
3010
- warning_code: 'many_active_backup_codes'
3011
- } /**
3012
- * Indicates that a third-party integration has been detected.
3013
- */
3014
- | {
3015
- /**
3016
- * Date and time at which Seam created the warning.
3017
- */
3018
- created_at: string
3019
-
3020
- /**
3021
- * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
3022
- */
3023
- message: string
3024
-
3025
- /**
3026
- * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3027
- */
3028
- warning_code: 'third_party_integration_detected'
3029
- } /**
3030
- * Indicates that the Remote Unlock feature is not enabled in the settings."
2941
+ | {
2942
+ /**
2943
+ * Date and time at which Seam created the warning.
2944
+ */
2945
+ created_at: string
2946
+
2947
+ /**
2948
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
2949
+ */
2950
+ message: string
2951
+
2952
+ /**
2953
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
2954
+ */
2955
+ warning_code: 'third_party_integration_detected'
2956
+ } /**
2957
+ * Indicates that the Remote Unlock feature is not enabled in the settings."
3031
2958
  */
3032
2959
  | {
3033
2960
  /**
@@ -3369,6 +3296,24 @@ export type Device = {
3369
3296
  */
3370
3297
  warning_code: 'hub_required_for_additional_capabilities'
3371
3298
  } /**
3299
+ * Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
3300
+ */
3301
+ | {
3302
+ /**
3303
+ * Date and time at which Seam created the warning.
3304
+ */
3305
+ created_at: string
3306
+
3307
+ /**
3308
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
3309
+ */
3310
+ message: string
3311
+
3312
+ /**
3313
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3314
+ */
3315
+ warning_code: 'service_mode'
3316
+ } /**
3372
3317
  * Indicates a provider-specific issue that may affect device functionality.
3373
3318
  */
3374
3319
  | {
@@ -3487,6 +3432,24 @@ export type Device = {
3487
3432
  */
3488
3433
  warning_code: 'max_access_codes_reached'
3489
3434
  } /**
3435
+ * Indicates that a third-party subscription is required to enable additional device capabilities.
3436
+ */
3437
+ | {
3438
+ /**
3439
+ * Date and time at which Seam created the warning.
3440
+ */
3441
+ created_at: string
3442
+
3443
+ /**
3444
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
3445
+ */
3446
+ message: string
3447
+
3448
+ /**
3449
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3450
+ */
3451
+ warning_code: 'subscription_required_for_additional_capabilities'
3452
+ } /**
3490
3453
  * Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
3491
3454
  */
3492
3455
  | {