@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
@@ -242,6 +242,33 @@ export interface Routes {
242
242
  message: string
243
243
  }
244
244
  }
245
+ | {
246
+ /** The ID of the action attempt. */
247
+ action_attempt_id: string
248
+ status: 'pending'
249
+ result: null
250
+ error: null
251
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
252
+ }
253
+ | {
254
+ /** The ID of the action attempt. */
255
+ action_attempt_id: string
256
+ status: 'success'
257
+ error: null
258
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
259
+ result: {}
260
+ }
261
+ | {
262
+ /** The ID of the action attempt. */
263
+ action_attempt_id: string
264
+ status: 'error'
265
+ result: null
266
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
267
+ error: {
268
+ type: string
269
+ message: string
270
+ }
271
+ }
245
272
  | {
246
273
  /** The ID of the action attempt. */
247
274
  action_attempt_id: string
@@ -819,6 +846,33 @@ export interface Routes {
819
846
  message: string
820
847
  }
821
848
  }
849
+ | {
850
+ /** The ID of the action attempt. */
851
+ action_attempt_id: string
852
+ status: 'pending'
853
+ result: null
854
+ error: null
855
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
856
+ }
857
+ | {
858
+ /** The ID of the action attempt. */
859
+ action_attempt_id: string
860
+ status: 'success'
861
+ error: null
862
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
863
+ result: {}
864
+ }
865
+ | {
866
+ /** The ID of the action attempt. */
867
+ action_attempt_id: string
868
+ status: 'error'
869
+ result: null
870
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
871
+ error: {
872
+ type: string
873
+ message: string
874
+ }
875
+ }
822
876
  | {
823
877
  /** The ID of the action attempt. */
824
878
  action_attempt_id: string
@@ -1561,6 +1615,33 @@ export interface Routes {
1561
1615
  message: string
1562
1616
  }
1563
1617
  }
1618
+ | {
1619
+ /** The ID of the action attempt. */
1620
+ action_attempt_id: string
1621
+ status: 'pending'
1622
+ result: null
1623
+ error: null
1624
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
1625
+ }
1626
+ | {
1627
+ /** The ID of the action attempt. */
1628
+ action_attempt_id: string
1629
+ status: 'success'
1630
+ error: null
1631
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
1632
+ result: {}
1633
+ }
1634
+ | {
1635
+ /** The ID of the action attempt. */
1636
+ action_attempt_id: string
1637
+ status: 'error'
1638
+ result: null
1639
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
1640
+ error: {
1641
+ type: string
1642
+ message: string
1643
+ }
1644
+ }
1564
1645
  | {
1565
1646
  /** The ID of the action attempt. */
1566
1647
  action_attempt_id: string
@@ -2125,6 +2206,33 @@ export interface Routes {
2125
2206
  message: string
2126
2207
  }
2127
2208
  }
2209
+ | {
2210
+ /** The ID of the action attempt. */
2211
+ action_attempt_id: string
2212
+ status: 'pending'
2213
+ result: null
2214
+ error: null
2215
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
2216
+ }
2217
+ | {
2218
+ /** The ID of the action attempt. */
2219
+ action_attempt_id: string
2220
+ status: 'success'
2221
+ error: null
2222
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
2223
+ result: {}
2224
+ }
2225
+ | {
2226
+ /** The ID of the action attempt. */
2227
+ action_attempt_id: string
2228
+ status: 'error'
2229
+ result: null
2230
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
2231
+ error: {
2232
+ type: string
2233
+ message: string
2234
+ }
2235
+ }
2128
2236
  | {
2129
2237
  /** The ID of the action attempt. */
2130
2238
  action_attempt_id: string
@@ -2497,22 +2605,55 @@ export interface Routes {
2497
2605
  warning_code: 'being_deleted'
2498
2606
  }
2499
2607
  | {
2608
+ /** Date and time at which Seam created the error. */
2500
2609
  created_at: string
2610
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2501
2611
  message: string
2502
- warning_code: 'failed_to_update_acs_user_on_acs_system'
2612
+ warning_code: 'failed_to_update_on_acs_system'
2503
2613
  }
2504
2614
  | {
2505
2615
  created_at: string
2506
2616
  message: string
2507
2617
  warning_code: 'salto_ks_user_not_subscribed'
2508
2618
  }
2619
+ >
2620
+ errors: Array<
2621
+ | {
2622
+ /** Date and time at which Seam created the error. */
2623
+ created_at: string
2624
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2625
+ message: string
2626
+ error_code: 'deleted_externally'
2627
+ }
2628
+ | {
2629
+ /** Date and time at which Seam created the error. */
2630
+ created_at: string
2631
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2632
+ message: string
2633
+ error_code: 'salto_ks_subscription_limit_exceeded'
2634
+ }
2509
2635
  | {
2636
+ /** Date and time at which Seam created the error. */
2637
+ created_at: string
2638
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2639
+ message: string
2640
+ warning_code: 'failed_to_create_on_acs_system'
2641
+ }
2642
+ | {
2643
+ /** Date and time at which Seam created the error. */
2644
+ created_at: string
2645
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2646
+ message: string
2647
+ warning_code: 'failed_to_update_on_acs_system'
2648
+ }
2649
+ | {
2650
+ /** Date and time at which Seam created the error. */
2510
2651
  created_at: string
2652
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2511
2653
  message: string
2512
- warning_code: 'salto_site_user_suspended'
2654
+ warning_code: 'failed_to_delete_on_acs_system'
2513
2655
  }
2514
2656
  >
2515
- errors?: any
2516
2657
  full_name?: string | undefined
2517
2658
  /**
2518
2659
  * @deprecated use email_address. */
@@ -3837,22 +3978,55 @@ export interface Routes {
3837
3978
  warning_code: 'being_deleted'
3838
3979
  }
3839
3980
  | {
3981
+ /** Date and time at which Seam created the error. */
3840
3982
  created_at: string
3983
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3841
3984
  message: string
3842
- warning_code: 'failed_to_update_acs_user_on_acs_system'
3985
+ warning_code: 'failed_to_update_on_acs_system'
3843
3986
  }
3844
3987
  | {
3845
3988
  created_at: string
3846
3989
  message: string
3847
3990
  warning_code: 'salto_ks_user_not_subscribed'
3848
3991
  }
3992
+ >
3993
+ errors: Array<
3994
+ | {
3995
+ /** Date and time at which Seam created the error. */
3996
+ created_at: string
3997
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3998
+ message: string
3999
+ error_code: 'deleted_externally'
4000
+ }
4001
+ | {
4002
+ /** Date and time at which Seam created the error. */
4003
+ created_at: string
4004
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4005
+ message: string
4006
+ error_code: 'salto_ks_subscription_limit_exceeded'
4007
+ }
4008
+ | {
4009
+ /** Date and time at which Seam created the error. */
4010
+ created_at: string
4011
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4012
+ message: string
4013
+ warning_code: 'failed_to_create_on_acs_system'
4014
+ }
4015
+ | {
4016
+ /** Date and time at which Seam created the error. */
4017
+ created_at: string
4018
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4019
+ message: string
4020
+ warning_code: 'failed_to_update_on_acs_system'
4021
+ }
3849
4022
  | {
4023
+ /** Date and time at which Seam created the error. */
3850
4024
  created_at: string
4025
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3851
4026
  message: string
3852
- warning_code: 'salto_site_user_suspended'
4027
+ warning_code: 'failed_to_delete_on_acs_system'
3853
4028
  }
3854
4029
  >
3855
- errors?: any
3856
4030
  full_name?: string | undefined
3857
4031
  /**
3858
4032
  * @deprecated use email_address. */
@@ -3921,22 +4095,55 @@ export interface Routes {
3921
4095
  warning_code: 'being_deleted'
3922
4096
  }
3923
4097
  | {
4098
+ /** Date and time at which Seam created the error. */
3924
4099
  created_at: string
4100
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3925
4101
  message: string
3926
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4102
+ warning_code: 'failed_to_update_on_acs_system'
3927
4103
  }
3928
4104
  | {
3929
4105
  created_at: string
3930
4106
  message: string
3931
4107
  warning_code: 'salto_ks_user_not_subscribed'
3932
4108
  }
4109
+ >
4110
+ errors: Array<
4111
+ | {
4112
+ /** Date and time at which Seam created the error. */
4113
+ created_at: string
4114
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4115
+ message: string
4116
+ error_code: 'deleted_externally'
4117
+ }
4118
+ | {
4119
+ /** Date and time at which Seam created the error. */
4120
+ created_at: string
4121
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4122
+ message: string
4123
+ error_code: 'salto_ks_subscription_limit_exceeded'
4124
+ }
4125
+ | {
4126
+ /** Date and time at which Seam created the error. */
4127
+ created_at: string
4128
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4129
+ message: string
4130
+ warning_code: 'failed_to_create_on_acs_system'
4131
+ }
4132
+ | {
4133
+ /** Date and time at which Seam created the error. */
4134
+ created_at: string
4135
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4136
+ message: string
4137
+ warning_code: 'failed_to_update_on_acs_system'
4138
+ }
3933
4139
  | {
4140
+ /** Date and time at which Seam created the error. */
3934
4141
  created_at: string
4142
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3935
4143
  message: string
3936
- warning_code: 'salto_site_user_suspended'
4144
+ warning_code: 'failed_to_delete_on_acs_system'
3937
4145
  }
3938
4146
  >
3939
- errors?: any
3940
4147
  full_name?: string | undefined
3941
4148
  /**
3942
4149
  * @deprecated use email_address. */
@@ -3999,22 +4206,55 @@ export interface Routes {
3999
4206
  warning_code: 'being_deleted'
4000
4207
  }
4001
4208
  | {
4209
+ /** Date and time at which Seam created the error. */
4002
4210
  created_at: string
4211
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4003
4212
  message: string
4004
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4213
+ warning_code: 'failed_to_update_on_acs_system'
4005
4214
  }
4006
4215
  | {
4007
4216
  created_at: string
4008
4217
  message: string
4009
4218
  warning_code: 'salto_ks_user_not_subscribed'
4010
4219
  }
4220
+ >
4221
+ errors: Array<
4222
+ | {
4223
+ /** Date and time at which Seam created the error. */
4224
+ created_at: string
4225
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4226
+ message: string
4227
+ error_code: 'deleted_externally'
4228
+ }
4229
+ | {
4230
+ /** Date and time at which Seam created the error. */
4231
+ created_at: string
4232
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4233
+ message: string
4234
+ error_code: 'salto_ks_subscription_limit_exceeded'
4235
+ }
4236
+ | {
4237
+ /** Date and time at which Seam created the error. */
4238
+ created_at: string
4239
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4240
+ message: string
4241
+ warning_code: 'failed_to_create_on_acs_system'
4242
+ }
4243
+ | {
4244
+ /** Date and time at which Seam created the error. */
4245
+ created_at: string
4246
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4247
+ message: string
4248
+ warning_code: 'failed_to_update_on_acs_system'
4249
+ }
4011
4250
  | {
4251
+ /** Date and time at which Seam created the error. */
4012
4252
  created_at: string
4253
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4013
4254
  message: string
4014
- warning_code: 'salto_site_user_suspended'
4255
+ warning_code: 'failed_to_delete_on_acs_system'
4015
4256
  }
4016
4257
  >
4017
- errors?: any
4018
4258
  full_name?: string | undefined
4019
4259
  /**
4020
4260
  * @deprecated use email_address. */
@@ -4153,22 +4393,55 @@ export interface Routes {
4153
4393
  warning_code: 'being_deleted'
4154
4394
  }
4155
4395
  | {
4396
+ /** Date and time at which Seam created the error. */
4156
4397
  created_at: string
4398
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4157
4399
  message: string
4158
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4400
+ warning_code: 'failed_to_update_on_acs_system'
4159
4401
  }
4160
4402
  | {
4161
4403
  created_at: string
4162
4404
  message: string
4163
4405
  warning_code: 'salto_ks_user_not_subscribed'
4164
4406
  }
4407
+ >
4408
+ errors: Array<
4409
+ | {
4410
+ /** Date and time at which Seam created the error. */
4411
+ created_at: string
4412
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4413
+ message: string
4414
+ error_code: 'deleted_externally'
4415
+ }
4416
+ | {
4417
+ /** Date and time at which Seam created the error. */
4418
+ created_at: string
4419
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4420
+ message: string
4421
+ error_code: 'salto_ks_subscription_limit_exceeded'
4422
+ }
4423
+ | {
4424
+ /** Date and time at which Seam created the error. */
4425
+ created_at: string
4426
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4427
+ message: string
4428
+ warning_code: 'failed_to_create_on_acs_system'
4429
+ }
4430
+ | {
4431
+ /** Date and time at which Seam created the error. */
4432
+ created_at: string
4433
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4434
+ message: string
4435
+ warning_code: 'failed_to_update_on_acs_system'
4436
+ }
4165
4437
  | {
4438
+ /** Date and time at which Seam created the error. */
4166
4439
  created_at: string
4440
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4167
4441
  message: string
4168
- warning_code: 'salto_site_user_suspended'
4442
+ warning_code: 'failed_to_delete_on_acs_system'
4169
4443
  }
4170
4444
  >
4171
- errors?: any
4172
4445
  full_name?: string | undefined
4173
4446
  /**
4174
4447
  * @deprecated use email_address. */
@@ -4230,22 +4503,55 @@ export interface Routes {
4230
4503
  warning_code: 'being_deleted'
4231
4504
  }
4232
4505
  | {
4506
+ /** Date and time at which Seam created the error. */
4233
4507
  created_at: string
4508
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4234
4509
  message: string
4235
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4510
+ warning_code: 'failed_to_update_on_acs_system'
4236
4511
  }
4237
4512
  | {
4238
4513
  created_at: string
4239
4514
  message: string
4240
4515
  warning_code: 'salto_ks_user_not_subscribed'
4241
4516
  }
4517
+ >
4518
+ errors: Array<
4242
4519
  | {
4520
+ /** Date and time at which Seam created the error. */
4243
4521
  created_at: string
4522
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4523
+ message: string
4524
+ error_code: 'deleted_externally'
4525
+ }
4526
+ | {
4527
+ /** Date and time at which Seam created the error. */
4528
+ created_at: string
4529
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4530
+ message: string
4531
+ error_code: 'salto_ks_subscription_limit_exceeded'
4532
+ }
4533
+ | {
4534
+ /** Date and time at which Seam created the error. */
4535
+ created_at: string
4536
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4537
+ message: string
4538
+ warning_code: 'failed_to_create_on_acs_system'
4539
+ }
4540
+ | {
4541
+ /** Date and time at which Seam created the error. */
4542
+ created_at: string
4543
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4544
+ message: string
4545
+ warning_code: 'failed_to_update_on_acs_system'
4546
+ }
4547
+ | {
4548
+ /** Date and time at which Seam created the error. */
4549
+ created_at: string
4550
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4244
4551
  message: string
4245
- warning_code: 'salto_site_user_suspended'
4552
+ warning_code: 'failed_to_delete_on_acs_system'
4246
4553
  }
4247
4554
  >
4248
- errors?: any
4249
4555
  full_name?: string | undefined
4250
4556
  /**
4251
4557
  * @deprecated use email_address. */
@@ -4518,6 +4824,33 @@ export interface Routes {
4518
4824
  message: string
4519
4825
  }
4520
4826
  }
