@seamapi/types 1.239.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 +1412 -774
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3622 -1409
  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 +289 -7
  12. package/lib/seam/connect/models/acs/acs-user.js +61 -8
  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 +1218 -657
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +1759 -453
  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 +88 -13
  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 +1252 -652
  57. package/src/lib/seam/connect/route-types.ts +2058 -498
  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;
@@ -2245,6 +2341,10 @@ export interface Routes {
2245
2341
  created_at: string;
2246
2342
  message: string;
2247
2343
  warning_code: 'being_deleted';
2344
+ } | {
2345
+ created_at: string;
2346
+ message: string;
2347
+ warning_code: 'failed_to_update_on_acs_system';
2248
2348
  } | {
2249
2349
  created_at: string;
2250
2350
  message: string;
@@ -2254,7 +2354,25 @@ export interface Routes {
2254
2354
  message: string;
2255
2355
  warning_code: 'salto_site_user_suspended';
2256
2356
  }>;
2257
- 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
+ }>;
2258
2376
  full_name?: string | undefined;
2259
2377
  /**
2260
2378
  * @deprecated use email_address. */
@@ -3325,6 +3443,10 @@ export interface Routes {
3325
3443
  created_at: string;
3326
3444
  message: string;
3327
3445
  warning_code: 'being_deleted';
3446
+ } | {
3447
+ created_at: string;
3448
+ message: string;
3449
+ warning_code: 'failed_to_update_on_acs_system';
3328
3450
  } | {
3329
3451
  created_at: string;
3330
3452
  message: string;
@@ -3334,7 +3456,25 @@ export interface Routes {
3334
3456
  message: string;
3335
3457
  warning_code: 'salto_site_user_suspended';
3336
3458
  }>;
3337
- 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
+ }>;
3338
3478
  full_name?: string | undefined;
3339
3479
  /**
3340
3480
  * @deprecated use email_address. */
@@ -3390,6 +3530,10 @@ export interface Routes {
3390
3530
  created_at: string;
3391
3531
  message: string;
3392
3532
  warning_code: 'being_deleted';
3533
+ } | {
3534
+ created_at: string;
3535
+ message: string;
3536
+ warning_code: 'failed_to_update_on_acs_system';
3393
3537
  } | {
3394
3538
  created_at: string;
3395
3539
  message: string;
@@ -3399,7 +3543,25 @@ export interface Routes {
3399
3543
  message: string;
3400
3544
  warning_code: 'salto_site_user_suspended';
3401
3545
  }>;
3402
- 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
+ }>;
3403
3565
  full_name?: string | undefined;
3404
3566
  /**
3405
3567
  * @deprecated use email_address. */
@@ -3449,6 +3611,10 @@ export interface Routes {
3449
3611
  created_at: string;
3450
3612
  message: string;
3451
3613
  warning_code: 'being_deleted';
3614
+ } | {
3615
+ created_at: string;
3616
+ message: string;
3617
+ warning_code: 'failed_to_update_on_acs_system';
3452
3618
  } | {
3453
3619
  created_at: string;
3454
3620
  message: string;
@@ -3458,7 +3624,25 @@ export interface Routes {
3458
3624
  message: string;
3459
3625
  warning_code: 'salto_site_user_suspended';
3460
3626
  }>;
3461
- 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
+ }>;
3462
3646
  full_name?: string | undefined;
3463
3647
  /**
3464
3648
  * @deprecated use email_address. */
@@ -3573,6 +3757,10 @@ export interface Routes {
3573
3757
  created_at: string;
3574
3758
  message: string;
3575
3759
  warning_code: 'being_deleted';
3760
+ } | {
3761
+ created_at: string;
3762
+ message: string;
3763
+ warning_code: 'failed_to_update_on_acs_system';
3576
3764
  } | {
3577
3765
  created_at: string;
3578
3766
  message: string;
@@ -3582,7 +3770,25 @@ export interface Routes {
3582
3770
  message: string;
3583
3771
  warning_code: 'salto_site_user_suspended';
3584
3772
  }>;
3585
- 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
+ }>;
3586
3792
  full_name?: string | undefined;
3587
3793
  /**
3588
3794
  * @deprecated use email_address. */
@@ -3631,6 +3837,10 @@ export interface Routes {
3631
3837
  created_at: string;
3632
3838
  message: string;
3633
3839
  warning_code: 'being_deleted';
3840
+ } | {
3841
+ created_at: string;
3842
+ message: string;
3843
+ warning_code: 'failed_to_update_on_acs_system';
3634
3844
  } | {
3635
3845
  created_at: string;
3636
3846
  message: string;
@@ -3640,7 +3850,25 @@ export interface Routes {
3640
3850
  message: string;
3641
3851
  warning_code: 'salto_site_user_suspended';
3642
3852
  }>;
3643
- 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
+ }>;
3644
3872
  full_name?: string | undefined;
3645
3873
  /**
3646
3874
  * @deprecated use email_address. */
