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