@seamapi/types 1.1188.0 → 1.1189.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.
@@ -14101,8 +14101,12 @@ export type Routes = {
14101
14101
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
14102
14102
  */
14103
14103
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
14104
+ /** Indicates whether the device is online. */
14105
+ is_online: boolean;
14106
+ /** Indicates whether the lock is locked. */
14107
+ is_door_locked?: boolean | undefined;
14104
14108
  /** Properties of the device. */
14105
- properties: (({
14109
+ properties?: ((({
14106
14110
  /** Indicates whether the device is online. */
14107
14111
  online: boolean;
14108
14112
  /** Name of the device.
@@ -14127,20 +14131,20 @@ export type Routes = {
14127
14131
  /** Device model-related properties. */
14128
14132
  model: {
14129
14133
  /**
14130
- Indicates whether the device can connect a accessory keypad.
14131
- */
14134
+ Indicates whether the device can connect a accessory keypad.
14135
+ */
14132
14136
  can_connect_accessory_keypad?: boolean | undefined;
14133
14137
  /**
14134
- Display name of the device model.
14135
- */
14138
+ Display name of the device model.
14139
+ */
14136
14140
  display_name: string;
14137
14141
  /**
14138
- Display name that corresponds to the manufacturer-specific terminology for the device.
14139
- */
14142
+ Display name that corresponds to the manufacturer-specific terminology for the device.
14143
+ */
14140
14144
  manufacturer_display_name: string;
14141
14145
  /**
14142
- Indicates whether the device has a built in accessory keypad.
14143
- */
14146
+ Indicates whether the device has a built in accessory keypad.
14147
+ */
14144
14148
  has_built_in_keypad?: boolean | undefined;
14145
14149
  /**
14146
14150
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -14989,8 +14993,8 @@ export type Routes = {
14989
14993
  /** Keypad battery status. */
14990
14994
  keypad_battery?: ({
14991
14995
  /**
14992
- Keypad battery charge level.
14993
- */
14996
+ Keypad battery charge level.
14997
+ */
14994
14998
  level: number;
14995
14999
  } | undefined) | undefined;
14996
15000
  /** Indicates whether the door is open. */
@@ -15070,8 +15074,8 @@ export type Routes = {
15070
15074
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
15071
15075
  display_name?: string | undefined;
15072
15076
  /**
15073
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15074
- */
15077
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15078
+ */
15075
15079
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
15076
15080
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
15077
15081
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -15089,8 +15093,8 @@ export type Routes = {
15089
15093
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
15090
15094
  manual_override_allowed?: boolean | undefined;
15091
15095
  /**
15092
- Metadata specific to the Ecobee climate, if applicable.
15093
- */
15096
+ Metadata specific to the Ecobee climate, if applicable.
15097
+ */
15094
15098
  ecobee_metadata?: ({
15095
15099
  /** Reference to the Ecobee climate, if applicable. */
15096
15100
  climate_ref?: (string | undefined) | undefined;
@@ -15116,8 +15120,8 @@ export type Routes = {
15116
15120
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
15117
15121
  display_name?: string | undefined;
15118
15122
  /**
15119
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15120
- */
15123
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15124
+ */
15121
15125
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
15122
15126
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
15123
15127
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -15135,8 +15139,8 @@ export type Routes = {
15135
15139
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
15136
15140
  manual_override_allowed?: boolean | undefined;
15137
15141
  /**
15138
- Metadata specific to the Ecobee climate, if applicable.
15139
- */
15142
+ Metadata specific to the Ecobee climate, if applicable.
15143
+ */
15140
15144
  ecobee_metadata?: ({
15141
15145
  /** Reference to the Ecobee climate, if applicable. */
15142
15146
  climate_ref?: (string | undefined) | undefined;
@@ -15161,8 +15165,8 @@ export type Routes = {
15161
15165
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
15162
15166
  display_name: string;
15163
15167
  /**
15164
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15165
- */
15168
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
15169
+ */
15166
15170
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
15167
15171
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
15168
15172
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -15180,8 +15184,8 @@ export type Routes = {
15180
15184
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
15181
15185
  manual_override_allowed: boolean;
15182
15186
  /**
15183
- Metadata specific to the Ecobee climate, if applicable.
15184
- */
15187
+ Metadata specific to the Ecobee climate, if applicable.
15188
+ */
15185
15189
  ecobee_metadata?: {
15186
15190
  /** Reference to the Ecobee climate, if applicable. */
15187
15191
  climate_ref?: (string | undefined) | undefined;
@@ -15308,7 +15312,7 @@ export type Routes = {
15308
15312
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
15309
15313
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
15310
15314
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
15311
- });
15315
+ })) | undefined;
15312
15316
  /** Location information for the device. */
15313
15317
  location?: {
15314
15318
  /** Name of the device location.
@@ -22409,8 +22413,12 @@ export type Routes = {
22409
22413
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
22410
22414
  */
22411
22415
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
22416
+ /** Indicates whether the device is online. */
22417
+ is_online: boolean;
22418
+ /** Indicates whether the lock is locked. */
22419
+ is_door_locked?: boolean | undefined;
22412
22420
  /** Properties of the device. */
22413
- properties: (({
22421
+ properties?: ((({
22414
22422
  /** Indicates whether the device is online. */
22415
22423
  online: boolean;
22416
22424
  /** Name of the device.
@@ -22435,20 +22443,20 @@ export type Routes = {
22435
22443
  /** Device model-related properties. */
22436
22444
  model: {
22437
22445
  /**
22438
- Indicates whether the device can connect a accessory keypad.
22439
- */
22446
+ Indicates whether the device can connect a accessory keypad.
22447
+ */
22440
22448
  can_connect_accessory_keypad?: boolean | undefined;
22441
22449
  /**
22442
- Display name of the device model.
22443
- */
22450
+ Display name of the device model.
22451
+ */
22444
22452
  display_name: string;
22445
22453
  /**
22446
- Display name that corresponds to the manufacturer-specific terminology for the device.
22447
- */
22454
+ Display name that corresponds to the manufacturer-specific terminology for the device.
22455
+ */
22448
22456
  manufacturer_display_name: string;
22449
22457
  /**
22450
- Indicates whether the device has a built in accessory keypad.
22451
- */
22458
+ Indicates whether the device has a built in accessory keypad.
22459
+ */
22452
22460
  has_built_in_keypad?: boolean | undefined;
22453
22461
  /**
22454
22462
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -23297,8 +23305,8 @@ export type Routes = {
23297
23305
  /** Keypad battery status. */
23298
23306
  keypad_battery?: ({
23299
23307
  /**
23300
- Keypad battery charge level.
23301
- */
23308
+ Keypad battery charge level.
23309
+ */
23302
23310
  level: number;
23303
23311
  } | undefined) | undefined;
23304
23312
  /** Indicates whether the door is open. */
@@ -23378,8 +23386,8 @@ export type Routes = {
23378
23386
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
23379
23387
  display_name?: string | undefined;
23380
23388
  /**
23381
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23382
- */
23389
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23390
+ */
23383
23391
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
23384
23392
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
23385
23393
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -23397,8 +23405,8 @@ export type Routes = {
23397
23405
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
23398
23406
  manual_override_allowed?: boolean | undefined;
23399
23407
  /**
23400
- Metadata specific to the Ecobee climate, if applicable.
23401
- */
23408
+ Metadata specific to the Ecobee climate, if applicable.
23409
+ */
23402
23410
  ecobee_metadata?: ({
23403
23411
  /** Reference to the Ecobee climate, if applicable. */
23404
23412
  climate_ref?: (string | undefined) | undefined;
@@ -23424,8 +23432,8 @@ export type Routes = {
23424
23432
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
23425
23433
  display_name?: string | undefined;
23426
23434
  /**
23427
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23428
- */
23435
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23436
+ */
23429
23437
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
23430
23438
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
23431
23439
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -23443,8 +23451,8 @@ export type Routes = {
23443
23451
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
23444
23452
  manual_override_allowed?: boolean | undefined;
23445
23453
  /**
23446
- Metadata specific to the Ecobee climate, if applicable.
23447
- */
23454
+ Metadata specific to the Ecobee climate, if applicable.
23455
+ */
23448
23456
  ecobee_metadata?: ({
23449
23457
  /** Reference to the Ecobee climate, if applicable. */
23450
23458
  climate_ref?: (string | undefined) | undefined;
@@ -23469,8 +23477,8 @@ export type Routes = {
23469
23477
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
23470
23478
  display_name: string;
23471
23479
  /**
23472
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23473
- */
23480
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
23481
+ */
23474
23482
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
23475
23483
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
23476
23484
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -23488,8 +23496,8 @@ export type Routes = {
23488
23496
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
23489
23497
  manual_override_allowed: boolean;
23490
23498
  /**
23491
- Metadata specific to the Ecobee climate, if applicable.
23492
- */
23499
+ Metadata specific to the Ecobee climate, if applicable.
23500
+ */
23493
23501
  ecobee_metadata?: {
23494
23502
  /** Reference to the Ecobee climate, if applicable. */
23495
23503
  climate_ref?: (string | undefined) | undefined;
@@ -23616,7 +23624,7 @@ export type Routes = {
23616
23624
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
23617
23625
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
23618
23626
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
23619
- });
23627
+ })) | undefined;
23620
23628
  /** Location information for the device. */
23621
23629
  location?: {
23622
23630
  /** Name of the device location.
@@ -49971,8 +49979,12 @@ export type Routes = {
49971
49979
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
49972
49980
  */
49973
49981
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
49982
+ /** Indicates whether the device is online. */
49983
+ is_online: boolean;
49984
+ /** Indicates whether the lock is locked. */
49985
+ is_door_locked?: boolean | undefined;
49974
49986
  /** Properties of the device. */
49975
- properties: (({
49987
+ properties?: ((({
49976
49988
  /** Indicates whether the device is online. */
49977
49989
  online: boolean;
49978
49990
  /** Name of the device.
@@ -49997,20 +50009,20 @@ export type Routes = {
49997
50009
  /** Device model-related properties. */
49998
50010
  model: {
49999
50011
  /**
50000
- Indicates whether the device can connect a accessory keypad.
50001
- */
50012
+ Indicates whether the device can connect a accessory keypad.
50013
+ */
50002
50014
  can_connect_accessory_keypad?: boolean | undefined;
50003
50015
  /**
50004
- Display name of the device model.
50005
- */
50016
+ Display name of the device model.
50017
+ */
50006
50018
  display_name: string;
50007
50019
  /**
50008
- Display name that corresponds to the manufacturer-specific terminology for the device.
50009
- */
50020
+ Display name that corresponds to the manufacturer-specific terminology for the device.
50021
+ */
50010
50022
  manufacturer_display_name: string;
50011
50023
  /**
50012
- Indicates whether the device has a built in accessory keypad.
50013
- */
50024
+ Indicates whether the device has a built in accessory keypad.
50025
+ */
50014
50026
  has_built_in_keypad?: boolean | undefined;
50015
50027
  /**
50016
50028
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -50859,8 +50871,8 @@ export type Routes = {
50859
50871
  /** Keypad battery status. */
50860
50872
  keypad_battery?: ({
50861
50873
  /**
50862
- Keypad battery charge level.
50863
- */
50874
+ Keypad battery charge level.
50875
+ */
50864
50876
  level: number;
50865
50877
  } | undefined) | undefined;
50866
50878
  /** Indicates whether the door is open. */
@@ -50940,8 +50952,8 @@ export type Routes = {
50940
50952
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
50941
50953
  display_name?: string | undefined;
50942
50954
  /**
50943
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
50944
- */
50955
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
50956
+ */
50945
50957
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
50946
50958
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
50947
50959
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -50959,8 +50971,8 @@ export type Routes = {
50959
50971
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
50960
50972
  manual_override_allowed?: boolean | undefined;
50961
50973
  /**
50962
- Metadata specific to the Ecobee climate, if applicable.
50963
- */
50974
+ Metadata specific to the Ecobee climate, if applicable.
50975
+ */
50964
50976
  ecobee_metadata?: ({
50965
50977
  /** Reference to the Ecobee climate, if applicable. */
50966
50978
  climate_ref?: (string | undefined) | undefined;
@@ -50986,8 +50998,8 @@ export type Routes = {
50986
50998
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
50987
50999
  display_name?: string | undefined;
50988
51000
  /**
50989
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
50990
- */
51001
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
51002
+ */
50991
51003
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
50992
51004
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
50993
51005
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -51005,8 +51017,8 @@ export type Routes = {
51005
51017
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
51006
51018
  manual_override_allowed?: boolean | undefined;
51007
51019
  /**
51008
- Metadata specific to the Ecobee climate, if applicable.
51009
- */
51020
+ Metadata specific to the Ecobee climate, if applicable.
51021
+ */
51010
51022
  ecobee_metadata?: ({
51011
51023
  /** Reference to the Ecobee climate, if applicable. */
51012
51024
  climate_ref?: (string | undefined) | undefined;
@@ -51031,8 +51043,8 @@ export type Routes = {
51031
51043
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
51032
51044
  display_name: string;
51033
51045
  /**
51034
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
51035
- */
51046
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
51047
+ */
51036
51048
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
51037
51049
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
51038
51050
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -51050,8 +51062,8 @@ export type Routes = {
51050
51062
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
51051
51063
  manual_override_allowed: boolean;
51052
51064
  /**
51053
- Metadata specific to the Ecobee climate, if applicable.
51054
- */
51065
+ Metadata specific to the Ecobee climate, if applicable.
51066
+ */
51055
51067
  ecobee_metadata?: {
51056
51068
  /** Reference to the Ecobee climate, if applicable. */
51057
51069
  climate_ref?: (string | undefined) | undefined;
@@ -51178,7 +51190,7 @@ export type Routes = {
51178
51190
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
51179
51191
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
51180
51192
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
51181
- });
51193
+ })) | undefined;
51182
51194
  /** Location information for the device. */
51183
51195
  location?: {
51184
51196
  /** Name of the device location.
@@ -51755,8 +51767,12 @@ export type Routes = {
51755
51767
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
51756
51768
  */
51757
51769
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
51770
+ /** Indicates whether the device is online. */
51771
+ is_online: boolean;
51772
+ /** Indicates whether the lock is locked. */
51773
+ is_door_locked?: boolean | undefined;
51758
51774
  /** Properties of the device. */
51759
- properties: (({
51775
+ properties?: ((({
51760
51776
  /** Indicates whether the device is online. */
51761
51777
  online: boolean;
51762
51778
  /** Name of the device.
@@ -51781,20 +51797,20 @@ export type Routes = {
51781
51797
  /** Device model-related properties. */
51782
51798
  model: {
51783
51799
  /**
51784
- Indicates whether the device can connect a accessory keypad.
51785
- */
51800
+ Indicates whether the device can connect a accessory keypad.
51801
+ */
51786
51802
  can_connect_accessory_keypad?: boolean | undefined;
51787
51803
  /**
51788
- Display name of the device model.
51789
- */
51804
+ Display name of the device model.
51805
+ */
51790
51806
  display_name: string;
51791
51807
  /**
51792
- Display name that corresponds to the manufacturer-specific terminology for the device.
51793
- */
51808
+ Display name that corresponds to the manufacturer-specific terminology for the device.
51809
+ */
51794
51810
  manufacturer_display_name: string;
51795
51811
  /**
51796
- Indicates whether the device has a built in accessory keypad.
51797
- */
51812
+ Indicates whether the device has a built in accessory keypad.
51813
+ */
51798
51814
  has_built_in_keypad?: boolean | undefined;
51799
51815
  /**
51800
51816
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -52643,8 +52659,8 @@ export type Routes = {
52643
52659
  /** Keypad battery status. */
52644
52660
  keypad_battery?: ({
52645
52661
  /**
52646
- Keypad battery charge level.
52647
- */
52662
+ Keypad battery charge level.
52663
+ */
52648
52664
  level: number;
52649
52665
  } | undefined) | undefined;
52650
52666
  /** Indicates whether the door is open. */
@@ -52724,8 +52740,8 @@ export type Routes = {
52724
52740
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
52725
52741
  display_name?: string | undefined;
52726
52742
  /**
52727
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52728
- */
52743
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52744
+ */
52729
52745
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
52730
52746
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
52731
52747
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -52743,8 +52759,8 @@ export type Routes = {
52743
52759
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
52744
52760
  manual_override_allowed?: boolean | undefined;
52745
52761
  /**
52746
- Metadata specific to the Ecobee climate, if applicable.
52747
- */
52762
+ Metadata specific to the Ecobee climate, if applicable.
52763
+ */
52748
52764
  ecobee_metadata?: ({
52749
52765
  /** Reference to the Ecobee climate, if applicable. */
52750
52766
  climate_ref?: (string | undefined) | undefined;
@@ -52770,8 +52786,8 @@ export type Routes = {
52770
52786
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
52771
52787
  display_name?: string | undefined;
52772
52788
  /**
52773
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52774
- */
52789
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52790
+ */
52775
52791
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
52776
52792
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
52777
52793
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -52789,8 +52805,8 @@ export type Routes = {
52789
52805
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
52790
52806
  manual_override_allowed?: boolean | undefined;
52791
52807
  /**
52792
- Metadata specific to the Ecobee climate, if applicable.
52793
- */
52808
+ Metadata specific to the Ecobee climate, if applicable.
52809
+ */
52794
52810
  ecobee_metadata?: ({
52795
52811
  /** Reference to the Ecobee climate, if applicable. */
52796
52812
  climate_ref?: (string | undefined) | undefined;
@@ -52815,8 +52831,8 @@ export type Routes = {
52815
52831
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
52816
52832
  display_name: string;
52817
52833
  /**
52818
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52819
- */
52834
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
52835
+ */
52820
52836
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
52821
52837
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
52822
52838
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -52834,8 +52850,8 @@ export type Routes = {
52834
52850
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
52835
52851
  manual_override_allowed: boolean;
52836
52852
  /**
52837
- Metadata specific to the Ecobee climate, if applicable.
52838
- */
52853
+ Metadata specific to the Ecobee climate, if applicable.
52854
+ */
52839
52855
  ecobee_metadata?: {
52840
52856
  /** Reference to the Ecobee climate, if applicable. */
52841
52857
  climate_ref?: (string | undefined) | undefined;
@@ -52962,7 +52978,7 @@ export type Routes = {
52962
52978
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
52963
52979
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
52964
52980
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
52965
- });
52981
+ })) | undefined;
52966
52982
  /** Location information for the device. */
52967
52983
  location?: {
52968
52984
  /** Name of the device location.
@@ -54075,10 +54091,12 @@ export type Routes = {
54075
54091
  };
54076
54092
  /** 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. */
54077
54093
  display_name: string;
54094
+ /** Indicates whether the device is online. */
54095
+ is_online: boolean;
54078
54096
  /** Indicates that Seam does not manage the device. */
54079
54097
  is_managed: false;
54080
54098
  /** properties of the device. */
54081
- properties: {
54099
+ properties?: {
54082
54100
  /** Accessory keypad properties and state. */
54083
54101
  accessory_keypad?: {
54084
54102
  /** Indicates if an accessory keypad is connected to the device.
@@ -54121,20 +54139,20 @@ export type Routes = {
54121
54139
  /** Device model-related properties. */
54122
54140
  model: {
54123
54141
  /**
54124
- Indicates whether the device can connect a accessory keypad.
54125
- */
54142
+ Indicates whether the device can connect a accessory keypad.
54143
+ */
54126
54144
  can_connect_accessory_keypad?: boolean | undefined;
54127
54145
  /**
54128
- Display name of the device model.
54129
- */
54146
+ Display name of the device model.
54147
+ */
54130
54148
  display_name: string;
54131
54149
  /**
54132
- Display name that corresponds to the manufacturer-specific terminology for the device.
54133
- */
54150
+ Display name that corresponds to the manufacturer-specific terminology for the device.
54151
+ */
54134
54152
  manufacturer_display_name: string;
54135
54153
  /**
54136
- Indicates whether the device has a built in accessory keypad.
54137
- */
54154
+ Indicates whether the device has a built in accessory keypad.
54155
+ */
54138
54156
  has_built_in_keypad?: boolean | undefined;
54139
54157
  /**
54140
54158
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -54146,7 +54164,7 @@ export type Routes = {
54146
54164
  * @deprecated use device.properties.model.can_connect_accessory_keypad*/
54147
54165
  accessory_keypad_supported?: boolean | undefined;
54148
54166
  };
54149
- };
54167
+ } | undefined;
54150
54168
  /** Indicates whether the device supports remote unlocking. */
54151
54169
  can_remotely_unlock?: boolean | undefined;
54152
54170
  /** Indicates whether the device supports remote locking. */
@@ -54631,10 +54649,12 @@ export type Routes = {
54631
54649
  };
54632
54650
  /** 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. */
54633
54651
  display_name: string;
54652
+ /** Indicates whether the device is online. */
54653
+ is_online: boolean;
54634
54654
  /** Indicates that Seam does not manage the device. */
54635
54655
  is_managed: false;
54636
54656
  /** properties of the device. */
54637
- properties: {
54657
+ properties?: {
54638
54658
  /** Accessory keypad properties and state. */
54639
54659
  accessory_keypad?: {
54640
54660
  /** Indicates if an accessory keypad is connected to the device.
@@ -54677,20 +54697,20 @@ export type Routes = {
54677
54697
  /** Device model-related properties. */
54678
54698
  model: {
54679
54699
  /**
54680
- Indicates whether the device can connect a accessory keypad.
54681
- */
54700
+ Indicates whether the device can connect a accessory keypad.
54701
+ */
54682
54702
  can_connect_accessory_keypad?: boolean | undefined;
54683
54703
  /**
54684
- Display name of the device model.
54685
- */
54704
+ Display name of the device model.
54705
+ */
54686
54706
  display_name: string;
54687
54707
  /**
54688
- Display name that corresponds to the manufacturer-specific terminology for the device.
54689
- */
54708
+ Display name that corresponds to the manufacturer-specific terminology for the device.
54709
+ */
54690
54710
  manufacturer_display_name: string;
54691
54711
  /**
54692
- Indicates whether the device has a built in accessory keypad.
54693
- */
54712
+ Indicates whether the device has a built in accessory keypad.
54713
+ */
54694
54714
  has_built_in_keypad?: boolean | undefined;
54695
54715
  /**
54696
54716
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -54702,7 +54722,7 @@ export type Routes = {
54702
54722
  * @deprecated use device.properties.model.can_connect_accessory_keypad*/
54703
54723
  accessory_keypad_supported?: boolean | undefined;
54704
54724
  };
54705
- };
54725
+ } | undefined;
54706
54726
  /** Indicates whether the device supports remote unlocking. */
54707
54727
  can_remotely_unlock?: boolean | undefined;
54708
54728
  /** Indicates whether the device supports remote locking. */
@@ -64780,8 +64800,12 @@ export type Routes = {
64780
64800
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
64781
64801
  */
64782
64802
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
64803
+ /** Indicates whether the device is online. */
64804
+ is_online: boolean;
64805
+ /** Indicates whether the lock is locked. */
64806
+ is_door_locked?: boolean | undefined;
64783
64807
  /** Properties of the device. */
64784
- properties: (({
64808
+ properties?: ((({
64785
64809
  /** Indicates whether the device is online. */
64786
64810
  online: boolean;
64787
64811
  /** Name of the device.
@@ -64806,20 +64830,20 @@ export type Routes = {
64806
64830
  /** Device model-related properties. */
64807
64831
  model: {
64808
64832
  /**
64809
- Indicates whether the device can connect a accessory keypad.
64810
- */
64833
+ Indicates whether the device can connect a accessory keypad.
64834
+ */
64811
64835
  can_connect_accessory_keypad?: boolean | undefined;
64812
64836
  /**
64813
- Display name of the device model.
64814
- */
64837
+ Display name of the device model.
64838
+ */
64815
64839
  display_name: string;
64816
64840
  /**
64817
- Display name that corresponds to the manufacturer-specific terminology for the device.
64818
- */
64841
+ Display name that corresponds to the manufacturer-specific terminology for the device.
64842
+ */
64819
64843
  manufacturer_display_name: string;
64820
64844
  /**
64821
- Indicates whether the device has a built in accessory keypad.
64822
- */
64845
+ Indicates whether the device has a built in accessory keypad.
64846
+ */
64823
64847
  has_built_in_keypad?: boolean | undefined;
64824
64848
  /**
64825
64849
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -65668,8 +65692,8 @@ export type Routes = {
65668
65692
  /** Keypad battery status. */
65669
65693
  keypad_battery?: ({
65670
65694
  /**
65671
- Keypad battery charge level.
65672
- */
65695
+ Keypad battery charge level.
65696
+ */
65673
65697
  level: number;
65674
65698
  } | undefined) | undefined;
65675
65699
  /** Indicates whether the door is open. */
@@ -65749,8 +65773,8 @@ export type Routes = {
65749
65773
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
65750
65774
  display_name?: string | undefined;
65751
65775
  /**
65752
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65753
- */
65776
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65777
+ */
65754
65778
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
65755
65779
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
65756
65780
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -65768,8 +65792,8 @@ export type Routes = {
65768
65792
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
65769
65793
  manual_override_allowed?: boolean | undefined;
65770
65794
  /**
65771
- Metadata specific to the Ecobee climate, if applicable.
65772
- */
65795
+ Metadata specific to the Ecobee climate, if applicable.
65796
+ */
65773
65797
  ecobee_metadata?: ({
65774
65798
  /** Reference to the Ecobee climate, if applicable. */
65775
65799
  climate_ref?: (string | undefined) | undefined;
@@ -65795,8 +65819,8 @@ export type Routes = {
65795
65819
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
65796
65820
  display_name?: string | undefined;
65797
65821
  /**
65798
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65799
- */
65822
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65823
+ */
65800
65824
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
65801
65825
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
65802
65826
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -65814,8 +65838,8 @@ export type Routes = {
65814
65838
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
65815
65839
  manual_override_allowed?: boolean | undefined;
65816
65840
  /**
65817
- Metadata specific to the Ecobee climate, if applicable.
65818
- */
65841
+ Metadata specific to the Ecobee climate, if applicable.
65842
+ */
65819
65843
  ecobee_metadata?: ({
65820
65844
  /** Reference to the Ecobee climate, if applicable. */
65821
65845
  climate_ref?: (string | undefined) | undefined;
@@ -65840,8 +65864,8 @@ export type Routes = {
65840
65864
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
65841
65865
  display_name: string;
65842
65866
  /**
65843
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65844
- */
65867
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
65868
+ */
65845
65869
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
65846
65870
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
65847
65871
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -65859,8 +65883,8 @@ export type Routes = {
65859
65883
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
65860
65884
  manual_override_allowed: boolean;
65861
65885
  /**
65862
- Metadata specific to the Ecobee climate, if applicable.
65863
- */
65886
+ Metadata specific to the Ecobee climate, if applicable.
65887
+ */
65864
65888
  ecobee_metadata?: {
65865
65889
  /** Reference to the Ecobee climate, if applicable. */
65866
65890
  climate_ref?: (string | undefined) | undefined;
@@ -65987,7 +66011,7 @@ export type Routes = {
65987
66011
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
65988
66012
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
65989
66013
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
65990
- });
66014
+ })) | undefined;
65991
66015
  /** Location information for the device. */
65992
66016
  location?: {
65993
66017
  /** Name of the device location.
@@ -66514,8 +66538,12 @@ export type Routes = {
66514
66538
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
66515
66539
  */
66516
66540
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
66541
+ /** Indicates whether the device is online. */
66542
+ is_online: boolean;
66543
+ /** Indicates whether the lock is locked. */
66544
+ is_door_locked?: boolean | undefined;
66517
66545
  /** Properties of the device. */
66518
- properties: (({
66546
+ properties?: ((({
66519
66547
  /** Indicates whether the device is online. */
66520
66548
  online: boolean;
66521
66549
  /** Name of the device.
@@ -66540,20 +66568,20 @@ export type Routes = {
66540
66568
  /** Device model-related properties. */
66541
66569
  model: {
66542
66570
  /**
66543
- Indicates whether the device can connect a accessory keypad.
66544
- */
66571
+ Indicates whether the device can connect a accessory keypad.
66572
+ */
66545
66573
  can_connect_accessory_keypad?: boolean | undefined;
66546
66574
  /**
66547
- Display name of the device model.
66548
- */
66575
+ Display name of the device model.
66576
+ */
66549
66577
  display_name: string;
66550
66578
  /**
66551
- Display name that corresponds to the manufacturer-specific terminology for the device.
66552
- */
66579
+ Display name that corresponds to the manufacturer-specific terminology for the device.
66580
+ */
66553
66581
  manufacturer_display_name: string;
66554
66582
  /**
66555
- Indicates whether the device has a built in accessory keypad.
66556
- */
66583
+ Indicates whether the device has a built in accessory keypad.
66584
+ */
66557
66585
  has_built_in_keypad?: boolean | undefined;
66558
66586
  /**
66559
66587
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -67402,8 +67430,8 @@ export type Routes = {
67402
67430
  /** Keypad battery status. */
67403
67431
  keypad_battery?: ({
67404
67432
  /**
67405
- Keypad battery charge level.
67406
- */
67433
+ Keypad battery charge level.
67434
+ */
67407
67435
  level: number;
67408
67436
  } | undefined) | undefined;
67409
67437
  /** Indicates whether the door is open. */
@@ -67483,8 +67511,8 @@ export type Routes = {
67483
67511
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
67484
67512
  display_name?: string | undefined;
67485
67513
  /**
67486
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67487
- */
67514
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67515
+ */
67488
67516
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
67489
67517
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
67490
67518
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -67502,8 +67530,8 @@ export type Routes = {
67502
67530
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
67503
67531
  manual_override_allowed?: boolean | undefined;
67504
67532
  /**
67505
- Metadata specific to the Ecobee climate, if applicable.
67506
- */
67533
+ Metadata specific to the Ecobee climate, if applicable.
67534
+ */
67507
67535
  ecobee_metadata?: ({
67508
67536
  /** Reference to the Ecobee climate, if applicable. */
67509
67537
  climate_ref?: (string | undefined) | undefined;
@@ -67529,8 +67557,8 @@ export type Routes = {
67529
67557
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
67530
67558
  display_name?: string | undefined;
67531
67559
  /**
67532
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67533
- */
67560
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67561
+ */
67534
67562
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
67535
67563
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
67536
67564
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -67548,8 +67576,8 @@ export type Routes = {
67548
67576
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
67549
67577
  manual_override_allowed?: boolean | undefined;
67550
67578
  /**
67551
- Metadata specific to the Ecobee climate, if applicable.
67552
- */
67579
+ Metadata specific to the Ecobee climate, if applicable.
67580
+ */
67553
67581
  ecobee_metadata?: ({
67554
67582
  /** Reference to the Ecobee climate, if applicable. */
67555
67583
  climate_ref?: (string | undefined) | undefined;
@@ -67574,8 +67602,8 @@ export type Routes = {
67574
67602
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
67575
67603
  display_name: string;
67576
67604
  /**
67577
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67578
- */
67605
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
67606
+ */
67579
67607
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
67580
67608
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
67581
67609
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -67593,8 +67621,8 @@ export type Routes = {
67593
67621
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
67594
67622
  manual_override_allowed: boolean;
67595
67623
  /**
67596
- Metadata specific to the Ecobee climate, if applicable.
67597
- */
67624
+ Metadata specific to the Ecobee climate, if applicable.
67625
+ */
67598
67626
  ecobee_metadata?: {
67599
67627
  /** Reference to the Ecobee climate, if applicable. */
67600
67628
  climate_ref?: (string | undefined) | undefined;
@@ -67721,7 +67749,7 @@ export type Routes = {
67721
67749
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
67722
67750
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
67723
67751
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
67724
- });
67752
+ })) | undefined;
67725
67753
  /** Location information for the device. */
67726
67754
  location?: {
67727
67755
  /** Name of the device location.
@@ -68271,8 +68299,12 @@ export type Routes = {
68271
68299
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
68272
68300
  */
68273
68301
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
68302
+ /** Indicates whether the device is online. */
68303
+ is_online: boolean;
68304
+ /** Indicates whether the lock is locked. */
68305
+ is_door_locked?: boolean | undefined;
68274
68306
  /** Properties of the device. */
68275
- properties: (({
68307
+ properties?: ((({
68276
68308
  /** Indicates whether the device is online. */
68277
68309
  online: boolean;
68278
68310
  /** Name of the device.
@@ -68297,20 +68329,20 @@ export type Routes = {
68297
68329
  /** Device model-related properties. */
68298
68330
  model: {
68299
68331
  /**
68300
- Indicates whether the device can connect a accessory keypad.
68301
- */
68332
+ Indicates whether the device can connect a accessory keypad.
68333
+ */
68302
68334
  can_connect_accessory_keypad?: boolean | undefined;
68303
68335
  /**
68304
- Display name of the device model.
68305
- */
68336
+ Display name of the device model.
68337
+ */
68306
68338
  display_name: string;
68307
68339
  /**
68308
- Display name that corresponds to the manufacturer-specific terminology for the device.
68309
- */
68340
+ Display name that corresponds to the manufacturer-specific terminology for the device.
68341
+ */
68310
68342
  manufacturer_display_name: string;
68311
68343
  /**
68312
- Indicates whether the device has a built in accessory keypad.
68313
- */
68344
+ Indicates whether the device has a built in accessory keypad.
68345
+ */
68314
68346
  has_built_in_keypad?: boolean | undefined;
68315
68347
  /**
68316
68348
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -69159,8 +69191,8 @@ export type Routes = {
69159
69191
  /** Keypad battery status. */
69160
69192
  keypad_battery?: ({
69161
69193
  /**
69162
- Keypad battery charge level.
69163
- */
69194
+ Keypad battery charge level.
69195
+ */
69164
69196
  level: number;
69165
69197
  } | undefined) | undefined;
69166
69198
  /** Indicates whether the door is open. */
@@ -69240,8 +69272,8 @@ export type Routes = {
69240
69272
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
69241
69273
  display_name?: string | undefined;
69242
69274
  /**
69243
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69244
- */
69275
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69276
+ */
69245
69277
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
69246
69278
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
69247
69279
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -69259,8 +69291,8 @@ export type Routes = {
69259
69291
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
69260
69292
  manual_override_allowed?: boolean | undefined;
69261
69293
  /**
69262
- Metadata specific to the Ecobee climate, if applicable.
69263
- */
69294
+ Metadata specific to the Ecobee climate, if applicable.
69295
+ */
69264
69296
  ecobee_metadata?: ({
69265
69297
  /** Reference to the Ecobee climate, if applicable. */
69266
69298
  climate_ref?: (string | undefined) | undefined;
@@ -69286,8 +69318,8 @@ export type Routes = {
69286
69318
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
69287
69319
  display_name?: string | undefined;
69288
69320
  /**
69289
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69290
- */
69321
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69322
+ */
69291
69323
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
69292
69324
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
69293
69325
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -69305,8 +69337,8 @@ export type Routes = {
69305
69337
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
69306
69338
  manual_override_allowed?: boolean | undefined;
69307
69339
  /**
69308
- Metadata specific to the Ecobee climate, if applicable.
69309
- */
69340
+ Metadata specific to the Ecobee climate, if applicable.
69341
+ */
69310
69342
  ecobee_metadata?: ({
69311
69343
  /** Reference to the Ecobee climate, if applicable. */
69312
69344
  climate_ref?: (string | undefined) | undefined;
@@ -69331,8 +69363,8 @@ export type Routes = {
69331
69363
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
69332
69364
  display_name: string;
69333
69365
  /**
69334
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69335
- */
69366
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
69367
+ */
69336
69368
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
69337
69369
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
69338
69370
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -69350,8 +69382,8 @@ export type Routes = {
69350
69382
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
69351
69383
  manual_override_allowed: boolean;
69352
69384
  /**
69353
- Metadata specific to the Ecobee climate, if applicable.
69354
- */
69385
+ Metadata specific to the Ecobee climate, if applicable.
69386
+ */
69355
69387
  ecobee_metadata?: {
69356
69388
  /** Reference to the Ecobee climate, if applicable. */
69357
69389
  climate_ref?: (string | undefined) | undefined;
@@ -69478,7 +69510,7 @@ export type Routes = {
69478
69510
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
69479
69511
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
69480
69512
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
69481
- });
69513
+ })) | undefined;
69482
69514
  /** Location information for the device. */
69483
69515
  location?: {
69484
69516
  /** Name of the device location.
@@ -70004,8 +70036,12 @@ export type Routes = {
70004
70036
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
70005
70037
  */
70006
70038
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
70039
+ /** Indicates whether the device is online. */
70040
+ is_online: boolean;
70041
+ /** Indicates whether the lock is locked. */
70042
+ is_door_locked?: boolean | undefined;
70007
70043
  /** Properties of the device. */
70008
- properties: (({
70044
+ properties?: ((({
70009
70045
  /** Indicates whether the device is online. */
70010
70046
  online: boolean;
70011
70047
  /** Name of the device.
@@ -70030,20 +70066,20 @@ export type Routes = {
70030
70066
  /** Device model-related properties. */
70031
70067
  model: {
70032
70068
  /**
70033
- Indicates whether the device can connect a accessory keypad.
70034
- */
70069
+ Indicates whether the device can connect a accessory keypad.
70070
+ */
70035
70071
  can_connect_accessory_keypad?: boolean | undefined;
70036
70072
  /**
70037
- Display name of the device model.
70038
- */
70073
+ Display name of the device model.
70074
+ */
70039
70075
  display_name: string;
70040
70076
  /**
70041
- Display name that corresponds to the manufacturer-specific terminology for the device.
70042
- */
70077
+ Display name that corresponds to the manufacturer-specific terminology for the device.
70078
+ */
70043
70079
  manufacturer_display_name: string;
70044
70080
  /**
70045
- Indicates whether the device has a built in accessory keypad.
70046
- */
70081
+ Indicates whether the device has a built in accessory keypad.
70082
+ */
70047
70083
  has_built_in_keypad?: boolean | undefined;
70048
70084
  /**
70049
70085
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -70892,8 +70928,8 @@ export type Routes = {
70892
70928
  /** Keypad battery status. */
70893
70929
  keypad_battery?: ({
70894
70930
  /**
70895
- Keypad battery charge level.
70896
- */
70931
+ Keypad battery charge level.
70932
+ */
70897
70933
  level: number;
70898
70934
  } | undefined) | undefined;
70899
70935
  /** Indicates whether the door is open. */
@@ -70973,8 +71009,8 @@ export type Routes = {
70973
71009
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
70974
71010
  display_name?: string | undefined;
70975
71011
  /**
70976
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
70977
- */
71012
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
71013
+ */
70978
71014
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
70979
71015
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
70980
71016
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -70992,8 +71028,8 @@ export type Routes = {
70992
71028
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
70993
71029
  manual_override_allowed?: boolean | undefined;
70994
71030
  /**
70995
- Metadata specific to the Ecobee climate, if applicable.
70996
- */
71031
+ Metadata specific to the Ecobee climate, if applicable.
71032
+ */
70997
71033
  ecobee_metadata?: ({
70998
71034
  /** Reference to the Ecobee climate, if applicable. */
70999
71035
  climate_ref?: (string | undefined) | undefined;
@@ -71019,8 +71055,8 @@ export type Routes = {
71019
71055
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
71020
71056
  display_name?: string | undefined;
71021
71057
  /**
71022
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
71023
- */
71058
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
71059
+ */
71024
71060
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
71025
71061
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
71026
71062
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -71038,8 +71074,8 @@ export type Routes = {
71038
71074
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
71039
71075
  manual_override_allowed?: boolean | undefined;
71040
71076
  /**
71041
- Metadata specific to the Ecobee climate, if applicable.
71042
- */
71077
+ Metadata specific to the Ecobee climate, if applicable.
71078
+ */
71043
71079
  ecobee_metadata?: ({
71044
71080
  /** Reference to the Ecobee climate, if applicable. */
71045
71081
  climate_ref?: (string | undefined) | undefined;
@@ -71064,8 +71100,8 @@ export type Routes = {
71064
71100
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
71065
71101
  display_name: string;
71066
71102
  /**
71067
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
71068
- */
71103
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
71104
+ */
71069
71105
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
71070
71106
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
71071
71107
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -71083,8 +71119,8 @@ export type Routes = {
71083
71119
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
71084
71120
  manual_override_allowed: boolean;
71085
71121
  /**
71086
- Metadata specific to the Ecobee climate, if applicable.
71087
- */
71122
+ Metadata specific to the Ecobee climate, if applicable.
71123
+ */
71088
71124
  ecobee_metadata?: {
71089
71125
  /** Reference to the Ecobee climate, if applicable. */
71090
71126
  climate_ref?: (string | undefined) | undefined;
@@ -71211,7 +71247,7 @@ export type Routes = {
71211
71247
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
71212
71248
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
71213
71249
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
71214
- });
71250
+ })) | undefined;
71215
71251
  /** Location information for the device. */
71216
71252
  location?: {
71217
71253
  /** Name of the device location.
@@ -80612,8 +80648,12 @@ export type Routes = {
80612
80648
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
80613
80649
  */
80614
80650
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
80651
+ /** Indicates whether the device is online. */
80652
+ is_online: boolean;
80653
+ /** Indicates whether the lock is locked. */
80654
+ is_door_locked?: boolean | undefined;
80615
80655
  /** Properties of the device. */
80616
- properties: (({
80656
+ properties?: ((({
80617
80657
  /** Indicates whether the device is online. */
80618
80658
  online: boolean;
80619
80659
  /** Name of the device.
@@ -80638,20 +80678,20 @@ export type Routes = {
80638
80678
  /** Device model-related properties. */
80639
80679
  model: {
80640
80680
  /**
80641
- Indicates whether the device can connect a accessory keypad.
80642
- */
80681
+ Indicates whether the device can connect a accessory keypad.
80682
+ */
80643
80683
  can_connect_accessory_keypad?: boolean | undefined;
80644
80684
  /**
80645
- Display name of the device model.
80646
- */
80685
+ Display name of the device model.
80686
+ */
80647
80687
  display_name: string;
80648
80688
  /**
80649
- Display name that corresponds to the manufacturer-specific terminology for the device.
80650
- */
80689
+ Display name that corresponds to the manufacturer-specific terminology for the device.
80690
+ */
80651
80691
  manufacturer_display_name: string;
80652
80692
  /**
80653
- Indicates whether the device has a built in accessory keypad.
80654
- */
80693
+ Indicates whether the device has a built in accessory keypad.
80694
+ */
80655
80695
  has_built_in_keypad?: boolean | undefined;
80656
80696
  /**
80657
80697
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -81500,8 +81540,8 @@ export type Routes = {
81500
81540
  /** Keypad battery status. */
81501
81541
  keypad_battery?: ({
81502
81542
  /**
81503
- Keypad battery charge level.
81504
- */
81543
+ Keypad battery charge level.
81544
+ */
81505
81545
  level: number;
81506
81546
  } | undefined) | undefined;
81507
81547
  /** Indicates whether the door is open. */
@@ -81581,8 +81621,8 @@ export type Routes = {
81581
81621
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
81582
81622
  display_name?: string | undefined;
81583
81623
  /**
81584
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81585
- */
81624
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81625
+ */
81586
81626
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
81587
81627
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
81588
81628
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -81600,8 +81640,8 @@ export type Routes = {
81600
81640
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
81601
81641
  manual_override_allowed?: boolean | undefined;
81602
81642
  /**
81603
- Metadata specific to the Ecobee climate, if applicable.
81604
- */
81643
+ Metadata specific to the Ecobee climate, if applicable.
81644
+ */
81605
81645
  ecobee_metadata?: ({
81606
81646
  /** Reference to the Ecobee climate, if applicable. */
81607
81647
  climate_ref?: (string | undefined) | undefined;
@@ -81627,8 +81667,8 @@ export type Routes = {
81627
81667
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
81628
81668
  display_name?: string | undefined;
81629
81669
  /**
81630
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81631
- */
81670
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81671
+ */
81632
81672
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
81633
81673
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
81634
81674
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -81646,8 +81686,8 @@ export type Routes = {
81646
81686
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
81647
81687
  manual_override_allowed?: boolean | undefined;
81648
81688
  /**
81649
- Metadata specific to the Ecobee climate, if applicable.
81650
- */
81689
+ Metadata specific to the Ecobee climate, if applicable.
81690
+ */
81651
81691
  ecobee_metadata?: ({
81652
81692
  /** Reference to the Ecobee climate, if applicable. */
81653
81693
  climate_ref?: (string | undefined) | undefined;
@@ -81672,8 +81712,8 @@ export type Routes = {
81672
81712
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
81673
81713
  display_name: string;
81674
81714
  /**
81675
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81676
- */
81715
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
81716
+ */
81677
81717
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
81678
81718
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
81679
81719
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -81691,8 +81731,8 @@ export type Routes = {
81691
81731
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
81692
81732
  manual_override_allowed: boolean;
81693
81733
  /**
81694
- Metadata specific to the Ecobee climate, if applicable.
81695
- */
81734
+ Metadata specific to the Ecobee climate, if applicable.
81735
+ */
81696
81736
  ecobee_metadata?: {
81697
81737
  /** Reference to the Ecobee climate, if applicable. */
81698
81738
  climate_ref?: (string | undefined) | undefined;
@@ -81819,7 +81859,7 @@ export type Routes = {
81819
81859
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
81820
81860
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
81821
81861
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
81822
- });
81862
+ })) | undefined;
81823
81863
  /** Location information for the device. */
81824
81864
  location?: {
81825
81865
  /** Name of the device location.
@@ -82345,8 +82385,12 @@ export type Routes = {
82345
82385
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
82346
82386
  */
82347
82387
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
82388
+ /** Indicates whether the device is online. */
82389
+ is_online: boolean;
82390
+ /** Indicates whether the lock is locked. */
82391
+ is_door_locked?: boolean | undefined;
82348
82392
  /** Properties of the device. */
82349
- properties: (({
82393
+ properties?: ((({
82350
82394
  /** Indicates whether the device is online. */
82351
82395
  online: boolean;
82352
82396
  /** Name of the device.
@@ -82371,20 +82415,20 @@ export type Routes = {
82371
82415
  /** Device model-related properties. */
82372
82416
  model: {
82373
82417
  /**
82374
- Indicates whether the device can connect a accessory keypad.
82375
- */
82418
+ Indicates whether the device can connect a accessory keypad.
82419
+ */
82376
82420
  can_connect_accessory_keypad?: boolean | undefined;
82377
82421
  /**
82378
- Display name of the device model.
82379
- */
82422
+ Display name of the device model.
82423
+ */
82380
82424
  display_name: string;
82381
82425
  /**
82382
- Display name that corresponds to the manufacturer-specific terminology for the device.
82383
- */
82426
+ Display name that corresponds to the manufacturer-specific terminology for the device.
82427
+ */
82384
82428
  manufacturer_display_name: string;
82385
82429
  /**
82386
- Indicates whether the device has a built in accessory keypad.
82387
- */
82430
+ Indicates whether the device has a built in accessory keypad.
82431
+ */
82388
82432
  has_built_in_keypad?: boolean | undefined;
82389
82433
  /**
82390
82434
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -83233,8 +83277,8 @@ export type Routes = {
83233
83277
  /** Keypad battery status. */
83234
83278
  keypad_battery?: ({
83235
83279
  /**
83236
- Keypad battery charge level.
83237
- */
83280
+ Keypad battery charge level.
83281
+ */
83238
83282
  level: number;
83239
83283
  } | undefined) | undefined;
83240
83284
  /** Indicates whether the door is open. */
@@ -83314,8 +83358,8 @@ export type Routes = {
83314
83358
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
83315
83359
  display_name?: string | undefined;
83316
83360
  /**
83317
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83318
- */
83361
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83362
+ */
83319
83363
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
83320
83364
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
83321
83365
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -83333,8 +83377,8 @@ export type Routes = {
83333
83377
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
83334
83378
  manual_override_allowed?: boolean | undefined;
83335
83379
  /**
83336
- Metadata specific to the Ecobee climate, if applicable.
83337
- */
83380
+ Metadata specific to the Ecobee climate, if applicable.
83381
+ */
83338
83382
  ecobee_metadata?: ({
83339
83383
  /** Reference to the Ecobee climate, if applicable. */
83340
83384
  climate_ref?: (string | undefined) | undefined;
@@ -83360,8 +83404,8 @@ export type Routes = {
83360
83404
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
83361
83405
  display_name?: string | undefined;
83362
83406
  /**
83363
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83364
- */
83407
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83408
+ */
83365
83409
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
83366
83410
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
83367
83411
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -83379,8 +83423,8 @@ export type Routes = {
83379
83423
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
83380
83424
  manual_override_allowed?: boolean | undefined;
83381
83425
  /**
83382
- Metadata specific to the Ecobee climate, if applicable.
83383
- */
83426
+ Metadata specific to the Ecobee climate, if applicable.
83427
+ */
83384
83428
  ecobee_metadata?: ({
83385
83429
  /** Reference to the Ecobee climate, if applicable. */
83386
83430
  climate_ref?: (string | undefined) | undefined;
@@ -83405,8 +83449,8 @@ export type Routes = {
83405
83449
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
83406
83450
  display_name: string;
83407
83451
  /**
83408
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83409
- */
83452
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
83453
+ */
83410
83454
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
83411
83455
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
83412
83456
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -83424,8 +83468,8 @@ export type Routes = {
83424
83468
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
83425
83469
  manual_override_allowed: boolean;
83426
83470
  /**
83427
- Metadata specific to the Ecobee climate, if applicable.
83428
- */
83471
+ Metadata specific to the Ecobee climate, if applicable.
83472
+ */
83429
83473
  ecobee_metadata?: {
83430
83474
  /** Reference to the Ecobee climate, if applicable. */
83431
83475
  climate_ref?: (string | undefined) | undefined;
@@ -83552,7 +83596,7 @@ export type Routes = {
83552
83596
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
83553
83597
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
83554
83598
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
83555
- });
83599
+ })) | undefined;
83556
83600
  /** Location information for the device. */
83557
83601
  location?: {
83558
83602
  /** Name of the device location.
@@ -107960,8 +108004,12 @@ export type Routes = {
107960
108004
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
107961
108005
  */
107962
108006
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
108007
+ /** Indicates whether the device is online. */
108008
+ is_online: boolean;
108009
+ /** Indicates whether the lock is locked. */
108010
+ is_door_locked?: boolean | undefined;
107963
108011
  /** Properties of the device. */
107964
- properties: (({
108012
+ properties?: ((({
107965
108013
  /** Indicates whether the device is online. */
107966
108014
  online: boolean;
107967
108015
  /** Name of the device.
@@ -107986,20 +108034,20 @@ export type Routes = {
107986
108034
  /** Device model-related properties. */
107987
108035
  model: {
107988
108036
  /**
107989
- Indicates whether the device can connect a accessory keypad.
107990
- */
108037
+ Indicates whether the device can connect a accessory keypad.
108038
+ */
107991
108039
  can_connect_accessory_keypad?: boolean | undefined;
107992
108040
  /**
107993
- Display name of the device model.
107994
- */
108041
+ Display name of the device model.
108042
+ */
107995
108043
  display_name: string;
107996
108044
  /**
107997
- Display name that corresponds to the manufacturer-specific terminology for the device.
107998
- */
108045
+ Display name that corresponds to the manufacturer-specific terminology for the device.
108046
+ */
107999
108047
  manufacturer_display_name: string;
108000
108048
  /**
108001
- Indicates whether the device has a built in accessory keypad.
108002
- */
108049
+ Indicates whether the device has a built in accessory keypad.
108050
+ */
108003
108051
  has_built_in_keypad?: boolean | undefined;
108004
108052
  /**
108005
108053
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -108848,8 +108896,8 @@ export type Routes = {
108848
108896
  /** Keypad battery status. */
108849
108897
  keypad_battery?: ({
108850
108898
  /**
108851
- Keypad battery charge level.
108852
- */
108899
+ Keypad battery charge level.
108900
+ */
108853
108901
  level: number;
108854
108902
  } | undefined) | undefined;
108855
108903
  /** Indicates whether the door is open. */
@@ -108929,8 +108977,8 @@ export type Routes = {
108929
108977
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
108930
108978
  display_name?: string | undefined;
108931
108979
  /**
108932
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
108933
- */
108980
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
108981
+ */
108934
108982
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
108935
108983
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
108936
108984
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -108948,8 +108996,8 @@ export type Routes = {
108948
108996
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
108949
108997
  manual_override_allowed?: boolean | undefined;
108950
108998
  /**
108951
- Metadata specific to the Ecobee climate, if applicable.
108952
- */
108999
+ Metadata specific to the Ecobee climate, if applicable.
109000
+ */
108953
109001
  ecobee_metadata?: ({
108954
109002
  /** Reference to the Ecobee climate, if applicable. */
108955
109003
  climate_ref?: (string | undefined) | undefined;
@@ -108975,8 +109023,8 @@ export type Routes = {
108975
109023
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
108976
109024
  display_name?: string | undefined;
108977
109025
  /**
108978
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
108979
- */
109026
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
109027
+ */
108980
109028
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
108981
109029
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
108982
109030
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -108994,8 +109042,8 @@ export type Routes = {
108994
109042
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
108995
109043
  manual_override_allowed?: boolean | undefined;
108996
109044
  /**
108997
- Metadata specific to the Ecobee climate, if applicable.
108998
- */
109045
+ Metadata specific to the Ecobee climate, if applicable.
109046
+ */
108999
109047
  ecobee_metadata?: ({
109000
109048
  /** Reference to the Ecobee climate, if applicable. */
109001
109049
  climate_ref?: (string | undefined) | undefined;
@@ -109020,8 +109068,8 @@ export type Routes = {
109020
109068
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
109021
109069
  display_name: string;
109022
109070
  /**
109023
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
109024
- */
109071
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
109072
+ */
109025
109073
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
109026
109074
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
109027
109075
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -109039,8 +109087,8 @@ export type Routes = {
109039
109087
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
109040
109088
  manual_override_allowed: boolean;
109041
109089
  /**
109042
- Metadata specific to the Ecobee climate, if applicable.
109043
- */
109090
+ Metadata specific to the Ecobee climate, if applicable.
109091
+ */
109044
109092
  ecobee_metadata?: {
109045
109093
  /** Reference to the Ecobee climate, if applicable. */
109046
109094
  climate_ref?: (string | undefined) | undefined;
@@ -109167,7 +109215,7 @@ export type Routes = {
109167
109215
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
109168
109216
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
109169
109217
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
109170
- });
109218
+ })) | undefined;
109171
109219
  /** Location information for the device. */
109172
109220
  location?: {
109173
109221
  /** Name of the device location.
@@ -137259,8 +137307,12 @@ export type Routes = {
137259
137307
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
137260
137308
  */
137261
137309
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
137310
+ /** Indicates whether the device is online. */
137311
+ is_online: boolean;
137312
+ /** Indicates whether the lock is locked. */
137313
+ is_door_locked?: boolean | undefined;
137262
137314
  /** Properties of the device. */
137263
- properties: (({
137315
+ properties?: ((({
137264
137316
  /** Indicates whether the device is online. */
137265
137317
  online: boolean;
137266
137318
  /** Name of the device.
@@ -137285,20 +137337,20 @@ export type Routes = {
137285
137337
  /** Device model-related properties. */
137286
137338
  model: {
137287
137339
  /**
137288
- Indicates whether the device can connect a accessory keypad.
137289
- */
137340
+ Indicates whether the device can connect a accessory keypad.
137341
+ */
137290
137342
  can_connect_accessory_keypad?: boolean | undefined;
137291
137343
  /**
137292
- Display name of the device model.
137293
- */
137344
+ Display name of the device model.
137345
+ */
137294
137346
  display_name: string;
137295
137347
  /**
137296
- Display name that corresponds to the manufacturer-specific terminology for the device.
137297
- */
137348
+ Display name that corresponds to the manufacturer-specific terminology for the device.
137349
+ */
137298
137350
  manufacturer_display_name: string;
137299
137351
  /**
137300
- Indicates whether the device has a built in accessory keypad.
137301
- */
137352
+ Indicates whether the device has a built in accessory keypad.
137353
+ */
137302
137354
  has_built_in_keypad?: boolean | undefined;
137303
137355
  /**
137304
137356
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -138147,8 +138199,8 @@ export type Routes = {
138147
138199
  /** Keypad battery status. */
138148
138200
  keypad_battery?: ({
138149
138201
  /**
138150
- Keypad battery charge level.
138151
- */
138202
+ Keypad battery charge level.
138203
+ */
138152
138204
  level: number;
138153
138205
  } | undefined) | undefined;
138154
138206
  /** Indicates whether the door is open. */
@@ -138228,8 +138280,8 @@ export type Routes = {
138228
138280
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
138229
138281
  display_name?: string | undefined;
138230
138282
  /**
138231
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138232
- */
138283
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138284
+ */
138233
138285
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
138234
138286
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
138235
138287
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -138247,8 +138299,8 @@ export type Routes = {
138247
138299
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
138248
138300
  manual_override_allowed?: boolean | undefined;
138249
138301
  /**
138250
- Metadata specific to the Ecobee climate, if applicable.
138251
- */
138302
+ Metadata specific to the Ecobee climate, if applicable.
138303
+ */
138252
138304
  ecobee_metadata?: ({
138253
138305
  /** Reference to the Ecobee climate, if applicable. */
138254
138306
  climate_ref?: (string | undefined) | undefined;
@@ -138274,8 +138326,8 @@ export type Routes = {
138274
138326
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
138275
138327
  display_name?: string | undefined;
138276
138328
  /**
138277
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138278
- */
138329
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138330
+ */
138279
138331
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
138280
138332
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
138281
138333
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -138293,8 +138345,8 @@ export type Routes = {
138293
138345
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
138294
138346
  manual_override_allowed?: boolean | undefined;
138295
138347
  /**
138296
- Metadata specific to the Ecobee climate, if applicable.
138297
- */
138348
+ Metadata specific to the Ecobee climate, if applicable.
138349
+ */
138298
138350
  ecobee_metadata?: ({
138299
138351
  /** Reference to the Ecobee climate, if applicable. */
138300
138352
  climate_ref?: (string | undefined) | undefined;
@@ -138319,8 +138371,8 @@ export type Routes = {
138319
138371
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
138320
138372
  display_name: string;
138321
138373
  /**
138322
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138323
- */
138374
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
138375
+ */
138324
138376
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
138325
138377
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
138326
138378
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -138338,8 +138390,8 @@ export type Routes = {
138338
138390
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
138339
138391
  manual_override_allowed: boolean;
138340
138392
  /**
138341
- Metadata specific to the Ecobee climate, if applicable.
138342
- */
138393
+ Metadata specific to the Ecobee climate, if applicable.
138394
+ */
138343
138395
  ecobee_metadata?: {
138344
138396
  /** Reference to the Ecobee climate, if applicable. */
138345
138397
  climate_ref?: (string | undefined) | undefined;
@@ -138466,7 +138518,7 @@ export type Routes = {
138466
138518
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
138467
138519
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
138468
138520
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
138469
- });
138521
+ })) | undefined;
138470
138522
  /** Location information for the device. */
138471
138523
  location?: {
138472
138524
  /** Name of the device location.
@@ -143434,8 +143486,12 @@ export type Routes = {
143434
143486
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
143435
143487
  */
143436
143488
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
143489
+ /** Indicates whether the device is online. */
143490
+ is_online: boolean;
143491
+ /** Indicates whether the lock is locked. */
143492
+ is_door_locked?: boolean | undefined;
143437
143493
  /** Properties of the device. */
143438
- properties: (({
143494
+ properties?: ((({
143439
143495
  /** Indicates whether the device is online. */
143440
143496
  online: boolean;
143441
143497
  /** Name of the device.
@@ -143460,20 +143516,20 @@ export type Routes = {
143460
143516
  /** Device model-related properties. */
143461
143517
  model: {
143462
143518
  /**
143463
- Indicates whether the device can connect a accessory keypad.
143464
- */
143519
+ Indicates whether the device can connect a accessory keypad.
143520
+ */
143465
143521
  can_connect_accessory_keypad?: boolean | undefined;
143466
143522
  /**
143467
- Display name of the device model.
143468
- */
143523
+ Display name of the device model.
143524
+ */
143469
143525
  display_name: string;
143470
143526
  /**
143471
- Display name that corresponds to the manufacturer-specific terminology for the device.
143472
- */
143527
+ Display name that corresponds to the manufacturer-specific terminology for the device.
143528
+ */
143473
143529
  manufacturer_display_name: string;
143474
143530
  /**
143475
- Indicates whether the device has a built in accessory keypad.
143476
- */
143531
+ Indicates whether the device has a built in accessory keypad.
143532
+ */
143477
143533
  has_built_in_keypad?: boolean | undefined;
143478
143534
  /**
143479
143535
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -144322,8 +144378,8 @@ export type Routes = {
144322
144378
  /** Keypad battery status. */
144323
144379
  keypad_battery?: ({
144324
144380
  /**
144325
- Keypad battery charge level.
144326
- */
144381
+ Keypad battery charge level.
144382
+ */
144327
144383
  level: number;
144328
144384
  } | undefined) | undefined;
144329
144385
  /** Indicates whether the door is open. */
@@ -144403,8 +144459,8 @@ export type Routes = {
144403
144459
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
144404
144460
  display_name?: string | undefined;
144405
144461
  /**
144406
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144407
- */
144462
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144463
+ */
144408
144464
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
144409
144465
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
144410
144466
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -144422,8 +144478,8 @@ export type Routes = {
144422
144478
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
144423
144479
  manual_override_allowed?: boolean | undefined;
144424
144480
  /**
144425
- Metadata specific to the Ecobee climate, if applicable.
144426
- */
144481
+ Metadata specific to the Ecobee climate, if applicable.
144482
+ */
144427
144483
  ecobee_metadata?: ({
144428
144484
  /** Reference to the Ecobee climate, if applicable. */
144429
144485
  climate_ref?: (string | undefined) | undefined;
@@ -144449,8 +144505,8 @@ export type Routes = {
144449
144505
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
144450
144506
  display_name?: string | undefined;
144451
144507
  /**
144452
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144453
- */
144508
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144509
+ */
144454
144510
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
144455
144511
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
144456
144512
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -144468,8 +144524,8 @@ export type Routes = {
144468
144524
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
144469
144525
  manual_override_allowed?: boolean | undefined;
144470
144526
  /**
144471
- Metadata specific to the Ecobee climate, if applicable.
144472
- */
144527
+ Metadata specific to the Ecobee climate, if applicable.
144528
+ */
144473
144529
  ecobee_metadata?: ({
144474
144530
  /** Reference to the Ecobee climate, if applicable. */
144475
144531
  climate_ref?: (string | undefined) | undefined;
@@ -144494,8 +144550,8 @@ export type Routes = {
144494
144550
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
144495
144551
  display_name: string;
144496
144552
  /**
144497
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144498
- */
144553
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
144554
+ */
144499
144555
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
144500
144556
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
144501
144557
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -144513,8 +144569,8 @@ export type Routes = {
144513
144569
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
144514
144570
  manual_override_allowed: boolean;
144515
144571
  /**
144516
- Metadata specific to the Ecobee climate, if applicable.
144517
- */
144572
+ Metadata specific to the Ecobee climate, if applicable.
144573
+ */
144518
144574
  ecobee_metadata?: {
144519
144575
  /** Reference to the Ecobee climate, if applicable. */
144520
144576
  climate_ref?: (string | undefined) | undefined;
@@ -144641,7 +144697,7 @@ export type Routes = {
144641
144697
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
144642
144698
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
144643
144699
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
144644
- });
144700
+ })) | undefined;
144645
144701
  /** Location information for the device. */
144646
144702
  location?: {
144647
144703
  /** Name of the device location.
@@ -145167,8 +145223,12 @@ export type Routes = {
145167
145223
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
145168
145224
  */
145169
145225
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
145226
+ /** Indicates whether the device is online. */
145227
+ is_online: boolean;
145228
+ /** Indicates whether the lock is locked. */
145229
+ is_door_locked?: boolean | undefined;
145170
145230
  /** Properties of the device. */
145171
- properties: (({
145231
+ properties?: ((({
145172
145232
  /** Indicates whether the device is online. */
145173
145233
  online: boolean;
145174
145234
  /** Name of the device.
@@ -145193,20 +145253,20 @@ export type Routes = {
145193
145253
  /** Device model-related properties. */
145194
145254
  model: {
145195
145255
  /**
145196
- Indicates whether the device can connect a accessory keypad.
145197
- */
145256
+ Indicates whether the device can connect a accessory keypad.
145257
+ */
145198
145258
  can_connect_accessory_keypad?: boolean | undefined;
145199
145259
  /**
145200
- Display name of the device model.
145201
- */
145260
+ Display name of the device model.
145261
+ */
145202
145262
  display_name: string;
145203
145263
  /**
145204
- Display name that corresponds to the manufacturer-specific terminology for the device.
145205
- */
145264
+ Display name that corresponds to the manufacturer-specific terminology for the device.
145265
+ */
145206
145266
  manufacturer_display_name: string;
145207
145267
  /**
145208
- Indicates whether the device has a built in accessory keypad.
145209
- */
145268
+ Indicates whether the device has a built in accessory keypad.
145269
+ */
145210
145270
  has_built_in_keypad?: boolean | undefined;
145211
145271
  /**
145212
145272
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -146055,8 +146115,8 @@ export type Routes = {
146055
146115
  /** Keypad battery status. */
146056
146116
  keypad_battery?: ({
146057
146117
  /**
146058
- Keypad battery charge level.
146059
- */
146118
+ Keypad battery charge level.
146119
+ */
146060
146120
  level: number;
146061
146121
  } | undefined) | undefined;
146062
146122
  /** Indicates whether the door is open. */
@@ -146136,8 +146196,8 @@ export type Routes = {
146136
146196
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
146137
146197
  display_name?: string | undefined;
146138
146198
  /**
146139
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146140
- */
146199
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146200
+ */
146141
146201
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
146142
146202
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
146143
146203
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -146155,8 +146215,8 @@ export type Routes = {
146155
146215
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
146156
146216
  manual_override_allowed?: boolean | undefined;
146157
146217
  /**
146158
- Metadata specific to the Ecobee climate, if applicable.
146159
- */
146218
+ Metadata specific to the Ecobee climate, if applicable.
146219
+ */
146160
146220
  ecobee_metadata?: ({
146161
146221
  /** Reference to the Ecobee climate, if applicable. */
146162
146222
  climate_ref?: (string | undefined) | undefined;
@@ -146182,8 +146242,8 @@ export type Routes = {
146182
146242
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
146183
146243
  display_name?: string | undefined;
146184
146244
  /**
146185
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146186
- */
146245
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146246
+ */
146187
146247
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
146188
146248
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
146189
146249
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -146201,8 +146261,8 @@ export type Routes = {
146201
146261
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
146202
146262
  manual_override_allowed?: boolean | undefined;
146203
146263
  /**
146204
- Metadata specific to the Ecobee climate, if applicable.
146205
- */
146264
+ Metadata specific to the Ecobee climate, if applicable.
146265
+ */
146206
146266
  ecobee_metadata?: ({
146207
146267
  /** Reference to the Ecobee climate, if applicable. */
146208
146268
  climate_ref?: (string | undefined) | undefined;
@@ -146227,8 +146287,8 @@ export type Routes = {
146227
146287
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
146228
146288
  display_name: string;
146229
146289
  /**
146230
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146231
- */
146290
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
146291
+ */
146232
146292
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
146233
146293
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
146234
146294
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -146246,8 +146306,8 @@ export type Routes = {
146246
146306
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
146247
146307
  manual_override_allowed: boolean;
146248
146308
  /**
146249
- Metadata specific to the Ecobee climate, if applicable.
146250
- */
146309
+ Metadata specific to the Ecobee climate, if applicable.
146310
+ */
146251
146311
  ecobee_metadata?: {
146252
146312
  /** Reference to the Ecobee climate, if applicable. */
146253
146313
  climate_ref?: (string | undefined) | undefined;
@@ -146374,7 +146434,7 @@ export type Routes = {
146374
146434
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
146375
146435
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
146376
146436
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
146377
- });
146437
+ })) | undefined;
146378
146438
  /** Location information for the device. */
146379
146439
  location?: {
146380
146440
  /** Name of the device location.
@@ -156845,8 +156905,12 @@ export type Routes = {
156845
156905
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
156846
156906
  */
156847
156907
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
156908
+ /** Indicates whether the device is online. */
156909
+ is_online: boolean;
156910
+ /** Indicates whether the lock is locked. */
156911
+ is_door_locked?: boolean | undefined;
156848
156912
  /** Properties of the device. */
156849
- properties: (({
156913
+ properties?: ((({
156850
156914
  /** Indicates whether the device is online. */
156851
156915
  online: boolean;
156852
156916
  /** Name of the device.
@@ -156871,20 +156935,20 @@ export type Routes = {
156871
156935
  /** Device model-related properties. */
156872
156936
  model: {
156873
156937
  /**
156874
- Indicates whether the device can connect a accessory keypad.
156875
- */
156938
+ Indicates whether the device can connect a accessory keypad.
156939
+ */
156876
156940
  can_connect_accessory_keypad?: boolean | undefined;
156877
156941
  /**
156878
- Display name of the device model.
156879
- */
156942
+ Display name of the device model.
156943
+ */
156880
156944
  display_name: string;
156881
156945
  /**
156882
- Display name that corresponds to the manufacturer-specific terminology for the device.
156883
- */
156946
+ Display name that corresponds to the manufacturer-specific terminology for the device.
156947
+ */
156884
156948
  manufacturer_display_name: string;
156885
156949
  /**
156886
- Indicates whether the device has a built in accessory keypad.
156887
- */
156950
+ Indicates whether the device has a built in accessory keypad.
156951
+ */
156888
156952
  has_built_in_keypad?: boolean | undefined;
156889
156953
  /**
156890
156954
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -157733,8 +157797,8 @@ export type Routes = {
157733
157797
  /** Keypad battery status. */
157734
157798
  keypad_battery?: ({
157735
157799
  /**
157736
- Keypad battery charge level.
157737
- */
157800
+ Keypad battery charge level.
157801
+ */
157738
157802
  level: number;
157739
157803
  } | undefined) | undefined;
157740
157804
  /** Indicates whether the door is open. */
@@ -157814,8 +157878,8 @@ export type Routes = {
157814
157878
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
157815
157879
  display_name?: string | undefined;
157816
157880
  /**
157817
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157818
- */
157881
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157882
+ */
157819
157883
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
157820
157884
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
157821
157885
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -157833,8 +157897,8 @@ export type Routes = {
157833
157897
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
157834
157898
  manual_override_allowed?: boolean | undefined;
157835
157899
  /**
157836
- Metadata specific to the Ecobee climate, if applicable.
157837
- */
157900
+ Metadata specific to the Ecobee climate, if applicable.
157901
+ */
157838
157902
  ecobee_metadata?: ({
157839
157903
  /** Reference to the Ecobee climate, if applicable. */
157840
157904
  climate_ref?: (string | undefined) | undefined;
@@ -157860,8 +157924,8 @@ export type Routes = {
157860
157924
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
157861
157925
  display_name?: string | undefined;
157862
157926
  /**
157863
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157864
- */
157927
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157928
+ */
157865
157929
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
157866
157930
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
157867
157931
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -157879,8 +157943,8 @@ export type Routes = {
157879
157943
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
157880
157944
  manual_override_allowed?: boolean | undefined;
157881
157945
  /**
157882
- Metadata specific to the Ecobee climate, if applicable.
157883
- */
157946
+ Metadata specific to the Ecobee climate, if applicable.
157947
+ */
157884
157948
  ecobee_metadata?: ({
157885
157949
  /** Reference to the Ecobee climate, if applicable. */
157886
157950
  climate_ref?: (string | undefined) | undefined;
@@ -157905,8 +157969,8 @@ export type Routes = {
157905
157969
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
157906
157970
  display_name: string;
157907
157971
  /**
157908
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157909
- */
157972
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
157973
+ */
157910
157974
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
157911
157975
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
157912
157976
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -157924,8 +157988,8 @@ export type Routes = {
157924
157988
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
157925
157989
  manual_override_allowed: boolean;
157926
157990
  /**
157927
- Metadata specific to the Ecobee climate, if applicable.
157928
- */
157991
+ Metadata specific to the Ecobee climate, if applicable.
157992
+ */
157929
157993
  ecobee_metadata?: {
157930
157994
  /** Reference to the Ecobee climate, if applicable. */
157931
157995
  climate_ref?: (string | undefined) | undefined;
@@ -158052,7 +158116,7 @@ export type Routes = {
158052
158116
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
158053
158117
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
158054
158118
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
158055
- });
158119
+ })) | undefined;
158056
158120
  /** Location information for the device. */
158057
158121
  location?: {
158058
158122
  /** Name of the device location.
@@ -158580,8 +158644,12 @@ export type Routes = {
158580
158644
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
158581
158645
  */
158582
158646
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
158647
+ /** Indicates whether the device is online. */
158648
+ is_online: boolean;
158649
+ /** Indicates whether the lock is locked. */
158650
+ is_door_locked?: boolean | undefined;
158583
158651
  /** Properties of the device. */
158584
- properties: (({
158652
+ properties?: ((({
158585
158653
  /** Indicates whether the device is online. */
158586
158654
  online: boolean;
158587
158655
  /** Name of the device.
@@ -158606,20 +158674,20 @@ export type Routes = {
158606
158674
  /** Device model-related properties. */
158607
158675
  model: {
158608
158676
  /**
158609
- Indicates whether the device can connect a accessory keypad.
158610
- */
158677
+ Indicates whether the device can connect a accessory keypad.
158678
+ */
158611
158679
  can_connect_accessory_keypad?: boolean | undefined;
158612
158680
  /**
158613
- Display name of the device model.
158614
- */
158681
+ Display name of the device model.
158682
+ */
158615
158683
  display_name: string;
158616
158684
  /**
158617
- Display name that corresponds to the manufacturer-specific terminology for the device.
158618
- */
158685
+ Display name that corresponds to the manufacturer-specific terminology for the device.
158686
+ */
158619
158687
  manufacturer_display_name: string;
158620
158688
  /**
158621
- Indicates whether the device has a built in accessory keypad.
158622
- */
158689
+ Indicates whether the device has a built in accessory keypad.
158690
+ */
158623
158691
  has_built_in_keypad?: boolean | undefined;
158624
158692
  /**
158625
158693
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -159468,8 +159536,8 @@ export type Routes = {
159468
159536
  /** Keypad battery status. */
159469
159537
  keypad_battery?: ({
159470
159538
  /**
159471
- Keypad battery charge level.
159472
- */
159539
+ Keypad battery charge level.
159540
+ */
159473
159541
  level: number;
159474
159542
  } | undefined) | undefined;
159475
159543
  /** Indicates whether the door is open. */
@@ -159549,8 +159617,8 @@ export type Routes = {
159549
159617
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
159550
159618
  display_name?: string | undefined;
159551
159619
  /**
159552
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159553
- */
159620
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159621
+ */
159554
159622
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
159555
159623
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
159556
159624
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -159568,8 +159636,8 @@ export type Routes = {
159568
159636
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
159569
159637
  manual_override_allowed?: boolean | undefined;
159570
159638
  /**
159571
- Metadata specific to the Ecobee climate, if applicable.
159572
- */
159639
+ Metadata specific to the Ecobee climate, if applicable.
159640
+ */
159573
159641
  ecobee_metadata?: ({
159574
159642
  /** Reference to the Ecobee climate, if applicable. */
159575
159643
  climate_ref?: (string | undefined) | undefined;
@@ -159595,8 +159663,8 @@ export type Routes = {
159595
159663
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
159596
159664
  display_name?: string | undefined;
159597
159665
  /**
159598
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159599
- */
159666
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159667
+ */
159600
159668
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
159601
159669
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
159602
159670
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -159614,8 +159682,8 @@ export type Routes = {
159614
159682
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
159615
159683
  manual_override_allowed?: boolean | undefined;
159616
159684
  /**
159617
- Metadata specific to the Ecobee climate, if applicable.
159618
- */
159685
+ Metadata specific to the Ecobee climate, if applicable.
159686
+ */
159619
159687
  ecobee_metadata?: ({
159620
159688
  /** Reference to the Ecobee climate, if applicable. */
159621
159689
  climate_ref?: (string | undefined) | undefined;
@@ -159640,8 +159708,8 @@ export type Routes = {
159640
159708
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
159641
159709
  display_name: string;
159642
159710
  /**
159643
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159644
- */
159711
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
159712
+ */
159645
159713
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
159646
159714
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
159647
159715
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -159659,8 +159727,8 @@ export type Routes = {
159659
159727
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
159660
159728
  manual_override_allowed: boolean;
159661
159729
  /**
159662
- Metadata specific to the Ecobee climate, if applicable.
159663
- */
159730
+ Metadata specific to the Ecobee climate, if applicable.
159731
+ */
159664
159732
  ecobee_metadata?: {
159665
159733
  /** Reference to the Ecobee climate, if applicable. */
159666
159734
  climate_ref?: (string | undefined) | undefined;
@@ -159787,7 +159855,7 @@ export type Routes = {
159787
159855
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
159788
159856
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
159789
159857
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
159790
- });
159858
+ })) | undefined;
159791
159859
  /** Location information for the device. */
159792
159860
  location?: {
159793
159861
  /** Name of the device location.
@@ -162671,8 +162739,12 @@ export type Routes = {
162671
162739
  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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
162672
162740
  */
162673
162741
  capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
162742
+ /** Indicates whether the device is online. */
162743
+ is_online: boolean;
162744
+ /** Indicates whether the lock is locked. */
162745
+ is_door_locked?: boolean | undefined;
162674
162746
  /** Properties of the device. */
162675
- properties: (({
162747
+ properties?: ((({
162676
162748
  /** Indicates whether the device is online. */
162677
162749
  online: boolean;
162678
162750
  /** Name of the device.
@@ -162697,20 +162769,20 @@ export type Routes = {
162697
162769
  /** Device model-related properties. */
162698
162770
  model: {
162699
162771
  /**
162700
- Indicates whether the device can connect a accessory keypad.
162701
- */
162772
+ Indicates whether the device can connect a accessory keypad.
162773
+ */
162702
162774
  can_connect_accessory_keypad?: boolean | undefined;
162703
162775
  /**
162704
- Display name of the device model.
162705
- */
162776
+ Display name of the device model.
162777
+ */
162706
162778
  display_name: string;
162707
162779
  /**
162708
- Display name that corresponds to the manufacturer-specific terminology for the device.
162709
- */
162780
+ Display name that corresponds to the manufacturer-specific terminology for the device.
162781
+ */
162710
162782
  manufacturer_display_name: string;
162711
162783
  /**
162712
- Indicates whether the device has a built in accessory keypad.
162713
- */
162784
+ Indicates whether the device has a built in accessory keypad.
162785
+ */
162714
162786
  has_built_in_keypad?: boolean | undefined;
162715
162787
  /**
162716
162788
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -163559,8 +163631,8 @@ export type Routes = {
163559
163631
  /** Keypad battery status. */
163560
163632
  keypad_battery?: ({
163561
163633
  /**
163562
- Keypad battery charge level.
163563
- */
163634
+ Keypad battery charge level.
163635
+ */
163564
163636
  level: number;
163565
163637
  } | undefined) | undefined;
163566
163638
  /** Indicates whether the door is open. */
@@ -163640,8 +163712,8 @@ export type Routes = {
163640
163712
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
163641
163713
  display_name?: string | undefined;
163642
163714
  /**
163643
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163644
- */
163715
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163716
+ */
163645
163717
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
163646
163718
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
163647
163719
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -163659,8 +163731,8 @@ export type Routes = {
163659
163731
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
163660
163732
  manual_override_allowed?: boolean | undefined;
163661
163733
  /**
163662
- Metadata specific to the Ecobee climate, if applicable.
163663
- */
163734
+ Metadata specific to the Ecobee climate, if applicable.
163735
+ */
163664
163736
  ecobee_metadata?: ({
163665
163737
  /** Reference to the Ecobee climate, if applicable. */
163666
163738
  climate_ref?: (string | undefined) | undefined;
@@ -163686,8 +163758,8 @@ export type Routes = {
163686
163758
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
163687
163759
  display_name?: string | undefined;
163688
163760
  /**
163689
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163690
- */
163761
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163762
+ */
163691
163763
  climate_preset_mode?: (('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined) | undefined;
163692
163764
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
163693
163765
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
@@ -163705,8 +163777,8 @@ export type Routes = {
163705
163777
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
163706
163778
  manual_override_allowed?: boolean | undefined;
163707
163779
  /**
163708
- Metadata specific to the Ecobee climate, if applicable.
163709
- */
163780
+ Metadata specific to the Ecobee climate, if applicable.
163781
+ */
163710
163782
  ecobee_metadata?: ({
163711
163783
  /** Reference to the Ecobee climate, if applicable. */
163712
163784
  climate_ref?: (string | undefined) | undefined;
@@ -163731,8 +163803,8 @@ export type Routes = {
163731
163803
  /** Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
163732
163804
  display_name: string;
163733
163805
  /**
163734
- The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163735
- */
163806
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
163807
+ */
163736
163808
  climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
163737
163809
  /** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
163738
163810
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
@@ -163750,8 +163822,8 @@ export type Routes = {
163750
163822
  * @deprecated Use 'thermostat_schedule.is_override_allowed'*/
163751
163823
  manual_override_allowed: boolean;
163752
163824
  /**
163753
- Metadata specific to the Ecobee climate, if applicable.
163754
- */
163825
+ Metadata specific to the Ecobee climate, if applicable.
163826
+ */
163755
163827
  ecobee_metadata?: {
163756
163828
  /** Reference to the Ecobee climate, if applicable. */
163757
163829
  climate_ref?: (string | undefined) | undefined;
@@ -163878,7 +163950,7 @@ export type Routes = {
163878
163950
  max_unique_climate_presets_per_thermostat_weekly_program?: (number | undefined) | undefined;
163879
163951
  /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
163880
163952
  max_thermostat_daily_program_periods_per_day?: (number | undefined) | undefined;
163881
- });
163953
+ })) | undefined;
163882
163954
  /** Location information for the device. */
163883
163955
  location?: {
163884
163956
  /** Name of the device location.
@@ -168227,10 +168299,12 @@ export type Routes = {
168227
168299
  };
168228
168300
  /** 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. */
168229
168301
  display_name: string;
168302
+ /** Indicates whether the device is online. */
168303
+ is_online: boolean;
168230
168304
  /** Indicates that Seam does not manage the device. */
168231
168305
  is_managed: false;
168232
168306
  /** properties of the device. */
168233
- properties: {
168307
+ properties?: {
168234
168308
  /** Accessory keypad properties and state. */
168235
168309
  accessory_keypad?: {
168236
168310
  /** Indicates if an accessory keypad is connected to the device.
@@ -168273,20 +168347,20 @@ export type Routes = {
168273
168347
  /** Device model-related properties. */
168274
168348
  model: {
168275
168349
  /**
168276
- Indicates whether the device can connect a accessory keypad.
168277
- */
168350
+ Indicates whether the device can connect a accessory keypad.
168351
+ */
168278
168352
  can_connect_accessory_keypad?: boolean | undefined;
168279
168353
  /**
168280
- Display name of the device model.
168281
- */
168354
+ Display name of the device model.
168355
+ */
168282
168356
  display_name: string;
168283
168357
  /**
168284
- Display name that corresponds to the manufacturer-specific terminology for the device.
168285
- */
168358
+ Display name that corresponds to the manufacturer-specific terminology for the device.
168359
+ */
168286
168360
  manufacturer_display_name: string;
168287
168361
  /**
168288
- Indicates whether the device has a built in accessory keypad.
168289
- */
168362
+ Indicates whether the device has a built in accessory keypad.
168363
+ */
168290
168364
  has_built_in_keypad?: boolean | undefined;
168291
168365
  /**
168292
168366
  * @deprecated use device.can_program_offline_access_codes.*/
@@ -168298,7 +168372,7 @@ export type Routes = {
168298
168372
  * @deprecated use device.properties.model.can_connect_accessory_keypad*/
168299
168373
  accessory_keypad_supported?: boolean | undefined;
168300
168374
  };
168301
- };
168375
+ } | undefined;
168302
168376
  /** Indicates whether the device supports remote unlocking. */
168303
168377
  can_remotely_unlock?: boolean | undefined;
168304
168378
  /** Indicates whether the device supports remote locking. */