@@ -3886,6 +4114,30 @@ export interface Routes {
3886
4114
  type: string;
3887
4115
  message: string;
3888
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
+ };
3889
4141
  } | {
3890
4142
  /** The ID of the action attempt. */
3891
4143
  action_attempt_id: string;
@@ -4259,6 +4511,30 @@ export interface Routes {
4259
4511
  type: string;
4260
4512
  message: string;
4261
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
+ };
4262
4538
  } | {
4263
4539
  /** The ID of the action attempt. */
4264
4540
  action_attempt_id: string;
@@ -5170,42 +5446,67 @@ export interface Routes {
5170
5446
  is_heating?: boolean | undefined;
5171
5447
  is_cooling?: boolean | undefined;
5172
5448
  is_fan_running?: boolean | undefined;
5449
+ /**
5450
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5173
5451
  fan_mode_setting?: ('auto' | 'on') | undefined;
5174
5452
  is_temporary_manual_override_active?: boolean | undefined;
5175
5453
  current_climate_setting?: {
5176
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5177
- cooling_set_point_celsius?: number | undefined;
5178
- heating_set_point_celsius?: number | undefined;
5179
- cooling_set_point_fahrenheit?: number | undefined;
5180
- heating_set_point_fahrenheit?: number | undefined;
5181
- 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;
5182
5466
  } | undefined;
5467
+ /**
5468
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5183
5469
  default_climate_setting?: {
5184
- 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;
5185
5491
  cooling_set_point_celsius?: number | undefined;
5186
5492
  heating_set_point_celsius?: number | undefined;
5187
5493
  cooling_set_point_fahrenheit?: number | undefined;
5188
5494
  heating_set_point_fahrenheit?: number | undefined;
5189
5495
  manual_override_allowed: boolean;
5190
- } | undefined;
5191
- is_climate_setting_schedule_active?: boolean | undefined;
5192
- active_climate_setting_schedule?: {
5193
- climate_setting_schedule_id: string;
5194
- schedule_type: 'time_bound';
5496
+ }> | undefined;
5497
+ fallback_climate_preset_key?: (string | null) | undefined;
5498
+ active_thermostat_schedule?: ({
5499
+ thermostat_schedule_id: string;
5195
5500
  device_id: string;
5196
5501
  name?: string | undefined;
5197
- schedule_starts_at: string;
5198
- schedule_ends_at: string;
5502
+ climate_preset_key: string;
5503
+ max_override_period_minutes?: number;
5504
+ starts_at: string;
5505
+ ends_at: string;
5199
5506
  created_at: string;
5200
- /** 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. */
5201
5508
  errors?: any;
5202
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5203
- cooling_set_point_celsius?: (number | undefined) | undefined;
5204
- heating_set_point_celsius?: (number | undefined) | undefined;
5205
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5206
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5207
- manual_override_allowed?: boolean | undefined;
5208
- } | undefined;
5509
+ } | null) | undefined;
5209
5510
  min_cooling_set_point_celsius?: number | undefined;
5210
5511
  min_cooling_set_point_fahrenheit?: number | undefined;
5211
5512
  max_cooling_set_point_celsius?: number | undefined;
@@ -5589,42 +5890,67 @@ export interface Routes {
5589
5890
  is_heating?: boolean | undefined;
5590
5891
  is_cooling?: boolean | undefined;
5591
5892
  is_fan_running?: boolean | undefined;
5893
+ /**
5894
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5592
5895
  fan_mode_setting?: ('auto' | 'on') | undefined;
5593
5896
  is_temporary_manual_override_active?: boolean | undefined;
5594
5897
  current_climate_setting?: {
5595
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5596
- cooling_set_point_celsius?: number | undefined;
5597
- heating_set_point_celsius?: number | undefined;
5598
- cooling_set_point_fahrenheit?: number | undefined;
5599
- heating_set_point_fahrenheit?: number | undefined;
5600
- 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;
5601
5910
  } | undefined;
5911
+ /**
5912
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5602
5913
  default_climate_setting?: {
5603
- 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;
5604
5935
  cooling_set_point_celsius?: number | undefined;
5605
5936
  heating_set_point_celsius?: number | undefined;
5606
5937
  cooling_set_point_fahrenheit?: number | undefined;
5607
5938
  heating_set_point_fahrenheit?: number | undefined;
5608
5939
  manual_override_allowed: boolean;
5609
- } | undefined;
5610
- is_climate_setting_schedule_active?: boolean | undefined;
5611
- active_climate_setting_schedule?: {
5612
- climate_setting_schedule_id: string;
5613
- schedule_type: 'time_bound';
5940
+ }> | undefined;
5941
+ fallback_climate_preset_key?: (string | null) | undefined;
5942
+ active_thermostat_schedule?: ({
5943
+ thermostat_schedule_id: string;
5614
5944
  device_id: string;
5615
5945
  name?: string | undefined;
5616
- schedule_starts_at: string;
5617
- schedule_ends_at: string;
5946
+ climate_preset_key: string;
5947
+ max_override_period_minutes?: number;
5948
+ starts_at: string;
5949
+ ends_at: string;
5618
5950
  created_at: string;
5619
- /** 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. */
5620
5952
  errors?: any;
5621
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5622
- cooling_set_point_celsius?: (number | undefined) | undefined;
5623
- heating_set_point_celsius?: (number | undefined) | undefined;
5624
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5625
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5626
- manual_override_allowed?: boolean | undefined;
5627
- } | undefined;
5953
+ } | null) | undefined;
5628
5954
  min_cooling_set_point_celsius?: number | undefined;
5629
5955
  min_cooling_set_point_fahrenheit?: number | undefined;
5630
5956
  max_cooling_set_point_celsius?: number | undefined;
@@ -6388,42 +6714,67 @@ export interface Routes {
6388
6714
  is_heating?: boolean | undefined;
6389
6715
  is_cooling?: boolean | undefined;
6390
6716
  is_fan_running?: boolean | undefined;
6717
+ /**
6718
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6391
6719
  fan_mode_setting?: ('auto' | 'on') | undefined;
6392
6720
  is_temporary_manual_override_active?: boolean | undefined;
6393
6721
  current_climate_setting?: {
6394
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6395
- cooling_set_point_celsius?: number | undefined;
6396
- heating_set_point_celsius?: number | undefined;
6397
- cooling_set_point_fahrenheit?: number | undefined;
6398
- heating_set_point_fahrenheit?: number | undefined;
6399
- 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;
6400
6734
  } | undefined;
6735
+ /**
6736
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6401
6737
  default_climate_setting?: {
6402
- 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;
6403
6759
  cooling_set_point_celsius?: number | undefined;
6404
6760
  heating_set_point_celsius?: number | undefined;
6405
6761
  cooling_set_point_fahrenheit?: number | undefined;
6406
6762
  heating_set_point_fahrenheit?: number | undefined;
6407
6763
  manual_override_allowed: boolean;
6408
- } | undefined;
6409
- is_climate_setting_schedule_active?: boolean | undefined;
6410
- active_climate_setting_schedule?: {
6411
- climate_setting_schedule_id: string;
6412
- schedule_type: 'time_bound';
6764
+ }> | undefined;
6765
+ fallback_climate_preset_key?: (string | null) | undefined;
6766
+ active_thermostat_schedule?: ({
6767
+ thermostat_schedule_id: string;
6413
6768
  device_id: string;
6414
6769
  name?: string | undefined;
6415
- schedule_starts_at: string;
6416
- schedule_ends_at: string;
6770
+ climate_preset_key: string;
6771
+ max_override_period_minutes?: number;
6772
+ starts_at: string;
6773
+ ends_at: string;
6417
6774
  created_at: string;
6418
- /** 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. */
6419
6776
  errors?: any;
6420
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6421
- cooling_set_point_celsius?: (number | undefined) | undefined;
6422
- heating_set_point_celsius?: (number | undefined) | undefined;
6423
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6424
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6425
- manual_override_allowed?: boolean | undefined;
6426
- } | undefined;
6777
+ } | null) | undefined;
6427
6778
  min_cooling_set_point_celsius?: number | undefined;
