@seamapi/types 1.240.0 → 1.241.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/connect.cjs +1347 -768
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3569 -1426
  4. package/dist/devicedb.d.cts +30 -30
  5. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  6. package/lib/seam/connect/internal/schemas.js +1 -1
  7. package/lib/seam/connect/internal/schemas.js.map +1 -1
  8. package/lib/seam/connect/model-types.d.ts +1 -1
  9. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +4 -4
  10. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +1 -1
  11. package/lib/seam/connect/models/acs/acs-user.d.ts +231 -28
  12. package/lib/seam/connect/models/acs/acs-user.js +61 -13
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +78 -0
  15. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  16. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  17. package/lib/seam/connect/models/action-attempts/activate-climate-preset.d.ts +80 -0
  18. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js +25 -0
  19. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js.map +1 -0
  20. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +185 -83
  21. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +185 -83
  22. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +15 -6
  23. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +263 -119
  25. package/lib/seam/connect/models/devices/phone.d.ts +187 -85
  26. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +185 -83
  27. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +83 -0
  28. package/lib/seam/connect/models/thermostats/climate-preset.js +18 -0
  29. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -0
  30. package/lib/seam/connect/models/thermostats/climate-setting-schedule.d.ts +18 -34
  31. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js +8 -10
  32. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js.map +1 -1
  33. package/lib/seam/connect/models/thermostats/index.d.ts +1 -1
  34. package/lib/seam/connect/models/thermostats/index.js +1 -1
  35. package/lib/seam/connect/models/thermostats/index.js.map +1 -1
  36. package/lib/seam/connect/openapi.d.ts +1000 -569
  37. package/lib/seam/connect/openapi.js +1188 -681
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +1738 -460
  40. package/lib/seam/connect/schemas.d.ts +1 -1
  41. package/lib/seam/connect/schemas.js +1 -1
  42. package/lib/seam/connect/schemas.js.map +1 -1
  43. package/lib/seam/devicedb/models/device-model.d.ts +8 -8
  44. package/lib/seam/devicedb/models/manufacturer.d.ts +2 -2
  45. package/lib/seam/devicedb/route-specs.d.ts +20 -20
  46. package/package.json +2 -2
  47. package/src/lib/seam/connect/internal/schemas.ts +2 -2
  48. package/src/lib/seam/connect/model-types.ts +1 -1
  49. package/src/lib/seam/connect/models/acs/acs-user.ts +86 -19
  50. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  51. package/src/lib/seam/connect/models/action-attempts/activate-climate-preset.ts +36 -0
  52. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +16 -6
  53. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +24 -0
  54. package/src/lib/seam/connect/models/thermostats/climate-setting-schedule.ts +16 -19
  55. package/src/lib/seam/connect/models/thermostats/index.ts +1 -1
  56. package/src/lib/seam/connect/openapi.ts +1216 -670
  57. package/src/lib/seam/connect/route-types.ts +2030 -505
  58. package/src/lib/seam/connect/schemas.ts +1 -1
  59. package/lib/seam/connect/models/thermostats/climate-setting.d.ts +0 -24
  60. package/lib/seam/connect/models/thermostats/climate-setting.js +0 -11
  61. package/lib/seam/connect/models/thermostats/climate-setting.js.map +0 -1
  62. package/src/lib/seam/connect/models/thermostats/climate-setting.ts +0 -14
