@seamapi/types 1.240.0 → 1.242.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 +1592 -904
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3728 -1455
  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 +316 -84
  12. package/lib/seam/connect/models/acs/acs-user.js +72 -22
  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 +1019 -570
  37. package/lib/seam/connect/openapi.js +1334 -723
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +1824 -476
  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 +100 -27
  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 +1385 -708
  57. package/src/lib/seam/connect/route-types.ts +2122 -520
  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;
@@ -2246,19 +2342,47 @@ export interface Routes {
2246
2342
  message: string;
2247
2343
  warning_code: 'being_deleted';
2248
2344
  } | {
2345
+ /** Date and time at which Seam created the error. */
2249
2346
  created_at: string;
2347
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2250
2348
  message: string;
2251
- warning_code: 'failed_to_update_acs_user_on_acs_system';
2349
+ warning_code: 'failed_to_update_on_acs_system';
2252
2350
  } | {
2253
2351
  created_at: string;
2254
2352
  message: string;
2255
2353
  warning_code: 'salto_ks_user_not_subscribed';
2354
+ }>;
2355
+ errors: Array<{
2356
+ /** Date and time at which Seam created the error. */
2357
+ created_at: string;
2358
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2359
+ message: string;
2360
+ error_code: 'deleted_externally';
2361
+ } | {
2362
+ /** Date and time at which Seam created the error. */
2363
+ created_at: string;
2364
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2365
+ message: string;
2366
+ error_code: 'salto_ks_subscription_limit_exceeded';
2367
+ } | {
2368
+ /** Date and time at which Seam created the error. */
2369
+ created_at: string;
2370
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2371
+ message: string;
2372
+ warning_code: 'failed_to_create_on_acs_system';
2373
+ } | {
2374
+ /** Date and time at which Seam created the error. */
2375
+ created_at: string;
2376
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2377
+ message: string;
2378
+ warning_code: 'failed_to_update_on_acs_system';
2256
2379
  } | {
2380
+ /** Date and time at which Seam created the error. */
2257
2381
  created_at: string;
2382
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2258
2383
  message: string;
2259
- warning_code: 'salto_site_user_suspended';
2384
+ warning_code: 'failed_to_delete_on_acs_system';
2260
2385
  }>;
2261
- errors?: any;
2262
2386
  full_name?: string | undefined;
2263
2387
  /**
2264
2388
  * @deprecated use email_address. */
@@ -3330,19 +3454,47 @@ export interface Routes {
3330
3454
  message: string;
3331
3455
  warning_code: 'being_deleted';
3332
3456
  } | {
3457
+ /** Date and time at which Seam created the error. */
3333
3458
  created_at: string;
3459
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3334
3460
  message: string;
3335
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3461
+ warning_code: 'failed_to_update_on_acs_system';
3336
3462
  } | {
3337
3463
  created_at: string;
3338
3464
  message: string;
3339
3465
  warning_code: 'salto_ks_user_not_subscribed';
3466
+ }>;
3467
+ errors: Array<{
3468
+ /** Date and time at which Seam created the error. */
3469
+ created_at: string;
3470
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3471
+ message: string;
3472
+ error_code: 'deleted_externally';
3473
+ } | {
3474
+ /** Date and time at which Seam created the error. */
3475
+ created_at: string;
3476
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3477
+ message: string;
3478
+ error_code: 'salto_ks_subscription_limit_exceeded';
3479
+ } | {
3480
+ /** Date and time at which Seam created the error. */
3481
+ created_at: string;
3482
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3483
+ message: string;
3484
+ warning_code: 'failed_to_create_on_acs_system';
3340
3485
  } | {
3486
+ /** Date and time at which Seam created the error. */
3487
+ created_at: string;
3488
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3489
+ message: string;
3490
+ warning_code: 'failed_to_update_on_acs_system';
3491
+ } | {
3492
+ /** Date and time at which Seam created the error. */
3341
3493
  created_at: string;
3494
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3342
3495
  message: string;
3343
- warning_code: 'salto_site_user_suspended';
3496
+ warning_code: 'failed_to_delete_on_acs_system';
3344
3497
  }>;
3345
- errors?: any;
3346
3498
  full_name?: string | undefined;
3347
3499
  /**
3348
3500
  * @deprecated use email_address. */
@@ -3399,19 +3551,47 @@ export interface Routes {
3399
3551
  message: string;
3400
3552
  warning_code: 'being_deleted';
3401
3553
  } | {
3554
+ /** Date and time at which Seam created the error. */
3402
3555
  created_at: string;
3556
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3403
3557
  message: string;
3404
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3558
+ warning_code: 'failed_to_update_on_acs_system';
3405
3559
  } | {
3406
3560
  created_at: string;
3407
3561
  message: string;
3408
3562
  warning_code: 'salto_ks_user_not_subscribed';
3563
+ }>;
3564
+ errors: Array<{
3565
+ /** Date and time at which Seam created the error. */
3566
+ created_at: string;
3567
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3568
+ message: string;
3569
+ error_code: 'deleted_externally';
3409
3570
  } | {
3571
+ /** Date and time at which Seam created the error. */
3572
+ created_at: string;
3573
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3574
+ message: string;
3575
+ error_code: 'salto_ks_subscription_limit_exceeded';
3576
+ } | {
3577
+ /** Date and time at which Seam created the error. */
3578
+ created_at: string;
3579
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3580
+ message: string;
3581
+ warning_code: 'failed_to_create_on_acs_system';
3582
+ } | {
3583
+ /** Date and time at which Seam created the error. */
3584
+ created_at: string;
3585
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3586
+ message: string;
3587
+ warning_code: 'failed_to_update_on_acs_system';
3588
+ } | {
3589
+ /** Date and time at which Seam created the error. */
3410
3590
  created_at: string;
3591
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3411
3592
  message: string;
3412
- warning_code: 'salto_site_user_suspended';
3593
+ warning_code: 'failed_to_delete_on_acs_system';
3413
3594
  }>;
3414
- errors?: any;
3415
3595
  full_name?: string | undefined;
3416
3596
  /**
3417
3597
  * @deprecated use email_address. */
@@ -3462,19 +3642,47 @@ export interface Routes {
3462
3642
  message: string;
3463
3643
  warning_code: 'being_deleted';
3464
3644
  } | {
3645
+ /** Date and time at which Seam created the error. */
3465
3646
  created_at: string;
3647
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3466
3648
  message: string;
3467
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3649
+ warning_code: 'failed_to_update_on_acs_system';
3468
3650
  } | {
3469
3651
  created_at: string;
3470
3652
  message: string;
3471
3653
  warning_code: 'salto_ks_user_not_subscribed';
3654
+ }>;
3655
+ errors: Array<{
3656
+ /** Date and time at which Seam created the error. */
3657
+ created_at: string;
3658
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3659
+ message: string;
3660
+ error_code: 'deleted_externally';
3661
+ } | {
3662
+ /** Date and time at which Seam created the error. */
3663
+ created_at: string;
3664
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3665
+ message: string;
3666
+ error_code: 'salto_ks_subscription_limit_exceeded';
3667
+ } | {
3668
+ /** Date and time at which Seam created the error. */
3669
+ created_at: string;
3670
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3671
+ message: string;
3672
+ warning_code: 'failed_to_create_on_acs_system';
3673
+ } | {
3674
+ /** Date and time at which Seam created the error. */
3675
+ created_at: string;
3676
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3677
+ message: string;
3678
+ warning_code: 'failed_to_update_on_acs_system';
3472
3679
  } | {
3680
+ /** Date and time at which Seam created the error. */
3473
3681
  created_at: string;
3682
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3474
3683
  message: string;
3475
- warning_code: 'salto_site_user_suspended';
3684
+ warning_code: 'failed_to_delete_on_acs_system';
3476
3685
  }>;
3477
- errors?: any;
3478
3686
  full_name?: string | undefined;
3479
3687
  /**
3480
3688
  * @deprecated use email_address. */
@@ -3590,19 +3798,47 @@ export interface Routes {
3590
3798
  message: string;
3591
3799
  warning_code: 'being_deleted';
3592
3800
  } | {
3801
+ /** Date and time at which Seam created the error. */
3593
3802
  created_at: string;
3803
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3594
3804
  message: string;
3595
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3805
+ warning_code: 'failed_to_update_on_acs_system';
3596
3806
  } | {
3597
3807
  created_at: string;
3598
3808
  message: string;
3599
3809
  warning_code: 'salto_ks_user_not_subscribed';
3810
+ }>;
3811
+ errors: Array<{
3812
+ /** Date and time at which Seam created the error. */
3813
+ created_at: string;
3814
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3815
+ message: string;
3816
+ error_code: 'deleted_externally';
3817
+ } | {
3818
+ /** Date and time at which Seam created the error. */
3819
+ created_at: string;
3820
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3821
+ message: string;
3822
+ error_code: 'salto_ks_subscription_limit_exceeded';
3823
+ } | {
3824
+ /** Date and time at which Seam created the error. */
3825
+ created_at: string;
3826
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3827
+ message: string;
3828
+ warning_code: 'failed_to_create_on_acs_system';
3829
+ } | {
3830
+ /** Date and time at which Seam created the error. */
3831
+ created_at: string;
3832
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3833
+ message: string;
3834
+ warning_code: 'failed_to_update_on_acs_system';
3600
3835
  } | {
3836
+ /** Date and time at which Seam created the error. */
3601
3837
  created_at: string;
3838
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3602
3839
  message: string;
3603
- warning_code: 'salto_site_user_suspended';
3840
+ warning_code: 'failed_to_delete_on_acs_system';
3604
3841
  }>;
3605
- errors?: any;
3606
3842
  full_name?: string | undefined;
3607
3843
  /**
3608
3844
  * @deprecated use email_address. */
@@ -3652,19 +3888,47 @@ export interface Routes {
3652
3888
  message: string;
3653
3889
  warning_code: 'being_deleted';
3654
3890
  } | {
3891
+ /** Date and time at which Seam created the error. */
3655
3892
  created_at: string;
3893
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3656
3894
  message: string;
3657
- warning_code: 'failed_to_update_acs_user_on_acs_system';
3895
+ warning_code: 'failed_to_update_on_acs_system';
3658
3896
  } | {
3659
3897
  created_at: string;
3660
3898
  message: string;
3661
3899
  warning_code: 'salto_ks_user_not_subscribed';
3900
+ }>;
3901
+ errors: Array<{
3902
+ /** Date and time at which Seam created the error. */
3903
+ created_at: string;
3904
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3905
+ message: string;
3906
+ error_code: 'deleted_externally';
3907
+ } | {
3908
+ /** Date and time at which Seam created the error. */
3909
+ created_at: string;
3910
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3911
+ message: string;
3912
+ error_code: 'salto_ks_subscription_limit_exceeded';
3913
+ } | {
3914
+ /** Date and time at which Seam created the error. */
3915
+ created_at: string;
3916
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3917
+ message: string;
3918
+ warning_code: 'failed_to_create_on_acs_system';
3662
3919
  } | {
3920
+ /** Date and time at which Seam created the error. */
3921
+ created_at: string;
3922
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3923
+ message: string;
3924
+ warning_code: 'failed_to_update_on_acs_system';
3925
+ } | {
3926
+ /** Date and time at which Seam created the error. */
3663
3927
  created_at: string;
3928
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3664
3929
  message: string;
3665
- warning_code: 'salto_site_user_suspended';
3930
+ warning_code: 'failed_to_delete_on_acs_system';
3666
3931
  }>;
3667
- errors?: any;
3668
3932
  full_name?: string | undefined;
3669
3933
  /**
3670
3934
  * @deprecated use email_address. */