6428
6779
  min_cooling_set_point_fahrenheit?: number | undefined;
6429
6780
  max_cooling_set_point_celsius?: number | undefined;
@@ -6782,42 +7133,67 @@ export interface Routes {
6782
7133
  is_heating?: boolean | undefined;
6783
7134
  is_cooling?: boolean | undefined;
6784
7135
  is_fan_running?: boolean | undefined;
7136
+ /**
7137
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6785
7138
  fan_mode_setting?: ('auto' | 'on') | undefined;
6786
7139
  is_temporary_manual_override_active?: boolean | undefined;
6787
7140
  current_climate_setting?: {
6788
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6789
- cooling_set_point_celsius?: number | undefined;
6790
- heating_set_point_celsius?: number | undefined;
6791
- cooling_set_point_fahrenheit?: number | undefined;
6792
- heating_set_point_fahrenheit?: number | undefined;
6793
- 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;
6794
7153
  } | undefined;
7154
+ /**
7155
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6795
7156
  default_climate_setting?: {
6796
- 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;
6797
7178
  cooling_set_point_celsius?: number | undefined;
6798
7179
  heating_set_point_celsius?: number | undefined;
6799
7180
  cooling_set_point_fahrenheit?: number | undefined;
6800
7181
  heating_set_point_fahrenheit?: number | undefined;
6801
7182
  manual_override_allowed: boolean;
6802
- } | undefined;
6803
- is_climate_setting_schedule_active?: boolean | undefined;
6804
- active_climate_setting_schedule?: {
6805
- climate_setting_schedule_id: string;
6806
- schedule_type: 'time_bound';
7183
+ }> | undefined;
7184
+ fallback_climate_preset_key?: (string | null) | undefined;
7185
+ active_thermostat_schedule?: ({
7186
+ thermostat_schedule_id: string;
6807
7187
  device_id: string;
6808
7188
  name?: string | undefined;
6809
- schedule_starts_at: string;
6810
- schedule_ends_at: string;
7189
+ climate_preset_key: string;
7190
+ max_override_period_minutes?: number;
7191
+ starts_at: string;
7192
+ ends_at: string;
6811
7193
  created_at: string;
6812
- /** 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. */
6813
7195
  errors?: any;
6814
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6815
- cooling_set_point_celsius?: (number | undefined) | undefined;
6816
- heating_set_point_celsius?: (number | undefined) | undefined;
6817
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6818
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6819
- manual_override_allowed?: boolean | undefined;
6820
- } | undefined;
7196
+ } | null) | undefined;
6821
7197
  min_cooling_set_point_celsius?: number | undefined;
6822
7198
  min_cooling_set_point_fahrenheit?: number | undefined;
6823
7199
  max_cooling_set_point_celsius?: number | undefined;
@@ -7201,42 +7577,67 @@ export interface Routes {
7201
7577
  is_heating?: boolean | undefined;
7202
7578
  is_cooling?: boolean | undefined;
7203
7579
  is_fan_running?: boolean | undefined;
7580
+ /**
7581
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7204
7582
  fan_mode_setting?: ('auto' | 'on') | undefined;
7205
7583
  is_temporary_manual_override_active?: boolean | undefined;
7206
7584
  current_climate_setting?: {
7207
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7208
- cooling_set_point_celsius?: number | undefined;
7209
- heating_set_point_celsius?: number | undefined;
7210
- cooling_set_point_fahrenheit?: number | undefined;
7211
- heating_set_point_fahrenheit?: number | undefined;
7212
- 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;
7213
7597
  } | undefined;
7598
+ /**
7599
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7214
7600
  default_climate_setting?: {
7215
- 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;
7216
7622
  cooling_set_point_celsius?: number | undefined;
7217
7623
  heating_set_point_celsius?: number | undefined;
7218
7624
  cooling_set_point_fahrenheit?: number | undefined;
7219
7625
  heating_set_point_fahrenheit?: number | undefined;
7220
7626
  manual_override_allowed: boolean;
7221
- } | undefined;
7222
- is_climate_setting_schedule_active?: boolean | undefined;
7223
- active_climate_setting_schedule?: {
7224
- climate_setting_schedule_id: string;
7225
- schedule_type: 'time_bound';
7627
+ }> | undefined;
7628
+ fallback_climate_preset_key?: (string | null) | undefined;
7629
+ active_thermostat_schedule?: ({
7630
+ thermostat_schedule_id: string;
7226
7631
  device_id: string;
7227
7632
  name?: string | undefined;
7228
- schedule_starts_at: string;
7229
- schedule_ends_at: string;
7633
+ climate_preset_key: string;
7634
+ max_override_period_minutes?: number;
7635
+ starts_at: string;
7636
+ ends_at: string;
7230
7637
  created_at: string;
7231
- /** 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. */
7232
7639
  errors?: any;
7233
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7234
- cooling_set_point_celsius?: (number | undefined) | undefined;
7235
- heating_set_point_celsius?: (number | undefined) | undefined;
7236
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7237
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7238
- manual_override_allowed?: boolean | undefined;
7239
- } | undefined;
7640
+ } | null) | undefined;
7240
7641
  min_cooling_set_point_celsius?: number | undefined;
7241
7642
  min_cooling_set_point_fahrenheit?: number | undefined;
7242
7643
  max_cooling_set_point_celsius?: number | undefined;
