@seamapi/types 1.153.0 → 1.153.2

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.
@@ -768,8 +768,8 @@ export interface Routes {
768
768
  }
769
769
  | undefined
770
770
  user_identity_id?: string | undefined
771
- user_identity_email_address?: string | undefined
772
- user_identity_phone_number?: string | undefined
771
+ user_identity_email_address?: (string | null) | undefined
772
+ user_identity_phone_number?: (string | null) | undefined
773
773
  full_name?: string | undefined
774
774
  /**
775
775
  ---
@@ -1512,8 +1512,8 @@ export interface Routes {
1512
1512
  }
1513
1513
  | undefined
1514
1514
  user_identity_id?: string | undefined
1515
- user_identity_email_address?: string | undefined
1516
- user_identity_phone_number?: string | undefined
1515
+ user_identity_email_address?: (string | null) | undefined
1516
+ user_identity_phone_number?: (string | null) | undefined
1517
1517
  full_name?: string | undefined
1518
1518
  /**
1519
1519
  ---
@@ -1572,8 +1572,8 @@ export interface Routes {
1572
1572
  }
1573
1573
  | undefined
1574
1574
  user_identity_id?: string | undefined
1575
- user_identity_email_address?: string | undefined
1576
- user_identity_phone_number?: string | undefined
1575
+ user_identity_email_address?: (string | null) | undefined
1576
+ user_identity_phone_number?: (string | null) | undefined
1577
1577
  full_name?: string | undefined
1578
1578
  /**
1579
1579
  ---
@@ -1624,8 +1624,8 @@ export interface Routes {
1624
1624
  }
1625
1625
  | undefined
1626
1626
  user_identity_id?: string | undefined
1627
- user_identity_email_address?: string | undefined
1628
- user_identity_phone_number?: string | undefined
1627
+ user_identity_email_address?: (string | null) | undefined
1628
+ user_identity_phone_number?: (string | null) | undefined
1629
1629
  full_name?: string | undefined
1630
1630
  /**
1631
1631
  ---
@@ -10441,6 +10441,739 @@ export interface Routes {
10441
10441
  }
10442
10442
  formData: {}
10443
10443
  jsonResponse: {
10444
+ devices: Array<{
10445
+ /** Unique identifier for the device. */
10446
+ device_id: string
10447
+ /** Type of the device. */
10448
+ device_type:
10449
+ | (
10450
+ | 'akuvox_lock'
10451
+ | 'august_lock'
10452
+ | 'brivo_access_point'
10453
+ | 'butterflymx_panel'
10454
+ | 'avigilon_alta_entry'
10455
+ | 'doorking_lock'
10456
+ | 'genie_door'
10457
+ | 'igloo_lock'
10458
+ | 'linear_lock'
10459
+ | 'lockly_lock'
10460
+ | 'kwikset_lock'
10461
+ | 'nuki_lock'
10462
+ | 'salto_lock'
10463
+ | 'schlage_lock'
10464
+ | 'seam_relay'
10465
+ | 'smartthings_lock'
10466
+ | 'wyze_lock'
10467
+ | 'yale_lock'
10468
+ | 'two_n_intercom'
10469
+ | 'controlbyweb_device'
10470
+ | 'ttlock_lock'
10471
+ | 'igloohome_lock'
10472
+ | 'hubitat_lock'
10473
+ | 'four_suites_door'
10474
+ | 'dormakaba_oracode_door'
10475
+ | 'tedee_lock'
10476
+ )
10477
+ | ('noiseaware_activity_zone' | 'minut_sensor')
10478
+ | (
10479
+ | 'ecobee_thermostat'
10480
+ | 'nest_thermostat'
10481
+ | 'honeywell_resideo_thermostat'
10482
+ )
10483
+ | ('ios_phone' | 'android_phone')
10484
+ /** Optional nickname to describe the device, settable through Seam */
10485
+ nickname?: string | undefined
10486
+ /** 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. */
10487
+ display_name: string
10488
+ /** 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. */
10489
+ capabilities_supported: Array<
10490
+ | 'access_code'
10491
+ | 'lock'
10492
+ | 'noise_detection'
10493
+ | 'thermostat'
10494
+ | 'battery'
10495
+ | 'phone'
10496
+ >
10497
+ /** Properties of the device. */
10498
+ properties: (({
10499
+ /** Indicates whether the device is online. */
10500
+ online: boolean
10501
+ /**
10502
+ ---
10503
+ deprecated: use device.display_name instead
10504
+ ---
10505
+ Name of the device.
10506
+ */
10507
+ name: string
10508
+ /** Represents the accessory keypad state. */
10509
+ accessory_keypad?:
10510
+ | {
10511
+ /** Indicates if the accessory_keypad is connected to the device. */
10512
+ is_connected: boolean
10513
+ /** Indicates if the keypad battery properties. */
10514
+ battery?:
10515
+ | {
10516
+ level: number
10517
+ }
10518
+ | undefined
10519
+ }
10520
+ | undefined
10521
+ appearance: {
10522
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
10523
+ name: string
10524
+ }
10525
+ model: {
10526
+ /** Indicates whether the device can connect a accessory keypad. */
10527
+ can_connect_accessory_keypad?: boolean | undefined
10528
+ /** Display name of the device model. */
10529
+ display_name: string
10530
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
10531
+ manufacturer_display_name: string
10532
+ /** Indicates whether the device has a built in accessory keypad. */
10533
+ has_built_in_keypad?: boolean | undefined
10534
+ /** Indicates whether the device supports offline access codes. */
10535
+ offline_access_codes_supported?: boolean | undefined
10536
+ /** Indicates whether the device supports online access codes. */
10537
+ online_access_codes_supported?: boolean | undefined
10538
+ /** Indicates whether the device supports an accessory keypad. */
10539
+ accessory_keypad_supported?: boolean | undefined
10540
+ }
10541
+ /** Indicates whether the device has direct power. */
10542
+ has_direct_power?: boolean | undefined
10543
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
10544
+ battery_level?: number | undefined
10545
+ /** 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. */
10546
+ battery?:
10547
+ | {
10548
+ level: number
10549
+ status: 'critical' | 'low' | 'good' | 'full'
10550
+ }
10551
+ | undefined
10552
+ /** Manufacturer of the device. */
10553
+ manufacturer?: string | undefined
10554
+ /** Image URL for the device. */
10555
+ image_url?: string | undefined
10556
+ /** Alt text for the device image. */
10557
+ image_alt_text?: string | undefined
10558
+ /** Serial number of the device. */
10559
+ serial_number?: string | undefined
10560
+ /** Indicates whether it is currently possible to use online access codes for the device. */
10561
+ online_access_codes_enabled?: boolean | undefined
10562
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
10563
+ offline_access_codes_enabled?: boolean | undefined
10564
+ /**
10565
+ ---
10566
+ deprecated: use model.accessory_keypad_supported
10567
+ ---
10568
+ */
10569
+ supports_accessory_keypad?: boolean | undefined
10570
+ /**
10571
+ ---
10572
+ deprecated: use offline_access_codes_enabled
10573
+ ---
10574
+ */
10575
+ supports_offline_access_codes?: boolean | undefined
10576
+ } & {
10577
+ assa_abloy_credential_service_metadata?:
10578
+ | (
10579
+ | {
10580
+ has_active_endpoint: boolean
10581
+ endpoints: Array<{
10582
+ endpoint_id: string
10583
+ is_active: boolean
10584
+ }>
10585
+ }
10586
+ | undefined
10587
+ )
10588
+ | undefined
10589
+ }) & {
10590
+ august_metadata?:
10591
+ | {
10592
+ lock_id: string
10593
+ lock_name: string
10594
+ house_name: string
10595
+ has_keypad: boolean
10596
+ keypad_battery_level?: string | undefined
10597
+ model?: string | undefined
10598
+ house_id?: string | undefined
10599
+ }
10600
+ | undefined
10601
+ avigilon_alta_metadata?:
10602
+ | {
10603
+ entry_name: string
10604
+ org_name: string
10605
+ zone_id: number
10606
+ zone_name: string
10607
+ site_id: number
10608
+ site_name: string
10609
+ }
10610
+ | undefined
10611
+ schlage_metadata?:
10612
+ | {
10613
+ device_id: string
10614
+ device_name: string
10615
+ access_code_length: number | null
10616
+ model?: string | undefined
10617
+ }
10618
+ | undefined
10619
+ smartthings_metadata?:
10620
+ | {
10621
+ device_id: string
10622
+ device_name: string
10623
+ model?: string | undefined
10624
+ location_id?: string | undefined
10625
+ }
10626
+ | undefined
10627
+ lockly_metadata?:
10628
+ | {
10629
+ device_id: string
10630
+ device_name: string
10631
+ model?: string | undefined
10632
+ }
10633
+ | undefined
10634
+ nuki_metadata?:
10635
+ | {
10636
+ device_id: string
10637
+ device_name: string
10638
+ keypad_battery_critical?: boolean | undefined
10639
+ keypad_paired?: boolean | undefined
10640
+ keypad_2_paired?: boolean | undefined
10641
+ }
10642
+ | undefined
10643
+ kwikset_metadata?:
10644
+ | {
10645
+ device_id: string
10646
+ device_name: string
10647
+ model_number: string
10648
+ }
10649
+ | undefined
10650
+ salto_metadata?:
10651
+ | {
10652
+ lock_id: string
10653
+ customer_reference: string
10654
+ lock_type: string
10655
+ battery_level: string
10656
+ locked_state: string
10657
+ model?: string | undefined
10658
+ }
10659
+ | undefined
10660
+ genie_metadata?:
10661
+ | {
10662
+ device_name: string
10663
+ door_name: string
10664
+ }
10665
+ | undefined
10666
+ brivo_metadata?:
10667
+ | {
10668
+ device_name: string
10669
+ }
10670
+ | undefined
10671
+ igloo_metadata?:
10672
+ | {
10673
+ device_id: string
10674
+ bridge_id: string
10675
+ model?: string | undefined
10676
+ }
10677
+ | undefined
10678
+ noiseaware_metadata?:
10679
+ | {
10680
+ device_model: 'indoor' | 'outdoor'
10681
+ noise_level_nrs: number
10682
+ noise_level_decibel: number
10683
+ device_name: string
10684
+ device_id: string
10685
+ }
10686
+ | undefined
10687
+ minut_metadata?:
10688
+ | {
10689
+ device_id: string
10690
+ device_name: string
10691
+ latest_sensor_values: {
10692
+ temperature: {
10693
+ time: string
10694
+ value: number
10695
+ }
10696
+ sound: {
10697
+ time: string
10698
+ value: number
10699
+ }
10700
+ humidity: {
10701
+ time: string
10702
+ value: number
10703
+ }
10704
+ pressure: {
10705
+ time: string
10706
+ value: number
10707
+ }
10708
+ accelerometer_z: {
10709
+ time: string
10710
+ value: number
10711
+ }
10712
+ }
10713
+ }
10714
+ | undefined
10715
+ four_suites_metadata?:
10716
+ | {
10717
+ device_id: number
10718
+ device_name: string
10719
+ reclose_delay_in_seconds: number
10720
+ }
10721
+ | undefined
10722
+ two_n_metadata?:
10723
+ | {
10724
+ device_id: number
10725
+ device_name: string
10726
+ }
10727
+ | undefined
10728
+ controlbyweb_metadata?:
10729
+ | {
10730
+ device_id: string
10731
+ device_name: string
10732
+ relay_name: string | null
10733
+ }
10734
+ | undefined
10735
+ ttlock_metadata?:
10736
+ | {
10737
+ lock_id: number
10738
+ lock_alias: string
10739
+ }
10740
+ | undefined
10741
+ seam_bridge_metadata?:
10742
+ | {
10743
+ unlock_method?: ('bridge' | 'doorking') | undefined
10744
+ device_num: number
10745
+ name: string
10746
+ }
10747
+ | undefined
10748
+ igloohome_metadata?:
10749
+ | {
10750
+ device_id: string
10751
+ device_name: string
10752
+ bridge_id?: string | undefined
10753
+ bridge_name?: string | undefined
10754
+ keypad_id?: string | undefined
10755
+ }
10756
+ | undefined
10757
+ nest_metadata?:
10758
+ | {
10759
+ nest_device_id: string
10760
+ device_name: string
10761
+ custom_name: string
10762
+ }
10763
+ | undefined
10764
+ ecobee_metadata?:
10765
+ | {
10766
+ ecobee_device_id: string
10767
+ device_name: string
10768
+ }
10769
+ | undefined
10770
+ honeywell_resideo_metadata?:
10771
+ | {
10772
+ honeywell_resideo_device_id: string
10773
+ device_name: string
10774
+ }
10775
+ | undefined
10776
+ hubitat_metadata?:
10777
+ | {
10778
+ device_id: string
10779
+ device_name: string
10780
+ device_label: string
10781
+ }
10782
+ | undefined
10783
+ dormakaba_oracode_metadata?:
10784
+ | {
10785
+ door_id: number
10786
+ door_name: string
10787
+ device_id?: number | undefined
10788
+ site_id: number
10789
+ site_name: string
10790
+ iana_timezone?: string | undefined
10791
+ predefined_time_slots?:
10792
+ | Array<{
10793
+ name: string
10794
+ prefix: number
10795
+ check_in_time: string
10796
+ check_out_time: string
10797
+ is_24_hour: boolean
10798
+ is_biweekly_mode: boolean
10799
+ is_one_shot: boolean
10800
+ is_master: boolean
10801
+ ext_dormakaba_oracode_user_level_prefix: number
10802
+ dormakaba_oracode_user_level_id: string
10803
+ }>
10804
+ | undefined
10805
+ }
10806
+ | undefined
10807
+ wyze_metadata?:
10808
+ | {
10809
+ device_id: string
10810
+ device_name: string
10811
+ product_name: string
10812
+ product_type: string
10813
+ product_model: string
10814
+ device_info_model: string
10815
+ keypad_uuid?: string | undefined
10816
+ locker_status_hardlock?: number | undefined
10817
+ }
10818
+ | undefined
10819
+ tedee_metadata?:
10820
+ | {
10821
+ device_id: number
10822
+ serial_number: string
10823
+ device_name: string
10824
+ device_model: string
10825
+ bridge_id: number
10826
+ bridge_name: string
10827
+ keypad_id?: number | undefined
10828
+ }
10829
+ | undefined
10830
+ }) &
10831
+ ({
10832
+ _experimental_supported_code_from_access_codes_lengths?:
10833
+ | (number[] | undefined)
10834
+ | undefined
10835
+ code_constraints?:
10836
+ | (
10837
+ | Array<
10838
+ | {
10839
+ constraint_type:
10840
+ | 'no_zeros'
10841
+ | 'cannot_start_with_12'
10842
+ | 'no_triple_consecutive_ints'
10843
+ | 'cannot_specify_pin_code'
10844
+ | 'pin_code_matches_existing_set'
10845
+ | 'start_date_in_future'
10846
+ | 'no_ascending_or_descending_sequence'
10847
+ | 'at_least_three_unique_digits'
10848
+ }
10849
+ | {
10850
+ constraint_type: 'name_length'
10851
+ min_length?: number | undefined
10852
+ max_length?: number | undefined
10853
+ }
10854
+ >
10855
+ | undefined
10856
+ )
10857
+ | undefined
10858
+ supported_code_lengths?: (number[] | undefined) | undefined
10859
+ max_active_codes_supported?: (number | undefined) | undefined
10860
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
10861
+ has_native_entry_events?: (boolean | undefined) | undefined
10862
+ locked?: (boolean | undefined) | undefined
10863
+ keypad_battery?:
10864
+ | (
10865
+ | {
10866
+ level: number
10867
+ }
10868
+ | undefined
10869
+ )
10870
+ | undefined
10871
+ door_open?: (boolean | undefined) | undefined
10872
+ } & (
10873
+ | {
10874
+ temperature_fahrenheit?: number | undefined
10875
+ temperature_celsius?: number | undefined
10876
+ relative_humidity?: number | undefined
10877
+ can_enable_automatic_heating?: boolean | undefined
10878
+ can_enable_automatic_cooling?: boolean | undefined
10879
+ available_hvac_mode_settings?:
10880
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
10881
+ | undefined
10882
+ is_heating_available?: true | undefined
10883
+ is_cooling_available?: true | undefined
10884
+ is_heating?: boolean | undefined
10885
+ is_cooling?: boolean | undefined
10886
+ is_fan_running?: boolean | undefined
10887
+ fan_mode_setting?: ('auto' | 'on') | undefined
10888
+ is_temporary_manual_override_active?: boolean | undefined
10889
+ current_climate_setting?:
10890
+ | {
10891
+ automatic_heating_enabled: boolean
10892
+ automatic_cooling_enabled: boolean
10893
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
10894
+ cooling_set_point_celsius?: number | undefined
10895
+ heating_set_point_celsius?: number | undefined
10896
+ cooling_set_point_fahrenheit?: number | undefined
10897
+ heating_set_point_fahrenheit?: number | undefined
10898
+ manual_override_allowed: boolean
10899
+ }
10900
+ | undefined
10901
+ default_climate_setting?:
10902
+ | (
10903
+ | {
10904
+ automatic_heating_enabled: boolean
10905
+ automatic_cooling_enabled: boolean
10906
+ hvac_mode_setting:
10907
+ | 'off'
10908
+ | 'heat'
10909
+ | 'cool'
10910
+ | 'heat_cool'
10911
+ cooling_set_point_celsius?: number | undefined
10912
+ heating_set_point_celsius?: number | undefined
10913
+ cooling_set_point_fahrenheit?: number | undefined
10914
+ heating_set_point_fahrenheit?: number | undefined
10915
+ manual_override_allowed: boolean
10916
+ }
10917
+ | undefined
10918
+ )
10919
+ | undefined
10920
+ is_climate_setting_schedule_active?: boolean | undefined
10921
+ active_climate_setting_schedule?:
10922
+ | (
10923
+ | {
10924
+ climate_setting_schedule_id: string
10925
+ schedule_type: 'time_bound'
10926
+ device_id: string
10927
+ name?: string | undefined
10928
+ schedule_starts_at: string
10929
+ schedule_ends_at: string
10930
+ created_at: string
10931
+ /** 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. */
10932
+ errors?: any
10933
+ automatic_heating_enabled?: boolean | undefined
10934
+ automatic_cooling_enabled?: boolean | undefined
10935
+ hvac_mode_setting?:
10936
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
10937
+ | undefined
10938
+ cooling_set_point_celsius?:
10939
+ | (number | undefined)
10940
+ | undefined
10941
+ heating_set_point_celsius?:
10942
+ | (number | undefined)
10943
+ | undefined
10944
+ cooling_set_point_fahrenheit?:
10945
+ | (number | undefined)
10946
+ | undefined
10947
+ heating_set_point_fahrenheit?:
10948
+ | (number | undefined)
10949
+ | undefined
10950
+ manual_override_allowed?: boolean | undefined
10951
+ }
10952
+ | undefined
10953
+ )
10954
+ | undefined
10955
+ min_cooling_set_point_celsius?: number | undefined
10956
+ min_cooling_set_point_fahrenheit?: number | undefined
10957
+ max_cooling_set_point_celsius?: number | undefined
10958
+ max_cooling_set_point_fahrenheit?: number | undefined
10959
+ min_heating_set_point_celsius?: number | undefined
10960
+ min_heating_set_point_fahrenheit?: number | undefined
10961
+ max_heating_set_point_celsius?: number | undefined
10962
+ max_heating_set_point_fahrenheit?: number | undefined
10963
+ min_heating_cooling_delta_celsius?: number | undefined
10964
+ min_heating_cooling_delta_fahrenheit?: number | undefined
10965
+ }
10966
+ | {
10967
+ temperature_fahrenheit?: number | undefined
10968
+ temperature_celsius?: number | undefined
10969
+ relative_humidity?: number | undefined
10970
+ can_enable_automatic_heating?: boolean | undefined
10971
+ can_enable_automatic_cooling?: boolean | undefined
10972
+ available_hvac_mode_settings?:
10973
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
10974
+ | undefined
10975
+ is_heating_available?: true | undefined
10976
+ is_cooling_available?: false | undefined
10977
+ is_heating?: boolean | undefined
10978
+ is_cooling?: boolean | undefined
10979
+ is_fan_running?: boolean | undefined
10980
+ fan_mode_setting?: ('auto' | 'on') | undefined
10981
+ is_temporary_manual_override_active?: boolean | undefined
10982
+ current_climate_setting?:
10983
+ | {
10984
+ automatic_heating_enabled: boolean
10985
+ automatic_cooling_enabled: boolean
10986
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
10987
+ cooling_set_point_celsius?: number | undefined
10988
+ heating_set_point_celsius?: number | undefined
10989
+ cooling_set_point_fahrenheit?: number | undefined
10990
+ heating_set_point_fahrenheit?: number | undefined
10991
+ manual_override_allowed: boolean
10992
+ }
10993
+ | undefined
10994
+ default_climate_setting?:
10995
+ | (
10996
+ | {
10997
+ automatic_heating_enabled: boolean
10998
+ automatic_cooling_enabled: boolean
10999
+ hvac_mode_setting:
11000
+ | 'off'
11001
+ | 'heat'
11002
+ | 'cool'
11003
+ | 'heat_cool'
11004
+ cooling_set_point_celsius?: number | undefined
11005
+ heating_set_point_celsius?: number | undefined
11006
+ cooling_set_point_fahrenheit?: number | undefined
11007
+ heating_set_point_fahrenheit?: number | undefined
11008
+ manual_override_allowed: boolean
11009
+ }
11010
+ | undefined
11011
+ )
11012
+ | undefined
11013
+ is_climate_setting_schedule_active?: boolean | undefined
11014
+ active_climate_setting_schedule?:
11015
+ | (
11016
+ | {
11017
+ climate_setting_schedule_id: string
11018
+ schedule_type: 'time_bound'
11019
+ device_id: string
11020
+ name?: string | undefined
11021
+ schedule_starts_at: string
11022
+ schedule_ends_at: string
11023
+ created_at: string
11024
+ /** 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. */
11025
+ errors?: any
11026
+ automatic_heating_enabled?: boolean | undefined
11027
+ automatic_cooling_enabled?: boolean | undefined
11028
+ hvac_mode_setting?:
11029
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
11030
+ | undefined
11031
+ cooling_set_point_celsius?:
11032
+ | (number | undefined)
11033
+ | undefined
11034
+ heating_set_point_celsius?:
11035
+ | (number | undefined)
11036
+ | undefined
11037
+ cooling_set_point_fahrenheit?:
11038
+ | (number | undefined)
11039
+ | undefined
11040
+ heating_set_point_fahrenheit?:
11041
+ | (number | undefined)
11042
+ | undefined
11043
+ manual_override_allowed?: boolean | undefined
11044
+ }
11045
+ | undefined
11046
+ )
11047
+ | undefined
11048
+ min_heating_set_point_celsius?: number | undefined
11049
+ min_heating_set_point_fahrenheit?: number | undefined
11050
+ max_heating_set_point_celsius?: number | undefined
11051
+ max_heating_set_point_fahrenheit?: number | undefined
11052
+ }
11053
+ | {
11054
+ temperature_fahrenheit?: number | undefined
11055
+ temperature_celsius?: number | undefined
11056
+ relative_humidity?: number | undefined
11057
+ can_enable_automatic_heating?: boolean | undefined
11058
+ can_enable_automatic_cooling?: boolean | undefined
11059
+ available_hvac_mode_settings?:
11060
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
11061
+ | undefined
11062
+ is_heating_available?: false | undefined
11063
+ is_cooling_available?: true | undefined
11064
+ is_heating?: boolean | undefined
11065
+ is_cooling?: boolean | undefined
11066
+ is_fan_running?: boolean | undefined
11067
+ fan_mode_setting?: ('auto' | 'on') | undefined
11068
+ is_temporary_manual_override_active?: boolean | undefined
11069
+ current_climate_setting?:
11070
+ | {
11071
+ automatic_heating_enabled: boolean
11072
+ automatic_cooling_enabled: boolean
11073
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
11074
+ cooling_set_point_celsius?: number | undefined
11075
+ heating_set_point_celsius?: number | undefined
11076
+ cooling_set_point_fahrenheit?: number | undefined
11077
+ heating_set_point_fahrenheit?: number | undefined
11078
+ manual_override_allowed: boolean
11079
+ }
11080
+ | undefined
11081
+ default_climate_setting?:
11082
+ | (
11083
+ | {
11084
+ automatic_heating_enabled: boolean
11085
+ automatic_cooling_enabled: boolean
11086
+ hvac_mode_setting:
11087
+ | 'off'
11088
+ | 'heat'
11089
+ | 'cool'
11090
+ | 'heat_cool'
11091
+ cooling_set_point_celsius?: number | undefined
11092
+ heating_set_point_celsius?: number | undefined
11093
+ cooling_set_point_fahrenheit?: number | undefined
11094
+ heating_set_point_fahrenheit?: number | undefined
11095
+ manual_override_allowed: boolean
11096
+ }
11097
+ | undefined
11098
+ )
11099
+ | undefined
11100
+ is_climate_setting_schedule_active?: boolean | undefined
11101
+ active_climate_setting_schedule?:
11102
+ | (
11103
+ | {
11104
+ climate_setting_schedule_id: string
11105
+ schedule_type: 'time_bound'
11106
+ device_id: string
11107
+ name?: string | undefined
11108
+ schedule_starts_at: string
11109
+ schedule_ends_at: string
11110
+ created_at: string
11111
+ /** 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. */
11112
+ errors?: any
11113
+ automatic_heating_enabled?: boolean | undefined
11114
+ automatic_cooling_enabled?: boolean | undefined
11115
+ hvac_mode_setting?:
11116
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
11117
+ | undefined
11118
+ cooling_set_point_celsius?:
11119
+ | (number | undefined)
11120
+ | undefined
11121
+ heating_set_point_celsius?:
11122
+ | (number | undefined)
11123
+ | undefined
11124
+ cooling_set_point_fahrenheit?:
11125
+ | (number | undefined)
11126
+ | undefined
11127
+ heating_set_point_fahrenheit?:
11128
+ | (number | undefined)
11129
+ | undefined
11130
+ manual_override_allowed?: boolean | undefined
11131
+ }
11132
+ | undefined
11133
+ )
11134
+ | undefined
11135
+ min_cooling_set_point_celsius?: number | undefined
11136
+ min_cooling_set_point_fahrenheit?: number | undefined
11137
+ max_cooling_set_point_celsius?: number | undefined
11138
+ max_cooling_set_point_fahrenheit?: number | undefined
11139
+ }
11140
+ ))
11141
+ /** Location information for the device. */
11142
+ location: {
11143
+ /** Name of the device location. */
11144
+ location_name?: string | undefined
11145
+ /** Time zone of the device location. */
11146
+ timezone?: string | undefined
11147
+ } | null
11148
+ /** Unique identifier for the account associated with the device. */
11149
+ connected_account_id: string
11150
+ /** Unique identifier for the Seam workspace associated with the device. */
11151
+ workspace_id: string
11152
+ /** 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. */
11153
+ errors: Array<{
11154
+ error_code: string
11155
+ message: string
11156
+ }>
11157
+ /** 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. */
11158
+ warnings: Array<{
11159
+ warning_code: string
11160
+ message: string
11161
+ }>
11162
+ /** Date and time at which the device object was created. */
11163
+ created_at: string
11164
+ /** Indicates whether Seam manages the device. */
11165
+ is_managed: true
11166
+ custom_metadata: Record<string, string | boolean>
11167
+ can_remotely_unlock?: boolean | undefined
11168
+ can_remotely_lock?: boolean | undefined
11169
+ can_program_online_access_codes?: boolean | undefined
11170
+ can_simulate_removal?: boolean | undefined
11171
+ }>
11172
+ /**
11173
+ ---
11174
+ deprecated: use devices.
11175
+ ---
11176
+ */
10444
11177
  accessible_devices: Array<{
10445
11178
  /** Unique identifier for the device. */
10446
11179
  device_id: string
@@ -11264,8 +11997,8 @@ export interface Routes {
11264
11997
  }
11265
11998
  | undefined
11266
11999
  user_identity_id?: string | undefined
11267
- user_identity_email_address?: string | undefined
11268
- user_identity_phone_number?: string | undefined
12000
+ user_identity_email_address?: (string | null) | undefined
12001
+ user_identity_phone_number?: (string | null) | undefined
11269
12002
  full_name?: string | undefined
11270
12003
  /**
11271
12004
  ---