@@ -3916,20 +4180,20 @@ export interface Routes {
3916
4180
  status: 'pending';
3917
4181
  result: null;
3918
4182
  error: null;
3919
- action_type: 'SYNC_ACCESS_CODES';
4183
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
3920
4184
  } | {
3921
4185
  /** The ID of the action attempt. */
3922
4186
  action_attempt_id: string;
3923
4187
  status: 'success';
3924
4188
  error: null;
3925
- action_type: 'SYNC_ACCESS_CODES';
3926
- result?: any;
4189
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4190
+ result: {};
3927
4191
  } | {
3928
4192
  /** The ID of the action attempt. */
3929
4193
  action_attempt_id: string;
3930
4194
  status: 'error';
3931
4195
  result: null;
3932
- action_type: 'SYNC_ACCESS_CODES';
4196
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
3933
4197
  error: {
3934
4198
  type: string;
3935
4199
  message: string;
@@ -3940,20 +4204,20 @@ export interface Routes {
3940
4204
  status: 'pending';
3941
4205
  result: null;
3942
4206
  error: null;
3943
- action_type: 'CREATE_ACCESS_CODE';
4207
+ action_type: 'SYNC_ACCESS_CODES';
3944
4208
  } | {
3945
4209
  /** The ID of the action attempt. */
3946
4210
  action_attempt_id: string;
3947
4211
  status: 'success';
3948
4212
  error: null;
3949
- action_type: 'CREATE_ACCESS_CODE';
4213
+ action_type: 'SYNC_ACCESS_CODES';
3950
4214
  result?: any;
3951
4215
  } | {
3952
4216
  /** The ID of the action attempt. */
3953
4217
  action_attempt_id: string;
3954
4218
  status: 'error';
3955
4219
  result: null;
3956
- action_type: 'CREATE_ACCESS_CODE';
4220
+ action_type: 'SYNC_ACCESS_CODES';
3957
4221
  error: {
3958
4222
  type: string;
3959
4223
  message: string;
@@ -3964,20 +4228,44 @@ export interface Routes {
3964
4228
  status: 'pending';
3965
4229
  result: null;
3966
4230
  error: null;
3967
- action_type: 'DELETE_ACCESS_CODE';
4231
+ action_type: 'CREATE_ACCESS_CODE';
3968
4232
  } | {
3969
4233
  /** The ID of the action attempt. */
3970
4234
  action_attempt_id: string;
3971
4235
  status: 'success';
3972
4236
  error: null;
3973
- action_type: 'DELETE_ACCESS_CODE';
4237
+ action_type: 'CREATE_ACCESS_CODE';
3974
4238
  result?: any;
3975
4239
  } | {
3976
4240
  /** The ID of the action attempt. */
3977
4241
  action_attempt_id: string;
3978
4242
  status: 'error';
3979
4243
  result: null;
3980
- action_type: 'DELETE_ACCESS_CODE';
4244
+ action_type: 'CREATE_ACCESS_CODE';
4245
+ error: {
4246
+ type: string;
4247
+ message: string;
4248
+ };
4249
+ } | {
4250
+ /** The ID of the action attempt. */
4251
+ action_attempt_id: string;
4252
+ status: 'pending';
4253
+ result: null;
4254
+ error: null;
4255
+ action_type: 'DELETE_ACCESS_CODE';
4256
+ } | {
4257
+ /** The ID of the action attempt. */
4258
+ action_attempt_id: string;
4259
+ status: 'success';
4260
+ error: null;
4261
+ action_type: 'DELETE_ACCESS_CODE';
4262
+ result?: any;
4263
+ } | {
4264
+ /** The ID of the action attempt. */
4265
+ action_attempt_id: string;
4266
+ status: 'error';
4267
+ result: null;
4268
+ action_type: 'DELETE_ACCESS_CODE';
3981
4269
  error: {
3982
4270
  type: string;
3983
4271
  message: string;
@@ -4283,6 +4571,30 @@ export interface Routes {
4283
4571
  type: string;
4284
4572
  message: string;
4285
4573
  };
4574
+ } | {
4575
+ /** The ID of the action attempt. */
4576
+ action_attempt_id: string;
4577
+ status: 'pending';
4578
+ result: null;
4579
+ error: null;
4580
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4581
+ } | {
4582
+ /** The ID of the action attempt. */
4583
+ action_attempt_id: string;
4584
+ status: 'success';
4585
+ error: null;
4586
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4587
+ result: {};
4588
+ } | {
4589
+ /** The ID of the action attempt. */
4590
+ action_attempt_id: string;
4591
+ status: 'error';
4592
+ result: null;
4593
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
4594
+ error: {
4595
+ type: string;
4596
+ message: string;
4597
+ };
4286
4598
  } | {
4287
4599
  /** The ID of the action attempt. */
4288
4600
  action_attempt_id: string;
@@ -5194,42 +5506,67 @@ export interface Routes {
5194
5506
  is_heating?: boolean | undefined;
5195
5507
  is_cooling?: boolean | undefined;
5196
5508
  is_fan_running?: boolean | undefined;
5509
+ /**
5510
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5197
5511
  fan_mode_setting?: ('auto' | 'on') | undefined;
5198
5512
  is_temporary_manual_override_active?: boolean | undefined;
5199
5513
  current_climate_setting?: {
5200
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5201
- cooling_set_point_celsius?: number | undefined;
5202
- heating_set_point_celsius?: number | undefined;
5203
- cooling_set_point_fahrenheit?: number | undefined;
5204
- heating_set_point_fahrenheit?: number | undefined;
5205
- manual_override_allowed: boolean;
5514
+ climate_preset_key?: string | undefined;
5515
+ can_edit?: boolean | undefined;
5516
+ can_delete?: boolean | undefined;
5517
+ name?: (string | null) | undefined;
5518
+ display_name?: string | undefined;
5519
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5520
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5521
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5522
+ heating_set_point_celsius?: (number | undefined) | undefined;
5523
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5524
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5525
+ manual_override_allowed?: boolean | undefined;
5206
5526
  } | undefined;
5527
+ /**
5528
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5207
5529
  default_climate_setting?: {
5208
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5530
+ climate_preset_key?: string | undefined;
5531
+ can_edit?: boolean | undefined;
5532
+ can_delete?: boolean | undefined;
5533
+ name?: (string | null) | undefined;
5534
+ display_name?: string | undefined;
5535
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5536
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5537
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5538
+ heating_set_point_celsius?: (number | undefined) | undefined;
5539
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5540
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5541
+ manual_override_allowed?: boolean | undefined;
5542
+ } | undefined;
5543
+ available_climate_presets?: Array<{
5544
+ climate_preset_key: string;
5545
+ can_edit: boolean;
5546
+ can_delete: boolean;
5547
+ name: string | null;
5548
+ display_name: string;
5549
+ fan_mode_setting?: ('auto' | 'on') | undefined;
5550
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5209
5551
  cooling_set_point_celsius?: number | undefined;
5210
5552
  heating_set_point_celsius?: number | undefined;
5211
5553
  cooling_set_point_fahrenheit?: number | undefined;
5212
5554
  heating_set_point_fahrenheit?: number | undefined;
5213
5555
  manual_override_allowed: boolean;
5214
- } | undefined;
5215
- is_climate_setting_schedule_active?: boolean | undefined;
5216
- active_climate_setting_schedule?: {
5217
- climate_setting_schedule_id: string;
5218
- schedule_type: 'time_bound';
5556
+ }> | undefined;
5557
+ fallback_climate_preset_key?: (string | null) | undefined;
5558
+ active_thermostat_schedule?: ({
5559
+ thermostat_schedule_id: string;
5219
5560
  device_id: string;
5220
5561
  name?: string | undefined;
5221
- schedule_starts_at: string;
5222
- schedule_ends_at: string;
5562
+ climate_preset_key: string;
5563
+ max_override_period_minutes?: number;
5564
+ starts_at: string;
5565
+ ends_at: string;
5223
5566
  created_at: string;
5224
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5567
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5225
5568
  errors?: any;
5226
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5227
- cooling_set_point_celsius?: (number | undefined) | undefined;
5228
- heating_set_point_celsius?: (number | undefined) | undefined;
5229
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5230
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5231
- manual_override_allowed?: boolean | undefined;
5232
- } | undefined;
5569
+ } | null) | undefined;
5233
5570
  min_cooling_set_point_celsius?: number | undefined;
5234
5571
  min_cooling_set_point_fahrenheit?: number | undefined;
5235
5572
  max_cooling_set_point_celsius?: number | undefined;
@@ -5613,42 +5950,67 @@ export interface Routes {
5613
5950
  is_heating?: boolean | undefined;
5614
5951
  is_cooling?: boolean | undefined;
5615
5952
  is_fan_running?: boolean | undefined;
5953
+ /**
5954
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
5616
5955
  fan_mode_setting?: ('auto' | 'on') | undefined;
5617
5956
  is_temporary_manual_override_active?: boolean | undefined;
5618
5957
  current_climate_setting?: {
5619
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5620
- cooling_set_point_celsius?: number | undefined;
5621
- heating_set_point_celsius?: number | undefined;
5622
- cooling_set_point_fahrenheit?: number | undefined;
5623
- heating_set_point_fahrenheit?: number | undefined;
5624
- manual_override_allowed: boolean;
5958
+ climate_preset_key?: string | undefined;
5959
+ can_edit?: boolean | undefined;
5960
+ can_delete?: boolean | undefined;
5961
+ name?: (string | null) | undefined;
5962
+ display_name?: string | undefined;
5963
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5964
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5965
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5966
+ heating_set_point_celsius?: (number | undefined) | undefined;
5967
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5968
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5969
+ manual_override_allowed?: boolean | undefined;
5625
5970
  } | undefined;
5971
+ /**
5972
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5626
5973
  default_climate_setting?: {
5627
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
5974
+ climate_preset_key?: string | undefined;
5975
+ can_edit?: boolean | undefined;
5976
+ can_delete?: boolean | undefined;
5977
+ name?: (string | null) | undefined;
5978
+ display_name?: string | undefined;
5979
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
5980
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5981
+ cooling_set_point_celsius?: (number | undefined) | undefined;
5982
+ heating_set_point_celsius?: (number | undefined) | undefined;
5983
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5984
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
5985
+ manual_override_allowed?: boolean | undefined;
5986
+ } | undefined;
5987
+ available_climate_presets?: Array<{
5988
+ climate_preset_key: string;
5989
+ can_edit: boolean;
5990
+ can_delete: boolean;
5991
+ name: string | null;
5992
+ display_name: string;
5993
+ fan_mode_setting?: ('auto' | 'on') | undefined;
5994
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5628
5995
  cooling_set_point_celsius?: number | undefined;
5629
5996
  heating_set_point_celsius?: number | undefined;
5630
5997
  cooling_set_point_fahrenheit?: number | undefined;
5631
5998
  heating_set_point_fahrenheit?: number | undefined;
5632
5999
  manual_override_allowed: boolean;
5633
- } | undefined;
5634
- is_climate_setting_schedule_active?: boolean | undefined;
5635
- active_climate_setting_schedule?: {
5636
- climate_setting_schedule_id: string;
5637
- schedule_type: 'time_bound';
6000
+ }> | undefined;
6001
+ fallback_climate_preset_key?: (string | null) | undefined;
6002
+ active_thermostat_schedule?: ({
6003
+ thermostat_schedule_id: string;
5638
6004
  device_id: string;
5639
6005
  name?: string | undefined;
5640
- schedule_starts_at: string;
5641
- schedule_ends_at: string;
6006
+ climate_preset_key: string;
6007
+ max_override_period_minutes?: number;
6008
+ starts_at: string;
6009
+ ends_at: string;
5642
6010
  created_at: string;
5643
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6011
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5644
6012
  errors?: any;
5645
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5646
- cooling_set_point_celsius?: (number | undefined) | undefined;
5647
- heating_set_point_celsius?: (number | undefined) | undefined;
5648
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5649
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5650
- manual_override_allowed?: boolean | undefined;
5651
- } | undefined;
6013
+ } | null) | undefined;
5652
6014
  min_cooling_set_point_celsius?: number | undefined;
5653
6015
  min_cooling_set_point_fahrenheit?: number | undefined;
5654
6016
  max_cooling_set_point_celsius?: number | undefined;
@@ -6412,42 +6774,67 @@ export interface Routes {
6412
6774
  is_heating?: boolean | undefined;
6413
6775
  is_cooling?: boolean | undefined;
6414
6776
  is_fan_running?: boolean | undefined;
6777
+ /**
6778
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6415
6779
  fan_mode_setting?: ('auto' | 'on') | undefined;
6416
6780
  is_temporary_manual_override_active?: boolean | undefined;
6417
6781
  current_climate_setting?: {
6418
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6419
- cooling_set_point_celsius?: number | undefined;
6420
- heating_set_point_celsius?: number | undefined;
6421
- cooling_set_point_fahrenheit?: number | undefined;
6422
- heating_set_point_fahrenheit?: number | undefined;
6423
- manual_override_allowed: boolean;
6782
+ climate_preset_key?: string | undefined;
6783
+ can_edit?: boolean | undefined;
6784
+ can_delete?: boolean | undefined;
6785
+ name?: (string | null) | undefined;
6786
+ display_name?: string | undefined;
6787
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
6788
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
6789
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6790
+ heating_set_point_celsius?: (number | undefined) | undefined;
6791
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6792
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6793
+ manual_override_allowed?: boolean | undefined;
6424
6794
  } | undefined;
6795
+ /**
6796
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6425
6797
  default_climate_setting?: {
6426
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6798
+ climate_preset_key?: string | undefined;
6799
+ can_edit?: boolean | undefined;
6800
+ can_delete?: boolean | undefined;
6801
+ name?: (string | null) | undefined;
6802
+ display_name?: string | undefined;
6803
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
6804
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
6805
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6806
+ heating_set_point_celsius?: (number | undefined) | undefined;
6807
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6808
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6809
+ manual_override_allowed?: boolean | undefined;
6810
+ } | undefined;
6811
+ available_climate_presets?: Array<{
6812
+ climate_preset_key: string;
6813
+ can_edit: boolean;
6814
+ can_delete: boolean;
6815
+ name: string | null;
6816
+ display_name: string;
6817
+ fan_mode_setting?: ('auto' | 'on') | undefined;
6818
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6427
6819
  cooling_set_point_celsius?: number | undefined;
6428
6820
  heating_set_point_celsius?: number | undefined;
6429
6821
  cooling_set_point_fahrenheit?: number | undefined;
6430
6822
  heating_set_point_fahrenheit?: number | undefined;
6431
6823
  manual_override_allowed: boolean;
6432
- } | undefined;
6433
- is_climate_setting_schedule_active?: boolean | undefined;
6434
- active_climate_setting_schedule?: {
6435
- climate_setting_schedule_id: string;
6436
- schedule_type: 'time_bound';
6824
+ }> | undefined;
6825
+ fallback_climate_preset_key?: (string | null) | undefined;
6826
+ active_thermostat_schedule?: ({
6827
+ thermostat_schedule_id: string;
6437
6828
  device_id: string;
6438
6829
  name?: string | undefined;
6439
- schedule_starts_at: string;
6440
- schedule_ends_at: string;
6830
+ climate_preset_key: string;
6831
+ max_override_period_minutes?: number;
6832
+ starts_at: string;
6833
+ ends_at: string;
6441
6834
  created_at: string;
6442
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6835
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6443
6836
  errors?: any;
6444
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6445
- cooling_set_point_celsius?: (number | undefined) | undefined;
6446
- heating_set_point_celsius?: (number | undefined) | undefined;
6447
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6448
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6449
- manual_override_allowed?: boolean | undefined;
6450
- } | undefined;
6837
+ } | null) | undefined;
6451
6838
  min_cooling_set_point_celsius?: number | undefined;
6452
6839
  min_cooling_set_point_fahrenheit?: number | undefined;
6453
6840
  max_cooling_set_point_celsius?: number | undefined;
@@ -6806,42 +7193,67 @@ export interface Routes {
6806
7193
  is_heating?: boolean | undefined;
6807
7194
  is_cooling?: boolean | undefined;
6808
7195
  is_fan_running?: boolean | undefined;
7196
+ /**
7197
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6809
7198
  fan_mode_setting?: ('auto' | 'on') | undefined;
6810
7199
  is_temporary_manual_override_active?: boolean | undefined;
6811
7200
  current_climate_setting?: {
6812
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
6813
- cooling_set_point_celsius?: number | undefined;
6814
- heating_set_point_celsius?: number | undefined;
6815
- cooling_set_point_fahrenheit?: number | undefined;
6816
- heating_set_point_fahrenheit?: number | undefined;
6817
- manual_override_allowed: boolean;
7201
+ climate_preset_key?: string | undefined;
7202
+ can_edit?: boolean | undefined;
7203
+ can_delete?: boolean | undefined;
7204
+ name?: (string | null) | undefined;
7205
+ display_name?: string | undefined;
7206
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7207
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7208
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7209
+ heating_set_point_celsius?: (number | undefined) | undefined;
7210
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7211
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7212
+ manual_override_allowed?: boolean | undefined;
6818
7213
  } | undefined;
7214
+ /**
7215
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6819
7216
  default_climate_setting?: {
6820
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7217
+ climate_preset_key?: string | undefined;
7218
+ can_edit?: boolean | undefined;
7219
+ can_delete?: boolean | undefined;
7220
+ name?: (string | null) | undefined;
7221
+ display_name?: string | undefined;
7222
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7223
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7224
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7225
+ heating_set_point_celsius?: (number | undefined) | undefined;
7226
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7227
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7228
+ manual_override_allowed?: boolean | undefined;
7229
+ } | undefined;
7230
+ available_climate_presets?: Array<{
7231
+ climate_preset_key: string;
7232
+ can_edit: boolean;
7233
+ can_delete: boolean;
7234
+ name: string | null;
7235
+ display_name: string;
7236
+ fan_mode_setting?: ('auto' | 'on') | undefined;
7237
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6821
7238
  cooling_set_point_celsius?: number | undefined;
6822
7239
  heating_set_point_celsius?: number | undefined;
6823
7240
  cooling_set_point_fahrenheit?: number | undefined;
6824
7241
  heating_set_point_fahrenheit?: number | undefined;
6825
7242
  manual_override_allowed: boolean;
6826
- } | undefined;
6827
- is_climate_setting_schedule_active?: boolean | undefined;
6828
- active_climate_setting_schedule?: {
6829
- climate_setting_schedule_id: string;
6830
- schedule_type: 'time_bound';
7243
+ }> | undefined;
7244
+ fallback_climate_preset_key?: (string | null) | undefined;
7245
+ active_thermostat_schedule?: ({
7246
+ thermostat_schedule_id: string;
6831
7247
  device_id: string;
6832
7248
  name?: string | undefined;
6833
- schedule_starts_at: string;
6834
- schedule_ends_at: string;
7249
+ climate_preset_key: string;
7250
+ max_override_period_minutes?: number;
7251
+ starts_at: string;
7252
+ ends_at: string;
6835
7253
  created_at: string;
6836
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7254
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6837
7255
  errors?: any;
6838
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6839
- cooling_set_point_celsius?: (number | undefined) | undefined;
6840
- heating_set_point_celsius?: (number | undefined) | undefined;
6841
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6842
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6843
- manual_override_allowed?: boolean | undefined;
6844
- } | undefined;
7256
+ } | null) | undefined;
6845
7257
  min_cooling_set_point_celsius?: number | undefined;
6846
7258
  min_cooling_set_point_fahrenheit?: number | undefined;
6847
7259
  max_cooling_set_point_celsius?: number | undefined;
@@ -7225,42 +7637,67 @@ export interface Routes {
7225
7637
  is_heating?: boolean | undefined;
7226
7638
  is_cooling?: boolean | undefined;
7227
7639
  is_fan_running?: boolean | undefined;
7640
+ /**
7641
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7228
7642
  fan_mode_setting?: ('auto' | 'on') | undefined;
7229
7643
  is_temporary_manual_override_active?: boolean | undefined;
7230
7644
  current_climate_setting?: {
7231
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7232
- cooling_set_point_celsius?: number | undefined;
7233
- heating_set_point_celsius?: number | undefined;
7234
- cooling_set_point_fahrenheit?: number | undefined;
7235
- heating_set_point_fahrenheit?: number | undefined;
7236
- manual_override_allowed: boolean;
7645
+ climate_preset_key?: string | undefined;
7646
+ can_edit?: boolean | undefined;
7647
+ can_delete?: boolean | undefined;
7648
+ name?: (string | null) | undefined;
7649
+ display_name?: string | undefined;
7650
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7651
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7652
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7653
+ heating_set_point_celsius?: (number | undefined) | undefined;
7654
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7655
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7656
+ manual_override_allowed?: boolean | undefined;
7237
7657
  } | undefined;
7658
+ /**
7659
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7238
7660
  default_climate_setting?: {
7239
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7661
+ climate_preset_key?: string | undefined;
7662
+ can_edit?: boolean | undefined;
7663
+ can_delete?: boolean | undefined;
7664
+ name?: (string | null) | undefined;
7665
+ display_name?: string | undefined;
7666
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
7667
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
7668
+ cooling_set_point_celsius?: (number | undefined) | undefined;
7669
+ heating_set_point_celsius?: (number | undefined) | undefined;
7670
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7671
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
7672
+ manual_override_allowed?: boolean | undefined;
7673
+ } | undefined;
7674
+ available_climate_presets?: Array<{
7675
+ climate_preset_key: string;
7676
+ can_edit: boolean;
7677
+ can_delete: boolean;
7678
+ name: string | null;
7679
+ display_name: string;
7680
+ fan_mode_setting?: ('auto' | 'on') | undefined;
7681
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7240
7682
  cooling_set_point_celsius?: number | undefined;
7241
7683
  heating_set_point_celsius?: number | undefined;
7242
7684
  cooling_set_point_fahrenheit?: number | undefined;
7243
7685
  heating_set_point_fahrenheit?: number | undefined;
7244
7686
  manual_override_allowed: boolean;
7245
- } | undefined;
7246
- is_climate_setting_schedule_active?: boolean | undefined;
7247
- active_climate_setting_schedule?: {
7248
- climate_setting_schedule_id: string;
7249
- schedule_type: 'time_bound';
7687
+ }> | undefined;
7688
+ fallback_climate_preset_key?: (string | null) | undefined;
7689
+ active_thermostat_schedule?: ({
7690
+ thermostat_schedule_id: string;
7250
7691
  device_id: string;
7251
7692
  name?: string | undefined;
7252
- schedule_starts_at: string;
7253
- schedule_ends_at: string;
7693
+ climate_preset_key: string;
7694
+ max_override_period_minutes?: number;
7695
+ starts_at: string;
7696
+ ends_at: string;
7254
7697
  created_at: string;
7255
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7698
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7256
7699
  errors?: any;
7257
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7258
- cooling_set_point_celsius?: (number | undefined) | undefined;
7259
- heating_set_point_celsius?: (number | undefined) | undefined;
7260
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7261
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7262
- manual_override_allowed?: boolean | undefined;
7263
- } | undefined;
7700
+ } | null) | undefined;
7264
7701
  min_cooling_set_point_celsius?: number | undefined;
7265
7702
  min_cooling_set_point_fahrenheit?: number | undefined;
7266
7703
  max_cooling_set_point_celsius?: number | undefined;
@@ -7619,42 +8056,67 @@ export interface Routes {
7619
8056
  is_heating?: boolean | undefined;
7620
8057
  is_cooling?: boolean | undefined;
7621
8058
  is_fan_running?: boolean | undefined;
8059
+ /**
8060
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
7622
8061
  fan_mode_setting?: ('auto' | 'on') | undefined;
7623
8062
  is_temporary_manual_override_active?: boolean | undefined;
7624
8063
  current_climate_setting?: {
7625
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
7626
- cooling_set_point_celsius?: number | undefined;
7627
- heating_set_point_celsius?: number | undefined;
7628
- cooling_set_point_fahrenheit?: number | undefined;
7629
- heating_set_point_fahrenheit?: number | undefined;
7630
- manual_override_allowed: boolean;
8064
+ climate_preset_key?: string | undefined;
8065
+ can_edit?: boolean | undefined;
8066
+ can_delete?: boolean | undefined;
8067
+ name?: (string | null) | undefined;
8068
+ display_name?: string | undefined;
8069
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
8070
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
8071
+ cooling_set_point_celsius?: (number | undefined) | undefined;
8072
+ heating_set_point_celsius?: (number | undefined) | undefined;
8073
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8074
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
8075
+ manual_override_allowed?: boolean | undefined;
7631
8076
  } | undefined;
8077
+ /**
8078
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
7632
8079
  default_climate_setting?: {
7633
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
8080
+ climate_preset_key?: string | undefined;
8081
+ can_edit?: boolean | undefined;
8082
+ can_delete?: boolean | undefined;
8083
+ name?: (string | null) | undefined;
8084
+ display_name?: string | undefined;
8085
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
8086
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
8087
+ cooling_set_point_celsius?: (number | undefined) | undefined;
8088
+ heating_set_point_celsius?: (number | undefined) | undefined;
8089
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8090
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
8091
+ manual_override_allowed?: boolean | undefined;
8092
+ } | undefined;
8093
+ available_climate_presets?: Array<{
8094
+ climate_preset_key: string;
8095
+ can_edit: boolean;
8096
+ can_delete: boolean;
8097
+ name: string | null;
8098
+ display_name: string;
8099
+ fan_mode_setting?: ('auto' | 'on') | undefined;
8100
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7634
8101
  cooling_set_point_celsius?: number | undefined;
7635
8102
  heating_set_point_celsius?: number | undefined;
7636
8103
  cooling_set_point_fahrenheit?: number | undefined;
7637
8104
  heating_set_point_fahrenheit?: number | undefined;
7638
8105
  manual_override_allowed: boolean;
7639
- } | undefined;
7640
- is_climate_setting_schedule_active?: boolean | undefined;
7641
- active_climate_setting_schedule?: {
7642
- climate_setting_schedule_id: string;
7643
- schedule_type: 'time_bound';
8106
+ }> | undefined;
8107
+ fallback_climate_preset_key?: (string | null) | undefined;
8108
+ active_thermostat_schedule?: ({
8109
+ thermostat_schedule_id: string;
7644
8110
  device_id: string;
7645
8111
  name?: string | undefined;
7646
- schedule_starts_at: string;
7647
- schedule_ends_at: string;
8112
+ climate_preset_key: string;
8113
+ max_override_period_minutes?: number;
8114
+ starts_at: string;
8115
+ ends_at: string;
7648
8116
  created_at: string;
7649
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8117
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7650
8118
  errors?: any;
7651
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
7652
- cooling_set_point_celsius?: (number | undefined) | undefined;
7653
- heating_set_point_celsius?: (number | undefined) | undefined;
7654
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
7655
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
7656
- manual_override_allowed?: boolean | undefined;
7657
- } | undefined;
8119
+ } | null) | undefined;
7658
8120
  min_cooling_set_point_celsius?: number | undefined;
7659
8121
  min_cooling_set_point_fahrenheit?: number | undefined;
7660
8122
  max_cooling_set_point_celsius?: number | undefined;
@@ -7914,6 +8376,30 @@ export interface Routes {
7914
8376
  type: string;
7915
8377
  message: string;
7916
8378
  };
8379
+ } | {
8380
+ /** The ID of the action attempt. */
8381
+ action_attempt_id: string;
8382
+ status: 'pending';
8383
+ result: null;
8384
+ error: null;
8385
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8386
+ } | {
8387
+ /** The ID of the action attempt. */
8388
+ action_attempt_id: string;
8389
+ status: 'success';
8390
+ error: null;
8391
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8392
+ result: {};
8393
+ } | {
8394
+ /** The ID of the action attempt. */
8395
+ action_attempt_id: string;
8396
+ status: 'error';
8397
+ result: null;
8398
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8399
+ error: {
8400
+ type: string;
8401
+ message: string;
8402
+ };
7917
8403
  } | {
7918
8404
  /** The ID of the action attempt. */
7919
8405
  action_attempt_id: string;
@@ -8294,20 +8780,20 @@ export interface Routes {
8294
8780
  status: 'pending';
8295
8781
  result: null;
8296
8782
  error: null;
8297
- action_type: 'SYNC_ACCESS_CODES';
8783
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8298
8784
  } | {
8299
8785
  /** The ID of the action attempt. */
8300
8786
  action_attempt_id: string;
8301
8787
  status: 'success';
8302
8788
  error: null;
8303
- action_type: 'SYNC_ACCESS_CODES';
8304
- result?: any;
8789
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8790
+ result: {};
8305
8791
  } | {
8306
8792
  /** The ID of the action attempt. */
8307
8793
  action_attempt_id: string;
8308
8794
  status: 'error';
8309
8795
  result: null;
8310
- action_type: 'SYNC_ACCESS_CODES';
8796
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
8311
8797
  error: {
8312
8798
  type: string;
8313
8799
  message: string;
@@ -8318,20 +8804,20 @@ export interface Routes {
8318
8804
  status: 'pending';
8319
8805
  result: null;
8320
8806
  error: null;
8321
- action_type: 'CREATE_ACCESS_CODE';
8807
+ action_type: 'SYNC_ACCESS_CODES';
8322
8808
  } | {
8323
8809
  /** The ID of the action attempt. */
8324
8810
  action_attempt_id: string;
8325
8811
  status: 'success';
8326
8812
  error: null;
8327
- action_type: 'CREATE_ACCESS_CODE';
8813
+ action_type: 'SYNC_ACCESS_CODES';
8328
8814
  result?: any;
8329
8815
  } | {
8330
8816
  /** The ID of the action attempt. */
8331
8817
  action_attempt_id: string;
8332
8818
  status: 'error';
8333
8819
  result: null;
8334
- action_type: 'CREATE_ACCESS_CODE';
8820
+ action_type: 'SYNC_ACCESS_CODES';
8335
8821
  error: {
8336
8822
  type: string;
8337
8823
  message: string;
@@ -8342,13 +8828,37 @@ export interface Routes {
8342
8828
  status: 'pending';
8343
8829
  result: null;
8344
8830
  error: null;
8345
- action_type: 'DELETE_ACCESS_CODE';
8831
+ action_type: 'CREATE_ACCESS_CODE';
8346
8832
  } | {
8347
8833
  /** The ID of the action attempt. */
8348
8834
  action_attempt_id: string;
8349
8835
  status: 'success';
8350
8836
  error: null;
8351
- action_type: 'DELETE_ACCESS_CODE';
8837
+ action_type: 'CREATE_ACCESS_CODE';
8838
+ result?: any;
8839
+ } | {
8840
+ /** The ID of the action attempt. */
8841
+ action_attempt_id: string;
8842
+ status: 'error';
8843
+ result: null;
8844
+ action_type: 'CREATE_ACCESS_CODE';
8845
+ error: {
8846
+ type: string;
8847
+ message: string;
8848
+ };
8849
+ } | {
8850
+ /** The ID of the action attempt. */
8851
+ action_attempt_id: string;
8852
+ status: 'pending';
8853
+ result: null;
8854
+ error: null;
8855
+ action_type: 'DELETE_ACCESS_CODE';
8856
+ } | {
8857
+ /** The ID of the action attempt. */
8858
+ action_attempt_id: string;
8859
+ status: 'success';
8860
+ error: null;
8861
+ action_type: 'DELETE_ACCESS_CODE';
8352
8862
  result?: any;
8353
8863
  } | {
8354
8864
  /** The ID of the action attempt. */
@@ -8820,42 +9330,67 @@ export interface Routes {
8820
9330
  is_heating?: boolean | undefined;
8821
9331
  is_cooling?: boolean | undefined;
8822
9332
  is_fan_running?: boolean | undefined;
9333
+ /**
9334
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8823
9335
  fan_mode_setting?: ('auto' | 'on') | undefined;
8824
9336
  is_temporary_manual_override_active?: boolean | undefined;
8825
9337
  current_climate_setting?: {
8826
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
8827
- cooling_set_point_celsius?: number | undefined;
8828
- heating_set_point_celsius?: number | undefined;
8829
- cooling_set_point_fahrenheit?: number | undefined;
8830
- heating_set_point_fahrenheit?: number | undefined;
8831
- manual_override_allowed: boolean;
9338
+ climate_preset_key?: string | undefined;
9339
+ can_edit?: boolean | undefined;
9340
+ can_delete?: boolean | undefined;
9341
+ name?: (string | null) | undefined;
9342
+ display_name?: string | undefined;
9343
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9344
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9345
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9346
+ heating_set_point_celsius?: (number | undefined) | undefined;
9347
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9348
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9349
+ manual_override_allowed?: boolean | undefined;
8832
9350
  } | undefined;
9351
+ /**
9352
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8833
9353
  default_climate_setting?: {
8834
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9354
+ climate_preset_key?: string | undefined;
9355
+ can_edit?: boolean | undefined;
9356
+ can_delete?: boolean | undefined;
9357
+ name?: (string | null) | undefined;
9358
+ display_name?: string | undefined;
9359
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9360
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9361
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9362
+ heating_set_point_celsius?: (number | undefined) | undefined;
9363
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9364
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9365
+ manual_override_allowed?: boolean | undefined;
9366
+ } | undefined;
9367
+ available_climate_presets?: Array<{
9368
+ climate_preset_key: string;
9369
+ can_edit: boolean;
9370
+ can_delete: boolean;
9371
+ name: string | null;
9372
+ display_name: string;
9373
+ fan_mode_setting?: ('auto' | 'on') | undefined;
9374
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
8835
9375
  cooling_set_point_celsius?: number | undefined;
8836
9376
  heating_set_point_celsius?: number | undefined;
8837
9377
  cooling_set_point_fahrenheit?: number | undefined;
8838
9378
  heating_set_point_fahrenheit?: number | undefined;
8839
9379
  manual_override_allowed: boolean;
8840
- } | undefined;
8841
- is_climate_setting_schedule_active?: boolean | undefined;
8842
- active_climate_setting_schedule?: {
8843
- climate_setting_schedule_id: string;
8844
- schedule_type: 'time_bound';
9380
+ }> | undefined;
9381
+ fallback_climate_preset_key?: (string | null) | undefined;
9382
+ active_thermostat_schedule?: ({
9383
+ thermostat_schedule_id: string;
8845
9384
  device_id: string;
8846
9385
  name?: string | undefined;
8847
- schedule_starts_at: string;
8848
- schedule_ends_at: string;
9386
+ climate_preset_key: string;
9387
+ max_override_period_minutes?: number;
9388
+ starts_at: string;
9389
+ ends_at: string;
8849
9390
  created_at: string;
8850
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9391
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8851
9392
  errors?: any;
8852
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
8853
- cooling_set_point_celsius?: (number | undefined) | undefined;
8854
- heating_set_point_celsius?: (number | undefined) | undefined;
8855
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
8856
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
8857
- manual_override_allowed?: boolean | undefined;
8858
- } | undefined;
9393
+ } | null) | undefined;
8859
9394
  min_cooling_set_point_celsius?: number | undefined;
8860
9395
  min_cooling_set_point_fahrenheit?: number | undefined;
8861
9396
  max_cooling_set_point_celsius?: number | undefined;
@@ -9214,42 +9749,67 @@ export interface Routes {
9214
9749
  is_heating?: boolean | undefined;
9215
9750
  is_cooling?: boolean | undefined;
9216
9751
  is_fan_running?: boolean | undefined;
9752
+ /**
9753
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9217
9754
  fan_mode_setting?: ('auto' | 'on') | undefined;
9218
9755
  is_temporary_manual_override_active?: boolean | undefined;
9219
9756
  current_climate_setting?: {
9220
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9221
- cooling_set_point_celsius?: number | undefined;
9222
- heating_set_point_celsius?: number | undefined;
9223
- cooling_set_point_fahrenheit?: number | undefined;
9224
- heating_set_point_fahrenheit?: number | undefined;
9225
- manual_override_allowed: boolean;
9757
+ climate_preset_key?: string | undefined;
9758
+ can_edit?: boolean | undefined;
9759
+ can_delete?: boolean | undefined;
9760
+ name?: (string | null) | undefined;
9761
+ display_name?: string | undefined;
9762
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9763
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9764
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9765
+ heating_set_point_celsius?: (number | undefined) | undefined;
9766
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9767
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9768
+ manual_override_allowed?: boolean | undefined;
9226
9769
  } | undefined;
9770
+ /**
9771
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9227
9772
  default_climate_setting?: {
9228
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
9773
+ climate_preset_key?: string | undefined;
9774
+ can_edit?: boolean | undefined;
9775
+ can_delete?: boolean | undefined;
9776
+ name?: (string | null) | undefined;
9777
+ display_name?: string | undefined;
9778
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
9779
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
9780
+ cooling_set_point_celsius?: (number | undefined) | undefined;
9781
+ heating_set_point_celsius?: (number | undefined) | undefined;
9782
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9783
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
9784
+ manual_override_allowed?: boolean | undefined;
9785
+ } | undefined;
9786
+ available_climate_presets?: Array<{
9787
+ climate_preset_key: string;
9788
+ can_edit: boolean;
9789
+ can_delete: boolean;
9790
+ name: string | null;
9791
+ display_name: string;
9792
+ fan_mode_setting?: ('auto' | 'on') | undefined;
9793
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
9229
9794
  cooling_set_point_celsius?: number | undefined;
9230
9795
  heating_set_point_celsius?: number | undefined;
9231
9796
  cooling_set_point_fahrenheit?: number | undefined;
9232
9797
  heating_set_point_fahrenheit?: number | undefined;
9233
9798
  manual_override_allowed: boolean;
9234
- } | undefined;
9235
- is_climate_setting_schedule_active?: boolean | undefined;
9236
- active_climate_setting_schedule?: {
9237
- climate_setting_schedule_id: string;
9238
- schedule_type: 'time_bound';
9799
+ }> | undefined;
9800
+ fallback_climate_preset_key?: (string | null) | undefined;
9801
+ active_thermostat_schedule?: ({
9802
+ thermostat_schedule_id: string;
9239
9803
  device_id: string;
9240
9804
  name?: string | undefined;
9241
- schedule_starts_at: string;
9242
- schedule_ends_at: string;
9805
+ climate_preset_key: string;
9806
+ max_override_period_minutes?: number;
9807
+ starts_at: string;
9808
+ ends_at: string;
9243
9809
  created_at: string;
9244
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9810
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9245
9811
  errors?: any;
9246
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
9247
- cooling_set_point_celsius?: (number | undefined) | undefined;
9248
- heating_set_point_celsius?: (number | undefined) | undefined;
9249
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
9250
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
9251
- manual_override_allowed?: boolean | undefined;
9252
- } | undefined;
9812
+ } | null) | undefined;
9253
9813
  min_cooling_set_point_celsius?: number | undefined;
9254
9814
  min_cooling_set_point_fahrenheit?: number | undefined;
9255
9815
  max_cooling_set_point_celsius?: number | undefined;
@@ -9514,6 +10074,30 @@ export interface Routes {
9514
10074
  type: string;
9515
10075
  message: string;
9516
10076
  };
10077
+ } | {
10078
+ /** The ID of the action attempt. */
10079
+ action_attempt_id: string;
10080
+ status: 'pending';
10081
+ result: null;
10082
+ error: null;
10083
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10084
+ } | {
10085
+ /** The ID of the action attempt. */
10086
+ action_attempt_id: string;
10087
+ status: 'success';
10088
+ error: null;
10089
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10090
+ result: {};
10091
+ } | {
10092
+ /** The ID of the action attempt. */
10093
+ action_attempt_id: string;
10094
+ status: 'error';
10095
+ result: null;
10096
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10097
+ error: {
10098
+ type: string;
10099
+ message: string;
10100
+ };
9517
10101
  } | {
9518
10102
  /** The ID of the action attempt. */
9519
10103
  action_attempt_id: string;
@@ -9898,6 +10482,30 @@ export interface Routes {
9898
10482
  type: string;
9899
10483
  message: string;
9900
10484
  };
10485
+ } | {
10486
+ /** The ID of the action attempt. */
10487
+ action_attempt_id: string;
10488
+ status: 'pending';
10489
+ result: null;
10490
+ error: null;
10491
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10492
+ } | {
10493
+ /** The ID of the action attempt. */
10494
+ action_attempt_id: string;
10495
+ status: 'success';
10496
+ error: null;
10497
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10498
+ result: {};
10499
+ } | {
10500
+ /** The ID of the action attempt. */
10501
+ action_attempt_id: string;
10502
+ status: 'error';
10503
+ result: null;
10504
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10505
+ error: {
10506
+ type: string;
10507
+ message: string;
10508
+ };
9901
10509
  } | {
9902
10510
  /** The ID of the action attempt. */
9903
10511
  action_attempt_id: string;
@@ -10321,6 +10929,30 @@ export interface Routes {
10321
10929
  type: string;
10322
10930
  message: string;
10323
10931
  };
10932
+ } | {
10933
+ /** The ID of the action attempt. */
10934
+ action_attempt_id: string;
10935
+ status: 'pending';
10936
+ result: null;
10937
+ error: null;
10938
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10939
+ } | {
10940
+ /** The ID of the action attempt. */
10941
+ action_attempt_id: string;
10942
+ status: 'success';
10943
+ error: null;
10944
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10945
+ result: {};
10946
+ } | {
10947
+ /** The ID of the action attempt. */
10948
+ action_attempt_id: string;
10949
+ status: 'error';
10950
+ result: null;
10951
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
10952
+ error: {
10953
+ type: string;
10954
+ message: string;
10955
+ };
10324
10956
  } | {
10325
10957
  /** The ID of the action attempt. */
10326
10958
  action_attempt_id: string;
@@ -10674,164 +11306,13 @@ export interface Routes {
10674
11306
  };
10675
11307
  };
10676
11308
  };
10677
- '/thermostats/climate_setting_schedules/create': {
10678
- route: '/thermostats/climate_setting_schedules/create';
10679
- method: 'POST';
10680
- queryParams: {};
10681
- jsonBody: {
10682
- schedule_type?: 'time_bound';
10683
- device_id: string;
10684
- name?: string | undefined;
10685
- schedule_starts_at: string;
10686
- schedule_ends_at: string;
10687
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10688
- cooling_set_point_celsius?: (number | undefined) | undefined;
10689
- heating_set_point_celsius?: (number | undefined) | undefined;
10690
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10691
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10692
- manual_override_allowed?: boolean | undefined;
10693
- };
10694
- commonParams: {};
10695
- formData: {};
10696
- jsonResponse: {
10697
- climate_setting_schedule: {
10698
- climate_setting_schedule_id: string;
10699
- schedule_type: 'time_bound';
10700
- device_id: string;
10701
- name?: string | undefined;
10702
- schedule_starts_at: string;
10703
- schedule_ends_at: string;
10704
- created_at: string;
10705
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10706
- errors?: any;
10707
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10708
- cooling_set_point_celsius?: (number | undefined) | undefined;
10709
- heating_set_point_celsius?: (number | undefined) | undefined;
10710
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10711
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10712
- manual_override_allowed?: boolean | undefined;
10713
- };
10714
- };
10715
- };
10716
- '/thermostats/climate_setting_schedules/delete': {
10717
- route: '/thermostats/climate_setting_schedules/delete';
10718
- method: 'DELETE' | 'POST' | 'PUT';
10719
- queryParams: {};
10720
- jsonBody: {};
10721
- commonParams: {
10722
- climate_setting_schedule_id: string;
10723
- };
10724
- formData: {};
10725
- jsonResponse: {};
10726
- };
10727
- '/thermostats/climate_setting_schedules/get': {
10728
- route: '/thermostats/climate_setting_schedules/get';
10729
- method: 'GET' | 'POST';
10730
- queryParams: {};
10731
- jsonBody: {};
10732
- commonParams: {
10733
- climate_setting_schedule_id?: string | undefined;
10734
- device_id?: string | undefined;
10735
- };
10736
- formData: {};
10737
- jsonResponse: {
10738
- climate_setting_schedule: {
10739
- climate_setting_schedule_id: string;
10740
- schedule_type: 'time_bound';
10741
- device_id: string;
10742
- name?: string | undefined;
10743
- schedule_starts_at: string;
10744
- schedule_ends_at: string;
10745
- created_at: string;
10746
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10747
- errors?: any;
10748
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10749
- cooling_set_point_celsius?: (number | undefined) | undefined;
10750
- heating_set_point_celsius?: (number | undefined) | undefined;
10751
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10752
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10753
- manual_override_allowed?: boolean | undefined;
10754
- };
10755
- };
10756
- };
10757
- '/thermostats/climate_setting_schedules/list': {
10758
- route: '/thermostats/climate_setting_schedules/list';
10759
- method: 'GET' | 'POST';
10760
- queryParams: {};
10761
- jsonBody: {};
10762
- commonParams: {
10763
- device_id: string;
10764
- user_identifier_key?: string | undefined;
10765
- };
10766
- formData: {};
10767
- jsonResponse: {
10768
- climate_setting_schedules: Array<{
10769
- climate_setting_schedule_id: string;
10770
- schedule_type: 'time_bound';
10771
- device_id: string;
10772
- name?: string | undefined;
10773
- schedule_starts_at: string;
10774
- schedule_ends_at: string;
10775
- created_at: string;
10776
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10777
- errors?: any;
10778
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10779
- cooling_set_point_celsius?: (number | undefined) | undefined;
10780
- heating_set_point_celsius?: (number | undefined) | undefined;
10781
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10782
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10783
- manual_override_allowed?: boolean | undefined;
10784
- }>;
10785
- };
10786
- };
10787
- '/thermostats/climate_setting_schedules/update': {
10788
- route: '/thermostats/climate_setting_schedules/update';
10789
- method: 'PATCH' | 'POST' | 'PUT';
10790
- queryParams: {};
10791
- jsonBody: {
10792
- climate_setting_schedule_id: string;
10793
- schedule_type?: 'time_bound';
10794
- name?: string | undefined;
10795
- schedule_starts_at?: string | undefined;
10796
- schedule_ends_at?: string | undefined;
10797
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10798
- cooling_set_point_celsius?: (number | undefined) | undefined;
10799
- heating_set_point_celsius?: (number | undefined) | undefined;
10800
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10801
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10802
- manual_override_allowed?: boolean | undefined;
10803
- };
10804
- commonParams: {};
10805
- formData: {};
10806
- jsonResponse: {
10807
- climate_setting_schedule: {
10808
- climate_setting_schedule_id: string;
10809
- schedule_type: 'time_bound';
10810
- device_id: string;
10811
- name?: string | undefined;
10812
- schedule_starts_at: string;
10813
- schedule_ends_at: string;
10814
- created_at: string;
10815
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
10816
- errors?: any;
10817
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10818
- cooling_set_point_celsius?: (number | undefined) | undefined;
10819
- heating_set_point_celsius?: (number | undefined) | undefined;
10820
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10821
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
10822
- manual_override_allowed?: boolean | undefined;
10823
- };
10824
- };
10825
- };
10826
- '/thermostats/cool': {
10827
- route: '/thermostats/cool';
11309
+ '/thermostats/activate_climate_preset': {
11310
+ route: '/thermostats/activate_climate_preset';
10828
11311
  method: 'POST';
10829
11312
  queryParams: {};
10830
11313
  jsonBody: {
10831
11314
  device_id: string;
10832
- cooling_set_point_celsius?: number | undefined;
10833
- cooling_set_point_fahrenheit?: number | undefined;
10834
- sync?: boolean;
11315
+ climate_preset_key: string;
10835
11316
  };
10836
11317
  commonParams: {};
10837
11318
  formData: {};
@@ -11028,6 +11509,30 @@ export interface Routes {
11028
11509
  type: string;
11029
11510
  message: string;
11030
11511
  };
11512
+ } | {
11513
+ /** The ID of the action attempt. */
11514
+ action_attempt_id: string;
11515
+ status: 'pending';
11516
+ result: null;
11517
+ error: null;
11518
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11519
+ } | {
11520
+ /** The ID of the action attempt. */
11521
+ action_attempt_id: string;
11522
+ status: 'success';
11523
+ error: null;
11524
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11525
+ result: {};
11526
+ } | {
11527
+ /** The ID of the action attempt. */
11528
+ action_attempt_id: string;
11529
+ status: 'error';
11530
+ result: null;
11531
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11532
+ error: {
11533
+ type: string;
11534
+ message: string;
11535
+ };
11031
11536
  } | {
11032
11537
  /** The ID of the action attempt. */
11033
11538
  action_attempt_id: string;
@@ -11199,9 +11704,456 @@ export interface Routes {
11199
11704
  };
11200
11705
  };
11201
11706
  };
11202
- '/thermostats/get': {
11203
- route: '/thermostats/get';
11204
- method: 'GET' | 'POST';
11707
+ '/thermostats/cool': {
11708
+ route: '/thermostats/cool';
11709
+ method: 'POST';
11710
+ queryParams: {};
11711
+ jsonBody: {
11712
+ device_id: string;
11713
+ cooling_set_point_celsius?: number | undefined;
11714
+ cooling_set_point_fahrenheit?: number | undefined;
11715
+ sync?: boolean;
11716
+ };
11717
+ commonParams: {};
11718
+ formData: {};
11719
+ jsonResponse: {
11720
+ action_attempt: {
11721
+ /** The ID of the action attempt. */
11722
+ action_attempt_id: string;
11723
+ status: 'pending';
11724
+ result: null;
11725
+ error: null;
11726
+ action_type: 'LOCK_DOOR';
11727
+ } | {
11728
+ /** The ID of the action attempt. */
11729
+ action_attempt_id: string;
11730
+ status: 'success';
11731
+ error: null;
11732
+ action_type: 'LOCK_DOOR';
11733
+ result: {};
11734
+ } | {
11735
+ /** The ID of the action attempt. */
11736
+ action_attempt_id: string;
11737
+ status: 'error';
11738
+ result: null;
11739
+ action_type: 'LOCK_DOOR';
11740
+ error: {
11741
+ type: string;
11742
+ message: string;
11743
+ };
11744
+ } | {
11745
+ /** The ID of the action attempt. */
11746
+ action_attempt_id: string;
11747
+ status: 'pending';
11748
+ result: null;
11749
+ error: null;
11750
+ action_type: 'UNLOCK_DOOR';
11751
+ } | {
11752
+ /** The ID of the action attempt. */
11753
+ action_attempt_id: string;
11754
+ status: 'success';
11755
+ error: null;
11756
+ action_type: 'UNLOCK_DOOR';
11757
+ result: {};
11758
+ } | {
11759
+ /** The ID of the action attempt. */
11760
+ action_attempt_id: string;
11761
+ status: 'error';
11762
+ result: null;
11763
+ action_type: 'UNLOCK_DOOR';
11764
+ error: {
11765
+ type: string;
11766
+ message: string;
11767
+ };
11768
+ } | {
11769
+ /** The ID of the action attempt. */
11770
+ action_attempt_id: string;
11771
+ status: 'pending';
11772
+ result: null;
11773
+ error: null;
11774
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11775
+ } | {
11776
+ /** The ID of the action attempt. */
11777
+ action_attempt_id: string;
11778
+ status: 'success';
11779
+ error: null;
11780
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11781
+ result: {};
11782
+ } | {
11783
+ /** The ID of the action attempt. */
11784
+ action_attempt_id: string;
11785
+ status: 'error';
11786
+ result: null;
11787
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11788
+ error: {
11789
+ type: string;
11790
+ message: string;
11791
+ };
11792
+ } | {
11793
+ /** The ID of the action attempt. */
11794
+ action_attempt_id: string;
11795
+ status: 'pending';
11796
+ result: null;
11797
+ error: null;
11798
+ action_type: 'SET_COOL';
11799
+ } | {
11800
+ /** The ID of the action attempt. */
11801
+ action_attempt_id: string;
11802
+ status: 'success';
11803
+ error: null;
11804
+ action_type: 'SET_COOL';
11805
+ result: {};
11806
+ } | {
11807
+ /** The ID of the action attempt. */
11808
+ action_attempt_id: string;
11809
+ status: 'error';
11810
+ result: null;
11811
+ action_type: 'SET_COOL';
11812
+ error: {
11813
+ type: string;
11814
+ message: string;
11815
+ };
11816
+ } | {
11817
+ /** The ID of the action attempt. */
11818
+ action_attempt_id: string;
11819
+ status: 'pending';
11820
+ result: null;
11821
+ error: null;
11822
+ action_type: 'SET_HEAT';
11823
+ } | {
11824
+ /** The ID of the action attempt. */
11825
+ action_attempt_id: string;
11826
+ status: 'success';
11827
+ error: null;
11828
+ action_type: 'SET_HEAT';
11829
+ result: {};
11830
+ } | {
11831
+ /** The ID of the action attempt. */
11832
+ action_attempt_id: string;
11833
+ status: 'error';
11834
+ result: null;
11835
+ action_type: 'SET_HEAT';
11836
+ error: {
11837
+ type: string;
11838
+ message: string;
11839
+ };
11840
+ } | {
11841
+ /** The ID of the action attempt. */
11842
+ action_attempt_id: string;
11843
+ status: 'pending';
11844
+ result: null;
11845
+ error: null;
11846
+ action_type: 'SET_HEAT_COOL';
11847
+ } | {
11848
+ /** The ID of the action attempt. */
11849
+ action_attempt_id: string;
11850
+ status: 'success';
11851
+ error: null;
11852
+ action_type: 'SET_HEAT_COOL';
11853
+ result: {};
11854
+ } | {
11855
+ /** The ID of the action attempt. */
11856
+ action_attempt_id: string;
11857
+ status: 'error';
11858
+ result: null;
11859
+ action_type: 'SET_HEAT_COOL';
11860
+ error: {
11861
+ type: string;
11862
+ message: string;
11863
+ };
11864
+ } | {
11865
+ /** The ID of the action attempt. */
11866
+ action_attempt_id: string;
11867
+ status: 'pending';
11868
+ result: null;
11869
+ error: null;
11870
+ action_type: 'SET_FAN_MODE';
11871
+ } | {
11872
+ /** The ID of the action attempt. */
11873
+ action_attempt_id: string;
11874
+ status: 'success';
11875
+ error: null;
11876
+ action_type: 'SET_FAN_MODE';
11877
+ result: {};
11878
+ } | {
11879
+ /** The ID of the action attempt. */
11880
+ action_attempt_id: string;
11881
+ status: 'error';
11882
+ result: null;
11883
+ action_type: 'SET_FAN_MODE';
11884
+ error: {
11885
+ type: string;
11886
+ message: string;
11887
+ };
11888
+ } | {
11889
+ /** The ID of the action attempt. */
11890
+ action_attempt_id: string;
11891
+ status: 'pending';
11892
+ result: null;
11893
+ error: null;
11894
+ action_type: 'SET_THERMOSTAT_OFF';
11895
+ } | {
11896
+ /** The ID of the action attempt. */
11897
+ action_attempt_id: string;
11898
+ status: 'success';
11899
+ error: null;
11900
+ action_type: 'SET_THERMOSTAT_OFF';
11901
+ result: {};
11902
+ } | {
11903
+ /** The ID of the action attempt. */
11904
+ action_attempt_id: string;
11905
+ status: 'error';
11906
+ result: null;
11907
+ action_type: 'SET_THERMOSTAT_OFF';
11908
+ error: {
11909
+ type: string;
11910
+ message: string;
11911
+ };
11912
+ } | {
11913
+ /** The ID of the action attempt. */
11914
+ action_attempt_id: string;
11915
+ status: 'pending';
11916
+ result: null;
11917
+ error: null;
11918
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11919
+ } | {
11920
+ /** The ID of the action attempt. */
11921
+ action_attempt_id: string;
11922
+ status: 'success';
11923
+ error: null;
11924
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11925
+ result: {};
11926
+ } | {
11927
+ /** The ID of the action attempt. */
11928
+ action_attempt_id: string;
11929
+ status: 'error';
11930
+ result: null;
11931
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
11932
+ error: {
11933
+ type: string;
11934
+ message: string;
11935
+ };
11936
+ } | {
11937
+ /** The ID of the action attempt. */
11938
+ action_attempt_id: string;
11939
+ status: 'pending';
11940
+ result: null;
11941
+ error: null;
11942
+ action_type: 'SYNC_ACCESS_CODES';
11943
+ } | {
11944
+ /** The ID of the action attempt. */
11945
+ action_attempt_id: string;
11946
+ status: 'success';
11947
+ error: null;
11948
+ action_type: 'SYNC_ACCESS_CODES';
11949
+ result?: any;
11950
+ } | {
11951
+ /** The ID of the action attempt. */
11952
+ action_attempt_id: string;
11953
+ status: 'error';
11954
+ result: null;
11955
+ action_type: 'SYNC_ACCESS_CODES';
11956
+ error: {
11957
+ type: string;
11958
+ message: string;
11959
+ };
11960
+ } | {
11961
+ /** The ID of the action attempt. */
11962
+ action_attempt_id: string;
11963
+ status: 'pending';
11964
+ result: null;
11965
+ error: null;
11966
+ action_type: 'CREATE_ACCESS_CODE';
11967
+ } | {
11968
+ /** The ID of the action attempt. */
11969
+ action_attempt_id: string;
11970
+ status: 'success';
11971
+ error: null;
11972
+ action_type: 'CREATE_ACCESS_CODE';
11973
+ result?: any;
11974
+ } | {
11975
+ /** The ID of the action attempt. */
11976
+ action_attempt_id: string;
11977
+ status: 'error';
11978
+ result: null;
11979
+ action_type: 'CREATE_ACCESS_CODE';
11980
+ error: {
11981
+ type: string;
11982
+ message: string;
11983
+ };
11984
+ } | {
11985
+ /** The ID of the action attempt. */
11986
+ action_attempt_id: string;
11987
+ status: 'pending';
11988
+ result: null;
11989
+ error: null;
11990
+ action_type: 'DELETE_ACCESS_CODE';
11991
+ } | {
11992
+ /** The ID of the action attempt. */
11993
+ action_attempt_id: string;
11994
+ status: 'success';
11995
+ error: null;
11996
+ action_type: 'DELETE_ACCESS_CODE';
11997
+ result?: any;
11998
+ } | {
11999
+ /** The ID of the action attempt. */
12000
+ action_attempt_id: string;
12001
+ status: 'error';
12002
+ result: null;
12003
+ action_type: 'DELETE_ACCESS_CODE';
12004
+ error: {
12005
+ type: string;
12006
+ message: string;
12007
+ };
12008
+ } | {
12009
+ /** The ID of the action attempt. */
12010
+ action_attempt_id: string;
12011
+ status: 'pending';
12012
+ result: null;
12013
+ error: null;
12014
+ action_type: 'UPDATE_ACCESS_CODE';
12015
+ } | {
12016
+ /** The ID of the action attempt. */
12017
+ action_attempt_id: string;
12018
+ status: 'success';
12019
+ error: null;
12020
+ action_type: 'UPDATE_ACCESS_CODE';
12021
+ result?: any;
12022
+ } | {
12023
+ /** The ID of the action attempt. */
12024
+ action_attempt_id: string;
12025
+ status: 'error';
12026
+ result: null;
12027
+ action_type: 'UPDATE_ACCESS_CODE';
12028
+ error: {
12029
+ type: string;
12030
+ message: string;
12031
+ };
12032
+ } | {
12033
+ /** The ID of the action attempt. */
12034
+ action_attempt_id: string;
12035
+ status: 'pending';
12036
+ result: null;
12037
+ error: null;
12038
+ action_type: 'CREATE_NOISE_THRESHOLD';
12039
+ } | {
12040
+ /** The ID of the action attempt. */
12041
+ action_attempt_id: string;
12042
+ status: 'success';
12043
+ error: null;
12044
+ action_type: 'CREATE_NOISE_THRESHOLD';
12045
+ result?: any;
12046
+ } | {
12047
+ /** The ID of the action attempt. */
12048
+ action_attempt_id: string;
12049
+ status: 'error';
12050
+ result: null;
12051
+ action_type: 'CREATE_NOISE_THRESHOLD';
12052
+ error: {
12053
+ type: string;
12054
+ message: string;
12055
+ };
12056
+ } | {
12057
+ /** The ID of the action attempt. */
12058
+ action_attempt_id: string;
12059
+ status: 'pending';
12060
+ result: null;
12061
+ error: null;
12062
+ action_type: 'DELETE_NOISE_THRESHOLD';
12063
+ } | {
12064
+ /** The ID of the action attempt. */
12065
+ action_attempt_id: string;
12066
+ status: 'success';
12067
+ error: null;
12068
+ action_type: 'DELETE_NOISE_THRESHOLD';
12069
+ result?: any;
12070
+ } | {
12071
+ /** The ID of the action attempt. */
12072
+ action_attempt_id: string;
12073
+ status: 'error';
12074
+ result: null;
12075
+ action_type: 'DELETE_NOISE_THRESHOLD';
12076
+ error: {
12077
+ type: string;
12078
+ message: string;
12079
+ };
12080
+ } | {
12081
+ /** The ID of the action attempt. */
12082
+ action_attempt_id: string;
12083
+ status: 'pending';
12084
+ result: null;
12085
+ error: null;
12086
+ action_type: 'UPDATE_NOISE_THRESHOLD';
12087
+ } | {
12088
+ /** The ID of the action attempt. */
12089
+ action_attempt_id: string;
12090
+ status: 'success';
12091
+ error: null;
12092
+ action_type: 'UPDATE_NOISE_THRESHOLD';
12093
+ result?: any;
12094
+ } | {
12095
+ /** The ID of the action attempt. */
12096
+ action_attempt_id: string;
12097
+ status: 'error';
12098
+ result: null;
12099
+ action_type: 'UPDATE_NOISE_THRESHOLD';
12100
+ error: {
12101
+ type: string;
12102
+ message: string;
12103
+ };
12104
+ };
12105
+ };
12106
+ };
12107
+ '/thermostats/create_climate_preset': {
12108
+ route: '/thermostats/create_climate_preset';
12109
+ method: 'POST';
12110
+ queryParams: {};
12111
+ jsonBody: {
12112
+ device_id: string;
12113
+ climate_preset_key: string;
12114
+ name: string | null;
12115
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12116
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12117
+ cooling_set_point_celsius?: number | undefined;
12118
+ heating_set_point_celsius?: number | undefined;
12119
+ cooling_set_point_fahrenheit?: number | undefined;
12120
+ heating_set_point_fahrenheit?: number | undefined;
12121
+ manual_override_allowed: boolean;
12122
+ };
12123
+ commonParams: {};
12124
+ formData: {};
12125
+ jsonResponse: {
12126
+ climate_preset: {
12127
+ climate_preset_key: string;
12128
+ can_edit: boolean;
12129
+ can_delete: boolean;
12130
+ name: string | null;
12131
+ display_name: string;
12132
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12133
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12134
+ cooling_set_point_celsius?: number | undefined;
12135
+ heating_set_point_celsius?: number | undefined;
12136
+ cooling_set_point_fahrenheit?: number | undefined;
12137
+ heating_set_point_fahrenheit?: number | undefined;
12138
+ manual_override_allowed: boolean;
12139
+ };
12140
+ };
12141
+ };
12142
+ '/thermostats/delete_climate_preset': {
12143
+ route: '/thermostats/delete_climate_preset';
12144
+ method: 'POST' | 'DELETE';
12145
+ queryParams: {};
12146
+ jsonBody: {
12147
+ device_id: string;
12148
+ climate_preset_key: string;
12149
+ };
12150
+ commonParams: {};
12151
+ formData: {};
12152
+ jsonResponse: {};
12153
+ };
12154
+ '/thermostats/get': {
12155
+ route: '/thermostats/get';
12156
+ method: 'GET' | 'POST';
11205
12157
  queryParams: {};
11206
12158
  jsonBody: {};
11207
12159
  commonParams: {
@@ -11514,42 +12466,67 @@ export interface Routes {
11514
12466
  is_heating?: boolean | undefined;
11515
12467
  is_cooling?: boolean | undefined;
11516
12468
  is_fan_running?: boolean | undefined;
12469
+ /**
12470
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
11517
12471
  fan_mode_setting?: ('auto' | 'on') | undefined;
11518
12472
  is_temporary_manual_override_active?: boolean | undefined;
11519
12473
  current_climate_setting?: {
11520
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11521
- cooling_set_point_celsius?: number | undefined;
11522
- heating_set_point_celsius?: number | undefined;
11523
- cooling_set_point_fahrenheit?: number | undefined;
11524
- heating_set_point_fahrenheit?: number | undefined;
11525
- manual_override_allowed: boolean;
12474
+ climate_preset_key?: string | undefined;
12475
+ can_edit?: boolean | undefined;
12476
+ can_delete?: boolean | undefined;
12477
+ name?: (string | null) | undefined;
12478
+ display_name?: string | undefined;
12479
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
12480
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12481
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12482
+ heating_set_point_celsius?: (number | undefined) | undefined;
12483
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12484
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12485
+ manual_override_allowed?: boolean | undefined;
11526
12486
  } | undefined;
12487
+ /**
12488
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11527
12489
  default_climate_setting?: {
11528
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12490
+ climate_preset_key?: string | undefined;
12491
+ can_edit?: boolean | undefined;
12492
+ can_delete?: boolean | undefined;
12493
+ name?: (string | null) | undefined;
12494
+ display_name?: string | undefined;
12495
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
12496
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12497
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12498
+ heating_set_point_celsius?: (number | undefined) | undefined;
12499
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12500
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12501
+ manual_override_allowed?: boolean | undefined;
12502
+ } | undefined;
12503
+ available_climate_presets?: Array<{
12504
+ climate_preset_key: string;
12505
+ can_edit: boolean;
12506
+ can_delete: boolean;
12507
+ name: string | null;
12508
+ display_name: string;
12509
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12510
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11529
12511
  cooling_set_point_celsius?: number | undefined;
11530
12512
  heating_set_point_celsius?: number | undefined;
11531
12513
  cooling_set_point_fahrenheit?: number | undefined;
11532
12514
  heating_set_point_fahrenheit?: number | undefined;
11533
12515
  manual_override_allowed: boolean;
11534
- } | undefined;
11535
- is_climate_setting_schedule_active?: boolean | undefined;
11536
- active_climate_setting_schedule?: {
11537
- climate_setting_schedule_id: string;
11538
- schedule_type: 'time_bound';
12516
+ }> | undefined;
12517
+ fallback_climate_preset_key?: (string | null) | undefined;
12518
+ active_thermostat_schedule?: ({
12519
+ thermostat_schedule_id: string;
11539
12520
  device_id: string;
11540
12521
  name?: string | undefined;
11541
- schedule_starts_at: string;
11542
- schedule_ends_at: string;
12522
+ climate_preset_key: string;
12523
+ max_override_period_minutes?: number;
12524
+ starts_at: string;
12525
+ ends_at: string;
11543
12526
  created_at: string;
11544
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12527
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
11545
12528
  errors?: any;
11546
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11547
- cooling_set_point_celsius?: (number | undefined) | undefined;
11548
- heating_set_point_celsius?: (number | undefined) | undefined;
11549
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11550
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
11551
- manual_override_allowed?: boolean | undefined;
11552
- } | undefined;
12529
+ } | null) | undefined;
11553
12530
  min_cooling_set_point_celsius?: number | undefined;
11554
12531
  min_cooling_set_point_fahrenheit?: number | undefined;
11555
12532
  max_cooling_set_point_celsius?: number | undefined;
@@ -11811,6 +12788,30 @@ export interface Routes {
11811
12788
  type: string;
11812
12789
  message: string;
11813
12790
  };
12791
+ } | {
12792
+ /** The ID of the action attempt. */
12793
+ action_attempt_id: string;
12794
+ status: 'pending';
12795
+ result: null;
12796
+ error: null;
12797
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12798
+ } | {
12799
+ /** The ID of the action attempt. */
12800
+ action_attempt_id: string;
12801
+ status: 'success';
12802
+ error: null;
12803
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12804
+ result: {};
12805
+ } | {
12806
+ /** The ID of the action attempt. */
12807
+ action_attempt_id: string;
12808
+ status: 'error';
12809
+ result: null;
12810
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
12811
+ error: {
12812
+ type: string;
12813
+ message: string;
12814
+ };
11814
12815
  } | {
11815
12816
  /** The ID of the action attempt. */
11816
12817
  action_attempt_id: string;
@@ -12189,6 +13190,30 @@ export interface Routes {
12189
13190
  type: string;
12190
13191
  message: string;
12191
13192
  };
13193
+ } | {
13194
+ /** The ID of the action attempt. */
13195
+ action_attempt_id: string;
13196
+ status: 'pending';
13197
+ result: null;
13198
+ error: null;
13199
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13200
+ } | {
13201
+ /** The ID of the action attempt. */
13202
+ action_attempt_id: string;
13203
+ status: 'success';
13204
+ error: null;
13205
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13206
+ result: {};
13207
+ } | {
13208
+ /** The ID of the action attempt. */
13209
+ action_attempt_id: string;
13210
+ status: 'error';
13211
+ result: null;
13212
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
13213
+ error: {
13214
+ type: string;
13215
+ message: string;
13216
+ };
12192
13217
  } | {
12193
13218
  /** The ID of the action attempt. */
12194
13219
  action_attempt_id: string;
@@ -12687,42 +13712,67 @@ export interface Routes {
12687
13712
  is_heating?: boolean | undefined;
12688
13713
  is_cooling?: boolean | undefined;
12689
13714
  is_fan_running?: boolean | undefined;
13715
+ /**
13716
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
12690
13717
  fan_mode_setting?: ('auto' | 'on') | undefined;
12691
13718
  is_temporary_manual_override_active?: boolean | undefined;
12692
13719
  current_climate_setting?: {
12693
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12694
- cooling_set_point_celsius?: number | undefined;
12695
- heating_set_point_celsius?: number | undefined;
12696
- cooling_set_point_fahrenheit?: number | undefined;
12697
- heating_set_point_fahrenheit?: number | undefined;
12698
- manual_override_allowed: boolean;
13720
+ climate_preset_key?: string | undefined;
13721
+ can_edit?: boolean | undefined;
13722
+ can_delete?: boolean | undefined;
13723
+ name?: (string | null) | undefined;
13724
+ display_name?: string | undefined;
13725
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
13726
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
13727
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13728
+ heating_set_point_celsius?: (number | undefined) | undefined;
13729
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13730
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13731
+ manual_override_allowed?: boolean | undefined;
12699
13732
  } | undefined;
13733
+ /**
13734
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12700
13735
  default_climate_setting?: {
12701
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12702
- cooling_set_point_celsius?: number | undefined;
12703
- heating_set_point_celsius?: number | undefined;
12704
- cooling_set_point_fahrenheit?: number | undefined;
12705
- heating_set_point_fahrenheit?: number | undefined;
12706
- manual_override_allowed: boolean;
12707
- } | undefined;
12708
- is_climate_setting_schedule_active?: boolean | undefined;
12709
- active_climate_setting_schedule?: {
12710
- climate_setting_schedule_id: string;
12711
- schedule_type: 'time_bound';
12712
- device_id: string;
12713
- name?: string | undefined;
12714
- schedule_starts_at: string;
12715
- schedule_ends_at: string;
12716
- created_at: string;
12717
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
12718
- errors?: any;
12719
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13736
+ climate_preset_key?: string | undefined;
13737
+ can_edit?: boolean | undefined;
13738
+ can_delete?: boolean | undefined;
13739
+ name?: (string | null) | undefined;
13740
+ display_name?: string | undefined;
13741
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
13742
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12720
13743
  cooling_set_point_celsius?: (number | undefined) | undefined;
12721
13744
  heating_set_point_celsius?: (number | undefined) | undefined;
12722
13745
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12723
13746
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
12724
13747
  manual_override_allowed?: boolean | undefined;
12725
13748
  } | undefined;
13749
+ available_climate_presets?: Array<{
13750
+ climate_preset_key: string;
13751
+ can_edit: boolean;
13752
+ can_delete: boolean;
13753
+ name: string | null;
13754
+ display_name: string;
13755
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13756
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13757
+ cooling_set_point_celsius?: number | undefined;
13758
+ heating_set_point_celsius?: number | undefined;
13759
+ cooling_set_point_fahrenheit?: number | undefined;
13760
+ heating_set_point_fahrenheit?: number | undefined;
13761
+ manual_override_allowed: boolean;
13762
+ }> | undefined;
13763
+ fallback_climate_preset_key?: (string | null) | undefined;
13764
+ active_thermostat_schedule?: ({
13765
+ thermostat_schedule_id: string;
13766
+ device_id: string;
13767
+ name?: string | undefined;
13768
+ climate_preset_key: string;
13769
+ max_override_period_minutes?: number;
13770
+ starts_at: string;
13771
+ ends_at: string;
13772
+ created_at: string;
13773
+ /** 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. */
13774
+ errors?: any;
13775
+ } | null) | undefined;
12726
13776
  min_cooling_set_point_celsius?: number | undefined;
12727
13777
  min_cooling_set_point_fahrenheit?: number | undefined;
12728
13778
  max_cooling_set_point_celsius?: number | undefined;
@@ -12982,6 +14032,30 @@ export interface Routes {
12982
14032
  type: string;
12983
14033
  message: string;
12984
14034
  };
14035
+ } | {
14036
+ /** The ID of the action attempt. */
14037
+ action_attempt_id: string;
14038
+ status: 'pending';
14039
+ result: null;
14040
+ error: null;
14041
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14042
+ } | {
14043
+ /** The ID of the action attempt. */
14044
+ action_attempt_id: string;
14045
+ status: 'success';
14046
+ error: null;
14047
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14048
+ result: {};
14049
+ } | {
14050
+ /** The ID of the action attempt. */
14051
+ action_attempt_id: string;
14052
+ status: 'error';
14053
+ result: null;
14054
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14055
+ error: {
14056
+ type: string;
14057
+ message: string;
14058
+ };
12985
14059
  } | {
12986
14060
  /** The ID of the action attempt. */
12987
14061
  action_attempt_id: string;
@@ -13153,12 +14227,144 @@ export interface Routes {
13153
14227
  };
13154
14228
  };
13155
14229
  };
14230
+ '/thermostats/schedules/create': {
14231
+ route: '/thermostats/schedules/create';
14232
+ method: 'POST';
14233
+ queryParams: {};
14234
+ jsonBody: {
14235
+ device_id: string;
14236
+ name?: string | undefined;
14237
+ climate_preset_key: string;
14238
+ max_override_period_minutes?: number;
14239
+ starts_at: string;
14240
+ ends_at: string;
14241
+ };
14242
+ commonParams: {};
14243
+ formData: {};
14244
+ jsonResponse: {
14245
+ thermostat_schedule: {
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/delete': {
14260
+ route: '/thermostats/schedules/delete';
14261
+ method: 'DELETE' | 'POST';
14262
+ queryParams: {};
14263
+ jsonBody: {};
14264
+ commonParams: {
14265
+ thermostat_schedule_id: string;
14266
+ };
14267
+ formData: {};
14268
+ jsonResponse: {};
14269
+ };
14270
+ '/thermostats/schedules/get': {
14271
+ route: '/thermostats/schedules/get';
14272
+ method: 'GET' | 'POST';
14273
+ queryParams: {};
14274
+ jsonBody: {};
14275
+ commonParams: {
14276
+ thermostat_schedule_id: string;
14277
+ };
14278
+ formData: {};
14279
+ jsonResponse: {
14280
+ thermostat_schedule: {
14281
+ thermostat_schedule_id: string;
14282
+ device_id: string;
14283
+ name?: string | undefined;
14284
+ climate_preset_key: string;
14285
+ max_override_period_minutes?: number;
14286
+ starts_at: string;
14287
+ ends_at: string;
14288
+ created_at: string;
14289
+ /** 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. */
14290
+ errors?: any;
14291
+ };
14292
+ };
14293
+ };
14294
+ '/thermostats/schedules/list': {
14295
+ route: '/thermostats/schedules/list';
14296
+ method: 'GET' | 'POST';
14297
+ queryParams: {};
14298
+ jsonBody: {};
14299
+ commonParams: {
14300
+ device_id: string;
14301
+ user_identifier_key?: string | undefined;
14302
+ };
14303
+ formData: {};
14304
+ jsonResponse: {
14305
+ thermostat_schedules: Array<{
14306
+ thermostat_schedule_id: string;
14307
+ device_id: string;
14308
+ name?: string | undefined;
14309
+ climate_preset_key: string;
14310
+ max_override_period_minutes?: number;
14311
+ starts_at: string;
14312
+ ends_at: string;
14313
+ created_at: string;
14314
+ /** 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. */
14315
+ errors?: any;
14316
+ }>;
14317
+ };
14318
+ };
14319
+ '/thermostats/schedules/update': {
14320
+ route: '/thermostats/schedules/update';
14321
+ method: 'PATCH' | 'POST';
14322
+ queryParams: {};
14323
+ jsonBody: {
14324
+ thermostat_schedule_id: string;
14325
+ name?: string | undefined;
14326
+ climate_preset_key?: string | undefined;
14327
+ max_override_period_minutes?: number | undefined;
14328
+ starts_at?: string | undefined;
14329
+ ends_at?: string | undefined;
14330
+ };
14331
+ commonParams: {};
14332
+ formData: {};
14333
+ jsonResponse: {
14334
+ thermostat_schedule: {
14335
+ thermostat_schedule_id: string;
14336
+ device_id: string;
14337
+ name?: string | undefined;
14338
+ climate_preset_key: string;
14339
+ max_override_period_minutes?: number;
14340
+ starts_at: string;
14341
+ ends_at: string;
14342
+ created_at: string;
14343
+ /** 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. */
14344
+ errors?: any;
14345
+ };
14346
+ };
14347
+ };
14348
+ '/thermostats/set_fallback_climate_preset': {
14349
+ route: '/thermostats/set_fallback_climate_preset';
14350
+ method: 'POST';
14351
+ queryParams: {};
14352
+ jsonBody: {
14353
+ device_id: string;
14354
+ climate_preset_key: string;
14355
+ };
14356
+ commonParams: {};
14357
+ formData: {};
14358
+ jsonResponse: {};
14359
+ };
13156
14360
  '/thermostats/set_fan_mode': {
13157
14361
  route: '/thermostats/set_fan_mode';
13158
14362
  method: 'POST';
13159
14363
  queryParams: {};
13160
14364
  jsonBody: {
13161
14365
  device_id: string;
14366
+ /**
14367
+ * @deprecated use fan_mode_setting instead. */
13162
14368
  fan_mode?: ('auto' | 'on') | undefined;
13163
14369
  fan_mode_setting?: ('auto' | 'on') | undefined;
13164
14370
  sync?: boolean;
@@ -13358,6 +14564,30 @@ export interface Routes {
13358
14564
  type: string;
13359
14565
  message: string;
13360
14566
  };
14567
+ } | {
14568
+ /** The ID of the action attempt. */
14569
+ action_attempt_id: string;
14570
+ status: 'pending';
14571
+ result: null;
14572
+ error: null;
14573
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14574
+ } | {
14575
+ /** The ID of the action attempt. */
14576
+ action_attempt_id: string;
14577
+ status: 'success';
14578
+ error: null;
14579
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14580
+ result: {};
14581
+ } | {
14582
+ /** The ID of the action attempt. */
14583
+ action_attempt_id: string;
14584
+ status: 'error';
14585
+ result: null;
14586
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
14587
+ error: {
14588
+ type: string;
14589
+ message: string;
14590
+ };
13361
14591
  } | {
13362
14592
  /** The ID of the action attempt. */
13363
14593
  action_attempt_id: string;
@@ -13529,24 +14759,40 @@ export interface Routes {
13529
14759
  };
13530
14760
  };
13531
14761
  };
13532
- '/thermostats/update': {
13533
- route: '/thermostats/update';
13534
- method: 'PATCH' | 'POST';
14762
+ '/thermostats/update_climate_preset': {
14763
+ route: '/thermostats/update_climate_preset';
14764
+ method: 'POST' | 'PATCH';
13535
14765
  queryParams: {};
13536
14766
  jsonBody: {
13537
14767
  device_id: string;
13538
- default_climate_setting: {
13539
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13540
- cooling_set_point_celsius?: (number | undefined) | undefined;
13541
- heating_set_point_celsius?: (number | undefined) | undefined;
13542
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13543
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
13544
- manual_override_allowed?: boolean | undefined;
13545
- };
14768
+ climate_preset_key: string;
14769
+ name: string | null;
14770
+ fan_mode_setting?: ('auto' | 'on') | undefined;
14771
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14772
+ cooling_set_point_celsius?: number | undefined;
14773
+ heating_set_point_celsius?: number | undefined;
14774
+ cooling_set_point_fahrenheit?: number | undefined;
14775
+ heating_set_point_fahrenheit?: number | undefined;
14776
+ manual_override_allowed: boolean;
13546
14777
  };
13547
14778
  commonParams: {};
13548
14779
  formData: {};
13549
- jsonResponse: {};
14780
+ jsonResponse: {
14781
+ climate_preset: {
14782
+ climate_preset_key: string;
14783
+ can_edit: boolean;
14784
+ can_delete: boolean;
14785
+ name: string | null;
14786
+ display_name: string;
14787
+ fan_mode_setting?: ('auto' | 'on') | undefined;
14788
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14789
+ cooling_set_point_celsius?: number | undefined;
14790
+ heating_set_point_celsius?: number | undefined;
14791
+ cooling_set_point_fahrenheit?: number | undefined;
14792
+ heating_set_point_fahrenheit?: number | undefined;
14793
+ manual_override_allowed: boolean;
14794
+ };
14795
+ };
13550
14796
  };
13551
14797
  '/user_identities/add_acs_user': {
13552
14798
  route: '/user_identities/add_acs_user';
@@ -14041,42 +15287,67 @@ export interface Routes {
14041
15287
  is_heating?: boolean | undefined;
14042
15288
  is_cooling?: boolean | undefined;
14043
15289
  is_fan_running?: boolean | undefined;
15290
+ /**
15291
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14044
15292
  fan_mode_setting?: ('auto' | 'on') | undefined;
14045
15293
  is_temporary_manual_override_active?: boolean | undefined;
14046
15294
  current_climate_setting?: {
14047
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14048
- cooling_set_point_celsius?: number | undefined;
14049
- heating_set_point_celsius?: number | undefined;
14050
- cooling_set_point_fahrenheit?: number | undefined;
14051
- heating_set_point_fahrenheit?: number | undefined;
14052
- manual_override_allowed: boolean;
15295
+ climate_preset_key?: string | undefined;
15296
+ can_edit?: boolean | undefined;
15297
+ can_delete?: boolean | undefined;
15298
+ name?: (string | null) | undefined;
15299
+ display_name?: string | undefined;
15300
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15301
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15302
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15303
+ heating_set_point_celsius?: (number | undefined) | undefined;
15304
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15305
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15306
+ manual_override_allowed?: boolean | undefined;
14053
15307
  } | undefined;
15308
+ /**
15309
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14054
15310
  default_climate_setting?: {
14055
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15311
+ climate_preset_key?: string | undefined;
15312
+ can_edit?: boolean | undefined;
15313
+ can_delete?: boolean | undefined;
15314
+ name?: (string | null) | undefined;
15315
+ display_name?: string | undefined;
15316
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15317
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15318
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15319
+ heating_set_point_celsius?: (number | undefined) | undefined;
15320
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15321
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15322
+ manual_override_allowed?: boolean | undefined;
15323
+ } | undefined;
15324
+ available_climate_presets?: Array<{
15325
+ climate_preset_key: string;
15326
+ can_edit: boolean;
15327
+ can_delete: boolean;
15328
+ name: string | null;
15329
+ display_name: string;
15330
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15331
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14056
15332
  cooling_set_point_celsius?: number | undefined;
14057
15333
  heating_set_point_celsius?: number | undefined;
14058
15334
  cooling_set_point_fahrenheit?: number | undefined;
14059
15335
  heating_set_point_fahrenheit?: number | undefined;
14060
15336
  manual_override_allowed: boolean;
14061
- } | undefined;
14062
- is_climate_setting_schedule_active?: boolean | undefined;
14063
- active_climate_setting_schedule?: {
14064
- climate_setting_schedule_id: string;
14065
- schedule_type: 'time_bound';
15337
+ }> | undefined;
15338
+ fallback_climate_preset_key?: (string | null) | undefined;
15339
+ active_thermostat_schedule?: ({
15340
+ thermostat_schedule_id: string;
14066
15341
  device_id: string;
14067
15342
  name?: string | undefined;
14068
- schedule_starts_at: string;
14069
- schedule_ends_at: string;
15343
+ climate_preset_key: string;
15344
+ max_override_period_minutes?: number;
15345
+ starts_at: string;
15346
+ ends_at: string;
14070
15347
  created_at: string;
14071
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
15348
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14072
15349
  errors?: any;
14073
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14074
- cooling_set_point_celsius?: (number | undefined) | undefined;
14075
- heating_set_point_celsius?: (number | undefined) | undefined;
14076
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14077
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14078
- manual_override_allowed?: boolean | undefined;
14079
- } | undefined;
15350
+ } | null) | undefined;
14080
15351
  min_cooling_set_point_celsius?: number | undefined;
14081
15352
  min_cooling_set_point_fahrenheit?: number | undefined;
14082
15353
  max_cooling_set_point_celsius?: number | undefined;
@@ -14437,42 +15708,67 @@ export interface Routes {
14437
15708
  is_heating?: boolean | undefined;
14438
15709
  is_cooling?: boolean | undefined;
14439
15710
  is_fan_running?: boolean | undefined;
15711
+ /**
15712
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14440
15713
  fan_mode_setting?: ('auto' | 'on') | undefined;
14441
15714
  is_temporary_manual_override_active?: boolean | undefined;
14442
15715
  current_climate_setting?: {
14443
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
14444
- cooling_set_point_celsius?: number | undefined;
14445
- heating_set_point_celsius?: number | undefined;
14446
- cooling_set_point_fahrenheit?: number | undefined;
14447
- heating_set_point_fahrenheit?: number | undefined;
14448
- manual_override_allowed: boolean;
15716
+ climate_preset_key?: string | undefined;
15717
+ can_edit?: boolean | undefined;
15718
+ can_delete?: boolean | undefined;
15719
+ name?: (string | null) | undefined;
15720
+ display_name?: string | undefined;
15721
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15722
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15723
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15724
+ heating_set_point_celsius?: (number | undefined) | undefined;
15725
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15726
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15727
+ manual_override_allowed?: boolean | undefined;
14449
15728
  } | undefined;
15729
+ /**
15730
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14450
15731
  default_climate_setting?: {
14451
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
15732
+ climate_preset_key?: string | undefined;
15733
+ can_edit?: boolean | undefined;
15734
+ can_delete?: boolean | undefined;
15735
+ name?: (string | null) | undefined;
15736
+ display_name?: string | undefined;
15737
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined;
15738
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15739
+ cooling_set_point_celsius?: (number | undefined) | undefined;
15740
+ heating_set_point_celsius?: (number | undefined) | undefined;
15741
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15742
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
15743
+ manual_override_allowed?: boolean | undefined;
15744
+ } | undefined;
15745
+ available_climate_presets?: Array<{
15746
+ climate_preset_key: string;
15747
+ can_edit: boolean;
15748
+ can_delete: boolean;
15749
+ name: string | null;
15750
+ display_name: string;
15751
+ fan_mode_setting?: ('auto' | 'on') | undefined;
15752
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14452
15753
  cooling_set_point_celsius?: number | undefined;
14453
15754
  heating_set_point_celsius?: number | undefined;
14454
15755
  cooling_set_point_fahrenheit?: number | undefined;
14455
15756
  heating_set_point_fahrenheit?: number | undefined;
14456
15757
  manual_override_allowed: boolean;
14457
- } | undefined;
14458
- is_climate_setting_schedule_active?: boolean | undefined;
14459
- active_climate_setting_schedule?: {
14460
- climate_setting_schedule_id: string;
14461
- schedule_type: 'time_bound';
15758
+ }> | undefined;
15759
+ fallback_climate_preset_key?: (string | null) | undefined;
15760
+ active_thermostat_schedule?: ({
15761
+ thermostat_schedule_id: string;
14462
15762
  device_id: string;
14463
15763
  name?: string | undefined;
14464
- schedule_starts_at: string;
14465
- schedule_ends_at: string;
15764
+ climate_preset_key: string;
15765
+ max_override_period_minutes?: number;
15766
+ starts_at: string;
15767
+ ends_at: string;
14466
15768
  created_at: string;
14467
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
15769
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
14468
15770
  errors?: any;
14469
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14470
- cooling_set_point_celsius?: (number | undefined) | undefined;
14471
- heating_set_point_celsius?: (number | undefined) | undefined;
14472
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
14473
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
14474
- manual_override_allowed?: boolean | undefined;
14475
- } | undefined;
15771
+ } | null) | undefined;
14476
15772
  min_cooling_set_point_celsius?: number | undefined;
14477
15773
  min_cooling_set_point_fahrenheit?: number | undefined;
14478
15774
  max_cooling_set_point_celsius?: number | undefined;
@@ -14654,19 +15950,47 @@ export interface Routes {
14654
15950
  message: string;
14655
15951
  warning_code: 'being_deleted';
14656
15952
  } | {
15953
+ /** Date and time at which Seam created the error. */
14657
15954
  created_at: string;
15955
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14658
15956
  message: string;
14659
- warning_code: 'failed_to_update_acs_user_on_acs_system';
15957
+ warning_code: 'failed_to_update_on_acs_system';
14660
15958
  } | {
14661
15959
  created_at: string;
14662
15960
  message: string;
14663
15961
  warning_code: 'salto_ks_user_not_subscribed';
15962
+ }>;
15963
+ errors: Array<{
15964
+ /** Date and time at which Seam created the error. */
15965
+ created_at: string;
15966
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15967
+ message: string;
15968
+ error_code: 'deleted_externally';
15969
+ } | {
15970
+ /** Date and time at which Seam created the error. */
15971
+ created_at: string;
15972
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15973
+ message: string;
15974
+ error_code: 'salto_ks_subscription_limit_exceeded';
15975
+ } | {
15976
+ /** Date and time at which Seam created the error. */
15977
+ created_at: string;
15978
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15979
+ message: string;
15980
+ warning_code: 'failed_to_create_on_acs_system';
15981
+ } | {
15982
+ /** Date and time at which Seam created the error. */
15983
+ created_at: string;
15984
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15985
+ message: string;
15986
+ warning_code: 'failed_to_update_on_acs_system';
14664
15987
  } | {
15988
+ /** Date and time at which Seam created the error. */
14665
15989
  created_at: string;
15990
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14666
15991
  message: string;
14667
- warning_code: 'salto_site_user_suspended';
15992
+ warning_code: 'failed_to_delete_on_acs_system';
14668
15993
  }>;
14669
- errors?: any;
14670
15994
  full_name?: string | undefined;
14671
15995
  /**
14672
15996
  * @deprecated use email_address. */
@@ -15058,6 +16382,30 @@ export interface Routes {
15058
16382
  type: string;
15059
16383
  message: string;
15060
16384
  };
16385
+ } | {
16386
+ /** The ID of the action attempt. */
16387
+ action_attempt_id: string;
16388
+ status: 'pending';
16389
+ result: null;
16390
+ error: null;
16391
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16392
+ } | {
16393
+ /** The ID of the action attempt. */
16394
+ action_attempt_id: string;
16395
+ status: 'success';
16396
+ error: null;
16397
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16398
+ result: {};
16399
+ } | {
16400
+ /** The ID of the action attempt. */
16401
+ action_attempt_id: string;
16402
+ status: 'error';
16403
+ result: null;
16404
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
16405
+ error: {
16406
+ type: string;
16407
+ message: string;
16408
+ };
15061
16409
  } | {
15062
16410
  /** The ID of the action attempt. */
15063
16411
  action_attempt_id: string;