@@ -7595,42 +7996,67 @@ export interface Routes {
7595
7996
  is_heating?: boolean | undefined;
7596
7997
  is_cooling?: boolean | undefined;
7597
7998
  is_fan_running?: boolean | undefined;
7999
+ /**
8000
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7598
8001
  fan_mode_setting?: ('auto' | 'on') | undefined;
7599
8002
  is_temporary_manual_override_active?: boolean | undefined;
7600
8003
  current_climate_setting?: {
7601
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7602
- cooling_set_point_celsius?: number | undefined;
7603
- heating_set_point_celsius?: number | undefined;
7604
- cooling_set_point_fahrenheit?: number | undefined;
7605
- heating_set_point_fahrenheit?: number | undefined;
7606
- 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;
7607
8016
  } | undefined;
8017
+ /**
8018
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7608
8019
  default_climate_setting?: {
7609
- 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;
7610
8041
  cooling_set_point_celsius?: number | undefined;
7611
8042
  heating_set_point_celsius?: number | undefined;
7612
8043
  cooling_set_point_fahrenheit?: number | undefined;
7613
8044
  heating_set_point_fahrenheit?: number | undefined;
7614
8045
  manual_override_allowed: boolean;
7615
- } | undefined;
7616
- is_climate_setting_schedule_active?: boolean | undefined;
7617
- active_climate_setting_schedule?: {
7618
- climate_setting_schedule_id: string;
7619
- schedule_type: 'time_bound';
8046
+ }> | undefined;
8047
+ fallback_climate_preset_key?: (string | null) | undefined;
8048
+ active_thermostat_schedule?: ({
8049
+ thermostat_schedule_id: string;
7620
8050
  device_id: string;
7621
8051
  name?: string | undefined;
7622
- schedule_starts_at: string;
7623
- schedule_ends_at: string;
8052
+ climate_preset_key: string;
8053
+ max_override_period_minutes?: number;
8054
+ starts_at: string;
8055
+ ends_at: string;
7624
8056
  created_at: string;
7625
- /** 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. */
7626
8058
  errors?: any;
7627
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7628
- cooling_set_point_celsius?: (number | undefined) | undefined;
7629
- heating_set_point_celsius?: (number | undefined) | undefined;
7630
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7631
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7632
- manual_override_allowed?: boolean | undefined;
7633
- } | undefined;
8059
+ } | null) | undefined;
7634
8060
  min_cooling_set_point_celsius?: number | undefined;
7635
8061
  min_cooling_set_point_fahrenheit?: number | undefined;
7636
8062
  max_cooling_set_point_celsius?: number | undefined;
@@ -7890,6 +8316,30 @@ export interface Routes {
7890
8316
  type: string;
7891
8317
  message: string;
7892
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
+ };
7893
8343
  } | {
7894
8344
  /** The ID of the action attempt. */
7895
8345
  action_attempt_id: string;
@@ -8264,6 +8714,30 @@ export interface Routes {
8264
8714
  type: string;
8265
8715
  message: string;
8266
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
+ };
8267
8741
  } | {
8268
8742
  /** The ID of the action attempt. */
8269
8743
  action_attempt_id: string;
@@ -8796,42 +9270,67 @@ export interface Routes {
8796
9270
  is_heating?: boolean | undefined;
8797
9271
  is_cooling?: boolean | undefined;
8798
9272
  is_fan_running?: boolean | undefined;
9273
+ /**
9274
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8799
9275
  fan_mode_setting?: ('auto' | 'on') | undefined;
8800
9276
  is_temporary_manual_override_active?: boolean | undefined;
8801
9277
  current_climate_setting?: {
8802
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
8803
- cooling_set_point_celsius?: number | undefined;
8804
- heating_set_point_celsius?: number | undefined;
8805
- cooling_set_point_fahrenheit?: number | undefined;
8806
- heating_set_point_fahrenheit?: number | undefined;
8807
- 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;
8808
9290
  } | undefined;
9291
+ /**
9292
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8809
9293
  default_climate_setting?: {
8810
- 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;
8811
9315
  cooling_set_point_celsius?: number | undefined;
8812
9316
  heating_set_point_celsius?: number | undefined;
8813
9317
  cooling_set_point_fahrenheit?: number | undefined;
8814
9318
  heating_set_point_fahrenheit?: number | undefined;
8815
9319
  manual_override_allowed: boolean;
8816
- } | undefined;
8817
- is_climate_setting_schedule_active?: boolean | undefined;
8818
- active_climate_setting_schedule?: {
8819
- climate_setting_schedule_id: string;
8820
- schedule_type: 'time_bound';
9320
+ }> | undefined;
9321
+ fallback_climate_preset_key?: (string | null) | undefined;
9322
+ active_thermostat_schedule?: ({
9323
+ thermostat_schedule_id: string;
8821
9324
  device_id: string;
8822
9325
  name?: string | undefined;
8823
- schedule_starts_at: string;
8824
- schedule_ends_at: string;
9326
+ climate_preset_key: string;
9327
+ max_override_period_minutes?: number;
9328
+ starts_at: string;
9329
+ ends_at: string;
8825
9330
  created_at: string;
8826
- /** 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. */
8827
9332
  errors?: any;
8828
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
8829
- cooling_set_point_celsius?: (number | undefined) | undefined;
8830
- heating_set_point_celsius?: (number | undefined) | undefined;
8831
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8832
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
8833
- manual_override_allowed?: boolean | undefined;
8834
- } | undefined;
9333
+ } | null) | undefined;
8835
9334
  min_cooling_set_point_celsius?: number | undefined;
8836
9335
  min_cooling_set_point_fahrenheit?: number | undefined;
8837
9336
  max_cooling_set_point_celsius?: number | undefined;
