@seamapi/types 1.291.0 → 1.292.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.
@@ -15110,17 +15110,21 @@ declare const _default: {
15110
15110
  nullable: boolean;
15111
15111
  properties: {
15112
15112
  climate_preset_key: {
15113
+ description: string;
15113
15114
  type: string;
15114
15115
  };
15115
15116
  created_at: {
15117
+ description: string;
15116
15118
  format: string;
15117
15119
  type: string;
15118
15120
  };
15119
15121
  device_id: {
15122
+ description: string;
15120
15123
  format: string;
15121
15124
  type: string;
15122
15125
  };
15123
15126
  ends_at: {
15127
+ description: string;
15124
15128
  format: string;
15125
15129
  type: string;
15126
15130
  };
@@ -15128,17 +15132,21 @@ declare const _default: {
15128
15132
  description: string;
15129
15133
  };
15130
15134
  max_override_period_minutes: {
15135
+ description: string;
15131
15136
  minimum: number;
15132
15137
  type: string;
15133
15138
  };
15134
15139
  name: {
15140
+ description: string;
15135
15141
  type: string;
15136
15142
  };
15137
15143
  starts_at: {
15144
+ description: string;
15138
15145
  format: string;
15139
15146
  type: string;
15140
15147
  };
15141
15148
  thermostat_schedule_id: {
15149
+ description: string;
15142
15150
  format: string;
15143
15151
  type: string;
15144
15152
  };
@@ -15150,46 +15158,58 @@ declare const _default: {
15150
15158
  items: {
15151
15159
  properties: {
15152
15160
  can_delete: {
15161
+ description: string;
15153
15162
  type: string;
15154
15163
  };
15155
15164
  can_edit: {
15165
+ description: string;
15156
15166
  type: string;
15157
15167
  };
15158
15168
  climate_preset_key: {
15169
+ description: string;
15159
15170
  type: string;
15160
15171
  };
15161
15172
  cooling_set_point_celsius: {
15173
+ description: string;
15162
15174
  format: string;
15163
15175
  type: string;
15164
15176
  };
15165
15177
  cooling_set_point_fahrenheit: {
15178
+ description: string;
15166
15179
  format: string;
15167
15180
  type: string;
15168
15181
  };
15169
15182
  display_name: {
15183
+ description: string;
15170
15184
  type: string;
15171
15185
  };
15172
15186
  fan_mode_setting: {
15187
+ description: string;
15173
15188
  enum: string[];
15174
15189
  type: string;
15175
15190
  };
15176
15191
  heating_set_point_celsius: {
15192
+ description: string;
15177
15193
  format: string;
15178
15194
  type: string;
15179
15195
  };
15180
15196
  heating_set_point_fahrenheit: {
15197
+ description: string;
15181
15198
  format: string;
15182
15199
  type: string;
15183
15200
  };
15184
15201
  hvac_mode_setting: {
15202
+ description: string;
15185
15203
  enum: string[];
15186
15204
  type: string;
15187
15205
  };
15188
15206
  manual_override_allowed: {
15207
+ description: string;
15189
15208
  type: string;
15190
15209
  };
15191
15210
  name: {
15192
15211
  default: null;
15212
+ description: string;
15193
15213
  nullable: boolean;
15194
15214
  type: string;
15195
15215
  };
@@ -15216,46 +15236,58 @@ declare const _default: {
15216
15236
  current_climate_setting: {
15217
15237
  properties: {
15218
15238
  can_delete: {
15239
+ description: string;
15219
15240
  type: string;
15220
15241
  };
15221
15242
  can_edit: {
15243
+ description: string;
15222
15244
  type: string;
15223
15245
  };
15224
15246
  climate_preset_key: {
15247
+ description: string;
15225
15248
  type: string;
15226
15249
  };
15227
15250
  cooling_set_point_celsius: {
15251
+ description: string;
15228
15252
  format: string;
15229
15253
  type: string;
15230
15254
  };
15231
15255
  cooling_set_point_fahrenheit: {
15256
+ description: string;
15232
15257
  format: string;
15233
15258
  type: string;
15234
15259
  };
15235
15260
  display_name: {
15261
+ description: string;
15236
15262
  type: string;
15237
15263
  };
15238
15264
  fan_mode_setting: {
15265
+ description: string;
15239
15266
  enum: string[];
15240
15267
  type: string;
15241
15268
  };
15242
15269
  heating_set_point_celsius: {
15270
+ description: string;
15243
15271
  format: string;
15244
15272
  type: string;
15245
15273
  };
15246
15274
  heating_set_point_fahrenheit: {
15275
+ description: string;
15247
15276
  format: string;
15248
15277
  type: string;
15249
15278
  };
15250
15279
  hvac_mode_setting: {
15280
+ description: string;
15251
15281
  enum: string[];
15252
15282
  type: string;
15253
15283
  };
15254
15284
  manual_override_allowed: {
15285
+ description: string;
15255
15286
  type: string;
15256
15287
  };
15257
15288
  name: {
15258
15289
  default: null;
15290
+ description: string;
15259
15291
  nullable: boolean;
15260
15292
  type: string;
15261
15293
  };
@@ -15266,46 +15298,58 @@ declare const _default: {
15266
15298
  deprecated: boolean;
15267
15299
  properties: {
15268
15300
  can_delete: {
15301
+ description: string;
15269
15302
  type: string;
15270
15303
  };
15271
15304
  can_edit: {
15305
+ description: string;
15272
15306
  type: string;
15273
15307
  };
15274
15308
  climate_preset_key: {
15309
+ description: string;
15275
15310
  type: string;
15276
15311
  };
15277
15312
  cooling_set_point_celsius: {
15313
+ description: string;
15278
15314
  format: string;
15279
15315
  type: string;
15280
15316
  };
15281
15317
  cooling_set_point_fahrenheit: {
15318
+ description: string;
15282
15319
  format: string;
15283
15320
  type: string;
15284
15321
  };
15285
15322
  display_name: {
15323
+ description: string;
15286
15324
  type: string;
15287
15325
  };
15288
15326
  fan_mode_setting: {
15327
+ description: string;
15289
15328
  enum: string[];
15290
15329
  type: string;
15291
15330
  };
15292
15331
  heating_set_point_celsius: {
15332
+ description: string;
15293
15333
  format: string;
15294
15334
  type: string;
15295
15335
  };
15296
15336
  heating_set_point_fahrenheit: {
15337
+ description: string;
15297
15338
  format: string;
15298
15339
  type: string;
15299
15340
  };
15300
15341
  hvac_mode_setting: {
15342
+ description: string;
15301
15343
  enum: string[];
15302
15344
  type: string;
15303
15345
  };
15304
15346
  manual_override_allowed: {
15347
+ description: string;
15305
15348
  type: string;
15306
15349
  };
15307
15350
  name: {
15308
15351
  default: null;
15352
+ description: string;
15309
15353
  nullable: boolean;
15310
15354
  type: string;
15311
15355
  };
@@ -15888,17 +15932,21 @@ declare const _default: {
15888
15932
  thermostat_schedule: {
15889
15933
  properties: {
15890
15934
  climate_preset_key: {
15935
+ description: string;
15891
15936
  type: string;
15892
15937
  };
15893
15938
  created_at: {
15939
+ description: string;
15894
15940
  format: string;
15895
15941
  type: string;
15896
15942
  };
15897
15943
  device_id: {
15944
+ description: string;
15898
15945
  format: string;
15899
15946
  type: string;
15900
15947
  };
15901
15948
  ends_at: {
15949
+ description: string;
15902
15950
  format: string;
15903
15951
  type: string;
15904
15952
  };
@@ -15906,17 +15954,21 @@ declare const _default: {
15906
15954
  description: string;
15907
15955
  };
15908
15956
  max_override_period_minutes: {
15957
+ description: string;
15909
15958
  minimum: number;
15910
15959
  type: string;
15911
15960
  };
15912
15961
  name: {
15962
+ description: string;
15913
15963
  type: string;
15914
15964
  };
15915
15965
  starts_at: {
15966
+ description: string;
15916
15967
  format: string;
15917
15968
  type: string;
15918
15969
  };
15919
15970
  thermostat_schedule_id: {
15971
+ description: string;
15920
15972
  format: string;
15921
15973
  type: string;
15922
15974
  };
@@ -24933,6 +24985,7 @@ declare const _default: {
24933
24985
  };
24934
24986
  '/devices/list': {
24935
24987
  post: {
24988
+ description: string;
24936
24989
  operationId: string;
24937
24990
  requestBody: {
24938
24991
  content: {
@@ -24940,6 +24993,7 @@ declare const _default: {
24940
24993
  schema: {
24941
24994
  properties: {
24942
24995
  connect_webview_id: {
24996
+ description: string;
24943
24997
  format: string;
24944
24998
  type: string;
24945
24999
  };
@@ -24949,6 +25003,7 @@ declare const _default: {
24949
25003
  type: string;
24950
25004
  };
24951
25005
  connected_account_ids: {
25006
+ description: string;
24952
25007
  items: {
24953
25008
  format: string;
24954
25009
  type: string;
@@ -24956,6 +25011,7 @@ declare const _default: {
24956
25011
  type: string;
24957
25012
  };
24958
25013
  created_before: {
25014
+ description: string;
24959
25015
  format: string;
24960
25016
  type: string;
24961
25017
  };
@@ -24965,9 +25021,11 @@ declare const _default: {
24965
25021
  type: string;
24966
25022
  }[];
24967
25023
  };
25024
+ description: string;
24968
25025
  type: string;
24969
25026
  };
24970
25027
  device_ids: {
25028
+ description: string;
24971
25029
  items: {
24972
25030
  format: string;
24973
25031
  type: string;
@@ -24975,12 +25033,14 @@ declare const _default: {
24975
25033
  type: string;
24976
25034
  };
24977
25035
  device_type: {
25036
+ description: string;
24978
25037
  oneOf: {
24979
25038
  enum: string[];
24980
25039
  type: string;
24981
25040
  }[];
24982
25041
  };
24983
25042
  device_types: {
25043
+ description: string;
24984
25044
  items: {
24985
25045
  oneOf: {
24986
25046
  enum: string[];
@@ -24995,6 +25055,7 @@ declare const _default: {
24995
25055
  type: string;
24996
25056
  };
24997
25057
  type: string;
25058
+ 'x-undocumented': string;
24998
25059
  };
24999
25060
  include_if: {
25000
25061
  items: {
@@ -25002,17 +25063,21 @@ declare const _default: {
25002
25063
  type: string;
25003
25064
  };
25004
25065
  type: string;
25066
+ 'x-undocumented': string;
25005
25067
  };
25006
25068
  limit: {
25007
25069
  default: number;
25070
+ description: string;
25008
25071
  format: string;
25009
25072
  type: string;
25010
25073
  };
25011
25074
  manufacturer: {
25075
+ description: string;
25012
25076
  enum: string[];
25013
25077
  type: string;
25014
25078
  };
25015
25079
  user_identifier_key: {
25080
+ description: string;
25016
25081
  type: string;
25017
25082
  };
25018
25083
  };
@@ -25078,6 +25143,7 @@ declare const _default: {
25078
25143
  'x-fern-sdk-method-name': string;
25079
25144
  'x-fern-sdk-return-value': string;
25080
25145
  'x-response-key': string;
25146
+ 'x-title': string;
25081
25147
  };
25082
25148
  };
25083
25149
  '/devices/list_device_providers': {
@@ -25432,6 +25498,7 @@ declare const _default: {
25432
25498
  schema: {
25433
25499
  properties: {
25434
25500
  connect_webview_id: {
25501
+ description: string;
25435
25502
  format: string;
25436
25503
  type: string;
25437
25504
  };
@@ -25441,6 +25508,7 @@ declare const _default: {
25441
25508
  type: string;
25442
25509
  };
25443
25510
  connected_account_ids: {
25511
+ description: string;
25444
25512
  items: {
25445
25513
  format: string;
25446
25514
  type: string;
@@ -25448,6 +25516,7 @@ declare const _default: {
25448
25516
  type: string;
25449
25517
  };
25450
25518
  created_before: {
25519
+ description: string;
25451
25520
  format: string;
25452
25521
  type: string;
25453
25522
  };
@@ -25457,9 +25526,11 @@ declare const _default: {
25457
25526
  type: string;
25458
25527
  }[];
25459
25528
  };
25529
+ description: string;
25460
25530
  type: string;
25461
25531
  };
25462
25532
  device_ids: {
25533
+ description: string;
25463
25534
  items: {
25464
25535
  format: string;
25465
25536
  type: string;
@@ -25467,12 +25538,14 @@ declare const _default: {
25467
25538
  type: string;
25468
25539
  };
25469
25540
  device_type: {
25541
+ description: string;
25470
25542
  oneOf: {
25471
25543
  enum: string[];
25472
25544
  type: string;
25473
25545
  }[];
25474
25546
  };
25475
25547
  device_types: {
25548
+ description: string;
25476
25549
  items: {
25477
25550
  oneOf: {
25478
25551
  enum: string[];
@@ -25487,6 +25560,7 @@ declare const _default: {
25487
25560
  type: string;
25488
25561
  };
25489
25562
  type: string;
25563
+ 'x-undocumented': string;
25490
25564
  };
25491
25565
  include_if: {
25492
25566
  items: {
@@ -25494,17 +25568,21 @@ declare const _default: {
25494
25568
  type: string;
25495
25569
  };
25496
25570
  type: string;
25571
+ 'x-undocumented': string;
25497
25572
  };
25498
25573
  limit: {
25499
25574
  default: number;
25575
+ description: string;
25500
25576
  format: string;
25501
25577
  type: string;
25502
25578
  };
25503
25579
  manufacturer: {
25580
+ description: string;
25504
25581
  enum: string[];
25505
25582
  type: string;
25506
25583
  };
25507
25584
  user_identifier_key: {
25585
+ description: string;
25508
25586
  type: string;
25509
25587
  };
25510
25588
  };
@@ -26203,6 +26281,7 @@ declare const _default: {
26203
26281
  schema: {
26204
26282
  properties: {
26205
26283
  connect_webview_id: {
26284
+ description: string;
26206
26285
  format: string;
26207
26286
  type: string;
26208
26287
  };
@@ -26212,6 +26291,7 @@ declare const _default: {
26212
26291
  type: string;
26213
26292
  };
26214
26293
  connected_account_ids: {
26294
+ description: string;
26215
26295
  items: {
26216
26296
  format: string;
26217
26297
  type: string;
@@ -26219,6 +26299,7 @@ declare const _default: {
26219
26299
  type: string;
26220
26300
  };
26221
26301
  created_before: {
26302
+ description: string;
26222
26303
  format: string;
26223
26304
  type: string;
26224
26305
  };
@@ -26228,9 +26309,11 @@ declare const _default: {
26228
26309
  type: string;
26229
26310
  }[];
26230
26311
  };
26312
+ description: string;
26231
26313
  type: string;
26232
26314
  };
26233
26315
  device_ids: {
26316
+ description: string;
26234
26317
  items: {
26235
26318
  format: string;
26236
26319
  type: string;
@@ -26238,12 +26321,14 @@ declare const _default: {
26238
26321
  type: string;
26239
26322
  };
26240
26323
  device_type: {
26324
+ description: string;
26241
26325
  oneOf: {
26242
26326
  enum: string[];
26243
26327
  type: string;
26244
26328
  }[];
26245
26329
  };
26246
26330
  device_types: {
26331
+ description: string;
26247
26332
  items: {
26248
26333
  oneOf: {
26249
26334
  enum: string[];
@@ -26258,6 +26343,7 @@ declare const _default: {
26258
26343
  type: string;
26259
26344
  };
26260
26345
  type: string;
26346
+ 'x-undocumented': string;
26261
26347
  };
26262
26348
  include_if: {
26263
26349
  items: {
@@ -26265,17 +26351,21 @@ declare const _default: {
26265
26351
  type: string;
26266
26352
  };
26267
26353
  type: string;
26354
+ 'x-undocumented': string;
26268
26355
  };
26269
26356
  limit: {
26270
26357
  default: number;
26358
+ description: string;
26271
26359
  format: string;
26272
26360
  type: string;
26273
26361
  };
26274
26362
  manufacturer: {
26363
+ description: string;
26275
26364
  enum: string[];
26276
26365
  type: string;
26277
26366
  };
26278
26367
  user_identifier_key: {
26368
+ description: string;
26279
26369
  type: string;
26280
26370
  };
26281
26371
  };
@@ -26647,6 +26737,7 @@ declare const _default: {
26647
26737
  schema: {
26648
26738
  properties: {
26649
26739
  connect_webview_id: {
26740
+ description: string;
26650
26741
  format: string;
26651
26742
  type: string;
26652
26743
  };
@@ -26656,6 +26747,7 @@ declare const _default: {
26656
26747
  type: string;
26657
26748
  };
26658
26749
  connected_account_ids: {
26750
+ description: string;
26659
26751
  items: {
26660
26752
  format: string;
26661
26753
  type: string;
@@ -26663,6 +26755,7 @@ declare const _default: {
26663
26755
  type: string;
26664
26756
  };
26665
26757
  created_before: {
26758
+ description: string;
26666
26759
  format: string;
26667
26760
  type: string;
26668
26761
  };
@@ -26672,9 +26765,11 @@ declare const _default: {
26672
26765
  type: string;
26673
26766
  }[];
26674
26767
  };
26768
+ description: string;
26675
26769
  type: string;
26676
26770
  };
26677
26771
  device_ids: {
26772
+ description: string;
26678
26773
  items: {
26679
26774
  format: string;
26680
26775
  type: string;
@@ -26682,12 +26777,14 @@ declare const _default: {
26682
26777
  type: string;
26683
26778
  };
26684
26779
  device_type: {
26780
+ description: string;
26685
26781
  oneOf: {
26686
26782
  enum: string[];
26687
26783
  type: string;
26688
26784
  }[];
26689
26785
  };
26690
26786
  device_types: {
26787
+ description: string;
26691
26788
  items: {
26692
26789
  oneOf: {
26693
26790
  enum: string[];
@@ -26702,6 +26799,7 @@ declare const _default: {
26702
26799
  type: string;
26703
26800
  };
26704
26801
  type: string;
26802
+ 'x-undocumented': string;
26705
26803
  };
26706
26804
  include_if: {
26707
26805
  items: {
@@ -26709,17 +26807,21 @@ declare const _default: {
26709
26807
  type: string;
26710
26808
  };
26711
26809
  type: string;
26810
+ 'x-undocumented': string;
26712
26811
  };
26713
26812
  limit: {
26714
26813
  default: number;
26814
+ description: string;
26715
26815
  format: string;
26716
26816
  type: string;
26717
26817
  };
26718
26818
  manufacturer: {
26819
+ description: string;
26719
26820
  enum: string[];
26720
26821
  type: string;
26721
26822
  };
26722
26823
  user_identifier_key: {
26824
+ description: string;
26723
26825
  type: string;
26724
26826
  };
26725
26827
  };
@@ -27705,6 +27807,7 @@ declare const _default: {
27705
27807
  };
27706
27808
  '/thermostats/activate_climate_preset': {
27707
27809
  post: {
27810
+ description: string;
27708
27811
  operationId: string;
27709
27812
  requestBody: {
27710
27813
  content: {
@@ -27712,9 +27815,11 @@ declare const _default: {
27712
27815
  schema: {
27713
27816
  properties: {
27714
27817
  climate_preset_key: {
27818
+ description: string;
27715
27819
  type: string;
27716
27820
  };
27717
27821
  device_id: {
27822
+ description: string;
27718
27823
  format: string;
27719
27824
  type: string;
27720
27825
  };
@@ -27771,6 +27876,7 @@ declare const _default: {
27771
27876
  'x-fern-sdk-method-name': string;
27772
27877
  'x-fern-sdk-return-value': string;
27773
27878
  'x-response-key': string;
27879
+ 'x-title': string;
27774
27880
  };
27775
27881
  };
27776
27882
  '/thermostats/cool': {
@@ -27800,6 +27906,7 @@ declare const _default: {
27800
27906
  sync: {
27801
27907
  default: boolean;
27802
27908
  type: string;
27909
+ 'x-undocumented': string;
27803
27910
  };
27804
27911
  };
27805
27912
  required: string[];
@@ -27867,6 +27974,7 @@ declare const _default: {
27867
27974
  };
27868
27975
  '/thermostats/create_climate_preset': {
27869
27976
  post: {
27977
+ description: string;
27870
27978
  operationId: string;
27871
27979
  requestBody: {
27872
27980
  content: {
@@ -27874,41 +27982,51 @@ declare const _default: {
27874
27982
  schema: {
27875
27983
  properties: {
27876
27984
  climate_preset_key: {
27985
+ description: string;
27877
27986
  type: string;
27878
27987
  };
27879
27988
  cooling_set_point_celsius: {
27989
+ description: string;
27880
27990
  format: string;
27881
27991
  type: string;
27882
27992
  };
27883
27993
  cooling_set_point_fahrenheit: {
27994
+ description: string;
27884
27995
  format: string;
27885
27996
  type: string;
27886
27997
  };
27887
27998
  device_id: {
27999
+ description: string;
27888
28000
  format: string;
27889
28001
  type: string;
27890
28002
  };
27891
28003
  fan_mode_setting: {
28004
+ description: string;
27892
28005
  enum: string[];
27893
28006
  type: string;
27894
28007
  };
27895
28008
  heating_set_point_celsius: {
28009
+ description: string;
27896
28010
  format: string;
27897
28011
  type: string;
27898
28012
  };
27899
28013
  heating_set_point_fahrenheit: {
28014
+ description: string;
27900
28015
  format: string;
27901
28016
  type: string;
27902
28017
  };
27903
28018
  hvac_mode_setting: {
28019
+ description: string;
27904
28020
  enum: string[];
27905
28021
  type: string;
27906
28022
  };
27907
28023
  manual_override_allowed: {
28024
+ description: string;
27908
28025
  type: string;
27909
28026
  };
27910
28027
  name: {
27911
28028
  default: null;
28029
+ description: string;
27912
28030
  nullable: boolean;
27913
28031
  type: string;
27914
28032
  };
@@ -27961,10 +28079,12 @@ declare const _default: {
27961
28079
  'x-fern-sdk-group-name': string[];
27962
28080
  'x-fern-sdk-method-name': string;
27963
28081
  'x-response-key': null;
28082
+ 'x-title': string;
27964
28083
  };
27965
28084
  };
27966
28085
  '/thermostats/delete_climate_preset': {
27967
28086
  post: {
28087
+ description: string;
27968
28088
  operationId: string;
27969
28089
  requestBody: {
27970
28090
  content: {
@@ -27972,9 +28092,11 @@ declare const _default: {
27972
28092
  schema: {
27973
28093
  properties: {
27974
28094
  climate_preset_key: {
28095
+ description: string;
27975
28096
  type: string;
27976
28097
  };
27977
28098
  device_id: {
28099
+ description: string;
27978
28100
  format: string;
27979
28101
  type: string;
27980
28102
  };
@@ -28027,6 +28149,7 @@ declare const _default: {
28027
28149
  'x-fern-sdk-group-name': string[];
28028
28150
  'x-fern-sdk-method-name': string;
28029
28151
  'x-response-key': null;
28152
+ 'x-title': string;
28030
28153
  };
28031
28154
  };
28032
28155
  '/thermostats/get': {
@@ -28109,6 +28232,7 @@ declare const _default: {
28109
28232
  'x-fern-sdk-return-value': string;
28110
28233
  'x-response-key': string;
28111
28234
  'x-title': string;
28235
+ 'x-undocumented': string;
28112
28236
  };
28113
28237
  };
28114
28238
  '/thermostats/heat': {
@@ -28138,6 +28262,7 @@ declare const _default: {
28138
28262
  sync: {
28139
28263
  default: boolean;
28140
28264
  type: string;
28265
+ 'x-undocumented': string;
28141
28266
  };
28142
28267
  };
28143
28268
  required: string[];
@@ -28240,6 +28365,7 @@ declare const _default: {
28240
28365
  sync: {
28241
28366
  default: boolean;
28242
28367
  type: string;
28368
+ 'x-undocumented': string;
28243
28369
  };
28244
28370
  };
28245
28371
  required: string[];
@@ -28315,6 +28441,7 @@ declare const _default: {
28315
28441
  schema: {
28316
28442
  properties: {
28317
28443
  connect_webview_id: {
28444
+ description: string;
28318
28445
  format: string;
28319
28446
  type: string;
28320
28447
  };
@@ -28324,6 +28451,7 @@ declare const _default: {
28324
28451
  type: string;
28325
28452
  };
28326
28453
  connected_account_ids: {
28454
+ description: string;
28327
28455
  items: {
28328
28456
  format: string;
28329
28457
  type: string;
@@ -28331,6 +28459,7 @@ declare const _default: {
28331
28459
  type: string;
28332
28460
  };
28333
28461
  created_before: {
28462
+ description: string;
28334
28463
  format: string;
28335
28464
  type: string;
28336
28465
  };
@@ -28340,9 +28469,11 @@ declare const _default: {
28340
28469
  type: string;
28341
28470
  }[];
28342
28471
  };
28472
+ description: string;
28343
28473
  type: string;
28344
28474
  };
28345
28475
  device_ids: {
28476
+ description: string;
28346
28477
  items: {
28347
28478
  format: string;
28348
28479
  type: string;
@@ -28350,12 +28481,14 @@ declare const _default: {
28350
28481
  type: string;
28351
28482
  };
28352
28483
  device_type: {
28484
+ description: string;
28353
28485
  oneOf: {
28354
28486
  enum: string[];
28355
28487
  type: string;
28356
28488
  }[];
28357
28489
  };
28358
28490
  device_types: {
28491
+ description: string;
28359
28492
  items: {
28360
28493
  oneOf: {
28361
28494
  enum: string[];
@@ -28370,6 +28503,7 @@ declare const _default: {
28370
28503
  type: string;
28371
28504
  };
28372
28505
  type: string;
28506
+ 'x-undocumented': string;
28373
28507
  };
28374
28508
  include_if: {
28375
28509
  items: {
@@ -28377,17 +28511,21 @@ declare const _default: {
28377
28511
  type: string;
28378
28512
  };
28379
28513
  type: string;
28514
+ 'x-undocumented': string;
28380
28515
  };
28381
28516
  limit: {
28382
28517
  default: number;
28518
+ description: string;
28383
28519
  format: string;
28384
28520
  type: string;
28385
28521
  };
28386
28522
  manufacturer: {
28523
+ description: string;
28387
28524
  enum: string[];
28388
28525
  type: string;
28389
28526
  };
28390
28527
  user_identifier_key: {
28528
+ description: string;
28391
28529
  type: string;
28392
28530
  };
28393
28531
  };
@@ -28479,6 +28617,7 @@ declare const _default: {
28479
28617
  sync: {
28480
28618
  default: boolean;
28481
28619
  type: string;
28620
+ 'x-undocumented': string;
28482
28621
  };
28483
28622
  };
28484
28623
  required: string[];
@@ -28546,6 +28685,7 @@ declare const _default: {
28546
28685
  };
28547
28686
  '/thermostats/schedules/create': {
28548
28687
  post: {
28688
+ description: string;
28549
28689
  operationId: string;
28550
28690
  requestBody: {
28551
28691
  content: {
@@ -28553,23 +28693,29 @@ declare const _default: {
28553
28693
  schema: {
28554
28694
  properties: {
28555
28695
  climate_preset_key: {
28696
+ description: string;
28556
28697
  type: string;
28557
28698
  };
28558
28699
  device_id: {
28700
+ description: string;
28559
28701
  type: string;
28560
28702
  };
28561
28703
  ends_at: {
28704
+ description: string;
28562
28705
  type: string;
28563
28706
  };
28564
28707
  max_override_period_minutes: {
28565
28708
  default: number;
28709
+ description: string;
28566
28710
  minimum: number;
28567
28711
  type: string;
28568
28712
  };
28569
28713
  name: {
28714
+ description: string;
28570
28715
  type: string;
28571
28716
  };
28572
28717
  starts_at: {
28718
+ description: string;
28573
28719
  type: string;
28574
28720
  };
28575
28721
  };
@@ -28633,10 +28779,12 @@ declare const _default: {
28633
28779
  'x-fern-sdk-method-name': string;
28634
28780
  'x-fern-sdk-return-value': string;
28635
28781
  'x-response-key': string;
28782
+ 'x-title': string;
28636
28783
  };
28637
28784
  };
28638
28785
  '/thermostats/schedules/delete': {
28639
28786
  post: {
28787
+ description: string;
28640
28788
  operationId: string;
28641
28789
  requestBody: {
28642
28790
  content: {
@@ -28644,6 +28792,7 @@ declare const _default: {
28644
28792
  schema: {
28645
28793
  properties: {
28646
28794
  thermostat_schedule_id: {
28795
+ description: string;
28647
28796
  format: string;
28648
28797
  type: string;
28649
28798
  };
@@ -28704,10 +28853,12 @@ declare const _default: {
28704
28853
  'x-fern-sdk-group-name': string[];
28705
28854
  'x-fern-sdk-method-name': string;
28706
28855
  'x-response-key': null;
28856
+ 'x-title': string;
28707
28857
  };
28708
28858
  };
28709
28859
  '/thermostats/schedules/get': {
28710
28860
  post: {
28861
+ description: string;
28711
28862
  operationId: string;
28712
28863
  requestBody: {
28713
28864
  content: {
@@ -28715,6 +28866,7 @@ declare const _default: {
28715
28866
  schema: {
28716
28867
  properties: {
28717
28868
  thermostat_schedule_id: {
28869
+ description: string;
28718
28870
  format: string;
28719
28871
  type: string;
28720
28872
  };
@@ -28779,10 +28931,12 @@ declare const _default: {
28779
28931
  'x-fern-sdk-method-name': string;
28780
28932
  'x-fern-sdk-return-value': string;
28781
28933
  'x-response-key': string;
28934
+ 'x-title': string;
28782
28935
  };
28783
28936
  };
28784
28937
  '/thermostats/schedules/list': {
28785
28938
  post: {
28939
+ description: string;
28786
28940
  operationId: string;
28787
28941
  requestBody: {
28788
28942
  content: {
@@ -28790,10 +28944,12 @@ declare const _default: {
28790
28944
  schema: {
28791
28945
  properties: {
28792
28946
  device_id: {
28947
+ description: string;
28793
28948
  format: string;
28794
28949
  type: string;
28795
28950
  };
28796
28951
  user_identifier_key: {
28952
+ description: string;
28797
28953
  type: string;
28798
28954
  };
28799
28955
  };
@@ -28860,10 +29016,12 @@ declare const _default: {
28860
29016
  'x-fern-sdk-method-name': string;
28861
29017
  'x-fern-sdk-return-value': string;
28862
29018
  'x-response-key': string;
29019
+ 'x-title': string;
28863
29020
  };
28864
29021
  };
28865
29022
  '/thermostats/schedules/update': {
28866
29023
  patch: {
29024
+ description: string;
28867
29025
  operationId: string;
28868
29026
  requestBody: {
28869
29027
  content: {
@@ -28871,22 +29029,28 @@ declare const _default: {
28871
29029
  schema: {
28872
29030
  properties: {
28873
29031
  climate_preset_key: {
29032
+ description: string;
28874
29033
  type: string;
28875
29034
  };
28876
29035
  ends_at: {
29036
+ description: string;
28877
29037
  type: string;
28878
29038
  };
28879
29039
  max_override_period_minutes: {
29040
+ description: string;
28880
29041
  minimum: number;
28881
29042
  type: string;
28882
29043
  };
28883
29044
  name: {
29045
+ description: string;
28884
29046
  type: string;
28885
29047
  };
28886
29048
  starts_at: {
29049
+ description: string;
28887
29050
  type: string;
28888
29051
  };
28889
29052
  thermostat_schedule_id: {
29053
+ description: string;
28890
29054
  format: string;
28891
29055
  type: string;
28892
29056
  };
@@ -28946,8 +29110,10 @@ declare const _default: {
28946
29110
  tags: string[];
28947
29111
  'x-fern-ignore': boolean;
28948
29112
  'x-response-key': null;
29113
+ 'x-title': string;
28949
29114
  };
28950
29115
  post: {
29116
+ description: string;
28951
29117
  operationId: string;
28952
29118
  requestBody: {
28953
29119
  content: {
@@ -28955,22 +29121,28 @@ declare const _default: {
28955
29121
  schema: {
28956
29122
  properties: {
28957
29123
  climate_preset_key: {
29124
+ description: string;
28958
29125
  type: string;
28959
29126
  };
28960
29127
  ends_at: {
29128
+ description: string;
28961
29129
  type: string;
28962
29130
  };
28963
29131
  max_override_period_minutes: {
29132
+ description: string;
28964
29133
  minimum: number;
28965
29134
  type: string;
28966
29135
  };
28967
29136
  name: {
29137
+ description: string;
28968
29138
  type: string;
28969
29139
  };
28970
29140
  starts_at: {
29141
+ description: string;
28971
29142
  type: string;
28972
29143
  };
28973
29144
  thermostat_schedule_id: {
29145
+ description: string;
28974
29146
  format: string;
28975
29147
  type: string;
28976
29148
  };
@@ -29031,10 +29203,12 @@ declare const _default: {
29031
29203
  'x-fern-sdk-group-name': string[];
29032
29204
  'x-fern-sdk-method-name': string;
29033
29205
  'x-response-key': null;
29206
+ 'x-title': string;
29034
29207
  };
29035
29208
  };
29036
29209
  '/thermostats/set_fallback_climate_preset': {
29037
29210
  post: {
29211
+ description: string;
29038
29212
  operationId: string;
29039
29213
  requestBody: {
29040
29214
  content: {
@@ -29042,9 +29216,11 @@ declare const _default: {
29042
29216
  schema: {
29043
29217
  properties: {
29044
29218
  climate_preset_key: {
29219
+ description: string;
29045
29220
  type: string;
29046
29221
  };
29047
29222
  device_id: {
29223
+ description: string;
29048
29224
  format: string;
29049
29225
  type: string;
29050
29226
  };
@@ -29097,6 +29273,7 @@ declare const _default: {
29097
29273
  'x-fern-sdk-group-name': string[];
29098
29274
  'x-fern-sdk-method-name': string;
29099
29275
  'x-response-key': null;
29276
+ 'x-title': string;
29100
29277
  };
29101
29278
  };
29102
29279
  '/thermostats/set_fan_mode': {
@@ -29109,7 +29286,6 @@ declare const _default: {
29109
29286
  schema: {
29110
29287
  properties: {
29111
29288
  device_id: {
29112
- description: string;
29113
29289
  format: string;
29114
29290
  type: string;
29115
29291
  };
@@ -29127,6 +29303,7 @@ declare const _default: {
29127
29303
  sync: {
29128
29304
  default: boolean;
29129
29305
  type: string;
29306
+ 'x-undocumented': string;
29130
29307
  };
29131
29308
  };
29132
29309
  required: string[];
@@ -29194,6 +29371,7 @@ declare const _default: {
29194
29371
  };
29195
29372
  '/thermostats/set_temperature_threshold': {
29196
29373
  patch: {
29374
+ description: string;
29197
29375
  operationId: string;
29198
29376
  requestBody: {
29199
29377
  content: {
@@ -29201,29 +29379,34 @@ declare const _default: {
29201
29379
  schema: {
29202
29380
  properties: {
29203
29381
  device_id: {
29382
+ description: string;
29204
29383
  format: string;
29205
29384
  type: string;
29206
29385
  };
29207
29386
  lower_limit_celsius: {
29208
29387
  default: null;
29388
+ description: string;
29209
29389
  format: string;
29210
29390
  nullable: boolean;
29211
29391
  type: string;
29212
29392
  };
29213
29393
  lower_limit_fahrenheit: {
29214
29394
  default: null;
29395
+ description: string;
29215
29396
  format: string;
29216
29397
  nullable: boolean;
29217
29398
  type: string;
29218
29399
  };
29219
29400
  upper_limit_celsius: {
29220
29401
  default: null;
29402
+ description: string;
29221
29403
  format: string;
29222
29404
  nullable: boolean;
29223
29405
  type: string;
29224
29406
  };
29225
29407
  upper_limit_fahrenheit: {
29226
29408
  default: null;
29409
+ description: string;
29227
29410
  format: string;
29228
29411
  nullable: boolean;
29229
29412
  type: string;
@@ -29276,8 +29459,10 @@ declare const _default: {
29276
29459
  tags: string[];
29277
29460
  'x-fern-ignore': boolean;
29278
29461
  'x-response-key': null;
29462
+ 'x-title': string;
29279
29463
  };
29280
29464
  post: {
29465
+ description: string;
29281
29466
  operationId: string;
29282
29467
  requestBody: {
29283
29468
  content: {
@@ -29285,29 +29470,34 @@ declare const _default: {
29285
29470
  schema: {
29286
29471
  properties: {
29287
29472
  device_id: {
29473
+ description: string;
29288
29474
  format: string;
29289
29475
  type: string;
29290
29476
  };
29291
29477
  lower_limit_celsius: {
29292
29478
  default: null;
29479
+ description: string;
29293
29480
  format: string;
29294
29481
  nullable: boolean;
29295
29482
  type: string;
29296
29483
  };
29297
29484
  lower_limit_fahrenheit: {
29298
29485
  default: null;
29486
+ description: string;
29299
29487
  format: string;
29300
29488
  nullable: boolean;
29301
29489
  type: string;
29302
29490
  };
29303
29491
  upper_limit_celsius: {
29304
29492
  default: null;
29493
+ description: string;
29305
29494
  format: string;
29306
29495
  nullable: boolean;
29307
29496
  type: string;
29308
29497
  };
29309
29498
  upper_limit_fahrenheit: {
29310
29499
  default: null;
29500
+ description: string;
29311
29501
  format: string;
29312
29502
  nullable: boolean;
29313
29503
  type: string;
@@ -29361,10 +29551,12 @@ declare const _default: {
29361
29551
  'x-fern-sdk-group-name': string[];
29362
29552
  'x-fern-sdk-method-name': string;
29363
29553
  'x-response-key': null;
29554
+ 'x-title': string;
29364
29555
  };
29365
29556
  };
29366
29557
  '/thermostats/update_climate_preset': {
29367
29558
  patch: {
29559
+ description: string;
29368
29560
  operationId: string;
29369
29561
  requestBody: {
29370
29562
  content: {
@@ -29372,41 +29564,51 @@ declare const _default: {
29372
29564
  schema: {
29373
29565
  properties: {
29374
29566
  climate_preset_key: {
29567
+ description: string;
29375
29568
  type: string;
29376
29569
  };
29377
29570
  cooling_set_point_celsius: {
29571
+ description: string;
29378
29572
  format: string;
29379
29573
  type: string;
29380
29574
  };
29381
29575
  cooling_set_point_fahrenheit: {
29576
+ description: string;
29382
29577
  format: string;
29383
29578
  type: string;
29384
29579
  };
29385
29580
  device_id: {
29581
+ description: string;
29386
29582
  format: string;
29387
29583
  type: string;
29388
29584
  };
29389
29585
  fan_mode_setting: {
29586
+ description: string;
29390
29587
  enum: string[];
29391
29588
  type: string;
29392
29589
  };
29393
29590
  heating_set_point_celsius: {
29591
+ description: string;
29394
29592
  format: string;
29395
29593
  type: string;
29396
29594
  };
29397
29595
  heating_set_point_fahrenheit: {
29596
+ description: string;
29398
29597
  format: string;
29399
29598
  type: string;
29400
29599
  };
29401
29600
  hvac_mode_setting: {
29601
+ description: string;
29402
29602
  enum: string[];
29403
29603
  type: string;
29404
29604
  };
29405
29605
  manual_override_allowed: {
29606
+ description: string;
29406
29607
  type: string;
29407
29608
  };
29408
29609
  name: {
29409
29610
  default: null;
29611
+ description: string;
29410
29612
  nullable: boolean;
29411
29613
  type: string;
29412
29614
  };
@@ -29458,8 +29660,10 @@ declare const _default: {
29458
29660
  tags: string[];
29459
29661
  'x-fern-ignore': boolean;
29460
29662
  'x-response-key': null;
29663
+ 'x-title': string;
29461
29664
  };
29462
29665
  post: {
29666
+ description: string;
29463
29667
  operationId: string;
29464
29668
  requestBody: {
29465
29669
  content: {
@@ -29467,41 +29671,51 @@ declare const _default: {
29467
29671
  schema: {
29468
29672
  properties: {
29469
29673
  climate_preset_key: {
29674
+ description: string;
29470
29675
  type: string;
29471
29676
  };
29472
29677
  cooling_set_point_celsius: {
29678
+ description: string;
29473
29679
  format: string;
29474
29680
  type: string;
29475
29681
  };
29476
29682
  cooling_set_point_fahrenheit: {
29683
+ description: string;
29477
29684
  format: string;
29478
29685
  type: string;
29479
29686
  };
29480
29687
  device_id: {
29688
+ description: string;
29481
29689
  format: string;
29482
29690
  type: string;
29483
29691
  };
29484
29692
  fan_mode_setting: {
29693
+ description: string;
29485
29694
  enum: string[];
29486
29695
  type: string;
29487
29696
  };
29488
29697
  heating_set_point_celsius: {
29698
+ description: string;
29489
29699
  format: string;
29490
29700
  type: string;
29491
29701
  };
29492
29702
  heating_set_point_fahrenheit: {
29703
+ description: string;
29493
29704
  format: string;
29494
29705
  type: string;
29495
29706
  };
29496
29707
  hvac_mode_setting: {
29708
+ description: string;
29497
29709
  enum: string[];
29498
29710
  type: string;
29499
29711
  };
29500
29712
  manual_override_allowed: {
29713
+ description: string;
29501
29714
  type: string;
29502
29715
  };
29503
29716
  name: {
29504
29717
  default: null;
29718
+ description: string;
29505
29719
  nullable: boolean;
29506
29720
  type: string;
29507
29721
  };
@@ -29554,6 +29768,7 @@ declare const _default: {
29554
29768
  'x-fern-sdk-group-name': string[];
29555
29769
  'x-fern-sdk-method-name': string;
29556
29770
  'x-response-key': null;
29771
+ 'x-title': string;
29557
29772
  };
29558
29773
  };
29559
29774
  '/user_identities/add_acs_user': {
@@ -37590,60 +37805,104 @@ interface Routes {
37590
37805
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37591
37806
  is_temporary_manual_override_active?: boolean | undefined;
37592
37807
  current_climate_setting?: {
37808
+ /** Unique key to identify the climate preset. */
37593
37809
  climate_preset_key?: string | undefined;
37810
+ /** Indicates whether this climate preset key can be edited. */
37594
37811
  can_edit?: boolean | undefined;
37812
+ /** Indicates whether this climate preset key can be deleted. */
37595
37813
  can_delete?: boolean | undefined;
37814
+ /** User-friendly name to identify the climate preset. */
37596
37815
  name?: ((string | null) | undefined) | undefined;
37816
+ /** Display name for the climate preset. */
37597
37817
  display_name?: string | undefined;
37818
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37598
37819
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37820
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37599
37821
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37822
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37600
37823
  cooling_set_point_celsius?: (number | undefined) | undefined;
37824
+ /** Temperature to which the thermostat should heat (in °C). */
37601
37825
  heating_set_point_celsius?: (number | undefined) | undefined;
37826
+ /** Temperature to which the thermostat should cool (in °F). */
37602
37827
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37828
+ /** Temperature to which the thermostat should heat (in °F). */
37603
37829
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
37830
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37604
37831
  manual_override_allowed?: boolean | undefined;
37605
37832
  } | undefined;
37606
37833
  /**
37607
37834
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
37608
37835
  default_climate_setting?: {
37836
+ /** Unique key to identify the climate preset. */
37609
37837
  climate_preset_key?: string | undefined;
37838
+ /** Indicates whether this climate preset key can be edited. */
37610
37839
  can_edit?: boolean | undefined;
37840
+ /** Indicates whether this climate preset key can be deleted. */
37611
37841
  can_delete?: boolean | undefined;
37842
+ /** User-friendly name to identify the climate preset. */
37612
37843
  name?: ((string | null) | undefined) | undefined;
37844
+ /** Display name for the climate preset. */
37613
37845
  display_name?: string | undefined;
37846
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37614
37847
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37848
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37615
37849
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37850
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37616
37851
  cooling_set_point_celsius?: (number | undefined) | undefined;
37852
+ /** Temperature to which the thermostat should heat (in °C). */
37617
37853
  heating_set_point_celsius?: (number | undefined) | undefined;
37854
+ /** Temperature to which the thermostat should cool (in °F). */
37618
37855
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37856
+ /** Temperature to which the thermostat should heat (in °F). */
37619
37857
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
37858
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37620
37859
  manual_override_allowed?: boolean | undefined;
37621
37860
  } | undefined;
37622
37861
  available_climate_presets?: Array<{
37862
+ /** Unique key to identify the climate preset. */
37623
37863
  climate_preset_key: string;
37864
+ /** Indicates whether this climate preset key can be edited. */
37624
37865
  can_edit: boolean;
37866
+ /** Indicates whether this climate preset key can be deleted. */
37625
37867
  can_delete: boolean;
37868
+ /** User-friendly name to identify the climate preset. */
37626
37869
  name?: (string | null) | undefined;
37870
+ /** Display name for the climate preset. */
37627
37871
  display_name: string;
37872
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37628
37873
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37874
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37629
37875
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
37876
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37630
37877
  cooling_set_point_celsius?: number | undefined;
37878
+ /** Temperature to which the thermostat should heat (in °C). */
37631
37879
  heating_set_point_celsius?: number | undefined;
37880
+ /** Temperature to which the thermostat should cool (in °F). */
37632
37881
  cooling_set_point_fahrenheit?: number | undefined;
37882
+ /** Temperature to which the thermostat should heat (in °F). */
37633
37883
  heating_set_point_fahrenheit?: number | undefined;
37884
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37634
37885
  manual_override_allowed: boolean;
37635
37886
  }> | undefined;
37636
37887
  fallback_climate_preset_key?: (string | null) | undefined;
37637
37888
  active_thermostat_schedule?: ({
37889
+ /** ID of the climate schedule. */
37638
37890
  thermostat_schedule_id: string;
37891
+ /** ID of the desired thermostat device. */
37639
37892
  device_id: string;
37893
+ /** User-friendly name to identify the climate schedule. */
37640
37894
  name?: string | undefined;
37895
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
37641
37896
  climate_preset_key: string;
37897
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
37642
37898
  max_override_period_minutes: number;
37899
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37643
37900
  starts_at: string;
37901
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37644
37902
  ends_at: string;
37903
+ /** Date and time at which the climate schedule was created. */
37645
37904
  created_at: string;
37646
- /** 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. */
37905
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
37647
37906
  errors?: any;
37648
37907
  } | null) | undefined;
37649
37908
  min_cooling_set_point_celsius?: number | undefined;
@@ -41930,60 +42189,104 @@ interface Routes {
41930
42189
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
41931
42190
  is_temporary_manual_override_active?: boolean | undefined;
41932
42191
  current_climate_setting?: {
42192
+ /** Unique key to identify the climate preset. */
41933
42193
  climate_preset_key?: string | undefined;
42194
+ /** Indicates whether this climate preset key can be edited. */
41934
42195
  can_edit?: boolean | undefined;
42196
+ /** Indicates whether this climate preset key can be deleted. */
41935
42197
  can_delete?: boolean | undefined;
42198
+ /** User-friendly name to identify the climate preset. */
41936
42199
  name?: ((string | null) | undefined) | undefined;
42200
+ /** Display name for the climate preset. */
41937
42201
  display_name?: string | undefined;
42202
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41938
42203
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42204
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41939
42205
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42206
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41940
42207
  cooling_set_point_celsius?: (number | undefined) | undefined;
42208
+ /** Temperature to which the thermostat should heat (in °C). */
41941
42209
  heating_set_point_celsius?: (number | undefined) | undefined;
42210
+ /** Temperature to which the thermostat should cool (in °F). */
41942
42211
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42212
+ /** Temperature to which the thermostat should heat (in °F). */
41943
42213
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42214
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41944
42215
  manual_override_allowed?: boolean | undefined;
41945
42216
  } | undefined;
41946
42217
  /**
41947
42218
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
41948
42219
  default_climate_setting?: {
42220
+ /** Unique key to identify the climate preset. */
41949
42221
  climate_preset_key?: string | undefined;
42222
+ /** Indicates whether this climate preset key can be edited. */
41950
42223
  can_edit?: boolean | undefined;
42224
+ /** Indicates whether this climate preset key can be deleted. */
41951
42225
  can_delete?: boolean | undefined;
42226
+ /** User-friendly name to identify the climate preset. */
41952
42227
  name?: ((string | null) | undefined) | undefined;
42228
+ /** Display name for the climate preset. */
41953
42229
  display_name?: string | undefined;
42230
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41954
42231
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42232
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41955
42233
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42234
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41956
42235
  cooling_set_point_celsius?: (number | undefined) | undefined;
42236
+ /** Temperature to which the thermostat should heat (in °C). */
41957
42237
  heating_set_point_celsius?: (number | undefined) | undefined;
42238
+ /** Temperature to which the thermostat should cool (in °F). */
41958
42239
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42240
+ /** Temperature to which the thermostat should heat (in °F). */
41959
42241
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42242
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41960
42243
  manual_override_allowed?: boolean | undefined;
41961
42244
  } | undefined;
41962
42245
  available_climate_presets?: Array<{
42246
+ /** Unique key to identify the climate preset. */
41963
42247
  climate_preset_key: string;
42248
+ /** Indicates whether this climate preset key can be edited. */
41964
42249
  can_edit: boolean;
42250
+ /** Indicates whether this climate preset key can be deleted. */
41965
42251
  can_delete: boolean;
42252
+ /** User-friendly name to identify the climate preset. */
41966
42253
  name?: (string | null) | undefined;
42254
+ /** Display name for the climate preset. */
41967
42255
  display_name: string;
42256
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41968
42257
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42258
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41969
42259
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
42260
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41970
42261
  cooling_set_point_celsius?: number | undefined;
42262
+ /** Temperature to which the thermostat should heat (in °C). */
41971
42263
  heating_set_point_celsius?: number | undefined;
42264
+ /** Temperature to which the thermostat should cool (in °F). */
41972
42265
  cooling_set_point_fahrenheit?: number | undefined;
42266
+ /** Temperature to which the thermostat should heat (in °F). */
41973
42267
  heating_set_point_fahrenheit?: number | undefined;
42268
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41974
42269
  manual_override_allowed: boolean;
41975
42270
  }> | undefined;
41976
42271
  fallback_climate_preset_key?: (string | null) | undefined;
41977
42272
  active_thermostat_schedule?: ({
42273
+ /** ID of the climate schedule. */
41978
42274
  thermostat_schedule_id: string;
42275
+ /** ID of the desired thermostat device. */
41979
42276
  device_id: string;
42277
+ /** User-friendly name to identify the climate schedule. */
41980
42278
  name?: string | undefined;
42279
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
41981
42280
  climate_preset_key: string;
42281
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
41982
42282
  max_override_period_minutes: number;
42283
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41983
42284
  starts_at: string;
42285
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41984
42286
  ends_at: string;
42287
+ /** Date and time at which the climate schedule was created. */
41985
42288
  created_at: string;
41986
- /** 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. */
42289
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
41987
42290
  errors?: any;
41988
42291
  } | null) | undefined;
41989
42292
  min_cooling_set_point_celsius?: number | undefined;
@@ -42054,19 +42357,31 @@ interface Routes {
42054
42357
  queryParams: {};
42055
42358
  jsonBody: {};
42056
42359
  commonParams: {
42057
- /** List all devices owned by this connected account */
42360
+ /** ID of the connected account by which to filter. */
42058
42361
  connected_account_id?: string | undefined;
42362
+ /** Array of IDs of the connected accounts by which to filter devices. */
42059
42363
  connected_account_ids?: string[] | undefined;
42364
+ /** ID of the Connect Webview by which to filter devices. */
42060
42365
  connect_webview_id?: string | undefined;
42366
+ /** Device type by which to filter devices. */
42061
42367
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
42368
+ /** Array of device types by which to filter devices. */
42062
42369
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
42370
+ /** Manufacturer by which to filter devices. */
42063
42371
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
42372
+ /** Array of device IDs by which to filter devices. */
42064
42373
  device_ids?: string[] | undefined;
42374
+ /** Numerical limit on the number of devices to return. */
42065
42375
  limit?: number;
42376
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
42066
42377
  created_before?: Date | undefined;
42378
+ /** Your own internal user ID for the user by which to filter devices. */
42067
42379
  user_identifier_key?: string | undefined;
42380
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
42068
42381
  custom_metadata_has?: Record<string, string | boolean> | undefined;
42382
+ /** */
42069
42383
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42384
+ /** */
42070
42385
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42071
42386
  };
42072
42387
  formData: {};
@@ -42418,60 +42733,104 @@ interface Routes {
42418
42733
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42419
42734
  is_temporary_manual_override_active?: boolean | undefined;
42420
42735
  current_climate_setting?: {
42736
+ /** Unique key to identify the climate preset. */
42421
42737
  climate_preset_key?: string | undefined;
42738
+ /** Indicates whether this climate preset key can be edited. */
42422
42739
  can_edit?: boolean | undefined;
42740
+ /** Indicates whether this climate preset key can be deleted. */
42423
42741
  can_delete?: boolean | undefined;
42742
+ /** User-friendly name to identify the climate preset. */
42424
42743
  name?: ((string | null) | undefined) | undefined;
42744
+ /** Display name for the climate preset. */
42425
42745
  display_name?: string | undefined;
42746
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42426
42747
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42748
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42427
42749
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42750
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42428
42751
  cooling_set_point_celsius?: (number | undefined) | undefined;
42752
+ /** Temperature to which the thermostat should heat (in °C). */
42429
42753
  heating_set_point_celsius?: (number | undefined) | undefined;
42754
+ /** Temperature to which the thermostat should cool (in °F). */
42430
42755
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42756
+ /** Temperature to which the thermostat should heat (in °F). */
42431
42757
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42758
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42432
42759
  manual_override_allowed?: boolean | undefined;
42433
42760
  } | undefined;
42434
42761
  /**
42435
42762
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
42436
42763
  default_climate_setting?: {
42764
+ /** Unique key to identify the climate preset. */
42437
42765
  climate_preset_key?: string | undefined;
42766
+ /** Indicates whether this climate preset key can be edited. */
42438
42767
  can_edit?: boolean | undefined;
42768
+ /** Indicates whether this climate preset key can be deleted. */
42439
42769
  can_delete?: boolean | undefined;
42770
+ /** User-friendly name to identify the climate preset. */
42440
42771
  name?: ((string | null) | undefined) | undefined;
42772
+ /** Display name for the climate preset. */
42441
42773
  display_name?: string | undefined;
42774
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42442
42775
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42776
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42443
42777
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42778
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42444
42779
  cooling_set_point_celsius?: (number | undefined) | undefined;
42780
+ /** Temperature to which the thermostat should heat (in °C). */
42445
42781
  heating_set_point_celsius?: (number | undefined) | undefined;
42782
+ /** Temperature to which the thermostat should cool (in °F). */
42446
42783
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42784
+ /** Temperature to which the thermostat should heat (in °F). */
42447
42785
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42786
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42448
42787
  manual_override_allowed?: boolean | undefined;
42449
42788
  } | undefined;
42450
42789
  available_climate_presets?: Array<{
42790
+ /** Unique key to identify the climate preset. */
42451
42791
  climate_preset_key: string;
42792
+ /** Indicates whether this climate preset key can be edited. */
42452
42793
  can_edit: boolean;
42794
+ /** Indicates whether this climate preset key can be deleted. */
42453
42795
  can_delete: boolean;
42796
+ /** User-friendly name to identify the climate preset. */
42454
42797
  name?: (string | null) | undefined;
42798
+ /** Display name for the climate preset. */
42455
42799
  display_name: string;
42800
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42456
42801
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42802
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42457
42803
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
42804
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42458
42805
  cooling_set_point_celsius?: number | undefined;
42806
+ /** Temperature to which the thermostat should heat (in °C). */
42459
42807
  heating_set_point_celsius?: number | undefined;
42808
+ /** Temperature to which the thermostat should cool (in °F). */
42460
42809
  cooling_set_point_fahrenheit?: number | undefined;
42810
+ /** Temperature to which the thermostat should heat (in °F). */
42461
42811
  heating_set_point_fahrenheit?: number | undefined;
42812
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42462
42813
  manual_override_allowed: boolean;
42463
42814
  }> | undefined;
42464
42815
  fallback_climate_preset_key?: (string | null) | undefined;
42465
42816
  active_thermostat_schedule?: ({
42817
+ /** ID of the climate schedule. */
42466
42818
  thermostat_schedule_id: string;
42819
+ /** ID of the desired thermostat device. */
42467
42820
  device_id: string;
42821
+ /** User-friendly name to identify the climate schedule. */
42468
42822
  name?: string | undefined;
42823
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
42469
42824
  climate_preset_key: string;
42825
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
42470
42826
  max_override_period_minutes: number;
42827
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42471
42828
  starts_at: string;
42829
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42472
42830
  ends_at: string;
42831
+ /** Date and time at which the climate schedule was created. */
42473
42832
  created_at: string;
42474
- /** 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. */
42833
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
42475
42834
  errors?: any;
42476
42835
  } | null) | undefined;
42477
42836
  min_cooling_set_point_celsius?: number | undefined;
@@ -42715,19 +43074,31 @@ interface Routes {
42715
43074
  queryParams: {};
42716
43075
  jsonBody: {};
42717
43076
  commonParams: {
42718
- /** List all devices owned by this connected account */
43077
+ /** ID of the connected account by which to filter. */
42719
43078
  connected_account_id?: string | undefined;
43079
+ /** Array of IDs of the connected accounts by which to filter devices. */
42720
43080
  connected_account_ids?: string[] | undefined;
43081
+ /** ID of the Connect Webview by which to filter devices. */
42721
43082
  connect_webview_id?: string | undefined;
43083
+ /** Device type by which to filter devices. */
42722
43084
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
43085
+ /** Array of device types by which to filter devices. */
42723
43086
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
43087
+ /** Manufacturer by which to filter devices. */
42724
43088
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
43089
+ /** Array of device IDs by which to filter devices. */
42725
43090
  device_ids?: string[] | undefined;
43091
+ /** Numerical limit on the number of devices to return. */
42726
43092
  limit?: number;
43093
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
42727
43094
  created_before?: Date | undefined;
43095
+ /** Your own internal user ID for the user by which to filter devices. */
42728
43096
  user_identifier_key?: string | undefined;
43097
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
42729
43098
  custom_metadata_has?: Record<string, string | boolean> | undefined;
43099
+ /** */
42730
43100
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
43101
+ /** */
42731
43102
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42732
43103
  };
42733
43104
  formData: {};
@@ -43309,60 +43680,104 @@ interface Routes {
43309
43680
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43310
43681
  is_temporary_manual_override_active?: boolean | undefined;
43311
43682
  current_climate_setting?: {
43683
+ /** Unique key to identify the climate preset. */
43312
43684
  climate_preset_key?: string | undefined;
43685
+ /** Indicates whether this climate preset key can be edited. */
43313
43686
  can_edit?: boolean | undefined;
43687
+ /** Indicates whether this climate preset key can be deleted. */
43314
43688
  can_delete?: boolean | undefined;
43689
+ /** User-friendly name to identify the climate preset. */
43315
43690
  name?: ((string | null) | undefined) | undefined;
43691
+ /** Display name for the climate preset. */
43316
43692
  display_name?: string | undefined;
43693
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43317
43694
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
43695
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43318
43696
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
43697
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43319
43698
  cooling_set_point_celsius?: (number | undefined) | undefined;
43699
+ /** Temperature to which the thermostat should heat (in °C). */
43320
43700
  heating_set_point_celsius?: (number | undefined) | undefined;
43701
+ /** Temperature to which the thermostat should cool (in °F). */
43321
43702
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
43703
+ /** Temperature to which the thermostat should heat (in °F). */
43322
43704
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
43705
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43323
43706
  manual_override_allowed?: boolean | undefined;
43324
43707
  } | undefined;
43325
43708
  /**
43326
43709
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
43327
43710
  default_climate_setting?: {
43711
+ /** Unique key to identify the climate preset. */
43328
43712
  climate_preset_key?: string | undefined;
43713
+ /** Indicates whether this climate preset key can be edited. */
43329
43714
  can_edit?: boolean | undefined;
43715
+ /** Indicates whether this climate preset key can be deleted. */
43330
43716
  can_delete?: boolean | undefined;
43717
+ /** User-friendly name to identify the climate preset. */
43331
43718
  name?: ((string | null) | undefined) | undefined;
43719
+ /** Display name for the climate preset. */
43332
43720
  display_name?: string | undefined;
43721
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43333
43722
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
43723
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43334
43724
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
43725
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43335
43726
  cooling_set_point_celsius?: (number | undefined) | undefined;
43727
+ /** Temperature to which the thermostat should heat (in °C). */
43336
43728
  heating_set_point_celsius?: (number | undefined) | undefined;
43729
+ /** Temperature to which the thermostat should cool (in °F). */
43337
43730
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
43731
+ /** Temperature to which the thermostat should heat (in °F). */
43338
43732
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
43733
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43339
43734
  manual_override_allowed?: boolean | undefined;
43340
43735
  } | undefined;
43341
43736
  available_climate_presets?: Array<{
43737
+ /** Unique key to identify the climate preset. */
43342
43738
  climate_preset_key: string;
43739
+ /** Indicates whether this climate preset key can be edited. */
43343
43740
  can_edit: boolean;
43741
+ /** Indicates whether this climate preset key can be deleted. */
43344
43742
  can_delete: boolean;
43743
+ /** User-friendly name to identify the climate preset. */
43345
43744
  name?: (string | null) | undefined;
43745
+ /** Display name for the climate preset. */
43346
43746
  display_name: string;
43747
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43347
43748
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43749
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43348
43750
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
43751
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43349
43752
  cooling_set_point_celsius?: number | undefined;
43753
+ /** Temperature to which the thermostat should heat (in °C). */
43350
43754
  heating_set_point_celsius?: number | undefined;
43755
+ /** Temperature to which the thermostat should cool (in °F). */
43351
43756
  cooling_set_point_fahrenheit?: number | undefined;
43757
+ /** Temperature to which the thermostat should heat (in °F). */
43352
43758
  heating_set_point_fahrenheit?: number | undefined;
43759
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43353
43760
  manual_override_allowed: boolean;
43354
43761
  }> | undefined;
43355
43762
  fallback_climate_preset_key?: (string | null) | undefined;
43356
43763
  active_thermostat_schedule?: ({
43764
+ /** ID of the climate schedule. */
43357
43765
  thermostat_schedule_id: string;
43766
+ /** ID of the desired thermostat device. */
43358
43767
  device_id: string;
43768
+ /** User-friendly name to identify the climate schedule. */
43359
43769
  name?: string | undefined;
43770
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43360
43771
  climate_preset_key: string;
43772
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
43361
43773
  max_override_period_minutes: number;
43774
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43362
43775
  starts_at: string;
43776
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43363
43777
  ends_at: string;
43778
+ /** Date and time at which the climate schedule was created. */
43364
43779
  created_at: string;
43365
- /** 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. */
43780
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
43366
43781
  errors?: any;
43367
43782
  } | null) | undefined;
43368
43783
  min_cooling_set_point_celsius?: number | undefined;
@@ -43772,60 +44187,104 @@ interface Routes {
43772
44187
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43773
44188
  is_temporary_manual_override_active?: boolean | undefined;
43774
44189
  current_climate_setting?: {
44190
+ /** Unique key to identify the climate preset. */
43775
44191
  climate_preset_key?: string | undefined;
44192
+ /** Indicates whether this climate preset key can be edited. */
43776
44193
  can_edit?: boolean | undefined;
44194
+ /** Indicates whether this climate preset key can be deleted. */
43777
44195
  can_delete?: boolean | undefined;
44196
+ /** User-friendly name to identify the climate preset. */
43778
44197
  name?: ((string | null) | undefined) | undefined;
44198
+ /** Display name for the climate preset. */
43779
44199
  display_name?: string | undefined;
44200
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43780
44201
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44202
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43781
44203
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44204
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43782
44205
  cooling_set_point_celsius?: (number | undefined) | undefined;
44206
+ /** Temperature to which the thermostat should heat (in °C). */
43783
44207
  heating_set_point_celsius?: (number | undefined) | undefined;
44208
+ /** Temperature to which the thermostat should cool (in °F). */
43784
44209
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44210
+ /** Temperature to which the thermostat should heat (in °F). */
43785
44211
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44212
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43786
44213
  manual_override_allowed?: boolean | undefined;
43787
44214
  } | undefined;
43788
44215
  /**
43789
44216
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
43790
44217
  default_climate_setting?: {
44218
+ /** Unique key to identify the climate preset. */
43791
44219
  climate_preset_key?: string | undefined;
44220
+ /** Indicates whether this climate preset key can be edited. */
43792
44221
  can_edit?: boolean | undefined;
44222
+ /** Indicates whether this climate preset key can be deleted. */
43793
44223
  can_delete?: boolean | undefined;
44224
+ /** User-friendly name to identify the climate preset. */
43794
44225
  name?: ((string | null) | undefined) | undefined;
44226
+ /** Display name for the climate preset. */
43795
44227
  display_name?: string | undefined;
44228
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43796
44229
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44230
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43797
44231
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44232
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43798
44233
  cooling_set_point_celsius?: (number | undefined) | undefined;
44234
+ /** Temperature to which the thermostat should heat (in °C). */
43799
44235
  heating_set_point_celsius?: (number | undefined) | undefined;
44236
+ /** Temperature to which the thermostat should cool (in °F). */
43800
44237
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44238
+ /** Temperature to which the thermostat should heat (in °F). */
43801
44239
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44240
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43802
44241
  manual_override_allowed?: boolean | undefined;
43803
44242
  } | undefined;
43804
44243
  available_climate_presets?: Array<{
44244
+ /** Unique key to identify the climate preset. */
43805
44245
  climate_preset_key: string;
44246
+ /** Indicates whether this climate preset key can be edited. */
43806
44247
  can_edit: boolean;
44248
+ /** Indicates whether this climate preset key can be deleted. */
43807
44249
  can_delete: boolean;
44250
+ /** User-friendly name to identify the climate preset. */
43808
44251
  name?: (string | null) | undefined;
44252
+ /** Display name for the climate preset. */
43809
44253
  display_name: string;
44254
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43810
44255
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44256
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43811
44257
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
44258
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43812
44259
  cooling_set_point_celsius?: number | undefined;
44260
+ /** Temperature to which the thermostat should heat (in °C). */
43813
44261
  heating_set_point_celsius?: number | undefined;
44262
+ /** Temperature to which the thermostat should cool (in °F). */
43814
44263
  cooling_set_point_fahrenheit?: number | undefined;
44264
+ /** Temperature to which the thermostat should heat (in °F). */
43815
44265
  heating_set_point_fahrenheit?: number | undefined;
44266
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43816
44267
  manual_override_allowed: boolean;
43817
44268
  }> | undefined;
43818
44269
  fallback_climate_preset_key?: (string | null) | undefined;
43819
44270
  active_thermostat_schedule?: ({
44271
+ /** ID of the climate schedule. */
43820
44272
  thermostat_schedule_id: string;
44273
+ /** ID of the desired thermostat device. */
43821
44274
  device_id: string;
44275
+ /** User-friendly name to identify the climate schedule. */
43822
44276
  name?: string | undefined;
44277
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43823
44278
  climate_preset_key: string;
44279
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
43824
44280
  max_override_period_minutes: number;
44281
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43825
44282
  starts_at: string;
44283
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43826
44284
  ends_at: string;
44285
+ /** Date and time at which the climate schedule was created. */
43827
44286
  created_at: string;
43828
- /** 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. */
44287
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
43829
44288
  errors?: any;
43830
44289
  } | null) | undefined;
43831
44290
  min_cooling_set_point_celsius?: number | undefined;
@@ -43896,19 +44355,31 @@ interface Routes {
43896
44355
  queryParams: {};
43897
44356
  jsonBody: {};
43898
44357
  commonParams: {
43899
- /** List all devices owned by this connected account */
44358
+ /** ID of the connected account by which to filter. */
43900
44359
  connected_account_id?: string | undefined;
44360
+ /** Array of IDs of the connected accounts by which to filter devices. */
43901
44361
  connected_account_ids?: string[] | undefined;
44362
+ /** ID of the Connect Webview by which to filter devices. */
43902
44363
  connect_webview_id?: string | undefined;
44364
+ /** Device type by which to filter devices. */
43903
44365
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
44366
+ /** Array of device types by which to filter devices. */
43904
44367
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
44368
+ /** Manufacturer by which to filter devices. */
43905
44369
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
44370
+ /** Array of device IDs by which to filter devices. */
43906
44371
  device_ids?: string[] | undefined;
44372
+ /** Numerical limit on the number of devices to return. */
43907
44373
  limit?: number;
44374
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
43908
44375
  created_before?: Date | undefined;
44376
+ /** Your own internal user ID for the user by which to filter devices. */
43909
44377
  user_identifier_key?: string | undefined;
44378
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
43910
44379
  custom_metadata_has?: Record<string, string | boolean> | undefined;
44380
+ /** */
43911
44381
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
44382
+ /** */
43912
44383
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
43913
44384
  };
43914
44385
  formData: {};
@@ -44260,60 +44731,104 @@ interface Routes {
44260
44731
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44261
44732
  is_temporary_manual_override_active?: boolean | undefined;
44262
44733
  current_climate_setting?: {
44734
+ /** Unique key to identify the climate preset. */
44263
44735
  climate_preset_key?: string | undefined;
44736
+ /** Indicates whether this climate preset key can be edited. */
44264
44737
  can_edit?: boolean | undefined;
44738
+ /** Indicates whether this climate preset key can be deleted. */
44265
44739
  can_delete?: boolean | undefined;
44740
+ /** User-friendly name to identify the climate preset. */
44266
44741
  name?: ((string | null) | undefined) | undefined;
44742
+ /** Display name for the climate preset. */
44267
44743
  display_name?: string | undefined;
44744
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44268
44745
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44746
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44269
44747
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44748
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44270
44749
  cooling_set_point_celsius?: (number | undefined) | undefined;
44750
+ /** Temperature to which the thermostat should heat (in °C). */
44271
44751
  heating_set_point_celsius?: (number | undefined) | undefined;
44752
+ /** Temperature to which the thermostat should cool (in °F). */
44272
44753
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44754
+ /** Temperature to which the thermostat should heat (in °F). */
44273
44755
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44756
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44274
44757
  manual_override_allowed?: boolean | undefined;
44275
44758
  } | undefined;
44276
44759
  /**
44277
44760
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
44278
44761
  default_climate_setting?: {
44762
+ /** Unique key to identify the climate preset. */
44279
44763
  climate_preset_key?: string | undefined;
44764
+ /** Indicates whether this climate preset key can be edited. */
44280
44765
  can_edit?: boolean | undefined;
44766
+ /** Indicates whether this climate preset key can be deleted. */
44281
44767
  can_delete?: boolean | undefined;
44768
+ /** User-friendly name to identify the climate preset. */
44282
44769
  name?: ((string | null) | undefined) | undefined;
44770
+ /** Display name for the climate preset. */
44283
44771
  display_name?: string | undefined;
44772
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44284
44773
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44774
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44285
44775
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44776
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44286
44777
  cooling_set_point_celsius?: (number | undefined) | undefined;
44778
+ /** Temperature to which the thermostat should heat (in °C). */
44287
44779
  heating_set_point_celsius?: (number | undefined) | undefined;
44780
+ /** Temperature to which the thermostat should cool (in °F). */
44288
44781
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44782
+ /** Temperature to which the thermostat should heat (in °F). */
44289
44783
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44784
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44290
44785
  manual_override_allowed?: boolean | undefined;
44291
44786
  } | undefined;
44292
44787
  available_climate_presets?: Array<{
44788
+ /** Unique key to identify the climate preset. */
44293
44789
  climate_preset_key: string;
44790
+ /** Indicates whether this climate preset key can be edited. */
44294
44791
  can_edit: boolean;
44792
+ /** Indicates whether this climate preset key can be deleted. */
44295
44793
  can_delete: boolean;
44794
+ /** User-friendly name to identify the climate preset. */
44296
44795
  name?: (string | null) | undefined;
44796
+ /** Display name for the climate preset. */
44297
44797
  display_name: string;
44798
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44298
44799
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44800
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44299
44801
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
44802
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44300
44803
  cooling_set_point_celsius?: number | undefined;
44804
+ /** Temperature to which the thermostat should heat (in °C). */
44301
44805
  heating_set_point_celsius?: number | undefined;
44806
+ /** Temperature to which the thermostat should cool (in °F). */
44302
44807
  cooling_set_point_fahrenheit?: number | undefined;
44808
+ /** Temperature to which the thermostat should heat (in °F). */
44303
44809
  heating_set_point_fahrenheit?: number | undefined;
44810
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44304
44811
  manual_override_allowed: boolean;
44305
44812
  }> | undefined;
44306
44813
  fallback_climate_preset_key?: (string | null) | undefined;
44307
44814
  active_thermostat_schedule?: ({
44815
+ /** ID of the climate schedule. */
44308
44816
  thermostat_schedule_id: string;
44817
+ /** ID of the desired thermostat device. */
44309
44818
  device_id: string;
44819
+ /** User-friendly name to identify the climate schedule. */
44310
44820
  name?: string | undefined;
44821
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44311
44822
  climate_preset_key: string;
44823
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
44312
44824
  max_override_period_minutes: number;
44825
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44313
44826
  starts_at: string;
44827
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44314
44828
  ends_at: string;
44829
+ /** Date and time at which the climate schedule was created. */
44315
44830
  created_at: string;
44316
- /** 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. */
44831
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
44317
44832
  errors?: any;
44318
44833
  } | null) | undefined;
44319
44834
  min_cooling_set_point_celsius?: number | undefined;
@@ -44723,60 +45238,104 @@ interface Routes {
44723
45238
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44724
45239
  is_temporary_manual_override_active?: boolean | undefined;
44725
45240
  current_climate_setting?: {
45241
+ /** Unique key to identify the climate preset. */
44726
45242
  climate_preset_key?: string | undefined;
45243
+ /** Indicates whether this climate preset key can be edited. */
44727
45244
  can_edit?: boolean | undefined;
45245
+ /** Indicates whether this climate preset key can be deleted. */
44728
45246
  can_delete?: boolean | undefined;
45247
+ /** User-friendly name to identify the climate preset. */
44729
45248
  name?: ((string | null) | undefined) | undefined;
45249
+ /** Display name for the climate preset. */
44730
45250
  display_name?: string | undefined;
45251
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44731
45252
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
45253
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44732
45254
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
45255
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44733
45256
  cooling_set_point_celsius?: (number | undefined) | undefined;
45257
+ /** Temperature to which the thermostat should heat (in °C). */
44734
45258
  heating_set_point_celsius?: (number | undefined) | undefined;
45259
+ /** Temperature to which the thermostat should cool (in °F). */
44735
45260
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
45261
+ /** Temperature to which the thermostat should heat (in °F). */
44736
45262
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
45263
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44737
45264
  manual_override_allowed?: boolean | undefined;
44738
45265
  } | undefined;
44739
45266
  /**
44740
45267
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
44741
45268
  default_climate_setting?: {
45269
+ /** Unique key to identify the climate preset. */
44742
45270
  climate_preset_key?: string | undefined;
45271
+ /** Indicates whether this climate preset key can be edited. */
44743
45272
  can_edit?: boolean | undefined;
45273
+ /** Indicates whether this climate preset key can be deleted. */
44744
45274
  can_delete?: boolean | undefined;
45275
+ /** User-friendly name to identify the climate preset. */
44745
45276
  name?: ((string | null) | undefined) | undefined;
45277
+ /** Display name for the climate preset. */
44746
45278
  display_name?: string | undefined;
45279
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44747
45280
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
45281
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44748
45282
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
45283
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44749
45284
  cooling_set_point_celsius?: (number | undefined) | undefined;
45285
+ /** Temperature to which the thermostat should heat (in °C). */
44750
45286
  heating_set_point_celsius?: (number | undefined) | undefined;
45287
+ /** Temperature to which the thermostat should cool (in °F). */
44751
45288
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
45289
+ /** Temperature to which the thermostat should heat (in °F). */
44752
45290
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
45291
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44753
45292
  manual_override_allowed?: boolean | undefined;
44754
45293
  } | undefined;
44755
45294
  available_climate_presets?: Array<{
45295
+ /** Unique key to identify the climate preset. */
44756
45296
  climate_preset_key: string;
45297
+ /** Indicates whether this climate preset key can be edited. */
44757
45298
  can_edit: boolean;
45299
+ /** Indicates whether this climate preset key can be deleted. */
44758
45300
  can_delete: boolean;
45301
+ /** User-friendly name to identify the climate preset. */
44759
45302
  name?: (string | null) | undefined;
45303
+ /** Display name for the climate preset. */
44760
45304
  display_name: string;
45305
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44761
45306
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
45307
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44762
45308
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
45309
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44763
45310
  cooling_set_point_celsius?: number | undefined;
45311
+ /** Temperature to which the thermostat should heat (in °C). */
44764
45312
  heating_set_point_celsius?: number | undefined;
45313
+ /** Temperature to which the thermostat should cool (in °F). */
44765
45314
  cooling_set_point_fahrenheit?: number | undefined;
45315
+ /** Temperature to which the thermostat should heat (in °F). */
44766
45316
  heating_set_point_fahrenheit?: number | undefined;
45317
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44767
45318
  manual_override_allowed: boolean;
44768
45319
  }> | undefined;
44769
45320
  fallback_climate_preset_key?: (string | null) | undefined;
44770
45321
  active_thermostat_schedule?: ({
45322
+ /** ID of the climate schedule. */
44771
45323
  thermostat_schedule_id: string;
45324
+ /** ID of the desired thermostat device. */
44772
45325
  device_id: string;
45326
+ /** User-friendly name to identify the climate schedule. */
44773
45327
  name?: string | undefined;
45328
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44774
45329
  climate_preset_key: string;
45330
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
44775
45331
  max_override_period_minutes: number;
45332
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44776
45333
  starts_at: string;
45334
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44777
45335
  ends_at: string;
45336
+ /** Date and time at which the climate schedule was created. */
44778
45337
  created_at: string;
44779
- /** 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. */
45338
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
44780
45339
  errors?: any;
44781
45340
  } | null) | undefined;
44782
45341
  min_cooling_set_point_celsius?: number | undefined;
@@ -46347,19 +46906,31 @@ interface Routes {
46347
46906
  queryParams: {};
46348
46907
  jsonBody: {};
46349
46908
  commonParams: {
46350
- /** List all devices owned by this connected account */
46909
+ /** ID of the connected account by which to filter. */
46351
46910
  connected_account_id?: string | undefined;
46911
+ /** Array of IDs of the connected accounts by which to filter devices. */
46352
46912
  connected_account_ids?: string[] | undefined;
46913
+ /** ID of the Connect Webview by which to filter devices. */
46353
46914
  connect_webview_id?: string | undefined;
46915
+ /** Device type by which to filter devices. */
46354
46916
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
46917
+ /** Array of device types by which to filter devices. */
46355
46918
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
46919
+ /** Manufacturer by which to filter devices. */
46356
46920
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
46921
+ /** Array of device IDs by which to filter devices. */
46357
46922
  device_ids?: string[] | undefined;
46923
+ /** Numerical limit on the number of devices to return. */
46358
46924
  limit?: number;
46925
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
46359
46926
  created_before?: Date | undefined;
46927
+ /** Your own internal user ID for the user by which to filter devices. */
46360
46928
  user_identifier_key?: string | undefined;
46929
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
46361
46930
  custom_metadata_has?: Record<string, string | boolean> | undefined;
46931
+ /** */
46362
46932
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
46933
+ /** */
46363
46934
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
46364
46935
  };
46365
46936
  formData: {};
@@ -46711,60 +47282,104 @@ interface Routes {
46711
47282
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
46712
47283
  is_temporary_manual_override_active?: boolean | undefined;
46713
47284
  current_climate_setting?: {
47285
+ /** Unique key to identify the climate preset. */
46714
47286
  climate_preset_key?: string | undefined;
47287
+ /** Indicates whether this climate preset key can be edited. */
46715
47288
  can_edit?: boolean | undefined;
47289
+ /** Indicates whether this climate preset key can be deleted. */
46716
47290
  can_delete?: boolean | undefined;
47291
+ /** User-friendly name to identify the climate preset. */
46717
47292
  name?: ((string | null) | undefined) | undefined;
47293
+ /** Display name for the climate preset. */
46718
47294
  display_name?: string | undefined;
47295
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46719
47296
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47297
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46720
47298
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47299
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46721
47300
  cooling_set_point_celsius?: (number | undefined) | undefined;
47301
+ /** Temperature to which the thermostat should heat (in °C). */
46722
47302
  heating_set_point_celsius?: (number | undefined) | undefined;
47303
+ /** Temperature to which the thermostat should cool (in °F). */
46723
47304
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47305
+ /** Temperature to which the thermostat should heat (in °F). */
46724
47306
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47307
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46725
47308
  manual_override_allowed?: boolean | undefined;
46726
47309
  } | undefined;
46727
47310
  /**
46728
47311
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
46729
47312
  default_climate_setting?: {
47313
+ /** Unique key to identify the climate preset. */
46730
47314
  climate_preset_key?: string | undefined;
47315
+ /** Indicates whether this climate preset key can be edited. */
46731
47316
  can_edit?: boolean | undefined;
47317
+ /** Indicates whether this climate preset key can be deleted. */
46732
47318
  can_delete?: boolean | undefined;
47319
+ /** User-friendly name to identify the climate preset. */
46733
47320
  name?: ((string | null) | undefined) | undefined;
47321
+ /** Display name for the climate preset. */
46734
47322
  display_name?: string | undefined;
47323
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46735
47324
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47325
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46736
47326
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47327
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46737
47328
  cooling_set_point_celsius?: (number | undefined) | undefined;
47329
+ /** Temperature to which the thermostat should heat (in °C). */
46738
47330
  heating_set_point_celsius?: (number | undefined) | undefined;
47331
+ /** Temperature to which the thermostat should cool (in °F). */
46739
47332
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47333
+ /** Temperature to which the thermostat should heat (in °F). */
46740
47334
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47335
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46741
47336
  manual_override_allowed?: boolean | undefined;
46742
47337
  } | undefined;
46743
47338
  available_climate_presets?: Array<{
47339
+ /** Unique key to identify the climate preset. */
46744
47340
  climate_preset_key: string;
47341
+ /** Indicates whether this climate preset key can be edited. */
46745
47342
  can_edit: boolean;
47343
+ /** Indicates whether this climate preset key can be deleted. */
46746
47344
  can_delete: boolean;
47345
+ /** User-friendly name to identify the climate preset. */
46747
47346
  name?: (string | null) | undefined;
47347
+ /** Display name for the climate preset. */
46748
47348
  display_name: string;
47349
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46749
47350
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47351
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46750
47352
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
47353
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46751
47354
  cooling_set_point_celsius?: number | undefined;
47355
+ /** Temperature to which the thermostat should heat (in °C). */
46752
47356
  heating_set_point_celsius?: number | undefined;
47357
+ /** Temperature to which the thermostat should cool (in °F). */
46753
47358
  cooling_set_point_fahrenheit?: number | undefined;
47359
+ /** Temperature to which the thermostat should heat (in °F). */
46754
47360
  heating_set_point_fahrenheit?: number | undefined;
47361
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46755
47362
  manual_override_allowed: boolean;
46756
47363
  }> | undefined;
46757
47364
  fallback_climate_preset_key?: (string | null) | undefined;
46758
47365
  active_thermostat_schedule?: ({
47366
+ /** ID of the climate schedule. */
46759
47367
  thermostat_schedule_id: string;
47368
+ /** ID of the desired thermostat device. */
46760
47369
  device_id: string;
47370
+ /** User-friendly name to identify the climate schedule. */
46761
47371
  name?: string | undefined;
47372
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
46762
47373
  climate_preset_key: string;
47374
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
46763
47375
  max_override_period_minutes: number;
47376
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46764
47377
  starts_at: string;
47378
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46765
47379
  ends_at: string;
47380
+ /** Date and time at which the climate schedule was created. */
46766
47381
  created_at: string;
46767
- /** 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. */
47382
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
46768
47383
  errors?: any;
46769
47384
  } | null) | undefined;
46770
47385
  min_cooling_set_point_celsius?: number | undefined;
@@ -47174,60 +47789,104 @@ interface Routes {
47174
47789
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47175
47790
  is_temporary_manual_override_active?: boolean | undefined;
47176
47791
  current_climate_setting?: {
47792
+ /** Unique key to identify the climate preset. */
47177
47793
  climate_preset_key?: string | undefined;
47794
+ /** Indicates whether this climate preset key can be edited. */
47178
47795
  can_edit?: boolean | undefined;
47796
+ /** Indicates whether this climate preset key can be deleted. */
47179
47797
  can_delete?: boolean | undefined;
47798
+ /** User-friendly name to identify the climate preset. */
47180
47799
  name?: ((string | null) | undefined) | undefined;
47800
+ /** Display name for the climate preset. */
47181
47801
  display_name?: string | undefined;
47802
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47182
47803
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47804
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47183
47805
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47806
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47184
47807
  cooling_set_point_celsius?: (number | undefined) | undefined;
47808
+ /** Temperature to which the thermostat should heat (in °C). */
47185
47809
  heating_set_point_celsius?: (number | undefined) | undefined;
47810
+ /** Temperature to which the thermostat should cool (in °F). */
47186
47811
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47812
+ /** Temperature to which the thermostat should heat (in °F). */
47187
47813
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47814
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47188
47815
  manual_override_allowed?: boolean | undefined;
47189
47816
  } | undefined;
47190
47817
  /**
47191
47818
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
47192
47819
  default_climate_setting?: {
47820
+ /** Unique key to identify the climate preset. */
47193
47821
  climate_preset_key?: string | undefined;
47822
+ /** Indicates whether this climate preset key can be edited. */
47194
47823
  can_edit?: boolean | undefined;
47824
+ /** Indicates whether this climate preset key can be deleted. */
47195
47825
  can_delete?: boolean | undefined;
47826
+ /** User-friendly name to identify the climate preset. */
47196
47827
  name?: ((string | null) | undefined) | undefined;
47828
+ /** Display name for the climate preset. */
47197
47829
  display_name?: string | undefined;
47830
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47198
47831
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47832
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47199
47833
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47834
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47200
47835
  cooling_set_point_celsius?: (number | undefined) | undefined;
47836
+ /** Temperature to which the thermostat should heat (in °C). */
47201
47837
  heating_set_point_celsius?: (number | undefined) | undefined;
47838
+ /** Temperature to which the thermostat should cool (in °F). */
47202
47839
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47840
+ /** Temperature to which the thermostat should heat (in °F). */
47203
47841
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47842
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47204
47843
  manual_override_allowed?: boolean | undefined;
47205
47844
  } | undefined;
47206
47845
  available_climate_presets?: Array<{
47846
+ /** Unique key to identify the climate preset. */
47207
47847
  climate_preset_key: string;
47848
+ /** Indicates whether this climate preset key can be edited. */
47208
47849
  can_edit: boolean;
47850
+ /** Indicates whether this climate preset key can be deleted. */
47209
47851
  can_delete: boolean;
47852
+ /** User-friendly name to identify the climate preset. */
47210
47853
  name?: (string | null) | undefined;
47854
+ /** Display name for the climate preset. */
47211
47855
  display_name: string;
47856
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47212
47857
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47858
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47213
47859
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
47860
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47214
47861
  cooling_set_point_celsius?: number | undefined;
47862
+ /** Temperature to which the thermostat should heat (in °C). */
47215
47863
  heating_set_point_celsius?: number | undefined;
47864
+ /** Temperature to which the thermostat should cool (in °F). */
47216
47865
  cooling_set_point_fahrenheit?: number | undefined;
47866
+ /** Temperature to which the thermostat should heat (in °F). */
47217
47867
  heating_set_point_fahrenheit?: number | undefined;
47868
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47218
47869
  manual_override_allowed: boolean;
47219
47870
  }> | undefined;
47220
47871
  fallback_climate_preset_key?: (string | null) | undefined;
47221
47872
  active_thermostat_schedule?: ({
47873
+ /** ID of the climate schedule. */
47222
47874
  thermostat_schedule_id: string;
47875
+ /** ID of the desired thermostat device. */
47223
47876
  device_id: string;
47877
+ /** User-friendly name to identify the climate schedule. */
47224
47878
  name?: string | undefined;
47879
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
47225
47880
  climate_preset_key: string;
47881
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
47226
47882
  max_override_period_minutes: number;
47883
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47227
47884
  starts_at: string;
47885
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47228
47886
  ends_at: string;
47887
+ /** Date and time at which the climate schedule was created. */
47229
47888
  created_at: string;
47230
- /** 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. */
47889
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
47231
47890
  errors?: any;
47232
47891
  } | null) | undefined;
47233
47892
  min_cooling_set_point_celsius?: number | undefined;
@@ -49742,7 +50401,9 @@ interface Routes {
49742
50401
  method: 'POST';
49743
50402
  queryParams: {};
49744
50403
  jsonBody: {
50404
+ /** ID of the desired thermostat device. */
49745
50405
  device_id: string;
50406
+ /** Climate preset key of the desired climate preset. */
49746
50407
  climate_preset_key: string;
49747
50408
  };
49748
50409
  commonParams: {};
@@ -50475,12 +51136,13 @@ interface Routes {
50475
51136
  method: 'POST';
50476
51137
  queryParams: {};
50477
51138
  jsonBody: {
50478
- /** ID of the thermostat device. */
51139
+ /** ID of the desired thermostat device. */
50479
51140
  device_id: string;
50480
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
51141
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
50481
51142
  cooling_set_point_celsius?: number | undefined;
50482
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
51143
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
50483
51144
  cooling_set_point_fahrenheit?: number | undefined;
51145
+ /** */
50484
51146
  sync?: boolean;
50485
51147
  };
50486
51148
  commonParams: {};
@@ -51213,15 +51875,25 @@ interface Routes {
51213
51875
  method: 'POST';
51214
51876
  queryParams: {};
51215
51877
  jsonBody: {
51878
+ /** ID of the desired thermostat device. */
51216
51879
  device_id: string;
51880
+ /** Unique key to identify the climate preset. */
51217
51881
  climate_preset_key: string;
51882
+ /** User-friendly name to identify the climate preset. */
51218
51883
  name?: (string | null) | undefined;
51884
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51219
51885
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
51886
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51220
51887
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
51888
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51221
51889
  cooling_set_point_celsius?: number | undefined;
51890
+ /** Temperature to which the thermostat should heat (in °C). */
51222
51891
  heating_set_point_celsius?: number | undefined;
51892
+ /** Temperature to which the thermostat should cool (in °F). */
51223
51893
  cooling_set_point_fahrenheit?: number | undefined;
51894
+ /** Temperature to which the thermostat should heat (in °F). */
51224
51895
  heating_set_point_fahrenheit?: number | undefined;
51896
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51225
51897
  manual_override_allowed: boolean;
51226
51898
  };
51227
51899
  commonParams: {};
@@ -51233,7 +51905,9 @@ interface Routes {
51233
51905
  method: 'POST' | 'DELETE';
51234
51906
  queryParams: {};
51235
51907
  jsonBody: {
51908
+ /** ID of the desired thermostat device. */
51236
51909
  device_id: string;
51910
+ /** Climate preset key of the desired climate preset. */
51237
51911
  climate_preset_key: string;
51238
51912
  };
51239
51913
  commonParams: {};
@@ -51246,9 +51920,9 @@ interface Routes {
51246
51920
  queryParams: {};
51247
51921
  jsonBody: {};
51248
51922
  commonParams: {
51249
- /** ID of the thermostat device. */
51923
+ /** ID of the desired thermostat device. */
51250
51924
  device_id?: string | undefined;
51251
- /** Name of the thermostat. */
51925
+ /** User-friendly name of the desired thermostat device. */
51252
51926
  name?: string | undefined;
51253
51927
  };
51254
51928
  formData: {};
@@ -51600,60 +52274,104 @@ interface Routes {
51600
52274
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
51601
52275
  is_temporary_manual_override_active?: boolean | undefined;
51602
52276
  current_climate_setting?: {
52277
+ /** Unique key to identify the climate preset. */
51603
52278
  climate_preset_key?: string | undefined;
52279
+ /** Indicates whether this climate preset key can be edited. */
51604
52280
  can_edit?: boolean | undefined;
52281
+ /** Indicates whether this climate preset key can be deleted. */
51605
52282
  can_delete?: boolean | undefined;
52283
+ /** User-friendly name to identify the climate preset. */
51606
52284
  name?: ((string | null) | undefined) | undefined;
52285
+ /** Display name for the climate preset. */
51607
52286
  display_name?: string | undefined;
52287
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51608
52288
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
52289
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51609
52290
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
52291
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51610
52292
  cooling_set_point_celsius?: (number | undefined) | undefined;
52293
+ /** Temperature to which the thermostat should heat (in °C). */
51611
52294
  heating_set_point_celsius?: (number | undefined) | undefined;
52295
+ /** Temperature to which the thermostat should cool (in °F). */
51612
52296
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
52297
+ /** Temperature to which the thermostat should heat (in °F). */
51613
52298
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
52299
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51614
52300
  manual_override_allowed?: boolean | undefined;
51615
52301
  } | undefined;
51616
52302
  /**
51617
52303
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
51618
52304
  default_climate_setting?: {
52305
+ /** Unique key to identify the climate preset. */
51619
52306
  climate_preset_key?: string | undefined;
52307
+ /** Indicates whether this climate preset key can be edited. */
51620
52308
  can_edit?: boolean | undefined;
52309
+ /** Indicates whether this climate preset key can be deleted. */
51621
52310
  can_delete?: boolean | undefined;
52311
+ /** User-friendly name to identify the climate preset. */
51622
52312
  name?: ((string | null) | undefined) | undefined;
52313
+ /** Display name for the climate preset. */
51623
52314
  display_name?: string | undefined;
52315
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51624
52316
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
52317
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51625
52318
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
52319
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51626
52320
  cooling_set_point_celsius?: (number | undefined) | undefined;
52321
+ /** Temperature to which the thermostat should heat (in °C). */
51627
52322
  heating_set_point_celsius?: (number | undefined) | undefined;
52323
+ /** Temperature to which the thermostat should cool (in °F). */
51628
52324
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
52325
+ /** Temperature to which the thermostat should heat (in °F). */
51629
52326
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
52327
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51630
52328
  manual_override_allowed?: boolean | undefined;
51631
52329
  } | undefined;
51632
52330
  available_climate_presets?: Array<{
52331
+ /** Unique key to identify the climate preset. */
51633
52332
  climate_preset_key: string;
52333
+ /** Indicates whether this climate preset key can be edited. */
51634
52334
  can_edit: boolean;
52335
+ /** Indicates whether this climate preset key can be deleted. */
51635
52336
  can_delete: boolean;
52337
+ /** User-friendly name to identify the climate preset. */
51636
52338
  name?: (string | null) | undefined;
52339
+ /** Display name for the climate preset. */
51637
52340
  display_name: string;
52341
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51638
52342
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
52343
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51639
52344
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
52345
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51640
52346
  cooling_set_point_celsius?: number | undefined;
52347
+ /** Temperature to which the thermostat should heat (in °C). */
51641
52348
  heating_set_point_celsius?: number | undefined;
52349
+ /** Temperature to which the thermostat should cool (in °F). */
51642
52350
  cooling_set_point_fahrenheit?: number | undefined;
52351
+ /** Temperature to which the thermostat should heat (in °F). */
51643
52352
  heating_set_point_fahrenheit?: number | undefined;
52353
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51644
52354
  manual_override_allowed: boolean;
51645
52355
  }> | undefined;
51646
52356
  fallback_climate_preset_key?: (string | null) | undefined;
51647
52357
  active_thermostat_schedule?: ({
52358
+ /** ID of the climate schedule. */
51648
52359
  thermostat_schedule_id: string;
52360
+ /** ID of the desired thermostat device. */
51649
52361
  device_id: string;
52362
+ /** User-friendly name to identify the climate schedule. */
51650
52363
  name?: string | undefined;
52364
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
51651
52365
  climate_preset_key: string;
52366
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
51652
52367
  max_override_period_minutes: number;
52368
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51653
52369
  starts_at: string;
52370
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51654
52371
  ends_at: string;
52372
+ /** Date and time at which the climate schedule was created. */
51655
52373
  created_at: string;
51656
- /** 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. */
52374
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
51657
52375
  errors?: any;
51658
52376
  } | null) | undefined;
51659
52377
  min_cooling_set_point_celsius?: number | undefined;
@@ -51723,12 +52441,13 @@ interface Routes {
51723
52441
  method: 'POST';
51724
52442
  queryParams: {};
51725
52443
  jsonBody: {
51726
- /** ID of the thermostat device. */
52444
+ /** ID of the desired thermostat device. */
51727
52445
  device_id: string;
51728
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
52446
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
51729
52447
  heating_set_point_celsius?: number | undefined;
51730
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
52448
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
51731
52449
  heating_set_point_fahrenheit?: number | undefined;
52450
+ /** */
51732
52451
  sync?: boolean;
51733
52452
  };
51734
52453
  commonParams: {};
@@ -52461,16 +53180,17 @@ interface Routes {
52461
53180
  method: 'POST';
52462
53181
  queryParams: {};
52463
53182
  jsonBody: {
52464
- /** ID of the thermostat device. */
53183
+ /** ID of the desired thermostat device. */
52465
53184
  device_id: string;
52466
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
53185
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
52467
53186
  heating_set_point_celsius?: number | undefined;
52468
- /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
53187
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
52469
53188
  heating_set_point_fahrenheit?: number | undefined;
52470
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
53189
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
52471
53190
  cooling_set_point_celsius?: number | undefined;
52472
- /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
53191
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
52473
53192
  cooling_set_point_fahrenheit?: number | undefined;
53193
+ /** */
52474
53194
  sync?: boolean;
52475
53195
  };
52476
53196
  commonParams: {};
@@ -53204,19 +53924,31 @@ interface Routes {
53204
53924
  queryParams: {};
53205
53925
  jsonBody: {};
53206
53926
  commonParams: {
53207
- /** List all devices owned by this connected account */
53927
+ /** ID of the connected account by which to filter. */
53208
53928
  connected_account_id?: string | undefined;
53929
+ /** Array of IDs of the connected accounts by which to filter devices. */
53209
53930
  connected_account_ids?: string[] | undefined;
53931
+ /** ID of the Connect Webview by which to filter devices. */
53210
53932
  connect_webview_id?: string | undefined;
53933
+ /** Device type by which to filter devices. */
53211
53934
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
53935
+ /** Array of device types by which to filter devices. */
53212
53936
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
53937
+ /** Manufacturer by which to filter devices. */
53213
53938
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
53939
+ /** Array of device IDs by which to filter devices. */
53214
53940
  device_ids?: string[] | undefined;
53941
+ /** Numerical limit on the number of devices to return. */
53215
53942
  limit?: number;
53943
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
53216
53944
  created_before?: Date | undefined;
53945
+ /** Your own internal user ID for the user by which to filter devices. */
53217
53946
  user_identifier_key?: string | undefined;
53947
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
53218
53948
  custom_metadata_has?: Record<string, string | boolean> | undefined;
53949
+ /** */
53219
53950
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
53951
+ /** */
53220
53952
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
53221
53953
  };
53222
53954
  formData: {};
@@ -53568,60 +54300,104 @@ interface Routes {
53568
54300
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
53569
54301
  is_temporary_manual_override_active?: boolean | undefined;
53570
54302
  current_climate_setting?: {
54303
+ /** Unique key to identify the climate preset. */
53571
54304
  climate_preset_key?: string | undefined;
54305
+ /** Indicates whether this climate preset key can be edited. */
53572
54306
  can_edit?: boolean | undefined;
54307
+ /** Indicates whether this climate preset key can be deleted. */
53573
54308
  can_delete?: boolean | undefined;
54309
+ /** User-friendly name to identify the climate preset. */
53574
54310
  name?: ((string | null) | undefined) | undefined;
54311
+ /** Display name for the climate preset. */
53575
54312
  display_name?: string | undefined;
54313
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53576
54314
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54315
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53577
54316
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54317
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53578
54318
  cooling_set_point_celsius?: (number | undefined) | undefined;
54319
+ /** Temperature to which the thermostat should heat (in °C). */
53579
54320
  heating_set_point_celsius?: (number | undefined) | undefined;
54321
+ /** Temperature to which the thermostat should cool (in °F). */
53580
54322
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54323
+ /** Temperature to which the thermostat should heat (in °F). */
53581
54324
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54325
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53582
54326
  manual_override_allowed?: boolean | undefined;
53583
54327
  } | undefined;
53584
54328
  /**
53585
54329
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
53586
54330
  default_climate_setting?: {
54331
+ /** Unique key to identify the climate preset. */
53587
54332
  climate_preset_key?: string | undefined;
54333
+ /** Indicates whether this climate preset key can be edited. */
53588
54334
  can_edit?: boolean | undefined;
54335
+ /** Indicates whether this climate preset key can be deleted. */
53589
54336
  can_delete?: boolean | undefined;
54337
+ /** User-friendly name to identify the climate preset. */
53590
54338
  name?: ((string | null) | undefined) | undefined;
54339
+ /** Display name for the climate preset. */
53591
54340
  display_name?: string | undefined;
54341
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53592
54342
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54343
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53593
54344
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54345
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53594
54346
  cooling_set_point_celsius?: (number | undefined) | undefined;
54347
+ /** Temperature to which the thermostat should heat (in °C). */
53595
54348
  heating_set_point_celsius?: (number | undefined) | undefined;
54349
+ /** Temperature to which the thermostat should cool (in °F). */
53596
54350
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54351
+ /** Temperature to which the thermostat should heat (in °F). */
53597
54352
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54353
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53598
54354
  manual_override_allowed?: boolean | undefined;
53599
54355
  } | undefined;
53600
54356
  available_climate_presets?: Array<{
54357
+ /** Unique key to identify the climate preset. */
53601
54358
  climate_preset_key: string;
54359
+ /** Indicates whether this climate preset key can be edited. */
53602
54360
  can_edit: boolean;
54361
+ /** Indicates whether this climate preset key can be deleted. */
53603
54362
  can_delete: boolean;
54363
+ /** User-friendly name to identify the climate preset. */
53604
54364
  name?: (string | null) | undefined;
54365
+ /** Display name for the climate preset. */
53605
54366
  display_name: string;
54367
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53606
54368
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54369
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53607
54370
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
54371
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53608
54372
  cooling_set_point_celsius?: number | undefined;
54373
+ /** Temperature to which the thermostat should heat (in °C). */
53609
54374
  heating_set_point_celsius?: number | undefined;
54375
+ /** Temperature to which the thermostat should cool (in °F). */
53610
54376
  cooling_set_point_fahrenheit?: number | undefined;
54377
+ /** Temperature to which the thermostat should heat (in °F). */
53611
54378
  heating_set_point_fahrenheit?: number | undefined;
54379
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53612
54380
  manual_override_allowed: boolean;
53613
54381
  }> | undefined;
53614
54382
  fallback_climate_preset_key?: (string | null) | undefined;
53615
54383
  active_thermostat_schedule?: ({
54384
+ /** ID of the climate schedule. */
53616
54385
  thermostat_schedule_id: string;
54386
+ /** ID of the desired thermostat device. */
53617
54387
  device_id: string;
54388
+ /** User-friendly name to identify the climate schedule. */
53618
54389
  name?: string | undefined;
54390
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
53619
54391
  climate_preset_key: string;
54392
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
53620
54393
  max_override_period_minutes: number;
54394
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53621
54395
  starts_at: string;
54396
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53622
54397
  ends_at: string;
54398
+ /** Date and time at which the climate schedule was created. */
53623
54399
  created_at: string;
53624
- /** 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. */
54400
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
53625
54401
  errors?: any;
53626
54402
  } | null) | undefined;
53627
54403
  min_cooling_set_point_celsius?: number | undefined;
@@ -54031,60 +54807,104 @@ interface Routes {
54031
54807
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54032
54808
  is_temporary_manual_override_active?: boolean | undefined;
54033
54809
  current_climate_setting?: {
54810
+ /** Unique key to identify the climate preset. */
54034
54811
  climate_preset_key?: string | undefined;
54812
+ /** Indicates whether this climate preset key can be edited. */
54035
54813
  can_edit?: boolean | undefined;
54814
+ /** Indicates whether this climate preset key can be deleted. */
54036
54815
  can_delete?: boolean | undefined;
54816
+ /** User-friendly name to identify the climate preset. */
54037
54817
  name?: ((string | null) | undefined) | undefined;
54818
+ /** Display name for the climate preset. */
54038
54819
  display_name?: string | undefined;
54820
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
54039
54821
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54822
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
54040
54823
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54824
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
54041
54825
  cooling_set_point_celsius?: (number | undefined) | undefined;
54826
+ /** Temperature to which the thermostat should heat (in °C). */
54042
54827
  heating_set_point_celsius?: (number | undefined) | undefined;
54828
+ /** Temperature to which the thermostat should cool (in °F). */
54043
54829
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54830
+ /** Temperature to which the thermostat should heat (in °F). */
54044
54831
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54832
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
54045
54833
  manual_override_allowed?: boolean | undefined;
54046
54834
  } | undefined;
54047
54835
  /**
54048
54836
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
54049
54837
  default_climate_setting?: {
54838
+ /** Unique key to identify the climate preset. */
54050
54839
  climate_preset_key?: string | undefined;
54840
+ /** Indicates whether this climate preset key can be edited. */
54051
54841
  can_edit?: boolean | undefined;
54842
+ /** Indicates whether this climate preset key can be deleted. */
54052
54843
  can_delete?: boolean | undefined;
54844
+ /** User-friendly name to identify the climate preset. */
54053
54845
  name?: ((string | null) | undefined) | undefined;
54846
+ /** Display name for the climate preset. */
54054
54847
  display_name?: string | undefined;
54848
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
54055
54849
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54850
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
54056
54851
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54852
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
54057
54853
  cooling_set_point_celsius?: (number | undefined) | undefined;
54854
+ /** Temperature to which the thermostat should heat (in °C). */
54058
54855
  heating_set_point_celsius?: (number | undefined) | undefined;
54856
+ /** Temperature to which the thermostat should cool (in °F). */
54059
54857
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54858
+ /** Temperature to which the thermostat should heat (in °F). */
54060
54859
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54860
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
54061
54861
  manual_override_allowed?: boolean | undefined;
54062
54862
  } | undefined;
54063
54863
  available_climate_presets?: Array<{
54864
+ /** Unique key to identify the climate preset. */
54064
54865
  climate_preset_key: string;
54866
+ /** Indicates whether this climate preset key can be edited. */
54065
54867
  can_edit: boolean;
54868
+ /** Indicates whether this climate preset key can be deleted. */
54066
54869
  can_delete: boolean;
54870
+ /** User-friendly name to identify the climate preset. */
54067
54871
  name?: (string | null) | undefined;
54872
+ /** Display name for the climate preset. */
54068
54873
  display_name: string;
54874
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
54069
54875
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54876
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
54070
54877
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
54878
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
54071
54879
  cooling_set_point_celsius?: number | undefined;
54880
+ /** Temperature to which the thermostat should heat (in °C). */
54072
54881
  heating_set_point_celsius?: number | undefined;
54882
+ /** Temperature to which the thermostat should cool (in °F). */
54073
54883
  cooling_set_point_fahrenheit?: number | undefined;
54884
+ /** Temperature to which the thermostat should heat (in °F). */
54074
54885
  heating_set_point_fahrenheit?: number | undefined;
54886
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
54075
54887
  manual_override_allowed: boolean;
54076
54888
  }> | undefined;
54077
54889
  fallback_climate_preset_key?: (string | null) | undefined;
54078
54890
  active_thermostat_schedule?: ({
54891
+ /** ID of the climate schedule. */
54079
54892
  thermostat_schedule_id: string;
54893
+ /** ID of the desired thermostat device. */
54080
54894
  device_id: string;
54895
+ /** User-friendly name to identify the climate schedule. */
54081
54896
  name?: string | undefined;
54897
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54082
54898
  climate_preset_key: string;
54899
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54083
54900
  max_override_period_minutes: number;
54901
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54084
54902
  starts_at: string;
54903
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54085
54904
  ends_at: string;
54905
+ /** Date and time at which the climate schedule was created. */
54086
54906
  created_at: string;
54087
- /** 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. */
54907
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54088
54908
  errors?: any;
54089
54909
  } | null) | undefined;
54090
54910
  min_cooling_set_point_celsius?: number | undefined;
@@ -54154,8 +54974,9 @@ interface Routes {
54154
54974
  method: 'POST';
54155
54975
  queryParams: {};
54156
54976
  jsonBody: {
54157
- /** ID of the thermostat device. */
54977
+ /** ID of the desired thermostat device. */
54158
54978
  device_id: string;
54979
+ /** */
54159
54980
  sync?: boolean;
54160
54981
  };
54161
54982
  commonParams: {};
@@ -54888,26 +55709,40 @@ interface Routes {
54888
55709
  method: 'POST';
54889
55710
  queryParams: {};
54890
55711
  jsonBody: {
55712
+ /** ID of the desired thermostat device. */
54891
55713
  device_id: string;
55714
+ /** User-friendly name to identify the climate schedule. */
54892
55715
  name?: string | undefined;
55716
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54893
55717
  climate_preset_key: string;
55718
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54894
55719
  max_override_period_minutes?: number;
55720
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54895
55721
  starts_at: string;
55722
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54896
55723
  ends_at: string;
54897
55724
  };
54898
55725
  commonParams: {};
54899
55726
  formData: {};
54900
55727
  jsonResponse: {
54901
55728
  thermostat_schedule: {
55729
+ /** ID of the climate schedule. */
54902
55730
  thermostat_schedule_id: string;
55731
+ /** ID of the desired thermostat device. */
54903
55732
  device_id: string;
55733
+ /** User-friendly name to identify the climate schedule. */
54904
55734
  name?: string | undefined;
55735
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54905
55736
  climate_preset_key: string;
55737
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54906
55738
  max_override_period_minutes: number;
55739
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54907
55740
  starts_at: string;
55741
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54908
55742
  ends_at: string;
55743
+ /** Date and time at which the climate schedule was created. */
54909
55744
  created_at: string;
54910
- /** 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. */
55745
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54911
55746
  errors?: any;
54912
55747
  };
54913
55748
  };
@@ -54918,6 +55753,7 @@ interface Routes {
54918
55753
  queryParams: {};
54919
55754
  jsonBody: {};
54920
55755
  commonParams: {
55756
+ /** ID of the desired climate schedule. */
54921
55757
  thermostat_schedule_id: string;
54922
55758
  };
54923
55759
  formData: {};
@@ -54929,20 +55765,29 @@ interface Routes {
54929
55765
  queryParams: {};
54930
55766
  jsonBody: {};
54931
55767
  commonParams: {
55768
+ /** ID of the desired climate schedule. */
54932
55769
  thermostat_schedule_id: string;
54933
55770
  };
54934
55771
  formData: {};
54935
55772
  jsonResponse: {
54936
55773
  thermostat_schedule: {
55774
+ /** ID of the climate schedule. */
54937
55775
  thermostat_schedule_id: string;
55776
+ /** ID of the desired thermostat device. */
54938
55777
  device_id: string;
55778
+ /** User-friendly name to identify the climate schedule. */
54939
55779
  name?: string | undefined;
55780
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54940
55781
  climate_preset_key: string;
55782
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54941
55783
  max_override_period_minutes: number;
55784
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54942
55785
  starts_at: string;
55786
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54943
55787
  ends_at: string;
55788
+ /** Date and time at which the climate schedule was created. */
54944
55789
  created_at: string;
54945
- /** 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. */
55790
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54946
55791
  errors?: any;
54947
55792
  };
54948
55793
  };
@@ -54953,21 +55798,31 @@ interface Routes {
54953
55798
  queryParams: {};
54954
55799
  jsonBody: {};
54955
55800
  commonParams: {
55801
+ /** ID of the desired thermostat device. */
54956
55802
  device_id: string;
55803
+ /** User identifier key by which to filter the list of returned climate schedules. */
54957
55804
  user_identifier_key?: string | undefined;
54958
55805
  };
54959
55806
  formData: {};
54960
55807
  jsonResponse: {
54961
55808
  thermostat_schedules: Array<{
55809
+ /** ID of the climate schedule. */
54962
55810
  thermostat_schedule_id: string;
55811
+ /** ID of the desired thermostat device. */
54963
55812
  device_id: string;
55813
+ /** User-friendly name to identify the climate schedule. */
54964
55814
  name?: string | undefined;
55815
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54965
55816
  climate_preset_key: string;
55817
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54966
55818
  max_override_period_minutes: number;
55819
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54967
55820
  starts_at: string;
55821
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54968
55822
  ends_at: string;
55823
+ /** Date and time at which the climate schedule was created. */
54969
55824
  created_at: string;
54970
- /** 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. */
55825
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54971
55826
  errors?: any;
54972
55827
  }>;
54973
55828
  };
@@ -54977,11 +55832,17 @@ interface Routes {
54977
55832
  method: 'PATCH' | 'POST';
54978
55833
  queryParams: {};
54979
55834
  jsonBody: {
55835
+ /** ID of the desired climate schedule. */
54980
55836
  thermostat_schedule_id: string;
55837
+ /** User-friendly name to identify the climate schedule. */
54981
55838
  name?: string | undefined;
55839
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54982
55840
  climate_preset_key?: string | undefined;
55841
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54983
55842
  max_override_period_minutes?: number | undefined;
55843
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54984
55844
  starts_at?: string | undefined;
55845
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54985
55846
  ends_at?: string | undefined;
54986
55847
  };
54987
55848
  commonParams: {};
@@ -54993,7 +55854,9 @@ interface Routes {
54993
55854
  method: 'POST';
54994
55855
  queryParams: {};
54995
55856
  jsonBody: {
55857
+ /** ID of the desired thermostat device. */
54996
55858
  device_id: string;
55859
+ /** Climate preset key of the desired climate preset. */
54997
55860
  climate_preset_key: string;
54998
55861
  };
54999
55862
  commonParams: {};
@@ -55005,13 +55868,13 @@ interface Routes {
55005
55868
  method: 'POST';
55006
55869
  queryParams: {};
55007
55870
  jsonBody: {
55008
- /** ID of the thermostat device. */
55009
55871
  device_id: string;
55010
55872
  /**
55011
55873
  * @deprecated Use `fan_mode_setting` instead. */
55012
55874
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
55013
- /** Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings). */
55875
+ /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
55014
55876
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
55877
+ /** */
55015
55878
  sync?: boolean;
55016
55879
  };
55017
55880
  commonParams: {};
@@ -55744,10 +56607,15 @@ interface Routes {
55744
56607
  method: 'POST' | 'PATCH';
55745
56608
  queryParams: {};
55746
56609
  jsonBody: {
56610
+ /** ID of the desired thermostat device. */
55747
56611
  device_id: string;
56612
+ /** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
55748
56613
  lower_limit_celsius?: (number | undefined) | null;
56614
+ /** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
55749
56615
  lower_limit_fahrenheit?: (number | undefined) | null;
56616
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
55750
56617
  upper_limit_celsius?: (number | undefined) | null;
56618
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
55751
56619
  upper_limit_fahrenheit?: (number | undefined) | null;
55752
56620
  };
55753
56621
  commonParams: {};
@@ -55759,15 +56627,25 @@ interface Routes {
55759
56627
  method: 'POST' | 'PATCH';
55760
56628
  queryParams: {};
55761
56629
  jsonBody: {
56630
+ /** ID of the desired thermostat device. */
55762
56631
  device_id: string;
56632
+ /** Unique key to identify the climate preset. */
55763
56633
  climate_preset_key: string;
56634
+ /** User-friendly name to identify the climate preset. */
55764
56635
  name?: (string | null) | undefined;
56636
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
55765
56637
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56638
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
55766
56639
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
56640
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
55767
56641
  cooling_set_point_celsius?: number | undefined;
56642
+ /** Temperature to which the thermostat should heat (in °C). */
55768
56643
  heating_set_point_celsius?: number | undefined;
56644
+ /** Temperature to which the thermostat should cool (in °F). */
55769
56645
  cooling_set_point_fahrenheit?: number | undefined;
56646
+ /** Temperature to which the thermostat should heat (in °F). */
55770
56647
  heating_set_point_fahrenheit?: number | undefined;
56648
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
55771
56649
  manual_override_allowed: boolean;
55772
56650
  };
55773
56651
  commonParams: {};
@@ -56310,60 +57188,104 @@ interface Routes {
56310
57188
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56311
57189
  is_temporary_manual_override_active?: boolean | undefined;
56312
57190
  current_climate_setting?: {
57191
+ /** Unique key to identify the climate preset. */
56313
57192
  climate_preset_key?: string | undefined;
57193
+ /** Indicates whether this climate preset key can be edited. */
56314
57194
  can_edit?: boolean | undefined;
57195
+ /** Indicates whether this climate preset key can be deleted. */
56315
57196
  can_delete?: boolean | undefined;
57197
+ /** User-friendly name to identify the climate preset. */
56316
57198
  name?: ((string | null) | undefined) | undefined;
57199
+ /** Display name for the climate preset. */
56317
57200
  display_name?: string | undefined;
57201
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56318
57202
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57203
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56319
57204
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57205
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56320
57206
  cooling_set_point_celsius?: (number | undefined) | undefined;
57207
+ /** Temperature to which the thermostat should heat (in °C). */
56321
57208
  heating_set_point_celsius?: (number | undefined) | undefined;
57209
+ /** Temperature to which the thermostat should cool (in °F). */
56322
57210
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57211
+ /** Temperature to which the thermostat should heat (in °F). */
56323
57212
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57213
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56324
57214
  manual_override_allowed?: boolean | undefined;
56325
57215
  } | undefined;
56326
57216
  /**
56327
57217
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
56328
57218
  default_climate_setting?: {
57219
+ /** Unique key to identify the climate preset. */
56329
57220
  climate_preset_key?: string | undefined;
57221
+ /** Indicates whether this climate preset key can be edited. */
56330
57222
  can_edit?: boolean | undefined;
57223
+ /** Indicates whether this climate preset key can be deleted. */
56331
57224
  can_delete?: boolean | undefined;
57225
+ /** User-friendly name to identify the climate preset. */
56332
57226
  name?: ((string | null) | undefined) | undefined;
57227
+ /** Display name for the climate preset. */
56333
57228
  display_name?: string | undefined;
57229
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56334
57230
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57231
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56335
57232
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57233
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56336
57234
  cooling_set_point_celsius?: (number | undefined) | undefined;
57235
+ /** Temperature to which the thermostat should heat (in °C). */
56337
57236
  heating_set_point_celsius?: (number | undefined) | undefined;
57237
+ /** Temperature to which the thermostat should cool (in °F). */
56338
57238
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57239
+ /** Temperature to which the thermostat should heat (in °F). */
56339
57240
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57241
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56340
57242
  manual_override_allowed?: boolean | undefined;
56341
57243
  } | undefined;
56342
57244
  available_climate_presets?: Array<{
57245
+ /** Unique key to identify the climate preset. */
56343
57246
  climate_preset_key: string;
57247
+ /** Indicates whether this climate preset key can be edited. */
56344
57248
  can_edit: boolean;
57249
+ /** Indicates whether this climate preset key can be deleted. */
56345
57250
  can_delete: boolean;
57251
+ /** User-friendly name to identify the climate preset. */
56346
57252
  name?: (string | null) | undefined;
57253
+ /** Display name for the climate preset. */
56347
57254
  display_name: string;
57255
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56348
57256
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
57257
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56349
57258
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
57259
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56350
57260
  cooling_set_point_celsius?: number | undefined;
57261
+ /** Temperature to which the thermostat should heat (in °C). */
56351
57262
  heating_set_point_celsius?: number | undefined;
57263
+ /** Temperature to which the thermostat should cool (in °F). */
56352
57264
  cooling_set_point_fahrenheit?: number | undefined;
57265
+ /** Temperature to which the thermostat should heat (in °F). */
56353
57266
  heating_set_point_fahrenheit?: number | undefined;
57267
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56354
57268
  manual_override_allowed: boolean;
56355
57269
  }> | undefined;
56356
57270
  fallback_climate_preset_key?: (string | null) | undefined;
56357
57271
  active_thermostat_schedule?: ({
57272
+ /** ID of the climate schedule. */
56358
57273
  thermostat_schedule_id: string;
57274
+ /** ID of the desired thermostat device. */
56359
57275
  device_id: string;
57276
+ /** User-friendly name to identify the climate schedule. */
56360
57277
  name?: string | undefined;
57278
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
56361
57279
  climate_preset_key: string;
57280
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
56362
57281
  max_override_period_minutes: number;
57282
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56363
57283
  starts_at: string;
57284
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56364
57285
  ends_at: string;
57286
+ /** Date and time at which the climate schedule was created. */
56365
57287
  created_at: string;
56366
- /** 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. */
57288
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
56367
57289
  errors?: any;
56368
57290
  } | null) | undefined;
56369
57291
  min_cooling_set_point_celsius?: number | undefined;
@@ -56775,60 +57697,104 @@ interface Routes {
56775
57697
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56776
57698
  is_temporary_manual_override_active?: boolean | undefined;
56777
57699
  current_climate_setting?: {
57700
+ /** Unique key to identify the climate preset. */
56778
57701
  climate_preset_key?: string | undefined;
57702
+ /** Indicates whether this climate preset key can be edited. */
56779
57703
  can_edit?: boolean | undefined;
57704
+ /** Indicates whether this climate preset key can be deleted. */
56780
57705
  can_delete?: boolean | undefined;
57706
+ /** User-friendly name to identify the climate preset. */
56781
57707
  name?: ((string | null) | undefined) | undefined;
57708
+ /** Display name for the climate preset. */
56782
57709
  display_name?: string | undefined;
57710
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56783
57711
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57712
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56784
57713
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57714
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56785
57715
  cooling_set_point_celsius?: (number | undefined) | undefined;
57716
+ /** Temperature to which the thermostat should heat (in °C). */
56786
57717
  heating_set_point_celsius?: (number | undefined) | undefined;
57718
+ /** Temperature to which the thermostat should cool (in °F). */
56787
57719
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57720
+ /** Temperature to which the thermostat should heat (in °F). */
56788
57721
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57722
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56789
57723
  manual_override_allowed?: boolean | undefined;
56790
57724
  } | undefined;
56791
57725
  /**
56792
57726
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
56793
57727
  default_climate_setting?: {
57728
+ /** Unique key to identify the climate preset. */
56794
57729
  climate_preset_key?: string | undefined;
57730
+ /** Indicates whether this climate preset key can be edited. */
56795
57731
  can_edit?: boolean | undefined;
57732
+ /** Indicates whether this climate preset key can be deleted. */
56796
57733
  can_delete?: boolean | undefined;
57734
+ /** User-friendly name to identify the climate preset. */
56797
57735
  name?: ((string | null) | undefined) | undefined;
57736
+ /** Display name for the climate preset. */
56798
57737
  display_name?: string | undefined;
57738
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56799
57739
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57740
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56800
57741
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57742
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56801
57743
  cooling_set_point_celsius?: (number | undefined) | undefined;
57744
+ /** Temperature to which the thermostat should heat (in °C). */
56802
57745
  heating_set_point_celsius?: (number | undefined) | undefined;
57746
+ /** Temperature to which the thermostat should cool (in °F). */
56803
57747
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57748
+ /** Temperature to which the thermostat should heat (in °F). */
56804
57749
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57750
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56805
57751
  manual_override_allowed?: boolean | undefined;
56806
57752
  } | undefined;
56807
57753
  available_climate_presets?: Array<{
57754
+ /** Unique key to identify the climate preset. */
56808
57755
  climate_preset_key: string;
57756
+ /** Indicates whether this climate preset key can be edited. */
56809
57757
  can_edit: boolean;
57758
+ /** Indicates whether this climate preset key can be deleted. */
56810
57759
  can_delete: boolean;
57760
+ /** User-friendly name to identify the climate preset. */
56811
57761
  name?: (string | null) | undefined;
57762
+ /** Display name for the climate preset. */
56812
57763
  display_name: string;
57764
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56813
57765
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
57766
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56814
57767
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
57768
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56815
57769
  cooling_set_point_celsius?: number | undefined;
57770
+ /** Temperature to which the thermostat should heat (in °C). */
56816
57771
  heating_set_point_celsius?: number | undefined;
57772
+ /** Temperature to which the thermostat should cool (in °F). */
56817
57773
  cooling_set_point_fahrenheit?: number | undefined;
57774
+ /** Temperature to which the thermostat should heat (in °F). */
56818
57775
  heating_set_point_fahrenheit?: number | undefined;
57776
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56819
57777
  manual_override_allowed: boolean;
56820
57778
  }> | undefined;
56821
57779
  fallback_climate_preset_key?: (string | null) | undefined;
56822
57780
  active_thermostat_schedule?: ({
57781
+ /** ID of the climate schedule. */
56823
57782
  thermostat_schedule_id: string;
57783
+ /** ID of the desired thermostat device. */
56824
57784
  device_id: string;
57785
+ /** User-friendly name to identify the climate schedule. */
56825
57786
  name?: string | undefined;
57787
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
56826
57788
  climate_preset_key: string;
57789
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
56827
57790
  max_override_period_minutes: number;
57791
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56828
57792
  starts_at: string;
57793
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56829
57794
  ends_at: string;
57795
+ /** Date and time at which the climate schedule was created. */
56830
57796
  created_at: string;
56831
- /** 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. */
57797
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
56832
57798
  errors?: any;
56833
57799
  } | null) | undefined;
56834
57800
  min_cooling_set_point_celsius?: number | undefined;