@@ -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
@@ -2499,7 +2607,7 @@ export interface Routes {
2499
2607
  | {
2500
2608
  created_at: string
2501
2609
  message: string
2502
- warning_code: 'failed_to_update_acs_user_on_acs_system'
2610
+ warning_code: 'failed_to_update_on_acs_system'
2503
2611
  }
2504
2612
  | {
2505
2613
  created_at: string
@@ -2512,7 +2620,29 @@ export interface Routes {
2512
2620
  warning_code: 'salto_site_user_suspended'
2513
2621
  }
2514
2622
  >
2515
- errors?: any
2623
+ errors: Array<
2624
+ | {
2625
+ /** Date and time at which Seam created the error. */
2626
+ created_at: string
2627
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2628
+ message: string
2629
+ error_code: 'user_deleted_externally'
2630
+ }
2631
+ | {
2632
+ /** Date and time at which Seam created the error. */
2633
+ created_at: string
2634
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2635
+ message: string
2636
+ error_code: 'salto_ks_subscription_limit_exceeded'
2637
+ }
2638
+ | {
2639
+ /** Date and time at which Seam created the error. */
2640
+ created_at: string
2641
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2642
+ message: string
2643
+ error_code: 'salto_site_user_limit_reached'
2644
+ }
2645
+ >
2516
2646
  full_name?: string | undefined
2517
2647
  /**
2518
2648
  * @deprecated use email_address. */
@@ -3839,7 +3969,7 @@ export interface Routes {
3839
3969
  | {
3840
3970
  created_at: string
3841
3971
  message: string
3842
- warning_code: 'failed_to_update_acs_user_on_acs_system'
3972
+ warning_code: 'failed_to_update_on_acs_system'
3843
3973
  }
3844
3974
  | {
3845
3975
  created_at: string
@@ -3852,7 +3982,29 @@ export interface Routes {
3852
3982
  warning_code: 'salto_site_user_suspended'
3853
3983
  }
3854
3984
  >
3855
- errors?: any
3985
+ errors: Array<
3986
+ | {
3987
+ /** Date and time at which Seam created the error. */
3988
+ created_at: string
3989
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3990
+ message: string
3991
+ error_code: 'user_deleted_externally'
3992
+ }
3993
+ | {
3994
+ /** Date and time at which Seam created the error. */
3995
+ created_at: string
3996
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3997
+ message: string
3998
+ error_code: 'salto_ks_subscription_limit_exceeded'
3999
+ }
4000
+ | {
4001
+ /** Date and time at which Seam created the error. */
4002
+ created_at: string
4003
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4004
+ message: string
4005
+ error_code: 'salto_site_user_limit_reached'
4006
+ }
4007
+ >
3856
4008
  full_name?: string | undefined
3857
4009
  /**
3858
4010
  * @deprecated use email_address. */
@@ -3923,7 +4075,7 @@ export interface Routes {
3923
4075
  | {
3924
4076
  created_at: string
3925
4077
  message: string
3926
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4078
+ warning_code: 'failed_to_update_on_acs_system'
3927
4079
  }
3928
4080
  | {
3929
4081
  created_at: string
@@ -3936,7 +4088,29 @@ export interface Routes {
3936
4088
  warning_code: 'salto_site_user_suspended'
3937
4089
  }
3938
4090
  >
3939
- errors?: any
4091
+ errors: Array<
4092
+ | {
4093
+ /** Date and time at which Seam created the error. */
4094
+ created_at: string
4095
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4096
+ message: string
4097
+ error_code: 'user_deleted_externally'
4098
+ }
4099
+ | {
4100
+ /** Date and time at which Seam created the error. */
4101
+ created_at: string
4102
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4103
+ message: string
4104
+ error_code: 'salto_ks_subscription_limit_exceeded'
4105
+ }
4106
+ | {
4107
+ /** Date and time at which Seam created the error. */
4108
+ created_at: string
4109
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4110
+ message: string
4111
+ error_code: 'salto_site_user_limit_reached'
4112
+ }
4113
+ >
3940
4114
  full_name?: string | undefined
3941
4115
  /**
3942
4116
  * @deprecated use email_address. */
@@ -4001,7 +4175,7 @@ export interface Routes {
4001
4175
  | {
4002
4176
  created_at: string
4003
4177
  message: string
4004
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4178
+ warning_code: 'failed_to_update_on_acs_system'
4005
4179
  }
4006
4180
  | {
4007
4181
  created_at: string
@@ -4014,7 +4188,29 @@ export interface Routes {
4014
4188
  warning_code: 'salto_site_user_suspended'
4015
4189
  }
4016
4190
  >
4017
- errors?: any
4191
+ errors: Array<
4192
+ | {
4193
+ /** Date and time at which Seam created the error. */
4194
+ created_at: string
4195
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4196
+ message: string
4197
+ error_code: 'user_deleted_externally'
4198
+ }
4199
+ | {
4200
+ /** Date and time at which Seam created the error. */
4201
+ created_at: string
4202
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4203
+ message: string
4204
+ error_code: 'salto_ks_subscription_limit_exceeded'
4205
+ }
4206
+ | {
4207
+ /** Date and time at which Seam created the error. */
4208
+ created_at: string
4209
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4210
+ message: string
4211
+ error_code: 'salto_site_user_limit_reached'
4212
+ }
4213
+ >
4018
4214
  full_name?: string | undefined
4019
4215
  /**
4020
4216
  * @deprecated use email_address. */
@@ -4155,7 +4351,7 @@ export interface Routes {
4155
4351
  | {
4156
4352
  created_at: string
4157
4353
  message: string
4158
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4354
+ warning_code: 'failed_to_update_on_acs_system'
4159
4355
  }
4160
4356
  | {
4161
4357
  created_at: string
@@ -4168,7 +4364,29 @@ export interface Routes {
4168
4364
  warning_code: 'salto_site_user_suspended'
4169
4365
  }
4170
4366
  >
4171
- errors?: any
4367
+ errors: Array<
4368
+ | {
4369
+ /** Date and time at which Seam created the error. */
4370
+ created_at: string
4371
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4372
+ message: string
4373
+ error_code: 'user_deleted_externally'
4374
+ }
4375
+ | {
4376
+ /** Date and time at which Seam created the error. */
4377
+ created_at: string
4378
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4379
+ message: string
4380
+ error_code: 'salto_ks_subscription_limit_exceeded'
4381
+ }
4382
+ | {
4383
+ /** Date and time at which Seam created the error. */
4384
+ created_at: string
4385
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4386
+ message: string
4387
+ error_code: 'salto_site_user_limit_reached'
4388
+ }
4389
+ >
4172
4390
  full_name?: string | undefined
4173
4391
  /**
4174
4392
  * @deprecated use email_address. */
@@ -4232,7 +4450,7 @@ export interface Routes {
4232
4450
  | {
4233
4451
  created_at: string
4234
4452
  message: string
4235
- warning_code: 'failed_to_update_acs_user_on_acs_system'
4453
+ warning_code: 'failed_to_update_on_acs_system'
4236
4454
  }
4237
4455
  | {
4238
4456
  created_at: string
@@ -4245,7 +4463,29 @@ export interface Routes {
4245
4463
  warning_code: 'salto_site_user_suspended'
4246
4464
  }
4247
4465
  >
4248
- errors?: any
4466
+ errors: Array<
4467
+ | {
4468
+ /** Date and time at which Seam created the error. */
4469
+ created_at: string
4470
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4471
+ message: string
4472
+ error_code: 'user_deleted_externally'
4473
+ }
4474
+ | {
4475
+ /** Date and time at which Seam created the error. */
4476
+ created_at: string
4477
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4478
+ message: string
4479
+ error_code: 'salto_ks_subscription_limit_exceeded'
4480
+ }
4481
+ | {
4482
+ /** Date and time at which Seam created the error. */
4483
+ created_at: string
4484
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4485
+ message: string
4486
+ error_code: 'salto_site_user_limit_reached'
4487
+ }
4488
+ >
4249
4489
  full_name?: string | undefined
4250
4490
  /**
4251
4491
  * @deprecated use email_address. */
@@ -4518,6 +4758,33 @@ export interface Routes {
4518
4758
  message: string
4519
4759
  }
4520
4760
  }
4761
+ | {
4762
+ /** The ID of the action attempt. */
4763
+ action_attempt_id: string
4764
+ status: 'pending'
4765
+ result: null
4766
+ error: null
4767
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4768
+ }
4769
+ | {
4770
+ /** The ID of the action attempt. */
4771
+ action_attempt_id: string
4772
+ status: 'success'
4773
+ error: null
4774
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4775
+ result: {}
4776
+ }
4777
+ | {
4778
+ /** The ID of the action attempt. */
4779
+ action_attempt_id: string
4780
+ status: 'error'
4781
+ result: null
4782
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4783
+ error: {
4784
+ type: string
4785
+ message: string
4786
+ }
4787
+ }
4521
4788
  | {
4522
4789
  /** The ID of the action attempt. */
4523
4790
  action_attempt_id: string
@@ -4942,15 +5209,42 @@ export interface Routes {
4942
5209
  status: 'pending'
4943
5210
  result: null
4944
5211
  error: null
4945
- action_type: 'SYNC_ACCESS_CODES'
5212
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
4946
5213
  }
4947
5214
  | {
4948
5215
  /** The ID of the action attempt. */
4949
5216
  action_attempt_id: string
4950
5217
  status: 'success'
4951
5218
  error: null
4952
- action_type: 'SYNC_ACCESS_CODES'
4953
- result?: any
5219
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
5220
+ result: {}
5221
+ }
5222
+ | {
5223
+ /** The ID of the action attempt. */
5224
+ action_attempt_id: string
5225
+ status: 'error'
5226
+ result: null
5227
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
5228
+ error: {
5229
+ type: string
5230
+ message: string
5231
+ }
5232
+ }
5233
+ | {
5234
+ /** The ID of the action attempt. */
5235
+ action_attempt_id: string
5236
+ status: 'pending'
5237
+ result: null
5238
+ error: null
5239
+ action_type: 'SYNC_ACCESS_CODES'
5240
+ }
5241
+ | {
5242
+ /** The ID of the action attempt. */
5243
+ action_attempt_id: string
5244
+ status: 'success'
5245
+ error: null
5246
+ action_type: 'SYNC_ACCESS_CODES'
5247
+ result?: any
4954
5248
  }
4955
5249
  | {
4956
5250
  /** The ID of the action attempt. */
@@ -6064,42 +6358,44 @@ export interface Routes {
6064
6358
  is_heating?: boolean | undefined
6065
6359
  is_cooling?: boolean | undefined
6066
6360
  is_fan_running?: boolean | undefined
6361
+ /**
6362
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6067
6363
  fan_mode_setting?: ('auto' | 'on') | undefined
6068
6364
  is_temporary_manual_override_active?: boolean | undefined
6069
6365
  current_climate_setting?:
6070
6366
  | {
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
6367
+ climate_preset_key?: string | undefined
6368
+ can_edit?: boolean | undefined
6369
+ can_delete?: boolean | undefined
6370
+ name?: (string | null) | undefined
6371
+ display_name?: string | undefined
6372
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6373
+ hvac_mode_setting?:
6374
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6375
+ | undefined
6376
+ cooling_set_point_celsius?: (number | undefined) | undefined
6377
+ heating_set_point_celsius?: (number | undefined) | undefined
6378
+ cooling_set_point_fahrenheit?:
6379
+ | (number | undefined)
6380
+ | undefined
6381
+ heating_set_point_fahrenheit?:
6382
+ | (number | undefined)
6383
+ | undefined
6384
+ manual_override_allowed?: boolean | undefined
6077
6385
  }
6078
6386
  | undefined
6387
+ /**
6388
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6079
6389
  default_climate_setting?:
6080
6390
  | {
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
6391
+ climate_preset_key?: string | undefined
6392
+ can_edit?: boolean | undefined
6393
+ can_delete?: boolean | undefined
6394
+ name?: (string | null) | undefined
6395
+ display_name?: string | undefined
6396
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6101
6397
  hvac_mode_setting?:
6102
- | ('off' | 'heat' | 'cool' | 'heat_cool')
6398
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6103
6399
  | undefined
6104
6400
  cooling_set_point_celsius?: (number | undefined) | undefined
6105
6401
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -6112,6 +6408,39 @@ export interface Routes {
6112
6408
  manual_override_allowed?: boolean | undefined
6113
6409
  }
6114
6410
  | undefined
6411
+ available_climate_presets?:
6412
+ | Array<{
6413
+ climate_preset_key: string
6414
+ can_edit: boolean
6415
+ can_delete: boolean
6416
+ name: string | null
6417
+ display_name: string
6418
+ fan_mode_setting?: ('auto' | 'on') | undefined
6419
+ hvac_mode_setting?:
6420
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
6421
+ | undefined
6422
+ cooling_set_point_celsius?: number | undefined
6423
+ heating_set_point_celsius?: number | undefined
6424
+ cooling_set_point_fahrenheit?: number | undefined
6425
+ heating_set_point_fahrenheit?: number | undefined
6426
+ manual_override_allowed: boolean
6427
+ }>
6428
+ | undefined
6429
+ fallback_climate_preset_key?: (string | null) | undefined
6430
+ active_thermostat_schedule?:
6431
+ | ({
6432
+ thermostat_schedule_id: string
6433
+ device_id: string
6434
+ name?: string | undefined
6435
+ climate_preset_key: string
6436
+ max_override_period_minutes?: number
6437
+ starts_at: string
6438
+ ends_at: string
6439
+ created_at: string
6440
+ /** 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. */
6441
+ errors?: any
6442
+ } | null)
6443
+ | undefined
6115
6444
  min_cooling_set_point_celsius?: number | undefined
6116
6445
  min_cooling_set_point_fahrenheit?: number | undefined
6117
6446
  max_cooling_set_point_celsius?: number | undefined
@@ -6774,42 +7103,44 @@ export interface Routes {
6774
7103
  is_heating?: boolean | undefined
6775
7104
  is_cooling?: boolean | undefined
6776
7105
  is_fan_running?: boolean | undefined
7106
+ /**
7107
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
6777
7108
  fan_mode_setting?: ('auto' | 'on') | undefined
6778
7109
  is_temporary_manual_override_active?: boolean | undefined
6779
7110
  current_climate_setting?:
6780
7111
  | {
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
7112
+ climate_preset_key?: string | undefined
7113
+ can_edit?: boolean | undefined
7114
+ can_delete?: boolean | undefined
7115
+ name?: (string | null) | undefined
7116
+ display_name?: string | undefined
7117
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
7118
+ hvac_mode_setting?:
7119
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
7120
+ | undefined
7121
+ cooling_set_point_celsius?: (number | undefined) | undefined
7122
+ heating_set_point_celsius?: (number | undefined) | undefined
7123
+ cooling_set_point_fahrenheit?:
7124
+ | (number | undefined)
7125
+ | undefined
7126
+ heating_set_point_fahrenheit?:
7127
+ | (number | undefined)
7128
+ | undefined
7129
+ manual_override_allowed?: boolean | undefined
6787
7130
  }
6788
7131
  | undefined
7132
+ /**
7133
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6789
7134
  default_climate_setting?:
6790
7135
  | {
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
7136
+ climate_preset_key?: string | undefined
7137
+ can_edit?: boolean | undefined
7138
+ can_delete?: boolean | undefined
7139
+ name?: (string | null) | undefined
7140
+ display_name?: string | undefined
7141
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
6811
7142
  hvac_mode_setting?:
6812
- | ('off' | 'heat' | 'cool' | 'heat_cool')
7143
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6813
7144
  | undefined
6814
7145
  cooling_set_point_celsius?: (number | undefined) | undefined
6815
7146
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -6822,6 +7153,39 @@ export interface Routes {
6822
7153
  manual_override_allowed?: boolean | undefined
6823
7154
  }
6824
7155
  | undefined
7156
+ available_climate_presets?:
7157
+ | Array<{
7158
+ climate_preset_key: string
7159
+ can_edit: boolean
7160
+ can_delete: boolean
7161
+ name: string | null
7162
+ display_name: string
7163
+ fan_mode_setting?: ('auto' | 'on') | undefined
7164
+ hvac_mode_setting?:
7165
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
7166
+ | undefined
7167
+ cooling_set_point_celsius?: number | undefined
7168
+ heating_set_point_celsius?: number | undefined
7169
+ cooling_set_point_fahrenheit?: number | undefined
7170
+ heating_set_point_fahrenheit?: number | undefined
7171
+ manual_override_allowed: boolean
7172
+ }>
7173
+ | undefined
7174
+ fallback_climate_preset_key?: (string | null) | undefined
7175
+ active_thermostat_schedule?:
7176
+ | ({
7177
+ thermostat_schedule_id: string
7178
+ device_id: string
7179
+ name?: string | undefined
7180
+ climate_preset_key: string
7181
+ max_override_period_minutes?: number
7182
+ starts_at: string
7183
+ ends_at: string
7184
+ created_at: string
7185
+ /** 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. */
7186
+ errors?: any
7187
+ } | null)
7188
+ | undefined
6825
7189
  min_cooling_set_point_celsius?: number | undefined
6826
7190
  min_cooling_set_point_fahrenheit?: number | undefined
6827
7191
  max_cooling_set_point_celsius?: number | undefined
@@ -8150,42 +8514,44 @@ export interface Routes {
8150
8514
  is_heating?: boolean | undefined
8151
8515
  is_cooling?: boolean | undefined
8152
8516
  is_fan_running?: boolean | undefined
8517
+ /**
8518
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8153
8519
  fan_mode_setting?: ('auto' | 'on') | undefined
8154
8520
  is_temporary_manual_override_active?: boolean | undefined
8155
8521
  current_climate_setting?:
8156
8522
  | {
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
8523
+ climate_preset_key?: string | undefined
8524
+ can_edit?: boolean | undefined
8525
+ can_delete?: boolean | undefined
8526
+ name?: (string | null) | undefined
8527
+ display_name?: string | undefined
8528
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8529
+ hvac_mode_setting?:
8530
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8531
+ | undefined
8532
+ cooling_set_point_celsius?: (number | undefined) | undefined
8533
+ heating_set_point_celsius?: (number | undefined) | undefined
8534
+ cooling_set_point_fahrenheit?:
8535
+ | (number | undefined)
8536
+ | undefined
8537
+ heating_set_point_fahrenheit?:
8538
+ | (number | undefined)
8539
+ | undefined
8540
+ manual_override_allowed?: boolean | undefined
8163
8541
  }
8164
8542
  | undefined
8543
+ /**
8544
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8165
8545
  default_climate_setting?:
8166
8546
  | {
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
8547
+ climate_preset_key?: string | undefined
8548
+ can_edit?: boolean | undefined
8549
+ can_delete?: boolean | undefined
8550
+ name?: (string | null) | undefined
8551
+ display_name?: string | undefined
8552
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8187
8553
  hvac_mode_setting?:
8188
- | ('off' | 'heat' | 'cool' | 'heat_cool')
8554
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8189
8555
  | undefined
8190
8556
  cooling_set_point_celsius?: (number | undefined) | undefined
8191
8557
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -8198,6 +8564,39 @@ export interface Routes {
8198
8564
  manual_override_allowed?: boolean | undefined
8199
8565
  }
8200
8566
  | undefined
8567
+ available_climate_presets?:
8568
+ | Array<{
8569
+ climate_preset_key: string
8570
+ can_edit: boolean
8571
+ can_delete: boolean
8572
+ name: string | null
8573
+ display_name: string
8574
+ fan_mode_setting?: ('auto' | 'on') | undefined
8575
+ hvac_mode_setting?:
8576
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
8577
+ | undefined
8578
+ cooling_set_point_celsius?: number | undefined
8579
+ heating_set_point_celsius?: number | undefined
8580
+ cooling_set_point_fahrenheit?: number | undefined
8581
+ heating_set_point_fahrenheit?: number | undefined
8582
+ manual_override_allowed: boolean
8583
+ }>
8584
+ | undefined
8585
+ fallback_climate_preset_key?: (string | null) | undefined
8586
+ active_thermostat_schedule?:
8587
+ | ({
8588
+ thermostat_schedule_id: string
8589
+ device_id: string
8590
+ name?: string | undefined
8591
+ climate_preset_key: string
8592
+ max_override_period_minutes?: number
8593
+ starts_at: string
8594
+ ends_at: string
8595
+ created_at: string
8596
+ /** 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. */
8597
+ errors?: any
8598
+ } | null)
8599
+ | undefined
8201
8600
  min_cooling_set_point_celsius?: number | undefined
8202
8601
  min_cooling_set_point_fahrenheit?: number | undefined
8203
8602
  max_cooling_set_point_celsius?: number | undefined
@@ -8694,42 +9093,44 @@ export interface Routes {
8694
9093
  is_heating?: boolean | undefined
8695
9094
  is_cooling?: boolean | undefined
8696
9095
  is_fan_running?: boolean | undefined
9096
+ /**
9097
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
8697
9098
  fan_mode_setting?: ('auto' | 'on') | undefined
8698
9099
  is_temporary_manual_override_active?: boolean | undefined
8699
9100
  current_climate_setting?:
8700
9101
  | {
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
9102
+ climate_preset_key?: string | undefined
9103
+ can_edit?: boolean | undefined
9104
+ can_delete?: boolean | undefined
9105
+ name?: (string | null) | undefined
9106
+ display_name?: string | undefined
9107
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9108
+ hvac_mode_setting?:
9109
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9110
+ | undefined
9111
+ cooling_set_point_celsius?: (number | undefined) | undefined
9112
+ heating_set_point_celsius?: (number | undefined) | undefined
9113
+ cooling_set_point_fahrenheit?:
9114
+ | (number | undefined)
9115
+ | undefined
9116
+ heating_set_point_fahrenheit?:
9117
+ | (number | undefined)
9118
+ | undefined
9119
+ manual_override_allowed?: boolean | undefined
8707
9120
  }
8708
9121
  | undefined
9122
+ /**
9123
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
8709
9124
  default_climate_setting?:
8710
9125
  | {
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
9126
+ climate_preset_key?: string | undefined
9127
+ can_edit?: boolean | undefined
9128
+ can_delete?: boolean | undefined
9129
+ name?: (string | null) | undefined
9130
+ display_name?: string | undefined
9131
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
8731
9132
  hvac_mode_setting?:
8732
- | ('off' | 'heat' | 'cool' | 'heat_cool')
9133
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
8733
9134
  | undefined
8734
9135
  cooling_set_point_celsius?: (number | undefined) | undefined
8735
9136
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -8742,6 +9143,39 @@ export interface Routes {
8742
9143
  manual_override_allowed?: boolean | undefined
8743
9144
  }
8744
9145
  | undefined
9146
+ available_climate_presets?:
9147
+ | Array<{
9148
+ climate_preset_key: string
9149
+ can_edit: boolean
9150
+ can_delete: boolean
9151
+ name: string | null
9152
+ display_name: string
9153
+ fan_mode_setting?: ('auto' | 'on') | undefined
9154
+ hvac_mode_setting?:
9155
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
9156
+ | undefined
9157
+ cooling_set_point_celsius?: number | undefined
9158
+ heating_set_point_celsius?: number | undefined
9159
+ cooling_set_point_fahrenheit?: number | undefined
9160
+ heating_set_point_fahrenheit?: number | undefined
9161
+ manual_override_allowed: boolean
9162
+ }>
9163
+ | undefined
9164
+ fallback_climate_preset_key?: (string | null) | undefined
9165
+ active_thermostat_schedule?:
9166
+ | ({
9167
+ thermostat_schedule_id: string
9168
+ device_id: string
9169
+ name?: string | undefined
9170
+ climate_preset_key: string
9171
+ max_override_period_minutes?: number
9172
+ starts_at: string
9173
+ ends_at: string
9174
+ created_at: string
9175
+ /** 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. */
9176
+ errors?: any
9177
+ } | null)
9178
+ | undefined
8745
9179
  min_cooling_set_point_celsius?: number | undefined
8746
9180
  min_cooling_set_point_fahrenheit?: number | undefined
8747
9181
  max_cooling_set_point_celsius?: number | undefined
@@ -9404,42 +9838,44 @@ export interface Routes {
9404
9838
  is_heating?: boolean | undefined
9405
9839
  is_cooling?: boolean | undefined
9406
9840
  is_fan_running?: boolean | undefined
9841
+ /**
9842
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9407
9843
  fan_mode_setting?: ('auto' | 'on') | undefined
9408
9844
  is_temporary_manual_override_active?: boolean | undefined
9409
9845
  current_climate_setting?:
9410
9846
  | {
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
9847
+ climate_preset_key?: string | undefined
9848
+ can_edit?: boolean | undefined
9849
+ can_delete?: boolean | undefined
9850
+ name?: (string | null) | undefined
9851
+ display_name?: string | undefined
9852
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9853
+ hvac_mode_setting?:
9854
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9855
+ | undefined
9856
+ cooling_set_point_celsius?: (number | undefined) | undefined
9857
+ heating_set_point_celsius?: (number | undefined) | undefined
9858
+ cooling_set_point_fahrenheit?:
9859
+ | (number | undefined)
9860
+ | undefined
9861
+ heating_set_point_fahrenheit?:
9862
+ | (number | undefined)
9863
+ | undefined
9864
+ manual_override_allowed?: boolean | undefined
9417
9865
  }
9418
9866
  | undefined
9867
+ /**
9868
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9419
9869
  default_climate_setting?:
9420
9870
  | {
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
9871
+ climate_preset_key?: string | undefined
9872
+ can_edit?: boolean | undefined
9873
+ can_delete?: boolean | undefined
9874
+ name?: (string | null) | undefined
9875
+ display_name?: string | undefined
9876
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9441
9877
  hvac_mode_setting?:
9442
- | ('off' | 'heat' | 'cool' | 'heat_cool')
9878
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9443
9879
  | undefined
9444
9880
  cooling_set_point_celsius?: (number | undefined) | undefined
9445
9881
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -9452,6 +9888,39 @@ export interface Routes {
9452
9888
  manual_override_allowed?: boolean | undefined
9453
9889
  }
9454
9890
  | undefined
9891
+ available_climate_presets?:
9892
+ | Array<{
9893
+ climate_preset_key: string
9894
+ can_edit: boolean
9895
+ can_delete: boolean
9896
+ name: string | null
9897
+ display_name: string
9898
+ fan_mode_setting?: ('auto' | 'on') | undefined
9899
+ hvac_mode_setting?:
9900
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
9901
+ | undefined
9902
+ cooling_set_point_celsius?: number | undefined
9903
+ heating_set_point_celsius?: number | undefined
9904
+ cooling_set_point_fahrenheit?: number | undefined
9905
+ heating_set_point_fahrenheit?: number | undefined
9906
+ manual_override_allowed: boolean
9907
+ }>
9908
+ | undefined
9909
+ fallback_climate_preset_key?: (string | null) | undefined
9910
+ active_thermostat_schedule?:
9911
+ | ({
9912
+ thermostat_schedule_id: string
9913
+ device_id: string
9914
+ name?: string | undefined
9915
+ climate_preset_key: string
9916
+ max_override_period_minutes?: number
9917
+ starts_at: string
9918
+ ends_at: string
9919
+ created_at: string
9920
+ /** 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. */
9921
+ errors?: any
9922
+ } | null)
9923
+ | undefined
9455
9924
  min_cooling_set_point_celsius?: number | undefined
9456
9925
  min_cooling_set_point_fahrenheit?: number | undefined
9457
9926
  max_cooling_set_point_celsius?: number | undefined
@@ -9948,42 +10417,44 @@ export interface Routes {
9948
10417
  is_heating?: boolean | undefined
9949
10418
  is_cooling?: boolean | undefined
9950
10419
  is_fan_running?: boolean | undefined
10420
+ /**
10421
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
9951
10422
  fan_mode_setting?: ('auto' | 'on') | undefined
9952
10423
  is_temporary_manual_override_active?: boolean | undefined
9953
10424
  current_climate_setting?:
9954
10425
  | {
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
10426
+ climate_preset_key?: string | undefined
10427
+ can_edit?: boolean | undefined
10428
+ can_delete?: boolean | undefined
10429
+ name?: (string | null) | undefined
10430
+ display_name?: string | undefined
10431
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
10432
+ hvac_mode_setting?:
10433
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
10434
+ | undefined
10435
+ cooling_set_point_celsius?: (number | undefined) | undefined
10436
+ heating_set_point_celsius?: (number | undefined) | undefined
10437
+ cooling_set_point_fahrenheit?:
10438
+ | (number | undefined)
10439
+ | undefined
10440
+ heating_set_point_fahrenheit?:
10441
+ | (number | undefined)
10442
+ | undefined
10443
+ manual_override_allowed?: boolean | undefined
9961
10444
  }
9962
10445
  | undefined
10446
+ /**
10447
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
9963
10448
  default_climate_setting?:
9964
10449
  | {
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
10450
+ climate_preset_key?: string | undefined
10451
+ can_edit?: boolean | undefined
10452
+ can_delete?: boolean | undefined
10453
+ name?: (string | null) | undefined
10454
+ display_name?: string | undefined
10455
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
9985
10456
  hvac_mode_setting?:
9986
- | ('off' | 'heat' | 'cool' | 'heat_cool')
10457
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
9987
10458
  | undefined
9988
10459
  cooling_set_point_celsius?: (number | undefined) | undefined
9989
10460
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -9996,6 +10467,39 @@ export interface Routes {
9996
10467
  manual_override_allowed?: boolean | undefined
9997
10468
  }
9998
10469
  | undefined
10470
+ available_climate_presets?:
10471
+ | Array<{
10472
+ climate_preset_key: string
10473
+ can_edit: boolean
10474
+ can_delete: boolean
10475
+ name: string | null
10476
+ display_name: string
10477
+ fan_mode_setting?: ('auto' | 'on') | undefined
10478
+ hvac_mode_setting?:
10479
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
10480
+ | undefined
10481
+ cooling_set_point_celsius?: number | undefined
10482
+ heating_set_point_celsius?: number | undefined
10483
+ cooling_set_point_fahrenheit?: number | undefined
10484
+ heating_set_point_fahrenheit?: number | undefined
10485
+ manual_override_allowed: boolean
10486
+ }>
10487
+ | undefined
10488
+ fallback_climate_preset_key?: (string | null) | undefined
10489
+ active_thermostat_schedule?:
10490
+ | ({
10491
+ thermostat_schedule_id: string
10492
+ device_id: string
10493
+ name?: string | undefined
10494
+ climate_preset_key: string
10495
+ max_override_period_minutes?: number
10496
+ starts_at: string
10497
+ ends_at: string
10498
+ created_at: string
10499
+ /** 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. */
10500
+ errors?: any
10501
+ } | null)
10502
+ | undefined
9999
10503
  min_cooling_set_point_celsius?: number | undefined
10000
10504
  min_cooling_set_point_fahrenheit?: number | undefined
10001
10505
  max_cooling_set_point_celsius?: number | undefined
@@ -10283,6 +10787,33 @@ export interface Routes {
10283
10787
  message: string
10284
10788
  }
10285
10789
  }
10790
+ | {
10791
+ /** The ID of the action attempt. */
10792
+ action_attempt_id: string
10793
+ status: 'pending'
10794
+ result: null
10795
+ error: null
10796
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10797
+ }
10798
+ | {
10799
+ /** The ID of the action attempt. */
10800
+ action_attempt_id: string
10801
+ status: 'success'
10802
+ error: null
10803
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10804
+ result: {}
10805
+ }
10806
+ | {
10807
+ /** The ID of the action attempt. */
10808
+ action_attempt_id: string
10809
+ status: 'error'
10810
+ result: null
10811
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
10812
+ error: {
10813
+ type: string
10814
+ message: string
10815
+ }
10816
+ }
10286
10817
  | {
10287
10818
  /** The ID of the action attempt. */
10288
10819
  action_attempt_id: string
@@ -10702,6 +11233,33 @@ export interface Routes {
10702
11233
  message: string
10703
11234
  }
10704
11235
  }
11236
+ | {
11237
+ /** The ID of the action attempt. */
11238
+ action_attempt_id: string
11239
+ status: 'pending'
11240
+ result: null
11241
+ error: null
11242
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11243
+ }
11244
+ | {
11245
+ /** The ID of the action attempt. */
11246
+ action_attempt_id: string
11247
+ status: 'success'
11248
+ error: null
11249
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11250
+ result: {}
11251
+ }
11252
+ | {
11253
+ /** The ID of the action attempt. */
11254
+ action_attempt_id: string
11255
+ status: 'error'
11256
+ result: null
11257
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
11258
+ error: {
11259
+ type: string
11260
+ message: string
11261
+ }
11262
+ }
10705
11263
  | {
10706
11264
  /** The ID of the action attempt. */
10707
11265
  action_attempt_id: string
@@ -11530,42 +12088,44 @@ export interface Routes {
11530
12088
  is_heating?: boolean | undefined
11531
12089
  is_cooling?: boolean | undefined
11532
12090
  is_fan_running?: boolean | undefined
12091
+ /**
12092
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
11533
12093
  fan_mode_setting?: ('auto' | 'on') | undefined
11534
12094
  is_temporary_manual_override_active?: boolean | undefined
11535
12095
  current_climate_setting?:
11536
12096
  | {
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
12097
+ climate_preset_key?: string | undefined
12098
+ can_edit?: boolean | undefined
12099
+ can_delete?: boolean | undefined
12100
+ name?: (string | null) | undefined
12101
+ display_name?: string | undefined
12102
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12103
+ hvac_mode_setting?:
12104
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12105
+ | undefined
12106
+ cooling_set_point_celsius?: (number | undefined) | undefined
12107
+ heating_set_point_celsius?: (number | undefined) | undefined
12108
+ cooling_set_point_fahrenheit?:
12109
+ | (number | undefined)
12110
+ | undefined
12111
+ heating_set_point_fahrenheit?:
12112
+ | (number | undefined)
12113
+ | undefined
12114
+ manual_override_allowed?: boolean | undefined
11543
12115
  }
11544
12116
  | undefined
12117
+ /**
12118
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11545
12119
  default_climate_setting?:
11546
12120
  | {
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
12121
+ climate_preset_key?: string | undefined
12122
+ can_edit?: boolean | undefined
12123
+ can_delete?: boolean | undefined
12124
+ name?: (string | null) | undefined
12125
+ display_name?: string | undefined
12126
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
11567
12127
  hvac_mode_setting?:
11568
- | ('off' | 'heat' | 'cool' | 'heat_cool')
12128
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
11569
12129
  | undefined
11570
12130
  cooling_set_point_celsius?: (number | undefined) | undefined
11571
12131
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -11578,6 +12138,39 @@ export interface Routes {
11578
12138
  manual_override_allowed?: boolean | undefined
11579
12139
  }
11580
12140
  | undefined
12141
+ available_climate_presets?:
12142
+ | Array<{
12143
+ climate_preset_key: string
12144
+ can_edit: boolean
12145
+ can_delete: boolean
12146
+ name: string | null
12147
+ display_name: string
12148
+ fan_mode_setting?: ('auto' | 'on') | undefined
12149
+ hvac_mode_setting?:
12150
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12151
+ | undefined
12152
+ cooling_set_point_celsius?: number | undefined
12153
+ heating_set_point_celsius?: number | undefined
12154
+ cooling_set_point_fahrenheit?: number | undefined
12155
+ heating_set_point_fahrenheit?: number | undefined
12156
+ manual_override_allowed: boolean
12157
+ }>
12158
+ | undefined
12159
+ fallback_climate_preset_key?: (string | null) | undefined
12160
+ active_thermostat_schedule?:
12161
+ | ({
12162
+ thermostat_schedule_id: string
12163
+ device_id: string
12164
+ name?: string | undefined
12165
+ climate_preset_key: string
12166
+ max_override_period_minutes?: number
12167
+ starts_at: string
12168
+ ends_at: string
12169
+ created_at: string
12170
+ /** 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. */
12171
+ errors?: any
12172
+ } | null)
12173
+ | undefined
11581
12174
  min_cooling_set_point_celsius?: number | undefined
11582
12175
  min_cooling_set_point_fahrenheit?: number | undefined
11583
12176
  max_cooling_set_point_celsius?: number | undefined
@@ -12074,42 +12667,44 @@ export interface Routes {
12074
12667
  is_heating?: boolean | undefined
12075
12668
  is_cooling?: boolean | undefined
12076
12669
  is_fan_running?: boolean | undefined
12670
+ /**
12671
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
12077
12672
  fan_mode_setting?: ('auto' | 'on') | undefined
12078
12673
  is_temporary_manual_override_active?: boolean | undefined
12079
12674
  current_climate_setting?:
12080
12675
  | {
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
12676
+ climate_preset_key?: string | undefined
12677
+ can_edit?: boolean | undefined
12678
+ can_delete?: boolean | undefined
12679
+ name?: (string | null) | undefined
12680
+ display_name?: string | undefined
12681
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12682
+ hvac_mode_setting?:
12683
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12684
+ | undefined
12685
+ cooling_set_point_celsius?: (number | undefined) | undefined
12686
+ heating_set_point_celsius?: (number | undefined) | undefined
12687
+ cooling_set_point_fahrenheit?:
12688
+ | (number | undefined)
12689
+ | undefined
12690
+ heating_set_point_fahrenheit?:
12691
+ | (number | undefined)
12692
+ | undefined
12693
+ manual_override_allowed?: boolean | undefined
12087
12694
  }
12088
12695
  | undefined
12696
+ /**
12697
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12089
12698
  default_climate_setting?:
12090
12699
  | {
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
12700
+ climate_preset_key?: string | undefined
12701
+ can_edit?: boolean | undefined
12702
+ can_delete?: boolean | undefined
12703
+ name?: (string | null) | undefined
12704
+ display_name?: string | undefined
12705
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
12111
12706
  hvac_mode_setting?:
12112
- | ('off' | 'heat' | 'cool' | 'heat_cool')
12707
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12113
12708
  | undefined
12114
12709
  cooling_set_point_celsius?: (number | undefined) | undefined
12115
12710
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -12122,6 +12717,39 @@ export interface Routes {
12122
12717
  manual_override_allowed?: boolean | undefined
12123
12718
  }
12124
12719
  | undefined
12720
+ available_climate_presets?:
12721
+ | Array<{
12722
+ climate_preset_key: string
12723
+ can_edit: boolean
12724
+ can_delete: boolean
12725
+ name: string | null
12726
+ display_name: string
12727
+ fan_mode_setting?: ('auto' | 'on') | undefined
12728
+ hvac_mode_setting?:
12729
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
12730
+ | undefined
12731
+ cooling_set_point_celsius?: number | undefined
12732
+ heating_set_point_celsius?: number | undefined
12733
+ cooling_set_point_fahrenheit?: number | undefined
12734
+ heating_set_point_fahrenheit?: number | undefined
12735
+ manual_override_allowed: boolean
12736
+ }>
12737
+ | undefined
12738
+ fallback_climate_preset_key?: (string | null) | undefined
12739
+ active_thermostat_schedule?:
12740
+ | ({
12741
+ thermostat_schedule_id: string
12742
+ device_id: string
12743
+ name?: string | undefined
12744
+ climate_preset_key: string
12745
+ max_override_period_minutes?: number
12746
+ starts_at: string
12747
+ ends_at: string
12748
+ created_at: string
12749
+ /** 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. */
12750
+ errors?: any
12751
+ } | null)
12752
+ | undefined
12125
12753
  min_cooling_set_point_celsius?: number | undefined
12126
12754
  min_cooling_set_point_fahrenheit?: number | undefined
12127
12755
  max_cooling_set_point_celsius?: number | undefined
@@ -12414,6 +13042,33 @@ export interface Routes {
12414
13042
  message: string
12415
13043
  }
12416
13044
  }
13045
+ | {
13046
+ /** The ID of the action attempt. */
13047
+ action_attempt_id: string
13048
+ status: 'pending'
13049
+ result: null
13050
+ error: null
13051
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13052
+ }
13053
+ | {
13054
+ /** The ID of the action attempt. */
13055
+ action_attempt_id: string
13056
+ status: 'success'
13057
+ error: null
13058
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13059
+ result: {}
13060
+ }
13061
+ | {
13062
+ /** The ID of the action attempt. */
13063
+ action_attempt_id: string
13064
+ status: 'error'
13065
+ result: null
13066
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13067
+ error: {
13068
+ type: string
13069
+ message: string
13070
+ }
13071
+ }
12417
13072
  | {
12418
13073
  /** The ID of the action attempt. */
12419
13074
  action_attempt_id: string
@@ -12843,6 +13498,33 @@ export interface Routes {
12843
13498
  message: string
12844
13499
  }
12845
13500
  }
13501
+ | {
13502
+ /** The ID of the action attempt. */
13503
+ action_attempt_id: string
13504
+ status: 'pending'
13505
+ result: null
13506
+ error: null
13507
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13508
+ }
13509
+ | {
13510
+ /** The ID of the action attempt. */
13511
+ action_attempt_id: string
13512
+ status: 'success'
13513
+ error: null
13514
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13515
+ result: {}
13516
+ }
13517
+ | {
13518
+ /** The ID of the action attempt. */
13519
+ action_attempt_id: string
13520
+ status: 'error'
13521
+ result: null
13522
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13523
+ error: {
13524
+ type: string
13525
+ message: string
13526
+ }
13527
+ }
12846
13528
  | {
12847
13529
  /** The ID of the action attempt. */
12848
13530
  action_attempt_id: string
@@ -13317,22 +13999,22 @@ export interface Routes {
13317
13999
  status: 'pending'
13318
14000
  result: null
13319
14001
  error: null
13320
- action_type: 'SYNC_ACCESS_CODES'
14002
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13321
14003
  }
13322
14004
  | {
13323
14005
  /** The ID of the action attempt. */
13324
14006
  action_attempt_id: string
13325
14007
  status: 'success'
13326
14008
  error: null
13327
- action_type: 'SYNC_ACCESS_CODES'
13328
- result?: any
14009
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14010
+ result: {}
13329
14011
  }
13330
14012
  | {
13331
14013
  /** The ID of the action attempt. */
13332
14014
  action_attempt_id: string
13333
14015
  status: 'error'
13334
14016
  result: null
13335
- action_type: 'SYNC_ACCESS_CODES'
14017
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
13336
14018
  error: {
13337
14019
  type: string
13338
14020
  message: string
@@ -13344,14 +14026,14 @@ export interface Routes {
13344
14026
  status: 'pending'
13345
14027
  result: null
13346
14028
  error: null
13347
- action_type: 'CREATE_ACCESS_CODE'
14029
+ action_type: 'SYNC_ACCESS_CODES'
13348
14030
  }
13349
14031
  | {
13350
14032
  /** The ID of the action attempt. */
13351
14033
  action_attempt_id: string
13352
14034
  status: 'success'
13353
14035
  error: null
13354
- action_type: 'CREATE_ACCESS_CODE'
14036
+ action_type: 'SYNC_ACCESS_CODES'
13355
14037
  result?: any
13356
14038
  }
13357
14039
  | {
@@ -13359,7 +14041,7 @@ export interface Routes {
13359
14041
  action_attempt_id: string
13360
14042
  status: 'error'
13361
14043
  result: null
13362
- action_type: 'CREATE_ACCESS_CODE'
14044
+ action_type: 'SYNC_ACCESS_CODES'
13363
14045
  error: {
13364
14046
  type: string
13365
14047
  message: string
@@ -13371,14 +14053,14 @@ export interface Routes {
13371
14053
  status: 'pending'
13372
14054
  result: null
13373
14055
  error: null
13374
- action_type: 'DELETE_ACCESS_CODE'
14056
+ action_type: 'CREATE_ACCESS_CODE'
13375
14057
  }
13376
14058
  | {
13377
14059
  /** The ID of the action attempt. */
13378
14060
  action_attempt_id: string
13379
14061
  status: 'success'
13380
14062
  error: null
13381
- action_type: 'DELETE_ACCESS_CODE'
14063
+ action_type: 'CREATE_ACCESS_CODE'
13382
14064
  result?: any
13383
14065
  }
13384
14066
  | {
@@ -13386,7 +14068,7 @@ export interface Routes {
13386
14068
  action_attempt_id: string
13387
14069
  status: 'error'
13388
14070
  result: null
13389
- action_type: 'DELETE_ACCESS_CODE'
14071
+ action_type: 'CREATE_ACCESS_CODE'
13390
14072
  error: {
13391
14073
  type: string
13392
14074
  message: string
@@ -13398,14 +14080,14 @@ export interface Routes {
13398
14080
  status: 'pending'
13399
14081
  result: null
13400
14082
  error: null
13401
- action_type: 'UPDATE_ACCESS_CODE'
14083
+ action_type: 'DELETE_ACCESS_CODE'
13402
14084
  }
13403
14085
  | {
13404
14086
  /** The ID of the action attempt. */
13405
14087
  action_attempt_id: string
13406
14088
  status: 'success'
13407
14089
  error: null
13408
- action_type: 'UPDATE_ACCESS_CODE'
14090
+ action_type: 'DELETE_ACCESS_CODE'
13409
14091
  result?: any
13410
14092
  }
13411
14093
  | {
@@ -13413,7 +14095,34 @@ export interface Routes {
13413
14095
  action_attempt_id: string
13414
14096
  status: 'error'
13415
14097
  result: null
13416
- action_type: 'UPDATE_ACCESS_CODE'
14098
+ action_type: 'DELETE_ACCESS_CODE'
14099
+ error: {
14100
+ type: string
14101
+ message: string
14102
+ }
14103
+ }
14104
+ | {
14105
+ /** The ID of the action attempt. */
14106
+ action_attempt_id: string
14107
+ status: 'pending'
14108
+ result: null
14109
+ error: null
14110
+ action_type: 'UPDATE_ACCESS_CODE'
14111
+ }
14112
+ | {
14113
+ /** The ID of the action attempt. */
14114
+ action_attempt_id: string
14115
+ status: 'success'
14116
+ error: null
14117
+ action_type: 'UPDATE_ACCESS_CODE'
14118
+ result?: any
14119
+ }
14120
+ | {
14121
+ /** The ID of the action attempt. */
14122
+ action_attempt_id: string
14123
+ status: 'error'
14124
+ result: null
14125
+ action_type: 'UPDATE_ACCESS_CODE'
13417
14126
  error: {
13418
14127
  type: string
13419
14128
  message: string
@@ -13708,153 +14417,450 @@ export interface Routes {
13708
14417
  }
13709
14418
  }
13710
14419
  }
13711
- '/thermostats/climate_setting_schedules/create': {
13712
- route: '/thermostats/climate_setting_schedules/create'
14420
+ '/thermostats/activate_climate_preset': {
14421
+ route: '/thermostats/activate_climate_preset'
13713
14422
  method: 'POST'
13714
14423
  queryParams: {}
13715
14424
  jsonBody: {
13716
- schedule_type?: 'time_bound'
13717
14425
  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
14426
+ climate_preset_key: string
13727
14427
  }
13728
14428
  commonParams: {}
13729
14429
  formData: {}
13730
14430
  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
- 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
13837
- }
13838
- commonParams: {}
13839
- formData: {}
13840
- 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
- }
14431
+ action_attempt:
14432
+ | {
14433
+ /** The ID of the action attempt. */
14434
+ action_attempt_id: string
14435
+ status: 'pending'
14436
+ result: null
14437
+ error: null
14438
+ action_type: 'LOCK_DOOR'
14439
+ }
14440
+ | {
14441
+ /** The ID of the action attempt. */
14442
+ action_attempt_id: string
14443
+ status: 'success'
14444
+ error: null
14445
+ action_type: 'LOCK_DOOR'
14446
+ result: {}
14447
+ }
14448
+ | {
14449
+ /** The ID of the action attempt. */
14450
+ action_attempt_id: string
14451
+ status: 'error'
14452
+ result: null
14453
+ action_type: 'LOCK_DOOR'
14454
+ error: {
14455
+ type: string
14456
+ message: string
14457
+ }
14458
+ }
14459
+ | {
14460
+ /** The ID of the action attempt. */
14461
+ action_attempt_id: string
14462
+ status: 'pending'
14463
+ result: null
14464
+ error: null
14465
+ action_type: 'UNLOCK_DOOR'
14466
+ }
14467
+ | {
14468
+ /** The ID of the action attempt. */
14469
+ action_attempt_id: string
14470
+ status: 'success'
14471
+ error: null
14472
+ action_type: 'UNLOCK_DOOR'
14473
+ result: {}
14474
+ }
14475
+ | {
14476
+ /** The ID of the action attempt. */
14477
+ action_attempt_id: string
14478
+ status: 'error'
14479
+ result: null
14480
+ action_type: 'UNLOCK_DOOR'
14481
+ error: {
14482
+ type: string
14483
+ message: string
14484
+ }
14485
+ }
14486
+ | {
14487
+ /** The ID of the action attempt. */
14488
+ action_attempt_id: string
14489
+ status: 'pending'
14490
+ result: null
14491
+ error: null
14492
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14493
+ }
14494
+ | {
14495
+ /** The ID of the action attempt. */
14496
+ action_attempt_id: string
14497
+ status: 'success'
14498
+ error: null
14499
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14500
+ result: {}
14501
+ }
14502
+ | {
14503
+ /** The ID of the action attempt. */
14504
+ action_attempt_id: string
14505
+ status: 'error'
14506
+ result: null
14507
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14508
+ error: {
14509
+ type: string
14510
+ message: string
14511
+ }
14512
+ }
14513
+ | {
14514
+ /** The ID of the action attempt. */
14515
+ action_attempt_id: string
14516
+ status: 'pending'
14517
+ result: null
14518
+ error: null
14519
+ action_type: 'SET_COOL'
14520
+ }
14521
+ | {
14522
+ /** The ID of the action attempt. */
14523
+ action_attempt_id: string
14524
+ status: 'success'
14525
+ error: null
14526
+ action_type: 'SET_COOL'
14527
+ result: {}
14528
+ }
14529
+ | {
14530
+ /** The ID of the action attempt. */
14531
+ action_attempt_id: string
14532
+ status: 'error'
14533
+ result: null
14534
+ action_type: 'SET_COOL'
14535
+ error: {
14536
+ type: string
14537
+ message: string
14538
+ }
14539
+ }
14540
+ | {
14541
+ /** The ID of the action attempt. */
14542
+ action_attempt_id: string
14543
+ status: 'pending'
14544
+ result: null
14545
+ error: null
14546
+ action_type: 'SET_HEAT'
14547
+ }
14548
+ | {
14549
+ /** The ID of the action attempt. */
14550
+ action_attempt_id: string
14551
+ status: 'success'
14552
+ error: null
14553
+ action_type: 'SET_HEAT'
14554
+ result: {}
14555
+ }
14556
+ | {
14557
+ /** The ID of the action attempt. */
14558
+ action_attempt_id: string
14559
+ status: 'error'
14560
+ result: null
14561
+ action_type: 'SET_HEAT'
14562
+ error: {
14563
+ type: string
14564
+ message: string
14565
+ }
14566
+ }
14567
+ | {
14568
+ /** The ID of the action attempt. */
14569
+ action_attempt_id: string
14570
+ status: 'pending'
14571
+ result: null
14572
+ error: null
14573
+ action_type: 'SET_HEAT_COOL'
14574
+ }
14575
+ | {
14576
+ /** The ID of the action attempt. */
14577
+ action_attempt_id: string
14578
+ status: 'success'
14579
+ error: null
14580
+ action_type: 'SET_HEAT_COOL'
14581
+ result: {}
14582
+ }
14583
+ | {
14584
+ /** The ID of the action attempt. */
14585
+ action_attempt_id: string
14586
+ status: 'error'
14587
+ result: null
14588
+ action_type: 'SET_HEAT_COOL'
14589
+ error: {
14590
+ type: string
14591
+ message: string
14592
+ }
14593
+ }
14594
+ | {
14595
+ /** The ID of the action attempt. */
14596
+ action_attempt_id: string
14597
+ status: 'pending'
14598
+ result: null
14599
+ error: null
14600
+ action_type: 'SET_FAN_MODE'
14601
+ }
14602
+ | {
14603
+ /** The ID of the action attempt. */
14604
+ action_attempt_id: string
14605
+ status: 'success'
14606
+ error: null
14607
+ action_type: 'SET_FAN_MODE'
14608
+ result: {}
14609
+ }
14610
+ | {
14611
+ /** The ID of the action attempt. */
14612
+ action_attempt_id: string
14613
+ status: 'error'
14614
+ result: null
14615
+ action_type: 'SET_FAN_MODE'
14616
+ error: {
14617
+ type: string
14618
+ message: string
14619
+ }
14620
+ }
14621
+ | {
14622
+ /** The ID of the action attempt. */
14623
+ action_attempt_id: string
14624
+ status: 'pending'
14625
+ result: null
14626
+ error: null
14627
+ action_type: 'SET_THERMOSTAT_OFF'
14628
+ }
14629
+ | {
14630
+ /** The ID of the action attempt. */
14631
+ action_attempt_id: string
14632
+ status: 'success'
14633
+ error: null
14634
+ action_type: 'SET_THERMOSTAT_OFF'
14635
+ result: {}
14636
+ }
14637
+ | {
14638
+ /** The ID of the action attempt. */
14639
+ action_attempt_id: string
14640
+ status: 'error'
14641
+ result: null
14642
+ action_type: 'SET_THERMOSTAT_OFF'
14643
+ error: {
14644
+ type: string
14645
+ message: string
14646
+ }
14647
+ }
14648
+ | {
14649
+ /** The ID of the action attempt. */
14650
+ action_attempt_id: string
14651
+ status: 'pending'
14652
+ result: null
14653
+ error: null
14654
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14655
+ }
14656
+ | {
14657
+ /** The ID of the action attempt. */
14658
+ action_attempt_id: string
14659
+ status: 'success'
14660
+ error: null
14661
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14662
+ result: {}
14663
+ }
14664
+ | {
14665
+ /** The ID of the action attempt. */
14666
+ action_attempt_id: string
14667
+ status: 'error'
14668
+ result: null
14669
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
14670
+ error: {
14671
+ type: string
14672
+ message: string
14673
+ }
14674
+ }
14675
+ | {
14676
+ /** The ID of the action attempt. */
14677
+ action_attempt_id: string
14678
+ status: 'pending'
14679
+ result: null
14680
+ error: null
14681
+ action_type: 'SYNC_ACCESS_CODES'
14682
+ }
14683
+ | {
14684
+ /** The ID of the action attempt. */
14685
+ action_attempt_id: string
14686
+ status: 'success'
14687
+ error: null
14688
+ action_type: 'SYNC_ACCESS_CODES'
14689
+ result?: any
14690
+ }
14691
+ | {
14692
+ /** The ID of the action attempt. */
14693
+ action_attempt_id: string
14694
+ status: 'error'
14695
+ result: null
14696
+ action_type: 'SYNC_ACCESS_CODES'
14697
+ error: {
14698
+ type: string
14699
+ message: string
14700
+ }
14701
+ }
14702
+ | {
14703
+ /** The ID of the action attempt. */
14704
+ action_attempt_id: string
14705
+ status: 'pending'
14706
+ result: null
14707
+ error: null
14708
+ action_type: 'CREATE_ACCESS_CODE'
14709
+ }
14710
+ | {
14711
+ /** The ID of the action attempt. */
14712
+ action_attempt_id: string
14713
+ status: 'success'
14714
+ error: null
14715
+ action_type: 'CREATE_ACCESS_CODE'
14716
+ result?: any
14717
+ }
14718
+ | {
14719
+ /** The ID of the action attempt. */
14720
+ action_attempt_id: string
14721
+ status: 'error'
14722
+ result: null
14723
+ action_type: 'CREATE_ACCESS_CODE'
14724
+ error: {
14725
+ type: string
14726
+ message: string
14727
+ }
14728
+ }
14729
+ | {
14730
+ /** The ID of the action attempt. */
14731
+ action_attempt_id: string
14732
+ status: 'pending'
14733
+ result: null
14734
+ error: null
14735
+ action_type: 'DELETE_ACCESS_CODE'
14736
+ }
14737
+ | {
14738
+ /** The ID of the action attempt. */
14739
+ action_attempt_id: string
14740
+ status: 'success'
14741
+ error: null
14742
+ action_type: 'DELETE_ACCESS_CODE'
14743
+ result?: any
14744
+ }
14745
+ | {
14746
+ /** The ID of the action attempt. */
14747
+ action_attempt_id: string
14748
+ status: 'error'
14749
+ result: null
14750
+ action_type: 'DELETE_ACCESS_CODE'
14751
+ error: {
14752
+ type: string
14753
+ message: string
14754
+ }
14755
+ }
14756
+ | {
14757
+ /** The ID of the action attempt. */
14758
+ action_attempt_id: string
14759
+ status: 'pending'
14760
+ result: null
14761
+ error: null
14762
+ action_type: 'UPDATE_ACCESS_CODE'
14763
+ }
14764
+ | {
14765
+ /** The ID of the action attempt. */
14766
+ action_attempt_id: string
14767
+ status: 'success'
14768
+ error: null
14769
+ action_type: 'UPDATE_ACCESS_CODE'
14770
+ result?: any
14771
+ }
14772
+ | {
14773
+ /** The ID of the action attempt. */
14774
+ action_attempt_id: string
14775
+ status: 'error'
14776
+ result: null
14777
+ action_type: 'UPDATE_ACCESS_CODE'
14778
+ error: {
14779
+ type: string
14780
+ message: string
14781
+ }
14782
+ }
14783
+ | {
14784
+ /** The ID of the action attempt. */
14785
+ action_attempt_id: string
14786
+ status: 'pending'
14787
+ result: null
14788
+ error: null
14789
+ action_type: 'CREATE_NOISE_THRESHOLD'
14790
+ }
14791
+ | {
14792
+ /** The ID of the action attempt. */
14793
+ action_attempt_id: string
14794
+ status: 'success'
14795
+ error: null
14796
+ action_type: 'CREATE_NOISE_THRESHOLD'
14797
+ result?: any
14798
+ }
14799
+ | {
14800
+ /** The ID of the action attempt. */
14801
+ action_attempt_id: string
14802
+ status: 'error'
14803
+ result: null
14804
+ action_type: 'CREATE_NOISE_THRESHOLD'
14805
+ error: {
14806
+ type: string
14807
+ message: string
14808
+ }
14809
+ }
14810
+ | {
14811
+ /** The ID of the action attempt. */
14812
+ action_attempt_id: string
14813
+ status: 'pending'
14814
+ result: null
14815
+ error: null
14816
+ action_type: 'DELETE_NOISE_THRESHOLD'
14817
+ }
14818
+ | {
14819
+ /** The ID of the action attempt. */
14820
+ action_attempt_id: string
14821
+ status: 'success'
14822
+ error: null
14823
+ action_type: 'DELETE_NOISE_THRESHOLD'
14824
+ result?: any
14825
+ }
14826
+ | {
14827
+ /** The ID of the action attempt. */
14828
+ action_attempt_id: string
14829
+ status: 'error'
14830
+ result: null
14831
+ action_type: 'DELETE_NOISE_THRESHOLD'
14832
+ error: {
14833
+ type: string
14834
+ message: string
14835
+ }
14836
+ }
14837
+ | {
14838
+ /** The ID of the action attempt. */
14839
+ action_attempt_id: string
14840
+ status: 'pending'
14841
+ result: null
14842
+ error: null
14843
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14844
+ }
14845
+ | {
14846
+ /** The ID of the action attempt. */
14847
+ action_attempt_id: string
14848
+ status: 'success'
14849
+ error: null
14850
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14851
+ result?: any
14852
+ }
14853
+ | {
14854
+ /** The ID of the action attempt. */
14855
+ action_attempt_id: string
14856
+ status: 'error'
14857
+ result: null
14858
+ action_type: 'UPDATE_NOISE_THRESHOLD'
14859
+ error: {
14860
+ type: string
14861
+ message: string
14862
+ }
14863
+ }
13858
14864
  }
13859
14865
  }
13860
14866
  '/thermostats/cool': {
@@ -14087,6 +15093,33 @@ export interface Routes {
14087
15093
  message: string
14088
15094
  }
14089
15095
  }
15096
+ | {
15097
+ /** The ID of the action attempt. */
15098
+ action_attempt_id: string
15099
+ status: 'pending'
15100
+ result: null
15101
+ error: null
15102
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15103
+ }
15104
+ | {
15105
+ /** The ID of the action attempt. */
15106
+ action_attempt_id: string
15107
+ status: 'success'
15108
+ error: null
15109
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15110
+ result: {}
15111
+ }
15112
+ | {
15113
+ /** The ID of the action attempt. */
15114
+ action_attempt_id: string
15115
+ status: 'error'
15116
+ result: null
15117
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
15118
+ error: {
15119
+ type: string
15120
+ message: string
15121
+ }
15122
+ }
14090
15123
  | {
14091
15124
  /** The ID of the action attempt. */
14092
15125
  action_attempt_id: string
@@ -14278,6 +15311,53 @@ export interface Routes {
14278
15311
  }
14279
15312
  }
14280
15313
  }
15314
+ '/thermostats/create_climate_preset': {
15315
+ route: '/thermostats/create_climate_preset'
15316
+ method: 'POST'
15317
+ queryParams: {}
15318
+ jsonBody: {
15319
+ device_id: string
15320
+ climate_preset_key: string
15321
+ name: string | null
15322
+ fan_mode_setting?: ('auto' | 'on') | undefined
15323
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
15324
+ cooling_set_point_celsius?: number | undefined
15325
+ heating_set_point_celsius?: number | undefined
15326
+ cooling_set_point_fahrenheit?: number | undefined
15327
+ heating_set_point_fahrenheit?: number | undefined
15328
+ manual_override_allowed: boolean
15329
+ }
15330
+ commonParams: {}
15331
+ formData: {}
15332
+ jsonResponse: {
15333
+ climate_preset: {
15334
+ climate_preset_key: string
15335
+ can_edit: boolean
15336
+ can_delete: boolean
15337
+ name: string | null
15338
+ display_name: string
15339
+ fan_mode_setting?: ('auto' | 'on') | undefined
15340
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
15341
+ cooling_set_point_celsius?: number | undefined
15342
+ heating_set_point_celsius?: number | undefined
15343
+ cooling_set_point_fahrenheit?: number | undefined
15344
+ heating_set_point_fahrenheit?: number | undefined
15345
+ manual_override_allowed: boolean
15346
+ }
15347
+ }
15348
+ }
15349
+ '/thermostats/delete_climate_preset': {
15350
+ route: '/thermostats/delete_climate_preset'
15351
+ method: 'POST' | 'DELETE'
15352
+ queryParams: {}
15353
+ jsonBody: {
15354
+ device_id: string
15355
+ climate_preset_key: string
15356
+ }
15357
+ commonParams: {}
15358
+ formData: {}
15359
+ jsonResponse: {}
15360
+ }
14281
15361
  '/thermostats/get': {
14282
15362
  route: '/thermostats/get'
14283
15363
  method: 'GET' | 'POST'
@@ -14728,42 +15808,44 @@ export interface Routes {
14728
15808
  is_heating?: boolean | undefined
14729
15809
  is_cooling?: boolean | undefined
14730
15810
  is_fan_running?: boolean | undefined
15811
+ /**
15812
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
14731
15813
  fan_mode_setting?: ('auto' | 'on') | undefined
14732
15814
  is_temporary_manual_override_active?: boolean | undefined
14733
15815
  current_climate_setting?:
14734
15816
  | {
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
15817
+ climate_preset_key?: string | undefined
15818
+ can_edit?: boolean | undefined
15819
+ can_delete?: boolean | undefined
15820
+ name?: (string | null) | undefined
15821
+ display_name?: string | undefined
15822
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
15823
+ hvac_mode_setting?:
15824
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15825
+ | undefined
15826
+ cooling_set_point_celsius?: (number | undefined) | undefined
15827
+ heating_set_point_celsius?: (number | undefined) | undefined
15828
+ cooling_set_point_fahrenheit?:
15829
+ | (number | undefined)
15830
+ | undefined
15831
+ heating_set_point_fahrenheit?:
15832
+ | (number | undefined)
15833
+ | undefined
15834
+ manual_override_allowed?: boolean | undefined
14741
15835
  }
14742
15836
  | undefined
15837
+ /**
15838
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14743
15839
  default_climate_setting?:
14744
15840
  | {
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
15841
+ climate_preset_key?: string | undefined
15842
+ can_edit?: boolean | undefined
15843
+ can_delete?: boolean | undefined
15844
+ name?: (string | null) | undefined
15845
+ display_name?: string | undefined
15846
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
14765
15847
  hvac_mode_setting?:
14766
- | ('off' | 'heat' | 'cool' | 'heat_cool')
15848
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
14767
15849
  | undefined
14768
15850
  cooling_set_point_celsius?: (number | undefined) | undefined
14769
15851
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -14776,6 +15858,39 @@ export interface Routes {
14776
15858
  manual_override_allowed?: boolean | undefined
14777
15859
  }
14778
15860
  | undefined
15861
+ available_climate_presets?:
15862
+ | Array<{
15863
+ climate_preset_key: string
15864
+ can_edit: boolean
15865
+ can_delete: boolean
15866
+ name: string | null
15867
+ display_name: string
15868
+ fan_mode_setting?: ('auto' | 'on') | undefined
15869
+ hvac_mode_setting?:
15870
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
15871
+ | undefined
15872
+ cooling_set_point_celsius?: number | undefined
15873
+ heating_set_point_celsius?: number | undefined
15874
+ cooling_set_point_fahrenheit?: number | undefined
15875
+ heating_set_point_fahrenheit?: number | undefined
15876
+ manual_override_allowed: boolean
15877
+ }>
15878
+ | undefined
15879
+ fallback_climate_preset_key?: (string | null) | undefined
15880
+ active_thermostat_schedule?:
15881
+ | ({
15882
+ thermostat_schedule_id: string
15883
+ device_id: string
15884
+ name?: string | undefined
15885
+ climate_preset_key: string
15886
+ max_override_period_minutes?: number
15887
+ starts_at: string
15888
+ ends_at: string
15889
+ created_at: string
15890
+ /** 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. */
15891
+ errors?: any
15892
+ } | null)
15893
+ | undefined
14779
15894
  min_cooling_set_point_celsius?: number | undefined
14780
15895
  min_cooling_set_point_fahrenheit?: number | undefined
14781
15896
  max_cooling_set_point_celsius?: number | undefined
@@ -15065,6 +16180,33 @@ export interface Routes {
15065
16180
  message: string
15066
16181
  }
15067
16182
  }
16183
+ | {
16184
+ /** The ID of the action attempt. */
16185
+ action_attempt_id: string
16186
+ status: 'pending'
16187
+ result: null
16188
+ error: null
16189
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16190
+ }
16191
+ | {
16192
+ /** The ID of the action attempt. */
16193
+ action_attempt_id: string
16194
+ status: 'success'
16195
+ error: null
16196
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16197
+ result: {}
16198
+ }
16199
+ | {
16200
+ /** The ID of the action attempt. */
16201
+ action_attempt_id: string
16202
+ status: 'error'
16203
+ result: null
16204
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16205
+ error: {
16206
+ type: string
16207
+ message: string
16208
+ }
16209
+ }
15068
16210
  | {
15069
16211
  /** The ID of the action attempt. */
15070
16212
  action_attempt_id: string
@@ -15488,6 +16630,33 @@ export interface Routes {
15488
16630
  message: string
15489
16631
  }
15490
16632
  }
16633
+ | {
16634
+ /** The ID of the action attempt. */
16635
+ action_attempt_id: string
16636
+ status: 'pending'
16637
+ result: null
16638
+ error: null
16639
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16640
+ }
16641
+ | {
16642
+ /** The ID of the action attempt. */
16643
+ action_attempt_id: string
16644
+ status: 'success'
16645
+ error: null
16646
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16647
+ result: {}
16648
+ }
16649
+ | {
16650
+ /** The ID of the action attempt. */
16651
+ action_attempt_id: string
16652
+ status: 'error'
16653
+ result: null
16654
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
16655
+ error: {
16656
+ type: string
16657
+ message: string
16658
+ }
16659
+ }
15491
16660
  | {
15492
16661
  /** The ID of the action attempt. */
15493
16662
  action_attempt_id: string
@@ -16282,42 +17451,44 @@ export interface Routes {
16282
17451
  is_heating?: boolean | undefined
16283
17452
  is_cooling?: boolean | undefined
16284
17453
  is_fan_running?: boolean | undefined
17454
+ /**
17455
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
16285
17456
  fan_mode_setting?: ('auto' | 'on') | undefined
16286
17457
  is_temporary_manual_override_active?: boolean | undefined
16287
17458
  current_climate_setting?:
16288
17459
  | {
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
17460
+ climate_preset_key?: string | undefined
17461
+ can_edit?: boolean | undefined
17462
+ can_delete?: boolean | undefined
17463
+ name?: (string | null) | undefined
17464
+ display_name?: string | undefined
17465
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
17466
+ hvac_mode_setting?:
17467
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
17468
+ | undefined
17469
+ cooling_set_point_celsius?: (number | undefined) | undefined
17470
+ heating_set_point_celsius?: (number | undefined) | undefined
17471
+ cooling_set_point_fahrenheit?:
17472
+ | (number | undefined)
17473
+ | undefined
17474
+ heating_set_point_fahrenheit?:
17475
+ | (number | undefined)
17476
+ | undefined
17477
+ manual_override_allowed?: boolean | undefined
16295
17478
  }
16296
17479
  | undefined
17480
+ /**
17481
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
16297
17482
  default_climate_setting?:
16298
17483
  | {
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
17484
+ climate_preset_key?: string | undefined
17485
+ can_edit?: boolean | undefined
17486
+ can_delete?: boolean | undefined
17487
+ name?: (string | null) | undefined
17488
+ display_name?: string | undefined
17489
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
16319
17490
  hvac_mode_setting?:
16320
- | ('off' | 'heat' | 'cool' | 'heat_cool')
17491
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
16321
17492
  | undefined
16322
17493
  cooling_set_point_celsius?: (number | undefined) | undefined
16323
17494
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -16330,6 +17501,39 @@ export interface Routes {
16330
17501
  manual_override_allowed?: boolean | undefined
16331
17502
  }
16332
17503
  | undefined
17504
+ available_climate_presets?:
17505
+ | Array<{
17506
+ climate_preset_key: string
17507
+ can_edit: boolean
17508
+ can_delete: boolean
17509
+ name: string | null
17510
+ display_name: string
17511
+ fan_mode_setting?: ('auto' | 'on') | undefined
17512
+ hvac_mode_setting?:
17513
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
17514
+ | undefined
17515
+ cooling_set_point_celsius?: number | undefined
17516
+ heating_set_point_celsius?: number | undefined
17517
+ cooling_set_point_fahrenheit?: number | undefined
17518
+ heating_set_point_fahrenheit?: number | undefined
17519
+ manual_override_allowed: boolean
17520
+ }>
17521
+ | undefined
17522
+ fallback_climate_preset_key?: (string | null) | undefined
17523
+ active_thermostat_schedule?:
17524
+ | ({
17525
+ thermostat_schedule_id: string
17526
+ device_id: string
17527
+ name?: string | undefined
17528
+ climate_preset_key: string
17529
+ max_override_period_minutes?: number
17530
+ starts_at: string
17531
+ ends_at: string
17532
+ created_at: string
17533
+ /** 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. */
17534
+ errors?: any
17535
+ } | null)
17536
+ | undefined
16333
17537
  min_cooling_set_point_celsius?: number | undefined
16334
17538
  min_cooling_set_point_fahrenheit?: number | undefined
16335
17539
  max_cooling_set_point_celsius?: number | undefined
@@ -16617,6 +17821,33 @@ export interface Routes {
16617
17821
  message: string
16618
17822
  }
16619
17823
  }
17824
+ | {
17825
+ /** The ID of the action attempt. */
17826
+ action_attempt_id: string
17827
+ status: 'pending'
17828
+ result: null
17829
+ error: null
17830
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17831
+ }
17832
+ | {
17833
+ /** The ID of the action attempt. */
17834
+ action_attempt_id: string
17835
+ status: 'success'
17836
+ error: null
17837
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17838
+ result: {}
17839
+ }
17840
+ | {
17841
+ /** The ID of the action attempt. */
17842
+ action_attempt_id: string
17843
+ status: 'error'
17844
+ result: null
17845
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
17846
+ error: {
17847
+ type: string
17848
+ message: string
17849
+ }
17850
+ }
16620
17851
  | {
16621
17852
  /** The ID of the action attempt. */
16622
17853
  action_attempt_id: string
@@ -16808,12 +18039,144 @@ export interface Routes {
16808
18039
  }
16809
18040
  }
16810
18041
  }
18042
+ '/thermostats/schedules/create': {
18043
+ route: '/thermostats/schedules/create'
18044
+ method: 'POST'
18045
+ queryParams: {}
18046
+ jsonBody: {
18047
+ device_id: string
18048
+ name?: string | undefined
18049
+ climate_preset_key: string
18050
+ max_override_period_minutes?: number
18051
+ starts_at: string
18052
+ ends_at: string
18053
+ }
18054
+ commonParams: {}
18055
+ formData: {}
18056
+ jsonResponse: {
18057
+ thermostat_schedule: {
18058
+ thermostat_schedule_id: string
18059
+ device_id: string
18060
+ name?: string | undefined
18061
+ climate_preset_key: string
18062
+ max_override_period_minutes?: number
18063
+ starts_at: string
18064
+ ends_at: string
18065
+ created_at: string
18066
+ /** 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. */
18067
+ errors?: any
18068
+ }
18069
+ }
18070
+ }
18071
+ '/thermostats/schedules/delete': {
18072
+ route: '/thermostats/schedules/delete'
18073
+ method: 'DELETE' | 'POST'
18074
+ queryParams: {}
18075
+ jsonBody: {}
18076
+ commonParams: {
18077
+ thermostat_schedule_id: string
18078
+ }
18079
+ formData: {}
18080
+ jsonResponse: {}
18081
+ }
18082
+ '/thermostats/schedules/get': {
18083
+ route: '/thermostats/schedules/get'
18084
+ method: 'GET' | 'POST'
18085
+ queryParams: {}
18086
+ jsonBody: {}
18087
+ commonParams: {
18088
+ thermostat_schedule_id: string
18089
+ }
18090
+ formData: {}
18091
+ jsonResponse: {
18092
+ thermostat_schedule: {
18093
+ thermostat_schedule_id: string
18094
+ device_id: string
18095
+ name?: string | undefined
18096
+ climate_preset_key: string
18097
+ max_override_period_minutes?: number
18098
+ starts_at: string
18099
+ ends_at: string
18100
+ created_at: string
18101
+ /** 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. */
18102
+ errors?: any
18103
+ }
18104
+ }
18105
+ }
18106
+ '/thermostats/schedules/list': {
18107
+ route: '/thermostats/schedules/list'
18108
+ method: 'GET' | 'POST'
18109
+ queryParams: {}
18110
+ jsonBody: {}
18111
+ commonParams: {
18112
+ device_id: string
18113
+ user_identifier_key?: string | undefined
18114
+ }
18115
+ formData: {}
18116
+ jsonResponse: {
18117
+ thermostat_schedules: Array<{
18118
+ thermostat_schedule_id: string
18119
+ device_id: string
18120
+ name?: string | undefined
18121
+ climate_preset_key: string
18122
+ max_override_period_minutes?: number
18123
+ starts_at: string
18124
+ ends_at: string
18125
+ created_at: string
18126
+ /** 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. */
18127
+ errors?: any
18128
+ }>
18129
+ }
18130
+ }
18131
+ '/thermostats/schedules/update': {
18132
+ route: '/thermostats/schedules/update'
18133
+ method: 'PATCH' | 'POST'
18134
+ queryParams: {}
18135
+ jsonBody: {
18136
+ thermostat_schedule_id: string
18137
+ name?: string | undefined
18138
+ climate_preset_key?: string | undefined
18139
+ max_override_period_minutes?: number | undefined
18140
+ starts_at?: string | undefined
18141
+ ends_at?: string | undefined
18142
+ }
18143
+ commonParams: {}
18144
+ formData: {}
18145
+ jsonResponse: {
18146
+ thermostat_schedule: {
18147
+ thermostat_schedule_id: string
18148
+ device_id: string
18149
+ name?: string | undefined
18150
+ climate_preset_key: string
18151
+ max_override_period_minutes?: number
18152
+ starts_at: string
18153
+ ends_at: string
18154
+ created_at: string
18155
+ /** 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. */
18156
+ errors?: any
18157
+ }
18158
+ }
18159
+ }
18160
+ '/thermostats/set_fallback_climate_preset': {
18161
+ route: '/thermostats/set_fallback_climate_preset'
18162
+ method: 'POST'
18163
+ queryParams: {}
18164
+ jsonBody: {
18165
+ device_id: string
18166
+ climate_preset_key: string
18167
+ }
18168
+ commonParams: {}
18169
+ formData: {}
18170
+ jsonResponse: {}
18171
+ }
16811
18172
  '/thermostats/set_fan_mode': {
16812
18173
  route: '/thermostats/set_fan_mode'
16813
18174
  method: 'POST'
16814
18175
  queryParams: {}
16815
18176
  jsonBody: {
16816
18177
  device_id: string
18178
+ /**
18179
+ * @deprecated use fan_mode_setting instead. */
16817
18180
  fan_mode?: ('auto' | 'on') | undefined
16818
18181
  fan_mode_setting?: ('auto' | 'on') | undefined
16819
18182
  sync?: boolean
@@ -17038,6 +18401,33 @@ export interface Routes {
17038
18401
  message: string
17039
18402
  }
17040
18403
  }
18404
+ | {
18405
+ /** The ID of the action attempt. */
18406
+ action_attempt_id: string
18407
+ status: 'pending'
18408
+ result: null
18409
+ error: null
18410
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18411
+ }
18412
+ | {
18413
+ /** The ID of the action attempt. */
18414
+ action_attempt_id: string
18415
+ status: 'success'
18416
+ error: null
18417
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18418
+ result: {}
18419
+ }
18420
+ | {
18421
+ /** The ID of the action attempt. */
18422
+ action_attempt_id: string
18423
+ status: 'error'
18424
+ result: null
18425
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
18426
+ error: {
18427
+ type: string
18428
+ message: string
18429
+ }
18430
+ }
17041
18431
  | {
17042
18432
  /** The ID of the action attempt. */
17043
18433
  action_attempt_id: string
@@ -17229,24 +18619,40 @@ export interface Routes {
17229
18619
  }
17230
18620
  }
17231
18621
  }
17232
- '/thermostats/update': {
17233
- route: '/thermostats/update'
17234
- method: 'PATCH' | 'POST'
18622
+ '/thermostats/update_climate_preset': {
18623
+ route: '/thermostats/update_climate_preset'
18624
+ method: 'POST' | 'PATCH'
17235
18625
  queryParams: {}
17236
18626
  jsonBody: {
17237
18627
  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
- }
18628
+ climate_preset_key: string
18629
+ name: string | null
18630
+ fan_mode_setting?: ('auto' | 'on') | undefined
18631
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
18632
+ cooling_set_point_celsius?: number | undefined
18633
+ heating_set_point_celsius?: number | undefined
18634
+ cooling_set_point_fahrenheit?: number | undefined
18635
+ heating_set_point_fahrenheit?: number | undefined
18636
+ manual_override_allowed: boolean
17246
18637
  }
17247
18638
  commonParams: {}
17248
18639
  formData: {}
17249
- jsonResponse: {}
18640
+ jsonResponse: {
18641
+ climate_preset: {
18642
+ climate_preset_key: string
18643
+ can_edit: boolean
18644
+ can_delete: boolean
18645
+ name: string | null
18646
+ display_name: string
18647
+ fan_mode_setting?: ('auto' | 'on') | undefined
18648
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
18649
+ cooling_set_point_celsius?: number | undefined
18650
+ heating_set_point_celsius?: number | undefined
18651
+ cooling_set_point_fahrenheit?: number | undefined
18652
+ heating_set_point_fahrenheit?: number | undefined
18653
+ manual_override_allowed: boolean
18654
+ }
18655
+ }
17250
18656
  }
17251
18657
  '/user_identities/add_acs_user': {
17252
18658
  route: '/user_identities/add_acs_user'
@@ -17878,42 +19284,44 @@ export interface Routes {
17878
19284
  is_heating?: boolean | undefined
17879
19285
  is_cooling?: boolean | undefined
17880
19286
  is_fan_running?: boolean | undefined
19287
+ /**
19288
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
17881
19289
  fan_mode_setting?: ('auto' | 'on') | undefined
17882
19290
  is_temporary_manual_override_active?: boolean | undefined
17883
19291
  current_climate_setting?:
17884
19292
  | {
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
19293
+ climate_preset_key?: string | undefined
19294
+ can_edit?: boolean | undefined
19295
+ can_delete?: boolean | undefined
19296
+ name?: (string | null) | undefined
19297
+ display_name?: string | undefined
19298
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
19299
+ hvac_mode_setting?:
19300
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19301
+ | undefined
19302
+ cooling_set_point_celsius?: (number | undefined) | undefined
19303
+ heating_set_point_celsius?: (number | undefined) | undefined
19304
+ cooling_set_point_fahrenheit?:
19305
+ | (number | undefined)
19306
+ | undefined
19307
+ heating_set_point_fahrenheit?:
19308
+ | (number | undefined)
19309
+ | undefined
19310
+ manual_override_allowed?: boolean | undefined
17891
19311
  }
17892
19312
  | undefined
19313
+ /**
19314
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
17893
19315
  default_climate_setting?:
17894
19316
  | {
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
19317
+ climate_preset_key?: string | undefined
19318
+ can_edit?: boolean | undefined
19319
+ can_delete?: boolean | undefined
19320
+ name?: (string | null) | undefined
19321
+ display_name?: string | undefined
19322
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
17915
19323
  hvac_mode_setting?:
17916
- | ('off' | 'heat' | 'cool' | 'heat_cool')
19324
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
17917
19325
  | undefined
17918
19326
  cooling_set_point_celsius?: (number | undefined) | undefined
17919
19327
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -17926,6 +19334,39 @@ export interface Routes {
17926
19334
  manual_override_allowed?: boolean | undefined
17927
19335
  }
17928
19336
  | undefined
19337
+ available_climate_presets?:
19338
+ | Array<{
19339
+ climate_preset_key: string
19340
+ can_edit: boolean
19341
+ can_delete: boolean
19342
+ name: string | null
19343
+ display_name: string
19344
+ fan_mode_setting?: ('auto' | 'on') | undefined
19345
+ hvac_mode_setting?:
19346
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
19347
+ | undefined
19348
+ cooling_set_point_celsius?: number | undefined
19349
+ heating_set_point_celsius?: number | undefined
19350
+ cooling_set_point_fahrenheit?: number | undefined
19351
+ heating_set_point_fahrenheit?: number | undefined
19352
+ manual_override_allowed: boolean
19353
+ }>
19354
+ | undefined
19355
+ fallback_climate_preset_key?: (string | null) | undefined
19356
+ active_thermostat_schedule?:
19357
+ | ({
19358
+ thermostat_schedule_id: string
19359
+ device_id: string
19360
+ name?: string | undefined
19361
+ climate_preset_key: string
19362
+ max_override_period_minutes?: number
19363
+ starts_at: string
19364
+ ends_at: string
19365
+ created_at: string
19366
+ /** 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. */
19367
+ errors?: any
19368
+ } | null)
19369
+ | undefined
17929
19370
  min_cooling_set_point_celsius?: number | undefined
17930
19371
  min_cooling_set_point_fahrenheit?: number | undefined
17931
19372
  max_cooling_set_point_celsius?: number | undefined
@@ -18424,42 +19865,44 @@ export interface Routes {
18424
19865
  is_heating?: boolean | undefined
18425
19866
  is_cooling?: boolean | undefined
18426
19867
  is_fan_running?: boolean | undefined
19868
+ /**
19869
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
18427
19870
  fan_mode_setting?: ('auto' | 'on') | undefined
18428
19871
  is_temporary_manual_override_active?: boolean | undefined
18429
19872
  current_climate_setting?:
18430
19873
  | {
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
19874
+ climate_preset_key?: string | undefined
19875
+ can_edit?: boolean | undefined
19876
+ can_delete?: boolean | undefined
19877
+ name?: (string | null) | undefined
19878
+ display_name?: string | undefined
19879
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
19880
+ hvac_mode_setting?:
19881
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19882
+ | undefined
19883
+ cooling_set_point_celsius?: (number | undefined) | undefined
19884
+ heating_set_point_celsius?: (number | undefined) | undefined
19885
+ cooling_set_point_fahrenheit?:
19886
+ | (number | undefined)
19887
+ | undefined
19888
+ heating_set_point_fahrenheit?:
19889
+ | (number | undefined)
19890
+ | undefined
19891
+ manual_override_allowed?: boolean | undefined
18437
19892
  }
18438
19893
  | undefined
19894
+ /**
19895
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
18439
19896
  default_climate_setting?:
18440
19897
  | {
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
19898
+ climate_preset_key?: string | undefined
19899
+ can_edit?: boolean | undefined
19900
+ can_delete?: boolean | undefined
19901
+ name?: (string | null) | undefined
19902
+ display_name?: string | undefined
19903
+ fan_mode_setting?: (('auto' | 'on') | undefined) | undefined
18461
19904
  hvac_mode_setting?:
18462
- | ('off' | 'heat' | 'cool' | 'heat_cool')
19905
+ | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
18463
19906
  | undefined
18464
19907
  cooling_set_point_celsius?: (number | undefined) | undefined
18465
19908
  heating_set_point_celsius?: (number | undefined) | undefined
@@ -18472,6 +19915,39 @@ export interface Routes {
18472
19915
  manual_override_allowed?: boolean | undefined
18473
19916
  }
18474
19917
  | undefined
19918
+ available_climate_presets?:
19919
+ | Array<{
19920
+ climate_preset_key: string
19921
+ can_edit: boolean
19922
+ can_delete: boolean
19923
+ name: string | null
19924
+ display_name: string
19925
+ fan_mode_setting?: ('auto' | 'on') | undefined
19926
+ hvac_mode_setting?:
19927
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
19928
+ | undefined
19929
+ cooling_set_point_celsius?: number | undefined
19930
+ heating_set_point_celsius?: number | undefined
19931
+ cooling_set_point_fahrenheit?: number | undefined
19932
+ heating_set_point_fahrenheit?: number | undefined
19933
+ manual_override_allowed: boolean
19934
+ }>
19935
+ | undefined
19936
+ fallback_climate_preset_key?: (string | null) | undefined
19937
+ active_thermostat_schedule?:
19938
+ | ({
19939
+ thermostat_schedule_id: string
19940
+ device_id: string
19941
+ name?: string | undefined
19942
+ climate_preset_key: string
19943
+ max_override_period_minutes?: number
19944
+ starts_at: string
19945
+ ends_at: string
19946
+ created_at: string
19947
+ /** 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. */
19948
+ errors?: any
19949
+ } | null)
19950
+ | undefined
18475
19951
  min_cooling_set_point_celsius?: number | undefined
18476
19952
  min_cooling_set_point_fahrenheit?: number | undefined
18477
19953
  max_cooling_set_point_celsius?: number | undefined
@@ -18699,7 +20175,7 @@ export interface Routes {
18699
20175
  | {
18700
20176
  created_at: string
18701
20177
  message: string
18702
- warning_code: 'failed_to_update_acs_user_on_acs_system'
20178
+ warning_code: 'failed_to_update_on_acs_system'
18703
20179
  }
18704
20180
  | {
18705
20181
  created_at: string
@@ -18712,7 +20188,29 @@ export interface Routes {
18712
20188
  warning_code: 'salto_site_user_suspended'
18713
20189
  }
18714
20190
  >
18715
- errors?: any
20191
+ errors: Array<
20192
+ | {
20193
+ /** Date and time at which Seam created the error. */
20194
+ created_at: string
20195
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20196
+ message: string
20197
+ error_code: 'user_deleted_externally'
20198
+ }
20199
+ | {
20200
+ /** Date and time at which Seam created the error. */
20201
+ created_at: string
20202
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20203
+ message: string
20204
+ error_code: 'salto_ks_subscription_limit_exceeded'
20205
+ }
20206
+ | {
20207
+ /** Date and time at which Seam created the error. */
20208
+ created_at: string
20209
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20210
+ message: string
20211
+ error_code: 'salto_site_user_limit_reached'
20212
+ }
20213
+ >
18716
20214
  full_name?: string | undefined
18717
20215
  /**
18718
20216
  * @deprecated use email_address. */
@@ -19129,6 +20627,33 @@ export interface Routes {
19129
20627
  message: string
19130
20628
  }
19131
20629
  }
20630
+ | {
20631
+ /** The ID of the action attempt. */
20632
+ action_attempt_id: string
20633
+ status: 'pending'
20634
+ result: null
20635
+ error: null
20636
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20637
+ }
20638
+ | {
20639
+ /** The ID of the action attempt. */
20640
+ action_attempt_id: string
20641
+ status: 'success'
20642
+ error: null
20643
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20644
+ result: {}
20645
+ }
20646
+ | {
20647
+ /** The ID of the action attempt. */
20648
+ action_attempt_id: string
20649
+ status: 'error'
20650
+ result: null
20651
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
20652
+ error: {
20653
+ type: string
20654
+ message: string
20655
+ }
20656
+ }
19132
20657
  | {
19133
20658
  /** The ID of the action attempt. */
19134
20659
  action_attempt_id: string