@@ -9190,42 +9689,67 @@ export interface Routes {
9190
9689
  is_heating?: boolean | undefined;
9191
9690
  is_cooling?: boolean | undefined;
9192
9691
  is_fan_running?: boolean | undefined;
9692
+ /**
9693
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9193
9694
  fan_mode_setting?: ('auto' | 'on') | undefined;
9194
9695
  is_temporary_manual_override_active?: boolean | undefined;
9195
9696
  current_climate_setting?: {
9196
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9197
- cooling_set_point_celsius?: number | undefined;
9198
- heating_set_point_celsius?: number | undefined;
9199
- cooling_set_point_fahrenheit?: number | undefined;
9200
- heating_set_point_fahrenheit?: number | undefined;
9201
- 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;
9202
9709
  } | undefined;
9710
+ /**
9711
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9203
9712
  default_climate_setting?: {
9204
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9205
- cooling_set_point_celsius?: number | undefined;
9206
- heating_set_point_celsius?: number | undefined;
9207
- cooling_set_point_fahrenheit?: number | undefined;
9208
- heating_set_point_fahrenheit?: number | undefined;
9209
- manual_override_allowed: boolean;
9210
- } | undefined;
9211
- is_climate_setting_schedule_active?: boolean | undefined;
9212
- active_climate_setting_schedule?: {
9213
- climate_setting_schedule_id: string;
9214
- schedule_type: 'time_bound';
9215
- device_id: string;
9216
- name?: string | undefined;
9217
- schedule_starts_at: string;
9218
- schedule_ends_at: string;
9219
- created_at: string;
9220
- /** 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. */
9221
- errors?: any;
9222
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
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;
9223
9720
  cooling_set_point_celsius?: (number | undefined) | undefined;
9224
9721
  heating_set_point_celsius?: (number | undefined) | undefined;
9225
9722
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9226
9723
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
9227
9724
  manual_override_allowed?: boolean | undefined;
9228
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;
9734
+ cooling_set_point_celsius?: number | undefined;
9735
+ heating_set_point_celsius?: number | undefined;
9736
+ cooling_set_point_fahrenheit?: number | undefined;
9737
+ heating_set_point_fahrenheit?: number | undefined;
9738
+ manual_override_allowed: boolean;
9739
+ }> | undefined;
9740
+ fallback_climate_preset_key?: (string | null) | undefined;
9741
+ active_thermostat_schedule?: ({
9742
+ thermostat_schedule_id: string;
9743
+ device_id: string;
9744
+ name?: string | undefined;
9745
+ climate_preset_key: string;
9746
+ max_override_period_minutes?: number;
9747
+ starts_at: string;
9748
+ ends_at: string;
9749
+ created_at: string;
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. */
9751
+ errors?: any;
9752
+ } | null) | undefined;
9229
9753
  min_cooling_set_point_celsius?: number | undefined;
9230
9754
  min_cooling_set_point_fahrenheit?: number | undefined;
9231
9755
  max_cooling_set_point_celsius?: number | undefined;
@@ -9490,6 +10014,30 @@ export interface Routes {
9490
10014
  type: string;
9491
10015
  message: string;
9492
10016
  };
