@seamapi/types 1.42.0 → 1.43.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.
@@ -681,12 +681,21 @@ declare const _default: {
681
681
  };
682
682
  model: {
683
683
  properties: {
684
+ access_codes_supported: {
685
+ type: string;
686
+ };
687
+ accessory_keypad_supported: {
688
+ type: string;
689
+ };
684
690
  display_name: {
685
691
  type: string;
686
692
  };
687
693
  manufacturer_display_name: {
688
694
  type: string;
689
695
  };
696
+ offline_access_codes_supported: {
697
+ type: string;
698
+ };
690
699
  };
691
700
  required: string[];
692
701
  type: string;
@@ -694,16 +703,26 @@ declare const _default: {
694
703
  name: {
695
704
  type: string;
696
705
  };
706
+ offline_access_codes_enabled: {
707
+ description: string;
708
+ type: string;
709
+ };
697
710
  online: {
698
711
  type: string;
699
712
  };
713
+ online_access_codes_enabled: {
714
+ description: string;
715
+ type: string;
716
+ };
700
717
  serial_number: {
701
718
  type: string;
702
719
  };
703
720
  supports_accessory_keypad: {
721
+ description: string;
704
722
  type: string;
705
723
  };
706
724
  supports_offline_access_codes: {
725
+ description: string;
707
726
  type: string;
708
727
  };
709
728
  august_metadata?: never;
@@ -1211,7 +1230,9 @@ declare const _default: {
1211
1230
  manufacturer?: never;
1212
1231
  model?: never;
1213
1232
  name?: never;
1233
+ offline_access_codes_enabled?: never;
1214
1234
  online?: never;
1235
+ online_access_codes_enabled?: never;
1215
1236
  serial_number?: never;
1216
1237
  supports_accessory_keypad?: never;
1217
1238
  supports_offline_access_codes?: never;
@@ -8660,10 +8681,10 @@ declare const _default: {
8660
8681
  schema: {
8661
8682
  properties: {
8662
8683
  device: {
8663
- nullable: boolean;
8684
+ $ref: string;
8664
8685
  };
8665
8686
  lock: {
8666
- nullable: boolean;
8687
+ $ref: string;
8667
8688
  };
8668
8689
  ok: {
8669
8690
  type: string;
@@ -8782,10 +8803,16 @@ declare const _default: {
8782
8803
  schema: {
8783
8804
  properties: {
8784
8805
  devices: {
8785
- nullable: boolean;
8806
+ items: {
8807
+ $ref: string;
8808
+ };
8809
+ type: string;
8786
8810
  };
8787
8811
  locks: {
8788
- nullable: boolean;
8812
+ items: {
8813
+ $ref: string;
8814
+ };
8815
+ type: string;
8789
8816
  };
8790
8817
  ok: {
8791
8818
  type: string;
@@ -13748,6 +13775,9 @@ interface Routes {
13748
13775
  model: {
13749
13776
  display_name: string;
13750
13777
  manufacturer_display_name: string;
13778
+ offline_access_codes_supported?: boolean | undefined;
13779
+ access_codes_supported?: boolean | undefined;
13780
+ accessory_keypad_supported?: boolean | undefined;
13751
13781
  };
13752
13782
  has_direct_power?: boolean | undefined;
13753
13783
  battery_level?: number | undefined;
@@ -13759,7 +13789,13 @@ interface Routes {
13759
13789
  image_url?: string | undefined;
13760
13790
  image_alt_text?: string | undefined;
13761
13791
  serial_number?: string | undefined;
13792
+ /** Currently possible to use online access codes */
13793
+ online_access_codes_enabled?: boolean | undefined;
13794
+ /** Currently possible to use offline access codes */
13795
+ offline_access_codes_enabled?: boolean | undefined;
13796
+ /** Deprecated: use model.offline_access_codes_enabled. */
13762
13797
  supports_accessory_keypad?: boolean | undefined;
13798
+ /** Deprecated: use model.accessory_keypad_supported. */
13763
13799
  supports_offline_access_codes?: boolean | undefined;
13764
13800
  } & {
13765
13801
  august_metadata?: {
@@ -14158,6 +14194,9 @@ interface Routes {
14158
14194
  model: {
14159
14195
  display_name: string;
14160
14196
  manufacturer_display_name: string;
14197
+ offline_access_codes_supported?: boolean | undefined;
14198
+ access_codes_supported?: boolean | undefined;
14199
+ accessory_keypad_supported?: boolean | undefined;
14161
14200
  };
14162
14201
  has_direct_power?: boolean | undefined;
14163
14202
  battery_level?: number | undefined;
@@ -14169,7 +14208,13 @@ interface Routes {
14169
14208
  image_url?: string | undefined;
14170
14209
  image_alt_text?: string | undefined;
14171
14210
  serial_number?: string | undefined;
14211
+ /** Currently possible to use online access codes */
14212
+ online_access_codes_enabled?: boolean | undefined;
14213
+ /** Currently possible to use offline access codes */
14214
+ offline_access_codes_enabled?: boolean | undefined;
14215
+ /** Deprecated: use model.offline_access_codes_enabled. */
14172
14216
  supports_accessory_keypad?: boolean | undefined;
14217
+ /** Deprecated: use model.accessory_keypad_supported. */
14173
14218
  supports_offline_access_codes?: boolean | undefined;
14174
14219
  } & {
14175
14220
  august_metadata?: {
@@ -14711,8 +14756,8 @@ interface Routes {
14711
14756
  device_ids?: string[] | undefined;
14712
14757
  access_code_id?: string | undefined;
14713
14758
  access_code_ids?: string[] | undefined;
14714
- event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled') | undefined;
14715
- event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled'> | undefined;
14759
+ event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled') | undefined;
14760
+ event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled'> | undefined;
14716
14761
  connected_account_id?: string | undefined;
14717
14762
  };
14718
14763
  formData: {};
@@ -14813,32 +14858,1580 @@ interface Routes {
14813
14858
  };
14814
14859
  formData: {};
14815
14860
  jsonResponse: {
14816
- lock?: any;
14817
- device?: any;
14818
- };
14819
- };
14820
- '/locks/list': {
14821
- route: '/locks/list';
14822
- method: 'GET' | 'POST';
14823
- queryParams: {};
14824
- jsonBody: {};
14825
- commonParams: {
14826
- /** List all devices owned by this connected account */
14827
- connected_account_id?: string | undefined;
14828
- connected_account_ids?: string[] | undefined;
14829
- connect_webview_id?: string | undefined;
14830
- device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
14831
- device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
14832
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
14833
- device_ids?: string[] | undefined;
14834
- limit?: number;
14835
- created_before?: Date | undefined;
14836
- user_identifier_key?: string | undefined;
14837
- };
14838
- formData: {};
14839
- jsonResponse: {
14840
- locks?: any;
14841
- devices?: any;
14861
+ lock: {
14862
+ device_id: string;
14863
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
14864
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
14865
+ properties: ({
14866
+ online: boolean;
14867
+ name: string;
14868
+ model: {
14869
+ display_name: string;
14870
+ manufacturer_display_name: string;
14871
+ };
14872
+ has_direct_power?: boolean | undefined;
14873
+ battery_level?: number | undefined;
14874
+ battery?: {
14875
+ level: number;
14876
+ status: 'critical' | 'low' | 'good' | 'full';
14877
+ } | undefined;
14878
+ manufacturer?: string | undefined;
14879
+ image_url?: string | undefined;
14880
+ image_alt_text?: string | undefined;
14881
+ serial_number?: string | undefined;
14882
+ supports_accessory_keypad?: boolean | undefined;
14883
+ supports_offline_access_codes?: boolean | undefined;
14884
+ } & {
14885
+ august_metadata?: {
14886
+ lock_id: string;
14887
+ lock_name: string;
14888
+ house_name: string;
14889
+ has_keypad: boolean;
14890
+ keypad_battery_level?: string | undefined;
14891
+ model?: string | undefined;
14892
+ house_id?: string | undefined;
14893
+ } | undefined;
14894
+ avigilon_alta_metadata?: {
14895
+ entry_name: string;
14896
+ org_name: string;
14897
+ zone_id: number;
14898
+ zone_name: string;
14899
+ site_id: number;
14900
+ site_name: string;
14901
+ } | undefined;
14902
+ schlage_metadata?: {
14903
+ device_id: string;
14904
+ device_name: string;
14905
+ access_code_length: number;
14906
+ model?: string | undefined;
14907
+ } | undefined;
14908
+ smartthings_metadata?: {
14909
+ device_id: string;
14910
+ device_name: string;
14911
+ model?: string | undefined;
14912
+ location_id?: string | undefined;
14913
+ } | undefined;
14914
+ lockly_metadata?: {
14915
+ device_id: string;
14916
+ device_name: string;
14917
+ model?: string | undefined;
14918
+ } | undefined;
14919
+ nuki_metadata?: {
14920
+ device_id: string;
14921
+ device_name: string;
14922
+ keypad_battery_critical?: boolean | undefined;
14923
+ } | undefined;
14924
+ kwikset_metadata?: {
14925
+ device_id: string;
14926
+ device_name: string;
14927
+ model_number: string;
14928
+ } | undefined;
14929
+ salto_metadata?: {
14930
+ lock_id: string;
14931
+ customer_reference: string;
14932
+ lock_type: string;
14933
+ battery_level: string;
14934
+ locked_state: string;
14935
+ model?: string | undefined;
14936
+ } | undefined;
14937
+ genie_metadata?: {
14938
+ device_name: string;
14939
+ door_name: string;
14940
+ } | undefined;
14941
+ brivo_metadata?: {
14942
+ device_name: string;
14943
+ } | undefined;
14944
+ igloo_metadata?: {
14945
+ device_id: string;
14946
+ bridge_id: string;
14947
+ model?: string | undefined;
14948
+ } | undefined;
14949
+ noiseaware_metadata?: {
14950
+ device_model: 'indoor' | 'outdoor';
14951
+ noise_level_nrs: number;
14952
+ noise_level_decibel: number;
14953
+ device_name: string;
14954
+ device_id: string;
14955
+ } | undefined;
14956
+ minut_metadata?: {
14957
+ device_id: string;
14958
+ device_name: string;
14959
+ latest_sensor_values: {
14960
+ temperature: {
14961
+ time: string;
14962
+ value: number;
14963
+ };
14964
+ sound: {
14965
+ time: string;
14966
+ value: number;
14967
+ };
14968
+ humidity: {
14969
+ time: string;
14970
+ value: number;
14971
+ };
14972
+ pressure: {
14973
+ time: string;
14974
+ value: number;
14975
+ };
14976
+ accelerometer_z: {
14977
+ time: string;
14978
+ value: number;
14979
+ };
14980
+ };
14981
+ } | undefined;
14982
+ four_suites_metadata?: {
14983
+ device_id: number;
14984
+ device_name: string;
14985
+ reclose_delay_in_seconds: number;
14986
+ } | undefined;
14987
+ two_n_metadata?: {
14988
+ device_id: number;
14989
+ device_name: string;
14990
+ } | undefined;
14991
+ controlbyweb_metadata?: {
14992
+ device_id: string;
14993
+ device_name: string;
14994
+ relay_name: string | null;
14995
+ } | undefined;
14996
+ ttlock_metadata?: {
14997
+ lock_id: number;
14998
+ lock_alias: string;
14999
+ } | undefined;
15000
+ seam_bridge_metadata?: {
15001
+ unlock_method?: ('bridge' | 'doorking') | undefined;
15002
+ device_num: number;
15003
+ name: string;
15004
+ } | undefined;
15005
+ igloohome_metadata?: {
15006
+ device_id: string;
15007
+ device_name: string;
15008
+ bridge_id?: string | undefined;
15009
+ bridge_name?: string | undefined;
15010
+ } | undefined;
15011
+ nest_metadata?: {
15012
+ nest_device_id: string;
15013
+ device_name: string;
15014
+ custom_name: string;
15015
+ } | undefined;
15016
+ ecobee_metadata?: {
15017
+ ecobee_device_id: string;
15018
+ device_name: string;
15019
+ } | undefined;
15020
+ hubitat_metadata?: {
15021
+ device_id: string;
15022
+ device_name: string;
15023
+ device_label: string;
15024
+ } | undefined;
15025
+ dormakaba_oracode_metadata?: {
15026
+ door_id: number;
15027
+ door_name: string;
15028
+ device_id?: number | undefined;
15029
+ site_id: number;
15030
+ site_name: string;
15031
+ } | undefined;
15032
+ wyze_metadata?: {
15033
+ device_id: string;
15034
+ device_name: string;
15035
+ product_name: string;
15036
+ product_type: string;
15037
+ product_model: string;
15038
+ device_info_model: string;
15039
+ } | undefined;
15040
+ }) & ({
15041
+ code_constraints?: (Array<{
15042
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
15043
+ } | {
15044
+ constraint_type: 'name_length';
15045
+ min_length?: number | undefined;
15046
+ max_length?: number | undefined;
15047
+ }> | undefined) | undefined;
15048
+ supported_code_lengths?: (number[] | undefined) | undefined;
15049
+ max_active_codes_supported?: (number | undefined) | undefined;
15050
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
15051
+ has_native_entry_events?: (boolean | undefined) | undefined;
15052
+ locked?: (boolean | undefined) | undefined;
15053
+ keypad_battery?: ({
15054
+ level: number;
15055
+ } | undefined) | undefined;
15056
+ door_open?: (boolean | undefined) | undefined;
15057
+ } & ({
15058
+ temperature_fahrenheit?: number | undefined;
15059
+ temperature_celsius?: number | undefined;
15060
+ relative_humidity?: number | undefined;
15061
+ can_enable_automatic_heating?: boolean | undefined;
15062
+ can_enable_automatic_cooling?: boolean | undefined;
15063
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15064
+ is_heating_available?: true | undefined;
15065
+ is_cooling_available?: true | undefined;
15066
+ is_heating?: boolean | undefined;
15067
+ is_cooling?: boolean | undefined;
15068
+ is_fan_running?: boolean | undefined;
15069
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15070
+ is_temporary_manual_override_active?: boolean | undefined;
15071
+ current_climate_setting?: {
15072
+ automatic_heating_enabled: boolean;
15073
+ automatic_cooling_enabled: boolean;
15074
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15075
+ cooling_set_point_celsius?: number | undefined;
15076
+ heating_set_point_celsius?: number | undefined;
15077
+ cooling_set_point_fahrenheit?: number | undefined;
15078
+ heating_set_point_fahrenheit?: number | undefined;
15079
+ manual_override_allowed: boolean;
15080
+ } | undefined;
15081
+ default_climate_setting?: ({
15082
+ automatic_heating_enabled: boolean;
15083
+ automatic_cooling_enabled: boolean;
15084
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15085
+ cooling_set_point_celsius?: number | undefined;
15086
+ heating_set_point_celsius?: number | undefined;
15087
+ cooling_set_point_fahrenheit?: number | undefined;
15088
+ heating_set_point_fahrenheit?: number | undefined;
15089
+ manual_override_allowed: boolean;
15090
+ } | undefined) | undefined;
15091
+ is_climate_setting_schedule_active?: boolean | undefined;
15092
+ active_climate_setting_schedule?: ({
15093
+ climate_setting_schedule_id: string;
15094
+ schedule_type: 'time_bound';
15095
+ device_id: string;
15096
+ name?: string | undefined;
15097
+ schedule_starts_at: string;
15098
+ schedule_ends_at: string;
15099
+ created_at: string;
15100
+ automatic_heating_enabled?: boolean | undefined;
15101
+ automatic_cooling_enabled?: boolean | undefined;
15102
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15103
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15104
+ heating_set_point_celsius?: (number | undefined) | undefined;
15105
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15106
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15107
+ manual_override_allowed?: boolean | undefined;
15108
+ } | undefined) | undefined;
15109
+ min_cooling_set_point_celsius?: number | undefined;
15110
+ min_cooling_set_point_fahrenheit?: number | undefined;
15111
+ max_cooling_set_point_celsius?: number | undefined;
15112
+ max_cooling_set_point_fahrenheit?: number | undefined;
15113
+ min_heating_set_point_celsius?: number | undefined;
15114
+ min_heating_set_point_fahrenheit?: number | undefined;
15115
+ max_heating_set_point_celsius?: number | undefined;
15116
+ max_heating_set_point_fahrenheit?: number | undefined;
15117
+ min_heating_cooling_delta_celsius?: number | undefined;
15118
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
15119
+ } | {
15120
+ temperature_fahrenheit?: number | undefined;
15121
+ temperature_celsius?: number | undefined;
15122
+ relative_humidity?: number | undefined;
15123
+ can_enable_automatic_heating?: boolean | undefined;
15124
+ can_enable_automatic_cooling?: boolean | undefined;
15125
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15126
+ is_heating_available?: true | undefined;
15127
+ is_cooling_available?: false | undefined;
15128
+ is_heating?: boolean | undefined;
15129
+ is_cooling?: boolean | undefined;
15130
+ is_fan_running?: boolean | undefined;
15131
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15132
+ is_temporary_manual_override_active?: boolean | undefined;
15133
+ current_climate_setting?: {
15134
+ automatic_heating_enabled: boolean;
15135
+ automatic_cooling_enabled: boolean;
15136
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15137
+ cooling_set_point_celsius?: number | undefined;
15138
+ heating_set_point_celsius?: number | undefined;
15139
+ cooling_set_point_fahrenheit?: number | undefined;
15140
+ heating_set_point_fahrenheit?: number | undefined;
15141
+ manual_override_allowed: boolean;
15142
+ } | undefined;
15143
+ default_climate_setting?: ({
15144
+ automatic_heating_enabled: boolean;
15145
+ automatic_cooling_enabled: boolean;
15146
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15147
+ cooling_set_point_celsius?: number | undefined;
15148
+ heating_set_point_celsius?: number | undefined;
15149
+ cooling_set_point_fahrenheit?: number | undefined;
15150
+ heating_set_point_fahrenheit?: number | undefined;
15151
+ manual_override_allowed: boolean;
15152
+ } | undefined) | undefined;
15153
+ is_climate_setting_schedule_active?: boolean | undefined;
15154
+ active_climate_setting_schedule?: ({
15155
+ climate_setting_schedule_id: string;
15156
+ schedule_type: 'time_bound';
15157
+ device_id: string;
15158
+ name?: string | undefined;
15159
+ schedule_starts_at: string;
15160
+ schedule_ends_at: string;
15161
+ created_at: string;
15162
+ automatic_heating_enabled?: boolean | undefined;
15163
+ automatic_cooling_enabled?: boolean | undefined;
15164
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15165
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15166
+ heating_set_point_celsius?: (number | undefined) | undefined;
15167
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15168
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15169
+ manual_override_allowed?: boolean | undefined;
15170
+ } | undefined) | undefined;
15171
+ min_heating_set_point_celsius?: number | undefined;
15172
+ min_heating_set_point_fahrenheit?: number | undefined;
15173
+ max_heating_set_point_celsius?: number | undefined;
15174
+ max_heating_set_point_fahrenheit?: number | undefined;
15175
+ } | {
15176
+ temperature_fahrenheit?: number | undefined;
15177
+ temperature_celsius?: number | undefined;
15178
+ relative_humidity?: number | undefined;
15179
+ can_enable_automatic_heating?: boolean | undefined;
15180
+ can_enable_automatic_cooling?: boolean | undefined;
15181
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15182
+ is_heating_available?: false | undefined;
15183
+ is_cooling_available?: true | undefined;
15184
+ is_heating?: boolean | undefined;
15185
+ is_cooling?: boolean | undefined;
15186
+ is_fan_running?: boolean | undefined;
15187
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15188
+ is_temporary_manual_override_active?: boolean | undefined;
15189
+ current_climate_setting?: {
15190
+ automatic_heating_enabled: boolean;
15191
+ automatic_cooling_enabled: boolean;
15192
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15193
+ cooling_set_point_celsius?: number | undefined;
15194
+ heating_set_point_celsius?: number | undefined;
15195
+ cooling_set_point_fahrenheit?: number | undefined;
15196
+ heating_set_point_fahrenheit?: number | undefined;
15197
+ manual_override_allowed: boolean;
15198
+ } | undefined;
15199
+ default_climate_setting?: ({
15200
+ automatic_heating_enabled: boolean;
15201
+ automatic_cooling_enabled: boolean;
15202
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15203
+ cooling_set_point_celsius?: number | undefined;
15204
+ heating_set_point_celsius?: number | undefined;
15205
+ cooling_set_point_fahrenheit?: number | undefined;
15206
+ heating_set_point_fahrenheit?: number | undefined;
15207
+ manual_override_allowed: boolean;
15208
+ } | undefined) | undefined;
15209
+ is_climate_setting_schedule_active?: boolean | undefined;
15210
+ active_climate_setting_schedule?: ({
15211
+ climate_setting_schedule_id: string;
15212
+ schedule_type: 'time_bound';
15213
+ device_id: string;
15214
+ name?: string | undefined;
15215
+ schedule_starts_at: string;
15216
+ schedule_ends_at: string;
15217
+ created_at: string;
15218
+ automatic_heating_enabled?: boolean | undefined;
15219
+ automatic_cooling_enabled?: boolean | undefined;
15220
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15221
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15222
+ heating_set_point_celsius?: (number | undefined) | undefined;
15223
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15224
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15225
+ manual_override_allowed?: boolean | undefined;
15226
+ } | undefined) | undefined;
15227
+ min_cooling_set_point_celsius?: number | undefined;
15228
+ min_cooling_set_point_fahrenheit?: number | undefined;
15229
+ max_cooling_set_point_celsius?: number | undefined;
15230
+ max_cooling_set_point_fahrenheit?: number | undefined;
15231
+ }));
15232
+ location: {
15233
+ location_name?: string | undefined;
15234
+ timezone?: string | undefined;
15235
+ } | null;
15236
+ connected_account_id: string;
15237
+ workspace_id: string;
15238
+ errors: Array<{
15239
+ error_code: string;
15240
+ message: string;
15241
+ }>;
15242
+ warnings: Array<{
15243
+ warning_code: string;
15244
+ message: string;
15245
+ }>;
15246
+ created_at: string;
15247
+ is_managed: true;
15248
+ };
15249
+ device: {
15250
+ device_id: string;
15251
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
15252
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
15253
+ properties: ({
15254
+ online: boolean;
15255
+ name: string;
15256
+ model: {
15257
+ display_name: string;
15258
+ manufacturer_display_name: string;
15259
+ };
15260
+ has_direct_power?: boolean | undefined;
15261
+ battery_level?: number | undefined;
15262
+ battery?: {
15263
+ level: number;
15264
+ status: 'critical' | 'low' | 'good' | 'full';
15265
+ } | undefined;
15266
+ manufacturer?: string | undefined;
15267
+ image_url?: string | undefined;
15268
+ image_alt_text?: string | undefined;
15269
+ serial_number?: string | undefined;
15270
+ supports_accessory_keypad?: boolean | undefined;
15271
+ supports_offline_access_codes?: boolean | undefined;
15272
+ } & {
15273
+ august_metadata?: {
15274
+ lock_id: string;
15275
+ lock_name: string;
15276
+ house_name: string;
15277
+ has_keypad: boolean;
15278
+ keypad_battery_level?: string | undefined;
15279
+ model?: string | undefined;
15280
+ house_id?: string | undefined;
15281
+ } | undefined;
15282
+ avigilon_alta_metadata?: {
15283
+ entry_name: string;
15284
+ org_name: string;
15285
+ zone_id: number;
15286
+ zone_name: string;
15287
+ site_id: number;
15288
+ site_name: string;
15289
+ } | undefined;
15290
+ schlage_metadata?: {
15291
+ device_id: string;
15292
+ device_name: string;
15293
+ access_code_length: number;
15294
+ model?: string | undefined;
15295
+ } | undefined;
15296
+ smartthings_metadata?: {
15297
+ device_id: string;
15298
+ device_name: string;
15299
+ model?: string | undefined;
15300
+ location_id?: string | undefined;
15301
+ } | undefined;
15302
+ lockly_metadata?: {
15303
+ device_id: string;
15304
+ device_name: string;
15305
+ model?: string | undefined;
15306
+ } | undefined;
15307
+ nuki_metadata?: {
15308
+ device_id: string;
15309
+ device_name: string;
15310
+ keypad_battery_critical?: boolean | undefined;
15311
+ } | undefined;
15312
+ kwikset_metadata?: {
15313
+ device_id: string;
15314
+ device_name: string;
15315
+ model_number: string;
15316
+ } | undefined;
15317
+ salto_metadata?: {
15318
+ lock_id: string;
15319
+ customer_reference: string;
15320
+ lock_type: string;
15321
+ battery_level: string;
15322
+ locked_state: string;
15323
+ model?: string | undefined;
15324
+ } | undefined;
15325
+ genie_metadata?: {
15326
+ device_name: string;
15327
+ door_name: string;
15328
+ } | undefined;
15329
+ brivo_metadata?: {
15330
+ device_name: string;
15331
+ } | undefined;
15332
+ igloo_metadata?: {
15333
+ device_id: string;
15334
+ bridge_id: string;
15335
+ model?: string | undefined;
15336
+ } | undefined;
15337
+ noiseaware_metadata?: {
15338
+ device_model: 'indoor' | 'outdoor';
15339
+ noise_level_nrs: number;
15340
+ noise_level_decibel: number;
15341
+ device_name: string;
15342
+ device_id: string;
15343
+ } | undefined;
15344
+ minut_metadata?: {
15345
+ device_id: string;
15346
+ device_name: string;
15347
+ latest_sensor_values: {
15348
+ temperature: {
15349
+ time: string;
15350
+ value: number;
15351
+ };
15352
+ sound: {
15353
+ time: string;
15354
+ value: number;
15355
+ };
15356
+ humidity: {
15357
+ time: string;
15358
+ value: number;
15359
+ };
15360
+ pressure: {
15361
+ time: string;
15362
+ value: number;
15363
+ };
15364
+ accelerometer_z: {
15365
+ time: string;
15366
+ value: number;
15367
+ };
15368
+ };
15369
+ } | undefined;
15370
+ four_suites_metadata?: {
15371
+ device_id: number;
15372
+ device_name: string;
15373
+ reclose_delay_in_seconds: number;
15374
+ } | undefined;
15375
+ two_n_metadata?: {
15376
+ device_id: number;
15377
+ device_name: string;
15378
+ } | undefined;
15379
+ controlbyweb_metadata?: {
15380
+ device_id: string;
15381
+ device_name: string;
15382
+ relay_name: string | null;
15383
+ } | undefined;
15384
+ ttlock_metadata?: {
15385
+ lock_id: number;
15386
+ lock_alias: string;
15387
+ } | undefined;
15388
+ seam_bridge_metadata?: {
15389
+ unlock_method?: ('bridge' | 'doorking') | undefined;
15390
+ device_num: number;
15391
+ name: string;
15392
+ } | undefined;
15393
+ igloohome_metadata?: {
15394
+ device_id: string;
15395
+ device_name: string;
15396
+ bridge_id?: string | undefined;
15397
+ bridge_name?: string | undefined;
15398
+ } | undefined;
15399
+ nest_metadata?: {
15400
+ nest_device_id: string;
15401
+ device_name: string;
15402
+ custom_name: string;
15403
+ } | undefined;
15404
+ ecobee_metadata?: {
15405
+ ecobee_device_id: string;
15406
+ device_name: string;
15407
+ } | undefined;
15408
+ hubitat_metadata?: {
15409
+ device_id: string;
15410
+ device_name: string;
15411
+ device_label: string;
15412
+ } | undefined;
15413
+ dormakaba_oracode_metadata?: {
15414
+ door_id: number;
15415
+ door_name: string;
15416
+ device_id?: number | undefined;
15417
+ site_id: number;
15418
+ site_name: string;
15419
+ } | undefined;
15420
+ wyze_metadata?: {
15421
+ device_id: string;
15422
+ device_name: string;
15423
+ product_name: string;
15424
+ product_type: string;
15425
+ product_model: string;
15426
+ device_info_model: string;
15427
+ } | undefined;
15428
+ }) & ({
15429
+ code_constraints?: (Array<{
15430
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
15431
+ } | {
15432
+ constraint_type: 'name_length';
15433
+ min_length?: number | undefined;
15434
+ max_length?: number | undefined;
15435
+ }> | undefined) | undefined;
15436
+ supported_code_lengths?: (number[] | undefined) | undefined;
15437
+ max_active_codes_supported?: (number | undefined) | undefined;
15438
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
15439
+ has_native_entry_events?: (boolean | undefined) | undefined;
15440
+ locked?: (boolean | undefined) | undefined;
15441
+ keypad_battery?: ({
15442
+ level: number;
15443
+ } | undefined) | undefined;
15444
+ door_open?: (boolean | undefined) | undefined;
15445
+ } & ({
15446
+ temperature_fahrenheit?: number | undefined;
15447
+ temperature_celsius?: number | undefined;
15448
+ relative_humidity?: number | undefined;
15449
+ can_enable_automatic_heating?: boolean | undefined;
15450
+ can_enable_automatic_cooling?: boolean | undefined;
15451
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15452
+ is_heating_available?: true | undefined;
15453
+ is_cooling_available?: true | undefined;
15454
+ is_heating?: boolean | undefined;
15455
+ is_cooling?: boolean | undefined;
15456
+ is_fan_running?: boolean | undefined;
15457
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15458
+ is_temporary_manual_override_active?: boolean | undefined;
15459
+ current_climate_setting?: {
15460
+ automatic_heating_enabled: boolean;
15461
+ automatic_cooling_enabled: boolean;
15462
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15463
+ cooling_set_point_celsius?: number | undefined;
15464
+ heating_set_point_celsius?: number | undefined;
15465
+ cooling_set_point_fahrenheit?: number | undefined;
15466
+ heating_set_point_fahrenheit?: number | undefined;
15467
+ manual_override_allowed: boolean;
15468
+ } | undefined;
15469
+ default_climate_setting?: ({
15470
+ automatic_heating_enabled: boolean;
15471
+ automatic_cooling_enabled: boolean;
15472
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15473
+ cooling_set_point_celsius?: number | undefined;
15474
+ heating_set_point_celsius?: number | undefined;
15475
+ cooling_set_point_fahrenheit?: number | undefined;
15476
+ heating_set_point_fahrenheit?: number | undefined;
15477
+ manual_override_allowed: boolean;
15478
+ } | undefined) | undefined;
15479
+ is_climate_setting_schedule_active?: boolean | undefined;
15480
+ active_climate_setting_schedule?: ({
15481
+ climate_setting_schedule_id: string;
15482
+ schedule_type: 'time_bound';
15483
+ device_id: string;
15484
+ name?: string | undefined;
15485
+ schedule_starts_at: string;
15486
+ schedule_ends_at: string;
15487
+ created_at: string;
15488
+ automatic_heating_enabled?: boolean | undefined;
15489
+ automatic_cooling_enabled?: boolean | undefined;
15490
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15491
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15492
+ heating_set_point_celsius?: (number | undefined) | undefined;
15493
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15494
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15495
+ manual_override_allowed?: boolean | undefined;
15496
+ } | undefined) | undefined;
15497
+ min_cooling_set_point_celsius?: number | undefined;
15498
+ min_cooling_set_point_fahrenheit?: number | undefined;
15499
+ max_cooling_set_point_celsius?: number | undefined;
15500
+ max_cooling_set_point_fahrenheit?: number | undefined;
15501
+ min_heating_set_point_celsius?: number | undefined;
15502
+ min_heating_set_point_fahrenheit?: number | undefined;
15503
+ max_heating_set_point_celsius?: number | undefined;
15504
+ max_heating_set_point_fahrenheit?: number | undefined;
15505
+ min_heating_cooling_delta_celsius?: number | undefined;
15506
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
15507
+ } | {
15508
+ temperature_fahrenheit?: number | undefined;
15509
+ temperature_celsius?: number | undefined;
15510
+ relative_humidity?: number | undefined;
15511
+ can_enable_automatic_heating?: boolean | undefined;
15512
+ can_enable_automatic_cooling?: boolean | undefined;
15513
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15514
+ is_heating_available?: true | undefined;
15515
+ is_cooling_available?: false | undefined;
15516
+ is_heating?: boolean | undefined;
15517
+ is_cooling?: boolean | undefined;
15518
+ is_fan_running?: boolean | undefined;
15519
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15520
+ is_temporary_manual_override_active?: boolean | undefined;
15521
+ current_climate_setting?: {
15522
+ automatic_heating_enabled: boolean;
15523
+ automatic_cooling_enabled: boolean;
15524
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15525
+ cooling_set_point_celsius?: number | undefined;
15526
+ heating_set_point_celsius?: number | undefined;
15527
+ cooling_set_point_fahrenheit?: number | undefined;
15528
+ heating_set_point_fahrenheit?: number | undefined;
15529
+ manual_override_allowed: boolean;
15530
+ } | undefined;
15531
+ default_climate_setting?: ({
15532
+ automatic_heating_enabled: boolean;
15533
+ automatic_cooling_enabled: boolean;
15534
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15535
+ cooling_set_point_celsius?: number | undefined;
15536
+ heating_set_point_celsius?: number | undefined;
15537
+ cooling_set_point_fahrenheit?: number | undefined;
15538
+ heating_set_point_fahrenheit?: number | undefined;
15539
+ manual_override_allowed: boolean;
15540
+ } | undefined) | undefined;
15541
+ is_climate_setting_schedule_active?: boolean | undefined;
15542
+ active_climate_setting_schedule?: ({
15543
+ climate_setting_schedule_id: string;
15544
+ schedule_type: 'time_bound';
15545
+ device_id: string;
15546
+ name?: string | undefined;
15547
+ schedule_starts_at: string;
15548
+ schedule_ends_at: string;
15549
+ created_at: string;
15550
+ automatic_heating_enabled?: boolean | undefined;
15551
+ automatic_cooling_enabled?: boolean | undefined;
15552
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15553
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15554
+ heating_set_point_celsius?: (number | undefined) | undefined;
15555
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15556
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15557
+ manual_override_allowed?: boolean | undefined;
15558
+ } | undefined) | undefined;
15559
+ min_heating_set_point_celsius?: number | undefined;
15560
+ min_heating_set_point_fahrenheit?: number | undefined;
15561
+ max_heating_set_point_celsius?: number | undefined;
15562
+ max_heating_set_point_fahrenheit?: number | undefined;
15563
+ } | {
15564
+ temperature_fahrenheit?: number | undefined;
15565
+ temperature_celsius?: number | undefined;
15566
+ relative_humidity?: number | undefined;
15567
+ can_enable_automatic_heating?: boolean | undefined;
15568
+ can_enable_automatic_cooling?: boolean | undefined;
15569
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15570
+ is_heating_available?: false | undefined;
15571
+ is_cooling_available?: true | undefined;
15572
+ is_heating?: boolean | undefined;
15573
+ is_cooling?: boolean | undefined;
15574
+ is_fan_running?: boolean | undefined;
15575
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15576
+ is_temporary_manual_override_active?: boolean | undefined;
15577
+ current_climate_setting?: {
15578
+ automatic_heating_enabled: boolean;
15579
+ automatic_cooling_enabled: boolean;
15580
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15581
+ cooling_set_point_celsius?: number | undefined;
15582
+ heating_set_point_celsius?: number | undefined;
15583
+ cooling_set_point_fahrenheit?: number | undefined;
15584
+ heating_set_point_fahrenheit?: number | undefined;
15585
+ manual_override_allowed: boolean;
15586
+ } | undefined;
15587
+ default_climate_setting?: ({
15588
+ automatic_heating_enabled: boolean;
15589
+ automatic_cooling_enabled: boolean;
15590
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15591
+ cooling_set_point_celsius?: number | undefined;
15592
+ heating_set_point_celsius?: number | undefined;
15593
+ cooling_set_point_fahrenheit?: number | undefined;
15594
+ heating_set_point_fahrenheit?: number | undefined;
15595
+ manual_override_allowed: boolean;
15596
+ } | undefined) | undefined;
15597
+ is_climate_setting_schedule_active?: boolean | undefined;
15598
+ active_climate_setting_schedule?: ({
15599
+ climate_setting_schedule_id: string;
15600
+ schedule_type: 'time_bound';
15601
+ device_id: string;
15602
+ name?: string | undefined;
15603
+ schedule_starts_at: string;
15604
+ schedule_ends_at: string;
15605
+ created_at: string;
15606
+ automatic_heating_enabled?: boolean | undefined;
15607
+ automatic_cooling_enabled?: boolean | undefined;
15608
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15609
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15610
+ heating_set_point_celsius?: (number | undefined) | undefined;
15611
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15612
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15613
+ manual_override_allowed?: boolean | undefined;
15614
+ } | undefined) | undefined;
15615
+ min_cooling_set_point_celsius?: number | undefined;
15616
+ min_cooling_set_point_fahrenheit?: number | undefined;
15617
+ max_cooling_set_point_celsius?: number | undefined;
15618
+ max_cooling_set_point_fahrenheit?: number | undefined;
15619
+ }));
15620
+ location: {
15621
+ location_name?: string | undefined;
15622
+ timezone?: string | undefined;
15623
+ } | null;
15624
+ connected_account_id: string;
15625
+ workspace_id: string;
15626
+ errors: Array<{
15627
+ error_code: string;
15628
+ message: string;
15629
+ }>;
15630
+ warnings: Array<{
15631
+ warning_code: string;
15632
+ message: string;
15633
+ }>;
15634
+ created_at: string;
15635
+ is_managed: true;
15636
+ };
15637
+ };
15638
+ };
15639
+ '/locks/list': {
15640
+ route: '/locks/list';
15641
+ method: 'GET' | 'POST';
15642
+ queryParams: {};
15643
+ jsonBody: {};
15644
+ commonParams: {
15645
+ /** List all devices owned by this connected account */
15646
+ connected_account_id?: string | undefined;
15647
+ connected_account_ids?: string[] | undefined;
15648
+ connect_webview_id?: string | undefined;
15649
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
15650
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
15651
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
15652
+ device_ids?: string[] | undefined;
15653
+ limit?: number;
15654
+ created_before?: Date | undefined;
15655
+ user_identifier_key?: string | undefined;
15656
+ };
15657
+ formData: {};
15658
+ jsonResponse: {
15659
+ locks: Array<{
15660
+ device_id: string;
15661
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
15662
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
15663
+ properties: ({
15664
+ online: boolean;
15665
+ name: string;
15666
+ model: {
15667
+ display_name: string;
15668
+ manufacturer_display_name: string;
15669
+ };
15670
+ has_direct_power?: boolean | undefined;
15671
+ battery_level?: number | undefined;
15672
+ battery?: {
15673
+ level: number;
15674
+ status: 'critical' | 'low' | 'good' | 'full';
15675
+ } | undefined;
15676
+ manufacturer?: string | undefined;
15677
+ image_url?: string | undefined;
15678
+ image_alt_text?: string | undefined;
15679
+ serial_number?: string | undefined;
15680
+ supports_accessory_keypad?: boolean | undefined;
15681
+ supports_offline_access_codes?: boolean | undefined;
15682
+ } & {
15683
+ august_metadata?: {
15684
+ lock_id: string;
15685
+ lock_name: string;
15686
+ house_name: string;
15687
+ has_keypad: boolean;
15688
+ keypad_battery_level?: string | undefined;
15689
+ model?: string | undefined;
15690
+ house_id?: string | undefined;
15691
+ } | undefined;
15692
+ avigilon_alta_metadata?: {
15693
+ entry_name: string;
15694
+ org_name: string;
15695
+ zone_id: number;
15696
+ zone_name: string;
15697
+ site_id: number;
15698
+ site_name: string;
15699
+ } | undefined;
15700
+ schlage_metadata?: {
15701
+ device_id: string;
15702
+ device_name: string;
15703
+ access_code_length: number;
15704
+ model?: string | undefined;
15705
+ } | undefined;
15706
+ smartthings_metadata?: {
15707
+ device_id: string;
15708
+ device_name: string;
15709
+ model?: string | undefined;
15710
+ location_id?: string | undefined;
15711
+ } | undefined;
15712
+ lockly_metadata?: {
15713
+ device_id: string;
15714
+ device_name: string;
15715
+ model?: string | undefined;
15716
+ } | undefined;
15717
+ nuki_metadata?: {
15718
+ device_id: string;
15719
+ device_name: string;
15720
+ keypad_battery_critical?: boolean | undefined;
15721
+ } | undefined;
15722
+ kwikset_metadata?: {
15723
+ device_id: string;
15724
+ device_name: string;
15725
+ model_number: string;
15726
+ } | undefined;
15727
+ salto_metadata?: {
15728
+ lock_id: string;
15729
+ customer_reference: string;
15730
+ lock_type: string;
15731
+ battery_level: string;
15732
+ locked_state: string;
15733
+ model?: string | undefined;
15734
+ } | undefined;
15735
+ genie_metadata?: {
15736
+ device_name: string;
15737
+ door_name: string;
15738
+ } | undefined;
15739
+ brivo_metadata?: {
15740
+ device_name: string;
15741
+ } | undefined;
15742
+ igloo_metadata?: {
15743
+ device_id: string;
15744
+ bridge_id: string;
15745
+ model?: string | undefined;
15746
+ } | undefined;
15747
+ noiseaware_metadata?: {
15748
+ device_model: 'indoor' | 'outdoor';
15749
+ noise_level_nrs: number;
15750
+ noise_level_decibel: number;
15751
+ device_name: string;
15752
+ device_id: string;
15753
+ } | undefined;
15754
+ minut_metadata?: {
15755
+ device_id: string;
15756
+ device_name: string;
15757
+ latest_sensor_values: {
15758
+ temperature: {
15759
+ time: string;
15760
+ value: number;
15761
+ };
15762
+ sound: {
15763
+ time: string;
15764
+ value: number;
15765
+ };
15766
+ humidity: {
15767
+ time: string;
15768
+ value: number;
15769
+ };
15770
+ pressure: {
15771
+ time: string;
15772
+ value: number;
15773
+ };
15774
+ accelerometer_z: {
15775
+ time: string;
15776
+ value: number;
15777
+ };
15778
+ };
15779
+ } | undefined;
15780
+ four_suites_metadata?: {
15781
+ device_id: number;
15782
+ device_name: string;
15783
+ reclose_delay_in_seconds: number;
15784
+ } | undefined;
15785
+ two_n_metadata?: {
15786
+ device_id: number;
15787
+ device_name: string;
15788
+ } | undefined;
15789
+ controlbyweb_metadata?: {
15790
+ device_id: string;
15791
+ device_name: string;
15792
+ relay_name: string | null;
15793
+ } | undefined;
15794
+ ttlock_metadata?: {
15795
+ lock_id: number;
15796
+ lock_alias: string;
15797
+ } | undefined;
15798
+ seam_bridge_metadata?: {
15799
+ unlock_method?: ('bridge' | 'doorking') | undefined;
15800
+ device_num: number;
15801
+ name: string;
15802
+ } | undefined;
15803
+ igloohome_metadata?: {
15804
+ device_id: string;
15805
+ device_name: string;
15806
+ bridge_id?: string | undefined;
15807
+ bridge_name?: string | undefined;
15808
+ } | undefined;
15809
+ nest_metadata?: {
15810
+ nest_device_id: string;
15811
+ device_name: string;
15812
+ custom_name: string;
15813
+ } | undefined;
15814
+ ecobee_metadata?: {
15815
+ ecobee_device_id: string;
15816
+ device_name: string;
15817
+ } | undefined;
15818
+ hubitat_metadata?: {
15819
+ device_id: string;
15820
+ device_name: string;
15821
+ device_label: string;
15822
+ } | undefined;
15823
+ dormakaba_oracode_metadata?: {
15824
+ door_id: number;
15825
+ door_name: string;
15826
+ device_id?: number | undefined;
15827
+ site_id: number;
15828
+ site_name: string;
15829
+ } | undefined;
15830
+ wyze_metadata?: {
15831
+ device_id: string;
15832
+ device_name: string;
15833
+ product_name: string;
15834
+ product_type: string;
15835
+ product_model: string;
15836
+ device_info_model: string;
15837
+ } | undefined;
15838
+ }) & ({
15839
+ code_constraints?: (Array<{
15840
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
15841
+ } | {
15842
+ constraint_type: 'name_length';
15843
+ min_length?: number | undefined;
15844
+ max_length?: number | undefined;
15845
+ }> | undefined) | undefined;
15846
+ supported_code_lengths?: (number[] | undefined) | undefined;
15847
+ max_active_codes_supported?: (number | undefined) | undefined;
15848
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
15849
+ has_native_entry_events?: (boolean | undefined) | undefined;
15850
+ locked?: (boolean | undefined) | undefined;
15851
+ keypad_battery?: ({
15852
+ level: number;
15853
+ } | undefined) | undefined;
15854
+ door_open?: (boolean | undefined) | undefined;
15855
+ } & ({
15856
+ temperature_fahrenheit?: number | undefined;
15857
+ temperature_celsius?: number | undefined;
15858
+ relative_humidity?: number | undefined;
15859
+ can_enable_automatic_heating?: boolean | undefined;
15860
+ can_enable_automatic_cooling?: boolean | undefined;
15861
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15862
+ is_heating_available?: true | undefined;
15863
+ is_cooling_available?: true | undefined;
15864
+ is_heating?: boolean | undefined;
15865
+ is_cooling?: boolean | undefined;
15866
+ is_fan_running?: boolean | undefined;
15867
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15868
+ is_temporary_manual_override_active?: boolean | undefined;
15869
+ current_climate_setting?: {
15870
+ automatic_heating_enabled: boolean;
15871
+ automatic_cooling_enabled: boolean;
15872
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15873
+ cooling_set_point_celsius?: number | undefined;
15874
+ heating_set_point_celsius?: number | undefined;
15875
+ cooling_set_point_fahrenheit?: number | undefined;
15876
+ heating_set_point_fahrenheit?: number | undefined;
15877
+ manual_override_allowed: boolean;
15878
+ } | undefined;
15879
+ default_climate_setting?: ({
15880
+ automatic_heating_enabled: boolean;
15881
+ automatic_cooling_enabled: boolean;
15882
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15883
+ cooling_set_point_celsius?: number | undefined;
15884
+ heating_set_point_celsius?: number | undefined;
15885
+ cooling_set_point_fahrenheit?: number | undefined;
15886
+ heating_set_point_fahrenheit?: number | undefined;
15887
+ manual_override_allowed: boolean;
15888
+ } | undefined) | undefined;
15889
+ is_climate_setting_schedule_active?: boolean | undefined;
15890
+ active_climate_setting_schedule?: ({
15891
+ climate_setting_schedule_id: string;
15892
+ schedule_type: 'time_bound';
15893
+ device_id: string;
15894
+ name?: string | undefined;
15895
+ schedule_starts_at: string;
15896
+ schedule_ends_at: string;
15897
+ created_at: string;
15898
+ automatic_heating_enabled?: boolean | undefined;
15899
+ automatic_cooling_enabled?: boolean | undefined;
15900
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15901
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15902
+ heating_set_point_celsius?: (number | undefined) | undefined;
15903
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15904
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15905
+ manual_override_allowed?: boolean | undefined;
15906
+ } | undefined) | undefined;
15907
+ min_cooling_set_point_celsius?: number | undefined;
15908
+ min_cooling_set_point_fahrenheit?: number | undefined;
15909
+ max_cooling_set_point_celsius?: number | undefined;
15910
+ max_cooling_set_point_fahrenheit?: number | undefined;
15911
+ min_heating_set_point_celsius?: number | undefined;
15912
+ min_heating_set_point_fahrenheit?: number | undefined;
15913
+ max_heating_set_point_celsius?: number | undefined;
15914
+ max_heating_set_point_fahrenheit?: number | undefined;
15915
+ min_heating_cooling_delta_celsius?: number | undefined;
15916
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
15917
+ } | {
15918
+ temperature_fahrenheit?: number | undefined;
15919
+ temperature_celsius?: number | undefined;
15920
+ relative_humidity?: number | undefined;
15921
+ can_enable_automatic_heating?: boolean | undefined;
15922
+ can_enable_automatic_cooling?: boolean | undefined;
15923
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15924
+ is_heating_available?: true | undefined;
15925
+ is_cooling_available?: false | undefined;
15926
+ is_heating?: boolean | undefined;
15927
+ is_cooling?: boolean | undefined;
15928
+ is_fan_running?: boolean | undefined;
15929
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15930
+ is_temporary_manual_override_active?: boolean | undefined;
15931
+ current_climate_setting?: {
15932
+ automatic_heating_enabled: boolean;
15933
+ automatic_cooling_enabled: boolean;
15934
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15935
+ cooling_set_point_celsius?: number | undefined;
15936
+ heating_set_point_celsius?: number | undefined;
15937
+ cooling_set_point_fahrenheit?: number | undefined;
15938
+ heating_set_point_fahrenheit?: number | undefined;
15939
+ manual_override_allowed: boolean;
15940
+ } | undefined;
15941
+ default_climate_setting?: ({
15942
+ automatic_heating_enabled: boolean;
15943
+ automatic_cooling_enabled: boolean;
15944
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15945
+ cooling_set_point_celsius?: number | undefined;
15946
+ heating_set_point_celsius?: number | undefined;
15947
+ cooling_set_point_fahrenheit?: number | undefined;
15948
+ heating_set_point_fahrenheit?: number | undefined;
15949
+ manual_override_allowed: boolean;
15950
+ } | undefined) | undefined;
15951
+ is_climate_setting_schedule_active?: boolean | undefined;
15952
+ active_climate_setting_schedule?: ({
15953
+ climate_setting_schedule_id: string;
15954
+ schedule_type: 'time_bound';
15955
+ device_id: string;
15956
+ name?: string | undefined;
15957
+ schedule_starts_at: string;
15958
+ schedule_ends_at: string;
15959
+ created_at: string;
15960
+ automatic_heating_enabled?: boolean | undefined;
15961
+ automatic_cooling_enabled?: boolean | undefined;
15962
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15963
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15964
+ heating_set_point_celsius?: (number | undefined) | undefined;
15965
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15966
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15967
+ manual_override_allowed?: boolean | undefined;
15968
+ } | undefined) | undefined;
15969
+ min_heating_set_point_celsius?: number | undefined;
15970
+ min_heating_set_point_fahrenheit?: number | undefined;
15971
+ max_heating_set_point_celsius?: number | undefined;
15972
+ max_heating_set_point_fahrenheit?: number | undefined;
15973
+ } | {
15974
+ temperature_fahrenheit?: number | undefined;
15975
+ temperature_celsius?: number | undefined;
15976
+ relative_humidity?: number | undefined;
15977
+ can_enable_automatic_heating?: boolean | undefined;
15978
+ can_enable_automatic_cooling?: boolean | undefined;
15979
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
15980
+ is_heating_available?: false | undefined;
15981
+ is_cooling_available?: true | undefined;
15982
+ is_heating?: boolean | undefined;
15983
+ is_cooling?: boolean | undefined;
15984
+ is_fan_running?: boolean | undefined;
15985
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15986
+ is_temporary_manual_override_active?: boolean | undefined;
15987
+ current_climate_setting?: {
15988
+ automatic_heating_enabled: boolean;
15989
+ automatic_cooling_enabled: boolean;
15990
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15991
+ cooling_set_point_celsius?: number | undefined;
15992
+ heating_set_point_celsius?: number | undefined;
15993
+ cooling_set_point_fahrenheit?: number | undefined;
15994
+ heating_set_point_fahrenheit?: number | undefined;
15995
+ manual_override_allowed: boolean;
15996
+ } | undefined;
15997
+ default_climate_setting?: ({
15998
+ automatic_heating_enabled: boolean;
15999
+ automatic_cooling_enabled: boolean;
16000
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16001
+ cooling_set_point_celsius?: number | undefined;
16002
+ heating_set_point_celsius?: number | undefined;
16003
+ cooling_set_point_fahrenheit?: number | undefined;
16004
+ heating_set_point_fahrenheit?: number | undefined;
16005
+ manual_override_allowed: boolean;
16006
+ } | undefined) | undefined;
16007
+ is_climate_setting_schedule_active?: boolean | undefined;
16008
+ active_climate_setting_schedule?: ({
16009
+ climate_setting_schedule_id: string;
16010
+ schedule_type: 'time_bound';
16011
+ device_id: string;
16012
+ name?: string | undefined;
16013
+ schedule_starts_at: string;
16014
+ schedule_ends_at: string;
16015
+ created_at: string;
16016
+ automatic_heating_enabled?: boolean | undefined;
16017
+ automatic_cooling_enabled?: boolean | undefined;
16018
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
16019
+ cooling_set_point_celsius?: (number | undefined) | undefined;
16020
+ heating_set_point_celsius?: (number | undefined) | undefined;
16021
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
16022
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
16023
+ manual_override_allowed?: boolean | undefined;
16024
+ } | undefined) | undefined;
16025
+ min_cooling_set_point_celsius?: number | undefined;
16026
+ min_cooling_set_point_fahrenheit?: number | undefined;
16027
+ max_cooling_set_point_celsius?: number | undefined;
16028
+ max_cooling_set_point_fahrenheit?: number | undefined;
16029
+ }));
16030
+ location: {
16031
+ location_name?: string | undefined;
16032
+ timezone?: string | undefined;
16033
+ } | null;
16034
+ connected_account_id: string;
16035
+ workspace_id: string;
16036
+ errors: Array<{
16037
+ error_code: string;
16038
+ message: string;
16039
+ }>;
16040
+ warnings: Array<{
16041
+ warning_code: string;
16042
+ message: string;
16043
+ }>;
16044
+ created_at: string;
16045
+ is_managed: true;
16046
+ }>;
16047
+ devices: Array<{
16048
+ device_id: string;
16049
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
16050
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
16051
+ properties: ({
16052
+ online: boolean;
16053
+ name: string;
16054
+ model: {
16055
+ display_name: string;
16056
+ manufacturer_display_name: string;
16057
+ };
16058
+ has_direct_power?: boolean | undefined;
16059
+ battery_level?: number | undefined;
16060
+ battery?: {
16061
+ level: number;
16062
+ status: 'critical' | 'low' | 'good' | 'full';
16063
+ } | undefined;
16064
+ manufacturer?: string | undefined;
16065
+ image_url?: string | undefined;
16066
+ image_alt_text?: string | undefined;
16067
+ serial_number?: string | undefined;
16068
+ supports_accessory_keypad?: boolean | undefined;
16069
+ supports_offline_access_codes?: boolean | undefined;
16070
+ } & {
16071
+ august_metadata?: {
16072
+ lock_id: string;
16073
+ lock_name: string;
16074
+ house_name: string;
16075
+ has_keypad: boolean;
16076
+ keypad_battery_level?: string | undefined;
16077
+ model?: string | undefined;
16078
+ house_id?: string | undefined;
16079
+ } | undefined;
16080
+ avigilon_alta_metadata?: {
16081
+ entry_name: string;
16082
+ org_name: string;
16083
+ zone_id: number;
16084
+ zone_name: string;
16085
+ site_id: number;
16086
+ site_name: string;
16087
+ } | undefined;
16088
+ schlage_metadata?: {
16089
+ device_id: string;
16090
+ device_name: string;
16091
+ access_code_length: number;
16092
+ model?: string | undefined;
16093
+ } | undefined;
16094
+ smartthings_metadata?: {
16095
+ device_id: string;
16096
+ device_name: string;
16097
+ model?: string | undefined;
16098
+ location_id?: string | undefined;
16099
+ } | undefined;
16100
+ lockly_metadata?: {
16101
+ device_id: string;
16102
+ device_name: string;
16103
+ model?: string | undefined;
16104
+ } | undefined;
16105
+ nuki_metadata?: {
16106
+ device_id: string;
16107
+ device_name: string;
16108
+ keypad_battery_critical?: boolean | undefined;
16109
+ } | undefined;
16110
+ kwikset_metadata?: {
16111
+ device_id: string;
16112
+ device_name: string;
16113
+ model_number: string;
16114
+ } | undefined;
16115
+ salto_metadata?: {
16116
+ lock_id: string;
16117
+ customer_reference: string;
16118
+ lock_type: string;
16119
+ battery_level: string;
16120
+ locked_state: string;
16121
+ model?: string | undefined;
16122
+ } | undefined;
16123
+ genie_metadata?: {
16124
+ device_name: string;
16125
+ door_name: string;
16126
+ } | undefined;
16127
+ brivo_metadata?: {
16128
+ device_name: string;
16129
+ } | undefined;
16130
+ igloo_metadata?: {
16131
+ device_id: string;
16132
+ bridge_id: string;
16133
+ model?: string | undefined;
16134
+ } | undefined;
16135
+ noiseaware_metadata?: {
16136
+ device_model: 'indoor' | 'outdoor';
16137
+ noise_level_nrs: number;
16138
+ noise_level_decibel: number;
16139
+ device_name: string;
16140
+ device_id: string;
16141
+ } | undefined;
16142
+ minut_metadata?: {
16143
+ device_id: string;
16144
+ device_name: string;
16145
+ latest_sensor_values: {
16146
+ temperature: {
16147
+ time: string;
16148
+ value: number;
16149
+ };
16150
+ sound: {
16151
+ time: string;
16152
+ value: number;
16153
+ };
16154
+ humidity: {
16155
+ time: string;
16156
+ value: number;
16157
+ };
16158
+ pressure: {
16159
+ time: string;
16160
+ value: number;
16161
+ };
16162
+ accelerometer_z: {
16163
+ time: string;
16164
+ value: number;
16165
+ };
16166
+ };
16167
+ } | undefined;
16168
+ four_suites_metadata?: {
16169
+ device_id: number;
16170
+ device_name: string;
16171
+ reclose_delay_in_seconds: number;
16172
+ } | undefined;
16173
+ two_n_metadata?: {
16174
+ device_id: number;
16175
+ device_name: string;
16176
+ } | undefined;
16177
+ controlbyweb_metadata?: {
16178
+ device_id: string;
16179
+ device_name: string;
16180
+ relay_name: string | null;
16181
+ } | undefined;
16182
+ ttlock_metadata?: {
16183
+ lock_id: number;
16184
+ lock_alias: string;
16185
+ } | undefined;
16186
+ seam_bridge_metadata?: {
16187
+ unlock_method?: ('bridge' | 'doorking') | undefined;
16188
+ device_num: number;
16189
+ name: string;
16190
+ } | undefined;
16191
+ igloohome_metadata?: {
16192
+ device_id: string;
16193
+ device_name: string;
16194
+ bridge_id?: string | undefined;
16195
+ bridge_name?: string | undefined;
16196
+ } | undefined;
16197
+ nest_metadata?: {
16198
+ nest_device_id: string;
16199
+ device_name: string;
16200
+ custom_name: string;
16201
+ } | undefined;
16202
+ ecobee_metadata?: {
16203
+ ecobee_device_id: string;
16204
+ device_name: string;
16205
+ } | undefined;
16206
+ hubitat_metadata?: {
16207
+ device_id: string;
16208
+ device_name: string;
16209
+ device_label: string;
16210
+ } | undefined;
16211
+ dormakaba_oracode_metadata?: {
16212
+ door_id: number;
16213
+ door_name: string;
16214
+ device_id?: number | undefined;
16215
+ site_id: number;
16216
+ site_name: string;
16217
+ } | undefined;
16218
+ wyze_metadata?: {
16219
+ device_id: string;
16220
+ device_name: string;
16221
+ product_name: string;
16222
+ product_type: string;
16223
+ product_model: string;
16224
+ device_info_model: string;
16225
+ } | undefined;
16226
+ }) & ({
16227
+ code_constraints?: (Array<{
16228
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
16229
+ } | {
16230
+ constraint_type: 'name_length';
16231
+ min_length?: number | undefined;
16232
+ max_length?: number | undefined;
16233
+ }> | undefined) | undefined;
16234
+ supported_code_lengths?: (number[] | undefined) | undefined;
16235
+ max_active_codes_supported?: (number | undefined) | undefined;
16236
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
16237
+ has_native_entry_events?: (boolean | undefined) | undefined;
16238
+ locked?: (boolean | undefined) | undefined;
16239
+ keypad_battery?: ({
16240
+ level: number;
16241
+ } | undefined) | undefined;
16242
+ door_open?: (boolean | undefined) | undefined;
16243
+ } & ({
16244
+ temperature_fahrenheit?: number | undefined;
16245
+ temperature_celsius?: number | undefined;
16246
+ relative_humidity?: number | undefined;
16247
+ can_enable_automatic_heating?: boolean | undefined;
16248
+ can_enable_automatic_cooling?: boolean | undefined;
16249
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
16250
+ is_heating_available?: true | undefined;
16251
+ is_cooling_available?: true | undefined;
16252
+ is_heating?: boolean | undefined;
16253
+ is_cooling?: boolean | undefined;
16254
+ is_fan_running?: boolean | undefined;
16255
+ fan_mode_setting?: ('auto' | 'on') | undefined;
16256
+ is_temporary_manual_override_active?: boolean | undefined;
16257
+ current_climate_setting?: {
16258
+ automatic_heating_enabled: boolean;
16259
+ automatic_cooling_enabled: boolean;
16260
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16261
+ cooling_set_point_celsius?: number | undefined;
16262
+ heating_set_point_celsius?: number | undefined;
16263
+ cooling_set_point_fahrenheit?: number | undefined;
16264
+ heating_set_point_fahrenheit?: number | undefined;
16265
+ manual_override_allowed: boolean;
16266
+ } | undefined;
16267
+ default_climate_setting?: ({
16268
+ automatic_heating_enabled: boolean;
16269
+ automatic_cooling_enabled: boolean;
16270
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16271
+ cooling_set_point_celsius?: number | undefined;
16272
+ heating_set_point_celsius?: number | undefined;
16273
+ cooling_set_point_fahrenheit?: number | undefined;
16274
+ heating_set_point_fahrenheit?: number | undefined;
16275
+ manual_override_allowed: boolean;
16276
+ } | undefined) | undefined;
16277
+ is_climate_setting_schedule_active?: boolean | undefined;
16278
+ active_climate_setting_schedule?: ({
16279
+ climate_setting_schedule_id: string;
16280
+ schedule_type: 'time_bound';
16281
+ device_id: string;
16282
+ name?: string | undefined;
16283
+ schedule_starts_at: string;
16284
+ schedule_ends_at: string;
16285
+ created_at: string;
16286
+ automatic_heating_enabled?: boolean | undefined;
16287
+ automatic_cooling_enabled?: boolean | undefined;
16288
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
16289
+ cooling_set_point_celsius?: (number | undefined) | undefined;
16290
+ heating_set_point_celsius?: (number | undefined) | undefined;
16291
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
16292
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
16293
+ manual_override_allowed?: boolean | undefined;
16294
+ } | undefined) | undefined;
16295
+ min_cooling_set_point_celsius?: number | undefined;
16296
+ min_cooling_set_point_fahrenheit?: number | undefined;
16297
+ max_cooling_set_point_celsius?: number | undefined;
16298
+ max_cooling_set_point_fahrenheit?: number | undefined;
16299
+ min_heating_set_point_celsius?: number | undefined;
16300
+ min_heating_set_point_fahrenheit?: number | undefined;
16301
+ max_heating_set_point_celsius?: number | undefined;
16302
+ max_heating_set_point_fahrenheit?: number | undefined;
16303
+ min_heating_cooling_delta_celsius?: number | undefined;
16304
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
16305
+ } | {
16306
+ temperature_fahrenheit?: number | undefined;
16307
+ temperature_celsius?: number | undefined;
16308
+ relative_humidity?: number | undefined;
16309
+ can_enable_automatic_heating?: boolean | undefined;
16310
+ can_enable_automatic_cooling?: boolean | undefined;
16311
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
16312
+ is_heating_available?: true | undefined;
16313
+ is_cooling_available?: false | undefined;
16314
+ is_heating?: boolean | undefined;
16315
+ is_cooling?: boolean | undefined;
16316
+ is_fan_running?: boolean | undefined;
16317
+ fan_mode_setting?: ('auto' | 'on') | undefined;
16318
+ is_temporary_manual_override_active?: boolean | undefined;
16319
+ current_climate_setting?: {
16320
+ automatic_heating_enabled: boolean;
16321
+ automatic_cooling_enabled: boolean;
16322
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16323
+ cooling_set_point_celsius?: number | undefined;
16324
+ heating_set_point_celsius?: number | undefined;
16325
+ cooling_set_point_fahrenheit?: number | undefined;
16326
+ heating_set_point_fahrenheit?: number | undefined;
16327
+ manual_override_allowed: boolean;
16328
+ } | undefined;
16329
+ default_climate_setting?: ({
16330
+ automatic_heating_enabled: boolean;
16331
+ automatic_cooling_enabled: boolean;
16332
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16333
+ cooling_set_point_celsius?: number | undefined;
16334
+ heating_set_point_celsius?: number | undefined;
16335
+ cooling_set_point_fahrenheit?: number | undefined;
16336
+ heating_set_point_fahrenheit?: number | undefined;
16337
+ manual_override_allowed: boolean;
16338
+ } | undefined) | undefined;
16339
+ is_climate_setting_schedule_active?: boolean | undefined;
16340
+ active_climate_setting_schedule?: ({
16341
+ climate_setting_schedule_id: string;
16342
+ schedule_type: 'time_bound';
16343
+ device_id: string;
16344
+ name?: string | undefined;
16345
+ schedule_starts_at: string;
16346
+ schedule_ends_at: string;
16347
+ created_at: string;
16348
+ automatic_heating_enabled?: boolean | undefined;
16349
+ automatic_cooling_enabled?: boolean | undefined;
16350
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
16351
+ cooling_set_point_celsius?: (number | undefined) | undefined;
16352
+ heating_set_point_celsius?: (number | undefined) | undefined;
16353
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
16354
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
16355
+ manual_override_allowed?: boolean | undefined;
16356
+ } | undefined) | undefined;
16357
+ min_heating_set_point_celsius?: number | undefined;
16358
+ min_heating_set_point_fahrenheit?: number | undefined;
16359
+ max_heating_set_point_celsius?: number | undefined;
16360
+ max_heating_set_point_fahrenheit?: number | undefined;
16361
+ } | {
16362
+ temperature_fahrenheit?: number | undefined;
16363
+ temperature_celsius?: number | undefined;
16364
+ relative_humidity?: number | undefined;
16365
+ can_enable_automatic_heating?: boolean | undefined;
16366
+ can_enable_automatic_cooling?: boolean | undefined;
16367
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
16368
+ is_heating_available?: false | undefined;
16369
+ is_cooling_available?: true | undefined;
16370
+ is_heating?: boolean | undefined;
16371
+ is_cooling?: boolean | undefined;
16372
+ is_fan_running?: boolean | undefined;
16373
+ fan_mode_setting?: ('auto' | 'on') | undefined;
16374
+ is_temporary_manual_override_active?: boolean | undefined;
16375
+ current_climate_setting?: {
16376
+ automatic_heating_enabled: boolean;
16377
+ automatic_cooling_enabled: boolean;
16378
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16379
+ cooling_set_point_celsius?: number | undefined;
16380
+ heating_set_point_celsius?: number | undefined;
16381
+ cooling_set_point_fahrenheit?: number | undefined;
16382
+ heating_set_point_fahrenheit?: number | undefined;
16383
+ manual_override_allowed: boolean;
16384
+ } | undefined;
16385
+ default_climate_setting?: ({
16386
+ automatic_heating_enabled: boolean;
16387
+ automatic_cooling_enabled: boolean;
16388
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
16389
+ cooling_set_point_celsius?: number | undefined;
16390
+ heating_set_point_celsius?: number | undefined;
16391
+ cooling_set_point_fahrenheit?: number | undefined;
16392
+ heating_set_point_fahrenheit?: number | undefined;
16393
+ manual_override_allowed: boolean;
16394
+ } | undefined) | undefined;
16395
+ is_climate_setting_schedule_active?: boolean | undefined;
16396
+ active_climate_setting_schedule?: ({
16397
+ climate_setting_schedule_id: string;
16398
+ schedule_type: 'time_bound';
16399
+ device_id: string;
16400
+ name?: string | undefined;
16401
+ schedule_starts_at: string;
16402
+ schedule_ends_at: string;
16403
+ created_at: string;
16404
+ automatic_heating_enabled?: boolean | undefined;
16405
+ automatic_cooling_enabled?: boolean | undefined;
16406
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
16407
+ cooling_set_point_celsius?: (number | undefined) | undefined;
16408
+ heating_set_point_celsius?: (number | undefined) | undefined;
16409
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
16410
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
16411
+ manual_override_allowed?: boolean | undefined;
16412
+ } | undefined) | undefined;
16413
+ min_cooling_set_point_celsius?: number | undefined;
16414
+ min_cooling_set_point_fahrenheit?: number | undefined;
16415
+ max_cooling_set_point_celsius?: number | undefined;
16416
+ max_cooling_set_point_fahrenheit?: number | undefined;
16417
+ }));
16418
+ location: {
16419
+ location_name?: string | undefined;
16420
+ timezone?: string | undefined;
16421
+ } | null;
16422
+ connected_account_id: string;
16423
+ workspace_id: string;
16424
+ errors: Array<{
16425
+ error_code: string;
16426
+ message: string;
16427
+ }>;
16428
+ warnings: Array<{
16429
+ warning_code: string;
16430
+ message: string;
16431
+ }>;
16432
+ created_at: string;
16433
+ is_managed: true;
16434
+ }>;
14842
16435
  };
14843
16436
  };
14844
16437
  '/locks/lock_door': {
@@ -15269,6 +16862,9 @@ interface Routes {
15269
16862
  model: {
15270
16863
  display_name: string;
15271
16864
  manufacturer_display_name: string;
16865
+ offline_access_codes_supported?: boolean | undefined;
16866
+ access_codes_supported?: boolean | undefined;
16867
+ accessory_keypad_supported?: boolean | undefined;
15272
16868
  };
15273
16869
  has_direct_power?: boolean | undefined;
15274
16870
  battery_level?: number | undefined;
@@ -15280,7 +16876,13 @@ interface Routes {
15280
16876
  image_url?: string | undefined;
15281
16877
  image_alt_text?: string | undefined;
15282
16878
  serial_number?: string | undefined;
16879
+ /** Currently possible to use online access codes */
16880
+ online_access_codes_enabled?: boolean | undefined;
16881
+ /** Currently possible to use offline access codes */
16882
+ offline_access_codes_enabled?: boolean | undefined;
16883
+ /** Deprecated: use model.offline_access_codes_enabled. */
15283
16884
  supports_accessory_keypad?: boolean | undefined;
16885
+ /** Deprecated: use model.accessory_keypad_supported. */
15284
16886
  supports_offline_access_codes?: boolean | undefined;
15285
16887
  } & {
15286
16888
  august_metadata?: {
@@ -15709,6 +17311,9 @@ interface Routes {
15709
17311
  model: {
15710
17312
  display_name: string;
15711
17313
  manufacturer_display_name: string;
17314
+ offline_access_codes_supported?: boolean | undefined;
17315
+ access_codes_supported?: boolean | undefined;
17316
+ accessory_keypad_supported?: boolean | undefined;
15712
17317
  };
15713
17318
  has_direct_power?: boolean | undefined;
15714
17319
  battery_level?: number | undefined;
@@ -15720,7 +17325,13 @@ interface Routes {
15720
17325
  image_url?: string | undefined;
15721
17326
  image_alt_text?: string | undefined;
15722
17327
  serial_number?: string | undefined;
17328
+ /** Currently possible to use online access codes */
17329
+ online_access_codes_enabled?: boolean | undefined;
17330
+ /** Currently possible to use offline access codes */
17331
+ offline_access_codes_enabled?: boolean | undefined;
17332
+ /** Deprecated: use model.offline_access_codes_enabled. */
15723
17333
  supports_accessory_keypad?: boolean | undefined;
17334
+ /** Deprecated: use model.accessory_keypad_supported. */
15724
17335
  supports_offline_access_codes?: boolean | undefined;
15725
17336
  } & {
15726
17337
  august_metadata?: {
@@ -16221,6 +17832,9 @@ interface Routes {
16221
17832
  model: {
16222
17833
  display_name: string;
16223
17834
  manufacturer_display_name: string;
17835
+ offline_access_codes_supported?: boolean | undefined;
17836
+ access_codes_supported?: boolean | undefined;
17837
+ accessory_keypad_supported?: boolean | undefined;
16224
17838
  };
16225
17839
  has_direct_power?: boolean | undefined;
16226
17840
  battery_level?: number | undefined;
@@ -16232,7 +17846,13 @@ interface Routes {
16232
17846
  image_url?: string | undefined;
16233
17847
  image_alt_text?: string | undefined;
16234
17848
  serial_number?: string | undefined;
17849
+ /** Currently possible to use online access codes */
17850
+ online_access_codes_enabled?: boolean | undefined;
17851
+ /** Currently possible to use offline access codes */
17852
+ offline_access_codes_enabled?: boolean | undefined;
17853
+ /** Deprecated: use model.offline_access_codes_enabled. */
16235
17854
  supports_accessory_keypad?: boolean | undefined;
17855
+ /** Deprecated: use model.accessory_keypad_supported. */
16236
17856
  supports_offline_access_codes?: boolean | undefined;
16237
17857
  } & {
16238
17858
  august_metadata?: {