@seamapi/types 1.208.0 → 1.209.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.
@@ -11444,6 +11444,1624 @@ export interface Routes {
11444
11444
  }>
11445
11445
  }
11446
11446
  }
11447
+ '/noise_sensors/list': {
11448
+ route: '/noise_sensors/list'
11449
+ method: 'GET' | 'POST'
11450
+ queryParams: {}
11451
+ jsonBody: {}
11452
+ commonParams: {
11453
+ /** List all devices owned by this connected account */
11454
+ connected_account_id?: string | undefined
11455
+ connected_account_ids?: string[] | undefined
11456
+ connect_webview_id?: string | undefined
11457
+ device_type?:
11458
+ | (
11459
+ | (
11460
+ | 'akuvox_lock'
11461
+ | 'august_lock'
11462
+ | 'brivo_access_point'
11463
+ | 'butterflymx_panel'
11464
+ | 'avigilon_alta_entry'
11465
+ | 'doorking_lock'
11466
+ | 'genie_door'
11467
+ | 'igloo_lock'
11468
+ | 'linear_lock'
11469
+ | 'lockly_lock'
11470
+ | 'kwikset_lock'
11471
+ | 'nuki_lock'
11472
+ | 'salto_lock'
11473
+ | 'schlage_lock'
11474
+ | 'seam_relay'
11475
+ | 'smartthings_lock'
11476
+ | 'wyze_lock'
11477
+ | 'yale_lock'
11478
+ | 'two_n_intercom'
11479
+ | 'controlbyweb_device'
11480
+ | 'ttlock_lock'
11481
+ | 'igloohome_lock'
11482
+ | 'hubitat_lock'
11483
+ | 'four_suites_door'
11484
+ | 'dormakaba_oracode_door'
11485
+ | 'tedee_lock'
11486
+ )
11487
+ | ('noiseaware_activity_zone' | 'minut_sensor')
11488
+ | (
11489
+ | 'ecobee_thermostat'
11490
+ | 'nest_thermostat'
11491
+ | 'honeywell_resideo_thermostat'
11492
+ )
11493
+ | ('ios_phone' | 'android_phone')
11494
+ )
11495
+ | undefined
11496
+ device_types?:
11497
+ | Array<
11498
+ | (
11499
+ | 'akuvox_lock'
11500
+ | 'august_lock'
11501
+ | 'brivo_access_point'
11502
+ | 'butterflymx_panel'
11503
+ | 'avigilon_alta_entry'
11504
+ | 'doorking_lock'
11505
+ | 'genie_door'
11506
+ | 'igloo_lock'
11507
+ | 'linear_lock'
11508
+ | 'lockly_lock'
11509
+ | 'kwikset_lock'
11510
+ | 'nuki_lock'
11511
+ | 'salto_lock'
11512
+ | 'schlage_lock'
11513
+ | 'seam_relay'
11514
+ | 'smartthings_lock'
11515
+ | 'wyze_lock'
11516
+ | 'yale_lock'
11517
+ | 'two_n_intercom'
11518
+ | 'controlbyweb_device'
11519
+ | 'ttlock_lock'
11520
+ | 'igloohome_lock'
11521
+ | 'hubitat_lock'
11522
+ | 'four_suites_door'
11523
+ | 'dormakaba_oracode_door'
11524
+ | 'tedee_lock'
11525
+ )
11526
+ | ('noiseaware_activity_zone' | 'minut_sensor')
11527
+ | (
11528
+ | 'ecobee_thermostat'
11529
+ | 'nest_thermostat'
11530
+ | 'honeywell_resideo_thermostat'
11531
+ )
11532
+ | ('ios_phone' | 'android_phone')
11533
+ >
11534
+ | undefined
11535
+ manufacturer?:
11536
+ | (
11537
+ | 'akuvox'
11538
+ | 'august'
11539
+ | 'avigilon_alta'
11540
+ | 'brivo'
11541
+ | 'butterflymx'
11542
+ | 'doorking'
11543
+ | 'four_suites'
11544
+ | 'genie'
11545
+ | 'igloo'
11546
+ | 'keywe'
11547
+ | 'kwikset'
11548
+ | 'linear'
11549
+ | 'lockly'
11550
+ | 'nuki'
11551
+ | 'philia'
11552
+ | 'salto'
11553
+ | 'samsung'
11554
+ | 'schlage'
11555
+ | 'seam'
11556
+ | 'unknown'
11557
+ | 'wyze'
11558
+ | 'yale'
11559
+ | 'minut'
11560
+ | 'two_n'
11561
+ | 'ttlock'
11562
+ | 'nest'
11563
+ | 'igloohome'
11564
+ | 'ecobee'
11565
+ | 'hubitat'
11566
+ | 'controlbyweb'
11567
+ | 'smartthings'
11568
+ | 'dormakaba_oracode'
11569
+ | 'tedee'
11570
+ | 'honeywell_resideo'
11571
+ )
11572
+ | undefined
11573
+ device_ids?: string[] | undefined
11574
+ limit?: number
11575
+ created_before?: Date | undefined
11576
+ user_identifier_key?: string | undefined
11577
+ custom_metadata_has?: Record<string, string | boolean> | undefined
11578
+ include_if?:
11579
+ | Array<
11580
+ | 'can_remotely_unlock'
11581
+ | 'can_remotely_lock'
11582
+ | 'can_program_offline_access_codes'
11583
+ | 'can_program_online_access_codes'
11584
+ | 'can_simulate_removal'
11585
+ | 'can_simulate_connection'
11586
+ | 'can_simulate_disconnection'
11587
+ >
11588
+ | undefined
11589
+ exclude_if?:
11590
+ | Array<
11591
+ | 'can_remotely_unlock'
11592
+ | 'can_remotely_lock'
11593
+ | 'can_program_offline_access_codes'
11594
+ | 'can_program_online_access_codes'
11595
+ | 'can_simulate_removal'
11596
+ | 'can_simulate_connection'
11597
+ | 'can_simulate_disconnection'
11598
+ >
11599
+ | undefined
11600
+ }
11601
+ formData: {}
11602
+ jsonResponse: {
11603
+ noise_sensors: Array<{
11604
+ /** Unique identifier for the device. */
11605
+ device_id: string
11606
+ /** Type of the device. */
11607
+ device_type:
11608
+ | (
11609
+ | 'akuvox_lock'
11610
+ | 'august_lock'
11611
+ | 'brivo_access_point'
11612
+ | 'butterflymx_panel'
11613
+ | 'avigilon_alta_entry'
11614
+ | 'doorking_lock'
11615
+ | 'genie_door'
11616
+ | 'igloo_lock'
11617
+ | 'linear_lock'
11618
+ | 'lockly_lock'
11619
+ | 'kwikset_lock'
11620
+ | 'nuki_lock'
11621
+ | 'salto_lock'
11622
+ | 'schlage_lock'
11623
+ | 'seam_relay'
11624
+ | 'smartthings_lock'
11625
+ | 'wyze_lock'
11626
+ | 'yale_lock'
11627
+ | 'two_n_intercom'
11628
+ | 'controlbyweb_device'
11629
+ | 'ttlock_lock'
11630
+ | 'igloohome_lock'
11631
+ | 'hubitat_lock'
11632
+ | 'four_suites_door'
11633
+ | 'dormakaba_oracode_door'
11634
+ | 'tedee_lock'
11635
+ )
11636
+ | ('noiseaware_activity_zone' | 'minut_sensor')
11637
+ | (
11638
+ | 'ecobee_thermostat'
11639
+ | 'nest_thermostat'
11640
+ | 'honeywell_resideo_thermostat'
11641
+ )
11642
+ | ('ios_phone' | 'android_phone')
11643
+ /** Optional nickname to describe the device, settable through Seam */
11644
+ nickname?: string | undefined
11645
+ /** 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. */
11646
+ display_name: string
11647
+ /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
11648
+ capabilities_supported: Array<
11649
+ | 'access_code'
11650
+ | 'lock'
11651
+ | 'noise_detection'
11652
+ | 'thermostat'
11653
+ | 'battery'
11654
+ | 'phone'
11655
+ >
11656
+ /** Properties of the device. */
11657
+ properties: (({
11658
+ /** Indicates whether the device is online. */
11659
+ online: boolean
11660
+ /** Name of the device.
11661
+ * @deprecated use device.display_name instead */
11662
+ name: string
11663
+ /** Represents the accessory keypad state. */
11664
+ accessory_keypad?:
11665
+ | {
11666
+ /** Indicates if the accessory_keypad is connected to the device. */
11667
+ is_connected: boolean
11668
+ /** Indicates if the keypad battery properties. */
11669
+ battery?:
11670
+ | {
11671
+ level: number
11672
+ }
11673
+ | undefined
11674
+ }
11675
+ | undefined
11676
+ appearance: {
11677
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
11678
+ name: string
11679
+ }
11680
+ model: {
11681
+ /** Indicates whether the device can connect a accessory keypad. */
11682
+ can_connect_accessory_keypad?: boolean | undefined
11683
+ /** Display name of the device model. */
11684
+ display_name: string
11685
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
11686
+ manufacturer_display_name: string
11687
+ /** Indicates whether the device has a built in accessory keypad. */
11688
+ has_built_in_keypad?: boolean | undefined
11689
+ /** Indicates whether the device supports offline access codes. */
11690
+ offline_access_codes_supported?: boolean | undefined
11691
+ /** Indicates whether the device supports online access codes. */
11692
+ online_access_codes_supported?: boolean | undefined
11693
+ /**
11694
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
11695
+ accessory_keypad_supported?: boolean | undefined
11696
+ }
11697
+ /** Indicates whether the device has direct power. */
11698
+ has_direct_power?: boolean | undefined
11699
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
11700
+ battery_level?: number | undefined
11701
+ /** 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. */
11702
+ battery?:
11703
+ | {
11704
+ level: number
11705
+ status: 'critical' | 'low' | 'good' | 'full'
11706
+ }
11707
+ | undefined
11708
+ /** Manufacturer of the device. */
11709
+ manufacturer?: string | undefined
11710
+ /** Image URL for the device. */
11711
+ image_url?: string | undefined
11712
+ /** Alt text for the device image. */
11713
+ image_alt_text?: string | undefined
11714
+ /** Serial number of the device. */
11715
+ serial_number?: string | undefined
11716
+ /** Indicates whether it is currently possible to use online access codes for the device. */
11717
+ online_access_codes_enabled?: boolean | undefined
11718
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
11719
+ offline_access_codes_enabled?: boolean | undefined
11720
+ /**
11721
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
11722
+ supports_accessory_keypad?: boolean | undefined
11723
+ /**
11724
+ * @deprecated use offline_access_codes_enabled */
11725
+ supports_offline_access_codes?: boolean | undefined
11726
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
11727
+ noise_level_decibels?: number | undefined
11728
+ /** Array of noise threshold IDs that are currently triggering. */
11729
+ currently_triggering_noise_threshold_ids?: string[] | undefined
11730
+ } & {
11731
+ assa_abloy_credential_service_metadata?:
11732
+ | (
11733
+ | {
11734
+ has_active_endpoint: boolean
11735
+ endpoints: Array<{
11736
+ endpoint_id: string
11737
+ is_active: boolean
11738
+ }>
11739
+ }
11740
+ | undefined
11741
+ )
11742
+ | undefined
11743
+ }) & {
11744
+ august_metadata?:
11745
+ | {
11746
+ lock_id: string
11747
+ lock_name: string
11748
+ house_name: string
11749
+ has_keypad: boolean
11750
+ keypad_battery_level?: string | undefined
11751
+ model?: string | undefined
11752
+ house_id?: string | undefined
11753
+ }
11754
+ | undefined
11755
+ avigilon_alta_metadata?:
11756
+ | {
11757
+ entry_name: string
11758
+ org_name: string
11759
+ zone_id: number
11760
+ zone_name: string
11761
+ site_id: number
11762
+ site_name: string
11763
+ entry_relays_total_count: number
11764
+ }
11765
+ | undefined
11766
+ schlage_metadata?:
11767
+ | {
11768
+ device_id: string
11769
+ device_name: string
11770
+ access_code_length: number | null
11771
+ model?: string | undefined
11772
+ }
11773
+ | undefined
11774
+ smartthings_metadata?:
11775
+ | {
11776
+ device_id: string
11777
+ device_name: string
11778
+ model?: string | undefined
11779
+ location_id?: string | undefined
11780
+ }
11781
+ | undefined
11782
+ lockly_metadata?:
11783
+ | {
11784
+ device_id: string
11785
+ device_name: string
11786
+ model?: string | undefined
11787
+ }
11788
+ | undefined
11789
+ nuki_metadata?:
11790
+ | {
11791
+ device_id: string
11792
+ device_name: string
11793
+ keypad_battery_critical?: boolean | undefined
11794
+ keypad_paired?: boolean | undefined
11795
+ keypad_2_paired?: boolean | undefined
11796
+ }
11797
+ | undefined
11798
+ kwikset_metadata?:
11799
+ | {
11800
+ device_id: string
11801
+ device_name: string
11802
+ model_number: string
11803
+ }
11804
+ | undefined
11805
+ salto_metadata?:
11806
+ | {
11807
+ lock_id: string
11808
+ customer_reference: string
11809
+ lock_type: string
11810
+ battery_level: string
11811
+ locked_state: string
11812
+ model?: string | undefined
11813
+ }
11814
+ | undefined
11815
+ genie_metadata?:
11816
+ | {
11817
+ device_name: string
11818
+ door_name: string
11819
+ }
11820
+ | undefined
11821
+ brivo_metadata?:
11822
+ | {
11823
+ device_name: string
11824
+ }
11825
+ | undefined
11826
+ igloo_metadata?:
11827
+ | {
11828
+ device_id: string
11829
+ bridge_id: string
11830
+ model?: string | undefined
11831
+ }
11832
+ | undefined
11833
+ noiseaware_metadata?:
11834
+ | {
11835
+ device_model: 'indoor' | 'outdoor'
11836
+ noise_level_nrs: number
11837
+ noise_level_decibel: number
11838
+ device_name: string
11839
+ device_id: string
11840
+ }
11841
+ | undefined
11842
+ minut_metadata?:
11843
+ | {
11844
+ device_id: string
11845
+ device_name: string
11846
+ latest_sensor_values: {
11847
+ temperature: {
11848
+ time: string
11849
+ value: number
11850
+ }
11851
+ sound: {
11852
+ time: string
11853
+ value: number
11854
+ }
11855
+ humidity: {
11856
+ time: string
11857
+ value: number
11858
+ }
11859
+ pressure: {
11860
+ time: string
11861
+ value: number
11862
+ }
11863
+ accelerometer_z: {
11864
+ time: string
11865
+ value: number
11866
+ }
11867
+ }
11868
+ }
11869
+ | undefined
11870
+ four_suites_metadata?:
11871
+ | {
11872
+ device_id: number
11873
+ device_name: string
11874
+ reclose_delay_in_seconds: number
11875
+ }
11876
+ | undefined
11877
+ two_n_metadata?:
11878
+ | {
11879
+ device_id: number
11880
+ device_name: string
11881
+ }
11882
+ | undefined
11883
+ controlbyweb_metadata?:
11884
+ | {
11885
+ device_id: string
11886
+ device_name: string
11887
+ relay_name: string | null
11888
+ }
11889
+ | undefined
11890
+ ttlock_metadata?:
11891
+ | {
11892
+ lock_id: number
11893
+ lock_alias: string
11894
+ feature_value: string
11895
+ }
11896
+ | undefined
11897
+ seam_bridge_metadata?:
11898
+ | {
11899
+ unlock_method?: ('bridge' | 'doorking') | undefined
11900
+ device_num: number
11901
+ name: string
11902
+ }
11903
+ | undefined
11904
+ igloohome_metadata?:
11905
+ | {
11906
+ device_id: string
11907
+ device_name: string
11908
+ bridge_id?: string | undefined
11909
+ bridge_name?: string | undefined
11910
+ keypad_id?: string | undefined
11911
+ }
11912
+ | undefined
11913
+ nest_metadata?:
11914
+ | {
11915
+ nest_device_id: string
11916
+ device_name: string
11917
+ custom_name: string
11918
+ }
11919
+ | undefined
11920
+ ecobee_metadata?:
11921
+ | {
11922
+ ecobee_device_id: string
11923
+ device_name: string
11924
+ }
11925
+ | undefined
11926
+ honeywell_resideo_metadata?:
11927
+ | {
11928
+ honeywell_resideo_device_id: string
11929
+ device_name: string
11930
+ }
11931
+ | undefined
11932
+ hubitat_metadata?:
11933
+ | {
11934
+ device_id: string
11935
+ device_name: string
11936
+ device_label: string
11937
+ }
11938
+ | undefined
11939
+ dormakaba_oracode_metadata?:
11940
+ | {
11941
+ door_id: number
11942
+ door_name: string
11943
+ device_id?: number | undefined
11944
+ door_is_wireless: boolean
11945
+ site_id: number
11946
+ site_name: string
11947
+ iana_timezone?: string | undefined
11948
+ predefined_time_slots?:
11949
+ | Array<{
11950
+ name: string
11951
+ prefix: number
11952
+ check_in_time: string
11953
+ check_out_time: string
11954
+ is_24_hour: boolean
11955
+ is_biweekly_mode: boolean
11956
+ is_one_shot: boolean
11957
+ is_master: boolean
11958
+ ext_dormakaba_oracode_user_level_prefix: number
11959
+ dormakaba_oracode_user_level_id: string
11960
+ }>
11961
+ | undefined
11962
+ }
11963
+ | undefined
11964
+ wyze_metadata?:
11965
+ | {
11966
+ device_id: string
11967
+ device_name: string
11968
+ product_name: string
11969
+ product_type: string
11970
+ product_model: string
11971
+ device_info_model: string
11972
+ keypad_uuid?: string | undefined
11973
+ locker_status_hardlock?: number | undefined
11974
+ }
11975
+ | undefined
11976
+ tedee_metadata?:
11977
+ | {
11978
+ device_id: number
11979
+ serial_number: string
11980
+ device_name: string
11981
+ device_model: string
11982
+ bridge_id: number
11983
+ bridge_name: string
11984
+ keypad_id?: number | undefined
11985
+ }
11986
+ | undefined
11987
+ }) &
11988
+ ({
11989
+ _experimental_supported_code_from_access_codes_lengths?:
11990
+ | (number[] | undefined)
11991
+ | undefined
11992
+ code_constraints?:
11993
+ | (
11994
+ | Array<
11995
+ | {
11996
+ constraint_type:
11997
+ | 'no_zeros'
11998
+ | 'cannot_start_with_12'
11999
+ | 'no_triple_consecutive_ints'
12000
+ | 'cannot_specify_pin_code'
12001
+ | 'pin_code_matches_existing_set'
12002
+ | 'start_date_in_future'
12003
+ | 'no_ascending_or_descending_sequence'
12004
+ | 'at_least_three_unique_digits'
12005
+ | 'cannot_contain_089'
12006
+ }
12007
+ | {
12008
+ constraint_type: 'name_length' | 'name_must_be_unique'
12009
+ min_length?: number | undefined
12010
+ max_length?: number | undefined
12011
+ }
12012
+ >
12013
+ | undefined
12014
+ )
12015
+ | undefined
12016
+ supported_code_lengths?: (number[] | undefined) | undefined
12017
+ max_active_codes_supported?: (number | undefined) | undefined
12018
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
12019
+ has_native_entry_events?: (boolean | undefined) | undefined
12020
+ locked?: (boolean | undefined) | undefined
12021
+ keypad_battery?:
12022
+ | (
12023
+ | {
12024
+ level: number
12025
+ }
12026
+ | undefined
12027
+ )
12028
+ | undefined
12029
+ door_open?: (boolean | undefined) | undefined
12030
+ } & (
12031
+ | {
12032
+ temperature_fahrenheit?: number | undefined
12033
+ temperature_celsius?: number | undefined
12034
+ relative_humidity?: number | undefined
12035
+ can_enable_automatic_heating?: boolean | undefined
12036
+ can_enable_automatic_cooling?: boolean | undefined
12037
+ available_hvac_mode_settings?:
12038
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12039
+ | undefined
12040
+ is_heating_available?: true | undefined
12041
+ is_cooling_available?: true | undefined
12042
+ is_heating?: boolean | undefined
12043
+ is_cooling?: boolean | undefined
12044
+ is_fan_running?: boolean | undefined
12045
+ fan_mode_setting?: ('auto' | 'on') | undefined
12046
+ is_temporary_manual_override_active?: boolean | undefined
12047
+ current_climate_setting?:
12048
+ | {
12049
+ automatic_heating_enabled: boolean
12050
+ automatic_cooling_enabled: boolean
12051
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12052
+ cooling_set_point_celsius?: number | undefined
12053
+ heating_set_point_celsius?: number | undefined
12054
+ cooling_set_point_fahrenheit?: number | undefined
12055
+ heating_set_point_fahrenheit?: number | undefined
12056
+ manual_override_allowed: boolean
12057
+ }
12058
+ | undefined
12059
+ default_climate_setting?:
12060
+ | (
12061
+ | {
12062
+ automatic_heating_enabled: boolean
12063
+ automatic_cooling_enabled: boolean
12064
+ hvac_mode_setting:
12065
+ | 'off'
12066
+ | 'heat'
12067
+ | 'cool'
12068
+ | 'heat_cool'
12069
+ cooling_set_point_celsius?: number | undefined
12070
+ heating_set_point_celsius?: number | undefined
12071
+ cooling_set_point_fahrenheit?: number | undefined
12072
+ heating_set_point_fahrenheit?: number | undefined
12073
+ manual_override_allowed: boolean
12074
+ }
12075
+ | undefined
12076
+ )
12077
+ | undefined
12078
+ is_climate_setting_schedule_active?: boolean | undefined
12079
+ active_climate_setting_schedule?:
12080
+ | (
12081
+ | {
12082
+ climate_setting_schedule_id: string
12083
+ schedule_type: 'time_bound'
12084
+ device_id: string
12085
+ name?: string | undefined
12086
+ schedule_starts_at: string
12087
+ schedule_ends_at: string
12088
+ created_at: string
12089
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12090
+ errors?: any
12091
+ automatic_heating_enabled?: boolean | undefined
12092
+ automatic_cooling_enabled?: boolean | undefined
12093
+ hvac_mode_setting?:
12094
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12095
+ | undefined
12096
+ cooling_set_point_celsius?:
12097
+ | (number | undefined)
12098
+ | undefined
12099
+ heating_set_point_celsius?:
12100
+ | (number | undefined)
12101
+ | undefined
12102
+ cooling_set_point_fahrenheit?:
12103
+ | (number | undefined)
12104
+ | undefined
12105
+ heating_set_point_fahrenheit?:
12106
+ | (number | undefined)
12107
+ | undefined
12108
+ manual_override_allowed?: boolean | undefined
12109
+ }
12110
+ | undefined
12111
+ )
12112
+ | undefined
12113
+ min_cooling_set_point_celsius?: number | undefined
12114
+ min_cooling_set_point_fahrenheit?: number | undefined
12115
+ max_cooling_set_point_celsius?: number | undefined
12116
+ max_cooling_set_point_fahrenheit?: number | undefined
12117
+ min_heating_set_point_celsius?: number | undefined
12118
+ min_heating_set_point_fahrenheit?: number | undefined
12119
+ max_heating_set_point_celsius?: number | undefined
12120
+ max_heating_set_point_fahrenheit?: number | undefined
12121
+ min_heating_cooling_delta_celsius?: number | undefined
12122
+ min_heating_cooling_delta_fahrenheit?: number | undefined
12123
+ }
12124
+ | {
12125
+ temperature_fahrenheit?: number | undefined
12126
+ temperature_celsius?: number | undefined
12127
+ relative_humidity?: number | undefined
12128
+ can_enable_automatic_heating?: boolean | undefined
12129
+ can_enable_automatic_cooling?: boolean | undefined
12130
+ available_hvac_mode_settings?:
12131
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12132
+ | undefined
12133
+ is_heating_available?: true | undefined
12134
+ is_cooling_available?: false | undefined
12135
+ is_heating?: boolean | undefined
12136
+ is_cooling?: boolean | undefined
12137
+ is_fan_running?: boolean | undefined
12138
+ fan_mode_setting?: ('auto' | 'on') | undefined
12139
+ is_temporary_manual_override_active?: boolean | undefined
12140
+ current_climate_setting?:
12141
+ | {
12142
+ automatic_heating_enabled: boolean
12143
+ automatic_cooling_enabled: boolean
12144
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12145
+ cooling_set_point_celsius?: number | undefined
12146
+ heating_set_point_celsius?: number | undefined
12147
+ cooling_set_point_fahrenheit?: number | undefined
12148
+ heating_set_point_fahrenheit?: number | undefined
12149
+ manual_override_allowed: boolean
12150
+ }
12151
+ | undefined
12152
+ default_climate_setting?:
12153
+ | (
12154
+ | {
12155
+ automatic_heating_enabled: boolean
12156
+ automatic_cooling_enabled: boolean
12157
+ hvac_mode_setting:
12158
+ | 'off'
12159
+ | 'heat'
12160
+ | 'cool'
12161
+ | 'heat_cool'
12162
+ cooling_set_point_celsius?: number | undefined
12163
+ heating_set_point_celsius?: number | undefined
12164
+ cooling_set_point_fahrenheit?: number | undefined
12165
+ heating_set_point_fahrenheit?: number | undefined
12166
+ manual_override_allowed: boolean
12167
+ }
12168
+ | undefined
12169
+ )
12170
+ | undefined
12171
+ is_climate_setting_schedule_active?: boolean | undefined
12172
+ active_climate_setting_schedule?:
12173
+ | (
12174
+ | {
12175
+ climate_setting_schedule_id: string
12176
+ schedule_type: 'time_bound'
12177
+ device_id: string
12178
+ name?: string | undefined
12179
+ schedule_starts_at: string
12180
+ schedule_ends_at: string
12181
+ created_at: string
12182
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12183
+ errors?: any
12184
+ automatic_heating_enabled?: boolean | undefined
12185
+ automatic_cooling_enabled?: boolean | undefined
12186
+ hvac_mode_setting?:
12187
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12188
+ | undefined
12189
+ cooling_set_point_celsius?:
12190
+ | (number | undefined)
12191
+ | undefined
12192
+ heating_set_point_celsius?:
12193
+ | (number | undefined)
12194
+ | undefined
12195
+ cooling_set_point_fahrenheit?:
12196
+ | (number | undefined)
12197
+ | undefined
12198
+ heating_set_point_fahrenheit?:
12199
+ | (number | undefined)
12200
+ | undefined
12201
+ manual_override_allowed?: boolean | undefined
12202
+ }
12203
+ | undefined
12204
+ )
12205
+ | undefined
12206
+ min_heating_set_point_celsius?: number | undefined
12207
+ min_heating_set_point_fahrenheit?: number | undefined
12208
+ max_heating_set_point_celsius?: number | undefined
12209
+ max_heating_set_point_fahrenheit?: number | undefined
12210
+ }
12211
+ | {
12212
+ temperature_fahrenheit?: number | undefined
12213
+ temperature_celsius?: number | undefined
12214
+ relative_humidity?: number | undefined
12215
+ can_enable_automatic_heating?: boolean | undefined
12216
+ can_enable_automatic_cooling?: boolean | undefined
12217
+ available_hvac_mode_settings?:
12218
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12219
+ | undefined
12220
+ is_heating_available?: false | undefined
12221
+ is_cooling_available?: true | undefined
12222
+ is_heating?: boolean | undefined
12223
+ is_cooling?: boolean | undefined
12224
+ is_fan_running?: boolean | undefined
12225
+ fan_mode_setting?: ('auto' | 'on') | undefined
12226
+ is_temporary_manual_override_active?: boolean | undefined
12227
+ current_climate_setting?:
12228
+ | {
12229
+ automatic_heating_enabled: boolean
12230
+ automatic_cooling_enabled: boolean
12231
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12232
+ cooling_set_point_celsius?: number | undefined
12233
+ heating_set_point_celsius?: number | undefined
12234
+ cooling_set_point_fahrenheit?: number | undefined
12235
+ heating_set_point_fahrenheit?: number | undefined
12236
+ manual_override_allowed: boolean
12237
+ }
12238
+ | undefined
12239
+ default_climate_setting?:
12240
+ | (
12241
+ | {
12242
+ automatic_heating_enabled: boolean
12243
+ automatic_cooling_enabled: boolean
12244
+ hvac_mode_setting:
12245
+ | 'off'
12246
+ | 'heat'
12247
+ | 'cool'
12248
+ | 'heat_cool'
12249
+ cooling_set_point_celsius?: number | undefined
12250
+ heating_set_point_celsius?: number | undefined
12251
+ cooling_set_point_fahrenheit?: number | undefined
12252
+ heating_set_point_fahrenheit?: number | undefined
12253
+ manual_override_allowed: boolean
12254
+ }
12255
+ | undefined
12256
+ )
12257
+ | undefined
12258
+ is_climate_setting_schedule_active?: boolean | undefined
12259
+ active_climate_setting_schedule?:
12260
+ | (
12261
+ | {
12262
+ climate_setting_schedule_id: string
12263
+ schedule_type: 'time_bound'
12264
+ device_id: string
12265
+ name?: string | undefined
12266
+ schedule_starts_at: string
12267
+ schedule_ends_at: string
12268
+ created_at: string
12269
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12270
+ errors?: any
12271
+ automatic_heating_enabled?: boolean | undefined
12272
+ automatic_cooling_enabled?: boolean | undefined
12273
+ hvac_mode_setting?:
12274
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12275
+ | undefined
12276
+ cooling_set_point_celsius?:
12277
+ | (number | undefined)
12278
+ | undefined
12279
+ heating_set_point_celsius?:
12280
+ | (number | undefined)
12281
+ | undefined
12282
+ cooling_set_point_fahrenheit?:
12283
+ | (number | undefined)
12284
+ | undefined
12285
+ heating_set_point_fahrenheit?:
12286
+ | (number | undefined)
12287
+ | undefined
12288
+ manual_override_allowed?: boolean | undefined
12289
+ }
12290
+ | undefined
12291
+ )
12292
+ | undefined
12293
+ min_cooling_set_point_celsius?: number | undefined
12294
+ min_cooling_set_point_fahrenheit?: number | undefined
12295
+ max_cooling_set_point_celsius?: number | undefined
12296
+ max_cooling_set_point_fahrenheit?: number | undefined
12297
+ }
12298
+ ))
12299
+ /** Location information for the device. */
12300
+ location: {
12301
+ /** Name of the device location. */
12302
+ location_name?: string | undefined
12303
+ /** Time zone of the device location. */
12304
+ timezone?: string | undefined
12305
+ } | null
12306
+ /** Unique identifier for the account associated with the device. */
12307
+ connected_account_id: string
12308
+ /** Unique identifier for the Seam workspace associated with the device. */
12309
+ workspace_id: string
12310
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
12311
+ errors: Array<{
12312
+ error_code: string
12313
+ message: string
12314
+ }>
12315
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
12316
+ warnings: Array<{
12317
+ warning_code: string
12318
+ message: string
12319
+ }>
12320
+ /** Date and time at which the device object was created. */
12321
+ created_at: string
12322
+ /** Indicates whether Seam manages the device. */
12323
+ is_managed: true
12324
+ custom_metadata: Record<string, string | boolean>
12325
+ can_remotely_unlock?: boolean | undefined
12326
+ can_remotely_lock?: boolean | undefined
12327
+ can_program_offline_access_codes?: boolean | undefined
12328
+ can_program_online_access_codes?: boolean | undefined
12329
+ can_simulate_removal?: boolean | undefined
12330
+ can_simulate_connection?: boolean | undefined
12331
+ can_simulate_disconnection?: boolean | undefined
12332
+ }>
12333
+ devices: Array<{
12334
+ /** Unique identifier for the device. */
12335
+ device_id: string
12336
+ /** Type of the device. */
12337
+ device_type:
12338
+ | (
12339
+ | 'akuvox_lock'
12340
+ | 'august_lock'
12341
+ | 'brivo_access_point'
12342
+ | 'butterflymx_panel'
12343
+ | 'avigilon_alta_entry'
12344
+ | 'doorking_lock'
12345
+ | 'genie_door'
12346
+ | 'igloo_lock'
12347
+ | 'linear_lock'
12348
+ | 'lockly_lock'
12349
+ | 'kwikset_lock'
12350
+ | 'nuki_lock'
12351
+ | 'salto_lock'
12352
+ | 'schlage_lock'
12353
+ | 'seam_relay'
12354
+ | 'smartthings_lock'
12355
+ | 'wyze_lock'
12356
+ | 'yale_lock'
12357
+ | 'two_n_intercom'
12358
+ | 'controlbyweb_device'
12359
+ | 'ttlock_lock'
12360
+ | 'igloohome_lock'
12361
+ | 'hubitat_lock'
12362
+ | 'four_suites_door'
12363
+ | 'dormakaba_oracode_door'
12364
+ | 'tedee_lock'
12365
+ )
12366
+ | ('noiseaware_activity_zone' | 'minut_sensor')
12367
+ | (
12368
+ | 'ecobee_thermostat'
12369
+ | 'nest_thermostat'
12370
+ | 'honeywell_resideo_thermostat'
12371
+ )
12372
+ | ('ios_phone' | 'android_phone')
12373
+ /** Optional nickname to describe the device, settable through Seam */
12374
+ nickname?: string | undefined
12375
+ /** 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. */
12376
+ display_name: string
12377
+ /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
12378
+ capabilities_supported: Array<
12379
+ | 'access_code'
12380
+ | 'lock'
12381
+ | 'noise_detection'
12382
+ | 'thermostat'
12383
+ | 'battery'
12384
+ | 'phone'
12385
+ >
12386
+ /** Properties of the device. */
12387
+ properties: (({
12388
+ /** Indicates whether the device is online. */
12389
+ online: boolean
12390
+ /** Name of the device.
12391
+ * @deprecated use device.display_name instead */
12392
+ name: string
12393
+ /** Represents the accessory keypad state. */
12394
+ accessory_keypad?:
12395
+ | {
12396
+ /** Indicates if the accessory_keypad is connected to the device. */
12397
+ is_connected: boolean
12398
+ /** Indicates if the keypad battery properties. */
12399
+ battery?:
12400
+ | {
12401
+ level: number
12402
+ }
12403
+ | undefined
12404
+ }
12405
+ | undefined
12406
+ appearance: {
12407
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
12408
+ name: string
12409
+ }
12410
+ model: {
12411
+ /** Indicates whether the device can connect a accessory keypad. */
12412
+ can_connect_accessory_keypad?: boolean | undefined
12413
+ /** Display name of the device model. */
12414
+ display_name: string
12415
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
12416
+ manufacturer_display_name: string
12417
+ /** Indicates whether the device has a built in accessory keypad. */
12418
+ has_built_in_keypad?: boolean | undefined
12419
+ /** Indicates whether the device supports offline access codes. */
12420
+ offline_access_codes_supported?: boolean | undefined
12421
+ /** Indicates whether the device supports online access codes. */
12422
+ online_access_codes_supported?: boolean | undefined
12423
+ /**
12424
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
12425
+ accessory_keypad_supported?: boolean | undefined
12426
+ }
12427
+ /** Indicates whether the device has direct power. */
12428
+ has_direct_power?: boolean | undefined
12429
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
12430
+ battery_level?: number | undefined
12431
+ /** 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. */
12432
+ battery?:
12433
+ | {
12434
+ level: number
12435
+ status: 'critical' | 'low' | 'good' | 'full'
12436
+ }
12437
+ | undefined
12438
+ /** Manufacturer of the device. */
12439
+ manufacturer?: string | undefined
12440
+ /** Image URL for the device. */
12441
+ image_url?: string | undefined
12442
+ /** Alt text for the device image. */
12443
+ image_alt_text?: string | undefined
12444
+ /** Serial number of the device. */
12445
+ serial_number?: string | undefined
12446
+ /** Indicates whether it is currently possible to use online access codes for the device. */
12447
+ online_access_codes_enabled?: boolean | undefined
12448
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
12449
+ offline_access_codes_enabled?: boolean | undefined
12450
+ /**
12451
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
12452
+ supports_accessory_keypad?: boolean | undefined
12453
+ /**
12454
+ * @deprecated use offline_access_codes_enabled */
12455
+ supports_offline_access_codes?: boolean | undefined
12456
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
12457
+ noise_level_decibels?: number | undefined
12458
+ /** Array of noise threshold IDs that are currently triggering. */
12459
+ currently_triggering_noise_threshold_ids?: string[] | undefined
12460
+ } & {
12461
+ assa_abloy_credential_service_metadata?:
12462
+ | (
12463
+ | {
12464
+ has_active_endpoint: boolean
12465
+ endpoints: Array<{
12466
+ endpoint_id: string
12467
+ is_active: boolean
12468
+ }>
12469
+ }
12470
+ | undefined
12471
+ )
12472
+ | undefined
12473
+ }) & {
12474
+ august_metadata?:
12475
+ | {
12476
+ lock_id: string
12477
+ lock_name: string
12478
+ house_name: string
12479
+ has_keypad: boolean
12480
+ keypad_battery_level?: string | undefined
12481
+ model?: string | undefined
12482
+ house_id?: string | undefined
12483
+ }
12484
+ | undefined
12485
+ avigilon_alta_metadata?:
12486
+ | {
12487
+ entry_name: string
12488
+ org_name: string
12489
+ zone_id: number
12490
+ zone_name: string
12491
+ site_id: number
12492
+ site_name: string
12493
+ entry_relays_total_count: number
12494
+ }
12495
+ | undefined
12496
+ schlage_metadata?:
12497
+ | {
12498
+ device_id: string
12499
+ device_name: string
12500
+ access_code_length: number | null
12501
+ model?: string | undefined
12502
+ }
12503
+ | undefined
12504
+ smartthings_metadata?:
12505
+ | {
12506
+ device_id: string
12507
+ device_name: string
12508
+ model?: string | undefined
12509
+ location_id?: string | undefined
12510
+ }
12511
+ | undefined
12512
+ lockly_metadata?:
12513
+ | {
12514
+ device_id: string
12515
+ device_name: string
12516
+ model?: string | undefined
12517
+ }
12518
+ | undefined
12519
+ nuki_metadata?:
12520
+ | {
12521
+ device_id: string
12522
+ device_name: string
12523
+ keypad_battery_critical?: boolean | undefined
12524
+ keypad_paired?: boolean | undefined
12525
+ keypad_2_paired?: boolean | undefined
12526
+ }
12527
+ | undefined
12528
+ kwikset_metadata?:
12529
+ | {
12530
+ device_id: string
12531
+ device_name: string
12532
+ model_number: string
12533
+ }
12534
+ | undefined
12535
+ salto_metadata?:
12536
+ | {
12537
+ lock_id: string
12538
+ customer_reference: string
12539
+ lock_type: string
12540
+ battery_level: string
12541
+ locked_state: string
12542
+ model?: string | undefined
12543
+ }
12544
+ | undefined
12545
+ genie_metadata?:
12546
+ | {
12547
+ device_name: string
12548
+ door_name: string
12549
+ }
12550
+ | undefined
12551
+ brivo_metadata?:
12552
+ | {
12553
+ device_name: string
12554
+ }
12555
+ | undefined
12556
+ igloo_metadata?:
12557
+ | {
12558
+ device_id: string
12559
+ bridge_id: string
12560
+ model?: string | undefined
12561
+ }
12562
+ | undefined
12563
+ noiseaware_metadata?:
12564
+ | {
12565
+ device_model: 'indoor' | 'outdoor'
12566
+ noise_level_nrs: number
12567
+ noise_level_decibel: number
12568
+ device_name: string
12569
+ device_id: string
12570
+ }
12571
+ | undefined
12572
+ minut_metadata?:
12573
+ | {
12574
+ device_id: string
12575
+ device_name: string
12576
+ latest_sensor_values: {
12577
+ temperature: {
12578
+ time: string
12579
+ value: number
12580
+ }
12581
+ sound: {
12582
+ time: string
12583
+ value: number
12584
+ }
12585
+ humidity: {
12586
+ time: string
12587
+ value: number
12588
+ }
12589
+ pressure: {
12590
+ time: string
12591
+ value: number
12592
+ }
12593
+ accelerometer_z: {
12594
+ time: string
12595
+ value: number
12596
+ }
12597
+ }
12598
+ }
12599
+ | undefined
12600
+ four_suites_metadata?:
12601
+ | {
12602
+ device_id: number
12603
+ device_name: string
12604
+ reclose_delay_in_seconds: number
12605
+ }
12606
+ | undefined
12607
+ two_n_metadata?:
12608
+ | {
12609
+ device_id: number
12610
+ device_name: string
12611
+ }
12612
+ | undefined
12613
+ controlbyweb_metadata?:
12614
+ | {
12615
+ device_id: string
12616
+ device_name: string
12617
+ relay_name: string | null
12618
+ }
12619
+ | undefined
12620
+ ttlock_metadata?:
12621
+ | {
12622
+ lock_id: number
12623
+ lock_alias: string
12624
+ feature_value: string
12625
+ }
12626
+ | undefined
12627
+ seam_bridge_metadata?:
12628
+ | {
12629
+ unlock_method?: ('bridge' | 'doorking') | undefined
12630
+ device_num: number
12631
+ name: string
12632
+ }
12633
+ | undefined
12634
+ igloohome_metadata?:
12635
+ | {
12636
+ device_id: string
12637
+ device_name: string
12638
+ bridge_id?: string | undefined
12639
+ bridge_name?: string | undefined
12640
+ keypad_id?: string | undefined
12641
+ }
12642
+ | undefined
12643
+ nest_metadata?:
12644
+ | {
12645
+ nest_device_id: string
12646
+ device_name: string
12647
+ custom_name: string
12648
+ }
12649
+ | undefined
12650
+ ecobee_metadata?:
12651
+ | {
12652
+ ecobee_device_id: string
12653
+ device_name: string
12654
+ }
12655
+ | undefined
12656
+ honeywell_resideo_metadata?:
12657
+ | {
12658
+ honeywell_resideo_device_id: string
12659
+ device_name: string
12660
+ }
12661
+ | undefined
12662
+ hubitat_metadata?:
12663
+ | {
12664
+ device_id: string
12665
+ device_name: string
12666
+ device_label: string
12667
+ }
12668
+ | undefined
12669
+ dormakaba_oracode_metadata?:
12670
+ | {
12671
+ door_id: number
12672
+ door_name: string
12673
+ device_id?: number | undefined
12674
+ door_is_wireless: boolean
12675
+ site_id: number
12676
+ site_name: string
12677
+ iana_timezone?: string | undefined
12678
+ predefined_time_slots?:
12679
+ | Array<{
12680
+ name: string
12681
+ prefix: number
12682
+ check_in_time: string
12683
+ check_out_time: string
12684
+ is_24_hour: boolean
12685
+ is_biweekly_mode: boolean
12686
+ is_one_shot: boolean
12687
+ is_master: boolean
12688
+ ext_dormakaba_oracode_user_level_prefix: number
12689
+ dormakaba_oracode_user_level_id: string
12690
+ }>
12691
+ | undefined
12692
+ }
12693
+ | undefined
12694
+ wyze_metadata?:
12695
+ | {
12696
+ device_id: string
12697
+ device_name: string
12698
+ product_name: string
12699
+ product_type: string
12700
+ product_model: string
12701
+ device_info_model: string
12702
+ keypad_uuid?: string | undefined
12703
+ locker_status_hardlock?: number | undefined
12704
+ }
12705
+ | undefined
12706
+ tedee_metadata?:
12707
+ | {
12708
+ device_id: number
12709
+ serial_number: string
12710
+ device_name: string
12711
+ device_model: string
12712
+ bridge_id: number
12713
+ bridge_name: string
12714
+ keypad_id?: number | undefined
12715
+ }
12716
+ | undefined
12717
+ }) &
12718
+ ({
12719
+ _experimental_supported_code_from_access_codes_lengths?:
12720
+ | (number[] | undefined)
12721
+ | undefined
12722
+ code_constraints?:
12723
+ | (
12724
+ | Array<
12725
+ | {
12726
+ constraint_type:
12727
+ | 'no_zeros'
12728
+ | 'cannot_start_with_12'
12729
+ | 'no_triple_consecutive_ints'
12730
+ | 'cannot_specify_pin_code'
12731
+ | 'pin_code_matches_existing_set'
12732
+ | 'start_date_in_future'
12733
+ | 'no_ascending_or_descending_sequence'
12734
+ | 'at_least_three_unique_digits'
12735
+ | 'cannot_contain_089'
12736
+ }
12737
+ | {
12738
+ constraint_type: 'name_length' | 'name_must_be_unique'
12739
+ min_length?: number | undefined
12740
+ max_length?: number | undefined
12741
+ }
12742
+ >
12743
+ | undefined
12744
+ )
12745
+ | undefined
12746
+ supported_code_lengths?: (number[] | undefined) | undefined
12747
+ max_active_codes_supported?: (number | undefined) | undefined
12748
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
12749
+ has_native_entry_events?: (boolean | undefined) | undefined
12750
+ locked?: (boolean | undefined) | undefined
12751
+ keypad_battery?:
12752
+ | (
12753
+ | {
12754
+ level: number
12755
+ }
12756
+ | undefined
12757
+ )
12758
+ | undefined
12759
+ door_open?: (boolean | undefined) | undefined
12760
+ } & (
12761
+ | {
12762
+ temperature_fahrenheit?: number | undefined
12763
+ temperature_celsius?: number | undefined
12764
+ relative_humidity?: number | undefined
12765
+ can_enable_automatic_heating?: boolean | undefined
12766
+ can_enable_automatic_cooling?: boolean | undefined
12767
+ available_hvac_mode_settings?:
12768
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12769
+ | undefined
12770
+ is_heating_available?: true | undefined
12771
+ is_cooling_available?: true | undefined
12772
+ is_heating?: boolean | undefined
12773
+ is_cooling?: boolean | undefined
12774
+ is_fan_running?: boolean | undefined
12775
+ fan_mode_setting?: ('auto' | 'on') | undefined
12776
+ is_temporary_manual_override_active?: boolean | undefined
12777
+ current_climate_setting?:
12778
+ | {
12779
+ automatic_heating_enabled: boolean
12780
+ automatic_cooling_enabled: boolean
12781
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12782
+ cooling_set_point_celsius?: number | undefined
12783
+ heating_set_point_celsius?: number | undefined
12784
+ cooling_set_point_fahrenheit?: number | undefined
12785
+ heating_set_point_fahrenheit?: number | undefined
12786
+ manual_override_allowed: boolean
12787
+ }
12788
+ | undefined
12789
+ default_climate_setting?:
12790
+ | (
12791
+ | {
12792
+ automatic_heating_enabled: boolean
12793
+ automatic_cooling_enabled: boolean
12794
+ hvac_mode_setting:
12795
+ | 'off'
12796
+ | 'heat'
12797
+ | 'cool'
12798
+ | 'heat_cool'
12799
+ cooling_set_point_celsius?: number | undefined
12800
+ heating_set_point_celsius?: number | undefined
12801
+ cooling_set_point_fahrenheit?: number | undefined
12802
+ heating_set_point_fahrenheit?: number | undefined
12803
+ manual_override_allowed: boolean
12804
+ }
12805
+ | undefined
12806
+ )
12807
+ | undefined
12808
+ is_climate_setting_schedule_active?: boolean | undefined
12809
+ active_climate_setting_schedule?:
12810
+ | (
12811
+ | {
12812
+ climate_setting_schedule_id: string
12813
+ schedule_type: 'time_bound'
12814
+ device_id: string
12815
+ name?: string | undefined
12816
+ schedule_starts_at: string
12817
+ schedule_ends_at: string
12818
+ created_at: string
12819
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12820
+ errors?: any
12821
+ automatic_heating_enabled?: boolean | undefined
12822
+ automatic_cooling_enabled?: boolean | undefined
12823
+ hvac_mode_setting?:
12824
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12825
+ | undefined
12826
+ cooling_set_point_celsius?:
12827
+ | (number | undefined)
12828
+ | undefined
12829
+ heating_set_point_celsius?:
12830
+ | (number | undefined)
12831
+ | undefined
12832
+ cooling_set_point_fahrenheit?:
12833
+ | (number | undefined)
12834
+ | undefined
12835
+ heating_set_point_fahrenheit?:
12836
+ | (number | undefined)
12837
+ | undefined
12838
+ manual_override_allowed?: boolean | undefined
12839
+ }
12840
+ | undefined
12841
+ )
12842
+ | undefined
12843
+ min_cooling_set_point_celsius?: number | undefined
12844
+ min_cooling_set_point_fahrenheit?: number | undefined
12845
+ max_cooling_set_point_celsius?: number | undefined
12846
+ max_cooling_set_point_fahrenheit?: number | undefined
12847
+ min_heating_set_point_celsius?: number | undefined
12848
+ min_heating_set_point_fahrenheit?: number | undefined
12849
+ max_heating_set_point_celsius?: number | undefined
12850
+ max_heating_set_point_fahrenheit?: number | undefined
12851
+ min_heating_cooling_delta_celsius?: number | undefined
12852
+ min_heating_cooling_delta_fahrenheit?: number | undefined
12853
+ }
12854
+ | {
12855
+ temperature_fahrenheit?: number | undefined
12856
+ temperature_celsius?: number | undefined
12857
+ relative_humidity?: number | undefined
12858
+ can_enable_automatic_heating?: boolean | undefined
12859
+ can_enable_automatic_cooling?: boolean | undefined
12860
+ available_hvac_mode_settings?:
12861
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12862
+ | undefined
12863
+ is_heating_available?: true | undefined
12864
+ is_cooling_available?: false | undefined
12865
+ is_heating?: boolean | undefined
12866
+ is_cooling?: boolean | undefined
12867
+ is_fan_running?: boolean | undefined
12868
+ fan_mode_setting?: ('auto' | 'on') | undefined
12869
+ is_temporary_manual_override_active?: boolean | undefined
12870
+ current_climate_setting?:
12871
+ | {
12872
+ automatic_heating_enabled: boolean
12873
+ automatic_cooling_enabled: boolean
12874
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12875
+ cooling_set_point_celsius?: number | undefined
12876
+ heating_set_point_celsius?: number | undefined
12877
+ cooling_set_point_fahrenheit?: number | undefined
12878
+ heating_set_point_fahrenheit?: number | undefined
12879
+ manual_override_allowed: boolean
12880
+ }
12881
+ | undefined
12882
+ default_climate_setting?:
12883
+ | (
12884
+ | {
12885
+ automatic_heating_enabled: boolean
12886
+ automatic_cooling_enabled: boolean
12887
+ hvac_mode_setting:
12888
+ | 'off'
12889
+ | 'heat'
12890
+ | 'cool'
12891
+ | 'heat_cool'
12892
+ cooling_set_point_celsius?: number | undefined
12893
+ heating_set_point_celsius?: number | undefined
12894
+ cooling_set_point_fahrenheit?: number | undefined
12895
+ heating_set_point_fahrenheit?: number | undefined
12896
+ manual_override_allowed: boolean
12897
+ }
12898
+ | undefined
12899
+ )
12900
+ | undefined
12901
+ is_climate_setting_schedule_active?: boolean | undefined
12902
+ active_climate_setting_schedule?:
12903
+ | (
12904
+ | {
12905
+ climate_setting_schedule_id: string
12906
+ schedule_type: 'time_bound'
12907
+ device_id: string
12908
+ name?: string | undefined
12909
+ schedule_starts_at: string
12910
+ schedule_ends_at: string
12911
+ created_at: string
12912
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12913
+ errors?: any
12914
+ automatic_heating_enabled?: boolean | undefined
12915
+ automatic_cooling_enabled?: boolean | undefined
12916
+ hvac_mode_setting?:
12917
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12918
+ | undefined
12919
+ cooling_set_point_celsius?:
12920
+ | (number | undefined)
12921
+ | undefined
12922
+ heating_set_point_celsius?:
12923
+ | (number | undefined)
12924
+ | undefined
12925
+ cooling_set_point_fahrenheit?:
12926
+ | (number | undefined)
12927
+ | undefined
12928
+ heating_set_point_fahrenheit?:
12929
+ | (number | undefined)
12930
+ | undefined
12931
+ manual_override_allowed?: boolean | undefined
12932
+ }
12933
+ | undefined
12934
+ )
12935
+ | undefined
12936
+ min_heating_set_point_celsius?: number | undefined
12937
+ min_heating_set_point_fahrenheit?: number | undefined
12938
+ max_heating_set_point_celsius?: number | undefined
12939
+ max_heating_set_point_fahrenheit?: number | undefined
12940
+ }
12941
+ | {
12942
+ temperature_fahrenheit?: number | undefined
12943
+ temperature_celsius?: number | undefined
12944
+ relative_humidity?: number | undefined
12945
+ can_enable_automatic_heating?: boolean | undefined
12946
+ can_enable_automatic_cooling?: boolean | undefined
12947
+ available_hvac_mode_settings?:
12948
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12949
+ | undefined
12950
+ is_heating_available?: false | undefined
12951
+ is_cooling_available?: true | undefined
12952
+ is_heating?: boolean | undefined
12953
+ is_cooling?: boolean | undefined
12954
+ is_fan_running?: boolean | undefined
12955
+ fan_mode_setting?: ('auto' | 'on') | undefined
12956
+ is_temporary_manual_override_active?: boolean | undefined
12957
+ current_climate_setting?:
12958
+ | {
12959
+ automatic_heating_enabled: boolean
12960
+ automatic_cooling_enabled: boolean
12961
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12962
+ cooling_set_point_celsius?: number | undefined
12963
+ heating_set_point_celsius?: number | undefined
12964
+ cooling_set_point_fahrenheit?: number | undefined
12965
+ heating_set_point_fahrenheit?: number | undefined
12966
+ manual_override_allowed: boolean
12967
+ }
12968
+ | undefined
12969
+ default_climate_setting?:
12970
+ | (
12971
+ | {
12972
+ automatic_heating_enabled: boolean
12973
+ automatic_cooling_enabled: boolean
12974
+ hvac_mode_setting:
12975
+ | 'off'
12976
+ | 'heat'
12977
+ | 'cool'
12978
+ | 'heat_cool'
12979
+ cooling_set_point_celsius?: number | undefined
12980
+ heating_set_point_celsius?: number | undefined
12981
+ cooling_set_point_fahrenheit?: number | undefined
12982
+ heating_set_point_fahrenheit?: number | undefined
12983
+ manual_override_allowed: boolean
12984
+ }
12985
+ | undefined
12986
+ )
12987
+ | undefined
12988
+ is_climate_setting_schedule_active?: boolean | undefined
12989
+ active_climate_setting_schedule?:
12990
+ | (
12991
+ | {
12992
+ climate_setting_schedule_id: string
12993
+ schedule_type: 'time_bound'
12994
+ device_id: string
12995
+ name?: string | undefined
12996
+ schedule_starts_at: string
12997
+ schedule_ends_at: string
12998
+ created_at: string
12999
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
13000
+ errors?: any
13001
+ automatic_heating_enabled?: boolean | undefined
13002
+ automatic_cooling_enabled?: boolean | undefined
13003
+ hvac_mode_setting?:
13004
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
13005
+ | undefined
13006
+ cooling_set_point_celsius?:
13007
+ | (number | undefined)
13008
+ | undefined
13009
+ heating_set_point_celsius?:
13010
+ | (number | undefined)
13011
+ | undefined
13012
+ cooling_set_point_fahrenheit?:
13013
+ | (number | undefined)
13014
+ | undefined
13015
+ heating_set_point_fahrenheit?:
13016
+ | (number | undefined)
13017
+ | undefined
13018
+ manual_override_allowed?: boolean | undefined
13019
+ }
13020
+ | undefined
13021
+ )
13022
+ | undefined
13023
+ min_cooling_set_point_celsius?: number | undefined
13024
+ min_cooling_set_point_fahrenheit?: number | undefined
13025
+ max_cooling_set_point_celsius?: number | undefined
13026
+ max_cooling_set_point_fahrenheit?: number | undefined
13027
+ }
13028
+ ))
13029
+ /** Location information for the device. */
13030
+ location: {
13031
+ /** Name of the device location. */
13032
+ location_name?: string | undefined
13033
+ /** Time zone of the device location. */
13034
+ timezone?: string | undefined
13035
+ } | null
13036
+ /** Unique identifier for the account associated with the device. */
13037
+ connected_account_id: string
13038
+ /** Unique identifier for the Seam workspace associated with the device. */
13039
+ workspace_id: string
13040
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
13041
+ errors: Array<{
13042
+ error_code: string
13043
+ message: string
13044
+ }>
13045
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
13046
+ warnings: Array<{
13047
+ warning_code: string
13048
+ message: string
13049
+ }>
13050
+ /** Date and time at which the device object was created. */
13051
+ created_at: string
13052
+ /** Indicates whether Seam manages the device. */
13053
+ is_managed: true
13054
+ custom_metadata: Record<string, string | boolean>
13055
+ can_remotely_unlock?: boolean | undefined
13056
+ can_remotely_lock?: boolean | undefined
13057
+ can_program_offline_access_codes?: boolean | undefined
13058
+ can_program_online_access_codes?: boolean | undefined
13059
+ can_simulate_removal?: boolean | undefined
13060
+ can_simulate_connection?: boolean | undefined
13061
+ can_simulate_disconnection?: boolean | undefined
13062
+ }>
13063
+ }
13064
+ }
11447
13065
  '/noise_sensors/noise_thresholds/create': {
11448
13066
  route: '/noise_sensors/noise_thresholds/create'
11449
13067
  method: 'POST'