@seamapi/types 1.291.0 → 1.292.1

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