4827
+ | {
4828
+ /** The ID of the action attempt. */
4829
+ action_attempt_id: string
4830
+ status: 'pending'
4831
+ result: null
4832
+ error: null
4833
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4834
+ }
4835
+ | {
4836
+ /** The ID of the action attempt. */
4837
+ action_attempt_id: string
4838
+ status: 'success'
4839
+ error: null
4840
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4841
+ result: {}
4842
+ }
4843
+ | {
4844
+ /** The ID of the action attempt. */
4845
+ action_attempt_id: string
4846
+ status: 'error'
4847
+ result: null
4848
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4849
+ error: {
4850
+ type: string
4851
+ message: string
4852
+ }
4853
+ }
4521
4854
  | {
4522
4855
  /** The ID of the action attempt. */
4523
4856
  action_attempt_id: string
@@ -4936,6 +5269,33 @@ export interface Routes {
4936
5269
  message: string
4937
5270
  }
4938
5271
  }
5272
+ | {
5273
+ /** The ID of the action attempt. */
5274
+ action_attempt_id: string
5275
+ status: 'pending'
5276
+ result: null
5277
+ error: null
5278
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
5279
+ }
5280
+ | {
5281
+ /** The ID of the action attempt. */
5282
+ action_attempt_id: string
5283
+ status: 'success'
5284
+ error: null
5285
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
5286
+ result: {}
5287
+ }
5288
+ | {
5289
+ /** The ID of the action attempt. */
5290
+ action_attempt_id: string
5291
+ status: 'error'
5292
+ result: null
5293
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
5294
+ error: {
5295
+ type: string
5296
+ message: string
5297
+ }
5298
+ }
4939
5299
  | {
4940
5300
  /** The ID of the action attempt. */
4941
5301
  action_attempt_id: string
@@ -6064,42 +6424,44 @@ export interface Routes {
6064
6424
  is_heating?: boolean | undefined
6065
6425
  is_cooling?: boolean | undefined
6066
6426
  is_fan_running?: boolean | undefined
6427
+ /**
6428
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6067
6429
  fan_mode_setting?: ('auto' | 'on') | undefined
6068
6430
  is_temporary_manual_override_active?: boolean | undefined
6069
6431
  current_climate_setting?:
6070
6432
  | {
6071
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
6072
- cooling_set_point_celsius?: number | undefined
6073
- heating_set_point_celsius?: number | undefined
6074
- cooling_set_point_fahrenheit?: number | undefined
6075
- heating_set_point_fahrenheit?: number | undefined
6076
- manual_override_allowed: boolean
6433
+ climate_preset_key?: string | undefined
6434
+ can_edit?: boolean | undefined
6435
+ can_delete?: boolean | undefined
6436
+ name?: (string | null) | undefined
6437
+ display_name?: string | undefined
6438
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6439
+ hvac_mode_setting?:
6440
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6441
+ | undefined
6442
+ cooling_set_point_celsius?: (number | undefined) | undefined
6443
+ heating_set_point_celsius?: (number | undefined) | undefined
6444
+ cooling_set_point_fahrenheit?:
6445
+ | (number | undefined)
6446
+ | undefined
6447
+ heating_set_point_fahrenheit?:
6448
+ | (number | undefined)
6449
+ | undefined
6450
+ manual_override_allowed?: boolean | undefined
6077
6451
  }
6078
6452
  | undefined
6453
+ /**
6454
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6079
6455
  default_climate_setting?:
6080
6456
  | {
6081
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
6082
- cooling_set_point_celsius?: number | undefined
6083
- heating_set_point_celsius?: number | undefined
6084
- cooling_set_point_fahrenheit?: number | undefined
6085
- heating_set_point_fahrenheit?: number | undefined
6086
- manual_override_allowed: boolean
6087
- }
6088
- | undefined
6089
- is_climate_setting_schedule_active?: boolean | undefined
6090
- active_climate_setting_schedule?:
6091
- | {
6092
- climate_setting_schedule_id: string
6093
- schedule_type: 'time_bound'
6094
- device_id: string
6095
- name?: string | undefined
6096
- schedule_starts_at: string
6097
- schedule_ends_at: string
6098
- created_at: string
6099
- /** 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. */
6100
- errors?: any
6457
+ climate_preset_key?: string | undefined
6458
+ can_edit?: boolean | undefined
6459
+ can_delete?: boolean | undefined
6460
+ name?: (string | null) | undefined
6461
+ display_name?: string | undefined
6462
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6101
6463
  hvac_mode_setting?:
6102
- | ('off' | 'heat' | 'cool' | 'heat_cool')
6464
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6103
6465
  | undefined
6104
6466
  cooling_set_point_celsius?: (number | undefined) | undefined
6105
6467
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -6112,6 +6474,39 @@ export interface Routes {
6112
6474
  manual_override_allowed?: boolean | undefined
6113
6475
  }
6114
6476
  | undefined
6477
+ available_climate_presets?:
6478
+ | Array<{
6479
+ climate_preset_key: string
6480
+ can_edit: boolean
6481
+ can_delete: boolean
6482
+ name: string | null
6483
+ display_name: string
6484
+ fan_mode_setting?: ('auto' | 'on') | undefined
6485
+ hvac_mode_setting?:
6486
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
6487
+ | undefined
6488
+ cooling_set_point_celsius?: number | undefined
6489
+ heating_set_point_celsius?: number | undefined
6490
+ cooling_set_point_fahrenheit?: number | undefined
6491
+ heating_set_point_fahrenheit?: number | undefined
6492
+ manual_override_allowed: boolean
6493
+ }>
6494
+ | undefined
6495
+ fallback_climate_preset_key?: (string | null) | undefined
6496
+ active_thermostat_schedule?:
6497
+ | ({
6498
+ thermostat_schedule_id: string
6499
+ device_id: string
6500
+ name?: string | undefined
6501
+ climate_preset_key: string
6502
+ max_override_period_minutes?: number
6503
+ starts_at: string
6504
+ ends_at: string
6505
+ created_at: string
6506
+ /** 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. */
6507
+ errors?: any
6508
+ } | null)
6509
+ | undefined
6115
6510
  min_cooling_set_point_celsius?: number | undefined
6116
6511
  min_cooling_set_point_fahrenheit?: number | undefined
6117
6512
  max_cooling_set_point_celsius?: number | undefined
@@ -6774,42 +7169,44 @@ export interface Routes {
6774
7169
  is_heating?: boolean | undefined
6775
7170
  is_cooling?: boolean | undefined
6776
7171
  is_fan_running?: boolean | undefined
7172
+ /**
7173
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6777
7174
  fan_mode_setting?: ('auto' | 'on') | undefined
6778
7175
  is_temporary_manual_override_active?: boolean | undefined
6779
7176
  current_climate_setting?:
6780
7177
  | {
6781
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
6782
- cooling_set_point_celsius?: number | undefined
6783
- heating_set_point_celsius?: number | undefined
6784
- cooling_set_point_fahrenheit?: number | undefined
6785
- heating_set_point_fahrenheit?: number | undefined
6786
- manual_override_allowed: boolean
7178
+ climate_preset_key?: string | undefined
7179
+ can_edit?: boolean | undefined
7180
+ can_delete?: boolean | undefined
7181
+ name?: (string | null) | undefined
7182
+ display_name?: string | undefined
7183
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
7184
+ hvac_mode_setting?:
7185
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
7186
+ | undefined
7187
+ cooling_set_point_celsius?: (number | undefined) | undefined
7188
+ heating_set_point_celsius?: (number | undefined) | undefined
7189
+ cooling_set_point_fahrenheit?:
7190
+ | (number | undefined)
7191
+ | undefined
7192
+ heating_set_point_fahrenheit?:
7193
+ | (number | undefined)
7194
+ | undefined
7195
+ manual_override_allowed?: boolean | undefined
6787
7196
  }
6788
7197
  | undefined
7198
+ /**
7199
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6789
7200
  default_climate_setting?:
6790
7201
  | {
6791
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
6792
- cooling_set_point_celsius?: number | undefined
6793
- heating_set_point_celsius?: number | undefined
6794
- cooling_set_point_fahrenheit?: number | undefined
6795
- heating_set_point_fahrenheit?: number | undefined
6796
- manual_override_allowed: boolean
6797
- }
6798
- | undefined
6799
- is_climate_setting_schedule_active?: boolean | undefined
6800
- active_climate_setting_schedule?:
6801
- | {
6802
- climate_setting_schedule_id: string
6803
- schedule_type: 'time_bound'
6804
- device_id: string
6805
- name?: string | undefined
6806
- schedule_starts_at: string
6807
- schedule_ends_at: string
6808
- created_at: string
6809
- /** 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. */
6810
- errors?: any
7202
+ climate_preset_key?: string | undefined
7203
+ can_edit?: boolean | undefined
7204
+ can_delete?: boolean | undefined
7205
+ name?: (string | null) | undefined
7206
+ display_name?: string | undefined
7207
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6811
7208
  hvac_mode_setting?:
6812
- | ('off' | 'heat' | 'cool' | 'heat_cool')
7209
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6813
7210
  | undefined
6814
7211
  cooling_set_point_celsius?: (number | undefined) | undefined
6815
7212
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -6822,6 +7219,39 @@ export interface Routes {
6822
7219
  manual_override_allowed?: boolean | undefined
6823
7220
  }
6824
7221
  | undefined
7222
+ available_climate_presets?:
7223
+ | Array<{
7224
+ climate_preset_key: string
7225
+ can_edit: boolean
7226
+ can_delete: boolean
7227
+ name: string | null
7228
+ display_name: string
7229
+ fan_mode_setting?: ('auto' | 'on') | undefined
7230
+ hvac_mode_setting?:
7231
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
7232
+ | undefined
7233
+ cooling_set_point_celsius?: number | undefined
7234
+ heating_set_point_celsius?: number | undefined
7235
+ cooling_set_point_fahrenheit?: number | undefined
7236
+ heating_set_point_fahrenheit?: number | undefined
7237
+ manual_override_allowed: boolean
7238
+ }>
7239
+ | undefined
7240
+ fallback_climate_preset_key?: (string | null) | undefined
7241
+ active_thermostat_schedule?:
7242
+ | ({
7243
+ thermostat_schedule_id: string
7244
+ device_id: string
7245
+ name?: string | undefined
7246
+ climate_preset_key: string
7247
+ max_override_period_minutes?: number
7248
+ starts_at: string
7249
+ ends_at: string
7250
+ created_at: string
7251
+ /** 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. */
7252
+ errors?: any
7253
+ } | null)
7254
+ | undefined
6825
7255
  min_cooling_set_point_celsius?: number | undefined
6826
7256
  min_cooling_set_point_fahrenheit?: number | undefined
6827
7257
  max_cooling_set_point_celsius?: number | undefined
@@ -8150,42 +8580,44 @@ export interface Routes {
8150
8580
  is_heating?: boolean | undefined
8151
8581
  is_cooling?: boolean | undefined
8152
8582
  is_fan_running?: boolean | undefined
8583
+ /**
8584
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8153
8585
  fan_mode_setting?: ('auto' | 'on') | undefined
8154
8586
  is_temporary_manual_override_active?: boolean | undefined
8155
8587
  current_climate_setting?:
8156
8588
  | {
8157
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8158
- cooling_set_point_celsius?: number | undefined
8159
- heating_set_point_celsius?: number | undefined
8160
- cooling_set_point_fahrenheit?: number | undefined
8161
- heating_set_point_fahrenheit?: number | undefined
8162
- manual_override_allowed: boolean
8589
+ climate_preset_key?: string | undefined
8590
+ can_edit?: boolean | undefined
8591
+ can_delete?: boolean | undefined
8592
+ name?: (string | null) | undefined
8593
+ display_name?: string | undefined
8594
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8595
+ hvac_mode_setting?:
8596
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8597
+ | undefined
8598
+ cooling_set_point_celsius?: (number | undefined) | undefined
8599
+ heating_set_point_celsius?: (number | undefined) | undefined
8600
+ cooling_set_point_fahrenheit?:
8601
+ | (number | undefined)
8602
+ | undefined
8603
+ heating_set_point_fahrenheit?:
8604
+ | (number | undefined)
8605
+ | undefined
8606
+ manual_override_allowed?: boolean | undefined
8163
8607
  }
8164
8608
  | undefined
8609
+ /**
8610
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8165
8611
  default_climate_setting?:
8166
8612
  | {
8167
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8168
- cooling_set_point_celsius?: number | undefined
8169
- heating_set_point_celsius?: number | undefined
8170
- cooling_set_point_fahrenheit?: number | undefined
8171
- heating_set_point_fahrenheit?: number | undefined
8172
- manual_override_allowed: boolean
8173
- }
8174
- | undefined
8175
- is_climate_setting_schedule_active?: boolean | undefined
8176
- active_climate_setting_schedule?:
8177
- | {
8178
- climate_setting_schedule_id: string
8179
- schedule_type: 'time_bound'
8180
- device_id: string
8181
- name?: string | undefined
8182
- schedule_starts_at: string
8183
- schedule_ends_at: string
8184
- created_at: string
8185
- /** 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. */
8186
- errors?: any
8613
+ climate_preset_key?: string | undefined
8614
+ can_edit?: boolean | undefined
8615
+ can_delete?: boolean | undefined
8616
+ name?: (string | null) | undefined
8617
+ display_name?: string | undefined
8618
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8187
8619
  hvac_mode_setting?:
8188
- | ('off' | 'heat' | 'cool' | 'heat_cool')
8620
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8189
8621
  | undefined
8190
8622
  cooling_set_point_celsius?: (number | undefined) | undefined
8191
8623
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -8198,6 +8630,39 @@ export interface Routes {
8198
8630
  manual_override_allowed?: boolean | undefined
8199
8631
  }
8200
8632
  | undefined
8633
+ available_climate_presets?:
8634
+ | Array<{
8635
+ climate_preset_key: string
8636
+ can_edit: boolean
8637
+ can_delete: boolean
8638
+ name: string | null
8639
+ display_name: string
8640
+ fan_mode_setting?: ('auto' | 'on') | undefined
8641
+ hvac_mode_setting?:
8642
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
8643
+ | undefined
8644
+ cooling_set_point_celsius?: number | undefined
8645
+ heating_set_point_celsius?: number | undefined
8646
+ cooling_set_point_fahrenheit?: number | undefined
8647
+ heating_set_point_fahrenheit?: number | undefined
8648
+ manual_override_allowed: boolean
8649
+ }>
8650
+ | undefined
8651
+ fallback_climate_preset_key?: (string | null) | undefined
8652
+ active_thermostat_schedule?:
8653
+ | ({
8654
+ thermostat_schedule_id: string
8655
+ device_id: string
8656
+ name?: string | undefined
8657
+ climate_preset_key: string
8658
+ max_override_period_minutes?: number
8659
+ starts_at: string
8660
+ ends_at: string
8661
+ created_at: string
8662
+ /** 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. */
8663
+ errors?: any
8664
+ } | null)
8665
+ | undefined
8201
8666
  min_cooling_set_point_celsius?: number | undefined
8202
8667
  min_cooling_set_point_fahrenheit?: number | undefined
8203
8668
  max_cooling_set_point_celsius?: number | undefined
@@ -8694,42 +9159,44 @@ export interface Routes {
8694
9159
  is_heating?: boolean | undefined
8695
9160
  is_cooling?: boolean | undefined
8696
9161
  is_fan_running?: boolean | undefined
9162
+ /**
9163
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8697
9164
  fan_mode_setting?: ('auto' | 'on') | undefined
8698
9165
  is_temporary_manual_override_active?: boolean | undefined
8699
9166
  current_climate_setting?:
8700
9167
  | {
8701
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8702
- cooling_set_point_celsius?: number | undefined
8703
- heating_set_point_celsius?: number | undefined
8704
- cooling_set_point_fahrenheit?: number | undefined
8705
- heating_set_point_fahrenheit?: number | undefined
8706
- manual_override_allowed: boolean
9168
+ climate_preset_key?: string | undefined
9169
+ can_edit?: boolean | undefined
9170
+ can_delete?: boolean | undefined
9171
+ name?: (string | null) | undefined
9172
+ display_name?: string | undefined
9173
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9174
+ hvac_mode_setting?:
9175
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9176
+ | undefined
9177
+ cooling_set_point_celsius?: (number | undefined) | undefined
9178
+ heating_set_point_celsius?: (number | undefined) | undefined
9179
+ cooling_set_point_fahrenheit?:
9180
+ | (number | undefined)
9181
+ | undefined
9182
+ heating_set_point_fahrenheit?:
9183
+ | (number | undefined)
9184
+ | undefined
9185
+ manual_override_allowed?: boolean | undefined
8707
9186
  }
8708
9187
  | undefined
9188
+ /**
9189
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8709
9190
  default_climate_setting?:
8710
9191
  | {
8711
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8712
- cooling_set_point_celsius?: number | undefined
8713
- heating_set_point_celsius?: number | undefined
8714
- cooling_set_point_fahrenheit?: number | undefined
8715
- heating_set_point_fahrenheit?: number | undefined
8716
- manual_override_allowed: boolean
8717
- }
8718
- | undefined
8719
- is_climate_setting_schedule_active?: boolean | undefined
8720
- active_climate_setting_schedule?:
8721
- | {
8722
- climate_setting_schedule_id: string
8723
- schedule_type: 'time_bound'
8724
- device_id: string
8725
- name?: string | undefined
8726
- schedule_starts_at: string
8727
- schedule_ends_at: string
8728
- created_at: string
8729
- /** 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. */
8730
- errors?: any
9192
+ climate_preset_key?: string | undefined
9193
+ can_edit?: boolean | undefined
9194
+ can_delete?: boolean | undefined
9195
+ name?: (string | null) | undefined
9196
+ display_name?: string | undefined
9197
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8731
9198
  hvac_mode_setting?:
8732
- | ('off' | 'heat' | 'cool' | 'heat_cool')
9199
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8733
9200
  | undefined
8734
9201
  cooling_set_point_celsius?: (number | undefined) | undefined
8735
9202
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -8742,19 +9209,52 @@ export interface Routes {
8742
9209
  manual_override_allowed?: boolean | undefined
8743
9210
  }
8744
9211
  | undefined
8745
- min_cooling_set_point_celsius?: number | undefined
8746
- min_cooling_set_point_fahrenheit?: number | undefined
8747
- max_cooling_set_point_celsius?: number | undefined
8748
- max_cooling_set_point_fahrenheit?: number | undefined
8749
- min_heating_set_point_celsius?: number | undefined
8750
- min_heating_set_point_fahrenheit?: number | undefined
8751
- max_heating_set_point_celsius?: number | undefined
8752
- max_heating_set_point_fahrenheit?: number | undefined
8753
- min_heating_cooling_delta_celsius?: number | undefined
8754
- min_heating_cooling_delta_fahrenheit?: number | undefined
8755
- })
8756
- /** Location information for the device. */
8757
- location: {
9212
+ available_climate_presets?:
9213
+ | Array<{
9214
+ climate_preset_key: string
9215
+ can_edit: boolean
9216
+ can_delete: boolean
9217
+ name: string | null
9218
+ display_name: string
9219
+ fan_mode_setting?: ('auto' | 'on') | undefined
9220
+ hvac_mode_setting?:
9221
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
9222
+ | undefined
9223
+ cooling_set_point_celsius?: number | undefined
9224
+ heating_set_point_celsius?: number | undefined
9225
+ cooling_set_point_fahrenheit?: number | undefined
9226
+ heating_set_point_fahrenheit?: number | undefined
9227
+ manual_override_allowed: boolean
9228
+ }>
9229
+ | undefined
9230
+ fallback_climate_preset_key?: (string | null) | undefined
9231
+ active_thermostat_schedule?:
9232
+ | ({
9233
+ thermostat_schedule_id: string
9234
+ device_id: string
9235
+ name?: string | undefined
9236
+ climate_preset_key: string
9237
+ max_override_period_minutes?: number
9238
+ starts_at: string
9239
+ ends_at: string
9240
+ created_at: string
9241
+ /** 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. */
9242
+ errors?: any
9243
+ } | null)
9244
+ | undefined
9245
+ min_cooling_set_point_celsius?: number | undefined
9246
+ min_cooling_set_point_fahrenheit?: number | undefined
9247
+ max_cooling_set_point_celsius?: number | undefined
9248
+ max_cooling_set_point_fahrenheit?: number | undefined
9249
+ min_heating_set_point_celsius?: number | undefined
9250
+ min_heating_set_point_fahrenheit?: number | undefined
9251
+ max_heating_set_point_celsius?: number | undefined
9252
+ max_heating_set_point_fahrenheit?: number | undefined
9253
+ min_heating_cooling_delta_celsius?: number | undefined
9254
+ min_heating_cooling_delta_fahrenheit?: number | undefined
9255
+ })
9256
+ /** Location information for the device. */
9257
+ location: {
8758
9258
  /** Name of the device location. */
8759
9259
  location_name?: string | undefined
8760
9260
  /** Time zone of the device location. */
@@ -9404,42 +9904,44 @@ export interface Routes {
9404
9904
  is_heating?: boolean | undefined
9405
9905
  is_cooling?: boolean | undefined
9406
9906
  is_fan_running?: boolean | undefined
9907
+ /**
9908
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9407
9909
  fan_mode_setting?: ('auto' | 'on') | undefined
9408
9910
  is_temporary_manual_override_active?: boolean | undefined
9409
9911
  current_climate_setting?:
9410
9912
  | {
9411
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
9412
- cooling_set_point_celsius?: number | undefined
9413
- heating_set_point_celsius?: number | undefined
9414
- cooling_set_point_fahrenheit?: number | undefined
9415
- heating_set_point_fahrenheit?: number | undefined
9416
- manual_override_allowed: boolean
9913
+ climate_preset_key?: string | undefined
9914
+ can_edit?: boolean | undefined
9915
+ can_delete?: boolean | undefined
9916
+ name?: (string | null) | undefined
9917
+ display_name?: string | undefined
9918
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9919
+ hvac_mode_setting?:
9920
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9921
+ | undefined
9922
+ cooling_set_point_celsius?: (number | undefined) | undefined
9923
+ heating_set_point_celsius?: (number | undefined) | undefined
9924
+ cooling_set_point_fahrenheit?:
9925
+ | (number | undefined)
9926
+ | undefined
9927
+ heating_set_point_fahrenheit?:
9928
+ | (number | undefined)
9929
+ | undefined
9930
+ manual_override_allowed?: boolean | undefined
9417
9931
  }
9418
9932
  | undefined
9933
+ /**
9934
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9419
9935
  default_climate_setting?:
9420
9936
  | {
9421
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
9422
- cooling_set_point_celsius?: number | undefined
9423
- heating_set_point_celsius?: number | undefined
9424
- cooling_set_point_fahrenheit?: number | undefined
9425
- heating_set_point_fahrenheit?: number | undefined
9426
- manual_override_allowed: boolean
9427
- }
9428
- | undefined
9429
- is_climate_setting_schedule_active?: boolean | undefined
9430
- active_climate_setting_schedule?:
9431
- | {
9432
- climate_setting_schedule_id: string
9433
- schedule_type: 'time_bound'
9434
- device_id: string
9435
- name?: string | undefined
9436
- schedule_starts_at: string
9437
- schedule_ends_at: string
9438
- created_at: string
9439
- /** 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. */
9440
- errors?: any
9937
+ climate_preset_key?: string | undefined
9938
+ can_edit?: boolean | undefined
9939
+ can_delete?: boolean | undefined
9940
+ name?: (string | null) | undefined
9941
+ display_name?: string | undefined
9942
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9441
9943
  hvac_mode_setting?:
9442
- | ('off' | 'heat' | 'cool' | 'heat_cool')
9944
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9443
9945
  | undefined
9444
9946
  cooling_set_point_celsius?: (number | undefined) | undefined
9445
9947
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -9452,6 +9954,39 @@ export interface Routes {
9452
9954
  manual_override_allowed?: boolean | undefined
9453
9955
  }
9454
9956
  | undefined
9957
+ available_climate_presets?:
9958
+ | Array<{
9959
+ climate_preset_key: string
9960
+ can_edit: boolean
9961
+ can_delete: boolean
9962
+ name: string | null
9963
+ display_name: string
9964
+ fan_mode_setting?: ('auto' | 'on') | undefined
9965
+ hvac_mode_setting?:
9966
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
9967
+ | undefined
9968
+ cooling_set_point_celsius?: number | undefined
9969
+ heating_set_point_celsius?: number | undefined
9970
+ cooling_set_point_fahrenheit?: number | undefined
9971
+ heating_set_point_fahrenheit?: number | undefined
9972
+ manual_override_allowed: boolean
9973
+ }>
9974
+ | undefined
9975
+ fallback_climate_preset_key?: (string | null) | undefined
9976
+ active_thermostat_schedule?:
9977
+ | ({
9978
+ thermostat_schedule_id: string
9979
+ device_id: string
9980
+ name?: string | undefined
9981
+ climate_preset_key: string
9982
+ max_override_period_minutes?: number
9983
+ starts_at: string
9984
+ ends_at: string
9985
+ created_at: string
9986
+ /** 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. */
9987
+ errors?: any
9988
+ } | null)
9989
+ | undefined
9455
9990
  min_cooling_set_point_celsius?: number | undefined
9456
9991
  min_cooling_set_point_fahrenheit?: number | undefined
9457
9992
  max_cooling_set_point_celsius?: number | undefined
@@ -9948,42 +10483,44 @@ export interface Routes {
9948
10483
  is_heating?: boolean | undefined
9949
10484
  is_cooling?: boolean | undefined
9950
10485
  is_fan_running?: boolean | undefined
10486
+ /**
10487
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9951
10488
  fan_mode_setting?: ('auto' | 'on') | undefined
9952
10489
  is_temporary_manual_override_active?: boolean | undefined
9953
10490
  current_climate_setting?:
9954
10491
  | {
9955
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
9956
- cooling_set_point_celsius?: number | undefined
9957
- heating_set_point_celsius?: number | undefined
9958
- cooling_set_point_fahrenheit?: number | undefined
9959
- heating_set_point_fahrenheit?: number | undefined
9960
- manual_override_allowed: boolean
10492
+ climate_preset_key?: string | undefined
10493
+ can_edit?: boolean | undefined
10494
+ can_delete?: boolean | undefined
10495
+ name?: (string | null) | undefined
10496
+ display_name?: string | undefined
10497
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
10498
+ hvac_mode_setting?:
10499
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
10500
+ | undefined
10501
+ cooling_set_point_celsius?: (number | undefined) | undefined
10502
+ heating_set_point_celsius?: (number | undefined) | undefined
10503
+ cooling_set_point_fahrenheit?:
10504
+ | (number | undefined)
10505
+ | undefined
10506
+ heating_set_point_fahrenheit?:
10507
+ | (number | undefined)
10508
+ | undefined
10509
+ manual_override_allowed?: boolean | undefined
9961
10510
  }
9962
10511
  | undefined
10512
+ /**
10513
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9963
10514
  default_climate_setting?:
9964
10515
  | {
9965
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
9966
- cooling_set_point_celsius?: number | undefined
9967
- heating_set_point_celsius?: number | undefined
9968
- cooling_set_point_fahrenheit?: number | undefined
9969
- heating_set_point_fahrenheit?: number | undefined
9970
- manual_override_allowed: boolean
9971
- }
9972
- | undefined
9973
- is_climate_setting_schedule_active?: boolean | undefined
9974
- active_climate_setting_schedule?:
9975
- | {
9976
- climate_setting_schedule_id: string
9977
- schedule_type: 'time_bound'
9978
- device_id: string
9979
- name?: string | undefined
9980
- schedule_starts_at: string
9981
- schedule_ends_at: string
9982
- created_at: string
9983
- /** 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. */
9984
- errors?: any
10516
+ climate_preset_key?: string | undefined
10517
+ can_edit?: boolean | undefined
10518
+ can_delete?: boolean | undefined
10519
+ name?: (string | null) | undefined
10520
+ display_name?: string | undefined
10521
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9985
10522
  hvac_mode_setting?:
9986
- | ('off' | 'heat' | 'cool' | 'heat_cool')
10523
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9987
10524
  | undefined
9988
10525
  cooling_set_point_celsius?: (number | undefined) | undefined
9989
10526
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -9996,6 +10533,39 @@ export interface Routes {
9996
10533
  manual_override_allowed?: boolean | undefined
9997
10534
  }
9998
10535
  | undefined
10536
+ available_climate_presets?:
10537
+ | Array<{
10538
+ climate_preset_key: string
10539
+ can_edit: boolean
10540
+ can_delete: boolean
10541
+ name: string | null
10542
+ display_name: string
10543
+ fan_mode_setting?: ('auto' | 'on') | undefined
10544
+ hvac_mode_setting?:
10545
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
10546
+ | undefined
10547
+ cooling_set_point_celsius?: number | undefined
10548
+ heating_set_point_celsius?: number | undefined
10549
+ cooling_set_point_fahrenheit?: number | undefined
10550
+ heating_set_point_fahrenheit?: number | undefined
10551
+ manual_override_allowed: boolean
10552
+ }>
10553
+ | undefined
10554
+ fallback_climate_preset_key?: (string | null) | undefined
10555
+ active_thermostat_schedule?:
10556
+ | ({
10557
+ thermostat_schedule_id: string
10558
+ device_id: string
10559
+ name?: string | undefined
10560
+ climate_preset_key: string
10561
+ max_override_period_minutes?: number
10562
+ starts_at: string
10563
+ ends_at: string
10564
+ created_at: string
10565
+ /** 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. */
10566
+ errors?: any
10567
+ } | null)
10568
+ | undefined
9999
10569
  min_cooling_set_point_celsius?: number | undefined
10000
10570
  min_cooling_set_point_fahrenheit?: number | undefined
10001
10571
  max_cooling_set_point_celsius?: number | undefined
@@ -10283,6 +10853,33 @@ export interface Routes {
10283
10853
  message: string
10284
10854
  }
10285
10855
  }
10856
+ | {
10857
+ /** The ID of the action attempt. */
10858
+ action_attempt_id: string
10859
+ status: 'pending'
10860
+ result: null
10861
+ error: null
10862
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10863
+ }
10864
+ | {
10865
+ /** The ID of the action attempt. */
10866
+ action_attempt_id: string
10867
+ status: 'success'
10868
+ error: null
10869
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10870
+ result: {}
10871
+ }
10872
+ | {
10873
+ /** The ID of the action attempt. */
10874
+ action_attempt_id: string
10875
+ status: 'error'
10876
+ result: null
10877
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10878
+ error: {
10879
+ type: string
10880
+ message: string
10881
+ }
10882
+ }
10286
10883
  | {
10287
10884
  /** The ID of the action attempt. */
10288
10885
  action_attempt_id: string
@@ -10702,6 +11299,33 @@ export interface Routes {
10702
11299
  message: string
10703
11300
  }
10704
11301
  }
11302
+ | {
11303
+ /** The ID of the action attempt. */
11304
+ action_attempt_id: string
11305
+ status: 'pending'
11306
+ result: null
11307
+ error: null
11308
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11309
+ }
11310
+ | {
11311
+ /** The ID of the action attempt. */
11312
+ action_attempt_id: string
11313
+ status: 'success'
11314
+ error: null
11315
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11316
+ result: {}
11317
+ }
11318
+ | {
11319
+ /** The ID of the action attempt. */
11320
+ action_attempt_id: string
11321
+ status: 'error'
11322
+ result: null
11323
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11324
+ error: {
11325
+ type: string
11326
+ message: string
11327
+ }
11328
+ }
10705
11329
  | {
10706
11330
  /** The ID of the action attempt. */
10707
11331
  action_attempt_id: string
@@ -11530,42 +12154,44 @@ export interface Routes {
11530
12154
  is_heating?: boolean | undefined
11531
12155
  is_cooling?: boolean | undefined
11532
12156
  is_fan_running?: boolean | undefined
12157
+ /**
12158
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
11533
12159
  fan_mode_setting?: ('auto' | 'on') | undefined
11534
12160
  is_temporary_manual_override_active?: boolean | undefined
11535
12161
  current_climate_setting?:
11536
12162
  | {
11537
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
11538
- cooling_set_point_celsius?: number | undefined
11539
- heating_set_point_celsius?: number | undefined
11540
- cooling_set_point_fahrenheit?: number | undefined
11541
- heating_set_point_fahrenheit?: number | undefined
11542
- manual_override_allowed: boolean
12163
+ climate_preset_key?: string | undefined
12164
+ can_edit?: boolean | undefined
12165
+ can_delete?: boolean | undefined
12166
+ name?: (string | null) | undefined
12167
+ display_name?: string | undefined
12168
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12169
+ hvac_mode_setting?:
12170
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12171
+ | undefined
12172
+ cooling_set_point_celsius?: (number | undefined) | undefined
12173
+ heating_set_point_celsius?: (number | undefined) | undefined
12174
+ cooling_set_point_fahrenheit?:
12175
+ | (number | undefined)
12176
+ | undefined
12177
+ heating_set_point_fahrenheit?:
12178
+ | (number | undefined)
12179
+ | undefined
12180
+ manual_override_allowed?: boolean | undefined
11543
12181
  }
11544
12182
  | undefined
12183
+ /**
12184
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11545
12185
  default_climate_setting?:
11546
12186
  | {
11547
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
11548
- cooling_set_point_celsius?: number | undefined
11549
- heating_set_point_celsius?: number | undefined
11550
- cooling_set_point_fahrenheit?: number | undefined
11551
- heating_set_point_fahrenheit?: number | undefined
11552
- manual_override_allowed: boolean
11553
- }
11554
- | undefined
11555
- is_climate_setting_schedule_active?: boolean | undefined
11556
- active_climate_setting_schedule?:
11557
- | {
11558
- climate_setting_schedule_id: string
11559
- schedule_type: 'time_bound'
11560
- device_id: string
11561
- name?: string | undefined
11562
- schedule_starts_at: string
11563
- schedule_ends_at: string
11564
- created_at: string
11565
- /** 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. */
11566
- errors?: any
12187
+ climate_preset_key?: string | undefined
12188
+ can_edit?: boolean | undefined
12189
+ can_delete?: boolean | undefined
12190
+ name?: (string | null) | undefined
12191
+ display_name?: string | undefined
12192
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
11567
12193
  hvac_mode_setting?:
11568
- | ('off' | 'heat' | 'cool' | 'heat_cool')
12194
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
11569
12195
  | undefined
11570
12196
  cooling_set_point_celsius?: (number | undefined) | undefined
11571
12197
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -11578,6 +12204,39 @@ export interface Routes {
11578
12204
  manual_override_allowed?: boolean | undefined
11579
12205
  }
11580
12206
  | undefined
12207
+ available_climate_presets?:
12208
+ | Array<{
12209
+ climate_preset_key: string
12210
+ can_edit: boolean
12211
+ can_delete: boolean
12212
+ name: string | null
12213
+ display_name: string
12214
+ fan_mode_setting?: ('auto' | 'on') | undefined
12215
+ hvac_mode_setting?:
12216
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12217
+ | undefined
12218
+ cooling_set_point_celsius?: number | undefined
12219
+ heating_set_point_celsius?: number | undefined
12220
+ cooling_set_point_fahrenheit?: number | undefined
12221
+ heating_set_point_fahrenheit?: number | undefined
12222
+ manual_override_allowed: boolean
12223
+ }>
12224
+ | undefined
12225
+ fallback_climate_preset_key?: (string | null) | undefined
12226
+ active_thermostat_schedule?:
12227
+ | ({
12228
+ thermostat_schedule_id: string
12229
+ device_id: string
12230
+ name?: string | undefined
12231
+ climate_preset_key: string
12232
+ max_override_period_minutes?: number
12233
+ starts_at: string
12234
+ ends_at: string
12235
+ created_at: string
12236
+ /** 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. */
12237
+ errors?: any
12238
+ } | null)
12239
+ | undefined
11581
12240
  min_cooling_set_point_celsius?: number | undefined
11582
12241
  min_cooling_set_point_fahrenheit?: number | undefined
11583
12242
  max_cooling_set_point_celsius?: number | undefined
@@ -12074,42 +12733,44 @@ export interface Routes {
12074
12733
  is_heating?: boolean | undefined
12075
12734
  is_cooling?: boolean | undefined
12076
12735
  is_fan_running?: boolean | undefined
12736
+ /**
12737
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
12077
12738
  fan_mode_setting?: ('auto' | 'on') | undefined
12078
12739
  is_temporary_manual_override_active?: boolean | undefined
12079
12740
  current_climate_setting?:
12080
12741
  | {
12081
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12082
- cooling_set_point_celsius?: number | undefined
12083
- heating_set_point_celsius?: number | undefined
12084
- cooling_set_point_fahrenheit?: number | undefined
12085
- heating_set_point_fahrenheit?: number | undefined
12086
- manual_override_allowed: boolean
12742
+ climate_preset_key?: string | undefined
12743
+ can_edit?: boolean | undefined
12744
+ can_delete?: boolean | undefined
12745
+ name?: (string | null) | undefined
12746
+ display_name?: string | undefined
12747
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12748
+ hvac_mode_setting?:
12749
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12750
+ | undefined
12751
+ cooling_set_point_celsius?: (number | undefined) | undefined
12752
+ heating_set_point_celsius?: (number | undefined) | undefined
12753
+ cooling_set_point_fahrenheit?:
12754
+ | (number | undefined)
12755
+ | undefined
12756
+ heating_set_point_fahrenheit?:
12757
+ | (number | undefined)
12758
+ | undefined
12759
+ manual_override_allowed?: boolean | undefined
12087
12760
  }
12088
12761
  | undefined
12762
+ /**
12763
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12089
12764
  default_climate_setting?:
12090
12765
  | {
12091
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
12092
- cooling_set_point_celsius?: number | undefined
12093
- heating_set_point_celsius?: number | undefined
12094
- cooling_set_point_fahrenheit?: number | undefined
12095
- heating_set_point_fahrenheit?: number | undefined
12096
- manual_override_allowed: boolean
12097
- }
12098
- | undefined
12099
- is_climate_setting_schedule_active?: boolean | undefined
12100
- active_climate_setting_schedule?:
12101
- | {
12102
- climate_setting_schedule_id: string
12103
- schedule_type: 'time_bound'
12104
- device_id: string
12105
- name?: string | undefined
12106
- schedule_starts_at: string
12107
- schedule_ends_at: string
12108
- created_at: string
12109
- /** 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. */
12110
- errors?: any
12766
+ climate_preset_key?: string | undefined
12767
+ can_edit?: boolean | undefined
12768
+ can_delete?: boolean | undefined
12769
+ name?: (string | null) | undefined
12770
+ display_name?: string | undefined
12771
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12111
12772
  hvac_mode_setting?:
12112
- | ('off' | 'heat' | 'cool' | 'heat_cool')
12773
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12113
12774
  | undefined
12114
12775
  cooling_set_point_celsius?: (number | undefined) | undefined
12115
12776
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -12122,17 +12783,50 @@ export interface Routes {
12122
12783
  manual_override_allowed?: boolean | undefined
12123
12784
  }
12124
12785
  | undefined
12125
- min_cooling_set_point_celsius?: number | undefined
12126
- min_cooling_set_point_fahrenheit?: number | undefined
12127
- max_cooling_set_point_celsius?: number | undefined
12128
- max_cooling_set_point_fahrenheit?: number | undefined
12129
- min_heating_set_point_celsius?: number | undefined
12130
- min_heating_set_point_fahrenheit?: number | undefined
12131
- max_heating_set_point_celsius?: number | undefined
12132
- max_heating_set_point_fahrenheit?: number | undefined
12133
- min_heating_cooling_delta_celsius?: number | undefined
12134
- min_heating_cooling_delta_fahrenheit?: number | undefined
12135
- })
12786
+ available_climate_presets?:
12787
+ | Array<{
12788
+ climate_preset_key: string
12789
+ can_edit: boolean
12790
+ can_delete: boolean
12791
+ name: string | null
12792
+ display_name: string
12793
+ fan_mode_setting?: ('auto' | 'on') | undefined
12794
+ hvac_mode_setting?:
12795
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12796
+ | undefined
12797
+ cooling_set_point_celsius?: number | undefined
12798
+ heating_set_point_celsius?: number | undefined
12799
+ cooling_set_point_fahrenheit?: number | undefined
12800
+ heating_set_point_fahrenheit?: number | undefined
12801
+ manual_override_allowed: boolean
12802
+ }>
12803
+ | undefined
12804
+ fallback_climate_preset_key?: (string | null) | undefined
12805
+ active_thermostat_schedule?:
12806
+ | ({
12807
+ thermostat_schedule_id: string
12808
+ device_id: string
12809
+ name?: string | undefined
12810
+ climate_preset_key: string
12811
+ max_override_period_minutes?: number
12812
+ starts_at: string
12813
+ ends_at: string
12814
+ created_at: string
12815
+ /** 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. */
12816
+ errors?: any
12817
+ } | null)
12818
+ | undefined
12819
+ min_cooling_set_point_celsius?: number | undefined
12820
+ min_cooling_set_point_fahrenheit?: number | undefined
12821
+ max_cooling_set_point_celsius?: number | undefined
12822
+ max_cooling_set_point_fahrenheit?: number | undefined
12823
+ min_heating_set_point_celsius?: number | undefined
12824
+ min_heating_set_point_fahrenheit?: number | undefined
12825
+ max_heating_set_point_celsius?: number | undefined
12826
+ max_heating_set_point_fahrenheit?: number | undefined
12827
+ min_heating_cooling_delta_celsius?: number | undefined
12828
+ min_heating_cooling_delta_fahrenheit?: number | undefined
12829
+ })
12136
12830
  /** Location information for the device. */
12137
12831
  location: {
12138
12832
  /** Name of the device location. */
@@ -12414,6 +13108,33 @@ export interface Routes {
12414
13108
  message: string
12415
13109
  }
12416
13110
  }
13111
+ | {
13112
+ /** The ID of the action attempt. */
13113
+ action_attempt_id: string
13114
+ status: 'pending'
13115
+ result: null
13116
+ error: null
13117
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13118
+ }
13119
+ | {
13120
+ /** The ID of the action attempt. */
13121
+ action_attempt_id: string
13122
+ status: 'success'
13123
+ error: null
13124
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13125
+ result: {}
13126
+ }
13127
+ | {
13128
+ /** The ID of the action attempt. */
13129
+ action_attempt_id: string
13130
+ status: 'error'
13131
+ result: null
13132
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13133
+ error: {
13134
+ type: string
13135
+ message: string
13136
+ }
13137
+ }
12417
13138
  | {
12418
13139
  /** The ID of the action attempt. */
12419
13140
  action_attempt_id: string
@@ -12843,6 +13564,33 @@ export interface Routes {
12843
13564
  message: string
12844
13565
  }
12845
13566
  }
13567
+ | {
13568
+ /** The ID of the action attempt. */
13569
+ action_attempt_id: string
13570
+ status: 'pending'
13571
+ result: null
13572
+ error: null
13573
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13574
+ }
13575
+ | {
13576
+ /** The ID of the action attempt. */
13577
+ action_attempt_id: string
13578
+ status: 'success'
13579
+ error: null
13580
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13581
+ result: {}
13582
+ }
13583
+ | {
13584
+ /** The ID of the action attempt. */
13585
+ action_attempt_id: string
13586
+ status: 'error'
13587
+ result: null
13588
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13589
+ error: {
13590
+ type: string
13591
+ message: string
13592
+ }
13593
+ }
12846
13594
  | {
12847
13595
  /** The ID of the action attempt. */
12848
13596
  action_attempt_id: string
@@ -13311,6 +14059,33 @@ export interface Routes {
13311
14059
  message: string
13312
14060
  }
13313
14061
  }
14062
+ | {
14063
+ /** The ID of the action attempt. */
14064
+ action_attempt_id: string
14065
+ status: 'pending'
14066
+ result: null
14067
+ error: null
14068
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14069
+ }
14070
+ | {
14071
+ /** The ID of the action attempt. */
14072
+ action_attempt_id: string
14073
+ status: 'success'
14074
+ error: null
14075
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14076
+ result: {}
14077
+ }
14078
+ | {
14079
+ /** The ID of the action attempt. */
14080
+ action_attempt_id: string
14081
+ status: 'error'
14082
+ result: null
14083
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14084
+ error: {
14085
+ type: string
14086
+ message: string
14087
+ }
14088
+ }
13314
14089
  | {
13315
14090
  /** The ID of the action attempt. */
13316
14091
  action_attempt_id: string
@@ -13708,153 +14483,450 @@ export interface Routes {
13708
14483
  }
13709
14484
  }
13710
14485
  }
13711
- '/thermostats/climate_setting_schedules/create': {
13712
- route: '/thermostats/climate_setting_schedules/create'
14486
+ '/thermostats/activate_climate_preset': {
14487
+ route: '/thermostats/activate_climate_preset'
13713
14488
  method: 'POST'
13714
14489
  queryParams: {}
13715
14490
  jsonBody: {
13716
- schedule_type?: 'time_bound'
13717
- device_id: string
13718
- name?: string | undefined
13719
- schedule_starts_at: string
13720
- schedule_ends_at: string
13721
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13722
- cooling_set_point_celsius?: (number | undefined) | undefined
13723
- heating_set_point_celsius?: (number | undefined) | undefined
13724
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13725
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13726
- manual_override_allowed?: boolean | undefined
13727
- }
13728
- commonParams: {}
13729
- formData: {}
13730
- jsonResponse: {
13731
- climate_setting_schedule: {
13732
- climate_setting_schedule_id: string
13733
- schedule_type: 'time_bound'
13734
- device_id: string
13735
- name?: string | undefined
13736
- schedule_starts_at: string
13737
- schedule_ends_at: string
13738
- created_at: string
13739
- /** 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. */
13740
- errors?: any
13741
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13742
- cooling_set_point_celsius?: (number | undefined) | undefined
13743
- heating_set_point_celsius?: (number | undefined) | undefined
13744
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13745
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13746
- manual_override_allowed?: boolean | undefined
13747
- }
13748
- }
13749
- }
13750
- '/thermostats/climate_setting_schedules/delete': {
13751
- route: '/thermostats/climate_setting_schedules/delete'
13752
- method: 'DELETE' | 'POST' | 'PUT'
13753
- queryParams: {}
13754
- jsonBody: {}
13755
- commonParams: {
13756
- climate_setting_schedule_id: string
13757
- }
13758
- formData: {}
13759
- jsonResponse: {}
13760
- }
13761
- '/thermostats/climate_setting_schedules/get': {
13762
- route: '/thermostats/climate_setting_schedules/get'
13763
- method: 'GET' | 'POST'
13764
- queryParams: {}
13765
- jsonBody: {}
13766
- commonParams: {
13767
- climate_setting_schedule_id?: string | undefined
13768
- device_id?: string | undefined
13769
- }
13770
- formData: {}
13771
- jsonResponse: {
13772
- climate_setting_schedule: {
13773
- climate_setting_schedule_id: string
13774
- schedule_type: 'time_bound'
13775
- device_id: string
13776
- name?: string | undefined
13777
- schedule_starts_at: string
13778
- schedule_ends_at: string
13779
- created_at: string
13780
- /** 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. */
13781
- errors?: any
13782
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13783
- cooling_set_point_celsius?: (number | undefined) | undefined
13784
- heating_set_point_celsius?: (number | undefined) | undefined
13785
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13786
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13787
- manual_override_allowed?: boolean | undefined
13788
- }
13789
- }
13790
- }
13791
- '/thermostats/climate_setting_schedules/list': {
13792
- route: '/thermostats/climate_setting_schedules/list'
13793
- method: 'GET' | 'POST'
13794
- queryParams: {}
13795
- jsonBody: {}
13796
- commonParams: {
13797
14491
  device_id: string
13798
- user_identifier_key?: string | undefined
13799
- }
13800
- formData: {}
13801
- jsonResponse: {
13802
- climate_setting_schedules: Array<{
13803
- climate_setting_schedule_id: string
13804
- schedule_type: 'time_bound'
13805
- device_id: string
13806
- name?: string | undefined
13807
- schedule_starts_at: string
13808
- schedule_ends_at: string
13809
- created_at: string
13810
- /** 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. */
13811
- errors?: any
13812
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13813
- cooling_set_point_celsius?: (number | undefined) | undefined
13814
- heating_set_point_celsius?: (number | undefined) | undefined
13815
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13816
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13817
- manual_override_allowed?: boolean | undefined
13818
- }>
13819
- }
13820
- }
13821
- '/thermostats/climate_setting_schedules/update': {
13822
- route: '/thermostats/climate_setting_schedules/update'
13823
- method: 'PATCH' | 'POST' | 'PUT'
13824
- queryParams: {}
13825
- jsonBody: {
13826
- climate_setting_schedule_id: string
13827
- schedule_type?: 'time_bound'
13828
- name?: string | undefined
13829
- schedule_starts_at?: string | undefined
13830
- schedule_ends_at?: string | undefined
13831
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13832
- cooling_set_point_celsius?: (number | undefined) | undefined
13833
- heating_set_point_celsius?: (number | undefined) | undefined
13834
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13835
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13836
- manual_override_allowed?: boolean | undefined
14492
+ climate_preset_key: string
13837
14493
  }
13838
14494
  commonParams: {}
13839
14495
  formData: {}
13840
14496
  jsonResponse: {
13841
- climate_setting_schedule: {
13842
- climate_setting_schedule_id: string
13843
- schedule_type: 'time_bound'
13844
- device_id: string
13845
- name?: string | undefined
13846
- schedule_starts_at: string
13847
- schedule_ends_at: string
13848
- created_at: string
13849
- /** 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. */
13850
- errors?: any
13851
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
13852
- cooling_set_point_celsius?: (number | undefined) | undefined
13853
- heating_set_point_celsius?: (number | undefined) | undefined
13854
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
13855
- heating_set_point_fahrenheit?: (number | undefined) | undefined
13856
- manual_override_allowed?: boolean | undefined
13857
- }
14497
+ action_attempt:
14498
+ | {
14499
+ /** The ID of the action attempt. */
14500
+ action_attempt_id: string
14501
+ status: 'pending'
14502
+ result: null
14503
+ error: null
14504
+ action_type: 'LOCK_DOOR'
14505
+ }
14506
+ | {
14507
+ /** The ID of the action attempt. */
14508
+ action_attempt_id: string
14509
+ status: 'success'
14510
+ error: null
14511
+ action_type: 'LOCK_DOOR'
14512
+ result: {}
14513
+ }
14514
+ | {
14515
+ /** The ID of the action attempt. */
14516
+ action_attempt_id: string
14517
+ status: 'error'
14518
+ result: null
14519
+ action_type: 'LOCK_DOOR'
14520
+ error: {
14521
+ type: string
14522
+ message: string
14523
+ }
14524
+ }
14525
+ | {
14526
+ /** The ID of the action attempt. */
14527
+ action_attempt_id: string
14528
+ status: 'pending'
14529
+ result: null
14530
+ error: null
14531
+ action_type: 'UNLOCK_DOOR'
14532
+ }
14533
+ | {
14534
+ /** The ID of the action attempt. */
14535
+ action_attempt_id: string
14536
+ status: 'success'
14537
+ error: null
14538
+ action_type: 'UNLOCK_DOOR'
14539
+ result: {}
14540
+ }
14541
+ | {
14542
+ /** The ID of the action attempt. */
14543
+ action_attempt_id: string
14544
+ status: 'error'
14545
+ result: null
14546
+ action_type: 'UNLOCK_DOOR'
14547
+ error: {
14548
+ type: string
14549
+ message: string
14550
+ }
14551
+ }
14552
+ | {
14553
+ /** The ID of the action attempt. */
14554
+ action_attempt_id: string
14555
+ status: 'pending'
14556
+ result: null
14557
+ error: null
14558
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14559
+ }
14560
+ | {
14561
+ /** The ID of the action attempt. */
14562
+ action_attempt_id: string
14563
+ status: 'success'
14564
+ error: null
14565
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14566
+ result: {}
14567
+ }
14568
+ | {
14569
+ /** The ID of the action attempt. */
14570
+ action_attempt_id: string
14571
+ status: 'error'
14572
+ result: null
14573
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14574
+ error: {
14575
+ type: string
14576
+ message: string
14577
+ }
14578
+ }
14579
+ | {
14580
+ /** The ID of the action attempt. */
14581
+ action_attempt_id: string
14582
+ status: 'pending'
14583
+ result: null
14584
+ error: null
14585
+ action_type: 'SET_COOL'
14586
+ }
14587
+ | {
14588
+ /** The ID of the action attempt. */
14589
+ action_attempt_id: string
14590
+ status: 'success'
14591
+ error: null
14592
+ action_type: 'SET_COOL'
14593
+ result: {}
14594
+ }
14595
+ | {
14596
+ /** The ID of the action attempt. */
14597
+ action_attempt_id: string
14598
+ status: 'error'
14599
+ result: null
14600
+ action_type: 'SET_COOL'
14601
+ error: {
14602
+ type: string
14603
+ message: string
14604
+ }
14605
+ }
14606
+ | {
14607
+ /** The ID of the action attempt. */
14608
+ action_attempt_id: string
14609
+ status: 'pending'
14610
+ result: null
14611
+ error: null
14612
+ action_type: 'SET_HEAT'
14613
+ }
14614
+ | {
14615
+ /** The ID of the action attempt. */
14616
+ action_attempt_id: string
14617
+ status: 'success'
14618
+ error: null
14619
+ action_type: 'SET_HEAT'
14620
+ result: {}
14621
+ }
14622
+ | {
14623
+ /** The ID of the action attempt. */
14624
+ action_attempt_id: string
14625
+ status: 'error'
14626
+ result: null
14627
+ action_type: 'SET_HEAT'
14628
+ error: {
14629
+ type: string
14630
+ message: string
14631
+ }
14632
+ }
14633
+ | {
14634
+ /** The ID of the action attempt. */
14635
+ action_attempt_id: string
14636
+ status: 'pending'
14637
+ result: null
14638
+ error: null
14639
+ action_type: 'SET_HEAT_COOL'
14640
+ }
14641
+ | {
14642
+ /** The ID of the action attempt. */
14643
+ action_attempt_id: string
14644
+ status: 'success'
14645
+ error: null
14646
+ action_type: 'SET_HEAT_COOL'
14647
+ result: {}
14648
+ }
14649
+ | {
14650
+ /** The ID of the action attempt. */
14651
+ action_attempt_id: string
14652
+ status: 'error'
14653
+ result: null
14654
+ action_type: 'SET_HEAT_COOL'
14655
+ error: {
14656
+ type: string
14657
+ message: string
14658
+ }
14659
+ }
14660
+ | {
14661
+ /** The ID of the action attempt. */
14662
+ action_attempt_id: string
14663
+ status: 'pending'
14664
+ result: null
14665
+ error: null
14666
+ action_type: 'SET_FAN_MODE'
14667
+ }
14668
+ | {
14669
+ /** The ID of the action attempt. */
14670
+ action_attempt_id: string
14671
+ status: 'success'
14672
+ error: null
14673
+ action_type: 'SET_FAN_MODE'
14674
+ result: {}
14675
+ }
14676
+ | {
14677
+ /** The ID of the action attempt. */
14678
+ action_attempt_id: string
14679
+ status: 'error'
14680
+ result: null
14681
+ action_type: 'SET_FAN_MODE'
14682
+ error: {
14683
+ type: string
14684
+ message: string
14685
+ }
14686
+ }
14687
+ | {
14688
+ /** The ID of the action attempt. */
14689
+ action_attempt_id: string
14690
+ status: 'pending'
14691
+ result: null
14692
+ error: null
14693
+ action_type: 'SET_THERMOSTAT_OFF'
14694
+ }
14695
+ | {
14696
+ /** The ID of the action attempt. */
14697
+ action_attempt_id: string
14698
+ status: 'success'
14699
+ error: null
14700
+ action_type: 'SET_THERMOSTAT_OFF'
14701
+ result: {}
14702
+ }
14703
+ | {
14704
+ /** The ID of the action attempt. */
14705
+ action_attempt_id: string
14706
+ status: 'error'
14707
+ result: null
14708
+ action_type: 'SET_THERMOSTAT_OFF'
14709
+ error: {
14710
+ type: string
14711
+ message: string
14712
+ }
14713
+ }
14714
+ | {
14715
+ /** The ID of the action attempt. */
14716
+ action_attempt_id: string
14717
+ status: 'pending'
14718
+ result: null
14719
+ error: null
14720
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14721
+ }
14722
+ | {
14723
+ /** The ID of the action attempt. */
14724
+ action_attempt_id: string
14725
+ status: 'success'
14726
+ error: null
14727
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14728
+ result: {}
14729
+ }
14730
+ | {
14731
+ /** The ID of the action attempt. */
14732
+ action_attempt_id: string
14733
+ status: 'error'
14734
+ result: null
14735
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14736
+ error: {
14737
+ type: string
14738
+ message: string
14739
+ }
14740
+ }
14741
+ | {
14742
+ /** The ID of the action attempt. */
14743
+ action_attempt_id: string
14744
+ status: 'pending'
14745
+ result: null
14746
+ error: null
14747
+ action_type: 'SYNC_ACCESS_CODES'
14748
+ }
14749
+ | {
14750
+ /** The ID of the action attempt. */
14751
+ action_attempt_id: string
14752
+ status: 'success'
14753
+ error: null
14754
+ action_type: 'SYNC_ACCESS_CODES'
14755
+ result?: any
14756
+ }
14757
+ | {
14758
+ /** The ID of the action attempt. */
14759
+ action_attempt_id: string
14760
+ status: 'error'
14761
+ result: null
14762
+ action_type: 'SYNC_ACCESS_CODES'
14763
+ error: {
14764
+ type: string
14765
+ message: string
14766
+ }
14767
+ }
14768
+ | {
14769
+ /** The ID of the action attempt. */
14770
+ action_attempt_id: string
14771
+ status: 'pending'
14772
+ result: null
14773
+ error: null
14774
+ action_type: 'CREATE_ACCESS_CODE'
14775
+ }
14776
+ | {
14777
+ /** The ID of the action attempt. */
14778
+ action_attempt_id: string
14779
+ status: 'success'
14780
+ error: null
14781
+ action_type: 'CREATE_ACCESS_CODE'
14782
+ result?: any
14783
+ }
14784
+ | {
14785
+ /** The ID of the action attempt. */
14786
+ action_attempt_id: string
14787
+ status: 'error'
14788
+ result: null
14789
+ action_type: 'CREATE_ACCESS_CODE'
14790
+ error: {
14791
+ type: string
14792
+ message: string
14793
+ }
14794
+ }
14795
+ | {
14796
+ /** The ID of the action attempt. */
14797
+ action_attempt_id: string
14798
+ status: 'pending'
14799
+ result: null
14800
+ error: null
14801
+ action_type: 'DELETE_ACCESS_CODE'
14802
+ }
14803
+ | {
14804
+ /** The ID of the action attempt. */
14805
+ action_attempt_id: string
14806
+ status: 'success'
14807
+ error: null
14808
+ action_type: 'DELETE_ACCESS_CODE'
14809
+ result?: any
14810
+ }
14811
+ | {
14812
+ /** The ID of the action attempt. */
14813
+ action_attempt_id: string
14814
+ status: 'error'
14815
+ result: null
14816
+ action_type: 'DELETE_ACCESS_CODE'
14817
+ error: {
14818
+ type: string
14819
+ message: string
14820
+ }
14821
+ }
14822
+ | {
14823
+ /** The ID of the action attempt. */
14824
+ action_attempt_id: string
14825
+ status: 'pending'
14826
+ result: null
14827
+ error: null
14828
+ action_type: 'UPDATE_ACCESS_CODE'
14829
+ }
14830
+ | {
14831
+ /** The ID of the action attempt. */
14832
+ action_attempt_id: string
14833
+ status: 'success'
14834
+ error: null
14835
+ action_type: 'UPDATE_ACCESS_CODE'
14836
+ result?: any
14837
+ }
14838
+ | {
14839
+ /** The ID of the action attempt. */
14840
+ action_attempt_id: string
14841
+ status: 'error'
14842
+ result: null
14843
+ action_type: 'UPDATE_ACCESS_CODE'
14844
+ error: {
14845
+ type: string
14846
+ message: string
14847
+ }
14848
+ }
14849
+ | {
14850
+ /** The ID of the action attempt. */
14851
+ action_attempt_id: string
14852
+ status: 'pending'
14853
+ result: null
14854
+ error: null
14855
+ action_type: 'CREATE_NOISE_THRESHOLD'
14856
+ }
14857
+ | {
14858
+ /** The ID of the action attempt. */
14859
+ action_attempt_id: string
14860
+ status: 'success'
14861
+ error: null
14862
+ action_type: 'CREATE_NOISE_THRESHOLD'
14863
+ result?: any
14864
+ }
14865
+ | {
14866
+ /** The ID of the action attempt. */
14867
+ action_attempt_id: string
14868
+ status: 'error'
14869
+ result: null
14870
+ action_type: 'CREATE_NOISE_THRESHOLD'
14871
+ error: {
14872
+ type: string
14873
+ message: string
14874
+ }
14875
+ }
14876
+ | {
14877
+ /** The ID of the action attempt. */
14878
+ action_attempt_id: string
14879
+ status: 'pending'
14880
+ result: null
14881
+ error: null
14882
+ action_type: 'DELETE_NOISE_THRESHOLD'
14883
+ }
14884
+ | {
14885
+ /** The ID of the action attempt. */
14886
+ action_attempt_id: string
14887
+ status: 'success'
14888
+ error: null
14889
+ action_type: 'DELETE_NOISE_THRESHOLD'
14890
+ result?: any
14891
+ }
14892
+ | {
14893
+ /** The ID of the action attempt. */
14894
+ action_attempt_id: string
14895
+ status: 'error'
14896
+ result: null
14897
+ action_type: 'DELETE_NOISE_THRESHOLD'
14898
+ error: {
14899
+ type: string
14900
+ message: string
14901
+ }
14902
+ }
14903
+ | {
14904
+ /** The ID of the action attempt. */
14905
+ action_attempt_id: string
14906
+ status: 'pending'
14907
+ result: null
14908
+ error: null
14909
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14910
+ }
14911
+ | {
14912
+ /** The ID of the action attempt. */
14913
+ action_attempt_id: string
14914
+ status: 'success'
14915
+ error: null
14916
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14917
+ result?: any
14918
+ }
14919
+ | {
14920
+ /** The ID of the action attempt. */
14921
+ action_attempt_id: string
14922
+ status: 'error'
14923
+ result: null
14924
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14925
+ error: {
14926
+ type: string
14927
+ message: string
14928
+ }
14929
+ }
13858
14930
  }
13859
14931
  }
13860
14932
  '/thermostats/cool': {
@@ -14087,6 +15159,33 @@ export interface Routes {
14087
15159
  message: string
14088
15160
  }
14089
15161
  }
15162
+ | {
15163
+ /** The ID of the action attempt. */
15164
+ action_attempt_id: string
15165
+ status: 'pending'
15166
+ result: null
15167
+ error: null
15168
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15169
+ }
15170
+ | {
15171
+ /** The ID of the action attempt. */
15172
+ action_attempt_id: string
15173
+ status: 'success'
15174
+ error: null
15175
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15176
+ result: {}
15177
+ }
15178
+ | {
15179
+ /** The ID of the action attempt. */
15180
+ action_attempt_id: string
15181
+ status: 'error'
15182
+ result: null
15183
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15184
+ error: {
15185
+ type: string
15186
+ message: string
15187
+ }
15188
+ }
14090
15189
  | {
14091
15190
  /** The ID of the action attempt. */
14092
15191
  action_attempt_id: string
@@ -14278,6 +15377,53 @@ export interface Routes {
14278
15377
  }
14279
15378
  }
14280
15379
  }
15380
+ '/thermostats/create_climate_preset': {
15381
+ route: '/thermostats/create_climate_preset'
15382
+ method: 'POST'
15383
+ queryParams: {}
15384
+ jsonBody: {
15385
+ device_id: string
15386
+ climate_preset_key: string
15387
+ name: string | null
15388
+ fan_mode_setting?: ('auto' | 'on') | undefined
15389
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
15390
+ cooling_set_point_celsius?: number | undefined
15391
+ heating_set_point_celsius?: number | undefined
15392
+ cooling_set_point_fahrenheit?: number | undefined
15393
+ heating_set_point_fahrenheit?: number | undefined
15394
+ manual_override_allowed: boolean
15395
+ }
15396
+ commonParams: {}
15397
+ formData: {}
15398
+ jsonResponse: {
15399
+ climate_preset: {
15400
+ climate_preset_key: string
15401
+ can_edit: boolean
15402
+ can_delete: boolean
15403
+ name: string | null
15404
+ display_name: string
15405
+ fan_mode_setting?: ('auto' | 'on') | undefined
15406
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
15407
+ cooling_set_point_celsius?: number | undefined
15408
+ heating_set_point_celsius?: number | undefined
15409
+ cooling_set_point_fahrenheit?: number | undefined
15410
+ heating_set_point_fahrenheit?: number | undefined
15411
+ manual_override_allowed: boolean
15412
+ }
15413
+ }
15414
+ }
15415
+ '/thermostats/delete_climate_preset': {
15416
+ route: '/thermostats/delete_climate_preset'
15417
+ method: 'POST' | 'DELETE'
15418
+ queryParams: {}
15419
+ jsonBody: {
15420
+ device_id: string
15421
+ climate_preset_key: string
15422
+ }
15423
+ commonParams: {}
15424
+ formData: {}
15425
+ jsonResponse: {}
15426
+ }
14281
15427
  '/thermostats/get': {
14282
15428
  route: '/thermostats/get'
14283
15429
  method: 'GET' | 'POST'
@@ -14728,42 +15874,44 @@ export interface Routes {
14728
15874
  is_heating?: boolean | undefined
14729
15875
  is_cooling?: boolean | undefined
14730
15876
  is_fan_running?: boolean | undefined
15877
+ /**
15878
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14731
15879
  fan_mode_setting?: ('auto' | 'on') | undefined
14732
15880
  is_temporary_manual_override_active?: boolean | undefined
14733
15881
  current_climate_setting?:
14734
15882
  | {
14735
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
14736
- cooling_set_point_celsius?: number | undefined
14737
- heating_set_point_celsius?: number | undefined
14738
- cooling_set_point_fahrenheit?: number | undefined
14739
- heating_set_point_fahrenheit?: number | undefined
14740
- manual_override_allowed: boolean
15883
+ climate_preset_key?: string | undefined
15884
+ can_edit?: boolean | undefined
15885
+ can_delete?: boolean | undefined
15886
+ name?: (string | null) | undefined
15887
+ display_name?: string | undefined
15888
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
15889
+ hvac_mode_setting?:
15890
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15891
+ | undefined
15892
+ cooling_set_point_celsius?: (number | undefined) | undefined
15893
+ heating_set_point_celsius?: (number | undefined) | undefined
15894
+ cooling_set_point_fahrenheit?:
15895
+ | (number | undefined)
15896
+ | undefined
15897
+ heating_set_point_fahrenheit?:
15898
+ | (number | undefined)
15899
+ | undefined
15900
+ manual_override_allowed?: boolean | undefined
14741
15901
  }
14742
15902
  | undefined
15903
+ /**
15904
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14743
15905
  default_climate_setting?:
14744
15906
  | {
14745
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
14746
- cooling_set_point_celsius?: number | undefined
14747
- heating_set_point_celsius?: number | undefined
14748
- cooling_set_point_fahrenheit?: number | undefined
14749
- heating_set_point_fahrenheit?: number | undefined
14750
- manual_override_allowed: boolean
14751
- }
14752
- | undefined
14753
- is_climate_setting_schedule_active?: boolean | undefined
14754
- active_climate_setting_schedule?:
14755
- | {
14756
- climate_setting_schedule_id: string
14757
- schedule_type: 'time_bound'
14758
- device_id: string
14759
- name?: string | undefined
14760
- schedule_starts_at: string
14761
- schedule_ends_at: string
14762
- created_at: string
14763
- /** 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. */
14764
- errors?: any
15907
+ climate_preset_key?: string | undefined
15908
+ can_edit?: boolean | undefined
15909
+ can_delete?: boolean | undefined
15910
+ name?: (string | null) | undefined
15911
+ display_name?: string | undefined
15912
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
14765
15913
  hvac_mode_setting?:
14766
- | ('off' | 'heat' | 'cool' | 'heat_cool')
15914
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
14767
15915
  | undefined
14768
15916
  cooling_set_point_celsius?: (number | undefined) | undefined
14769
15917
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -14776,6 +15924,39 @@ export interface Routes {
14776
15924
  manual_override_allowed?: boolean | undefined
14777
15925
  }
14778
15926
  | undefined
15927
+ available_climate_presets?:
15928
+ | Array<{
15929
+ climate_preset_key: string
15930
+ can_edit: boolean
15931
+ can_delete: boolean
15932
+ name: string | null
15933
+ display_name: string
15934
+ fan_mode_setting?: ('auto' | 'on') | undefined
15935
+ hvac_mode_setting?:
15936
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
15937
+ | undefined
15938
+ cooling_set_point_celsius?: number | undefined
15939
+ heating_set_point_celsius?: number | undefined
15940
+ cooling_set_point_fahrenheit?: number | undefined
15941
+ heating_set_point_fahrenheit?: number | undefined
15942
+ manual_override_allowed: boolean
15943
+ }>
15944
+ | undefined
15945
+ fallback_climate_preset_key?: (string | null) | undefined
15946
+ active_thermostat_schedule?:
15947
+ | ({
15948
+ thermostat_schedule_id: string
15949
+ device_id: string
15950
+ name?: string | undefined
15951
+ climate_preset_key: string
15952
+ max_override_period_minutes?: number
15953
+ starts_at: string
15954
+ ends_at: string
15955
+ created_at: string
15956
+ /** 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. */
15957
+ errors?: any
15958
+ } | null)
15959
+ | undefined
14779
15960
  min_cooling_set_point_celsius?: number | undefined
14780
15961
  min_cooling_set_point_fahrenheit?: number | undefined
14781
15962
  max_cooling_set_point_celsius?: number | undefined
@@ -15065,6 +16246,33 @@ export interface Routes {
15065
16246
  message: string
15066
16247
  }
15067
16248
  }
16249
+ | {
16250
+ /** The ID of the action attempt. */
16251
+ action_attempt_id: string
16252
+ status: 'pending'
16253
+ result: null
16254
+ error: null
16255
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16256
+ }
16257
+ | {
16258
+ /** The ID of the action attempt. */
16259
+ action_attempt_id: string
16260
+ status: 'success'
16261
+ error: null
16262
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16263
+ result: {}
16264
+ }
16265
+ | {
16266
+ /** The ID of the action attempt. */
16267
+ action_attempt_id: string
16268
+ status: 'error'
16269
+ result: null
16270
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16271
+ error: {
16272
+ type: string
16273
+ message: string
16274
+ }
16275
+ }
15068
16276
  | {
15069
16277
  /** The ID of the action attempt. */
15070
16278
  action_attempt_id: string
@@ -15488,6 +16696,33 @@ export interface Routes {
15488
16696
  message: string
15489
16697
  }
15490
16698
  }
16699
+ | {
16700
+ /** The ID of the action attempt. */
16701
+ action_attempt_id: string
16702
+ status: 'pending'
16703
+ result: null
16704
+ error: null
16705
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16706
+ }
16707
+ | {
16708
+ /** The ID of the action attempt. */
16709
+ action_attempt_id: string
16710
+ status: 'success'
16711
+ error: null
16712
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16713
+ result: {}
16714
+ }
16715
+ | {
16716
+ /** The ID of the action attempt. */
16717
+ action_attempt_id: string
16718
+ status: 'error'
16719
+ result: null
16720
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16721
+ error: {
16722
+ type: string
16723
+ message: string
16724
+ }
16725
+ }
15491
16726
  | {
15492
16727
  /** The ID of the action attempt. */
15493
16728
  action_attempt_id: string
@@ -16282,42 +17517,44 @@ export interface Routes {
16282
17517
  is_heating?: boolean | undefined
16283
17518
  is_cooling?: boolean | undefined
16284
17519
  is_fan_running?: boolean | undefined
17520
+ /**
17521
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
16285
17522
  fan_mode_setting?: ('auto' | 'on') | undefined
16286
17523
  is_temporary_manual_override_active?: boolean | undefined
16287
17524
  current_climate_setting?:
16288
17525
  | {
16289
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
16290
- cooling_set_point_celsius?: number | undefined
16291
- heating_set_point_celsius?: number | undefined
16292
- cooling_set_point_fahrenheit?: number | undefined
16293
- heating_set_point_fahrenheit?: number | undefined
16294
- manual_override_allowed: boolean
17526
+ climate_preset_key?: string | undefined
17527
+ can_edit?: boolean | undefined
17528
+ can_delete?: boolean | undefined
17529
+ name?: (string | null) | undefined
17530
+ display_name?: string | undefined
17531
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
17532
+ hvac_mode_setting?:
17533
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
17534
+ | undefined
17535
+ cooling_set_point_celsius?: (number | undefined) | undefined
17536
+ heating_set_point_celsius?: (number | undefined) | undefined
17537
+ cooling_set_point_fahrenheit?:
17538
+ | (number | undefined)
17539
+ | undefined
17540
+ heating_set_point_fahrenheit?:
17541
+ | (number | undefined)
17542
+ | undefined
17543
+ manual_override_allowed?: boolean | undefined
16295
17544
  }
16296
17545
  | undefined
17546
+ /**
17547
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
16297
17548
  default_climate_setting?:
16298
17549
  | {
16299
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
16300
- cooling_set_point_celsius?: number | undefined
16301
- heating_set_point_celsius?: number | undefined
16302
- cooling_set_point_fahrenheit?: number | undefined
16303
- heating_set_point_fahrenheit?: number | undefined
16304
- manual_override_allowed: boolean
16305
- }
16306
- | undefined
16307
- is_climate_setting_schedule_active?: boolean | undefined
16308
- active_climate_setting_schedule?:
16309
- | {
16310
- climate_setting_schedule_id: string
16311
- schedule_type: 'time_bound'
16312
- device_id: string
16313
- name?: string | undefined
16314
- schedule_starts_at: string
16315
- schedule_ends_at: string
16316
- created_at: string
16317
- /** 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. */
16318
- errors?: any
17550
+ climate_preset_key?: string | undefined
17551
+ can_edit?: boolean | undefined
17552
+ can_delete?: boolean | undefined
17553
+ name?: (string | null) | undefined
17554
+ display_name?: string | undefined
17555
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
16319
17556
  hvac_mode_setting?:
16320
- | ('off' | 'heat' | 'cool' | 'heat_cool')
17557
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
16321
17558
  | undefined
16322
17559
  cooling_set_point_celsius?: (number | undefined) | undefined
16323
17560
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -16330,6 +17567,39 @@ export interface Routes {
16330
17567
  manual_override_allowed?: boolean | undefined
16331
17568
  }
16332
17569
  | undefined
17570
+ available_climate_presets?:
17571
+ | Array<{
17572
+ climate_preset_key: string
17573
+ can_edit: boolean
17574
+ can_delete: boolean
17575
+ name: string | null
17576
+ display_name: string
17577
+ fan_mode_setting?: ('auto' | 'on') | undefined
17578
+ hvac_mode_setting?:
17579
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
17580
+ | undefined
17581
+ cooling_set_point_celsius?: number | undefined
17582
+ heating_set_point_celsius?: number | undefined
17583
+ cooling_set_point_fahrenheit?: number | undefined
17584
+ heating_set_point_fahrenheit?: number | undefined
17585
+ manual_override_allowed: boolean
17586
+ }>
17587
+ | undefined
17588
+ fallback_climate_preset_key?: (string | null) | undefined
17589
+ active_thermostat_schedule?:
17590
+ | ({
17591
+ thermostat_schedule_id: string
17592
+ device_id: string
17593
+ name?: string | undefined
17594
+ climate_preset_key: string
17595
+ max_override_period_minutes?: number
17596
+ starts_at: string
17597
+ ends_at: string
17598
+ created_at: string
17599
+ /** 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. */
17600
+ errors?: any
17601
+ } | null)
17602
+ | undefined
16333
17603
  min_cooling_set_point_celsius?: number | undefined
16334
17604
  min_cooling_set_point_fahrenheit?: number | undefined
16335
17605
  max_cooling_set_point_celsius?: number | undefined
@@ -16617,6 +17887,33 @@ export interface Routes {
16617
17887
  message: string
16618
17888
  }
16619
17889
  }
17890
+ | {
17891
+ /** The ID of the action attempt. */
17892
+ action_attempt_id: string
17893
+ status: 'pending'
17894
+ result: null
17895
+ error: null
17896
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17897
+ }
17898
+ | {
17899
+ /** The ID of the action attempt. */
17900
+ action_attempt_id: string
17901
+ status: 'success'
17902
+ error: null
17903
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17904
+ result: {}
17905
+ }
17906
+ | {
17907
+ /** The ID of the action attempt. */
17908
+ action_attempt_id: string
17909
+ status: 'error'
17910
+ result: null
17911
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17912
+ error: {
17913
+ type: string
17914
+ message: string
17915
+ }
17916
+ }
16620
17917
  | {
16621
17918
  /** The ID of the action attempt. */
16622
17919
  action_attempt_id: string
@@ -16808,12 +18105,144 @@ export interface Routes {
16808
18105
  }
16809
18106
  }
16810
18107
  }
18108
+ '/thermostats/schedules/create': {
18109
+ route: '/thermostats/schedules/create'
18110
+ method: 'POST'
18111
+ queryParams: {}
18112
+ jsonBody: {
18113
+ device_id: string
18114
+ name?: string | undefined
18115
+ climate_preset_key: string
18116
+ max_override_period_minutes?: number
18117
+ starts_at: string
18118
+ ends_at: string
18119
+ }
18120
+ commonParams: {}
18121
+ formData: {}
18122
+ jsonResponse: {
18123
+ thermostat_schedule: {
18124
+ thermostat_schedule_id: string
18125
+ device_id: string
18126
+ name?: string | undefined
18127
+ climate_preset_key: string
18128
+ max_override_period_minutes?: number
18129
+ starts_at: string
18130
+ ends_at: string
18131
+ created_at: string
18132
+ /** 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. */
18133
+ errors?: any
18134
+ }
18135
+ }
18136
+ }
18137
+ '/thermostats/schedules/delete': {
18138
+ route: '/thermostats/schedules/delete'
18139
+ method: 'DELETE' | 'POST'
18140
+ queryParams: {}
18141
+ jsonBody: {}
18142
+ commonParams: {
18143
+ thermostat_schedule_id: string
18144
+ }
18145
+ formData: {}
18146
+ jsonResponse: {}
18147
+ }
18148
+ '/thermostats/schedules/get': {
18149
+ route: '/thermostats/schedules/get'
18150
+ method: 'GET' | 'POST'
18151
+ queryParams: {}
18152
+ jsonBody: {}
18153
+ commonParams: {
18154
+ thermostat_schedule_id: string
18155
+ }
18156
+ formData: {}
18157
+ jsonResponse: {
18158
+ thermostat_schedule: {
18159
+ thermostat_schedule_id: string
18160
+ device_id: string
18161
+ name?: string | undefined
18162
+ climate_preset_key: string
18163
+ max_override_period_minutes?: number
18164
+ starts_at: string
18165
+ ends_at: string
18166
+ created_at: string
18167
+ /** 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. */
18168
+ errors?: any
18169
+ }
18170
+ }
18171
+ }
18172
+ '/thermostats/schedules/list': {
18173
+ route: '/thermostats/schedules/list'
18174
+ method: 'GET' | 'POST'
18175
+ queryParams: {}
18176
+ jsonBody: {}
18177
+ commonParams: {
18178
+ device_id: string
18179
+ user_identifier_key?: string | undefined
18180
+ }
18181
+ formData: {}
18182
+ jsonResponse: {
18183
+ thermostat_schedules: Array<{
18184
+ thermostat_schedule_id: string
18185
+ device_id: string
18186
+ name?: string | undefined
18187
+ climate_preset_key: string
18188
+ max_override_period_minutes?: number
18189
+ starts_at: string
18190
+ ends_at: string
18191
+ created_at: string
18192
+ /** 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. */
18193
+ errors?: any
18194
+ }>
18195
+ }
18196
+ }
18197
+ '/thermostats/schedules/update': {
18198
+ route: '/thermostats/schedules/update'
18199
+ method: 'PATCH' | 'POST'
18200
+ queryParams: {}
18201
+ jsonBody: {
18202
+ thermostat_schedule_id: string
18203
+ name?: string | undefined
18204
+ climate_preset_key?: string | undefined
18205
+ max_override_period_minutes?: number | undefined
18206
+ starts_at?: string | undefined
18207
+ ends_at?: string | undefined
18208
+ }
18209
+ commonParams: {}
18210
+ formData: {}
18211
+ jsonResponse: {
18212
+ thermostat_schedule: {
18213
+ thermostat_schedule_id: string
18214
+ device_id: string
18215
+ name?: string | undefined
18216
+ climate_preset_key: string
18217
+ max_override_period_minutes?: number
18218
+ starts_at: string
18219
+ ends_at: string
18220
+ created_at: string
18221
+ /** 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. */
18222
+ errors?: any
18223
+ }
18224
+ }
18225
+ }
18226
+ '/thermostats/set_fallback_climate_preset': {
18227
+ route: '/thermostats/set_fallback_climate_preset'
18228
+ method: 'POST'
18229
+ queryParams: {}
18230
+ jsonBody: {
18231
+ device_id: string
18232
+ climate_preset_key: string
18233
+ }
18234
+ commonParams: {}
18235
+ formData: {}
18236
+ jsonResponse: {}
18237
+ }
16811
18238
  '/thermostats/set_fan_mode': {
16812
18239
  route: '/thermostats/set_fan_mode'
16813
18240
  method: 'POST'
16814
18241
  queryParams: {}
16815
18242
  jsonBody: {
16816
18243
  device_id: string
18244
+ /**
18245
+ * @deprecated use fan_mode_setting instead. */
16817
18246
  fan_mode?: ('auto' | 'on') | undefined
16818
18247
  fan_mode_setting?: ('auto' | 'on') | undefined
16819
18248
  sync?: boolean
@@ -17038,6 +18467,33 @@ export interface Routes {
17038
18467
  message: string
17039
18468
  }
17040
18469
  }
18470
+ | {
18471
+ /** The ID of the action attempt. */
18472
+ action_attempt_id: string
18473
+ status: 'pending'
18474
+ result: null
18475
+ error: null
18476
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18477
+ }
18478
+ | {
18479
+ /** The ID of the action attempt. */
18480
+ action_attempt_id: string
18481
+ status: 'success'
18482
+ error: null
18483
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18484
+ result: {}
18485
+ }
18486
+ | {
18487
+ /** The ID of the action attempt. */
18488
+ action_attempt_id: string
18489
+ status: 'error'
18490
+ result: null
18491
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18492
+ error: {
18493
+ type: string
18494
+ message: string
18495
+ }
18496
+ }
17041
18497
  | {
17042
18498
  /** The ID of the action attempt. */
17043
18499
  action_attempt_id: string
@@ -17229,24 +18685,40 @@ export interface Routes {
17229
18685
  }
17230
18686
  }
17231
18687
  }
17232
- '/thermostats/update': {
17233
- route: '/thermostats/update'
17234
- method: 'PATCH' | 'POST'
18688
+ '/thermostats/update_climate_preset': {
18689
+ route: '/thermostats/update_climate_preset'
18690
+ method: 'POST' | 'PATCH'
17235
18691
  queryParams: {}
17236
18692
  jsonBody: {
17237
18693
  device_id: string
17238
- default_climate_setting: {
17239
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
17240
- cooling_set_point_celsius?: (number | undefined) | undefined
17241
- heating_set_point_celsius?: (number | undefined) | undefined
17242
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
17243
- heating_set_point_fahrenheit?: (number | undefined) | undefined
17244
- manual_override_allowed?: boolean | undefined
17245
- }
18694
+ climate_preset_key: string
18695
+ name: string | null
18696
+ fan_mode_setting?: ('auto' | 'on') | undefined
18697
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
18698
+ cooling_set_point_celsius?: number | undefined
18699
+ heating_set_point_celsius?: number | undefined
18700
+ cooling_set_point_fahrenheit?: number | undefined
18701
+ heating_set_point_fahrenheit?: number | undefined
18702
+ manual_override_allowed: boolean
17246
18703
  }
17247
18704
  commonParams: {}
17248
18705
  formData: {}
17249
- jsonResponse: {}
18706
+ jsonResponse: {
18707
+ climate_preset: {
18708
+ climate_preset_key: string
18709
+ can_edit: boolean
18710
+ can_delete: boolean
18711
+ name: string | null
18712
+ display_name: string
18713
+ fan_mode_setting?: ('auto' | 'on') | undefined
18714
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
18715
+ cooling_set_point_celsius?: number | undefined
18716
+ heating_set_point_celsius?: number | undefined
18717
+ cooling_set_point_fahrenheit?: number | undefined
18718
+ heating_set_point_fahrenheit?: number | undefined
18719
+ manual_override_allowed: boolean
18720
+ }
18721
+ }
17250
18722
  }
17251
18723
  '/user_identities/add_acs_user': {
17252
18724
  route: '/user_identities/add_acs_user'
@@ -17878,42 +19350,44 @@ export interface Routes {
17878
19350
  is_heating?: boolean | undefined
17879
19351
  is_cooling?: boolean | undefined
17880
19352
  is_fan_running?: boolean | undefined
19353
+ /**
19354
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
17881
19355
  fan_mode_setting?: ('auto' | 'on') | undefined
17882
19356
  is_temporary_manual_override_active?: boolean | undefined
17883
19357
  current_climate_setting?:
17884
19358
  | {
17885
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
17886
- cooling_set_point_celsius?: number | undefined
17887
- heating_set_point_celsius?: number | undefined
17888
- cooling_set_point_fahrenheit?: number | undefined
17889
- heating_set_point_fahrenheit?: number | undefined
17890
- manual_override_allowed: boolean
19359
+ climate_preset_key?: string | undefined
19360
+ can_edit?: boolean | undefined
19361
+ can_delete?: boolean | undefined
19362
+ name?: (string | null) | undefined
19363
+ display_name?: string | undefined
19364
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
19365
+ hvac_mode_setting?:
19366
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19367
+ | undefined
19368
+ cooling_set_point_celsius?: (number | undefined) | undefined
19369
+ heating_set_point_celsius?: (number | undefined) | undefined
19370
+ cooling_set_point_fahrenheit?:
19371
+ | (number | undefined)
19372
+ | undefined
19373
+ heating_set_point_fahrenheit?:
19374
+ | (number | undefined)
19375
+ | undefined
19376
+ manual_override_allowed?: boolean | undefined
17891
19377
  }
17892
19378
  | undefined
19379
+ /**
19380
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
17893
19381
  default_climate_setting?:
17894
19382
  | {
17895
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
17896
- cooling_set_point_celsius?: number | undefined
17897
- heating_set_point_celsius?: number | undefined
17898
- cooling_set_point_fahrenheit?: number | undefined
17899
- heating_set_point_fahrenheit?: number | undefined
17900
- manual_override_allowed: boolean
17901
- }
17902
- | undefined
17903
- is_climate_setting_schedule_active?: boolean | undefined
17904
- active_climate_setting_schedule?:
17905
- | {
17906
- climate_setting_schedule_id: string
17907
- schedule_type: 'time_bound'
17908
- device_id: string
17909
- name?: string | undefined
17910
- schedule_starts_at: string
17911
- schedule_ends_at: string
17912
- created_at: string
17913
- /** 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. */
17914
- errors?: any
19383
+ climate_preset_key?: string | undefined
19384
+ can_edit?: boolean | undefined
19385
+ can_delete?: boolean | undefined
19386
+ name?: (string | null) | undefined
19387
+ display_name?: string | undefined
19388
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
17915
19389
  hvac_mode_setting?:
17916
- | ('off' | 'heat' | 'cool' | 'heat_cool')
19390
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
17917
19391
  | undefined
17918
19392
  cooling_set_point_celsius?: (number | undefined) | undefined
17919
19393
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -17926,6 +19400,39 @@ export interface Routes {
17926
19400
  manual_override_allowed?: boolean | undefined
17927
19401
  }
17928
19402
  | undefined
19403
+ available_climate_presets?:
19404
+ | Array<{
19405
+ climate_preset_key: string
19406
+ can_edit: boolean
19407
+ can_delete: boolean
19408
+ name: string | null
19409
+ display_name: string
19410
+ fan_mode_setting?: ('auto' | 'on') | undefined
19411
+ hvac_mode_setting?:
19412
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
19413
+ | undefined
19414
+ cooling_set_point_celsius?: number | undefined
19415
+ heating_set_point_celsius?: number | undefined
19416
+ cooling_set_point_fahrenheit?: number | undefined
19417
+ heating_set_point_fahrenheit?: number | undefined
19418
+ manual_override_allowed: boolean
19419
+ }>
19420
+ | undefined
19421
+ fallback_climate_preset_key?: (string | null) | undefined
19422
+ active_thermostat_schedule?:
19423
+ | ({
19424
+ thermostat_schedule_id: string
19425
+ device_id: string
19426
+ name?: string | undefined
19427
+ climate_preset_key: string
19428
+ max_override_period_minutes?: number
19429
+ starts_at: string
19430
+ ends_at: string
19431
+ created_at: string
19432
+ /** 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. */
19433
+ errors?: any
19434
+ } | null)
19435
+ | undefined
17929
19436
  min_cooling_set_point_celsius?: number | undefined
17930
19437
  min_cooling_set_point_fahrenheit?: number | undefined
17931
19438
  max_cooling_set_point_celsius?: number | undefined
@@ -18424,42 +19931,44 @@ export interface Routes {
18424
19931
  is_heating?: boolean | undefined
18425
19932
  is_cooling?: boolean | undefined
18426
19933
  is_fan_running?: boolean | undefined
19934
+ /**
19935
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
18427
19936
  fan_mode_setting?: ('auto' | 'on') | undefined
18428
19937
  is_temporary_manual_override_active?: boolean | undefined
18429
19938
  current_climate_setting?:
18430
19939
  | {
18431
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
18432
- cooling_set_point_celsius?: number | undefined
18433
- heating_set_point_celsius?: number | undefined
18434
- cooling_set_point_fahrenheit?: number | undefined
18435
- heating_set_point_fahrenheit?: number | undefined
18436
- manual_override_allowed: boolean
19940
+ climate_preset_key?: string | undefined
19941
+ can_edit?: boolean | undefined
19942
+ can_delete?: boolean | undefined
19943
+ name?: (string | null) | undefined
19944
+ display_name?: string | undefined
19945
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
19946
+ hvac_mode_setting?:
19947
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19948
+ | undefined
19949
+ cooling_set_point_celsius?: (number | undefined) | undefined
19950
+ heating_set_point_celsius?: (number | undefined) | undefined
19951
+ cooling_set_point_fahrenheit?:
19952
+ | (number | undefined)
19953
+ | undefined
19954
+ heating_set_point_fahrenheit?:
19955
+ | (number | undefined)
19956
+ | undefined
19957
+ manual_override_allowed?: boolean | undefined
18437
19958
  }
18438
19959
  | undefined
19960
+ /**
19961
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
18439
19962
  default_climate_setting?:
18440
19963
  | {
18441
- hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
18442
- cooling_set_point_celsius?: number | undefined
18443
- heating_set_point_celsius?: number | undefined
18444
- cooling_set_point_fahrenheit?: number | undefined
18445
- heating_set_point_fahrenheit?: number | undefined
18446
- manual_override_allowed: boolean
18447
- }
18448
- | undefined
18449
- is_climate_setting_schedule_active?: boolean | undefined
18450
- active_climate_setting_schedule?:
18451
- | {
18452
- climate_setting_schedule_id: string
18453
- schedule_type: 'time_bound'
18454
- device_id: string
18455
- name?: string | undefined
18456
- schedule_starts_at: string
18457
- schedule_ends_at: string
18458
- created_at: string
18459
- /** 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. */
18460
- errors?: any
19964
+ climate_preset_key?: string | undefined
19965
+ can_edit?: boolean | undefined
19966
+ can_delete?: boolean | undefined
19967
+ name?: (string | null) | undefined
19968
+ display_name?: string | undefined
19969
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
18461
19970
  hvac_mode_setting?:
18462
- | ('off' | 'heat' | 'cool' | 'heat_cool')
19971
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
18463
19972
  | undefined
18464
19973
  cooling_set_point_celsius?: (number | undefined) | undefined
18465
19974
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -18472,6 +19981,39 @@ export interface Routes {
18472
19981
  manual_override_allowed?: boolean | undefined
18473
19982
  }
18474
19983
  | undefined
19984
+ available_climate_presets?:
19985
+ | Array<{
19986
+ climate_preset_key: string
19987
+ can_edit: boolean
19988
+ can_delete: boolean
19989
+ name: string | null
19990
+ display_name: string
19991
+ fan_mode_setting?: ('auto' | 'on') | undefined
19992
+ hvac_mode_setting?:
19993
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
19994
+ | undefined
19995
+ cooling_set_point_celsius?: number | undefined
19996
+ heating_set_point_celsius?: number | undefined
19997
+ cooling_set_point_fahrenheit?: number | undefined
19998
+ heating_set_point_fahrenheit?: number | undefined
19999
+ manual_override_allowed: boolean
20000
+ }>
20001
+ | undefined
20002
+ fallback_climate_preset_key?: (string | null) | undefined
20003
+ active_thermostat_schedule?:
20004
+ | ({
20005
+ thermostat_schedule_id: string
20006
+ device_id: string
20007
+ name?: string | undefined
20008
+ climate_preset_key: string
20009
+ max_override_period_minutes?: number
20010
+ starts_at: string
20011
+ ends_at: string
20012
+ created_at: string
20013
+ /** 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. */
20014
+ errors?: any
20015
+ } | null)
20016
+ | undefined
18475
20017
  min_cooling_set_point_celsius?: number | undefined
18476
20018
  min_cooling_set_point_fahrenheit?: number | undefined
18477
20019
  max_cooling_set_point_celsius?: number | undefined
@@ -18697,22 +20239,55 @@ export interface Routes {
18697
20239
  warning_code: 'being_deleted'
18698
20240
  }
18699
20241
  | {
20242
+ /** Date and time at which Seam created the error. */
18700
20243
  created_at: string
20244
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18701
20245
  message: string
18702
- warning_code: 'failed_to_update_acs_user_on_acs_system'
20246
+ warning_code: 'failed_to_update_on_acs_system'
18703
20247
  }
18704
20248
  | {
18705
20249
  created_at: string
18706
20250
  message: string
18707
20251
  warning_code: 'salto_ks_user_not_subscribed'
18708
20252
  }
20253
+ >
20254
+ errors: Array<
20255
+ | {
20256
+ /** Date and time at which Seam created the error. */
20257
+ created_at: string
20258
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20259
+ message: string
20260
+ error_code: 'deleted_externally'
20261
+ }
20262
+ | {
20263
+ /** Date and time at which Seam created the error. */
20264
+ created_at: string
20265
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20266
+ message: string
20267
+ error_code: 'salto_ks_subscription_limit_exceeded'
20268
+ }
20269
+ | {
20270
+ /** Date and time at which Seam created the error. */
20271
+ created_at: string
20272
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20273
+ message: string
20274
+ warning_code: 'failed_to_create_on_acs_system'
20275
+ }
20276
+ | {
20277
+ /** Date and time at which Seam created the error. */
20278
+ created_at: string
20279
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20280
+ message: string
20281
+ warning_code: 'failed_to_update_on_acs_system'
20282
+ }
18709
20283
  | {
20284
+ /** Date and time at which Seam created the error. */
18710
20285
  created_at: string
20286
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18711
20287
  message: string
18712
- warning_code: 'salto_site_user_suspended'
20288
+ warning_code: 'failed_to_delete_on_acs_system'
18713
20289
  }
18714
20290
  >
18715
- errors?: any
18716
20291
  full_name?: string | undefined
18717
20292
  /**
18718
20293
  * @deprecated use email_address. */
@@ -19129,6 +20704,33 @@ export interface Routes {
19129
20704
  message: string
19130
20705
  }
19131
20706
  }
20707
+ | {
20708
+ /** The ID of the action attempt. */
20709
+ action_attempt_id: string
20710
+ status: 'pending'
20711
+ result: null
20712
+ error: null
20713
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20714
+ }
20715
+ | {
20716
+ /** The ID of the action attempt. */
20717
+ action_attempt_id: string
20718
+ status: 'success'
20719
+ error: null
20720
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20721
+ result: {}
20722
+ }
20723
+ | {
20724
+ /** The ID of the action attempt. */
20725
+ action_attempt_id: string
20726
+ status: 'error'
20727
+ result: null
20728
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20729
+ error: {
20730
+ type: string
20731
+ message: string
20732
+ }
20733
+ }
19132
20734
  | {
19133
20735
  /** The ID of the action attempt. */
19134
20736
  action_attempt_id: string