@seamapi/types 1.240.0 → 1.241.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.
Files changed (62) hide show
  1. package/dist/connect.cjs +1347 -768
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3569 -1426
  4. package/dist/devicedb.d.cts +30 -30
  5. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  6. package/lib/seam/connect/internal/schemas.js +1 -1
  7. package/lib/seam/connect/internal/schemas.js.map +1 -1
  8. package/lib/seam/connect/model-types.d.ts +1 -1
  9. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +4 -4
  10. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +1 -1
  11. package/lib/seam/connect/models/acs/acs-user.d.ts +231 -28
  12. package/lib/seam/connect/models/acs/acs-user.js +61 -13
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +78 -0
  15. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  16. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  17. package/lib/seam/connect/models/action-attempts/activate-climate-preset.d.ts +80 -0
  18. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js +25 -0
  19. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js.map +1 -0
  20. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +185 -83
  21. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +185 -83
  22. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +15 -6
  23. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +263 -119
  25. package/lib/seam/connect/models/devices/phone.d.ts +187 -85
  26. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +185 -83
  27. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +83 -0
  28. package/lib/seam/connect/models/thermostats/climate-preset.js +18 -0
  29. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -0
  30. package/lib/seam/connect/models/thermostats/climate-setting-schedule.d.ts +18 -34
  31. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js +8 -10
  32. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js.map +1 -1
  33. package/lib/seam/connect/models/thermostats/index.d.ts +1 -1
  34. package/lib/seam/connect/models/thermostats/index.js +1 -1
  35. package/lib/seam/connect/models/thermostats/index.js.map +1 -1
  36. package/lib/seam/connect/openapi.d.ts +1000 -569
  37. package/lib/seam/connect/openapi.js +1188 -681
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +1738 -460
  40. package/lib/seam/connect/schemas.d.ts +1 -1
  41. package/lib/seam/connect/schemas.js +1 -1
  42. package/lib/seam/connect/schemas.js.map +1 -1
  43. package/lib/seam/devicedb/models/device-model.d.ts +8 -8
  44. package/lib/seam/devicedb/models/manufacturer.d.ts +2 -2
  45. package/lib/seam/devicedb/route-specs.d.ts +20 -20
  46. package/package.json +2 -2
  47. package/src/lib/seam/connect/internal/schemas.ts +2 -2
  48. package/src/lib/seam/connect/model-types.ts +1 -1
  49. package/src/lib/seam/connect/models/acs/acs-user.ts +86 -19
  50. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  51. package/src/lib/seam/connect/models/action-attempts/activate-climate-preset.ts +36 -0
  52. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +16 -6
  53. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +24 -0
  54. package/src/lib/seam/connect/models/thermostats/climate-setting-schedule.ts +16 -19
  55. package/src/lib/seam/connect/models/thermostats/index.ts +1 -1
  56. package/src/lib/seam/connect/openapi.ts +1216 -670
  57. package/src/lib/seam/connect/route-types.ts +2030 -505
  58. package/src/lib/seam/connect/schemas.ts +1 -1
  59. package/lib/seam/connect/models/thermostats/climate-setting.d.ts +0 -24
  60. package/lib/seam/connect/models/thermostats/climate-setting.js +0 -11
  61. package/lib/seam/connect/models/thermostats/climate-setting.js.map +0 -1
  62. package/src/lib/seam/connect/models/thermostats/climate-setting.ts +0 -14
@@ -217,6 +217,30 @@ export interface Routes {
217
217
  type: string;
218
218
  message: string;
219
219
  };