10017
+ } | {
10018
+ /** The ID of the action attempt. */
10019
+ action_attempt_id: string;
10020
+ status: 'pending';
10021
+ result: null;
10022
+ error: null;
10023
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10024
+ } | {
10025
+ /** The ID of the action attempt. */
10026
+ action_attempt_id: string;
10027
+ status: 'success';
10028
+ error: null;
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
+ };
9493
10041
  } | {
9494
10042
  /** The ID of the action attempt. */
9495
10043
  action_attempt_id: string;
@@ -9874,6 +10422,30 @@ export interface Routes {
9874
10422
  type: string;
9875
10423
  message: string;
9876
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
+ };
9877
10449
  } | {
9878
10450
  /** The ID of the action attempt. */
9879
10451
  action_attempt_id: string;
@@ -10297,6 +10869,30 @@ export interface Routes {
10297
10869
  type: string;
10298
10870
  message: string;
10299
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
+ };
10300
10896
  } | {
10301
10897
  /** The ID of the action attempt. */
10302
10898
  action_attempt_id: string;
@@ -10629,173 +11225,422 @@ export interface Routes {
10629
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. */
10630
11226
  warnings: Array<{
10631
11227
  message: string;
10632
- warning_code: string;
10633
- }>;
10634
- /** Date and time at which the device object was created. */
10635
- created_at: string;
10636
- /** Indicates whether Seam manages the device. */
10637
- is_managed: true;
10638
- custom_metadata: Record<string, string | boolean>;
10639
- can_remotely_unlock?: boolean | undefined;
10640
- can_remotely_lock?: boolean | undefined;
10641
- can_program_offline_access_codes?: boolean | undefined;
10642
- can_program_online_access_codes?: boolean | undefined;
10643
- can_hvac_heat?: boolean | undefined;
10644
- can_hvac_cool?: boolean | undefined;
10645
- can_hvac_heat_cool?: boolean | undefined;
10646
- can_turn_off_hvac?: boolean | undefined;
10647
- can_simulate_removal?: boolean | undefined;
10648
- can_simulate_connection?: boolean | undefined;
10649
- can_simulate_disconnection?: boolean | undefined;
10650
- };
10651
- };
10652
- };
10653
- '/thermostats/climate_setting_schedules/create': {
10654
- route: '/thermostats/climate_setting_schedules/create';
10655
- method: 'POST';
10656
- queryParams: {};
10657
- jsonBody: {
10658
- schedule_type?: 'time_bound';
10659
- device_id: string;
10660
- name?: string | undefined;
10661
- schedule_starts_at: string;
10662
- schedule_ends_at: string;
10663
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10664
- cooling_set_point_celsius?: (number | undefined) | undefined;
10665
- heating_set_point_celsius?: (number | undefined) | undefined;
10666
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10667
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10668
- manual_override_allowed?: boolean | undefined;
10669
- };
10670
- commonParams: {};
10671
- formData: {};
10672
- jsonResponse: {
10673
- climate_setting_schedule: {
10674
- climate_setting_schedule_id: string;
10675
- schedule_type: 'time_bound';
10676
- device_id: string;
10677
- name?: string | undefined;
10678
- schedule_starts_at: string;
10679
- schedule_ends_at: string;
10680
- created_at: string;
10681
- /** 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. */
10682
- errors?: any;
10683
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10684
- cooling_set_point_celsius?: (number | undefined) | undefined;
10685
- heating_set_point_celsius?: (number | undefined) | undefined;
10686
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10687
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10688
- manual_override_allowed?: boolean | undefined;
10689
- };
10690
- };
10691
- };
10692
- '/thermostats/climate_setting_schedules/delete': {
10693
- route: '/thermostats/climate_setting_schedules/delete';
10694
- method: 'DELETE' | 'POST' | 'PUT';
10695
- queryParams: {};
10696
- jsonBody: {};
10697
- commonParams: {
10698
- climate_setting_schedule_id: string;
10699
- };
10700
- formData: {};
10701
- jsonResponse: {};
10702
- };
10703
- '/thermostats/climate_setting_schedules/get': {
10704
- route: '/thermostats/climate_setting_schedules/get';
10705
- method: 'GET' | 'POST';
10706
- queryParams: {};
10707
- jsonBody: {};
10708
- commonParams: {
10709
- climate_setting_schedule_id?: string | undefined;
10710
- device_id?: string | undefined;
10711
- };
10712
- formData: {};
10713
- jsonResponse: {
10714
- climate_setting_schedule: {
10715
- climate_setting_schedule_id: string;
10716
- schedule_type: 'time_bound';
10717
- device_id: string;
10718
- name?: string | undefined;
10719
- schedule_starts_at: string;
10720
- schedule_ends_at: string;
10721
- created_at: string;
10722
- /** 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. */
10723
- errors?: any;
10724
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10725
- cooling_set_point_celsius?: (number | undefined) | undefined;
10726
- heating_set_point_celsius?: (number | undefined) | undefined;
10727
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10728
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10729
- manual_override_allowed?: boolean | undefined;
10730
- };
10731
- };
10732
- };
10733
- '/thermostats/climate_setting_schedules/list': {
10734
- route: '/thermostats/climate_setting_schedules/list';
10735
- method: 'GET' | 'POST';
10736
- queryParams: {};
10737
- jsonBody: {};
10738
- commonParams: {
10739
- device_id: string;
10740
- user_identifier_key?: string | undefined;
10741
- };
10742
- formData: {};
10743
- jsonResponse: {
10744
- climate_setting_schedules: Array<{
10745
- climate_setting_schedule_id: string;
10746
- schedule_type: 'time_bound';
10747
- device_id: string;
10748
- name?: string | undefined;
10749
- schedule_starts_at: string;
10750
- schedule_ends_at: string;
10751
- created_at: string;
10752
- /** 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. */
10753
- errors?: any;
10754
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10755
- cooling_set_point_celsius?: (number | undefined) | undefined;
10756
- heating_set_point_celsius?: (number | undefined) | undefined;
10757
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10758
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10759
- manual_override_allowed?: boolean | undefined;
10760
- }>;
10761
- };
10762
- };
10763
- '/thermostats/climate_setting_schedules/update': {
10764
- route: '/thermostats/climate_setting_schedules/update';
10765
- method: 'PATCH' | 'POST' | 'PUT';
10766
- queryParams: {};
10767
- jsonBody: {
10768
- climate_setting_schedule_id: string;
10769
- schedule_type?: 'time_bound';
10770
- name?: string | undefined;
10771
- schedule_starts_at?: string | undefined;
10772
- schedule_ends_at?: string | undefined;
10773
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10774
- cooling_set_point_celsius?: (number | undefined) | undefined;
10775
- heating_set_point_celsius?: (number | undefined) | undefined;
10776
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10777
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10778
- manual_override_allowed?: boolean | undefined;
10779
- };
10780
- commonParams: {};
10781
- formData: {};
10782
- jsonResponse: {
10783
- climate_setting_schedule: {
10784
- climate_setting_schedule_id: string;
10785
- schedule_type: 'time_bound';
10786
- device_id: string;
10787
- name?: string | undefined;
10788
- schedule_starts_at: string;
10789
- schedule_ends_at: string;
10790
- created_at: string;
10791
- /** 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. */
10792
- errors?: any;
10793
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10794
- cooling_set_point_celsius?: (number | undefined) | undefined;
10795
- heating_set_point_celsius?: (number | undefined) | undefined;
10796
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10797
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10798
- 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
+ };
10799
11644
  };
10800
11645
  };
10801
11646
  };
@@ -11004,6 +11849,30 @@ export interface Routes {
11004
11849
  type: string;
11005
11850
  message: string;
11006
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
+ };
11007
11876
  } | {
11008
11877
  /** The ID of the action attempt. */
11009
11878
  action_attempt_id: string;
@@ -11175,6 +12044,53 @@ export interface Routes {
11175
12044
  };
11176
12045
  };
11177
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
+ };
11178
12094
  '/thermostats/get': {
11179
12095
  route: '/thermostats/get';
11180
12096
  method: 'GET' | 'POST';
@@ -11490,42 +12406,67 @@ export interface Routes {
11490
12406
  is_heating?: boolean | undefined;
11491
12407
  is_cooling?: boolean | undefined;
11492
12408
  is_fan_running?: boolean | undefined;
12409
+ /**
12410
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
11493
12411
  fan_mode_setting?: ('auto' | 'on') | undefined;
11494
12412
  is_temporary_manual_override_active?: boolean | undefined;
11495
12413
  current_climate_setting?: {
11496
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11497
- cooling_set_point_celsius?: number | undefined;
11498
- heating_set_point_celsius?: number | undefined;
11499
- cooling_set_point_fahrenheit?: number | undefined;
11500
- heating_set_point_fahrenheit?: number | undefined;
11501
- 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;
11502
12426
  } | undefined;
12427
+ /**
12428
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11503
12429
  default_climate_setting?: {
11504
- 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;
11505
12451
  cooling_set_point_celsius?: number | undefined;
11506
12452
  heating_set_point_celsius?: number | undefined;
11507
12453
  cooling_set_point_fahrenheit?: number | undefined;
11508
12454
  heating_set_point_fahrenheit?: number | undefined;
11509
12455
  manual_override_allowed: boolean;
11510
- } | undefined;
11511
- is_climate_setting_schedule_active?: boolean | undefined;
11512
- active_climate_setting_schedule?: {
11513
- climate_setting_schedule_id: string;
11514
- schedule_type: 'time_bound';
12456
+ }> | undefined;
12457
+ fallback_climate_preset_key?: (string | null) | undefined;
12458
+ active_thermostat_schedule?: ({
12459
+ thermostat_schedule_id: string;
11515
12460
  device_id: string;
11516
12461
  name?: string | undefined;
11517
- schedule_starts_at: string;
11518
- schedule_ends_at: string;
12462
+ climate_preset_key: string;
12463
+ max_override_period_minutes?: number;
12464
+ starts_at: string;
12465
+ ends_at: string;
11519
12466
  created_at: string;
11520
- /** 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. */
11521
12468
  errors?: any;
11522
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11523
- cooling_set_point_celsius?: (number | undefined) | undefined;
11524
- heating_set_point_celsius?: (number | undefined) | undefined;
11525
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11526
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
11527
- manual_override_allowed?: boolean | undefined;
11528
- } | undefined;
12469
+ } | null) | undefined;
11529
12470
  min_cooling_set_point_celsius?: number | undefined;
