@seamapi/types 1.208.0 → 1.209.1

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,1642 @@ 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
+ | 'cannot_contain_0789'
12007
+ }
12008
+ | {
12009
+ constraint_type: 'name_length' | 'name_must_be_unique'
12010
+ min_length?: number | undefined
12011
+ max_length?: number | undefined
12012
+ }
12013
+ >
12014
+ | undefined
12015
+ )
12016
+ | undefined
12017
+ supported_code_lengths?: (number[] | undefined) | undefined
12018
+ max_active_codes_supported?: (number | undefined) | undefined
12019
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
12020
+ has_native_entry_events?: (boolean | undefined) | undefined
12021
+ locked?: (boolean | undefined) | undefined
12022
+ keypad_battery?:
12023
+ | (
12024
+ | {
12025
+ level: number
12026
+ }
12027
+ | undefined
12028
+ )
12029
+ | undefined
12030
+ door_open?: (boolean | undefined) | undefined
12031
+ } & (
12032
+ | {
12033
+ temperature_fahrenheit?: number | undefined
12034
+ temperature_celsius?: number | undefined
12035
+ relative_humidity?: number | undefined
12036
+ can_enable_automatic_heating?: boolean | undefined
12037
+ can_enable_automatic_cooling?: boolean | undefined
12038
+ available_hvac_mode_settings?:
12039
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12040
+ | undefined
12041
+ is_heating_available?: true | undefined
12042
+ is_cooling_available?: true | undefined
12043
+ is_heating?: boolean | undefined
12044
+ is_cooling?: boolean | undefined
12045
+ is_fan_running?: boolean | undefined
12046
+ fan_mode_setting?: ('auto' | 'on') | undefined
12047
+ is_temporary_manual_override_active?: boolean | undefined
12048
+ current_climate_setting?:
12049
+ | {
12050
+ automatic_heating_enabled: boolean
12051
+ automatic_cooling_enabled: boolean
12052
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12053
+ cooling_set_point_celsius?: number | undefined
12054
+ heating_set_point_celsius?: number | undefined
12055
+ cooling_set_point_fahrenheit?: number | undefined
12056
+ heating_set_point_fahrenheit?: number | undefined
12057
+ manual_override_allowed: boolean
12058
+ }
12059
+ | undefined
12060
+ default_climate_setting?:
12061
+ | (
12062
+ | {
12063
+ automatic_heating_enabled: boolean
12064
+ automatic_cooling_enabled: boolean
12065
+ hvac_mode_setting:
12066
+ | 'off'
12067
+ | 'heat'
12068
+ | 'cool'
12069
+ | 'heat_cool'
12070
+ cooling_set_point_celsius?: number | undefined
12071
+ heating_set_point_celsius?: number | undefined
12072
+ cooling_set_point_fahrenheit?: number | undefined
12073
+ heating_set_point_fahrenheit?: number | undefined
12074
+ manual_override_allowed: boolean
12075
+ }
12076
+ | undefined
12077
+ )
12078
+ | undefined
12079
+ is_climate_setting_schedule_active?: boolean | undefined
12080
+ active_climate_setting_schedule?:
12081
+ | (
12082
+ | {
12083
+ climate_setting_schedule_id: string
12084
+ schedule_type: 'time_bound'
12085
+ device_id: string
12086
+ name?: string | undefined
12087
+ schedule_starts_at: string
12088
+ schedule_ends_at: string
12089
+ created_at: string
12090
+ /** 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. */
12091
+ errors?: any
12092
+ automatic_heating_enabled?: boolean | undefined
12093
+ automatic_cooling_enabled?: boolean | undefined
12094
+ hvac_mode_setting?:
12095
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12096
+ | undefined
12097
+ cooling_set_point_celsius?:
12098
+ | (number | undefined)
12099
+ | undefined
12100
+ heating_set_point_celsius?:
12101
+ | (number | undefined)
12102
+ | undefined
12103
+ cooling_set_point_fahrenheit?:
12104
+ | (number | undefined)
12105
+ | undefined
12106
+ heating_set_point_fahrenheit?:
12107
+ | (number | undefined)
12108
+ | undefined
12109
+ manual_override_allowed?: boolean | undefined
12110
+ }
12111
+ | undefined
12112
+ )
12113
+ | undefined
12114
+ min_cooling_set_point_celsius?: number | undefined
12115
+ min_cooling_set_point_fahrenheit?: number | undefined
12116
+ max_cooling_set_point_celsius?: number | undefined
12117
+ max_cooling_set_point_fahrenheit?: number | undefined
12118
+ min_heating_set_point_celsius?: number | undefined
12119
+ min_heating_set_point_fahrenheit?: number | undefined
12120
+ max_heating_set_point_celsius?: number | undefined
12121
+ max_heating_set_point_fahrenheit?: number | undefined
12122
+ min_heating_cooling_delta_celsius?: number | undefined
12123
+ min_heating_cooling_delta_fahrenheit?: number | undefined
12124
+ }
12125
+ | {
12126
+ temperature_fahrenheit?: number | undefined
12127
+ temperature_celsius?: number | undefined
12128
+ relative_humidity?: number | undefined
12129
+ can_enable_automatic_heating?: boolean | undefined
12130
+ can_enable_automatic_cooling?: boolean | undefined
12131
+ available_hvac_mode_settings?:
12132
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12133
+ | undefined
12134
+ is_heating_available?: true | undefined
12135
+ is_cooling_available?: false | undefined
12136
+ is_heating?: boolean | undefined
12137
+ is_cooling?: boolean | undefined
12138
+ is_fan_running?: boolean | undefined
12139
+ fan_mode_setting?: ('auto' | 'on') | undefined
12140
+ is_temporary_manual_override_active?: boolean | undefined
12141
+ current_climate_setting?:
12142
+ | {
12143
+ automatic_heating_enabled: boolean
12144
+ automatic_cooling_enabled: boolean
12145
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12146
+ cooling_set_point_celsius?: number | undefined
12147
+ heating_set_point_celsius?: number | undefined
12148
+ cooling_set_point_fahrenheit?: number | undefined
12149
+ heating_set_point_fahrenheit?: number | undefined
12150
+ manual_override_allowed: boolean
12151
+ }
12152
+ | undefined
12153
+ default_climate_setting?:
12154
+ | (
12155
+ | {
12156
+ automatic_heating_enabled: boolean
12157
+ automatic_cooling_enabled: boolean
12158
+ hvac_mode_setting:
12159
+ | 'off'
12160
+ | 'heat'
12161
+ | 'cool'
12162
+ | 'heat_cool'
12163
+ cooling_set_point_celsius?: number | undefined
12164
+ heating_set_point_celsius?: number | undefined
12165
+ cooling_set_point_fahrenheit?: number | undefined
12166
+ heating_set_point_fahrenheit?: number | undefined
12167
+ manual_override_allowed: boolean
12168
+ }
12169
+ | undefined
12170
+ )
12171
+ | undefined
12172
+ is_climate_setting_schedule_active?: boolean | undefined
12173
+ active_climate_setting_schedule?:
12174
+ | (
12175
+ | {
12176
+ climate_setting_schedule_id: string
12177
+ schedule_type: 'time_bound'
12178
+ device_id: string
12179
+ name?: string | undefined
12180
+ schedule_starts_at: string
12181
+ schedule_ends_at: string
12182
+ created_at: string
12183
+ /** 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. */
12184
+ errors?: any
12185
+ automatic_heating_enabled?: boolean | undefined
12186
+ automatic_cooling_enabled?: boolean | undefined
12187
+ hvac_mode_setting?:
12188
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12189
+ | undefined
12190
+ cooling_set_point_celsius?:
12191
+ | (number | undefined)
12192
+ | undefined
12193
+ heating_set_point_celsius?:
12194
+ | (number | undefined)
12195
+ | undefined
12196
+ cooling_set_point_fahrenheit?:
12197
+ | (number | undefined)
12198
+ | undefined
12199
+ heating_set_point_fahrenheit?:
12200
+ | (number | undefined)
12201
+ | undefined
12202
+ manual_override_allowed?: boolean | undefined
12203
+ }
12204
+ | undefined
12205
+ )
12206
+ | undefined
12207
+ min_heating_set_point_celsius?: number | undefined
12208
+ min_heating_set_point_fahrenheit?: number | undefined
12209
+ max_heating_set_point_celsius?: number | undefined
12210
+ max_heating_set_point_fahrenheit?: number | undefined
12211
+ }
12212
+ | {
12213
+ temperature_fahrenheit?: number | undefined
12214
+ temperature_celsius?: number | undefined
12215
+ relative_humidity?: number | undefined
12216
+ can_enable_automatic_heating?: boolean | undefined
12217
+ can_enable_automatic_cooling?: boolean | undefined
12218
+ available_hvac_mode_settings?:
12219
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12220
+ | undefined
12221
+ is_heating_available?: false | undefined
12222
+ is_cooling_available?: true | undefined
12223
+ is_heating?: boolean | undefined
12224
+ is_cooling?: boolean | undefined
12225
+ is_fan_running?: boolean | undefined
12226
+ fan_mode_setting?: ('auto' | 'on') | undefined
12227
+ is_temporary_manual_override_active?: boolean | undefined
12228
+ current_climate_setting?:
12229
+ | {
12230
+ automatic_heating_enabled: boolean
12231
+ automatic_cooling_enabled: boolean
12232
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12233
+ cooling_set_point_celsius?: number | undefined
12234
+ heating_set_point_celsius?: number | undefined
12235
+ cooling_set_point_fahrenheit?: number | undefined
12236
+ heating_set_point_fahrenheit?: number | undefined
12237
+ manual_override_allowed: boolean
12238
+ }
12239
+ | undefined
12240
+ default_climate_setting?:
12241
+ | (
12242
+ | {
12243
+ automatic_heating_enabled: boolean
12244
+ automatic_cooling_enabled: boolean
12245
+ hvac_mode_setting:
12246
+ | 'off'
12247
+ | 'heat'
12248
+ | 'cool'
12249
+ | 'heat_cool'
12250
+ cooling_set_point_celsius?: number | undefined
12251
+ heating_set_point_celsius?: number | undefined
12252
+ cooling_set_point_fahrenheit?: number | undefined
12253
+ heating_set_point_fahrenheit?: number | undefined
12254
+ manual_override_allowed: boolean
12255
+ }
12256
+ | undefined
12257
+ )
12258
+ | undefined
12259
+ is_climate_setting_schedule_active?: boolean | undefined
12260
+ active_climate_setting_schedule?:
12261
+ | (
12262
+ | {
12263
+ climate_setting_schedule_id: string
12264
+ schedule_type: 'time_bound'
12265
+ device_id: string
12266
+ name?: string | undefined
12267
+ schedule_starts_at: string
12268
+ schedule_ends_at: string
12269
+ created_at: string
12270
+ /** 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. */
12271
+ errors?: any
12272
+ automatic_heating_enabled?: boolean | undefined
12273
+ automatic_cooling_enabled?: boolean | undefined
12274
+ hvac_mode_setting?:
12275
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12276
+ | undefined
12277
+ cooling_set_point_celsius?:
12278
+ | (number | undefined)
12279
+ | undefined
12280
+ heating_set_point_celsius?:
12281
+ | (number | undefined)
12282
+ | undefined
12283
+ cooling_set_point_fahrenheit?:
12284
+ | (number | undefined)
12285
+ | undefined
12286
+ heating_set_point_fahrenheit?:
12287
+ | (number | undefined)
12288
+ | undefined
12289
+ manual_override_allowed?: boolean | undefined
12290
+ }
12291
+ | undefined
12292
+ )
12293
+ | undefined
12294
+ min_cooling_set_point_celsius?: number | undefined
12295
+ min_cooling_set_point_fahrenheit?: number | undefined
12296
+ max_cooling_set_point_celsius?: number | undefined
12297
+ max_cooling_set_point_fahrenheit?: number | undefined
12298
+ }
12299
+ ))
12300
+ /** Location information for the device. */
12301
+ location: {
12302
+ /** Name of the device location. */
12303
+ location_name?: string | undefined
12304
+ /** Time zone of the device location. */
12305
+ timezone?: string | undefined
12306
+ } | null
12307
+ /** Unique identifier for the account associated with the device. */
12308
+ connected_account_id: string
12309
+ /** Unique identifier for the Seam workspace associated with the device. */
12310
+ workspace_id: string
12311
+ /** 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. */
12312
+ errors: Array<
12313
+ | {
12314
+ message: string
12315
+ is_device_error: true
12316
+ error_code: string
12317
+ }
12318
+ | {
12319
+ message: string
12320
+ is_connected_account_error: true
12321
+ error_code: string
12322
+ }
12323
+ >
12324
+ /** 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. */
12325
+ warnings: Array<{
12326
+ message: string
12327
+ warning_code: string
12328
+ }>
12329
+ /** Date and time at which the device object was created. */
12330
+ created_at: string
12331
+ /** Indicates whether Seam manages the device. */
12332
+ is_managed: true
12333
+ custom_metadata: Record<string, string | boolean>
12334
+ can_remotely_unlock?: boolean | undefined
12335
+ can_remotely_lock?: boolean | undefined
12336
+ can_program_offline_access_codes?: boolean | undefined
12337
+ can_program_online_access_codes?: boolean | undefined
12338
+ can_simulate_removal?: boolean | undefined
12339
+ can_simulate_connection?: boolean | undefined
12340
+ can_simulate_disconnection?: boolean | undefined
12341
+ }>
12342
+ devices: Array<{
12343
+ /** Unique identifier for the device. */
12344
+ device_id: string
12345
+ /** Type of the device. */
12346
+ device_type:
12347
+ | (
12348
+ | 'akuvox_lock'
12349
+ | 'august_lock'
12350
+ | 'brivo_access_point'
12351
+ | 'butterflymx_panel'
12352
+ | 'avigilon_alta_entry'
12353
+ | 'doorking_lock'
12354
+ | 'genie_door'
12355
+ | 'igloo_lock'
12356
+ | 'linear_lock'
12357
+ | 'lockly_lock'
12358
+ | 'kwikset_lock'
12359
+ | 'nuki_lock'
12360
+ | 'salto_lock'
12361
+ | 'schlage_lock'
12362
+ | 'seam_relay'
12363
+ | 'smartthings_lock'
12364
+ | 'wyze_lock'
12365
+ | 'yale_lock'
12366
+ | 'two_n_intercom'
12367
+ | 'controlbyweb_device'
12368
+ | 'ttlock_lock'
12369
+ | 'igloohome_lock'
12370
+ | 'hubitat_lock'
12371
+ | 'four_suites_door'
12372
+ | 'dormakaba_oracode_door'
12373
+ | 'tedee_lock'
12374
+ )
12375
+ | ('noiseaware_activity_zone' | 'minut_sensor')
12376
+ | (
12377
+ | 'ecobee_thermostat'
12378
+ | 'nest_thermostat'
12379
+ | 'honeywell_resideo_thermostat'
12380
+ )
12381
+ | ('ios_phone' | 'android_phone')
12382
+ /** Optional nickname to describe the device, settable through Seam */
12383
+ nickname?: string | undefined
12384
+ /** 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. */
12385
+ display_name: string
12386
+ /** 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. */
12387
+ capabilities_supported: Array<
12388
+ | 'access_code'
12389
+ | 'lock'
12390
+ | 'noise_detection'
12391
+ | 'thermostat'
12392
+ | 'battery'
12393
+ | 'phone'
12394
+ >
12395
+ /** Properties of the device. */
12396
+ properties: (({
12397
+ /** Indicates whether the device is online. */
12398
+ online: boolean
12399
+ /** Name of the device.
12400
+ * @deprecated use device.display_name instead */
12401
+ name: string
12402
+ /** Represents the accessory keypad state. */
12403
+ accessory_keypad?:
12404
+ | {
12405
+ /** Indicates if the accessory_keypad is connected to the device. */
12406
+ is_connected: boolean
12407
+ /** Indicates if the keypad battery properties. */
12408
+ battery?:
12409
+ | {
12410
+ level: number
12411
+ }
12412
+ | undefined
12413
+ }
12414
+ | undefined
12415
+ appearance: {
12416
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
12417
+ name: string
12418
+ }
12419
+ model: {
12420
+ /** Indicates whether the device can connect a accessory keypad. */
12421
+ can_connect_accessory_keypad?: boolean | undefined
12422
+ /** Display name of the device model. */
12423
+ display_name: string
12424
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
12425
+ manufacturer_display_name: string
12426
+ /** Indicates whether the device has a built in accessory keypad. */
12427
+ has_built_in_keypad?: boolean | undefined
12428
+ /** Indicates whether the device supports offline access codes. */
12429
+ offline_access_codes_supported?: boolean | undefined
12430
+ /** Indicates whether the device supports online access codes. */
12431
+ online_access_codes_supported?: boolean | undefined
12432
+ /**
12433
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
12434
+ accessory_keypad_supported?: boolean | undefined
12435
+ }
12436
+ /** Indicates whether the device has direct power. */
12437
+ has_direct_power?: boolean | undefined
12438
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
12439
+ battery_level?: number | undefined
12440
+ /** 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. */
12441
+ battery?:
12442
+ | {
12443
+ level: number
12444
+ status: 'critical' | 'low' | 'good' | 'full'
12445
+ }
12446
+ | undefined
12447
+ /** Manufacturer of the device. */
12448
+ manufacturer?: string | undefined
12449
+ /** Image URL for the device. */
12450
+ image_url?: string | undefined
12451
+ /** Alt text for the device image. */
12452
+ image_alt_text?: string | undefined
12453
+ /** Serial number of the device. */
12454
+ serial_number?: string | undefined
12455
+ /** Indicates whether it is currently possible to use online access codes for the device. */
12456
+ online_access_codes_enabled?: boolean | undefined
12457
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
12458
+ offline_access_codes_enabled?: boolean | undefined
12459
+ /**
12460
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
12461
+ supports_accessory_keypad?: boolean | undefined
12462
+ /**
12463
+ * @deprecated use offline_access_codes_enabled */
12464
+ supports_offline_access_codes?: boolean | undefined
12465
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
12466
+ noise_level_decibels?: number | undefined
12467
+ /** Array of noise threshold IDs that are currently triggering. */
12468
+ currently_triggering_noise_threshold_ids?: string[] | undefined
12469
+ } & {
12470
+ assa_abloy_credential_service_metadata?:
12471
+ | (
12472
+ | {
12473
+ has_active_endpoint: boolean
12474
+ endpoints: Array<{
12475
+ endpoint_id: string
12476
+ is_active: boolean
12477
+ }>
12478
+ }
12479
+ | undefined
12480
+ )
12481
+ | undefined
12482
+ }) & {
12483
+ august_metadata?:
12484
+ | {
12485
+ lock_id: string
12486
+ lock_name: string
12487
+ house_name: string
12488
+ has_keypad: boolean
12489
+ keypad_battery_level?: string | undefined
12490
+ model?: string | undefined
12491
+ house_id?: string | undefined
12492
+ }
12493
+ | undefined
12494
+ avigilon_alta_metadata?:
12495
+ | {
12496
+ entry_name: string
12497
+ org_name: string
12498
+ zone_id: number
12499
+ zone_name: string
12500
+ site_id: number
12501
+ site_name: string
12502
+ entry_relays_total_count: number
12503
+ }
12504
+ | undefined
12505
+ schlage_metadata?:
12506
+ | {
12507
+ device_id: string
12508
+ device_name: string
12509
+ access_code_length: number | null
12510
+ model?: string | undefined
12511
+ }
12512
+ | undefined
12513
+ smartthings_metadata?:
12514
+ | {
12515
+ device_id: string
12516
+ device_name: string
12517
+ model?: string | undefined
12518
+ location_id?: string | undefined
12519
+ }
12520
+ | undefined
12521
+ lockly_metadata?:
12522
+ | {
12523
+ device_id: string
12524
+ device_name: string
12525
+ model?: string | undefined
12526
+ }
12527
+ | undefined
12528
+ nuki_metadata?:
12529
+ | {
12530
+ device_id: string
12531
+ device_name: string
12532
+ keypad_battery_critical?: boolean | undefined
12533
+ keypad_paired?: boolean | undefined
12534
+ keypad_2_paired?: boolean | undefined
12535
+ }
12536
+ | undefined
12537
+ kwikset_metadata?:
12538
+ | {
12539
+ device_id: string
12540
+ device_name: string
12541
+ model_number: string
12542
+ }
12543
+ | undefined
12544
+ salto_metadata?:
12545
+ | {
12546
+ lock_id: string
12547
+ customer_reference: string
12548
+ lock_type: string
12549
+ battery_level: string
12550
+ locked_state: string
12551
+ model?: string | undefined
12552
+ }
12553
+ | undefined
12554
+ genie_metadata?:
12555
+ | {
12556
+ device_name: string
12557
+ door_name: string
12558
+ }
12559
+ | undefined
12560
+ brivo_metadata?:
12561
+ | {
12562
+ device_name: string
12563
+ }
12564
+ | undefined
12565
+ igloo_metadata?:
12566
+ | {
12567
+ device_id: string
12568
+ bridge_id: string
12569
+ model?: string | undefined
12570
+ }
12571
+ | undefined
12572
+ noiseaware_metadata?:
12573
+ | {
12574
+ device_model: 'indoor' | 'outdoor'
12575
+ noise_level_nrs: number
12576
+ noise_level_decibel: number
12577
+ device_name: string
12578
+ device_id: string
12579
+ }
12580
+ | undefined
12581
+ minut_metadata?:
12582
+ | {
12583
+ device_id: string
12584
+ device_name: string
12585
+ latest_sensor_values: {
12586
+ temperature: {
12587
+ time: string
12588
+ value: number
12589
+ }
12590
+ sound: {
12591
+ time: string
12592
+ value: number
12593
+ }
12594
+ humidity: {
12595
+ time: string
12596
+ value: number
12597
+ }
12598
+ pressure: {
12599
+ time: string
12600
+ value: number
12601
+ }
12602
+ accelerometer_z: {
12603
+ time: string
12604
+ value: number
12605
+ }
12606
+ }
12607
+ }
12608
+ | undefined
12609
+ four_suites_metadata?:
12610
+ | {
12611
+ device_id: number
12612
+ device_name: string
12613
+ reclose_delay_in_seconds: number
12614
+ }
12615
+ | undefined
12616
+ two_n_metadata?:
12617
+ | {
12618
+ device_id: number
12619
+ device_name: string
12620
+ }
12621
+ | undefined
12622
+ controlbyweb_metadata?:
12623
+ | {
12624
+ device_id: string
12625
+ device_name: string
12626
+ relay_name: string | null
12627
+ }
12628
+ | undefined
12629
+ ttlock_metadata?:
12630
+ | {
12631
+ lock_id: number
12632
+ lock_alias: string
12633
+ feature_value: string
12634
+ }
12635
+ | undefined
12636
+ seam_bridge_metadata?:
12637
+ | {
12638
+ unlock_method?: ('bridge' | 'doorking') | undefined
12639
+ device_num: number
12640
+ name: string
12641
+ }
12642
+ | undefined
12643
+ igloohome_metadata?:
12644
+ | {
12645
+ device_id: string
12646
+ device_name: string
12647
+ bridge_id?: string | undefined
12648
+ bridge_name?: string | undefined
12649
+ keypad_id?: string | undefined
12650
+ }
12651
+ | undefined
12652
+ nest_metadata?:
12653
+ | {
12654
+ nest_device_id: string
12655
+ device_name: string
12656
+ custom_name: string
12657
+ }
12658
+ | undefined
12659
+ ecobee_metadata?:
12660
+ | {
12661
+ ecobee_device_id: string
12662
+ device_name: string
12663
+ }
12664
+ | undefined
12665
+ honeywell_resideo_metadata?:
12666
+ | {
12667
+ honeywell_resideo_device_id: string
12668
+ device_name: string
12669
+ }
12670
+ | undefined
12671
+ hubitat_metadata?:
12672
+ | {
12673
+ device_id: string
12674
+ device_name: string
12675
+ device_label: string
12676
+ }
12677
+ | undefined
12678
+ dormakaba_oracode_metadata?:
12679
+ | {
12680
+ door_id: number
12681
+ door_name: string
12682
+ device_id?: number | undefined
12683
+ door_is_wireless: boolean
12684
+ site_id: number
12685
+ site_name: string
12686
+ iana_timezone?: string | undefined
12687
+ predefined_time_slots?:
12688
+ | Array<{
12689
+ name: string
12690
+ prefix: number
12691
+ check_in_time: string
12692
+ check_out_time: string
12693
+ is_24_hour: boolean
12694
+ is_biweekly_mode: boolean
12695
+ is_one_shot: boolean
12696
+ is_master: boolean
12697
+ ext_dormakaba_oracode_user_level_prefix: number
12698
+ dormakaba_oracode_user_level_id: string
12699
+ }>
12700
+ | undefined
12701
+ }
12702
+ | undefined
12703
+ wyze_metadata?:
12704
+ | {
12705
+ device_id: string
12706
+ device_name: string
12707
+ product_name: string
12708
+ product_type: string
12709
+ product_model: string
12710
+ device_info_model: string
12711
+ keypad_uuid?: string | undefined
12712
+ locker_status_hardlock?: number | undefined
12713
+ }
12714
+ | undefined
12715
+ tedee_metadata?:
12716
+ | {
12717
+ device_id: number
12718
+ serial_number: string
12719
+ device_name: string
12720
+ device_model: string
12721
+ bridge_id: number
12722
+ bridge_name: string
12723
+ keypad_id?: number | undefined
12724
+ }
12725
+ | undefined
12726
+ }) &
12727
+ ({
12728
+ _experimental_supported_code_from_access_codes_lengths?:
12729
+ | (number[] | undefined)
12730
+ | undefined
12731
+ code_constraints?:
12732
+ | (
12733
+ | Array<
12734
+ | {
12735
+ constraint_type:
12736
+ | 'no_zeros'
12737
+ | 'cannot_start_with_12'
12738
+ | 'no_triple_consecutive_ints'
12739
+ | 'cannot_specify_pin_code'
12740
+ | 'pin_code_matches_existing_set'
12741
+ | 'start_date_in_future'
12742
+ | 'no_ascending_or_descending_sequence'
12743
+ | 'at_least_three_unique_digits'
12744
+ | 'cannot_contain_089'
12745
+ | 'cannot_contain_0789'
12746
+ }
12747
+ | {
12748
+ constraint_type: 'name_length' | 'name_must_be_unique'
12749
+ min_length?: number | undefined
12750
+ max_length?: number | undefined
12751
+ }
12752
+ >
12753
+ | undefined
12754
+ )
12755
+ | undefined
12756
+ supported_code_lengths?: (number[] | undefined) | undefined
12757
+ max_active_codes_supported?: (number | undefined) | undefined
12758
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
12759
+ has_native_entry_events?: (boolean | undefined) | undefined
12760
+ locked?: (boolean | undefined) | undefined
12761
+ keypad_battery?:
12762
+ | (
12763
+ | {
12764
+ level: number
12765
+ }
12766
+ | undefined
12767
+ )
12768
+ | undefined
12769
+ door_open?: (boolean | undefined) | undefined
12770
+ } & (
12771
+ | {
12772
+ temperature_fahrenheit?: number | undefined
12773
+ temperature_celsius?: number | undefined
12774
+ relative_humidity?: number | undefined
12775
+ can_enable_automatic_heating?: boolean | undefined
12776
+ can_enable_automatic_cooling?: boolean | undefined
12777
+ available_hvac_mode_settings?:
12778
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12779
+ | undefined
12780
+ is_heating_available?: true | undefined
12781
+ is_cooling_available?: true | undefined
12782
+ is_heating?: boolean | undefined
12783
+ is_cooling?: boolean | undefined
12784
+ is_fan_running?: boolean | undefined
12785
+ fan_mode_setting?: ('auto' | 'on') | undefined
12786
+ is_temporary_manual_override_active?: boolean | undefined
12787
+ current_climate_setting?:
12788
+ | {
12789
+ automatic_heating_enabled: boolean
12790
+ automatic_cooling_enabled: boolean
12791
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12792
+ cooling_set_point_celsius?: number | undefined
12793
+ heating_set_point_celsius?: number | undefined
12794
+ cooling_set_point_fahrenheit?: number | undefined
12795
+ heating_set_point_fahrenheit?: number | undefined
12796
+ manual_override_allowed: boolean
12797
+ }
12798
+ | undefined
12799
+ default_climate_setting?:
12800
+ | (
12801
+ | {
12802
+ automatic_heating_enabled: boolean
12803
+ automatic_cooling_enabled: boolean
12804
+ hvac_mode_setting:
12805
+ | 'off'
12806
+ | 'heat'
12807
+ | 'cool'
12808
+ | 'heat_cool'
12809
+ cooling_set_point_celsius?: number | undefined
12810
+ heating_set_point_celsius?: number | undefined
12811
+ cooling_set_point_fahrenheit?: number | undefined
12812
+ heating_set_point_fahrenheit?: number | undefined
12813
+ manual_override_allowed: boolean
12814
+ }
12815
+ | undefined
12816
+ )
12817
+ | undefined
12818
+ is_climate_setting_schedule_active?: boolean | undefined
12819
+ active_climate_setting_schedule?:
12820
+ | (
12821
+ | {
12822
+ climate_setting_schedule_id: string
12823
+ schedule_type: 'time_bound'
12824
+ device_id: string
12825
+ name?: string | undefined
12826
+ schedule_starts_at: string
12827
+ schedule_ends_at: string
12828
+ created_at: string
12829
+ /** 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. */
12830
+ errors?: any
12831
+ automatic_heating_enabled?: boolean | undefined
12832
+ automatic_cooling_enabled?: boolean | undefined
12833
+ hvac_mode_setting?:
12834
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12835
+ | undefined
12836
+ cooling_set_point_celsius?:
12837
+ | (number | undefined)
12838
+ | undefined
12839
+ heating_set_point_celsius?:
12840
+ | (number | undefined)
12841
+ | undefined
12842
+ cooling_set_point_fahrenheit?:
12843
+ | (number | undefined)
12844
+ | undefined
12845
+ heating_set_point_fahrenheit?:
12846
+ | (number | undefined)
12847
+ | undefined
12848
+ manual_override_allowed?: boolean | undefined
12849
+ }
12850
+ | undefined
12851
+ )
12852
+ | undefined
12853
+ min_cooling_set_point_celsius?: number | undefined
12854
+ min_cooling_set_point_fahrenheit?: number | undefined
12855
+ max_cooling_set_point_celsius?: number | undefined
12856
+ max_cooling_set_point_fahrenheit?: number | undefined
12857
+ min_heating_set_point_celsius?: number | undefined
12858
+ min_heating_set_point_fahrenheit?: number | undefined
12859
+ max_heating_set_point_celsius?: number | undefined
12860
+ max_heating_set_point_fahrenheit?: number | undefined
12861
+ min_heating_cooling_delta_celsius?: number | undefined
12862
+ min_heating_cooling_delta_fahrenheit?: number | undefined
12863
+ }
12864
+ | {
12865
+ temperature_fahrenheit?: number | undefined
12866
+ temperature_celsius?: number | undefined
12867
+ relative_humidity?: number | undefined
12868
+ can_enable_automatic_heating?: boolean | undefined
12869
+ can_enable_automatic_cooling?: boolean | undefined
12870
+ available_hvac_mode_settings?:
12871
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12872
+ | undefined
12873
+ is_heating_available?: true | undefined
12874
+ is_cooling_available?: false | undefined
12875
+ is_heating?: boolean | undefined
12876
+ is_cooling?: boolean | undefined
12877
+ is_fan_running?: boolean | undefined
12878
+ fan_mode_setting?: ('auto' | 'on') | undefined
12879
+ is_temporary_manual_override_active?: boolean | undefined
12880
+ current_climate_setting?:
12881
+ | {
12882
+ automatic_heating_enabled: boolean
12883
+ automatic_cooling_enabled: boolean
12884
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12885
+ cooling_set_point_celsius?: number | undefined
12886
+ heating_set_point_celsius?: number | undefined
12887
+ cooling_set_point_fahrenheit?: number | undefined
12888
+ heating_set_point_fahrenheit?: number | undefined
12889
+ manual_override_allowed: boolean
12890
+ }
12891
+ | undefined
12892
+ default_climate_setting?:
12893
+ | (
12894
+ | {
12895
+ automatic_heating_enabled: boolean
12896
+ automatic_cooling_enabled: boolean
12897
+ hvac_mode_setting:
12898
+ | 'off'
12899
+ | 'heat'
12900
+ | 'cool'
12901
+ | 'heat_cool'
12902
+ cooling_set_point_celsius?: number | undefined
12903
+ heating_set_point_celsius?: number | undefined
12904
+ cooling_set_point_fahrenheit?: number | undefined
12905
+ heating_set_point_fahrenheit?: number | undefined
12906
+ manual_override_allowed: boolean
12907
+ }
12908
+ | undefined
12909
+ )
12910
+ | undefined
12911
+ is_climate_setting_schedule_active?: boolean | undefined
12912
+ active_climate_setting_schedule?:
12913
+ | (
12914
+ | {
12915
+ climate_setting_schedule_id: string
12916
+ schedule_type: 'time_bound'
12917
+ device_id: string
12918
+ name?: string | undefined
12919
+ schedule_starts_at: string
12920
+ schedule_ends_at: string
12921
+ created_at: string
12922
+ /** 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. */
12923
+ errors?: any
12924
+ automatic_heating_enabled?: boolean | undefined
12925
+ automatic_cooling_enabled?: boolean | undefined
12926
+ hvac_mode_setting?:
12927
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12928
+ | undefined
12929
+ cooling_set_point_celsius?:
12930
+ | (number | undefined)
12931
+ | undefined
12932
+ heating_set_point_celsius?:
12933
+ | (number | undefined)
12934
+ | undefined
12935
+ cooling_set_point_fahrenheit?:
12936
+ | (number | undefined)
12937
+ | undefined
12938
+ heating_set_point_fahrenheit?:
12939
+ | (number | undefined)
12940
+ | undefined
12941
+ manual_override_allowed?: boolean | undefined
12942
+ }
12943
+ | undefined
12944
+ )
12945
+ | undefined
12946
+ min_heating_set_point_celsius?: number | undefined
12947
+ min_heating_set_point_fahrenheit?: number | undefined
12948
+ max_heating_set_point_celsius?: number | undefined
12949
+ max_heating_set_point_fahrenheit?: number | undefined
12950
+ }
12951
+ | {
12952
+ temperature_fahrenheit?: number | undefined
12953
+ temperature_celsius?: number | undefined
12954
+ relative_humidity?: number | undefined
12955
+ can_enable_automatic_heating?: boolean | undefined
12956
+ can_enable_automatic_cooling?: boolean | undefined
12957
+ available_hvac_mode_settings?:
12958
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
12959
+ | undefined
12960
+ is_heating_available?: false | undefined
12961
+ is_cooling_available?: true | undefined
12962
+ is_heating?: boolean | undefined
12963
+ is_cooling?: boolean | undefined
12964
+ is_fan_running?: boolean | undefined
12965
+ fan_mode_setting?: ('auto' | 'on') | undefined
12966
+ is_temporary_manual_override_active?: boolean | undefined
12967
+ current_climate_setting?:
12968
+ | {
12969
+ automatic_heating_enabled: boolean
12970
+ automatic_cooling_enabled: boolean
12971
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12972
+ cooling_set_point_celsius?: number | undefined
12973
+ heating_set_point_celsius?: number | undefined
12974
+ cooling_set_point_fahrenheit?: number | undefined
12975
+ heating_set_point_fahrenheit?: number | undefined
12976
+ manual_override_allowed: boolean
12977
+ }
12978
+ | undefined
12979
+ default_climate_setting?:
12980
+ | (
12981
+ | {
12982
+ automatic_heating_enabled: boolean
12983
+ automatic_cooling_enabled: boolean
12984
+ hvac_mode_setting:
12985
+ | 'off'
12986
+ | 'heat'
12987
+ | 'cool'
12988
+ | 'heat_cool'
12989
+ cooling_set_point_celsius?: number | undefined
12990
+ heating_set_point_celsius?: number | undefined
12991
+ cooling_set_point_fahrenheit?: number | undefined
12992
+ heating_set_point_fahrenheit?: number | undefined
12993
+ manual_override_allowed: boolean
12994
+ }
12995
+ | undefined
12996
+ )
12997
+ | undefined
12998
+ is_climate_setting_schedule_active?: boolean | undefined
12999
+ active_climate_setting_schedule?:
13000
+ | (
13001
+ | {
13002
+ climate_setting_schedule_id: string
13003
+ schedule_type: 'time_bound'
13004
+ device_id: string
13005
+ name?: string | undefined
13006
+ schedule_starts_at: string
13007
+ schedule_ends_at: string
13008
+ created_at: string
13009
+ /** 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. */
13010
+ errors?: any
13011
+ automatic_heating_enabled?: boolean | undefined
13012
+ automatic_cooling_enabled?: boolean | undefined
13013
+ hvac_mode_setting?:
13014
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
13015
+ | undefined
13016
+ cooling_set_point_celsius?:
13017
+ | (number | undefined)
13018
+ | undefined
13019
+ heating_set_point_celsius?:
13020
+ | (number | undefined)
13021
+ | undefined
13022
+ cooling_set_point_fahrenheit?:
13023
+ | (number | undefined)
13024
+ | undefined
13025
+ heating_set_point_fahrenheit?:
13026
+ | (number | undefined)
13027
+ | undefined
13028
+ manual_override_allowed?: boolean | undefined
13029
+ }
13030
+ | undefined
13031
+ )
13032
+ | undefined
13033
+ min_cooling_set_point_celsius?: number | undefined
13034
+ min_cooling_set_point_fahrenheit?: number | undefined
13035
+ max_cooling_set_point_celsius?: number | undefined
13036
+ max_cooling_set_point_fahrenheit?: number | undefined
13037
+ }
13038
+ ))
13039
+ /** Location information for the device. */
13040
+ location: {
13041
+ /** Name of the device location. */
13042
+ location_name?: string | undefined
13043
+ /** Time zone of the device location. */
13044
+ timezone?: string | undefined
13045
+ } | null
13046
+ /** Unique identifier for the account associated with the device. */
13047
+ connected_account_id: string
13048
+ /** Unique identifier for the Seam workspace associated with the device. */
13049
+ workspace_id: string
13050
+ /** 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. */
13051
+ errors: Array<
13052
+ | {
13053
+ message: string
13054
+ is_device_error: true
13055
+ error_code: string
13056
+ }
13057
+ | {
13058
+ message: string
13059
+ is_connected_account_error: true
13060
+ error_code: string
13061
+ }
13062
+ >
13063
+ /** 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. */
13064
+ warnings: Array<{
13065
+ message: string
13066
+ warning_code: string
13067
+ }>
13068
+ /** Date and time at which the device object was created. */
13069
+ created_at: string
13070
+ /** Indicates whether Seam manages the device. */
13071
+ is_managed: true
13072
+ custom_metadata: Record<string, string | boolean>
13073
+ can_remotely_unlock?: boolean | undefined
13074
+ can_remotely_lock?: boolean | undefined
13075
+ can_program_offline_access_codes?: boolean | undefined
13076
+ can_program_online_access_codes?: boolean | undefined
13077
+ can_simulate_removal?: boolean | undefined
13078
+ can_simulate_connection?: boolean | undefined
13079
+ can_simulate_disconnection?: boolean | undefined
13080
+ }>
13081
+ }
13082
+ }
11447
13083
  '/noise_sensors/noise_thresholds/create': {
11448
13084
  route: '/noise_sensors/noise_thresholds/create'
11449
13085
  method: 'POST'