220
+ } | {
221
+ /** The ID of the action attempt. */
222
+ action_attempt_id: string;
223
+ status: 'pending';
224
+ result: null;
225
+ error: null;
226
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
227
+ } | {
228
+ /** The ID of the action attempt. */
229
+ action_attempt_id: string;
230
+ status: 'success';
231
+ error: null;
232
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
233
+ result: {};
234
+ } | {
235
+ /** The ID of the action attempt. */
236
+ action_attempt_id: string;
237
+ status: 'error';
238
+ result: null;
239
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
240
+ error: {
241
+ type: string;
242
+ message: string;
243
+ };
220
244
  } | {
221
245
  /** The ID of the action attempt. */
222
246
  action_attempt_id: string;
@@ -741,6 +765,30 @@ export interface Routes {
741
765
  type: string;
742
766
  message: string;
743
767
  };
768
+ } | {
769
+ /** The ID of the action attempt. */
770
+ action_attempt_id: string;
771
+ status: 'pending';
772
+ result: null;
773
+ error: null;
774
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
775
+ } | {
776
+ /** The ID of the action attempt. */
777
+ action_attempt_id: string;
778
+ status: 'success';
779
+ error: null;
780
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
781
+ result: {};
782
+ } | {
783
+ /** The ID of the action attempt. */
784
+ action_attempt_id: string;
785
+ status: 'error';
786
+ result: null;
787
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
788
+ error: {
789
+ type: string;
790
+ message: string;
791
+ };
744
792
  } | {
745
793
  /** The ID of the action attempt. */
746
794
  action_attempt_id: string;
@@ -1422,6 +1470,30 @@ export interface Routes {
1422
1470
  type: string;
1423
1471
  message: string;
1424
1472
  };
1473
+ } | {
1474
+ /** The ID of the action attempt. */
1475
+ action_attempt_id: string;
1476
+ status: 'pending';
1477
+ result: null;
1478
+ error: null;
1479
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
1480
+ } | {
1481
+ /** The ID of the action attempt. */
1482
+ action_attempt_id: string;
1483
+ status: 'success';
1484
+ error: null;
1485
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
1486
+ result: {};
1487
+ } | {
1488
+ /** The ID of the action attempt. */
1489
+ action_attempt_id: string;
1490
+ status: 'error';
1491
+ result: null;
1492
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
1493
+ error: {
1494
+ type: string;
1495
+ message: string;
1496
+ };
1425
1497
  } | {
1426
1498
  /** The ID of the action attempt. */
1427
1499
  action_attempt_id: string;
@@ -1933,6 +2005,30 @@ export interface Routes {
1933
2005
  type: string;
1934
2006
  message: string;
1935
2007
  };
2008
+ } | {
2009
+ /** The ID of the action attempt. */
2010
+ action_attempt_id: string;
2011
+ status: 'pending';
2012
+ result: null;
2013
+ error: null;
2014
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
2015
+ } | {
2016
+ /** The ID of the action attempt. */
2017
+ action_attempt_id: string;
2018
+ status: 'success';
2019
+ error: null;
2020
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
2021
+ result: {};
2022
+ } | {
2023
+ /** The ID of the action attempt. */
2024
+ action_attempt_id: string;
2025
+ status: 'error';
2026
+ result: null;
2027
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
2028
+ error: {
2029
+ type: string;
2030
+ message: string;
2031
+ };
1936
2032
  } | {
1937
2033
  /** The ID of the action attempt. */
1938
2034
  action_attempt_id: string;
@@ -2248,7 +2344,7 @@ export interface Routes {
2248
2344
  } | {
2249
2345
  created_at: string;
2250
2346
  message: string;
2251
- warning_code: 'failed_to_update_acs_user_on_acs_system';
2347
+ warning_code: 'failed_to_update_on_acs_system';
2252
2348
  } | {
2253
2349
  created_at: string;
2254
2350
  message: string;
@@ -2258,7 +2354,25 @@ export interface Routes {
2258
2354
  message: string;
2259
2355
  warning_code: 'salto_site_user_suspended';
2260
2356
  }>;
2261
- errors?: any;
2357
+ errors: Array<{
2358
+ /** Date and time at which Seam created the error. */
2359
+ created_at: string;
2360
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2361
+ message: string;
2362
+ error_code: 'user_deleted_externally';
2363
+ } | {
2364
+ /** Date and time at which Seam created the error. */
2365
+ created_at: string;
2366
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2367
+ message: string;
2368
+ error_code: 'salto_ks_subscription_limit_exceeded';
2369
+ } | {
2370
+ /** Date and time at which Seam created the error. */
2371
+ created_at: string;
2372
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2373
+ message: string;
2374
+ error_code: 'salto_site_user_limit_reached';
2375
+ }>;
2262
2376
  full_name?: string | undefined;
2263
2377
  /**
2264
2378
  * @deprecated use email_address. */
@@ -3332,7 +3446,7 @@ export interface Routes {
3332
3446
  } | {
3333
3447
  created_at: string;
3334
3448
  message: string;
3335
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3449
+ warning_code: 'failed_to_update_on_acs_system';
3336
3450
  } | {
3337
3451
  created_at: string;
3338
3452
  message: string;
@@ -3342,7 +3456,25 @@ export interface Routes {
3342
3456
  message: string;
3343
3457
  warning_code: 'salto_site_user_suspended';
3344
3458
  }>;
3345
- errors?: any;
3459
+ errors: Array<{
3460
+ /** Date and time at which Seam created the error. */
3461
+ created_at: string;
3462
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3463
+ message: string;
3464
+ error_code: 'user_deleted_externally';
3465
+ } | {
3466
+ /** Date and time at which Seam created the error. */
3467
+ created_at: string;
3468
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3469
+ message: string;
3470
+ error_code: 'salto_ks_subscription_limit_exceeded';
3471
+ } | {
3472
+ /** Date and time at which Seam created the error. */
3473
+ created_at: string;
3474
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3475
+ message: string;
3476
+ error_code: 'salto_site_user_limit_reached';
3477
+ }>;
3346
3478
  full_name?: string | undefined;
3347
3479
  /**
3348
3480
  * @deprecated use email_address. */
@@ -3401,7 +3533,7 @@ export interface Routes {
3401
3533
  } | {
3402
3534
  created_at: string;
3403
3535
  message: string;
3404
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3536
+ warning_code: 'failed_to_update_on_acs_system';
3405
3537
  } | {
3406
3538
  created_at: string;
3407
3539
  message: string;
@@ -3411,7 +3543,25 @@ export interface Routes {
3411
3543
  message: string;
3412
3544
  warning_code: 'salto_site_user_suspended';
3413
3545
  }>;
3414
- errors?: any;
3546
+ errors: Array<{
3547
+ /** Date and time at which Seam created the error. */
3548
+ created_at: string;
3549
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3550
+ message: string;
3551
+ error_code: 'user_deleted_externally';
3552
+ } | {
3553
+ /** Date and time at which Seam created the error. */
3554
+ created_at: string;
3555
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3556
+ message: string;
3557
+ error_code: 'salto_ks_subscription_limit_exceeded';
3558
+ } | {
3559
+ /** Date and time at which Seam created the error. */
3560
+ created_at: string;
3561
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3562
+ message: string;
3563
+ error_code: 'salto_site_user_limit_reached';
3564
+ }>;
3415
3565
  full_name?: string | undefined;
3416
3566
  /**
3417
3567
  * @deprecated use email_address. */
@@ -3464,7 +3614,7 @@ export interface Routes {
3464
3614
  } | {
3465
3615
  created_at: string;
3466
3616
  message: string;
3467
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3617
+ warning_code: 'failed_to_update_on_acs_system';
3468
3618
  } | {
3469
3619
  created_at: string;
3470
3620
  message: string;
@@ -3474,7 +3624,25 @@ export interface Routes {
3474
3624
  message: string;
3475
3625
  warning_code: 'salto_site_user_suspended';
3476
3626
  }>;
3477
- errors?: any;
3627
+ errors: Array<{
3628
+ /** Date and time at which Seam created the error. */
3629
+ created_at: string;
3630
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3631
+ message: string;
3632
+ error_code: 'user_deleted_externally';
3633
+ } | {
3634
+ /** Date and time at which Seam created the error. */
3635
+ created_at: string;
3636
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3637
+ message: string;
3638
+ error_code: 'salto_ks_subscription_limit_exceeded';
3639
+ } | {
3640
+ /** Date and time at which Seam created the error. */
3641
+ created_at: string;
3642
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3643
+ message: string;
3644
+ error_code: 'salto_site_user_limit_reached';
3645
+ }>;
3478
3646
  full_name?: string | undefined;
3479
3647
  /**
3480
3648
  * @deprecated use email_address. */
@@ -3592,7 +3760,7 @@ export interface Routes {
3592
3760
  } | {
3593
3761
  created_at: string;
3594
3762
  message: string;
3595
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3763
+ warning_code: 'failed_to_update_on_acs_system';
3596
3764
  } | {
3597
3765
  created_at: string;
3598
3766
  message: string;
@@ -3602,7 +3770,25 @@ export interface Routes {
3602
3770
  message: string;
3603
3771
  warning_code: 'salto_site_user_suspended';
3604
3772
  }>;
3605
- errors?: any;
3773
+ errors: Array<{
3774
+ /** Date and time at which Seam created the error. */
3775
+ created_at: string;
3776
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3777
+ message: string;
3778
+ error_code: 'user_deleted_externally';
3779
+ } | {
3780
+ /** Date and time at which Seam created the error. */
3781
+ created_at: string;
3782
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3783
+ message: string;
3784
+ error_code: 'salto_ks_subscription_limit_exceeded';
3785
+ } | {
3786
+ /** Date and time at which Seam created the error. */
3787
+ created_at: string;
3788
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3789
+ message: string;
3790
+ error_code: 'salto_site_user_limit_reached';
3791
+ }>;
3606
3792
  full_name?: string | undefined;
3607
3793
  /**
3608
3794
  * @deprecated use email_address. */
@@ -3654,7 +3840,7 @@ export interface Routes {
3654
3840
  } | {
3655
3841
  created_at: string;
3656
3842
  message: string;
3657
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3843
+ warning_code: 'failed_to_update_on_acs_system';
3658
3844
  } | {
3659
3845
  created_at: string;
3660
3846
  message: string;
@@ -3664,7 +3850,25 @@ export interface Routes {
3664
3850
  message: string;
3665
3851
  warning_code: 'salto_site_user_suspended';
3666
3852
  }>;
3667
- errors?: any;
3853
+ errors: Array<{
3854
+ /** Date and time at which Seam created the error. */
3855
+ created_at: string;
3856
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3857
+ message: string;
3858
+ error_code: 'user_deleted_externally';
3859
+ } | {
3860
+ /** Date and time at which Seam created the error. */
3861
+ created_at: string;
3862
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3863
+ message: string;
3864
+ error_code: 'salto_ks_subscription_limit_exceeded';
3865
+ } | {
3866
+ /** Date and time at which Seam created the error. */
3867
+ created_at: string;
3868
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3869
+ message: string;
3870
+ error_code: 'salto_site_user_limit_reached';
3871
+ }>;
3668
3872
  full_name?: string | undefined;
3669
3873
  /**
3670
3874
  * @deprecated use email_address. */
@@ -3910,6 +4114,30 @@ export interface Routes {
3910
4114
  type: string;
3911
4115
  message: string;
3912
4116
  };
4117
+ } | {
4118
+ /** The ID of the action attempt. */
4119
+ action_attempt_id: string;
4120
+ status: 'pending';
4121
+ result: null;
4122
+ error: null;
4123
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4124
+ } | {
4125
+ /** The ID of the action attempt. */
4126
+ action_attempt_id: string;
4127
+ status: 'success';
4128
+ error: null;
4129
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4130
+ result: {};
4131
+ } | {
4132
+ /** The ID of the action attempt. */
4133
+ action_attempt_id: string;
4134
+ status: 'error';
4135
+ result: null;
4136
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4137
+ error: {
4138
+ type: string;
4139
+ message: string;
4140
+ };
3913
4141
  } | {
3914
4142
  /** The ID of the action attempt. */
3915
4143
  action_attempt_id: string;
@@ -4283,6 +4511,30 @@ export interface Routes {
4283
4511
  type: string;
4284
4512
  message: string;
4285
4513
  };
4514
+ } | {
4515
+ /** The ID of the action attempt. */
4516
+ action_attempt_id: string;
4517
+ status: 'pending';
4518
+ result: null;
4519
+ error: null;
4520
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4521
+ } | {
4522
+ /** The ID of the action attempt. */
4523
+ action_attempt_id: string;
4524
+ status: 'success';
4525
+ error: null;
4526
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4527
+ result: {};
4528
+ } | {
4529
+ /** The ID of the action attempt. */
4530
+ action_attempt_id: string;
4531
+ status: 'error';
4532
+ result: null;
4533
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4534
+ error: {
4535
+ type: string;
4536
+ message: string;
4537
+ };
4286
4538
  } | {
4287
4539
  /** The ID of the action attempt. */
4288
4540
  action_attempt_id: string;
@@ -5194,42 +5446,67 @@ export interface Routes {
5194
5446
  is_heating?: boolean | undefined;
5195
5447
  is_cooling?: boolean | undefined;
5196
5448
  is_fan_running?: boolean | undefined;
5449
+ /**
5450
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5197
5451
  fan_mode_setting?: ('auto' | 'on') | undefined;
5198
5452
  is_temporary_manual_override_active?: boolean | undefined;
5199
5453
  current_climate_setting?: {
5200
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5201
- cooling_set_point_celsius?: number | undefined;
5202
- heating_set_point_celsius?: number | undefined;
5203
- cooling_set_point_fahrenheit?: number | undefined;
5204
- heating_set_point_fahrenheit?: number | undefined;
5205
- manual_override_allowed: boolean;
5454
+ climate_preset_key?: string | undefined;
5455
+ can_edit?: boolean | undefined;
5456
+ can_delete?: boolean | undefined;
5457
+ name?: (string | null) | undefined;
5458
+ display_name?: string | undefined;
5459
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5460
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5461
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5462
+ heating_set_point_celsius?: (number | undefined) | undefined;
5463
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5464
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5465
+ manual_override_allowed?: boolean | undefined;
5206
5466
  } | undefined;
5467
+ /**
5468
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5207
5469
  default_climate_setting?: {
5208
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5470
+ climate_preset_key?: string | undefined;
5471
+ can_edit?: boolean | undefined;
5472
+ can_delete?: boolean | undefined;
5473
+ name?: (string | null) | undefined;
5474
+ display_name?: string | undefined;
5475
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5476
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5477
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5478
+ heating_set_point_celsius?: (number | undefined) | undefined;
5479
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5480
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5481
+ manual_override_allowed?: boolean | undefined;
5482
+ } | undefined;
5483
+ available_climate_presets?: Array<{
5484
+ climate_preset_key: string;
5485
+ can_edit: boolean;
5486
+ can_delete: boolean;
5487
+ name: string | null;
5488
+ display_name: string;
5489
+ fan_mode_setting?: ('auto' | 'on') | undefined;
5490
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5209
5491
  cooling_set_point_celsius?: number | undefined;
5210
5492
  heating_set_point_celsius?: number | undefined;
5211
5493
  cooling_set_point_fahrenheit?: number | undefined;
5212
5494
  heating_set_point_fahrenheit?: number | undefined;
5213
5495
  manual_override_allowed: boolean;
5214
- } | undefined;
5215
- is_climate_setting_schedule_active?: boolean | undefined;
5216
- active_climate_setting_schedule?: {
5217
- climate_setting_schedule_id: string;
5218
- schedule_type: 'time_bound';
5496
+ }> | undefined;
5497
+ fallback_climate_preset_key?: (string | null) | undefined;
5498
+ active_thermostat_schedule?: ({
5499
+ thermostat_schedule_id: string;
5219
5500
  device_id: string;
5220
5501
  name?: string | undefined;
5221
- schedule_starts_at: string;
5222
- schedule_ends_at: string;
5502
+ climate_preset_key: string;
5503
+ max_override_period_minutes?: number;
5504
+ starts_at: string;
5505
+ ends_at: string;
5223
5506
  created_at: string;
5224
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5507
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5225
5508
  errors?: any;
5226
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5227
- cooling_set_point_celsius?: (number | undefined) | undefined;
5228
- heating_set_point_celsius?: (number | undefined) | undefined;
5229
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5230
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5231
- manual_override_allowed?: boolean | undefined;
5232
- } | undefined;
5509
+ } | null) | undefined;
5233
5510
  min_cooling_set_point_celsius?: number | undefined;
5234
5511
  min_cooling_set_point_fahrenheit?: number | undefined;
5235
5512
  max_cooling_set_point_celsius?: number | undefined;
@@ -5613,42 +5890,67 @@ export interface Routes {
5613
5890
  is_heating?: boolean | undefined;
5614
5891
  is_cooling?: boolean | undefined;
5615
5892
  is_fan_running?: boolean | undefined;
5893
+ /**
5894
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5616
5895
  fan_mode_setting?: ('auto' | 'on') | undefined;
5617
5896
  is_temporary_manual_override_active?: boolean | undefined;
5618
5897
  current_climate_setting?: {
5619
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5620
- cooling_set_point_celsius?: number | undefined;
5621
- heating_set_point_celsius?: number | undefined;
5622
- cooling_set_point_fahrenheit?: number | undefined;
5623
- heating_set_point_fahrenheit?: number | undefined;
5624
- manual_override_allowed: boolean;
5898
+ climate_preset_key?: string | undefined;
5899
+ can_edit?: boolean | undefined;
5900
+ can_delete?: boolean | undefined;
5901
+ name?: (string | null) | undefined;
5902
+ display_name?: string | undefined;
5903
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5904
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5905
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5906
+ heating_set_point_celsius?: (number | undefined) | undefined;
5907
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5908
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5909
+ manual_override_allowed?: boolean | undefined;
5625
5910
  } | undefined;
5911
+ /**
5912
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5626
5913
  default_climate_setting?: {
5627
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5914
+ climate_preset_key?: string | undefined;
5915
+ can_edit?: boolean | undefined;
5916
+ can_delete?: boolean | undefined;
5917
+ name?: (string | null) | undefined;
5918
+ display_name?: string | undefined;
5919
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5920
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5921
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5922
+ heating_set_point_celsius?: (number | undefined) | undefined;
5923
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5924
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5925
+ manual_override_allowed?: boolean | undefined;
5926
+ } | undefined;
5927
+ available_climate_presets?: Array<{
5928
+ climate_preset_key: string;
5929
+ can_edit: boolean;
5930
+ can_delete: boolean;
5931
+ name: string | null;
5932
+ display_name: string;
5933
+ fan_mode_setting?: ('auto' | 'on') | undefined;
5934
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5628
5935
  cooling_set_point_celsius?: number | undefined;
5629
5936
  heating_set_point_celsius?: number | undefined;
5630
5937
  cooling_set_point_fahrenheit?: number | undefined;
5631
5938
  heating_set_point_fahrenheit?: number | undefined;
5632
5939
  manual_override_allowed: boolean;
5633
- } | undefined;
5634
- is_climate_setting_schedule_active?: boolean | undefined;
5635
- active_climate_setting_schedule?: {
5636
- climate_setting_schedule_id: string;
5637
- schedule_type: 'time_bound';
5940
+ }> | undefined;
5941
+ fallback_climate_preset_key?: (string | null) | undefined;
5942
+ active_thermostat_schedule?: ({
5943
+ thermostat_schedule_id: string;
5638
5944
  device_id: string;
5639
5945
  name?: string | undefined;
5640
- schedule_starts_at: string;
5641
- schedule_ends_at: string;
5946
+ climate_preset_key: string;
5947
+ max_override_period_minutes?: number;
5948
+ starts_at: string;
5949
+ ends_at: string;
5642
5950
  created_at: string;
5643
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5951
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5644
5952
  errors?: any;
5645
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5646
- cooling_set_point_celsius?: (number | undefined) | undefined;
5647
- heating_set_point_celsius?: (number | undefined) | undefined;
5648
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5649
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5650
- manual_override_allowed?: boolean | undefined;
5651
- } | undefined;
5953
+ } | null) | undefined;
5652
5954
  min_cooling_set_point_celsius?: number | undefined;
5653
5955
  min_cooling_set_point_fahrenheit?: number | undefined;
5654
5956
  max_cooling_set_point_celsius?: number | undefined;
@@ -6412,42 +6714,67 @@ export interface Routes {
6412
6714
  is_heating?: boolean | undefined;
6413
6715
  is_cooling?: boolean | undefined;
6414
6716
  is_fan_running?: boolean | undefined;
6717
+ /**
6718
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6415
6719
  fan_mode_setting?: ('auto' | 'on') | undefined;
6416
6720
  is_temporary_manual_override_active?: boolean | undefined;
6417
6721
  current_climate_setting?: {
6418
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6419
- cooling_set_point_celsius?: number | undefined;
6420
- heating_set_point_celsius?: number | undefined;
6421
- cooling_set_point_fahrenheit?: number | undefined;
6422
- heating_set_point_fahrenheit?: number | undefined;
6423
- manual_override_allowed: boolean;
6722
+ climate_preset_key?: string | undefined;
6723
+ can_edit?: boolean | undefined;
6724
+ can_delete?: boolean | undefined;
6725
+ name?: (string | null) | undefined;
6726
+ display_name?: string | undefined;
6727
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
6728
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
6729
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6730
+ heating_set_point_celsius?: (number | undefined) | undefined;
6731
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6732
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6733
+ manual_override_allowed?: boolean | undefined;
6424
6734
  } | undefined;
6735
+ /**
6736
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6425
6737
  default_climate_setting?: {
6426
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6738
+ climate_preset_key?: string | undefined;
6739
+ can_edit?: boolean | undefined;
6740
+ can_delete?: boolean | undefined;
6741
+ name?: (string | null) | undefined;
6742
+ display_name?: string | undefined;
6743
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
6744
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
6745
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6746
+ heating_set_point_celsius?: (number | undefined) | undefined;
6747
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6748
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6749
+ manual_override_allowed?: boolean | undefined;
6750
+ } | undefined;
6751
+ available_climate_presets?: Array<{
6752
+ climate_preset_key: string;
6753
+ can_edit: boolean;
6754
+ can_delete: boolean;
6755
+ name: string | null;
6756
+ display_name: string;
6757
+ fan_mode_setting?: ('auto' | 'on') | undefined;
6758
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6427
6759
  cooling_set_point_celsius?: number | undefined;
6428
6760
  heating_set_point_celsius?: number | undefined;
6429
6761
  cooling_set_point_fahrenheit?: number | undefined;
6430
6762
  heating_set_point_fahrenheit?: number | undefined;
6431
6763
  manual_override_allowed: boolean;
6432
- } | undefined;
6433
- is_climate_setting_schedule_active?: boolean | undefined;
6434
- active_climate_setting_schedule?: {
6435
- climate_setting_schedule_id: string;
6436
- schedule_type: 'time_bound';
6764
+ }> | undefined;
6765
+ fallback_climate_preset_key?: (string | null) | undefined;
6766
+ active_thermostat_schedule?: ({
6767
+ thermostat_schedule_id: string;
6437
6768
  device_id: string;
6438
6769
  name?: string | undefined;
6439
- schedule_starts_at: string;
6440
- schedule_ends_at: string;
6770
+ climate_preset_key: string;
6771
+ max_override_period_minutes?: number;
6772
+ starts_at: string;
6773
+ ends_at: string;
6441
6774
  created_at: string;
6442
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6775
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6443
6776
  errors?: any;
6444
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6445
- cooling_set_point_celsius?: (number | undefined) | undefined;
6446
- heating_set_point_celsius?: (number | undefined) | undefined;
6447
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6448
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6449
- manual_override_allowed?: boolean | undefined;
6450
- } | undefined;
6777
+ } | null) | undefined;
6451
6778
  min_cooling_set_point_celsius?: number | undefined;
6452
6779
  min_cooling_set_point_fahrenheit?: number | undefined;
6453
6780
  max_cooling_set_point_celsius?: number | undefined;
@@ -6806,42 +7133,67 @@ export interface Routes {
6806
7133
  is_heating?: boolean | undefined;
6807
7134
  is_cooling?: boolean | undefined;
6808
7135
  is_fan_running?: boolean | undefined;
7136
+ /**
7137
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6809
7138
  fan_mode_setting?: ('auto' | 'on') | undefined;
6810
7139
  is_temporary_manual_override_active?: boolean | undefined;
6811
7140
  current_climate_setting?: {
6812
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6813
- cooling_set_point_celsius?: number | undefined;
6814
- heating_set_point_celsius?: number | undefined;
6815
- cooling_set_point_fahrenheit?: number | undefined;
6816
- heating_set_point_fahrenheit?: number | undefined;
6817
- manual_override_allowed: boolean;
7141
+ climate_preset_key?: string | undefined;
7142
+ can_edit?: boolean | undefined;
7143
+ can_delete?: boolean | undefined;
7144
+ name?: (string | null) | undefined;
7145
+ display_name?: string | undefined;
7146
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7147
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7148
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7149
+ heating_set_point_celsius?: (number | undefined) | undefined;
7150
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7151
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7152
+ manual_override_allowed?: boolean | undefined;
6818
7153
  } | undefined;
7154
+ /**
7155
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6819
7156
  default_climate_setting?: {
6820
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7157
+ climate_preset_key?: string | undefined;
7158
+ can_edit?: boolean | undefined;
7159
+ can_delete?: boolean | undefined;
7160
+ name?: (string | null) | undefined;
7161
+ display_name?: string | undefined;
7162
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7163
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7164
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7165
+ heating_set_point_celsius?: (number | undefined) | undefined;
7166
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7167
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7168
+ manual_override_allowed?: boolean | undefined;
7169
+ } | undefined;
7170
+ available_climate_presets?: Array<{
7171
+ climate_preset_key: string;
7172
+ can_edit: boolean;
7173
+ can_delete: boolean;
7174
+ name: string | null;
7175
+ display_name: string;
7176
+ fan_mode_setting?: ('auto' | 'on') | undefined;
7177
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6821
7178
  cooling_set_point_celsius?: number | undefined;
6822
7179
  heating_set_point_celsius?: number | undefined;
6823
7180
  cooling_set_point_fahrenheit?: number | undefined;
6824
7181
  heating_set_point_fahrenheit?: number | undefined;
6825
7182
  manual_override_allowed: boolean;
6826
- } | undefined;
6827
- is_climate_setting_schedule_active?: boolean | undefined;
6828
- active_climate_setting_schedule?: {
6829
- climate_setting_schedule_id: string;
6830
- schedule_type: 'time_bound';
7183
+ }> | undefined;
7184
+ fallback_climate_preset_key?: (string | null) | undefined;
7185
+ active_thermostat_schedule?: ({
7186
+ thermostat_schedule_id: string;
6831
7187
  device_id: string;
6832
7188
  name?: string | undefined;
6833
- schedule_starts_at: string;
6834
- schedule_ends_at: string;
7189
+ climate_preset_key: string;
7190
+ max_override_period_minutes?: number;
7191
+ starts_at: string;
7192
+ ends_at: string;
6835
7193
  created_at: string;
6836
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7194
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6837
7195
  errors?: any;
6838
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6839
- cooling_set_point_celsius?: (number | undefined) | undefined;
6840
- heating_set_point_celsius?: (number | undefined) | undefined;
6841
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6842
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6843
- manual_override_allowed?: boolean | undefined;
6844
- } | undefined;
7196
+ } | null) | undefined;
6845
7197
  min_cooling_set_point_celsius?: number | undefined;
6846
7198
  min_cooling_set_point_fahrenheit?: number | undefined;
6847
7199
  max_cooling_set_point_celsius?: number | undefined;
@@ -7225,42 +7577,67 @@ export interface Routes {
7225
7577
  is_heating?: boolean | undefined;
7226
7578
  is_cooling?: boolean | undefined;
7227
7579
  is_fan_running?: boolean | undefined;
7580
+ /**
7581
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7228
7582
  fan_mode_setting?: ('auto' | 'on') | undefined;
7229
7583
  is_temporary_manual_override_active?: boolean | undefined;
7230
7584
  current_climate_setting?: {
7231
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7232
- cooling_set_point_celsius?: number | undefined;
7233
- heating_set_point_celsius?: number | undefined;
7234
- cooling_set_point_fahrenheit?: number | undefined;
7235
- heating_set_point_fahrenheit?: number | undefined;
7236
- manual_override_allowed: boolean;
7585
+ climate_preset_key?: string | undefined;
7586
+ can_edit?: boolean | undefined;
7587
+ can_delete?: boolean | undefined;
7588
+ name?: (string | null) | undefined;
7589
+ display_name?: string | undefined;
7590
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7591
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7592
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7593
+ heating_set_point_celsius?: (number | undefined) | undefined;
7594
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7595
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7596
+ manual_override_allowed?: boolean | undefined;
7237
7597
  } | undefined;
7598
+ /**
7599
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7238
7600
  default_climate_setting?: {
7239
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7601
+ climate_preset_key?: string | undefined;
7602
+ can_edit?: boolean | undefined;
7603
+ can_delete?: boolean | undefined;
7604
+ name?: (string | null) | undefined;
7605
+ display_name?: string | undefined;
7606
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7607
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7608
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7609
+ heating_set_point_celsius?: (number | undefined) | undefined;
7610
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7611
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7612
+ manual_override_allowed?: boolean | undefined;
7613
+ } | undefined;
7614
+ available_climate_presets?: Array<{
7615
+ climate_preset_key: string;
7616
+ can_edit: boolean;
7617
+ can_delete: boolean;
7618
+ name: string | null;
7619
+ display_name: string;
7620
+ fan_mode_setting?: ('auto' | 'on') | undefined;
7621
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7240
7622
  cooling_set_point_celsius?: number | undefined;
7241
7623
  heating_set_point_celsius?: number | undefined;
7242
7624
  cooling_set_point_fahrenheit?: number | undefined;
7243
7625
  heating_set_point_fahrenheit?: number | undefined;
7244
7626
  manual_override_allowed: boolean;
7245
- } | undefined;
7246
- is_climate_setting_schedule_active?: boolean | undefined;
7247
- active_climate_setting_schedule?: {
7248
- climate_setting_schedule_id: string;
7249
- schedule_type: 'time_bound';
7627
+ }> | undefined;
7628
+ fallback_climate_preset_key?: (string | null) | undefined;
7629
+ active_thermostat_schedule?: ({
7630
+ thermostat_schedule_id: string;
7250
7631
  device_id: string;
7251
7632
  name?: string | undefined;
7252
- schedule_starts_at: string;
7253
- schedule_ends_at: string;
7633
+ climate_preset_key: string;
7634
+ max_override_period_minutes?: number;
7635
+ starts_at: string;
7636
+ ends_at: string;
7254
7637
  created_at: string;
7255
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7638
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7256
7639
  errors?: any;
7257
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7258
- cooling_set_point_celsius?: (number | undefined) | undefined;
7259
- heating_set_point_celsius?: (number | undefined) | undefined;
7260
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7261
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7262
- manual_override_allowed?: boolean | undefined;
7263
- } | undefined;
7640
+ } | null) | undefined;
7264
7641
  min_cooling_set_point_celsius?: number | undefined;
7265
7642
  min_cooling_set_point_fahrenheit?: number | undefined;
7266
7643
  max_cooling_set_point_celsius?: number | undefined;
@@ -7619,42 +7996,67 @@ export interface Routes {
7619
7996
  is_heating?: boolean | undefined;
7620
7997
  is_cooling?: boolean | undefined;
7621
7998
  is_fan_running?: boolean | undefined;
7999
+ /**
8000
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7622
8001
  fan_mode_setting?: ('auto' | 'on') | undefined;
7623
8002
  is_temporary_manual_override_active?: boolean | undefined;
7624
8003
  current_climate_setting?: {
7625
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7626
- cooling_set_point_celsius?: number | undefined;
7627
- heating_set_point_celsius?: number | undefined;
7628
- cooling_set_point_fahrenheit?: number | undefined;
7629
- heating_set_point_fahrenheit?: number | undefined;
7630
- manual_override_allowed: boolean;
8004
+ climate_preset_key?: string | undefined;
8005
+ can_edit?: boolean | undefined;
8006
+ can_delete?: boolean | undefined;
8007
+ name?: (string | null) | undefined;
8008
+ display_name?: string | undefined;
8009
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
8010
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
8011
+ cooling_set_point_celsius?: (number | undefined) | undefined;
8012
+ heating_set_point_celsius?: (number | undefined) | undefined;
8013
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8014
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
8015
+ manual_override_allowed?: boolean | undefined;
7631
8016
  } | undefined;
8017
+ /**
8018
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7632
8019
  default_climate_setting?: {
7633
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
8020
+ climate_preset_key?: string | undefined;
8021
+ can_edit?: boolean | undefined;
8022
+ can_delete?: boolean | undefined;
8023
+ name?: (string | null) | undefined;
8024
+ display_name?: string | undefined;
8025
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
8026
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
8027
+ cooling_set_point_celsius?: (number | undefined) | undefined;
8028
+ heating_set_point_celsius?: (number | undefined) | undefined;
8029
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8030
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
8031
+ manual_override_allowed?: boolean | undefined;
8032
+ } | undefined;
8033
+ available_climate_presets?: Array<{
8034
+ climate_preset_key: string;
8035
+ can_edit: boolean;
8036
+ can_delete: boolean;
8037
+ name: string | null;
8038
+ display_name: string;
8039
+ fan_mode_setting?: ('auto' | 'on') | undefined;
8040
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7634
8041
  cooling_set_point_celsius?: number | undefined;
7635
8042
  heating_set_point_celsius?: number | undefined;
7636
8043
  cooling_set_point_fahrenheit?: number | undefined;
7637
8044
  heating_set_point_fahrenheit?: number | undefined;
7638
8045
  manual_override_allowed: boolean;
7639
- } | undefined;
7640
- is_climate_setting_schedule_active?: boolean | undefined;
7641
- active_climate_setting_schedule?: {
7642
- climate_setting_schedule_id: string;
7643
- schedule_type: 'time_bound';
8046
+ }> | undefined;
8047
+ fallback_climate_preset_key?: (string | null) | undefined;
8048
+ active_thermostat_schedule?: ({
8049
+ thermostat_schedule_id: string;
7644
8050
  device_id: string;
7645
8051
  name?: string | undefined;
7646
- schedule_starts_at: string;
7647
- schedule_ends_at: string;
8052
+ climate_preset_key: string;
8053
+ max_override_period_minutes?: number;
8054
+ starts_at: string;
8055
+ ends_at: string;
7648
8056
  created_at: string;
7649
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8057
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7650
8058
  errors?: any;
7651
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7652
- cooling_set_point_celsius?: (number | undefined) | undefined;
7653
- heating_set_point_celsius?: (number | undefined) | undefined;
7654
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7655
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7656
- manual_override_allowed?: boolean | undefined;
7657
- } | undefined;
8059
+ } | null) | undefined;
7658
8060
  min_cooling_set_point_celsius?: number | undefined;
7659
8061
  min_cooling_set_point_fahrenheit?: number | undefined;
7660
8062
  max_cooling_set_point_celsius?: number | undefined;
@@ -7914,6 +8316,30 @@ export interface Routes {
7914
8316
  type: string;
7915
8317
  message: string;
7916
8318
  };
8319
+ } | {
8320
+ /** The ID of the action attempt. */
8321
+ action_attempt_id: string;
8322
+ status: 'pending';
8323
+ result: null;
8324
+ error: null;
8325
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8326
+ } | {
8327
+ /** The ID of the action attempt. */
8328
+ action_attempt_id: string;
8329
+ status: 'success';
8330
+ error: null;
8331
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8332
+ result: {};
8333
+ } | {
8334
+ /** The ID of the action attempt. */
8335
+ action_attempt_id: string;
8336
+ status: 'error';
8337
+ result: null;
8338
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8339
+ error: {
8340
+ type: string;
8341
+ message: string;
8342
+ };
7917
8343
  } | {
7918
8344
  /** The ID of the action attempt. */
7919
8345
  action_attempt_id: string;
@@ -8288,6 +8714,30 @@ export interface Routes {
8288
8714
  type: string;
8289
8715
  message: string;
8290
8716
  };
8717
+ } | {
8718
+ /** The ID of the action attempt. */
8719
+ action_attempt_id: string;
8720
+ status: 'pending';
8721
+ result: null;
8722
+ error: null;
8723
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8724
+ } | {
8725
+ /** The ID of the action attempt. */
8726
+ action_attempt_id: string;
8727
+ status: 'success';
8728
+ error: null;
8729
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8730
+ result: {};
8731
+ } | {
8732
+ /** The ID of the action attempt. */
8733
+ action_attempt_id: string;
8734
+ status: 'error';
8735
+ result: null;
8736
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8737
+ error: {
8738
+ type: string;
8739
+ message: string;
8740
+ };
8291
8741
  } | {
8292
8742
  /** The ID of the action attempt. */
8293
8743
  action_attempt_id: string;
@@ -8820,42 +9270,67 @@ export interface Routes {
8820
9270
  is_heating?: boolean | undefined;
8821
9271
  is_cooling?: boolean | undefined;
8822
9272
  is_fan_running?: boolean | undefined;
9273
+ /**
9274
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8823
9275
  fan_mode_setting?: ('auto' | 'on') | undefined;
8824
9276
  is_temporary_manual_override_active?: boolean | undefined;
8825
9277
  current_climate_setting?: {
8826
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
8827
- cooling_set_point_celsius?: number | undefined;
8828
- heating_set_point_celsius?: number | undefined;
8829
- cooling_set_point_fahrenheit?: number | undefined;
8830
- heating_set_point_fahrenheit?: number | undefined;
8831
- manual_override_allowed: boolean;
9278
+ climate_preset_key?: string | undefined;
9279
+ can_edit?: boolean | undefined;
9280
+ can_delete?: boolean | undefined;
9281
+ name?: (string | null) | undefined;
9282
+ display_name?: string | undefined;
9283
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9284
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9285
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9286
+ heating_set_point_celsius?: (number | undefined) | undefined;
9287
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9288
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9289
+ manual_override_allowed?: boolean | undefined;
8832
9290
  } | undefined;
9291
+ /**
9292
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8833
9293
  default_climate_setting?: {
8834
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9294
+ climate_preset_key?: string | undefined;
9295
+ can_edit?: boolean | undefined;
9296
+ can_delete?: boolean | undefined;
9297
+ name?: (string | null) | undefined;
9298
+ display_name?: string | undefined;
9299
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9300
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9301
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9302
+ heating_set_point_celsius?: (number | undefined) | undefined;
9303
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9304
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9305
+ manual_override_allowed?: boolean | undefined;
9306
+ } | undefined;
9307
+ available_climate_presets?: Array<{
9308
+ climate_preset_key: string;
9309
+ can_edit: boolean;
9310
+ can_delete: boolean;
9311
+ name: string | null;
9312
+ display_name: string;
9313
+ fan_mode_setting?: ('auto' | 'on') | undefined;
9314
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
8835
9315
  cooling_set_point_celsius?: number | undefined;
8836
9316
  heating_set_point_celsius?: number | undefined;
8837
9317
  cooling_set_point_fahrenheit?: number | undefined;
8838
9318
  heating_set_point_fahrenheit?: number | undefined;
8839
9319
  manual_override_allowed: boolean;
8840
- } | undefined;
8841
- is_climate_setting_schedule_active?: boolean | undefined;
8842
- active_climate_setting_schedule?: {
8843
- climate_setting_schedule_id: string;
8844
- schedule_type: 'time_bound';
9320
+ }> | undefined;
9321
+ fallback_climate_preset_key?: (string | null) | undefined;
9322
+ active_thermostat_schedule?: ({
9323
+ thermostat_schedule_id: string;
8845
9324
  device_id: string;
8846
9325
  name?: string | undefined;
8847
- schedule_starts_at: string;
8848
- schedule_ends_at: string;
9326
+ climate_preset_key: string;
9327
+ max_override_period_minutes?: number;
9328
+ starts_at: string;
9329
+ ends_at: string;
8849
9330
  created_at: string;
8850
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9331
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8851
9332
  errors?: any;
8852
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
8853
- cooling_set_point_celsius?: (number | undefined) | undefined;
8854
- heating_set_point_celsius?: (number | undefined) | undefined;
8855
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8856
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
8857
- manual_override_allowed?: boolean | undefined;
8858
- } | undefined;
9333
+ } | null) | undefined;
8859
9334
  min_cooling_set_point_celsius?: number | undefined;
8860
9335
  min_cooling_set_point_fahrenheit?: number | undefined;
8861
9336
  max_cooling_set_point_celsius?: number | undefined;
@@ -9214,42 +9689,67 @@ export interface Routes {
9214
9689
  is_heating?: boolean | undefined;
9215
9690
  is_cooling?: boolean | undefined;
9216
9691
  is_fan_running?: boolean | undefined;
9692
+ /**
9693
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9217
9694
  fan_mode_setting?: ('auto' | 'on') | undefined;
9218
9695
  is_temporary_manual_override_active?: boolean | undefined;
9219
9696
  current_climate_setting?: {
9220
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9221
- cooling_set_point_celsius?: number | undefined;
9222
- heating_set_point_celsius?: number | undefined;
9223
- cooling_set_point_fahrenheit?: number | undefined;
9224
- heating_set_point_fahrenheit?: number | undefined;
9225
- manual_override_allowed: boolean;
9697
+ climate_preset_key?: string | undefined;
9698
+ can_edit?: boolean | undefined;
9699
+ can_delete?: boolean | undefined;
9700
+ name?: (string | null) | undefined;
9701
+ display_name?: string | undefined;
9702
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9703
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9704
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9705
+ heating_set_point_celsius?: (number | undefined) | undefined;
9706
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9707
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9708
+ manual_override_allowed?: boolean | undefined;
9226
9709
  } | undefined;
9710
+ /**
9711
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9227
9712
  default_climate_setting?: {
9228
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9713
+ climate_preset_key?: string | undefined;
9714
+ can_edit?: boolean | undefined;
9715
+ can_delete?: boolean | undefined;
9716
+ name?: (string | null) | undefined;
9717
+ display_name?: string | undefined;
9718
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9719
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9720
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9721
+ heating_set_point_celsius?: (number | undefined) | undefined;
9722
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9723
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9724
+ manual_override_allowed?: boolean | undefined;
9725
+ } | undefined;
9726
+ available_climate_presets?: Array<{
9727
+ climate_preset_key: string;
9728
+ can_edit: boolean;
9729
+ can_delete: boolean;
9730
+ name: string | null;
9731
+ display_name: string;
9732
+ fan_mode_setting?: ('auto' | 'on') | undefined;
9733
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
9229
9734
  cooling_set_point_celsius?: number | undefined;
9230
9735
  heating_set_point_celsius?: number | undefined;
9231
9736
  cooling_set_point_fahrenheit?: number | undefined;
9232
9737
  heating_set_point_fahrenheit?: number | undefined;
9233
9738
  manual_override_allowed: boolean;
9234
- } | undefined;
9235
- is_climate_setting_schedule_active?: boolean | undefined;
9236
- active_climate_setting_schedule?: {
9237
- climate_setting_schedule_id: string;
9238
- schedule_type: 'time_bound';
9739
+ }> | undefined;
9740
+ fallback_climate_preset_key?: (string | null) | undefined;
9741
+ active_thermostat_schedule?: ({
9742
+ thermostat_schedule_id: string;
9239
9743
  device_id: string;
9240
9744
  name?: string | undefined;
9241
- schedule_starts_at: string;
9242
- schedule_ends_at: string;
9745
+ climate_preset_key: string;
9746
+ max_override_period_minutes?: number;
9747
+ starts_at: string;
9748
+ ends_at: string;
9243
9749
  created_at: string;
9244
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9750
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9245
9751
  errors?: any;
9246
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
9247
- cooling_set_point_celsius?: (number | undefined) | undefined;
9248
- heating_set_point_celsius?: (number | undefined) | undefined;
9249
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9250
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
9251
- manual_override_allowed?: boolean | undefined;
9252
- } | undefined;
9752
+ } | null) | undefined;
9253
9753
  min_cooling_set_point_celsius?: number | undefined;
9254
9754
  min_cooling_set_point_fahrenheit?: number | undefined;
9255
9755
  max_cooling_set_point_celsius?: number | undefined;
@@ -9520,14 +10020,38 @@ export interface Routes {
9520
10020
  status: 'pending';
9521
10021
  result: null;
9522
10022
  error: null;
9523
- action_type: 'SYNC_ACCESS_CODES';
10023
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
9524
10024
  } | {
9525
10025
  /** The ID of the action attempt. */
9526
10026
  action_attempt_id: string;
9527
10027
  status: 'success';
9528
10028
  error: null;
9529
- action_type: 'SYNC_ACCESS_CODES';
9530
- result?: any;
10029
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10030
+ result: {};
10031
+ } | {
10032
+ /** The ID of the action attempt. */
10033
+ action_attempt_id: string;
10034
+ status: 'error';
10035
+ result: null;
10036
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10037
+ error: {
10038
+ type: string;
10039
+ message: string;
10040
+ };
10041
+ } | {
10042
+ /** The ID of the action attempt. */
10043
+ action_attempt_id: string;
10044
+ status: 'pending';
10045
+ result: null;
10046
+ error: null;
10047
+ action_type: 'SYNC_ACCESS_CODES';
10048
+ } | {
10049
+ /** The ID of the action attempt. */
10050
+ action_attempt_id: string;
10051
+ status: 'success';
10052
+ error: null;
10053
+ action_type: 'SYNC_ACCESS_CODES';
10054
+ result?: any;
9531
10055
  } | {
9532
10056
  /** The ID of the action attempt. */
9533
10057
  action_attempt_id: string;
@@ -9898,6 +10422,30 @@ export interface Routes {
9898
10422
  type: string;
9899
10423
  message: string;
9900
10424
  };
10425
+ } | {
10426
+ /** The ID of the action attempt. */
10427
+ action_attempt_id: string;
10428
+ status: 'pending';
10429
+ result: null;
10430
+ error: null;
10431
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10432
+ } | {
10433
+ /** The ID of the action attempt. */
10434
+ action_attempt_id: string;
10435
+ status: 'success';
10436
+ error: null;
10437
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10438
+ result: {};
10439
+ } | {
10440
+ /** The ID of the action attempt. */
10441
+ action_attempt_id: string;
10442
+ status: 'error';
10443
+ result: null;
10444
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10445
+ error: {
10446
+ type: string;
10447
+ message: string;
10448
+ };
9901
10449
  } | {
9902
10450
  /** The ID of the action attempt. */
9903
10451
  action_attempt_id: string;
@@ -10321,6 +10869,30 @@ export interface Routes {
10321
10869
  type: string;
10322
10870
  message: string;
10323
10871
  };
10872
+ } | {
10873
+ /** The ID of the action attempt. */
10874
+ action_attempt_id: string;
10875
+ status: 'pending';
10876
+ result: null;
10877
+ error: null;
10878
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10879
+ } | {
10880
+ /** The ID of the action attempt. */
10881
+ action_attempt_id: string;
10882
+ status: 'success';
10883
+ error: null;
10884
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10885
+ result: {};
10886
+ } | {
10887
+ /** The ID of the action attempt. */
10888
+ action_attempt_id: string;
10889
+ status: 'error';
10890
+ result: null;
10891
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10892
+ error: {
10893
+ type: string;
10894
+ message: string;
10895
+ };
10324
10896
  } | {
10325
10897
  /** The ID of the action attempt. */
10326
10898
  action_attempt_id: string;
@@ -10653,173 +11225,422 @@ export interface Routes {
10653
11225
  /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
10654
11226
  warnings: Array<{
10655
11227
  message: string;
10656
- warning_code: string;
10657
- }>;
10658
- /** Date and time at which the device object was created. */
10659
- created_at: string;
10660
- /** Indicates whether Seam manages the device. */
10661
- is_managed: true;
10662
- custom_metadata: Record<string, string | boolean>;
10663
- can_remotely_unlock?: boolean | undefined;
10664
- can_remotely_lock?: boolean | undefined;
10665
- can_program_offline_access_codes?: boolean | undefined;
10666
- can_program_online_access_codes?: boolean | undefined;
10667
- can_hvac_heat?: boolean | undefined;
10668
- can_hvac_cool?: boolean | undefined;
10669
- can_hvac_heat_cool?: boolean | undefined;
10670
- can_turn_off_hvac?: boolean | undefined;
10671
- can_simulate_removal?: boolean | undefined;
10672
- can_simulate_connection?: boolean | undefined;
10673
- can_simulate_disconnection?: boolean | undefined;
10674
- };
10675
- };
10676
- };
10677
- '/thermostats/climate_setting_schedules/create': {
10678
- route: '/thermostats/climate_setting_schedules/create';
10679
- method: 'POST';
10680
- queryParams: {};
10681
- jsonBody: {
10682
- schedule_type?: 'time_bound';
10683
- device_id: string;
10684
- name?: string | undefined;
10685
- schedule_starts_at: string;
10686
- schedule_ends_at: string;
10687
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10688
- cooling_set_point_celsius?: (number | undefined) | undefined;
10689
- heating_set_point_celsius?: (number | undefined) | undefined;
10690
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10691
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10692
- manual_override_allowed?: boolean | undefined;
10693
- };
10694
- commonParams: {};
10695
- formData: {};
10696
- jsonResponse: {
10697
- climate_setting_schedule: {
10698
- climate_setting_schedule_id: string;
10699
- schedule_type: 'time_bound';
10700
- device_id: string;
10701
- name?: string | undefined;
10702
- schedule_starts_at: string;
10703
- schedule_ends_at: string;
10704
- created_at: string;
10705
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10706
- errors?: any;
10707
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10708
- cooling_set_point_celsius?: (number | undefined) | undefined;
10709
- heating_set_point_celsius?: (number | undefined) | undefined;
10710
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10711
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10712
- manual_override_allowed?: boolean | undefined;
10713
- };
10714
- };
10715
- };
10716
- '/thermostats/climate_setting_schedules/delete': {
10717
- route: '/thermostats/climate_setting_schedules/delete';
10718
- method: 'DELETE' | 'POST' | 'PUT';
10719
- queryParams: {};
10720
- jsonBody: {};
10721
- commonParams: {
10722
- climate_setting_schedule_id: string;
10723
- };
10724
- formData: {};
10725
- jsonResponse: {};
10726
- };
10727
- '/thermostats/climate_setting_schedules/get': {
10728
- route: '/thermostats/climate_setting_schedules/get';
10729
- method: 'GET' | 'POST';
10730
- queryParams: {};
10731
- jsonBody: {};
10732
- commonParams: {
10733
- climate_setting_schedule_id?: string | undefined;
10734
- device_id?: string | undefined;
10735
- };
10736
- formData: {};
10737
- jsonResponse: {
10738
- climate_setting_schedule: {
10739
- climate_setting_schedule_id: string;
10740
- schedule_type: 'time_bound';
10741
- device_id: string;
10742
- name?: string | undefined;
10743
- schedule_starts_at: string;
10744
- schedule_ends_at: string;
10745
- created_at: string;
10746
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10747
- errors?: any;
10748
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10749
- cooling_set_point_celsius?: (number | undefined) | undefined;
10750
- heating_set_point_celsius?: (number | undefined) | undefined;
10751
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10752
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10753
- manual_override_allowed?: boolean | undefined;
10754
- };
10755
- };
10756
- };
10757
- '/thermostats/climate_setting_schedules/list': {
10758
- route: '/thermostats/climate_setting_schedules/list';
10759
- method: 'GET' | 'POST';
10760
- queryParams: {};
10761
- jsonBody: {};
10762
- commonParams: {
10763
- device_id: string;
10764
- user_identifier_key?: string | undefined;
10765
- };
10766
- formData: {};
10767
- jsonResponse: {
10768
- climate_setting_schedules: Array<{
10769
- climate_setting_schedule_id: string;
10770
- schedule_type: 'time_bound';
10771
- device_id: string;
10772
- name?: string | undefined;
10773
- schedule_starts_at: string;
10774
- schedule_ends_at: string;
10775
- created_at: string;
10776
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10777
- errors?: any;
10778
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10779
- cooling_set_point_celsius?: (number | undefined) | undefined;
10780
- heating_set_point_celsius?: (number | undefined) | undefined;
10781
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10782
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10783
- manual_override_allowed?: boolean | undefined;
10784
- }>;
10785
- };
10786
- };
10787
- '/thermostats/climate_setting_schedules/update': {
10788
- route: '/thermostats/climate_setting_schedules/update';
10789
- method: 'PATCH' | 'POST' | 'PUT';
10790
- queryParams: {};
10791
- jsonBody: {
10792
- climate_setting_schedule_id: string;
10793
- schedule_type?: 'time_bound';
10794
- name?: string | undefined;
10795
- schedule_starts_at?: string | undefined;
10796
- schedule_ends_at?: string | undefined;
10797
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10798
- cooling_set_point_celsius?: (number | undefined) | undefined;
10799
- heating_set_point_celsius?: (number | undefined) | undefined;
10800
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10801
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10802
- manual_override_allowed?: boolean | undefined;
10803
- };
10804
- commonParams: {};
10805
- formData: {};
10806
- jsonResponse: {
10807
- climate_setting_schedule: {
10808
- climate_setting_schedule_id: string;
10809
- schedule_type: 'time_bound';
10810
- device_id: string;
10811
- name?: string | undefined;
10812
- schedule_starts_at: string;
10813
- schedule_ends_at: string;
10814
- created_at: string;
10815
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10816
- errors?: any;
10817
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10818
- cooling_set_point_celsius?: (number | undefined) | undefined;
10819
- heating_set_point_celsius?: (number | undefined) | undefined;
10820
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10821
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10822
- manual_override_allowed?: boolean | undefined;
11228
+ warning_code: string;
11229
+ }>;
11230
+ /** Date and time at which the device object was created. */
11231
+ created_at: string;
11232
+ /** Indicates whether Seam manages the device. */
11233
+ is_managed: true;
11234
+ custom_metadata: Record<string, string | boolean>;
11235
+ can_remotely_unlock?: boolean | undefined;
11236
+ can_remotely_lock?: boolean | undefined;
11237
+ can_program_offline_access_codes?: boolean | undefined;
11238
+ can_program_online_access_codes?: boolean | undefined;
11239
+ can_hvac_heat?: boolean | undefined;
11240
+ can_hvac_cool?: boolean | undefined;
11241
+ can_hvac_heat_cool?: boolean | undefined;
11242
+ can_turn_off_hvac?: boolean | undefined;
11243
+ can_simulate_removal?: boolean | undefined;
11244
+ can_simulate_connection?: boolean | undefined;
11245
+ can_simulate_disconnection?: boolean | undefined;
11246
+ };
11247
+ };
11248
+ };
11249
+ '/thermostats/activate_climate_preset': {
11250
+ route: '/thermostats/activate_climate_preset';
11251
+ method: 'POST';
11252
+ queryParams: {};
11253
+ jsonBody: {
11254
+ device_id: string;
11255
+ climate_preset_key: string;
11256
+ };
11257
+ commonParams: {};
11258
+ formData: {};
11259
+ jsonResponse: {
11260
+ action_attempt: {
11261
+ /** The ID of the action attempt. */
11262
+ action_attempt_id: string;
11263
+ status: 'pending';
11264
+ result: null;
11265
+ error: null;
11266
+ action_type: 'LOCK_DOOR';
11267
+ } | {
11268
+ /** The ID of the action attempt. */
11269
+ action_attempt_id: string;
11270
+ status: 'success';
11271
+ error: null;
11272
+ action_type: 'LOCK_DOOR';
11273
+ result: {};
11274
+ } | {
11275
+ /** The ID of the action attempt. */
11276
+ action_attempt_id: string;
11277
+ status: 'error';
11278
+ result: null;
11279
+ action_type: 'LOCK_DOOR';
11280
+ error: {
11281
+ type: string;
11282
+ message: string;
11283
+ };
11284
+ } | {
11285
+ /** The ID of the action attempt. */
11286
+ action_attempt_id: string;
11287
+ status: 'pending';
11288
+ result: null;
11289
+ error: null;
11290
+ action_type: 'UNLOCK_DOOR';
11291
+ } | {
11292
+ /** The ID of the action attempt. */
11293
+ action_attempt_id: string;
11294
+ status: 'success';
11295
+ error: null;
11296
+ action_type: 'UNLOCK_DOOR';
11297
+ result: {};
11298
+ } | {
11299
+ /** The ID of the action attempt. */
11300
+ action_attempt_id: string;
11301
+ status: 'error';
11302
+ result: null;
11303
+ action_type: 'UNLOCK_DOOR';
11304
+ error: {
11305
+ type: string;
11306
+ message: string;
11307
+ };
11308
+ } | {
11309
+ /** The ID of the action attempt. */
11310
+ action_attempt_id: string;
11311
+ status: 'pending';
11312
+ result: null;
11313
+ error: null;
11314
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11315
+ } | {
11316
+ /** The ID of the action attempt. */
11317
+ action_attempt_id: string;
11318
+ status: 'success';
11319
+ error: null;
11320
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11321
+ result: {};
11322
+ } | {
11323
+ /** The ID of the action attempt. */
11324
+ action_attempt_id: string;
11325
+ status: 'error';
11326
+ result: null;
11327
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11328
+ error: {
11329
+ type: string;
11330
+ message: string;
11331
+ };
11332
+ } | {
11333
+ /** The ID of the action attempt. */
11334
+ action_attempt_id: string;
11335
+ status: 'pending';
11336
+ result: null;
11337
+ error: null;
11338
+ action_type: 'SET_COOL';
11339
+ } | {
11340
+ /** The ID of the action attempt. */
11341
+ action_attempt_id: string;
11342
+ status: 'success';
11343
+ error: null;
11344
+ action_type: 'SET_COOL';
11345
+ result: {};
11346
+ } | {
11347
+ /** The ID of the action attempt. */
11348
+ action_attempt_id: string;
11349
+ status: 'error';
11350
+ result: null;
11351
+ action_type: 'SET_COOL';
11352
+ error: {
11353
+ type: string;
11354
+ message: string;
11355
+ };
11356
+ } | {
11357
+ /** The ID of the action attempt. */
11358
+ action_attempt_id: string;
11359
+ status: 'pending';
11360
+ result: null;
11361
+ error: null;
11362
+ action_type: 'SET_HEAT';
11363
+ } | {
11364
+ /** The ID of the action attempt. */
11365
+ action_attempt_id: string;
11366
+ status: 'success';
11367
+ error: null;
11368
+ action_type: 'SET_HEAT';
11369
+ result: {};
11370
+ } | {
11371
+ /** The ID of the action attempt. */
11372
+ action_attempt_id: string;
11373
+ status: 'error';
11374
+ result: null;
11375
+ action_type: 'SET_HEAT';
11376
+ error: {
11377
+ type: string;
11378
+ message: string;
11379
+ };
11380
+ } | {
11381
+ /** The ID of the action attempt. */
11382
+ action_attempt_id: string;
11383
+ status: 'pending';
11384
+ result: null;
11385
+ error: null;
11386
+ action_type: 'SET_HEAT_COOL';
11387
+ } | {
11388
+ /** The ID of the action attempt. */
11389
+ action_attempt_id: string;
11390
+ status: 'success';
11391
+ error: null;
11392
+ action_type: 'SET_HEAT_COOL';
11393
+ result: {};
11394
+ } | {
11395
+ /** The ID of the action attempt. */
11396
+ action_attempt_id: string;
11397
+ status: 'error';
11398
+ result: null;
11399
+ action_type: 'SET_HEAT_COOL';
11400
+ error: {
11401
+ type: string;
11402
+ message: string;
11403
+ };
11404
+ } | {
11405
+ /** The ID of the action attempt. */
11406
+ action_attempt_id: string;
11407
+ status: 'pending';
11408
+ result: null;
11409
+ error: null;
11410
+ action_type: 'SET_FAN_MODE';
11411
+ } | {
11412
+ /** The ID of the action attempt. */
11413
+ action_attempt_id: string;
11414
+ status: 'success';
11415
+ error: null;
11416
+ action_type: 'SET_FAN_MODE';
11417
+ result: {};
11418
+ } | {
11419
+ /** The ID of the action attempt. */
11420
+ action_attempt_id: string;
11421
+ status: 'error';
11422
+ result: null;
11423
+ action_type: 'SET_FAN_MODE';
11424
+ error: {
11425
+ type: string;
11426
+ message: string;
11427
+ };
11428
+ } | {
11429
+ /** The ID of the action attempt. */
11430
+ action_attempt_id: string;
11431
+ status: 'pending';
11432
+ result: null;
11433
+ error: null;
11434
+ action_type: 'SET_THERMOSTAT_OFF';
11435
+ } | {
11436
+ /** The ID of the action attempt. */
11437
+ action_attempt_id: string;
11438
+ status: 'success';
11439
+ error: null;
11440
+ action_type: 'SET_THERMOSTAT_OFF';
11441
+ result: {};
11442
+ } | {
11443
+ /** The ID of the action attempt. */
11444
+ action_attempt_id: string;
11445
+ status: 'error';
11446
+ result: null;
11447
+ action_type: 'SET_THERMOSTAT_OFF';
11448
+ error: {
11449
+ type: string;
11450
+ message: string;
11451
+ };
11452
+ } | {
11453
+ /** The ID of the action attempt. */
11454
+ action_attempt_id: string;
11455
+ status: 'pending';
11456
+ result: null;
11457
+ error: null;
11458
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11459
+ } | {
11460
+ /** The ID of the action attempt. */
11461
+ action_attempt_id: string;
11462
+ status: 'success';
11463
+ error: null;
11464
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11465
+ result: {};
11466
+ } | {
11467
+ /** The ID of the action attempt. */
11468
+ action_attempt_id: string;
11469
+ status: 'error';
11470
+ result: null;
11471
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11472
+ error: {
11473
+ type: string;
11474
+ message: string;
11475
+ };
11476
+ } | {
11477
+ /** The ID of the action attempt. */
11478
+ action_attempt_id: string;
11479
+ status: 'pending';
11480
+ result: null;
11481
+ error: null;
11482
+ action_type: 'SYNC_ACCESS_CODES';
11483
+ } | {
11484
+ /** The ID of the action attempt. */
11485
+ action_attempt_id: string;
11486
+ status: 'success';
11487
+ error: null;
11488
+ action_type: 'SYNC_ACCESS_CODES';
11489
+ result?: any;
11490
+ } | {
11491
+ /** The ID of the action attempt. */
11492
+ action_attempt_id: string;
11493
+ status: 'error';
11494
+ result: null;
11495
+ action_type: 'SYNC_ACCESS_CODES';
11496
+ error: {
11497
+ type: string;
11498
+ message: string;
11499
+ };
11500
+ } | {
11501
+ /** The ID of the action attempt. */
11502
+ action_attempt_id: string;
11503
+ status: 'pending';
11504
+ result: null;
11505
+ error: null;
11506
+ action_type: 'CREATE_ACCESS_CODE';
11507
+ } | {
11508
+ /** The ID of the action attempt. */
11509
+ action_attempt_id: string;
11510
+ status: 'success';
11511
+ error: null;
11512
+ action_type: 'CREATE_ACCESS_CODE';
11513
+ result?: any;
11514
+ } | {
11515
+ /** The ID of the action attempt. */
11516
+ action_attempt_id: string;
11517
+ status: 'error';
11518
+ result: null;
11519
+ action_type: 'CREATE_ACCESS_CODE';
11520
+ error: {
11521
+ type: string;
11522
+ message: string;
11523
+ };
11524
+ } | {
11525
+ /** The ID of the action attempt. */
11526
+ action_attempt_id: string;
11527
+ status: 'pending';
11528
+ result: null;
11529
+ error: null;
11530
+ action_type: 'DELETE_ACCESS_CODE';
11531
+ } | {
11532
+ /** The ID of the action attempt. */
11533
+ action_attempt_id: string;
11534
+ status: 'success';
11535
+ error: null;
11536
+ action_type: 'DELETE_ACCESS_CODE';
11537
+ result?: any;
11538
+ } | {
11539
+ /** The ID of the action attempt. */
11540
+ action_attempt_id: string;
11541
+ status: 'error';
11542
+ result: null;
11543
+ action_type: 'DELETE_ACCESS_CODE';
11544
+ error: {
11545
+ type: string;
11546
+ message: string;
11547
+ };
11548
+ } | {
11549
+ /** The ID of the action attempt. */
11550
+ action_attempt_id: string;
11551
+ status: 'pending';
11552
+ result: null;
11553
+ error: null;
11554
+ action_type: 'UPDATE_ACCESS_CODE';
11555
+ } | {
11556
+ /** The ID of the action attempt. */
11557
+ action_attempt_id: string;
11558
+ status: 'success';
11559
+ error: null;
11560
+ action_type: 'UPDATE_ACCESS_CODE';
11561
+ result?: any;
11562
+ } | {
11563
+ /** The ID of the action attempt. */
11564
+ action_attempt_id: string;
11565
+ status: 'error';
11566
+ result: null;
11567
+ action_type: 'UPDATE_ACCESS_CODE';
11568
+ error: {
11569
+ type: string;
11570
+ message: string;
11571
+ };
11572
+ } | {
11573
+ /** The ID of the action attempt. */
11574
+ action_attempt_id: string;
11575
+ status: 'pending';
11576
+ result: null;
11577
+ error: null;
11578
+ action_type: 'CREATE_NOISE_THRESHOLD';
11579
+ } | {
11580
+ /** The ID of the action attempt. */
11581
+ action_attempt_id: string;
11582
+ status: 'success';
11583
+ error: null;
11584
+ action_type: 'CREATE_NOISE_THRESHOLD';
11585
+ result?: any;
11586
+ } | {
11587
+ /** The ID of the action attempt. */
11588
+ action_attempt_id: string;
11589
+ status: 'error';
11590
+ result: null;
11591
+ action_type: 'CREATE_NOISE_THRESHOLD';
11592
+ error: {
11593
+ type: string;
11594
+ message: string;
11595
+ };
11596
+ } | {
11597
+ /** The ID of the action attempt. */
11598
+ action_attempt_id: string;
11599
+ status: 'pending';
11600
+ result: null;
11601
+ error: null;
11602
+ action_type: 'DELETE_NOISE_THRESHOLD';
11603
+ } | {
11604
+ /** The ID of the action attempt. */
11605
+ action_attempt_id: string;
11606
+ status: 'success';
11607
+ error: null;
11608
+ action_type: 'DELETE_NOISE_THRESHOLD';
11609
+ result?: any;
11610
+ } | {
11611
+ /** The ID of the action attempt. */
11612
+ action_attempt_id: string;
11613
+ status: 'error';
11614
+ result: null;
11615
+ action_type: 'DELETE_NOISE_THRESHOLD';
11616
+ error: {
11617
+ type: string;
11618
+ message: string;
11619
+ };
11620
+ } | {
11621
+ /** The ID of the action attempt. */
11622
+ action_attempt_id: string;
11623
+ status: 'pending';
11624
+ result: null;
11625
+ error: null;
11626
+ action_type: 'UPDATE_NOISE_THRESHOLD';
11627
+ } | {
11628
+ /** The ID of the action attempt. */
11629
+ action_attempt_id: string;
11630
+ status: 'success';
11631
+ error: null;
11632
+ action_type: 'UPDATE_NOISE_THRESHOLD';
11633
+ result?: any;
11634
+ } | {
11635
+ /** The ID of the action attempt. */
11636
+ action_attempt_id: string;
11637
+ status: 'error';
11638
+ result: null;
11639
+ action_type: 'UPDATE_NOISE_THRESHOLD';
11640
+ error: {
11641
+ type: string;
11642
+ message: string;
11643
+ };
10823
11644
  };
10824
11645
  };
10825
11646
  };
@@ -11028,6 +11849,30 @@ export interface Routes {
11028
11849
  type: string;
11029
11850
  message: string;
11030
11851
  };
11852
+ } | {
11853
+ /** The ID of the action attempt. */
11854
+ action_attempt_id: string;
11855
+ status: 'pending';
11856
+ result: null;
11857
+ error: null;
11858
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11859
+ } | {
11860
+ /** The ID of the action attempt. */
11861
+ action_attempt_id: string;
11862
+ status: 'success';
11863
+ error: null;
11864
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11865
+ result: {};
11866
+ } | {
11867
+ /** The ID of the action attempt. */
11868
+ action_attempt_id: string;
11869
+ status: 'error';
11870
+ result: null;
11871
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11872
+ error: {
11873
+ type: string;
11874
+ message: string;
11875
+ };
11031
11876
  } | {
11032
11877
  /** The ID of the action attempt. */
11033
11878
  action_attempt_id: string;
@@ -11199,6 +12044,53 @@ export interface Routes {
11199
12044
  };
11200
12045
  };
11201
12046
  };
12047
+ '/thermostats/create_climate_preset': {
12048
+ route: '/thermostats/create_climate_preset';
12049
+ method: 'POST';
12050
+ queryParams: {};
12051
+ jsonBody: {
12052
+ device_id: string;
12053
+ climate_preset_key: string;
12054
+ name: string | null;
12055
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12056
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12057
+ cooling_set_point_celsius?: number | undefined;
12058
+ heating_set_point_celsius?: number | undefined;
12059
+ cooling_set_point_fahrenheit?: number | undefined;
12060
+ heating_set_point_fahrenheit?: number | undefined;
12061
+ manual_override_allowed: boolean;
12062
+ };
12063
+ commonParams: {};
12064
+ formData: {};
12065
+ jsonResponse: {
12066
+ climate_preset: {
12067
+ climate_preset_key: string;
12068
+ can_edit: boolean;
12069
+ can_delete: boolean;
12070
+ name: string | null;
12071
+ display_name: string;
12072
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12073
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12074
+ cooling_set_point_celsius?: number | undefined;
12075
+ heating_set_point_celsius?: number | undefined;
12076
+ cooling_set_point_fahrenheit?: number | undefined;
12077
+ heating_set_point_fahrenheit?: number | undefined;
12078
+ manual_override_allowed: boolean;
12079
+ };
12080
+ };
12081
+ };
12082
+ '/thermostats/delete_climate_preset': {
12083
+ route: '/thermostats/delete_climate_preset';
12084
+ method: 'POST' | 'DELETE';
12085
+ queryParams: {};
12086
+ jsonBody: {
12087
+ device_id: string;
12088
+ climate_preset_key: string;
12089
+ };
12090
+ commonParams: {};
12091
+ formData: {};
12092
+ jsonResponse: {};
12093
+ };
11202
12094
  '/thermostats/get': {
11203
12095
  route: '/thermostats/get';
11204
12096
  method: 'GET' | 'POST';
@@ -11514,42 +12406,67 @@ export interface Routes {
11514
12406
  is_heating?: boolean | undefined;
11515
12407
  is_cooling?: boolean | undefined;
11516
12408
  is_fan_running?: boolean | undefined;
12409
+ /**
12410
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
11517
12411
  fan_mode_setting?: ('auto' | 'on') | undefined;
11518
12412
  is_temporary_manual_override_active?: boolean | undefined;
11519
12413
  current_climate_setting?: {
11520
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11521
- cooling_set_point_celsius?: number | undefined;
11522
- heating_set_point_celsius?: number | undefined;
11523
- cooling_set_point_fahrenheit?: number | undefined;
11524
- heating_set_point_fahrenheit?: number | undefined;
11525
- manual_override_allowed: boolean;
12414
+ climate_preset_key?: string | undefined;
12415
+ can_edit?: boolean | undefined;
12416
+ can_delete?: boolean | undefined;
12417
+ name?: (string | null) | undefined;
12418
+ display_name?: string | undefined;
12419
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
12420
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12421
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12422
+ heating_set_point_celsius?: (number | undefined) | undefined;
12423
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12424
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12425
+ manual_override_allowed?: boolean | undefined;
11526
12426
  } | undefined;
12427
+ /**
12428
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11527
12429
  default_climate_setting?: {
11528
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12430
+ climate_preset_key?: string | undefined;
12431
+ can_edit?: boolean | undefined;
12432
+ can_delete?: boolean | undefined;
12433
+ name?: (string | null) | undefined;
12434
+ display_name?: string | undefined;
12435
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
12436
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12437
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12438
+ heating_set_point_celsius?: (number | undefined) | undefined;
12439
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12440
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12441
+ manual_override_allowed?: boolean | undefined;
12442
+ } | undefined;
12443
+ available_climate_presets?: Array<{
12444
+ climate_preset_key: string;
12445
+ can_edit: boolean;
12446
+ can_delete: boolean;
12447
+ name: string | null;
12448
+ display_name: string;
12449
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12450
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11529
12451
  cooling_set_point_celsius?: number | undefined;
11530
12452
  heating_set_point_celsius?: number | undefined;
11531
12453
  cooling_set_point_fahrenheit?: number | undefined;
11532
12454
  heating_set_point_fahrenheit?: number | undefined;
11533
12455
  manual_override_allowed: boolean;
11534
- } | undefined;
11535
- is_climate_setting_schedule_active?: boolean | undefined;
11536
- active_climate_setting_schedule?: {
11537
- climate_setting_schedule_id: string;
11538
- schedule_type: 'time_bound';
12456
+ }> | undefined;
12457
+ fallback_climate_preset_key?: (string | null) | undefined;
12458
+ active_thermostat_schedule?: ({
12459
+ thermostat_schedule_id: string;
11539
12460
  device_id: string;
11540
12461
  name?: string | undefined;
11541
- schedule_starts_at: string;
11542
- schedule_ends_at: string;
12462
+ climate_preset_key: string;
12463
+ max_override_period_minutes?: number;
12464
+ starts_at: string;
12465
+ ends_at: string;
11543
12466
  created_at: string;
11544
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12467
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
11545
12468
  errors?: any;
11546
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11547
- cooling_set_point_celsius?: (number | undefined) | undefined;
11548
- heating_set_point_celsius?: (number | undefined) | undefined;
11549
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11550
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
11551
- manual_override_allowed?: boolean | undefined;
11552
- } | undefined;
12469
+ } | null) | undefined;
11553
12470
  min_cooling_set_point_celsius?: number | undefined;
11554
12471
  min_cooling_set_point_fahrenheit?: number | undefined;
11555
12472
  max_cooling_set_point_celsius?: number | undefined;
@@ -11811,6 +12728,30 @@ export interface Routes {
11811
12728
  type: string;
11812
12729
  message: string;
11813
12730
  };
12731
+ } | {
12732
+ /** The ID of the action attempt. */
12733
+ action_attempt_id: string;
12734
+ status: 'pending';
12735
+ result: null;
12736
+ error: null;
12737
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12738
+ } | {
12739
+ /** The ID of the action attempt. */
12740
+ action_attempt_id: string;
12741
+ status: 'success';
12742
+ error: null;
12743
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12744
+ result: {};
12745
+ } | {
12746
+ /** The ID of the action attempt. */
12747
+ action_attempt_id: string;
12748
+ status: 'error';
12749
+ result: null;
12750
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12751
+ error: {
12752
+ type: string;
12753
+ message: string;
12754
+ };
11814
12755
  } | {
11815
12756
  /** The ID of the action attempt. */
11816
12757
  action_attempt_id: string;
@@ -12189,6 +13130,30 @@ export interface Routes {
12189
13130
  type: string;
12190
13131
  message: string;
12191
13132
  };
13133
+ } | {
13134
+ /** The ID of the action attempt. */
13135
+ action_attempt_id: string;
13136
+ status: 'pending';
13137
+ result: null;
13138
+ error: null;
13139
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13140
+ } | {
13141
+ /** The ID of the action attempt. */
13142
+ action_attempt_id: string;
13143
+ status: 'success';
13144
+ error: null;
13145
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13146
+ result: {};
13147
+ } | {
13148
+ /** The ID of the action attempt. */
13149
+ action_attempt_id: string;
13150
+ status: 'error';
13151
+ result: null;
13152
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13153
+ error: {
13154
+ type: string;
13155
+ message: string;
13156
+ };
12192
13157
  } | {
12193
13158
  /** The ID of the action attempt. */
12194
13159
  action_attempt_id: string;
@@ -12687,42 +13652,67 @@ export interface Routes {
12687
13652
  is_heating?: boolean | undefined;
12688
13653
  is_cooling?: boolean | undefined;
12689
13654
  is_fan_running?: boolean | undefined;
13655
+ /**
13656
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
12690
13657
  fan_mode_setting?: ('auto' | 'on') | undefined;
12691
13658
  is_temporary_manual_override_active?: boolean | undefined;
12692
13659
  current_climate_setting?: {
12693
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12694
- cooling_set_point_celsius?: number | undefined;
12695
- heating_set_point_celsius?: number | undefined;
12696
- cooling_set_point_fahrenheit?: number | undefined;
12697
- heating_set_point_fahrenheit?: number | undefined;
12698
- manual_override_allowed: boolean;
13660
+ climate_preset_key?: string | undefined;
13661
+ can_edit?: boolean | undefined;
13662
+ can_delete?: boolean | undefined;
13663
+ name?: (string | null) | undefined;
13664
+ display_name?: string | undefined;
13665
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
13666
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
13667
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13668
+ heating_set_point_celsius?: (number | undefined) | undefined;
13669
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13670
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13671
+ manual_override_allowed?: boolean | undefined;
12699
13672
  } | undefined;
13673
+ /**
13674
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12700
13675
  default_climate_setting?: {
12701
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13676
+ climate_preset_key?: string | undefined;
13677
+ can_edit?: boolean | undefined;
13678
+ can_delete?: boolean | undefined;
13679
+ name?: (string | null) | undefined;
13680
+ display_name?: string | undefined;
13681
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
13682
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
13683
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13684
+ heating_set_point_celsius?: (number | undefined) | undefined;
13685
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13686
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13687
+ manual_override_allowed?: boolean | undefined;
13688
+ } | undefined;
13689
+ available_climate_presets?: Array<{
13690
+ climate_preset_key: string;
13691
+ can_edit: boolean;
13692
+ can_delete: boolean;
13693
+ name: string | null;
13694
+ display_name: string;
13695
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13696
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12702
13697
  cooling_set_point_celsius?: number | undefined;
12703
13698
  heating_set_point_celsius?: number | undefined;
12704
13699
  cooling_set_point_fahrenheit?: number | undefined;
12705
13700
  heating_set_point_fahrenheit?: number | undefined;
12706
13701
  manual_override_allowed: boolean;
12707
- } | undefined;
12708
- is_climate_setting_schedule_active?: boolean | undefined;
12709
- active_climate_setting_schedule?: {
12710
- climate_setting_schedule_id: string;
12711
- schedule_type: 'time_bound';
13702
+ }> | undefined;
13703
+ fallback_climate_preset_key?: (string | null) | undefined;
13704
+ active_thermostat_schedule?: ({
13705
+ thermostat_schedule_id: string;
12712
13706
  device_id: string;
12713
13707
  name?: string | undefined;
12714
- schedule_starts_at: string;
12715
- schedule_ends_at: string;
13708
+ climate_preset_key: string;
13709
+ max_override_period_minutes?: number;
13710
+ starts_at: string;
13711
+ ends_at: string;
12716
13712
  created_at: string;
12717
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
13713
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12718
13714
  errors?: any;
12719
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12720
- cooling_set_point_celsius?: (number | undefined) | undefined;
12721
- heating_set_point_celsius?: (number | undefined) | undefined;
12722
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12723
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
12724
- manual_override_allowed?: boolean | undefined;
12725
- } | undefined;
13715
+ } | null) | undefined;
12726
13716
  min_cooling_set_point_celsius?: number | undefined;
12727
13717
  min_cooling_set_point_fahrenheit?: number | undefined;
12728
13718
  max_cooling_set_point_celsius?: number | undefined;
@@ -12982,6 +13972,30 @@ export interface Routes {
12982
13972
  type: string;
12983
13973
  message: string;
12984
13974
  };
13975
+ } | {
13976
+ /** The ID of the action attempt. */
13977
+ action_attempt_id: string;
13978
+ status: 'pending';
13979
+ result: null;
13980
+ error: null;
13981
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13982
+ } | {
13983
+ /** The ID of the action attempt. */
13984
+ action_attempt_id: string;
13985
+ status: 'success';
13986
+ error: null;
13987
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13988
+ result: {};
13989
+ } | {
13990
+ /** The ID of the action attempt. */
13991
+ action_attempt_id: string;
13992
+ status: 'error';
13993
+ result: null;
13994
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13995
+ error: {
13996
+ type: string;
13997
+ message: string;
13998
+ };
12985
13999
  } | {
12986
14000
  /** The ID of the action attempt. */
12987
14001
  action_attempt_id: string;
@@ -13153,12 +14167,144 @@ export interface Routes {
13153
14167
  };
13154
14168
  };
13155
14169
  };
14170
+ '/thermostats/schedules/create': {
14171
+ route: '/thermostats/schedules/create';
14172
+ method: 'POST';
14173
+ queryParams: {};
14174
+ jsonBody: {
14175
+ device_id: string;
14176
+ name?: string | undefined;
14177
+ climate_preset_key: string;
14178
+ max_override_period_minutes?: number;
14179
+ starts_at: string;
14180
+ ends_at: string;
14181
+ };
14182
+ commonParams: {};
14183
+ formData: {};
14184
+ jsonResponse: {
14185
+ thermostat_schedule: {
14186
+ thermostat_schedule_id: string;
14187
+ device_id: string;
14188
+ name?: string | undefined;
14189
+ climate_preset_key: string;
14190
+ max_override_period_minutes?: number;
14191
+ starts_at: string;
14192
+ ends_at: string;
14193
+ created_at: string;
14194
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14195
+ errors?: any;
14196
+ };
14197
+ };
14198
+ };
14199
+ '/thermostats/schedules/delete': {
14200
+ route: '/thermostats/schedules/delete';
14201
+ method: 'DELETE' | 'POST';
14202
+ queryParams: {};
14203
+ jsonBody: {};
14204
+ commonParams: {
14205
+ thermostat_schedule_id: string;
14206
+ };
14207
+ formData: {};
14208
+ jsonResponse: {};
14209
+ };
14210
+ '/thermostats/schedules/get': {
14211
+ route: '/thermostats/schedules/get';
14212
+ method: 'GET' | 'POST';
14213
+ queryParams: {};
14214
+ jsonBody: {};
14215
+ commonParams: {
14216
+ thermostat_schedule_id: string;
14217
+ };
14218
+ formData: {};
14219
+ jsonResponse: {
14220
+ thermostat_schedule: {
14221
+ thermostat_schedule_id: string;
14222
+ device_id: string;
14223
+ name?: string | undefined;
14224
+ climate_preset_key: string;
14225
+ max_override_period_minutes?: number;
14226
+ starts_at: string;
14227
+ ends_at: string;
14228
+ created_at: string;
14229
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14230
+ errors?: any;
14231
+ };
14232
+ };
14233
+ };
14234
+ '/thermostats/schedules/list': {
14235
+ route: '/thermostats/schedules/list';
14236
+ method: 'GET' | 'POST';
14237
+ queryParams: {};
14238
+ jsonBody: {};
14239
+ commonParams: {
14240
+ device_id: string;
14241
+ user_identifier_key?: string | undefined;
14242
+ };
14243
+ formData: {};
14244
+ jsonResponse: {
14245
+ thermostat_schedules: Array<{
14246
+ thermostat_schedule_id: string;
14247
+ device_id: string;
14248
+ name?: string | undefined;
14249
+ climate_preset_key: string;
14250
+ max_override_period_minutes?: number;
14251
+ starts_at: string;
14252
+ ends_at: string;
14253
+ created_at: string;
14254
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14255
+ errors?: any;
14256
+ }>;
14257
+ };
14258
+ };
14259
+ '/thermostats/schedules/update': {
14260
+ route: '/thermostats/schedules/update';
14261
+ method: 'PATCH' | 'POST';
14262
+ queryParams: {};
14263
+ jsonBody: {
14264
+ thermostat_schedule_id: string;
14265
+ name?: string | undefined;
14266
+ climate_preset_key?: string | undefined;
14267
+ max_override_period_minutes?: number | undefined;
14268
+ starts_at?: string | undefined;
14269
+ ends_at?: string | undefined;
14270
+ };
14271
+ commonParams: {};
14272
+ formData: {};
14273
+ jsonResponse: {
14274
+ thermostat_schedule: {
14275
+ thermostat_schedule_id: string;
14276
+ device_id: string;
14277
+ name?: string | undefined;
14278
+ climate_preset_key: string;
14279
+ max_override_period_minutes?: number;
14280
+ starts_at: string;
14281
+ ends_at: string;
14282
+ created_at: string;
14283
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14284
+ errors?: any;
14285
+ };
14286
+ };
14287
+ };
14288
+ '/thermostats/set_fallback_climate_preset': {
14289
+ route: '/thermostats/set_fallback_climate_preset';
14290
+ method: 'POST';
14291
+ queryParams: {};
14292
+ jsonBody: {
14293
+ device_id: string;
14294
+ climate_preset_key: string;
14295
+ };
14296
+ commonParams: {};
14297
+ formData: {};
14298
+ jsonResponse: {};
14299
+ };
13156
14300
  '/thermostats/set_fan_mode': {
13157
14301
  route: '/thermostats/set_fan_mode';
13158
14302
  method: 'POST';
13159
14303
  queryParams: {};
13160
14304
  jsonBody: {
13161
14305
  device_id: string;
14306
+ /**
14307
+ * @deprecated use fan_mode_setting instead. */
13162
14308
  fan_mode?: ('auto' | 'on') | undefined;
13163
14309
  fan_mode_setting?: ('auto' | 'on') | undefined;
13164
14310
  sync?: boolean;
@@ -13358,6 +14504,30 @@ export interface Routes {
13358
14504
  type: string;
13359
14505
  message: string;
13360
14506
  };
14507
+ } | {
14508
+ /** The ID of the action attempt. */
14509
+ action_attempt_id: string;
14510
+ status: 'pending';
14511
+ result: null;
14512
+ error: null;
14513
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14514
+ } | {
14515
+ /** The ID of the action attempt. */
14516
+ action_attempt_id: string;
14517
+ status: 'success';
14518
+ error: null;
14519
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14520
+ result: {};
14521
+ } | {
14522
+ /** The ID of the action attempt. */
14523
+ action_attempt_id: string;
14524
+ status: 'error';
14525
+ result: null;
14526
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14527
+ error: {
14528
+ type: string;
14529
+ message: string;
14530
+ };
13361
14531
  } | {
13362
14532
  /** The ID of the action attempt. */
13363
14533
  action_attempt_id: string;
@@ -13529,24 +14699,40 @@ export interface Routes {
13529
14699
  };
13530
14700
  };
13531
14701
  };
13532
- '/thermostats/update': {
13533
- route: '/thermostats/update';
13534
- method: 'PATCH' | 'POST';
14702
+ '/thermostats/update_climate_preset': {
14703
+ route: '/thermostats/update_climate_preset';
14704
+ method: 'POST' | 'PATCH';
13535
14705
  queryParams: {};
13536
14706
  jsonBody: {
13537
14707
  device_id: string;
13538
- default_climate_setting: {
13539
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13540
- cooling_set_point_celsius?: (number | undefined) | undefined;
13541
- heating_set_point_celsius?: (number | undefined) | undefined;
13542
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13543
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
13544
- manual_override_allowed?: boolean | undefined;
13545
- };
14708
+ climate_preset_key: string;
14709
+ name: string | null;
14710
+ fan_mode_setting?: ('auto' | 'on') | undefined;
14711
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14712
+ cooling_set_point_celsius?: number | undefined;
14713
+ heating_set_point_celsius?: number | undefined;
14714
+ cooling_set_point_fahrenheit?: number | undefined;
14715
+ heating_set_point_fahrenheit?: number | undefined;
14716
+ manual_override_allowed: boolean;
13546
14717
  };
13547
14718
  commonParams: {};
13548
14719
  formData: {};
13549
- jsonResponse: {};
14720
+ jsonResponse: {
14721
+ climate_preset: {
14722
+ climate_preset_key: string;
14723
+ can_edit: boolean;
14724
+ can_delete: boolean;
14725
+ name: string | null;
14726
+ display_name: string;
14727
+ fan_mode_setting?: ('auto' | 'on') | undefined;
14728
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14729
+ cooling_set_point_celsius?: number | undefined;
14730
+ heating_set_point_celsius?: number | undefined;
14731
+ cooling_set_point_fahrenheit?: number | undefined;
14732
+ heating_set_point_fahrenheit?: number | undefined;
14733
+ manual_override_allowed: boolean;
14734
+ };
14735
+ };
13550
14736
  };
13551
14737
  '/user_identities/add_acs_user': {
13552
14738
  route: '/user_identities/add_acs_user';
@@ -14041,42 +15227,67 @@ export interface Routes {
14041
15227
  is_heating?: boolean | undefined;
14042
15228
  is_cooling?: boolean | undefined;
14043
15229
  is_fan_running?: boolean | undefined;
15230
+ /**
15231
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14044
15232
  fan_mode_setting?: ('auto' | 'on') | undefined;
14045
15233
  is_temporary_manual_override_active?: boolean | undefined;
14046
15234
  current_climate_setting?: {
14047
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14048
- cooling_set_point_celsius?: number | undefined;
14049
- heating_set_point_celsius?: number | undefined;
14050
- cooling_set_point_fahrenheit?: number | undefined;
14051
- heating_set_point_fahrenheit?: number | undefined;
14052
- manual_override_allowed: boolean;
15235
+ climate_preset_key?: string | undefined;
15236
+ can_edit?: boolean | undefined;
15237
+ can_delete?: boolean | undefined;
15238
+ name?: (string | null) | undefined;
15239
+ display_name?: string | undefined;
15240
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15241
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15242
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15243
+ heating_set_point_celsius?: (number | undefined) | undefined;
15244
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15245
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15246
+ manual_override_allowed?: boolean | undefined;
14053
15247
  } | undefined;
15248
+ /**
15249
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14054
15250
  default_climate_setting?: {
14055
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15251
+ climate_preset_key?: string | undefined;
15252
+ can_edit?: boolean | undefined;
15253
+ can_delete?: boolean | undefined;
15254
+ name?: (string | null) | undefined;
15255
+ display_name?: string | undefined;
15256
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15257
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15258
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15259
+ heating_set_point_celsius?: (number | undefined) | undefined;
15260
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15261
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15262
+ manual_override_allowed?: boolean | undefined;
15263
+ } | undefined;
15264
+ available_climate_presets?: Array<{
15265
+ climate_preset_key: string;
15266
+ can_edit: boolean;
15267
+ can_delete: boolean;
15268
+ name: string | null;
15269
+ display_name: string;
15270
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15271
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14056
15272
  cooling_set_point_celsius?: number | undefined;
14057
15273
  heating_set_point_celsius?: number | undefined;
14058
15274
  cooling_set_point_fahrenheit?: number | undefined;
14059
15275
  heating_set_point_fahrenheit?: number | undefined;
14060
15276
  manual_override_allowed: boolean;
14061
- } | undefined;
14062
- is_climate_setting_schedule_active?: boolean | undefined;
14063
- active_climate_setting_schedule?: {
14064
- climate_setting_schedule_id: string;
14065
- schedule_type: 'time_bound';
15277
+ }> | undefined;
15278
+ fallback_climate_preset_key?: (string | null) | undefined;
15279
+ active_thermostat_schedule?: ({
15280
+ thermostat_schedule_id: string;
14066
15281
  device_id: string;
14067
15282
  name?: string | undefined;
14068
- schedule_starts_at: string;
14069
- schedule_ends_at: string;
15283
+ climate_preset_key: string;
15284
+ max_override_period_minutes?: number;
15285
+ starts_at: string;
15286
+ ends_at: string;
14070
15287
  created_at: string;
14071
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
15288
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14072
15289
  errors?: any;
14073
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14074
- cooling_set_point_celsius?: (number | undefined) | undefined;
14075
- heating_set_point_celsius?: (number | undefined) | undefined;
14076
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14077
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14078
- manual_override_allowed?: boolean | undefined;
14079
- } | undefined;
15290
+ } | null) | undefined;
14080
15291
  min_cooling_set_point_celsius?: number | undefined;
14081
15292
  min_cooling_set_point_fahrenheit?: number | undefined;
14082
15293
  max_cooling_set_point_celsius?: number | undefined;
@@ -14437,42 +15648,67 @@ export interface Routes {
14437
15648
  is_heating?: boolean | undefined;
14438
15649
  is_cooling?: boolean | undefined;
14439
15650
  is_fan_running?: boolean | undefined;
15651
+ /**
15652
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14440
15653
  fan_mode_setting?: ('auto' | 'on') | undefined;
14441
15654
  is_temporary_manual_override_active?: boolean | undefined;
14442
15655
  current_climate_setting?: {
14443
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14444
- cooling_set_point_celsius?: number | undefined;
14445
- heating_set_point_celsius?: number | undefined;
14446
- cooling_set_point_fahrenheit?: number | undefined;
14447
- heating_set_point_fahrenheit?: number | undefined;
14448
- manual_override_allowed: boolean;
15656
+ climate_preset_key?: string | undefined;
15657
+ can_edit?: boolean | undefined;
15658
+ can_delete?: boolean | undefined;
15659
+ name?: (string | null) | undefined;
15660
+ display_name?: string | undefined;
15661
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15662
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15663
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15664
+ heating_set_point_celsius?: (number | undefined) | undefined;
15665
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15666
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15667
+ manual_override_allowed?: boolean | undefined;
14449
15668
  } | undefined;
15669
+ /**
15670
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14450
15671
  default_climate_setting?: {
14451
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15672
+ climate_preset_key?: string | undefined;
15673
+ can_edit?: boolean | undefined;
15674
+ can_delete?: boolean | undefined;
15675
+ name?: (string | null) | undefined;
15676
+ display_name?: string | undefined;
15677
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15678
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15679
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15680
+ heating_set_point_celsius?: (number | undefined) | undefined;
15681
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15682
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15683
+ manual_override_allowed?: boolean | undefined;
15684
+ } | undefined;
15685
+ available_climate_presets?: Array<{
15686
+ climate_preset_key: string;
15687
+ can_edit: boolean;
15688
+ can_delete: boolean;
15689
+ name: string | null;
15690
+ display_name: string;
15691
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15692
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14452
15693
  cooling_set_point_celsius?: number | undefined;
14453
15694
  heating_set_point_celsius?: number | undefined;
14454
15695
  cooling_set_point_fahrenheit?: number | undefined;
14455
15696
  heating_set_point_fahrenheit?: number | undefined;
14456
15697
  manual_override_allowed: boolean;
14457
- } | undefined;
14458
- is_climate_setting_schedule_active?: boolean | undefined;
14459
- active_climate_setting_schedule?: {
14460
- climate_setting_schedule_id: string;
14461
- schedule_type: 'time_bound';
15698
+ }> | undefined;
15699
+ fallback_climate_preset_key?: (string | null) | undefined;
15700
+ active_thermostat_schedule?: ({
15701
+ thermostat_schedule_id: string;
14462
15702
  device_id: string;
14463
15703
  name?: string | undefined;
14464
- schedule_starts_at: string;
14465
- schedule_ends_at: string;
15704
+ climate_preset_key: string;
15705
+ max_override_period_minutes?: number;
15706
+ starts_at: string;
15707
+ ends_at: string;
14466
15708
  created_at: string;
14467
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
15709
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14468
15710
  errors?: any;
14469
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14470
- cooling_set_point_celsius?: (number | undefined) | undefined;
14471
- heating_set_point_celsius?: (number | undefined) | undefined;
14472
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14473
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14474
- manual_override_allowed?: boolean | undefined;
14475
- } | undefined;
15711
+ } | null) | undefined;
14476
15712
  min_cooling_set_point_celsius?: number | undefined;
14477
15713
  min_cooling_set_point_fahrenheit?: number | undefined;
14478
15714
  max_cooling_set_point_celsius?: number | undefined;
@@ -14656,7 +15892,7 @@ export interface Routes {
14656
15892
  } | {
14657
15893
  created_at: string;
14658
15894
  message: string;
14659
- warning_code: 'failed_to_update_acs_user_on_acs_system';
15895
+ warning_code: 'failed_to_update_on_acs_system';
14660
15896
  } | {
14661
15897
  created_at: string;
14662
15898
  message: string;
@@ -14666,7 +15902,25 @@ export interface Routes {
14666
15902
  message: string;
14667
15903
  warning_code: 'salto_site_user_suspended';
14668
15904
  }>;
14669
- errors?: any;
15905
+ errors: Array<{
15906
+ /** Date and time at which Seam created the error. */
15907
+ created_at: string;
15908
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15909
+ message: string;
15910
+ error_code: 'user_deleted_externally';
15911
+ } | {
15912
+ /** Date and time at which Seam created the error. */
15913
+ created_at: string;
15914
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15915
+ message: string;
15916
+ error_code: 'salto_ks_subscription_limit_exceeded';
15917
+ } | {
15918
+ /** Date and time at which Seam created the error. */
15919
+ created_at: string;
15920
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15921
+ message: string;
15922
+ error_code: 'salto_site_user_limit_reached';
15923
+ }>;
14670
15924
  full_name?: string | undefined;
14671
15925
  /**
14672
15926
  * @deprecated use email_address. */
@@ -15058,6 +16312,30 @@ export interface Routes {
15058
16312
  type: string;
15059
16313
  message: string;
15060
16314
  };
16315
+ } | {
16316
+ /** The ID of the action attempt. */
16317
+ action_attempt_id: string;
16318
+ status: 'pending';
16319
+ result: null;
16320
+ error: null;
16321
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16322
+ } | {
16323
+ /** The ID of the action attempt. */
16324
+ action_attempt_id: string;
16325
+ status: 'success';
16326
+ error: null;
16327
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16328
+ result: {};
16329
+ } | {
16330
+ /** The ID of the action attempt. */
16331
+ action_attempt_id: string;
16332
+ status: 'error';
16333
+ result: null;
16334
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16335
+ error: {
16336
+ type: string;
16337
+ message: string;
16338
+ };
15061
16339
  } | {
15062
16340
  /** The ID of the action attempt. */
15063
16341
  action_attempt_id: string;