11530
12471
  min_cooling_set_point_fahrenheit?: number | undefined;
11531
12472
  max_cooling_set_point_celsius?: number | undefined;
@@ -11787,6 +12728,30 @@ export interface Routes {
11787
12728
  type: string;
11788
12729
  message: string;
11789
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
+ };
11790
12755
  } | {
11791
12756
  /** The ID of the action attempt. */
11792
12757
  action_attempt_id: string;
@@ -12165,6 +13130,30 @@ export interface Routes {
12165
13130
  type: string;
12166
13131
  message: string;
12167
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
+ };
12168
13157
  } | {
12169
13158
  /** The ID of the action attempt. */
12170
13159
  action_attempt_id: string;
@@ -12663,42 +13652,67 @@ export interface Routes {
12663
13652
  is_heating?: boolean | undefined;
12664
13653
  is_cooling?: boolean | undefined;
12665
13654
  is_fan_running?: boolean | undefined;
13655
+ /**
13656
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
12666
13657
  fan_mode_setting?: ('auto' | 'on') | undefined;
12667
13658
  is_temporary_manual_override_active?: boolean | undefined;
12668
13659
  current_climate_setting?: {
12669
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12670
- cooling_set_point_celsius?: number | undefined;
12671
- heating_set_point_celsius?: number | undefined;
12672
- cooling_set_point_fahrenheit?: number | undefined;
12673
- heating_set_point_fahrenheit?: number | undefined;
12674
- 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;
12675
13672
  } | undefined;
13673
+ /**
13674
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12676
13675
  default_climate_setting?: {
12677
- 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;
12678
13697
  cooling_set_point_celsius?: number | undefined;
12679
13698
  heating_set_point_celsius?: number | undefined;
12680
13699
  cooling_set_point_fahrenheit?: number | undefined;
12681
13700
  heating_set_point_fahrenheit?: number | undefined;
12682
13701
  manual_override_allowed: boolean;
12683
- } | undefined;
12684
- is_climate_setting_schedule_active?: boolean | undefined;
12685
- active_climate_setting_schedule?: {
12686
- climate_setting_schedule_id: string;
12687
- schedule_type: 'time_bound';
13702
+ }> | undefined;
13703
+ fallback_climate_preset_key?: (string | null) | undefined;
13704
+ active_thermostat_schedule?: ({
13705
+ thermostat_schedule_id: string;
12688
13706
  device_id: string;
12689
13707
  name?: string | undefined;
12690
- schedule_starts_at: string;
12691
- schedule_ends_at: string;
13708
+ climate_preset_key: string;
13709
+ max_override_period_minutes?: number;
13710
+ starts_at: string;
13711
+ ends_at: string;
12692
13712
  created_at: string;
12693
- /** 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. */
12694
13714
  errors?: any;
12695
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12696
- cooling_set_point_celsius?: (number | undefined) | undefined;
12697
- heating_set_point_celsius?: (number | undefined) | undefined;
12698
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12699
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
12700
- manual_override_allowed?: boolean | undefined;
12701
- } | undefined;
13715
+ } | null) | undefined;
12702
13716
  min_cooling_set_point_celsius?: number | undefined;
12703
13717
  min_cooling_set_point_fahrenheit?: number | undefined;
12704
13718
  max_cooling_set_point_celsius?: number | undefined;
@@ -12958,6 +13972,30 @@ export interface Routes {
12958
13972
  type: string;
12959
13973
  message: string;
12960
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
+ };
12961
13999
  } | {
12962
14000
  /** The ID of the action attempt. */
12963
14001
  action_attempt_id: string;
@@ -13129,12 +14167,144 @@ export interface Routes {
13129
14167
  };
13130
14168
  };
13131
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
+ };
13132
14300
  '/thermostats/set_fan_mode': {
13133
14301
  route: '/thermostats/set_fan_mode';
13134
14302
  method: 'POST';
13135
14303
  queryParams: {};
13136
14304
  jsonBody: {
13137
14305
  device_id: string;
14306
+ /**
14307
+ * @deprecated use fan_mode_setting instead. */
13138
14308
  fan_mode?: ('auto' | 'on') | undefined;
13139
14309
  fan_mode_setting?: ('auto' | 'on') | undefined;
13140
14310
  sync?: boolean;
@@ -13334,6 +14504,30 @@ export interface Routes {
13334
14504
  type: string;
13335
14505
  message: string;
13336
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
+ };
13337
14531
  } | {
13338
14532
  /** The ID of the action attempt. */
13339
14533
  action_attempt_id: string;
@@ -13505,24 +14699,40 @@ export interface Routes {
13505
14699
  };
13506
14700
  };
13507
14701
  };
13508
- '/thermostats/update': {
13509
- route: '/thermostats/update';
13510
- method: 'PATCH' | 'POST';
14702
+ '/thermostats/update_climate_preset': {
14703
+ route: '/thermostats/update_climate_preset';
14704
+ method: 'POST' | 'PATCH';
13511
14705
  queryParams: {};
13512
14706
  jsonBody: {
13513
14707
  device_id: string;
13514
- default_climate_setting: {
13515
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13516
- cooling_set_point_celsius?: (number | undefined) | undefined;
13517
- heating_set_point_celsius?: (number | undefined) | undefined;
13518
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13519
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
13520
- manual_override_allowed?: boolean | undefined;
13521
- };
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;
13522
14717
  };
13523
14718
  commonParams: {};
13524
14719
  formData: {};
13525
- 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
+ };
13526
14736
  };
13527
14737
  '/user_identities/add_acs_user': {
13528
14738
  route: '/user_identities/add_acs_user';
@@ -14017,42 +15227,67 @@ export interface Routes {
14017
15227
  is_heating?: boolean | undefined;
14018
15228
  is_cooling?: boolean | undefined;
14019
15229
  is_fan_running?: boolean | undefined;
15230
+ /**
15231
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14020
15232
  fan_mode_setting?: ('auto' | 'on') | undefined;
14021
15233
  is_temporary_manual_override_active?: boolean | undefined;
14022
15234
  current_climate_setting?: {
14023
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14024
- cooling_set_point_celsius?: number | undefined;
14025
- heating_set_point_celsius?: number | undefined;
14026
- cooling_set_point_fahrenheit?: number | undefined;
14027
- heating_set_point_fahrenheit?: number | undefined;
14028
- 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;
14029
15247
  } | undefined;
15248
+ /**
15249
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14030
15250
  default_climate_setting?: {
14031
- 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;
14032
15272
  cooling_set_point_celsius?: number | undefined;
14033
15273
  heating_set_point_celsius?: number | undefined;
14034
15274
  cooling_set_point_fahrenheit?: number | undefined;
14035
15275
  heating_set_point_fahrenheit?: number | undefined;
14036
15276
  manual_override_allowed: boolean;
14037
- } | undefined;
14038
- is_climate_setting_schedule_active?: boolean | undefined;
14039
- active_climate_setting_schedule?: {
14040
- climate_setting_schedule_id: string;
14041
- schedule_type: 'time_bound';
15277
+ }> | undefined;
15278
+ fallback_climate_preset_key?: (string | null) | undefined;
15279
+ active_thermostat_schedule?: ({
15280
+ thermostat_schedule_id: string;
14042
15281
  device_id: string;
14043
15282
  name?: string | undefined;
14044
- schedule_starts_at: string;
14045
- schedule_ends_at: string;
15283
+ climate_preset_key: string;
15284
+ max_override_period_minutes?: number;
15285
+ starts_at: string;
15286
+ ends_at: string;
14046
15287
  created_at: string;
14047
- /** 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. */
14048
15289
  errors?: any;
14049
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14050
- cooling_set_point_celsius?: (number | undefined) | undefined;
14051
- heating_set_point_celsius?: (number | undefined) | undefined;
14052
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14053
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14054
- manual_override_allowed?: boolean | undefined;
14055
- } | undefined;
15290
+ } | null) | undefined;
14056
15291
  min_cooling_set_point_celsius?: number | undefined;
14057
15292
  min_cooling_set_point_fahrenheit?: number | undefined;
14058
15293
  max_cooling_set_point_celsius?: number | undefined;
@@ -14413,42 +15648,67 @@ export interface Routes {
14413
15648
  is_heating?: boolean | undefined;
14414
15649
  is_cooling?: boolean | undefined;
14415
15650
  is_fan_running?: boolean | undefined;
15651
+ /**
15652
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14416
15653
  fan_mode_setting?: ('auto' | 'on') | undefined;
14417
15654
  is_temporary_manual_override_active?: boolean | undefined;
14418
15655
  current_climate_setting?: {
14419
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14420
- cooling_set_point_celsius?: number | undefined;
14421
- heating_set_point_celsius?: number | undefined;
14422
- cooling_set_point_fahrenheit?: number | undefined;
14423
- heating_set_point_fahrenheit?: number | undefined;
14424
- 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;
14425
15668
  } | undefined;
15669
+ /**
15670
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14426
15671
  default_climate_setting?: {
14427
- 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;
14428
15693
  cooling_set_point_celsius?: number | undefined;
14429
15694
  heating_set_point_celsius?: number | undefined;
14430
15695
  cooling_set_point_fahrenheit?: number | undefined;
14431
15696
  heating_set_point_fahrenheit?: number | undefined;
14432
15697
  manual_override_allowed: boolean;
14433
- } | undefined;
14434
- is_climate_setting_schedule_active?: boolean | undefined;
14435
- active_climate_setting_schedule?: {
14436
- climate_setting_schedule_id: string;
14437
- schedule_type: 'time_bound';
15698
+ }> | undefined;
15699
+ fallback_climate_preset_key?: (string | null) | undefined;
15700
+ active_thermostat_schedule?: ({
15701
+ thermostat_schedule_id: string;
14438
15702
  device_id: string;
14439
15703
  name?: string | undefined;
14440
- schedule_starts_at: string;
14441
- schedule_ends_at: string;
15704
+ climate_preset_key: string;
15705
+ max_override_period_minutes?: number;
15706
+ starts_at: string;
15707
+ ends_at: string;
14442
15708
  created_at: string;
14443
- /** 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. */
14444
15710
  errors?: any;
14445
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14446
- cooling_set_point_celsius?: (number | undefined) | undefined;
14447
- heating_set_point_celsius?: (number | undefined) | undefined;
14448
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14449
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14450
- manual_override_allowed?: boolean | undefined;
14451
- } | undefined;
15711
+ } | null) | undefined;
14452
15712
  min_cooling_set_point_celsius?: number | undefined;
14453
15713
  min_cooling_set_point_fahrenheit?: number | undefined;
14454
15714
  max_cooling_set_point_celsius?: number | undefined;
@@ -14629,6 +15889,10 @@ export interface Routes {
14629
15889
  created_at: string;
14630
15890
  message: string;
14631
15891
  warning_code: 'being_deleted';
15892
+ } | {
15893
+ created_at: string;
15894
+ message: string;
15895
+ warning_code: 'failed_to_update_on_acs_system';
14632
15896
  } | {
14633
15897
  created_at: string;
14634
15898
  message: string;
@@ -14638,7 +15902,25 @@ export interface Routes {
14638
15902
  message: string;
14639
15903
  warning_code: 'salto_site_user_suspended';
14640
15904
  }>;
14641
- 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
+ }>;
14642
15924
  full_name?: string | undefined;
14643
15925
  /**
14644
15926
  * @deprecated use email_address. */
@@ -15030,6 +16312,30 @@ export interface Routes {
15030
16312
  type: string;
15031
16313
  message: string;
15032
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
+ };
15033
16339
  } | {
15034
16340
  /** The ID of the action attempt. */
15035
16341
  action_attempt_id: string;