@seamapi/types 1.290.0 → 1.292.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/connect.cjs +688 -193
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1099 -82
  4. package/lib/seam/connect/models/acs/acs-encoder.d.ts +52 -7
  5. package/lib/seam/connect/models/acs/acs-encoder.js +28 -4
  6. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.js +15 -9
  8. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  9. package/lib/seam/connect/models/events/acs/encoders.d.ts +126 -0
  10. package/lib/seam/connect/models/events/acs/encoders.js +20 -0
  11. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -0
  12. package/lib/seam/connect/models/events/acs/index.d.ts +60 -0
  13. package/lib/seam/connect/models/events/acs/index.js +2 -0
  14. package/lib/seam/connect/models/events/acs/index.js.map +1 -1
  15. package/lib/seam/connect/models/events/seam-event.d.ts +60 -0
  16. package/lib/seam/connect/models/thermostats/climate-preset.js +41 -12
  17. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  18. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +30 -9
  19. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  20. package/lib/seam/connect/openapi.d.ts +218 -23
  21. package/lib/seam/connect/openapi.js +598 -133
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +803 -52
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-encoder.ts +40 -6
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +29 -21
  27. package/src/lib/seam/connect/models/events/acs/encoders.ts +28 -0
  28. package/src/lib/seam/connect/models/events/acs/index.ts +2 -0
  29. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +49 -12
  30. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +38 -9
  31. package/src/lib/seam/connect/openapi.ts +754 -133
  32. package/src/lib/seam/connect/route-types.ts +805 -50
@@ -696,15 +696,22 @@ declare const acs_encoder: z.ZodObject<{
696
696
  acs_encoder_id: z.ZodString;
697
697
  acs_system_id: z.ZodString;
698
698
  workspace_id: z.ZodString;
699
- errors: z.ZodArray<z.ZodObject<{
700
- error_code: z.ZodString;
699
+ errors: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
700
+ created_at: z.ZodString;
701
701
  message: z.ZodString;
702
- }, "strip", z.ZodTypeAny, {
702
+ }, {
703
+ error_code: z.ZodLiteral<"acs_encoder_removed">;
704
+ _event_id: z.ZodString;
705
+ }>, "strip", z.ZodTypeAny, {
703
706
  message: string;
704
- error_code: string;
707
+ error_code: "acs_encoder_removed";
708
+ created_at: string;
709
+ _event_id: string;
705
710
  }, {
706
711
  message: string;
707
- error_code: string;
712
+ error_code: "acs_encoder_removed";
713
+ created_at: string;
714
+ _event_id: string;
708
715
  }>, "many">;
709
716
  created_at: z.ZodString;
710
717
  display_name: z.ZodString;
@@ -712,7 +719,9 @@ declare const acs_encoder: z.ZodObject<{
712
719
  created_at: string;
713
720
  errors: {
714
721
  message: string;
715
- error_code: string;
722
+ error_code: "acs_encoder_removed";
723
+ created_at: string;
724
+ _event_id: string;
716
725
  }[];
717
726
  display_name: string;
718
727
  workspace_id: string;
@@ -722,7 +731,9 @@ declare const acs_encoder: z.ZodObject<{
722
731
  created_at: string;
723
732
  errors: {
724
733
  message: string;
725
- error_code: string;
734
+ error_code: "acs_encoder_removed";
735
+ created_at: string;
736
+ _event_id: string;
726
737
  }[];
727
738
  display_name: string;
728
739
  workspace_id: string;
@@ -10300,6 +10311,66 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<z.o
10300
10311
  occurred_at: string;
10301
10312
  event_type: "acs_user.deleted";
10302
10313
  connected_account_id?: string | undefined;
10314
+ }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
10315
+ event_id: z.ZodString;
10316
+ workspace_id: z.ZodString;
10317
+ created_at: z.ZodString;
10318
+ occurred_at: z.ZodString;
10319
+ }, {
10320
+ connected_account_id: z.ZodOptional<z.ZodString>;
10321
+ acs_system_id: z.ZodString;
10322
+ }>, {
10323
+ acs_encoder_id: z.ZodString;
10324
+ }>, {
10325
+ event_type: z.ZodLiteral<"acs_encoder.added">;
10326
+ }>, "strip", z.ZodTypeAny, {
10327
+ created_at: string;
10328
+ workspace_id: string;
10329
+ acs_system_id: string;
10330
+ acs_encoder_id: string;
10331
+ event_id: string;
10332
+ occurred_at: string;
10333
+ event_type: "acs_encoder.added";
10334
+ connected_account_id?: string | undefined;
10335
+ }, {
10336
+ created_at: string;
10337
+ workspace_id: string;
10338
+ acs_system_id: string;
10339
+ acs_encoder_id: string;
10340
+ event_id: string;
10341
+ occurred_at: string;
10342
+ event_type: "acs_encoder.added";
10343
+ connected_account_id?: string | undefined;
10344
+ }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
10345
+ event_id: z.ZodString;
10346
+ workspace_id: z.ZodString;
10347
+ created_at: z.ZodString;
10348
+ occurred_at: z.ZodString;
10349
+ }, {
10350
+ connected_account_id: z.ZodOptional<z.ZodString>;
10351
+ acs_system_id: z.ZodString;
10352
+ }>, {
10353
+ acs_encoder_id: z.ZodString;
10354
+ }>, {
10355
+ event_type: z.ZodLiteral<"acs_encoder.removed">;
10356
+ }>, "strip", z.ZodTypeAny, {
10357
+ created_at: string;
10358
+ workspace_id: string;
10359
+ acs_system_id: string;
10360
+ acs_encoder_id: string;
10361
+ event_id: string;
10362
+ occurred_at: string;
10363
+ event_type: "acs_encoder.removed";
10364
+ connected_account_id?: string | undefined;
10365
+ }, {
10366
+ created_at: string;
10367
+ workspace_id: string;
10368
+ acs_system_id: string;
10369
+ acs_encoder_id: string;
10370
+ event_id: string;
10371
+ occurred_at: string;
10372
+ event_type: "acs_encoder.removed";
10373
+ connected_account_id?: string | undefined;
10303
10374
  }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
10304
10375
  event_id: z.ZodString;
10305
10376
  workspace_id: z.ZodString;
@@ -12440,7 +12511,7 @@ declare const _default: {
12440
12511
  description: string;
12441
12512
  items: {
12442
12513
  description: string;
12443
- oneOf: ({
12514
+ oneOf: {
12444
12515
  description: string;
12445
12516
  properties: {
12446
12517
  created_at: {
@@ -12460,27 +12531,7 @@ declare const _default: {
12460
12531
  };
12461
12532
  required: string[];
12462
12533
  type: string;
12463
- } | {
12464
- properties: {
12465
- created_at: {
12466
- description: string;
12467
- format: string;
12468
- type: string;
12469
- };
12470
- error_code: {
12471
- description: string;
12472
- enum: string[];
12473
- type: string;
12474
- };
12475
- message: {
12476
- description: string;
12477
- type: string;
12478
- };
12479
- };
12480
- required: string[];
12481
- type: string;
12482
- description?: never;
12483
- })[];
12534
+ }[];
12484
12535
  };
12485
12536
  type: string;
12486
12537
  };
@@ -15059,17 +15110,21 @@ declare const _default: {
15059
15110
  nullable: boolean;
15060
15111
  properties: {
15061
15112
  climate_preset_key: {
15113
+ description: string;
15062
15114
  type: string;
15063
15115
  };
15064
15116
  created_at: {
15117
+ description: string;
15065
15118
  format: string;
15066
15119
  type: string;
15067
15120
  };
15068
15121
  device_id: {
15122
+ description: string;
15069
15123
  format: string;
15070
15124
  type: string;
15071
15125
  };
15072
15126
  ends_at: {
15127
+ description: string;
15073
15128
  format: string;
15074
15129
  type: string;
15075
15130
  };
@@ -15077,17 +15132,21 @@ declare const _default: {
15077
15132
  description: string;
15078
15133
  };
15079
15134
  max_override_period_minutes: {
15135
+ description: string;
15080
15136
  minimum: number;
15081
15137
  type: string;
15082
15138
  };
15083
15139
  name: {
15140
+ description: string;
15084
15141
  type: string;
15085
15142
  };
15086
15143
  starts_at: {
15144
+ description: string;
15087
15145
  format: string;
15088
15146
  type: string;
15089
15147
  };
15090
15148
  thermostat_schedule_id: {
15149
+ description: string;
15091
15150
  format: string;
15092
15151
  type: string;
15093
15152
  };
@@ -15099,46 +15158,58 @@ declare const _default: {
15099
15158
  items: {
15100
15159
  properties: {
15101
15160
  can_delete: {
15161
+ description: string;
15102
15162
  type: string;
15103
15163
  };
15104
15164
  can_edit: {
15165
+ description: string;
15105
15166
  type: string;
15106
15167
  };
15107
15168
  climate_preset_key: {
15169
+ description: string;
15108
15170
  type: string;
15109
15171
  };
15110
15172
  cooling_set_point_celsius: {
15173
+ description: string;
15111
15174
  format: string;
15112
15175
  type: string;
15113
15176
  };
15114
15177
  cooling_set_point_fahrenheit: {
15178
+ description: string;
15115
15179
  format: string;
15116
15180
  type: string;
15117
15181
  };
15118
15182
  display_name: {
15183
+ description: string;
15119
15184
  type: string;
15120
15185
  };
15121
15186
  fan_mode_setting: {
15187
+ description: string;
15122
15188
  enum: string[];
15123
15189
  type: string;
15124
15190
  };
15125
15191
  heating_set_point_celsius: {
15192
+ description: string;
15126
15193
  format: string;
15127
15194
  type: string;
15128
15195
  };
15129
15196
  heating_set_point_fahrenheit: {
15197
+ description: string;
15130
15198
  format: string;
15131
15199
  type: string;
15132
15200
  };
15133
15201
  hvac_mode_setting: {
15202
+ description: string;
15134
15203
  enum: string[];
15135
15204
  type: string;
15136
15205
  };
15137
15206
  manual_override_allowed: {
15207
+ description: string;
15138
15208
  type: string;
15139
15209
  };
15140
15210
  name: {
15141
15211
  default: null;
15212
+ description: string;
15142
15213
  nullable: boolean;
15143
15214
  type: string;
15144
15215
  };
@@ -15165,46 +15236,58 @@ declare const _default: {
15165
15236
  current_climate_setting: {
15166
15237
  properties: {
15167
15238
  can_delete: {
15239
+ description: string;
15168
15240
  type: string;
15169
15241
  };
15170
15242
  can_edit: {
15243
+ description: string;
15171
15244
  type: string;
15172
15245
  };
15173
15246
  climate_preset_key: {
15247
+ description: string;
15174
15248
  type: string;
15175
15249
  };
15176
15250
  cooling_set_point_celsius: {
15251
+ description: string;
15177
15252
  format: string;
15178
15253
  type: string;
15179
15254
  };
15180
15255
  cooling_set_point_fahrenheit: {
15256
+ description: string;
15181
15257
  format: string;
15182
15258
  type: string;
15183
15259
  };
15184
15260
  display_name: {
15261
+ description: string;
15185
15262
  type: string;
15186
15263
  };
15187
15264
  fan_mode_setting: {
15265
+ description: string;
15188
15266
  enum: string[];
15189
15267
  type: string;
15190
15268
  };
15191
15269
  heating_set_point_celsius: {
15270
+ description: string;
15192
15271
  format: string;
15193
15272
  type: string;
15194
15273
  };
15195
15274
  heating_set_point_fahrenheit: {
15275
+ description: string;
15196
15276
  format: string;
15197
15277
  type: string;
15198
15278
  };
15199
15279
  hvac_mode_setting: {
15280
+ description: string;
15200
15281
  enum: string[];
15201
15282
  type: string;
15202
15283
  };
15203
15284
  manual_override_allowed: {
15285
+ description: string;
15204
15286
  type: string;
15205
15287
  };
15206
15288
  name: {
15207
15289
  default: null;
15290
+ description: string;
15208
15291
  nullable: boolean;
15209
15292
  type: string;
15210
15293
  };
@@ -15215,46 +15298,58 @@ declare const _default: {
15215
15298
  deprecated: boolean;
15216
15299
  properties: {
15217
15300
  can_delete: {
15301
+ description: string;
15218
15302
  type: string;
15219
15303
  };
15220
15304
  can_edit: {
15305
+ description: string;
15221
15306
  type: string;
15222
15307
  };
15223
15308
  climate_preset_key: {
15309
+ description: string;
15224
15310
  type: string;
15225
15311
  };
15226
15312
  cooling_set_point_celsius: {
15313
+ description: string;
15227
15314
  format: string;
15228
15315
  type: string;
15229
15316
  };
15230
15317
  cooling_set_point_fahrenheit: {
15318
+ description: string;
15231
15319
  format: string;
15232
15320
  type: string;
15233
15321
  };
15234
15322
  display_name: {
15323
+ description: string;
15235
15324
  type: string;
15236
15325
  };
15237
15326
  fan_mode_setting: {
15327
+ description: string;
15238
15328
  enum: string[];
15239
15329
  type: string;
15240
15330
  };
15241
15331
  heating_set_point_celsius: {
15332
+ description: string;
15242
15333
  format: string;
15243
15334
  type: string;
15244
15335
  };
15245
15336
  heating_set_point_fahrenheit: {
15337
+ description: string;
15246
15338
  format: string;
15247
15339
  type: string;
15248
15340
  };
15249
15341
  hvac_mode_setting: {
15342
+ description: string;
15250
15343
  enum: string[];
15251
15344
  type: string;
15252
15345
  };
15253
15346
  manual_override_allowed: {
15347
+ description: string;
15254
15348
  type: string;
15255
15349
  };
15256
15350
  name: {
15257
15351
  default: null;
15352
+ description: string;
15258
15353
  nullable: boolean;
15259
15354
  type: string;
15260
15355
  };
@@ -15837,17 +15932,21 @@ declare const _default: {
15837
15932
  thermostat_schedule: {
15838
15933
  properties: {
15839
15934
  climate_preset_key: {
15935
+ description: string;
15840
15936
  type: string;
15841
15937
  };
15842
15938
  created_at: {
15939
+ description: string;
15843
15940
  format: string;
15844
15941
  type: string;
15845
15942
  };
15846
15943
  device_id: {
15944
+ description: string;
15847
15945
  format: string;
15848
15946
  type: string;
15849
15947
  };
15850
15948
  ends_at: {
15949
+ description: string;
15851
15950
  format: string;
15852
15951
  type: string;
15853
15952
  };
@@ -15855,17 +15954,21 @@ declare const _default: {
15855
15954
  description: string;
15856
15955
  };
15857
15956
  max_override_period_minutes: {
15957
+ description: string;
15858
15958
  minimum: number;
15859
15959
  type: string;
15860
15960
  };
15861
15961
  name: {
15962
+ description: string;
15862
15963
  type: string;
15863
15964
  };
15864
15965
  starts_at: {
15966
+ description: string;
15865
15967
  format: string;
15866
15968
  type: string;
15867
15969
  };
15868
15970
  thermostat_schedule_id: {
15971
+ description: string;
15869
15972
  format: string;
15870
15973
  type: string;
15871
15974
  };
@@ -24882,6 +24985,7 @@ declare const _default: {
24882
24985
  };
24883
24986
  '/devices/list': {
24884
24987
  post: {
24988
+ description: string;
24885
24989
  operationId: string;
24886
24990
  requestBody: {
24887
24991
  content: {
@@ -24889,6 +24993,7 @@ declare const _default: {
24889
24993
  schema: {
24890
24994
  properties: {
24891
24995
  connect_webview_id: {
24996
+ description: string;
24892
24997
  format: string;
24893
24998
  type: string;
24894
24999
  };
@@ -24898,6 +25003,7 @@ declare const _default: {
24898
25003
  type: string;
24899
25004
  };
24900
25005
  connected_account_ids: {
25006
+ description: string;
24901
25007
  items: {
24902
25008
  format: string;
24903
25009
  type: string;
@@ -24905,6 +25011,7 @@ declare const _default: {
24905
25011
  type: string;
24906
25012
  };
24907
25013
  created_before: {
25014
+ description: string;
24908
25015
  format: string;
24909
25016
  type: string;
24910
25017
  };
@@ -24914,9 +25021,11 @@ declare const _default: {
24914
25021
  type: string;
24915
25022
  }[];
24916
25023
  };
25024
+ description: string;
24917
25025
  type: string;
24918
25026
  };
24919
25027
  device_ids: {
25028
+ description: string;
24920
25029
  items: {
24921
25030
  format: string;
24922
25031
  type: string;
@@ -24924,12 +25033,14 @@ declare const _default: {
24924
25033
  type: string;
24925
25034
  };
24926
25035
  device_type: {
25036
+ description: string;
24927
25037
  oneOf: {
24928
25038
  enum: string[];
24929
25039
  type: string;
24930
25040
  }[];
24931
25041
  };
24932
25042
  device_types: {
25043
+ description: string;
24933
25044
  items: {
24934
25045
  oneOf: {
24935
25046
  enum: string[];
@@ -24944,6 +25055,7 @@ declare const _default: {
24944
25055
  type: string;
24945
25056
  };
24946
25057
  type: string;
25058
+ 'x-undocumented': string;
24947
25059
  };
24948
25060
  include_if: {
24949
25061
  items: {
@@ -24951,17 +25063,21 @@ declare const _default: {
24951
25063
  type: string;
24952
25064
  };
24953
25065
  type: string;
25066
+ 'x-undocumented': string;
24954
25067
  };
24955
25068
  limit: {
24956
25069
  default: number;
25070
+ description: string;
24957
25071
  format: string;
24958
25072
  type: string;
24959
25073
  };
24960
25074
  manufacturer: {
25075
+ description: string;
24961
25076
  enum: string[];
24962
25077
  type: string;
24963
25078
  };
24964
25079
  user_identifier_key: {
25080
+ description: string;
24965
25081
  type: string;
24966
25082
  };
24967
25083
  };
@@ -25027,6 +25143,7 @@ declare const _default: {
25027
25143
  'x-fern-sdk-method-name': string;
25028
25144
  'x-fern-sdk-return-value': string;
25029
25145
  'x-response-key': string;
25146
+ 'x-title': string;
25030
25147
  };
25031
25148
  };
25032
25149
  '/devices/list_device_providers': {
@@ -25381,6 +25498,7 @@ declare const _default: {
25381
25498
  schema: {
25382
25499
  properties: {
25383
25500
  connect_webview_id: {
25501
+ description: string;
25384
25502
  format: string;
25385
25503
  type: string;
25386
25504
  };
@@ -25390,6 +25508,7 @@ declare const _default: {
25390
25508
  type: string;
25391
25509
  };
25392
25510
  connected_account_ids: {
25511
+ description: string;
25393
25512
  items: {
25394
25513
  format: string;
25395
25514
  type: string;
@@ -25397,6 +25516,7 @@ declare const _default: {
25397
25516
  type: string;
25398
25517
  };
25399
25518
  created_before: {
25519
+ description: string;
25400
25520
  format: string;
25401
25521
  type: string;
25402
25522
  };
@@ -25406,9 +25526,11 @@ declare const _default: {
25406
25526
  type: string;
25407
25527
  }[];
25408
25528
  };
25529
+ description: string;
25409
25530
  type: string;
25410
25531
  };
25411
25532
  device_ids: {
25533
+ description: string;
25412
25534
  items: {
25413
25535
  format: string;
25414
25536
  type: string;
@@ -25416,12 +25538,14 @@ declare const _default: {
25416
25538
  type: string;
25417
25539
  };
25418
25540
  device_type: {
25541
+ description: string;
25419
25542
  oneOf: {
25420
25543
  enum: string[];
25421
25544
  type: string;
25422
25545
  }[];
25423
25546
  };
25424
25547
  device_types: {
25548
+ description: string;
25425
25549
  items: {
25426
25550
  oneOf: {
25427
25551
  enum: string[];
@@ -25436,6 +25560,7 @@ declare const _default: {
25436
25560
  type: string;
25437
25561
  };
25438
25562
  type: string;
25563
+ 'x-undocumented': string;
25439
25564
  };
25440
25565
  include_if: {
25441
25566
  items: {
@@ -25443,17 +25568,21 @@ declare const _default: {
25443
25568
  type: string;
25444
25569
  };
25445
25570
  type: string;
25571
+ 'x-undocumented': string;
25446
25572
  };
25447
25573
  limit: {
25448
25574
  default: number;
25575
+ description: string;
25449
25576
  format: string;
25450
25577
  type: string;
25451
25578
  };
25452
25579
  manufacturer: {
25580
+ description: string;
25453
25581
  enum: string[];
25454
25582
  type: string;
25455
25583
  };
25456
25584
  user_identifier_key: {
25585
+ description: string;
25457
25586
  type: string;
25458
25587
  };
25459
25588
  };
@@ -26152,6 +26281,7 @@ declare const _default: {
26152
26281
  schema: {
26153
26282
  properties: {
26154
26283
  connect_webview_id: {
26284
+ description: string;
26155
26285
  format: string;
26156
26286
  type: string;
26157
26287
  };
@@ -26161,6 +26291,7 @@ declare const _default: {
26161
26291
  type: string;
26162
26292
  };
26163
26293
  connected_account_ids: {
26294
+ description: string;
26164
26295
  items: {
26165
26296
  format: string;
26166
26297
  type: string;
@@ -26168,6 +26299,7 @@ declare const _default: {
26168
26299
  type: string;
26169
26300
  };
26170
26301
  created_before: {
26302
+ description: string;
26171
26303
  format: string;
26172
26304
  type: string;
26173
26305
  };
@@ -26177,9 +26309,11 @@ declare const _default: {
26177
26309
  type: string;
26178
26310
  }[];
26179
26311
  };
26312
+ description: string;
26180
26313
  type: string;
26181
26314
  };
26182
26315
  device_ids: {
26316
+ description: string;
26183
26317
  items: {
26184
26318
  format: string;
26185
26319
  type: string;
@@ -26187,12 +26321,14 @@ declare const _default: {
26187
26321
  type: string;
26188
26322
  };
26189
26323
  device_type: {
26324
+ description: string;
26190
26325
  oneOf: {
26191
26326
  enum: string[];
26192
26327
  type: string;
26193
26328
  }[];
26194
26329
  };
26195
26330
  device_types: {
26331
+ description: string;
26196
26332
  items: {
26197
26333
  oneOf: {
26198
26334
  enum: string[];
@@ -26207,6 +26343,7 @@ declare const _default: {
26207
26343
  type: string;
26208
26344
  };
26209
26345
  type: string;
26346
+ 'x-undocumented': string;
26210
26347
  };
26211
26348
  include_if: {
26212
26349
  items: {
@@ -26214,17 +26351,21 @@ declare const _default: {
26214
26351
  type: string;
26215
26352
  };
26216
26353
  type: string;
26354
+ 'x-undocumented': string;
26217
26355
  };
26218
26356
  limit: {
26219
26357
  default: number;
26358
+ description: string;
26220
26359
  format: string;
26221
26360
  type: string;
26222
26361
  };
26223
26362
  manufacturer: {
26363
+ description: string;
26224
26364
  enum: string[];
26225
26365
  type: string;
26226
26366
  };
26227
26367
  user_identifier_key: {
26368
+ description: string;
26228
26369
  type: string;
26229
26370
  };
26230
26371
  };
@@ -26596,6 +26737,7 @@ declare const _default: {
26596
26737
  schema: {
26597
26738
  properties: {
26598
26739
  connect_webview_id: {
26740
+ description: string;
26599
26741
  format: string;
26600
26742
  type: string;
26601
26743
  };
@@ -26605,6 +26747,7 @@ declare const _default: {
26605
26747
  type: string;
26606
26748
  };
26607
26749
  connected_account_ids: {
26750
+ description: string;
26608
26751
  items: {
26609
26752
  format: string;
26610
26753
  type: string;
@@ -26612,6 +26755,7 @@ declare const _default: {
26612
26755
  type: string;
26613
26756
  };
26614
26757
  created_before: {
26758
+ description: string;
26615
26759
  format: string;
26616
26760
  type: string;
26617
26761
  };
@@ -26621,9 +26765,11 @@ declare const _default: {
26621
26765
  type: string;
26622
26766
  }[];
26623
26767
  };
26768
+ description: string;
26624
26769
  type: string;
26625
26770
  };
26626
26771
  device_ids: {
26772
+ description: string;
26627
26773
  items: {
26628
26774
  format: string;
26629
26775
  type: string;
@@ -26631,12 +26777,14 @@ declare const _default: {
26631
26777
  type: string;
26632
26778
  };
26633
26779
  device_type: {
26780
+ description: string;
26634
26781
  oneOf: {
26635
26782
  enum: string[];
26636
26783
  type: string;
26637
26784
  }[];
26638
26785
  };
26639
26786
  device_types: {
26787
+ description: string;
26640
26788
  items: {
26641
26789
  oneOf: {
26642
26790
  enum: string[];
@@ -26651,6 +26799,7 @@ declare const _default: {
26651
26799
  type: string;
26652
26800
  };
26653
26801
  type: string;
26802
+ 'x-undocumented': string;
26654
26803
  };
26655
26804
  include_if: {
26656
26805
  items: {
@@ -26658,17 +26807,21 @@ declare const _default: {
26658
26807
  type: string;
26659
26808
  };
26660
26809
  type: string;
26810
+ 'x-undocumented': string;
26661
26811
  };
26662
26812
  limit: {
26663
26813
  default: number;
26814
+ description: string;
26664
26815
  format: string;
26665
26816
  type: string;
26666
26817
  };
26667
26818
  manufacturer: {
26819
+ description: string;
26668
26820
  enum: string[];
26669
26821
  type: string;
26670
26822
  };
26671
26823
  user_identifier_key: {
26824
+ description: string;
26672
26825
  type: string;
26673
26826
  };
26674
26827
  };
@@ -27654,6 +27807,7 @@ declare const _default: {
27654
27807
  };
27655
27808
  '/thermostats/activate_climate_preset': {
27656
27809
  post: {
27810
+ description: string;
27657
27811
  operationId: string;
27658
27812
  requestBody: {
27659
27813
  content: {
@@ -27661,9 +27815,11 @@ declare const _default: {
27661
27815
  schema: {
27662
27816
  properties: {
27663
27817
  climate_preset_key: {
27818
+ description: string;
27664
27819
  type: string;
27665
27820
  };
27666
27821
  device_id: {
27822
+ description: string;
27667
27823
  format: string;
27668
27824
  type: string;
27669
27825
  };
@@ -27720,6 +27876,7 @@ declare const _default: {
27720
27876
  'x-fern-sdk-method-name': string;
27721
27877
  'x-fern-sdk-return-value': string;
27722
27878
  'x-response-key': string;
27879
+ 'x-title': string;
27723
27880
  };
27724
27881
  };
27725
27882
  '/thermostats/cool': {
@@ -27749,6 +27906,7 @@ declare const _default: {
27749
27906
  sync: {
27750
27907
  default: boolean;
27751
27908
  type: string;
27909
+ 'x-undocumented': string;
27752
27910
  };
27753
27911
  };
27754
27912
  required: string[];
@@ -27816,6 +27974,7 @@ declare const _default: {
27816
27974
  };
27817
27975
  '/thermostats/create_climate_preset': {
27818
27976
  post: {
27977
+ description: string;
27819
27978
  operationId: string;
27820
27979
  requestBody: {
27821
27980
  content: {
@@ -27823,41 +27982,51 @@ declare const _default: {
27823
27982
  schema: {
27824
27983
  properties: {
27825
27984
  climate_preset_key: {
27985
+ description: string;
27826
27986
  type: string;
27827
27987
  };
27828
27988
  cooling_set_point_celsius: {
27989
+ description: string;
27829
27990
  format: string;
27830
27991
  type: string;
27831
27992
  };
27832
27993
  cooling_set_point_fahrenheit: {
27994
+ description: string;
27833
27995
  format: string;
27834
27996
  type: string;
27835
27997
  };
27836
27998
  device_id: {
27999
+ description: string;
27837
28000
  format: string;
27838
28001
  type: string;
27839
28002
  };
27840
28003
  fan_mode_setting: {
28004
+ description: string;
27841
28005
  enum: string[];
27842
28006
  type: string;
27843
28007
  };
27844
28008
  heating_set_point_celsius: {
28009
+ description: string;
27845
28010
  format: string;
27846
28011
  type: string;
27847
28012
  };
27848
28013
  heating_set_point_fahrenheit: {
28014
+ description: string;
27849
28015
  format: string;
27850
28016
  type: string;
27851
28017
  };
27852
28018
  hvac_mode_setting: {
28019
+ description: string;
27853
28020
  enum: string[];
27854
28021
  type: string;
27855
28022
  };
27856
28023
  manual_override_allowed: {
28024
+ description: string;
27857
28025
  type: string;
27858
28026
  };
27859
28027
  name: {
27860
28028
  default: null;
28029
+ description: string;
27861
28030
  nullable: boolean;
27862
28031
  type: string;
27863
28032
  };
@@ -27910,10 +28079,12 @@ declare const _default: {
27910
28079
  'x-fern-sdk-group-name': string[];
27911
28080
  'x-fern-sdk-method-name': string;
27912
28081
  'x-response-key': null;
28082
+ 'x-title': string;
27913
28083
  };
27914
28084
  };
27915
28085
  '/thermostats/delete_climate_preset': {
27916
28086
  post: {
28087
+ description: string;
27917
28088
  operationId: string;
27918
28089
  requestBody: {
27919
28090
  content: {
@@ -27921,9 +28092,11 @@ declare const _default: {
27921
28092
  schema: {
27922
28093
  properties: {
27923
28094
  climate_preset_key: {
28095
+ description: string;
27924
28096
  type: string;
27925
28097
  };
27926
28098
  device_id: {
28099
+ description: string;
27927
28100
  format: string;
27928
28101
  type: string;
27929
28102
  };
@@ -27976,6 +28149,7 @@ declare const _default: {
27976
28149
  'x-fern-sdk-group-name': string[];
27977
28150
  'x-fern-sdk-method-name': string;
27978
28151
  'x-response-key': null;
28152
+ 'x-title': string;
27979
28153
  };
27980
28154
  };
27981
28155
  '/thermostats/get': {
@@ -28058,6 +28232,7 @@ declare const _default: {
28058
28232
  'x-fern-sdk-return-value': string;
28059
28233
  'x-response-key': string;
28060
28234
  'x-title': string;
28235
+ 'x-undocumented': string;
28061
28236
  };
28062
28237
  };
28063
28238
  '/thermostats/heat': {
@@ -28087,6 +28262,7 @@ declare const _default: {
28087
28262
  sync: {
28088
28263
  default: boolean;
28089
28264
  type: string;
28265
+ 'x-undocumented': string;
28090
28266
  };
28091
28267
  };
28092
28268
  required: string[];
@@ -28189,6 +28365,7 @@ declare const _default: {
28189
28365
  sync: {
28190
28366
  default: boolean;
28191
28367
  type: string;
28368
+ 'x-undocumented': string;
28192
28369
  };
28193
28370
  };
28194
28371
  required: string[];
@@ -28264,6 +28441,7 @@ declare const _default: {
28264
28441
  schema: {
28265
28442
  properties: {
28266
28443
  connect_webview_id: {
28444
+ description: string;
28267
28445
  format: string;
28268
28446
  type: string;
28269
28447
  };
@@ -28273,6 +28451,7 @@ declare const _default: {
28273
28451
  type: string;
28274
28452
  };
28275
28453
  connected_account_ids: {
28454
+ description: string;
28276
28455
  items: {
28277
28456
  format: string;
28278
28457
  type: string;
@@ -28280,6 +28459,7 @@ declare const _default: {
28280
28459
  type: string;
28281
28460
  };
28282
28461
  created_before: {
28462
+ description: string;
28283
28463
  format: string;
28284
28464
  type: string;
28285
28465
  };
@@ -28289,9 +28469,11 @@ declare const _default: {
28289
28469
  type: string;
28290
28470
  }[];
28291
28471
  };
28472
+ description: string;
28292
28473
  type: string;
28293
28474
  };
28294
28475
  device_ids: {
28476
+ description: string;
28295
28477
  items: {
28296
28478
  format: string;
28297
28479
  type: string;
@@ -28299,12 +28481,14 @@ declare const _default: {
28299
28481
  type: string;
28300
28482
  };
28301
28483
  device_type: {
28484
+ description: string;
28302
28485
  oneOf: {
28303
28486
  enum: string[];
28304
28487
  type: string;
28305
28488
  }[];
28306
28489
  };
28307
28490
  device_types: {
28491
+ description: string;
28308
28492
  items: {
28309
28493
  oneOf: {
28310
28494
  enum: string[];
@@ -28319,6 +28503,7 @@ declare const _default: {
28319
28503
  type: string;
28320
28504
  };
28321
28505
  type: string;
28506
+ 'x-undocumented': string;
28322
28507
  };
28323
28508
  include_if: {
28324
28509
  items: {
@@ -28326,17 +28511,21 @@ declare const _default: {
28326
28511
  type: string;
28327
28512
  };
28328
28513
  type: string;
28514
+ 'x-undocumented': string;
28329
28515
  };
28330
28516
  limit: {
28331
28517
  default: number;
28518
+ description: string;
28332
28519
  format: string;
28333
28520
  type: string;
28334
28521
  };
28335
28522
  manufacturer: {
28523
+ description: string;
28336
28524
  enum: string[];
28337
28525
  type: string;
28338
28526
  };
28339
28527
  user_identifier_key: {
28528
+ description: string;
28340
28529
  type: string;
28341
28530
  };
28342
28531
  };
@@ -28428,6 +28617,7 @@ declare const _default: {
28428
28617
  sync: {
28429
28618
  default: boolean;
28430
28619
  type: string;
28620
+ 'x-undocumented': string;
28431
28621
  };
28432
28622
  };
28433
28623
  required: string[];
@@ -28495,6 +28685,7 @@ declare const _default: {
28495
28685
  };
28496
28686
  '/thermostats/schedules/create': {
28497
28687
  post: {
28688
+ description: string;
28498
28689
  operationId: string;
28499
28690
  requestBody: {
28500
28691
  content: {
@@ -28502,23 +28693,29 @@ declare const _default: {
28502
28693
  schema: {
28503
28694
  properties: {
28504
28695
  climate_preset_key: {
28696
+ description: string;
28505
28697
  type: string;
28506
28698
  };
28507
28699
  device_id: {
28700
+ description: string;
28508
28701
  type: string;
28509
28702
  };
28510
28703
  ends_at: {
28704
+ description: string;
28511
28705
  type: string;
28512
28706
  };
28513
28707
  max_override_period_minutes: {
28514
28708
  default: number;
28709
+ description: string;
28515
28710
  minimum: number;
28516
28711
  type: string;
28517
28712
  };
28518
28713
  name: {
28714
+ description: string;
28519
28715
  type: string;
28520
28716
  };
28521
28717
  starts_at: {
28718
+ description: string;
28522
28719
  type: string;
28523
28720
  };
28524
28721
  };
@@ -28582,10 +28779,12 @@ declare const _default: {
28582
28779
  'x-fern-sdk-method-name': string;
28583
28780
  'x-fern-sdk-return-value': string;
28584
28781
  'x-response-key': string;
28782
+ 'x-title': string;
28585
28783
  };
28586
28784
  };
28587
28785
  '/thermostats/schedules/delete': {
28588
28786
  post: {
28787
+ description: string;
28589
28788
  operationId: string;
28590
28789
  requestBody: {
28591
28790
  content: {
@@ -28593,6 +28792,7 @@ declare const _default: {
28593
28792
  schema: {
28594
28793
  properties: {
28595
28794
  thermostat_schedule_id: {
28795
+ description: string;
28596
28796
  format: string;
28597
28797
  type: string;
28598
28798
  };
@@ -28653,10 +28853,12 @@ declare const _default: {
28653
28853
  'x-fern-sdk-group-name': string[];
28654
28854
  'x-fern-sdk-method-name': string;
28655
28855
  'x-response-key': null;
28856
+ 'x-title': string;
28656
28857
  };
28657
28858
  };
28658
28859
  '/thermostats/schedules/get': {
28659
28860
  post: {
28861
+ description: string;
28660
28862
  operationId: string;
28661
28863
  requestBody: {
28662
28864
  content: {
@@ -28664,6 +28866,7 @@ declare const _default: {
28664
28866
  schema: {
28665
28867
  properties: {
28666
28868
  thermostat_schedule_id: {
28869
+ description: string;
28667
28870
  format: string;
28668
28871
  type: string;
28669
28872
  };
@@ -28728,10 +28931,12 @@ declare const _default: {
28728
28931
  'x-fern-sdk-method-name': string;
28729
28932
  'x-fern-sdk-return-value': string;
28730
28933
  'x-response-key': string;
28934
+ 'x-title': string;
28731
28935
  };
28732
28936
  };
28733
28937
  '/thermostats/schedules/list': {
28734
28938
  post: {
28939
+ description: string;
28735
28940
  operationId: string;
28736
28941
  requestBody: {
28737
28942
  content: {
@@ -28739,10 +28944,12 @@ declare const _default: {
28739
28944
  schema: {
28740
28945
  properties: {
28741
28946
  device_id: {
28947
+ description: string;
28742
28948
  format: string;
28743
28949
  type: string;
28744
28950
  };
28745
28951
  user_identifier_key: {
28952
+ description: string;
28746
28953
  type: string;
28747
28954
  };
28748
28955
  };
@@ -28809,10 +29016,12 @@ declare const _default: {
28809
29016
  'x-fern-sdk-method-name': string;
28810
29017
  'x-fern-sdk-return-value': string;
28811
29018
  'x-response-key': string;
29019
+ 'x-title': string;
28812
29020
  };
28813
29021
  };
28814
29022
  '/thermostats/schedules/update': {
28815
29023
  patch: {
29024
+ description: string;
28816
29025
  operationId: string;
28817
29026
  requestBody: {
28818
29027
  content: {
@@ -28820,22 +29029,28 @@ declare const _default: {
28820
29029
  schema: {
28821
29030
  properties: {
28822
29031
  climate_preset_key: {
29032
+ description: string;
28823
29033
  type: string;
28824
29034
  };
28825
29035
  ends_at: {
29036
+ description: string;
28826
29037
  type: string;
28827
29038
  };
28828
29039
  max_override_period_minutes: {
29040
+ description: string;
28829
29041
  minimum: number;
28830
29042
  type: string;
28831
29043
  };
28832
29044
  name: {
29045
+ description: string;
28833
29046
  type: string;
28834
29047
  };
28835
29048
  starts_at: {
29049
+ description: string;
28836
29050
  type: string;
28837
29051
  };
28838
29052
  thermostat_schedule_id: {
29053
+ description: string;
28839
29054
  format: string;
28840
29055
  type: string;
28841
29056
  };
@@ -28895,8 +29110,10 @@ declare const _default: {
28895
29110
  tags: string[];
28896
29111
  'x-fern-ignore': boolean;
28897
29112
  'x-response-key': null;
29113
+ 'x-title': string;
28898
29114
  };
28899
29115
  post: {
29116
+ description: string;
28900
29117
  operationId: string;
28901
29118
  requestBody: {
28902
29119
  content: {
@@ -28904,22 +29121,28 @@ declare const _default: {
28904
29121
  schema: {
28905
29122
  properties: {
28906
29123
  climate_preset_key: {
29124
+ description: string;
28907
29125
  type: string;
28908
29126
  };
28909
29127
  ends_at: {
29128
+ description: string;
28910
29129
  type: string;
28911
29130
  };
28912
29131
  max_override_period_minutes: {
29132
+ description: string;
28913
29133
  minimum: number;
28914
29134
  type: string;
28915
29135
  };
28916
29136
  name: {
29137
+ description: string;
28917
29138
  type: string;
28918
29139
  };
28919
29140
  starts_at: {
29141
+ description: string;
28920
29142
  type: string;
28921
29143
  };
28922
29144
  thermostat_schedule_id: {
29145
+ description: string;
28923
29146
  format: string;
28924
29147
  type: string;
28925
29148
  };
@@ -28980,10 +29203,12 @@ declare const _default: {
28980
29203
  'x-fern-sdk-group-name': string[];
28981
29204
  'x-fern-sdk-method-name': string;
28982
29205
  'x-response-key': null;
29206
+ 'x-title': string;
28983
29207
  };
28984
29208
  };
28985
29209
  '/thermostats/set_fallback_climate_preset': {
28986
29210
  post: {
29211
+ description: string;
28987
29212
  operationId: string;
28988
29213
  requestBody: {
28989
29214
  content: {
@@ -28991,9 +29216,11 @@ declare const _default: {
28991
29216
  schema: {
28992
29217
  properties: {
28993
29218
  climate_preset_key: {
29219
+ description: string;
28994
29220
  type: string;
28995
29221
  };
28996
29222
  device_id: {
29223
+ description: string;
28997
29224
  format: string;
28998
29225
  type: string;
28999
29226
  };
@@ -29046,6 +29273,7 @@ declare const _default: {
29046
29273
  'x-fern-sdk-group-name': string[];
29047
29274
  'x-fern-sdk-method-name': string;
29048
29275
  'x-response-key': null;
29276
+ 'x-title': string;
29049
29277
  };
29050
29278
  };
29051
29279
  '/thermostats/set_fan_mode': {
@@ -29058,7 +29286,6 @@ declare const _default: {
29058
29286
  schema: {
29059
29287
  properties: {
29060
29288
  device_id: {
29061
- description: string;
29062
29289
  format: string;
29063
29290
  type: string;
29064
29291
  };
@@ -29076,6 +29303,7 @@ declare const _default: {
29076
29303
  sync: {
29077
29304
  default: boolean;
29078
29305
  type: string;
29306
+ 'x-undocumented': string;
29079
29307
  };
29080
29308
  };
29081
29309
  required: string[];
@@ -29143,6 +29371,7 @@ declare const _default: {
29143
29371
  };
29144
29372
  '/thermostats/set_temperature_threshold': {
29145
29373
  patch: {
29374
+ description: string;
29146
29375
  operationId: string;
29147
29376
  requestBody: {
29148
29377
  content: {
@@ -29150,29 +29379,34 @@ declare const _default: {
29150
29379
  schema: {
29151
29380
  properties: {
29152
29381
  device_id: {
29382
+ description: string;
29153
29383
  format: string;
29154
29384
  type: string;
29155
29385
  };
29156
29386
  lower_limit_celsius: {
29157
29387
  default: null;
29388
+ description: string;
29158
29389
  format: string;
29159
29390
  nullable: boolean;
29160
29391
  type: string;
29161
29392
  };
29162
29393
  lower_limit_fahrenheit: {
29163
29394
  default: null;
29395
+ description: string;
29164
29396
  format: string;
29165
29397
  nullable: boolean;
29166
29398
  type: string;
29167
29399
  };
29168
29400
  upper_limit_celsius: {
29169
29401
  default: null;
29402
+ description: string;
29170
29403
  format: string;
29171
29404
  nullable: boolean;
29172
29405
  type: string;
29173
29406
  };
29174
29407
  upper_limit_fahrenheit: {
29175
29408
  default: null;
29409
+ description: string;
29176
29410
  format: string;
29177
29411
  nullable: boolean;
29178
29412
  type: string;
@@ -29225,8 +29459,10 @@ declare const _default: {
29225
29459
  tags: string[];
29226
29460
  'x-fern-ignore': boolean;
29227
29461
  'x-response-key': null;
29462
+ 'x-title': string;
29228
29463
  };
29229
29464
  post: {
29465
+ description: string;
29230
29466
  operationId: string;
29231
29467
  requestBody: {
29232
29468
  content: {
@@ -29234,29 +29470,34 @@ declare const _default: {
29234
29470
  schema: {
29235
29471
  properties: {
29236
29472
  device_id: {
29473
+ description: string;
29237
29474
  format: string;
29238
29475
  type: string;
29239
29476
  };
29240
29477
  lower_limit_celsius: {
29241
29478
  default: null;
29479
+ description: string;
29242
29480
  format: string;
29243
29481
  nullable: boolean;
29244
29482
  type: string;
29245
29483
  };
29246
29484
  lower_limit_fahrenheit: {
29247
29485
  default: null;
29486
+ description: string;
29248
29487
  format: string;
29249
29488
  nullable: boolean;
29250
29489
  type: string;
29251
29490
  };
29252
29491
  upper_limit_celsius: {
29253
29492
  default: null;
29493
+ description: string;
29254
29494
  format: string;
29255
29495
  nullable: boolean;
29256
29496
  type: string;
29257
29497
  };
29258
29498
  upper_limit_fahrenheit: {
29259
29499
  default: null;
29500
+ description: string;
29260
29501
  format: string;
29261
29502
  nullable: boolean;
29262
29503
  type: string;
@@ -29310,10 +29551,12 @@ declare const _default: {
29310
29551
  'x-fern-sdk-group-name': string[];
29311
29552
  'x-fern-sdk-method-name': string;
29312
29553
  'x-response-key': null;
29554
+ 'x-title': string;
29313
29555
  };
29314
29556
  };
29315
29557
  '/thermostats/update_climate_preset': {
29316
29558
  patch: {
29559
+ description: string;
29317
29560
  operationId: string;
29318
29561
  requestBody: {
29319
29562
  content: {
@@ -29321,41 +29564,51 @@ declare const _default: {
29321
29564
  schema: {
29322
29565
  properties: {
29323
29566
  climate_preset_key: {
29567
+ description: string;
29324
29568
  type: string;
29325
29569
  };
29326
29570
  cooling_set_point_celsius: {
29571
+ description: string;
29327
29572
  format: string;
29328
29573
  type: string;
29329
29574
  };
29330
29575
  cooling_set_point_fahrenheit: {
29576
+ description: string;
29331
29577
  format: string;
29332
29578
  type: string;
29333
29579
  };
29334
29580
  device_id: {
29581
+ description: string;
29335
29582
  format: string;
29336
29583
  type: string;
29337
29584
  };
29338
29585
  fan_mode_setting: {
29586
+ description: string;
29339
29587
  enum: string[];
29340
29588
  type: string;
29341
29589
  };
29342
29590
  heating_set_point_celsius: {
29591
+ description: string;
29343
29592
  format: string;
29344
29593
  type: string;
29345
29594
  };
29346
29595
  heating_set_point_fahrenheit: {
29596
+ description: string;
29347
29597
  format: string;
29348
29598
  type: string;
29349
29599
  };
29350
29600
  hvac_mode_setting: {
29601
+ description: string;
29351
29602
  enum: string[];
29352
29603
  type: string;
29353
29604
  };
29354
29605
  manual_override_allowed: {
29606
+ description: string;
29355
29607
  type: string;
29356
29608
  };
29357
29609
  name: {
29358
29610
  default: null;
29611
+ description: string;
29359
29612
  nullable: boolean;
29360
29613
  type: string;
29361
29614
  };
@@ -29407,8 +29660,10 @@ declare const _default: {
29407
29660
  tags: string[];
29408
29661
  'x-fern-ignore': boolean;
29409
29662
  'x-response-key': null;
29663
+ 'x-title': string;
29410
29664
  };
29411
29665
  post: {
29666
+ description: string;
29412
29667
  operationId: string;
29413
29668
  requestBody: {
29414
29669
  content: {
@@ -29416,41 +29671,51 @@ declare const _default: {
29416
29671
  schema: {
29417
29672
  properties: {
29418
29673
  climate_preset_key: {
29674
+ description: string;
29419
29675
  type: string;
29420
29676
  };
29421
29677
  cooling_set_point_celsius: {
29678
+ description: string;
29422
29679
  format: string;
29423
29680
  type: string;
29424
29681
  };
29425
29682
  cooling_set_point_fahrenheit: {
29683
+ description: string;
29426
29684
  format: string;
29427
29685
  type: string;
29428
29686
  };
29429
29687
  device_id: {
29688
+ description: string;
29430
29689
  format: string;
29431
29690
  type: string;
29432
29691
  };
29433
29692
  fan_mode_setting: {
29693
+ description: string;
29434
29694
  enum: string[];
29435
29695
  type: string;
29436
29696
  };
29437
29697
  heating_set_point_celsius: {
29698
+ description: string;
29438
29699
  format: string;
29439
29700
  type: string;
29440
29701
  };
29441
29702
  heating_set_point_fahrenheit: {
29703
+ description: string;
29442
29704
  format: string;
29443
29705
  type: string;
29444
29706
  };
29445
29707
  hvac_mode_setting: {
29708
+ description: string;
29446
29709
  enum: string[];
29447
29710
  type: string;
29448
29711
  };
29449
29712
  manual_override_allowed: {
29713
+ description: string;
29450
29714
  type: string;
29451
29715
  };
29452
29716
  name: {
29453
29717
  default: null;
29718
+ description: string;
29454
29719
  nullable: boolean;
29455
29720
  type: string;
29456
29721
  };
@@ -29503,6 +29768,7 @@ declare const _default: {
29503
29768
  'x-fern-sdk-group-name': string[];
29504
29769
  'x-fern-sdk-method-name': string;
29505
29770
  'x-response-key': null;
29771
+ 'x-title': string;
29506
29772
  };
29507
29773
  };
29508
29774
  '/user_identities/add_acs_user': {
@@ -37539,60 +37805,104 @@ interface Routes {
37539
37805
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37540
37806
  is_temporary_manual_override_active?: boolean | undefined;
37541
37807
  current_climate_setting?: {
37808
+ /** Unique key to identify the climate preset. */
37542
37809
  climate_preset_key?: string | undefined;
37810
+ /** Indicates whether this climate preset key can be edited. */
37543
37811
  can_edit?: boolean | undefined;
37812
+ /** Indicates whether this climate preset key can be deleted. */
37544
37813
  can_delete?: boolean | undefined;
37814
+ /** User-friendly name to identify the climate preset. */
37545
37815
  name?: ((string | null) | undefined) | undefined;
37816
+ /** Display name for the climate preset. */
37546
37817
  display_name?: string | undefined;
37818
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37547
37819
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37820
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37548
37821
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37822
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37549
37823
  cooling_set_point_celsius?: (number | undefined) | undefined;
37824
+ /** Temperature to which the thermostat should heat (in °C). */
37550
37825
  heating_set_point_celsius?: (number | undefined) | undefined;
37826
+ /** Temperature to which the thermostat should cool (in °F). */
37551
37827
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37828
+ /** Temperature to which the thermostat should heat (in °F). */
37552
37829
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
37830
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37553
37831
  manual_override_allowed?: boolean | undefined;
37554
37832
  } | undefined;
37555
37833
  /**
37556
37834
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
37557
37835
  default_climate_setting?: {
37836
+ /** Unique key to identify the climate preset. */
37558
37837
  climate_preset_key?: string | undefined;
37838
+ /** Indicates whether this climate preset key can be edited. */
37559
37839
  can_edit?: boolean | undefined;
37840
+ /** Indicates whether this climate preset key can be deleted. */
37560
37841
  can_delete?: boolean | undefined;
37842
+ /** User-friendly name to identify the climate preset. */
37561
37843
  name?: ((string | null) | undefined) | undefined;
37844
+ /** Display name for the climate preset. */
37562
37845
  display_name?: string | undefined;
37846
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37563
37847
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37848
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37564
37849
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37850
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37565
37851
  cooling_set_point_celsius?: (number | undefined) | undefined;
37852
+ /** Temperature to which the thermostat should heat (in °C). */
37566
37853
  heating_set_point_celsius?: (number | undefined) | undefined;
37854
+ /** Temperature to which the thermostat should cool (in °F). */
37567
37855
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37856
+ /** Temperature to which the thermostat should heat (in °F). */
37568
37857
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
37858
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37569
37859
  manual_override_allowed?: boolean | undefined;
37570
37860
  } | undefined;
37571
37861
  available_climate_presets?: Array<{
37862
+ /** Unique key to identify the climate preset. */
37572
37863
  climate_preset_key: string;
37864
+ /** Indicates whether this climate preset key can be edited. */
37573
37865
  can_edit: boolean;
37866
+ /** Indicates whether this climate preset key can be deleted. */
37574
37867
  can_delete: boolean;
37868
+ /** User-friendly name to identify the climate preset. */
37575
37869
  name?: (string | null) | undefined;
37870
+ /** Display name for the climate preset. */
37576
37871
  display_name: string;
37872
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37577
37873
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37874
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
37578
37875
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
37876
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
37579
37877
  cooling_set_point_celsius?: number | undefined;
37878
+ /** Temperature to which the thermostat should heat (in °C). */
37580
37879
  heating_set_point_celsius?: number | undefined;
37880
+ /** Temperature to which the thermostat should cool (in °F). */
37581
37881
  cooling_set_point_fahrenheit?: number | undefined;
37882
+ /** Temperature to which the thermostat should heat (in °F). */
37582
37883
  heating_set_point_fahrenheit?: number | undefined;
37884
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37583
37885
  manual_override_allowed: boolean;
37584
37886
  }> | undefined;
37585
37887
  fallback_climate_preset_key?: (string | null) | undefined;
37586
37888
  active_thermostat_schedule?: ({
37889
+ /** ID of the climate schedule. */
37587
37890
  thermostat_schedule_id: string;
37891
+ /** ID of the desired thermostat device. */
37588
37892
  device_id: string;
37893
+ /** User-friendly name to identify the climate schedule. */
37589
37894
  name?: string | undefined;
37895
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
37590
37896
  climate_preset_key: string;
37897
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
37591
37898
  max_override_period_minutes: number;
37899
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37592
37900
  starts_at: string;
37901
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37593
37902
  ends_at: string;
37903
+ /** Date and time at which the climate schedule was created. */
37594
37904
  created_at: string;
37595
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
37905
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
37596
37906
  errors?: any;
37597
37907
  } | null) | undefined;
37598
37908
  min_cooling_set_point_celsius?: number | undefined;
@@ -38670,21 +38980,21 @@ interface Routes {
38670
38980
  created_at: string;
38671
38981
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38672
38982
  message: string;
38673
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
38983
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38674
38984
  error_code: 'salto_ks_subscription_limit_exceeded';
38675
38985
  } | {
38676
38986
  /** Date and time at which Seam created the error. */
38677
38987
  created_at: string;
38678
38988
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38679
38989
  message: string;
38680
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
38990
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38681
38991
  error_code: 'acs_system_disconnected';
38682
38992
  } | {
38683
38993
  /** Date and time at which Seam created the error. */
38684
38994
  created_at: string;
38685
38995
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38686
38996
  message: string;
38687
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
38997
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38688
38998
  error_code: 'account_disconnected';
38689
38999
  }>;
38690
39000
  /** Warnings associated with the `acs_system`. */
@@ -38779,21 +39089,21 @@ interface Routes {
38779
39089
  created_at: string;
38780
39090
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38781
39091
  message: string;
38782
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
39092
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38783
39093
  error_code: 'salto_ks_subscription_limit_exceeded';
38784
39094
  } | {
38785
39095
  /** Date and time at which Seam created the error. */
38786
39096
  created_at: string;
38787
39097
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38788
39098
  message: string;
38789
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
39099
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38790
39100
  error_code: 'acs_system_disconnected';
38791
39101
  } | {
38792
39102
  /** Date and time at which Seam created the error. */
38793
39103
  created_at: string;
38794
39104
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38795
39105
  message: string;
38796
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
39106
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38797
39107
  error_code: 'account_disconnected';
38798
39108
  }>;
38799
39109
  /** Warnings associated with the `acs_system`. */
@@ -38888,21 +39198,21 @@ interface Routes {
38888
39198
  created_at: string;
38889
39199
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38890
39200
  message: string;
38891
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
39201
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38892
39202
  error_code: 'salto_ks_subscription_limit_exceeded';
38893
39203
  } | {
38894
39204
  /** Date and time at which Seam created the error. */
38895
39205
  created_at: string;
38896
39206
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38897
39207
  message: string;
38898
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
39208
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38899
39209
  error_code: 'acs_system_disconnected';
38900
39210
  } | {
38901
39211
  /** Date and time at which Seam created the error. */
38902
39212
  created_at: string;
38903
39213
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38904
39214
  message: string;
38905
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
39215
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
38906
39216
  error_code: 'account_disconnected';
38907
39217
  }>;
38908
39218
  /** Warnings associated with the `acs_system`. */
@@ -41879,60 +42189,104 @@ interface Routes {
41879
42189
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
41880
42190
  is_temporary_manual_override_active?: boolean | undefined;
41881
42191
  current_climate_setting?: {
42192
+ /** Unique key to identify the climate preset. */
41882
42193
  climate_preset_key?: string | undefined;
42194
+ /** Indicates whether this climate preset key can be edited. */
41883
42195
  can_edit?: boolean | undefined;
42196
+ /** Indicates whether this climate preset key can be deleted. */
41884
42197
  can_delete?: boolean | undefined;
42198
+ /** User-friendly name to identify the climate preset. */
41885
42199
  name?: ((string | null) | undefined) | undefined;
42200
+ /** Display name for the climate preset. */
41886
42201
  display_name?: string | undefined;
42202
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41887
42203
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42204
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41888
42205
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42206
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41889
42207
  cooling_set_point_celsius?: (number | undefined) | undefined;
42208
+ /** Temperature to which the thermostat should heat (in °C). */
41890
42209
  heating_set_point_celsius?: (number | undefined) | undefined;
42210
+ /** Temperature to which the thermostat should cool (in °F). */
41891
42211
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42212
+ /** Temperature to which the thermostat should heat (in °F). */
41892
42213
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42214
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41893
42215
  manual_override_allowed?: boolean | undefined;
41894
42216
  } | undefined;
41895
42217
  /**
41896
42218
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
41897
42219
  default_climate_setting?: {
42220
+ /** Unique key to identify the climate preset. */
41898
42221
  climate_preset_key?: string | undefined;
42222
+ /** Indicates whether this climate preset key can be edited. */
41899
42223
  can_edit?: boolean | undefined;
42224
+ /** Indicates whether this climate preset key can be deleted. */
41900
42225
  can_delete?: boolean | undefined;
42226
+ /** User-friendly name to identify the climate preset. */
41901
42227
  name?: ((string | null) | undefined) | undefined;
42228
+ /** Display name for the climate preset. */
41902
42229
  display_name?: string | undefined;
42230
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41903
42231
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42232
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41904
42233
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42234
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41905
42235
  cooling_set_point_celsius?: (number | undefined) | undefined;
42236
+ /** Temperature to which the thermostat should heat (in °C). */
41906
42237
  heating_set_point_celsius?: (number | undefined) | undefined;
42238
+ /** Temperature to which the thermostat should cool (in °F). */
41907
42239
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42240
+ /** Temperature to which the thermostat should heat (in °F). */
41908
42241
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42242
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41909
42243
  manual_override_allowed?: boolean | undefined;
41910
42244
  } | undefined;
41911
42245
  available_climate_presets?: Array<{
42246
+ /** Unique key to identify the climate preset. */
41912
42247
  climate_preset_key: string;
42248
+ /** Indicates whether this climate preset key can be edited. */
41913
42249
  can_edit: boolean;
42250
+ /** Indicates whether this climate preset key can be deleted. */
41914
42251
  can_delete: boolean;
42252
+ /** User-friendly name to identify the climate preset. */
41915
42253
  name?: (string | null) | undefined;
42254
+ /** Display name for the climate preset. */
41916
42255
  display_name: string;
42256
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
41917
42257
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42258
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
41918
42259
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
42260
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
41919
42261
  cooling_set_point_celsius?: number | undefined;
42262
+ /** Temperature to which the thermostat should heat (in °C). */
41920
42263
  heating_set_point_celsius?: number | undefined;
42264
+ /** Temperature to which the thermostat should cool (in °F). */
41921
42265
  cooling_set_point_fahrenheit?: number | undefined;
42266
+ /** Temperature to which the thermostat should heat (in °F). */
41922
42267
  heating_set_point_fahrenheit?: number | undefined;
42268
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
41923
42269
  manual_override_allowed: boolean;
41924
42270
  }> | undefined;
41925
42271
  fallback_climate_preset_key?: (string | null) | undefined;
41926
42272
  active_thermostat_schedule?: ({
42273
+ /** ID of the climate schedule. */
41927
42274
  thermostat_schedule_id: string;
42275
+ /** ID of the desired thermostat device. */
41928
42276
  device_id: string;
42277
+ /** User-friendly name to identify the climate schedule. */
41929
42278
  name?: string | undefined;
42279
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
41930
42280
  climate_preset_key: string;
42281
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
41931
42282
  max_override_period_minutes: number;
42283
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41932
42284
  starts_at: string;
42285
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41933
42286
  ends_at: string;
42287
+ /** Date and time at which the climate schedule was created. */
41934
42288
  created_at: string;
41935
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
42289
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
41936
42290
  errors?: any;
41937
42291
  } | null) | undefined;
41938
42292
  min_cooling_set_point_celsius?: number | undefined;
@@ -42003,19 +42357,31 @@ interface Routes {
42003
42357
  queryParams: {};
42004
42358
  jsonBody: {};
42005
42359
  commonParams: {
42006
- /** List all devices owned by this connected account */
42360
+ /** ID of the connected account by which to filter. */
42007
42361
  connected_account_id?: string | undefined;
42362
+ /** Array of IDs of the connected accounts by which to filter devices. */
42008
42363
  connected_account_ids?: string[] | undefined;
42364
+ /** ID of the Connect Webview by which to filter devices. */
42009
42365
  connect_webview_id?: string | undefined;
42366
+ /** Device type by which to filter devices. */
42010
42367
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
42368
+ /** Array of device types by which to filter devices. */
42011
42369
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
42370
+ /** Manufacturer by which to filter devices. */
42012
42371
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
42372
+ /** Array of device IDs by which to filter devices. */
42013
42373
  device_ids?: string[] | undefined;
42374
+ /** Numerical limit on the number of devices to return. */
42014
42375
  limit?: number;
42376
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
42015
42377
  created_before?: Date | undefined;
42378
+ /** Your own internal user ID for the user by which to filter devices. */
42016
42379
  user_identifier_key?: string | undefined;
42380
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
42017
42381
  custom_metadata_has?: Record<string, string | boolean> | undefined;
42382
+ /** */
42018
42383
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42384
+ /** */
42019
42385
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42020
42386
  };
42021
42387
  formData: {};
@@ -42367,60 +42733,104 @@ interface Routes {
42367
42733
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42368
42734
  is_temporary_manual_override_active?: boolean | undefined;
42369
42735
  current_climate_setting?: {
42736
+ /** Unique key to identify the climate preset. */
42370
42737
  climate_preset_key?: string | undefined;
42738
+ /** Indicates whether this climate preset key can be edited. */
42371
42739
  can_edit?: boolean | undefined;
42740
+ /** Indicates whether this climate preset key can be deleted. */
42372
42741
  can_delete?: boolean | undefined;
42742
+ /** User-friendly name to identify the climate preset. */
42373
42743
  name?: ((string | null) | undefined) | undefined;
42744
+ /** Display name for the climate preset. */
42374
42745
  display_name?: string | undefined;
42746
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42375
42747
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42748
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42376
42749
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42750
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42377
42751
  cooling_set_point_celsius?: (number | undefined) | undefined;
42752
+ /** Temperature to which the thermostat should heat (in °C). */
42378
42753
  heating_set_point_celsius?: (number | undefined) | undefined;
42754
+ /** Temperature to which the thermostat should cool (in °F). */
42379
42755
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42756
+ /** Temperature to which the thermostat should heat (in °F). */
42380
42757
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42758
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42381
42759
  manual_override_allowed?: boolean | undefined;
42382
42760
  } | undefined;
42383
42761
  /**
42384
42762
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
42385
42763
  default_climate_setting?: {
42764
+ /** Unique key to identify the climate preset. */
42386
42765
  climate_preset_key?: string | undefined;
42766
+ /** Indicates whether this climate preset key can be edited. */
42387
42767
  can_edit?: boolean | undefined;
42768
+ /** Indicates whether this climate preset key can be deleted. */
42388
42769
  can_delete?: boolean | undefined;
42770
+ /** User-friendly name to identify the climate preset. */
42389
42771
  name?: ((string | null) | undefined) | undefined;
42772
+ /** Display name for the climate preset. */
42390
42773
  display_name?: string | undefined;
42774
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42391
42775
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
42776
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42392
42777
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
42778
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42393
42779
  cooling_set_point_celsius?: (number | undefined) | undefined;
42780
+ /** Temperature to which the thermostat should heat (in °C). */
42394
42781
  heating_set_point_celsius?: (number | undefined) | undefined;
42782
+ /** Temperature to which the thermostat should cool (in °F). */
42395
42783
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
42784
+ /** Temperature to which the thermostat should heat (in °F). */
42396
42785
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
42786
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42397
42787
  manual_override_allowed?: boolean | undefined;
42398
42788
  } | undefined;
42399
42789
  available_climate_presets?: Array<{
42790
+ /** Unique key to identify the climate preset. */
42400
42791
  climate_preset_key: string;
42792
+ /** Indicates whether this climate preset key can be edited. */
42401
42793
  can_edit: boolean;
42794
+ /** Indicates whether this climate preset key can be deleted. */
42402
42795
  can_delete: boolean;
42796
+ /** User-friendly name to identify the climate preset. */
42403
42797
  name?: (string | null) | undefined;
42798
+ /** Display name for the climate preset. */
42404
42799
  display_name: string;
42800
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
42405
42801
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
42802
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
42406
42803
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
42804
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
42407
42805
  cooling_set_point_celsius?: number | undefined;
42806
+ /** Temperature to which the thermostat should heat (in °C). */
42408
42807
  heating_set_point_celsius?: number | undefined;
42808
+ /** Temperature to which the thermostat should cool (in °F). */
42409
42809
  cooling_set_point_fahrenheit?: number | undefined;
42810
+ /** Temperature to which the thermostat should heat (in °F). */
42410
42811
  heating_set_point_fahrenheit?: number | undefined;
42812
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
42411
42813
  manual_override_allowed: boolean;
42412
42814
  }> | undefined;
42413
42815
  fallback_climate_preset_key?: (string | null) | undefined;
42414
42816
  active_thermostat_schedule?: ({
42817
+ /** ID of the climate schedule. */
42415
42818
  thermostat_schedule_id: string;
42819
+ /** ID of the desired thermostat device. */
42416
42820
  device_id: string;
42821
+ /** User-friendly name to identify the climate schedule. */
42417
42822
  name?: string | undefined;
42823
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
42418
42824
  climate_preset_key: string;
42825
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
42419
42826
  max_override_period_minutes: number;
42827
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42420
42828
  starts_at: string;
42829
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42421
42830
  ends_at: string;
42831
+ /** Date and time at which the climate schedule was created. */
42422
42832
  created_at: string;
42423
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
42833
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
42424
42834
  errors?: any;
42425
42835
  } | null) | undefined;
42426
42836
  min_cooling_set_point_celsius?: number | undefined;
@@ -42664,19 +43074,31 @@ interface Routes {
42664
43074
  queryParams: {};
42665
43075
  jsonBody: {};
42666
43076
  commonParams: {
42667
- /** List all devices owned by this connected account */
43077
+ /** ID of the connected account by which to filter. */
42668
43078
  connected_account_id?: string | undefined;
43079
+ /** Array of IDs of the connected accounts by which to filter devices. */
42669
43080
  connected_account_ids?: string[] | undefined;
43081
+ /** ID of the Connect Webview by which to filter devices. */
42670
43082
  connect_webview_id?: string | undefined;
43083
+ /** Device type by which to filter devices. */
42671
43084
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
43085
+ /** Array of device types by which to filter devices. */
42672
43086
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
43087
+ /** Manufacturer by which to filter devices. */
42673
43088
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
43089
+ /** Array of device IDs by which to filter devices. */
42674
43090
  device_ids?: string[] | undefined;
43091
+ /** Numerical limit on the number of devices to return. */
42675
43092
  limit?: number;
43093
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
42676
43094
  created_before?: Date | undefined;
43095
+ /** Your own internal user ID for the user by which to filter devices. */
42677
43096
  user_identifier_key?: string | undefined;
43097
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
42678
43098
  custom_metadata_has?: Record<string, string | boolean> | undefined;
43099
+ /** */
42679
43100
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
43101
+ /** */
42680
43102
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
42681
43103
  };
42682
43104
  formData: {};
@@ -42865,8 +43287,8 @@ interface Routes {
42865
43287
  acs_system_ids?: string[] | undefined;
42866
43288
  access_code_id?: string | undefined;
42867
43289
  access_code_ids?: string[] | undefined;
42868
- event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded') | undefined;
42869
- event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded'> | undefined;
43290
+ event_type?: ('device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded') | undefined;
43291
+ event_types?: Array<'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'device.added' | 'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_system.added' | 'acs_system.connected' | 'acs_user.deleted' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_encoder.added' | 'acs_encoder.removed' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded'> | undefined;
42870
43292
  connected_account_id?: string | undefined;
42871
43293
  connect_webview_id?: string | undefined;
42872
43294
  limit?: number;
@@ -43258,60 +43680,104 @@ interface Routes {
43258
43680
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43259
43681
  is_temporary_manual_override_active?: boolean | undefined;
43260
43682
  current_climate_setting?: {
43683
+ /** Unique key to identify the climate preset. */
43261
43684
  climate_preset_key?: string | undefined;
43685
+ /** Indicates whether this climate preset key can be edited. */
43262
43686
  can_edit?: boolean | undefined;
43687
+ /** Indicates whether this climate preset key can be deleted. */
43263
43688
  can_delete?: boolean | undefined;
43689
+ /** User-friendly name to identify the climate preset. */
43264
43690
  name?: ((string | null) | undefined) | undefined;
43691
+ /** Display name for the climate preset. */
43265
43692
  display_name?: string | undefined;
43693
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43266
43694
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
43695
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43267
43696
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
43697
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43268
43698
  cooling_set_point_celsius?: (number | undefined) | undefined;
43699
+ /** Temperature to which the thermostat should heat (in °C). */
43269
43700
  heating_set_point_celsius?: (number | undefined) | undefined;
43701
+ /** Temperature to which the thermostat should cool (in °F). */
43270
43702
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
43703
+ /** Temperature to which the thermostat should heat (in °F). */
43271
43704
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
43705
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43272
43706
  manual_override_allowed?: boolean | undefined;
43273
43707
  } | undefined;
43274
43708
  /**
43275
43709
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
43276
43710
  default_climate_setting?: {
43711
+ /** Unique key to identify the climate preset. */
43277
43712
  climate_preset_key?: string | undefined;
43713
+ /** Indicates whether this climate preset key can be edited. */
43278
43714
  can_edit?: boolean | undefined;
43715
+ /** Indicates whether this climate preset key can be deleted. */
43279
43716
  can_delete?: boolean | undefined;
43717
+ /** User-friendly name to identify the climate preset. */
43280
43718
  name?: ((string | null) | undefined) | undefined;
43719
+ /** Display name for the climate preset. */
43281
43720
  display_name?: string | undefined;
43721
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43282
43722
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
43723
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43283
43724
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
43725
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43284
43726
  cooling_set_point_celsius?: (number | undefined) | undefined;
43727
+ /** Temperature to which the thermostat should heat (in °C). */
43285
43728
  heating_set_point_celsius?: (number | undefined) | undefined;
43729
+ /** Temperature to which the thermostat should cool (in °F). */
43286
43730
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
43731
+ /** Temperature to which the thermostat should heat (in °F). */
43287
43732
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
43733
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43288
43734
  manual_override_allowed?: boolean | undefined;
43289
43735
  } | undefined;
43290
43736
  available_climate_presets?: Array<{
43737
+ /** Unique key to identify the climate preset. */
43291
43738
  climate_preset_key: string;
43739
+ /** Indicates whether this climate preset key can be edited. */
43292
43740
  can_edit: boolean;
43741
+ /** Indicates whether this climate preset key can be deleted. */
43293
43742
  can_delete: boolean;
43743
+ /** User-friendly name to identify the climate preset. */
43294
43744
  name?: (string | null) | undefined;
43745
+ /** Display name for the climate preset. */
43295
43746
  display_name: string;
43747
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43296
43748
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43749
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43297
43750
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
43751
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43298
43752
  cooling_set_point_celsius?: number | undefined;
43753
+ /** Temperature to which the thermostat should heat (in °C). */
43299
43754
  heating_set_point_celsius?: number | undefined;
43755
+ /** Temperature to which the thermostat should cool (in °F). */
43300
43756
  cooling_set_point_fahrenheit?: number | undefined;
43757
+ /** Temperature to which the thermostat should heat (in °F). */
43301
43758
  heating_set_point_fahrenheit?: number | undefined;
43759
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43302
43760
  manual_override_allowed: boolean;
43303
43761
  }> | undefined;
43304
43762
  fallback_climate_preset_key?: (string | null) | undefined;
43305
43763
  active_thermostat_schedule?: ({
43764
+ /** ID of the climate schedule. */
43306
43765
  thermostat_schedule_id: string;
43766
+ /** ID of the desired thermostat device. */
43307
43767
  device_id: string;
43768
+ /** User-friendly name to identify the climate schedule. */
43308
43769
  name?: string | undefined;
43770
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43309
43771
  climate_preset_key: string;
43772
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
43310
43773
  max_override_period_minutes: number;
43774
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43311
43775
  starts_at: string;
43776
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43312
43777
  ends_at: string;
43778
+ /** Date and time at which the climate schedule was created. */
43313
43779
  created_at: string;
43314
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
43780
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
43315
43781
  errors?: any;
43316
43782
  } | null) | undefined;
43317
43783
  min_cooling_set_point_celsius?: number | undefined;
@@ -43721,60 +44187,104 @@ interface Routes {
43721
44187
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
43722
44188
  is_temporary_manual_override_active?: boolean | undefined;
43723
44189
  current_climate_setting?: {
44190
+ /** Unique key to identify the climate preset. */
43724
44191
  climate_preset_key?: string | undefined;
44192
+ /** Indicates whether this climate preset key can be edited. */
43725
44193
  can_edit?: boolean | undefined;
44194
+ /** Indicates whether this climate preset key can be deleted. */
43726
44195
  can_delete?: boolean | undefined;
44196
+ /** User-friendly name to identify the climate preset. */
43727
44197
  name?: ((string | null) | undefined) | undefined;
44198
+ /** Display name for the climate preset. */
43728
44199
  display_name?: string | undefined;
44200
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43729
44201
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44202
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43730
44203
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44204
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43731
44205
  cooling_set_point_celsius?: (number | undefined) | undefined;
44206
+ /** Temperature to which the thermostat should heat (in °C). */
43732
44207
  heating_set_point_celsius?: (number | undefined) | undefined;
44208
+ /** Temperature to which the thermostat should cool (in °F). */
43733
44209
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44210
+ /** Temperature to which the thermostat should heat (in °F). */
43734
44211
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44212
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43735
44213
  manual_override_allowed?: boolean | undefined;
43736
44214
  } | undefined;
43737
44215
  /**
43738
44216
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
43739
44217
  default_climate_setting?: {
44218
+ /** Unique key to identify the climate preset. */
43740
44219
  climate_preset_key?: string | undefined;
44220
+ /** Indicates whether this climate preset key can be edited. */
43741
44221
  can_edit?: boolean | undefined;
44222
+ /** Indicates whether this climate preset key can be deleted. */
43742
44223
  can_delete?: boolean | undefined;
44224
+ /** User-friendly name to identify the climate preset. */
43743
44225
  name?: ((string | null) | undefined) | undefined;
44226
+ /** Display name for the climate preset. */
43744
44227
  display_name?: string | undefined;
44228
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43745
44229
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44230
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43746
44231
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44232
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43747
44233
  cooling_set_point_celsius?: (number | undefined) | undefined;
44234
+ /** Temperature to which the thermostat should heat (in °C). */
43748
44235
  heating_set_point_celsius?: (number | undefined) | undefined;
44236
+ /** Temperature to which the thermostat should cool (in °F). */
43749
44237
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44238
+ /** Temperature to which the thermostat should heat (in °F). */
43750
44239
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44240
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43751
44241
  manual_override_allowed?: boolean | undefined;
43752
44242
  } | undefined;
43753
44243
  available_climate_presets?: Array<{
44244
+ /** Unique key to identify the climate preset. */
43754
44245
  climate_preset_key: string;
44246
+ /** Indicates whether this climate preset key can be edited. */
43755
44247
  can_edit: boolean;
44248
+ /** Indicates whether this climate preset key can be deleted. */
43756
44249
  can_delete: boolean;
44250
+ /** User-friendly name to identify the climate preset. */
43757
44251
  name?: (string | null) | undefined;
44252
+ /** Display name for the climate preset. */
43758
44253
  display_name: string;
44254
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
43759
44255
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44256
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
43760
44257
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
44258
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
43761
44259
  cooling_set_point_celsius?: number | undefined;
44260
+ /** Temperature to which the thermostat should heat (in °C). */
43762
44261
  heating_set_point_celsius?: number | undefined;
44262
+ /** Temperature to which the thermostat should cool (in °F). */
43763
44263
  cooling_set_point_fahrenheit?: number | undefined;
44264
+ /** Temperature to which the thermostat should heat (in °F). */
43764
44265
  heating_set_point_fahrenheit?: number | undefined;
44266
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
43765
44267
  manual_override_allowed: boolean;
43766
44268
  }> | undefined;
43767
44269
  fallback_climate_preset_key?: (string | null) | undefined;
43768
44270
  active_thermostat_schedule?: ({
44271
+ /** ID of the climate schedule. */
43769
44272
  thermostat_schedule_id: string;
44273
+ /** ID of the desired thermostat device. */
43770
44274
  device_id: string;
44275
+ /** User-friendly name to identify the climate schedule. */
43771
44276
  name?: string | undefined;
44277
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43772
44278
  climate_preset_key: string;
44279
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
43773
44280
  max_override_period_minutes: number;
44281
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43774
44282
  starts_at: string;
44283
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43775
44284
  ends_at: string;
44285
+ /** Date and time at which the climate schedule was created. */
43776
44286
  created_at: string;
43777
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
44287
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
43778
44288
  errors?: any;
43779
44289
  } | null) | undefined;
43780
44290
  min_cooling_set_point_celsius?: number | undefined;
@@ -43845,19 +44355,31 @@ interface Routes {
43845
44355
  queryParams: {};
43846
44356
  jsonBody: {};
43847
44357
  commonParams: {
43848
- /** List all devices owned by this connected account */
44358
+ /** ID of the connected account by which to filter. */
43849
44359
  connected_account_id?: string | undefined;
44360
+ /** Array of IDs of the connected accounts by which to filter devices. */
43850
44361
  connected_account_ids?: string[] | undefined;
44362
+ /** ID of the Connect Webview by which to filter devices. */
43851
44363
  connect_webview_id?: string | undefined;
44364
+ /** Device type by which to filter devices. */
43852
44365
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
44366
+ /** Array of device types by which to filter devices. */
43853
44367
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
44368
+ /** Manufacturer by which to filter devices. */
43854
44369
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
44370
+ /** Array of device IDs by which to filter devices. */
43855
44371
  device_ids?: string[] | undefined;
44372
+ /** Numerical limit on the number of devices to return. */
43856
44373
  limit?: number;
44374
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
43857
44375
  created_before?: Date | undefined;
44376
+ /** Your own internal user ID for the user by which to filter devices. */
43858
44377
  user_identifier_key?: string | undefined;
44378
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
43859
44379
  custom_metadata_has?: Record<string, string | boolean> | undefined;
44380
+ /** */
43860
44381
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
44382
+ /** */
43861
44383
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
43862
44384
  };
43863
44385
  formData: {};
@@ -44209,60 +44731,104 @@ interface Routes {
44209
44731
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44210
44732
  is_temporary_manual_override_active?: boolean | undefined;
44211
44733
  current_climate_setting?: {
44734
+ /** Unique key to identify the climate preset. */
44212
44735
  climate_preset_key?: string | undefined;
44736
+ /** Indicates whether this climate preset key can be edited. */
44213
44737
  can_edit?: boolean | undefined;
44738
+ /** Indicates whether this climate preset key can be deleted. */
44214
44739
  can_delete?: boolean | undefined;
44740
+ /** User-friendly name to identify the climate preset. */
44215
44741
  name?: ((string | null) | undefined) | undefined;
44742
+ /** Display name for the climate preset. */
44216
44743
  display_name?: string | undefined;
44744
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44217
44745
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44746
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44218
44747
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44748
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44219
44749
  cooling_set_point_celsius?: (number | undefined) | undefined;
44750
+ /** Temperature to which the thermostat should heat (in °C). */
44220
44751
  heating_set_point_celsius?: (number | undefined) | undefined;
44752
+ /** Temperature to which the thermostat should cool (in °F). */
44221
44753
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44754
+ /** Temperature to which the thermostat should heat (in °F). */
44222
44755
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44756
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44223
44757
  manual_override_allowed?: boolean | undefined;
44224
44758
  } | undefined;
44225
44759
  /**
44226
44760
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
44227
44761
  default_climate_setting?: {
44762
+ /** Unique key to identify the climate preset. */
44228
44763
  climate_preset_key?: string | undefined;
44764
+ /** Indicates whether this climate preset key can be edited. */
44229
44765
  can_edit?: boolean | undefined;
44766
+ /** Indicates whether this climate preset key can be deleted. */
44230
44767
  can_delete?: boolean | undefined;
44768
+ /** User-friendly name to identify the climate preset. */
44231
44769
  name?: ((string | null) | undefined) | undefined;
44770
+ /** Display name for the climate preset. */
44232
44771
  display_name?: string | undefined;
44772
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44233
44773
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
44774
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44234
44775
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
44776
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44235
44777
  cooling_set_point_celsius?: (number | undefined) | undefined;
44778
+ /** Temperature to which the thermostat should heat (in °C). */
44236
44779
  heating_set_point_celsius?: (number | undefined) | undefined;
44780
+ /** Temperature to which the thermostat should cool (in °F). */
44237
44781
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
44782
+ /** Temperature to which the thermostat should heat (in °F). */
44238
44783
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
44784
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44239
44785
  manual_override_allowed?: boolean | undefined;
44240
44786
  } | undefined;
44241
44787
  available_climate_presets?: Array<{
44788
+ /** Unique key to identify the climate preset. */
44242
44789
  climate_preset_key: string;
44790
+ /** Indicates whether this climate preset key can be edited. */
44243
44791
  can_edit: boolean;
44792
+ /** Indicates whether this climate preset key can be deleted. */
44244
44793
  can_delete: boolean;
44794
+ /** User-friendly name to identify the climate preset. */
44245
44795
  name?: (string | null) | undefined;
44796
+ /** Display name for the climate preset. */
44246
44797
  display_name: string;
44798
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44247
44799
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44800
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44248
44801
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
44802
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44249
44803
  cooling_set_point_celsius?: number | undefined;
44804
+ /** Temperature to which the thermostat should heat (in °C). */
44250
44805
  heating_set_point_celsius?: number | undefined;
44806
+ /** Temperature to which the thermostat should cool (in °F). */
44251
44807
  cooling_set_point_fahrenheit?: number | undefined;
44808
+ /** Temperature to which the thermostat should heat (in °F). */
44252
44809
  heating_set_point_fahrenheit?: number | undefined;
44810
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44253
44811
  manual_override_allowed: boolean;
44254
44812
  }> | undefined;
44255
44813
  fallback_climate_preset_key?: (string | null) | undefined;
44256
44814
  active_thermostat_schedule?: ({
44815
+ /** ID of the climate schedule. */
44257
44816
  thermostat_schedule_id: string;
44817
+ /** ID of the desired thermostat device. */
44258
44818
  device_id: string;
44819
+ /** User-friendly name to identify the climate schedule. */
44259
44820
  name?: string | undefined;
44821
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44260
44822
  climate_preset_key: string;
44823
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
44261
44824
  max_override_period_minutes: number;
44825
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44262
44826
  starts_at: string;
44827
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44263
44828
  ends_at: string;
44829
+ /** Date and time at which the climate schedule was created. */
44264
44830
  created_at: string;
44265
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
44831
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
44266
44832
  errors?: any;
44267
44833
  } | null) | undefined;
44268
44834
  min_cooling_set_point_celsius?: number | undefined;
@@ -44672,60 +45238,104 @@ interface Routes {
44672
45238
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
44673
45239
  is_temporary_manual_override_active?: boolean | undefined;
44674
45240
  current_climate_setting?: {
45241
+ /** Unique key to identify the climate preset. */
44675
45242
  climate_preset_key?: string | undefined;
45243
+ /** Indicates whether this climate preset key can be edited. */
44676
45244
  can_edit?: boolean | undefined;
45245
+ /** Indicates whether this climate preset key can be deleted. */
44677
45246
  can_delete?: boolean | undefined;
45247
+ /** User-friendly name to identify the climate preset. */
44678
45248
  name?: ((string | null) | undefined) | undefined;
45249
+ /** Display name for the climate preset. */
44679
45250
  display_name?: string | undefined;
45251
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44680
45252
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
45253
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44681
45254
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
45255
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44682
45256
  cooling_set_point_celsius?: (number | undefined) | undefined;
45257
+ /** Temperature to which the thermostat should heat (in °C). */
44683
45258
  heating_set_point_celsius?: (number | undefined) | undefined;
45259
+ /** Temperature to which the thermostat should cool (in °F). */
44684
45260
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
45261
+ /** Temperature to which the thermostat should heat (in °F). */
44685
45262
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
45263
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44686
45264
  manual_override_allowed?: boolean | undefined;
44687
45265
  } | undefined;
44688
45266
  /**
44689
45267
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
44690
45268
  default_climate_setting?: {
45269
+ /** Unique key to identify the climate preset. */
44691
45270
  climate_preset_key?: string | undefined;
45271
+ /** Indicates whether this climate preset key can be edited. */
44692
45272
  can_edit?: boolean | undefined;
45273
+ /** Indicates whether this climate preset key can be deleted. */
44693
45274
  can_delete?: boolean | undefined;
45275
+ /** User-friendly name to identify the climate preset. */
44694
45276
  name?: ((string | null) | undefined) | undefined;
45277
+ /** Display name for the climate preset. */
44695
45278
  display_name?: string | undefined;
45279
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44696
45280
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
45281
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44697
45282
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
45283
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44698
45284
  cooling_set_point_celsius?: (number | undefined) | undefined;
45285
+ /** Temperature to which the thermostat should heat (in °C). */
44699
45286
  heating_set_point_celsius?: (number | undefined) | undefined;
45287
+ /** Temperature to which the thermostat should cool (in °F). */
44700
45288
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
45289
+ /** Temperature to which the thermostat should heat (in °F). */
44701
45290
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
45291
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44702
45292
  manual_override_allowed?: boolean | undefined;
44703
45293
  } | undefined;
44704
45294
  available_climate_presets?: Array<{
45295
+ /** Unique key to identify the climate preset. */
44705
45296
  climate_preset_key: string;
45297
+ /** Indicates whether this climate preset key can be edited. */
44706
45298
  can_edit: boolean;
45299
+ /** Indicates whether this climate preset key can be deleted. */
44707
45300
  can_delete: boolean;
45301
+ /** User-friendly name to identify the climate preset. */
44708
45302
  name?: (string | null) | undefined;
45303
+ /** Display name for the climate preset. */
44709
45304
  display_name: string;
45305
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
44710
45306
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
45307
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
44711
45308
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
45309
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
44712
45310
  cooling_set_point_celsius?: number | undefined;
45311
+ /** Temperature to which the thermostat should heat (in °C). */
44713
45312
  heating_set_point_celsius?: number | undefined;
45313
+ /** Temperature to which the thermostat should cool (in °F). */
44714
45314
  cooling_set_point_fahrenheit?: number | undefined;
45315
+ /** Temperature to which the thermostat should heat (in °F). */
44715
45316
  heating_set_point_fahrenheit?: number | undefined;
45317
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
44716
45318
  manual_override_allowed: boolean;
44717
45319
  }> | undefined;
44718
45320
  fallback_climate_preset_key?: (string | null) | undefined;
44719
45321
  active_thermostat_schedule?: ({
45322
+ /** ID of the climate schedule. */
44720
45323
  thermostat_schedule_id: string;
45324
+ /** ID of the desired thermostat device. */
44721
45325
  device_id: string;
45326
+ /** User-friendly name to identify the climate schedule. */
44722
45327
  name?: string | undefined;
45328
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44723
45329
  climate_preset_key: string;
45330
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
44724
45331
  max_override_period_minutes: number;
45332
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44725
45333
  starts_at: string;
45334
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44726
45335
  ends_at: string;
45336
+ /** Date and time at which the climate schedule was created. */
44727
45337
  created_at: string;
44728
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
45338
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
44729
45339
  errors?: any;
44730
45340
  } | null) | undefined;
44731
45341
  min_cooling_set_point_celsius?: number | undefined;
@@ -46296,19 +46906,31 @@ interface Routes {
46296
46906
  queryParams: {};
46297
46907
  jsonBody: {};
46298
46908
  commonParams: {
46299
- /** List all devices owned by this connected account */
46909
+ /** ID of the connected account by which to filter. */
46300
46910
  connected_account_id?: string | undefined;
46911
+ /** Array of IDs of the connected accounts by which to filter devices. */
46301
46912
  connected_account_ids?: string[] | undefined;
46913
+ /** ID of the Connect Webview by which to filter devices. */
46302
46914
  connect_webview_id?: string | undefined;
46915
+ /** Device type by which to filter devices. */
46303
46916
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
46917
+ /** Array of device types by which to filter devices. */
46304
46918
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
46919
+ /** Manufacturer by which to filter devices. */
46305
46920
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
46921
+ /** Array of device IDs by which to filter devices. */
46306
46922
  device_ids?: string[] | undefined;
46923
+ /** Numerical limit on the number of devices to return. */
46307
46924
  limit?: number;
46925
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
46308
46926
  created_before?: Date | undefined;
46927
+ /** Your own internal user ID for the user by which to filter devices. */
46309
46928
  user_identifier_key?: string | undefined;
46929
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
46310
46930
  custom_metadata_has?: Record<string, string | boolean> | undefined;
46931
+ /** */
46311
46932
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
46933
+ /** */
46312
46934
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
46313
46935
  };
46314
46936
  formData: {};
@@ -46660,60 +47282,104 @@ interface Routes {
46660
47282
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
46661
47283
  is_temporary_manual_override_active?: boolean | undefined;
46662
47284
  current_climate_setting?: {
47285
+ /** Unique key to identify the climate preset. */
46663
47286
  climate_preset_key?: string | undefined;
47287
+ /** Indicates whether this climate preset key can be edited. */
46664
47288
  can_edit?: boolean | undefined;
47289
+ /** Indicates whether this climate preset key can be deleted. */
46665
47290
  can_delete?: boolean | undefined;
47291
+ /** User-friendly name to identify the climate preset. */
46666
47292
  name?: ((string | null) | undefined) | undefined;
47293
+ /** Display name for the climate preset. */
46667
47294
  display_name?: string | undefined;
47295
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46668
47296
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47297
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46669
47298
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47299
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46670
47300
  cooling_set_point_celsius?: (number | undefined) | undefined;
47301
+ /** Temperature to which the thermostat should heat (in °C). */
46671
47302
  heating_set_point_celsius?: (number | undefined) | undefined;
47303
+ /** Temperature to which the thermostat should cool (in °F). */
46672
47304
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47305
+ /** Temperature to which the thermostat should heat (in °F). */
46673
47306
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47307
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46674
47308
  manual_override_allowed?: boolean | undefined;
46675
47309
  } | undefined;
46676
47310
  /**
46677
47311
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
46678
47312
  default_climate_setting?: {
47313
+ /** Unique key to identify the climate preset. */
46679
47314
  climate_preset_key?: string | undefined;
47315
+ /** Indicates whether this climate preset key can be edited. */
46680
47316
  can_edit?: boolean | undefined;
47317
+ /** Indicates whether this climate preset key can be deleted. */
46681
47318
  can_delete?: boolean | undefined;
47319
+ /** User-friendly name to identify the climate preset. */
46682
47320
  name?: ((string | null) | undefined) | undefined;
47321
+ /** Display name for the climate preset. */
46683
47322
  display_name?: string | undefined;
47323
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46684
47324
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47325
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46685
47326
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47327
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46686
47328
  cooling_set_point_celsius?: (number | undefined) | undefined;
47329
+ /** Temperature to which the thermostat should heat (in °C). */
46687
47330
  heating_set_point_celsius?: (number | undefined) | undefined;
47331
+ /** Temperature to which the thermostat should cool (in °F). */
46688
47332
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47333
+ /** Temperature to which the thermostat should heat (in °F). */
46689
47334
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47335
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46690
47336
  manual_override_allowed?: boolean | undefined;
46691
47337
  } | undefined;
46692
47338
  available_climate_presets?: Array<{
47339
+ /** Unique key to identify the climate preset. */
46693
47340
  climate_preset_key: string;
47341
+ /** Indicates whether this climate preset key can be edited. */
46694
47342
  can_edit: boolean;
47343
+ /** Indicates whether this climate preset key can be deleted. */
46695
47344
  can_delete: boolean;
47345
+ /** User-friendly name to identify the climate preset. */
46696
47346
  name?: (string | null) | undefined;
47347
+ /** Display name for the climate preset. */
46697
47348
  display_name: string;
47349
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
46698
47350
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47351
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
46699
47352
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
47353
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
46700
47354
  cooling_set_point_celsius?: number | undefined;
47355
+ /** Temperature to which the thermostat should heat (in °C). */
46701
47356
  heating_set_point_celsius?: number | undefined;
47357
+ /** Temperature to which the thermostat should cool (in °F). */
46702
47358
  cooling_set_point_fahrenheit?: number | undefined;
47359
+ /** Temperature to which the thermostat should heat (in °F). */
46703
47360
  heating_set_point_fahrenheit?: number | undefined;
47361
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
46704
47362
  manual_override_allowed: boolean;
46705
47363
  }> | undefined;
46706
47364
  fallback_climate_preset_key?: (string | null) | undefined;
46707
47365
  active_thermostat_schedule?: ({
47366
+ /** ID of the climate schedule. */
46708
47367
  thermostat_schedule_id: string;
47368
+ /** ID of the desired thermostat device. */
46709
47369
  device_id: string;
47370
+ /** User-friendly name to identify the climate schedule. */
46710
47371
  name?: string | undefined;
47372
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
46711
47373
  climate_preset_key: string;
47374
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
46712
47375
  max_override_period_minutes: number;
47376
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46713
47377
  starts_at: string;
47378
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46714
47379
  ends_at: string;
47380
+ /** Date and time at which the climate schedule was created. */
46715
47381
  created_at: string;
46716
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
47382
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
46717
47383
  errors?: any;
46718
47384
  } | null) | undefined;
46719
47385
  min_cooling_set_point_celsius?: number | undefined;
@@ -47123,60 +47789,104 @@ interface Routes {
47123
47789
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47124
47790
  is_temporary_manual_override_active?: boolean | undefined;
47125
47791
  current_climate_setting?: {
47792
+ /** Unique key to identify the climate preset. */
47126
47793
  climate_preset_key?: string | undefined;
47794
+ /** Indicates whether this climate preset key can be edited. */
47127
47795
  can_edit?: boolean | undefined;
47796
+ /** Indicates whether this climate preset key can be deleted. */
47128
47797
  can_delete?: boolean | undefined;
47798
+ /** User-friendly name to identify the climate preset. */
47129
47799
  name?: ((string | null) | undefined) | undefined;
47800
+ /** Display name for the climate preset. */
47130
47801
  display_name?: string | undefined;
47802
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47131
47803
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47804
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47132
47805
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47806
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47133
47807
  cooling_set_point_celsius?: (number | undefined) | undefined;
47808
+ /** Temperature to which the thermostat should heat (in °C). */
47134
47809
  heating_set_point_celsius?: (number | undefined) | undefined;
47810
+ /** Temperature to which the thermostat should cool (in °F). */
47135
47811
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47812
+ /** Temperature to which the thermostat should heat (in °F). */
47136
47813
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47814
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47137
47815
  manual_override_allowed?: boolean | undefined;
47138
47816
  } | undefined;
47139
47817
  /**
47140
47818
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
47141
47819
  default_climate_setting?: {
47820
+ /** Unique key to identify the climate preset. */
47142
47821
  climate_preset_key?: string | undefined;
47822
+ /** Indicates whether this climate preset key can be edited. */
47143
47823
  can_edit?: boolean | undefined;
47824
+ /** Indicates whether this climate preset key can be deleted. */
47144
47825
  can_delete?: boolean | undefined;
47826
+ /** User-friendly name to identify the climate preset. */
47145
47827
  name?: ((string | null) | undefined) | undefined;
47828
+ /** Display name for the climate preset. */
47146
47829
  display_name?: string | undefined;
47830
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47147
47831
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
47832
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47148
47833
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
47834
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47149
47835
  cooling_set_point_celsius?: (number | undefined) | undefined;
47836
+ /** Temperature to which the thermostat should heat (in °C). */
47150
47837
  heating_set_point_celsius?: (number | undefined) | undefined;
47838
+ /** Temperature to which the thermostat should cool (in °F). */
47151
47839
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
47840
+ /** Temperature to which the thermostat should heat (in °F). */
47152
47841
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
47842
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47153
47843
  manual_override_allowed?: boolean | undefined;
47154
47844
  } | undefined;
47155
47845
  available_climate_presets?: Array<{
47846
+ /** Unique key to identify the climate preset. */
47156
47847
  climate_preset_key: string;
47848
+ /** Indicates whether this climate preset key can be edited. */
47157
47849
  can_edit: boolean;
47850
+ /** Indicates whether this climate preset key can be deleted. */
47158
47851
  can_delete: boolean;
47852
+ /** User-friendly name to identify the climate preset. */
47159
47853
  name?: (string | null) | undefined;
47854
+ /** Display name for the climate preset. */
47160
47855
  display_name: string;
47856
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
47161
47857
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
47858
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
47162
47859
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
47860
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
47163
47861
  cooling_set_point_celsius?: number | undefined;
47862
+ /** Temperature to which the thermostat should heat (in °C). */
47164
47863
  heating_set_point_celsius?: number | undefined;
47864
+ /** Temperature to which the thermostat should cool (in °F). */
47165
47865
  cooling_set_point_fahrenheit?: number | undefined;
47866
+ /** Temperature to which the thermostat should heat (in °F). */
47166
47867
  heating_set_point_fahrenheit?: number | undefined;
47868
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
47167
47869
  manual_override_allowed: boolean;
47168
47870
  }> | undefined;
47169
47871
  fallback_climate_preset_key?: (string | null) | undefined;
47170
47872
  active_thermostat_schedule?: ({
47873
+ /** ID of the climate schedule. */
47171
47874
  thermostat_schedule_id: string;
47875
+ /** ID of the desired thermostat device. */
47172
47876
  device_id: string;
47877
+ /** User-friendly name to identify the climate schedule. */
47173
47878
  name?: string | undefined;
47879
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
47174
47880
  climate_preset_key: string;
47881
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
47175
47882
  max_override_period_minutes: number;
47883
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47176
47884
  starts_at: string;
47885
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47177
47886
  ends_at: string;
47887
+ /** Date and time at which the climate schedule was created. */
47178
47888
  created_at: string;
47179
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
47889
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
47180
47890
  errors?: any;
47181
47891
  } | null) | undefined;
47182
47892
  min_cooling_set_point_celsius?: number | undefined;
@@ -49691,7 +50401,9 @@ interface Routes {
49691
50401
  method: 'POST';
49692
50402
  queryParams: {};
49693
50403
  jsonBody: {
50404
+ /** ID of the desired thermostat device. */
49694
50405
  device_id: string;
50406
+ /** Climate preset key of the desired climate preset. */
49695
50407
  climate_preset_key: string;
49696
50408
  };
49697
50409
  commonParams: {};
@@ -50424,12 +51136,13 @@ interface Routes {
50424
51136
  method: 'POST';
50425
51137
  queryParams: {};
50426
51138
  jsonBody: {
50427
- /** ID of the thermostat device. */
51139
+ /** ID of the desired thermostat device. */
50428
51140
  device_id: string;
50429
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
51141
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
50430
51142
  cooling_set_point_celsius?: number | undefined;
50431
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
51143
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
50432
51144
  cooling_set_point_fahrenheit?: number | undefined;
51145
+ /** */
50433
51146
  sync?: boolean;
50434
51147
  };
50435
51148
  commonParams: {};
@@ -51162,15 +51875,25 @@ interface Routes {
51162
51875
  method: 'POST';
51163
51876
  queryParams: {};
51164
51877
  jsonBody: {
51878
+ /** ID of the desired thermostat device. */
51165
51879
  device_id: string;
51880
+ /** Unique key to identify the climate preset. */
51166
51881
  climate_preset_key: string;
51882
+ /** User-friendly name to identify the climate preset. */
51167
51883
  name?: (string | null) | undefined;
51884
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51168
51885
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
51886
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51169
51887
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
51888
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51170
51889
  cooling_set_point_celsius?: number | undefined;
51890
+ /** Temperature to which the thermostat should heat (in °C). */
51171
51891
  heating_set_point_celsius?: number | undefined;
51892
+ /** Temperature to which the thermostat should cool (in °F). */
51172
51893
  cooling_set_point_fahrenheit?: number | undefined;
51894
+ /** Temperature to which the thermostat should heat (in °F). */
51173
51895
  heating_set_point_fahrenheit?: number | undefined;
51896
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51174
51897
  manual_override_allowed: boolean;
51175
51898
  };
51176
51899
  commonParams: {};
@@ -51182,7 +51905,9 @@ interface Routes {
51182
51905
  method: 'POST' | 'DELETE';
51183
51906
  queryParams: {};
51184
51907
  jsonBody: {
51908
+ /** ID of the desired thermostat device. */
51185
51909
  device_id: string;
51910
+ /** Climate preset key of the desired climate preset. */
51186
51911
  climate_preset_key: string;
51187
51912
  };
51188
51913
  commonParams: {};
@@ -51195,9 +51920,9 @@ interface Routes {
51195
51920
  queryParams: {};
51196
51921
  jsonBody: {};
51197
51922
  commonParams: {
51198
- /** ID of the thermostat device. */
51923
+ /** ID of the desired thermostat device. */
51199
51924
  device_id?: string | undefined;
51200
- /** Name of the thermostat. */
51925
+ /** User-friendly name of the desired thermostat device. */
51201
51926
  name?: string | undefined;
51202
51927
  };
51203
51928
  formData: {};
@@ -51549,60 +52274,104 @@ interface Routes {
51549
52274
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
51550
52275
  is_temporary_manual_override_active?: boolean | undefined;
51551
52276
  current_climate_setting?: {
52277
+ /** Unique key to identify the climate preset. */
51552
52278
  climate_preset_key?: string | undefined;
52279
+ /** Indicates whether this climate preset key can be edited. */
51553
52280
  can_edit?: boolean | undefined;
52281
+ /** Indicates whether this climate preset key can be deleted. */
51554
52282
  can_delete?: boolean | undefined;
52283
+ /** User-friendly name to identify the climate preset. */
51555
52284
  name?: ((string | null) | undefined) | undefined;
52285
+ /** Display name for the climate preset. */
51556
52286
  display_name?: string | undefined;
52287
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51557
52288
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
52289
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51558
52290
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
52291
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51559
52292
  cooling_set_point_celsius?: (number | undefined) | undefined;
52293
+ /** Temperature to which the thermostat should heat (in °C). */
51560
52294
  heating_set_point_celsius?: (number | undefined) | undefined;
52295
+ /** Temperature to which the thermostat should cool (in °F). */
51561
52296
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
52297
+ /** Temperature to which the thermostat should heat (in °F). */
51562
52298
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
52299
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51563
52300
  manual_override_allowed?: boolean | undefined;
51564
52301
  } | undefined;
51565
52302
  /**
51566
52303
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
51567
52304
  default_climate_setting?: {
52305
+ /** Unique key to identify the climate preset. */
51568
52306
  climate_preset_key?: string | undefined;
52307
+ /** Indicates whether this climate preset key can be edited. */
51569
52308
  can_edit?: boolean | undefined;
52309
+ /** Indicates whether this climate preset key can be deleted. */
51570
52310
  can_delete?: boolean | undefined;
52311
+ /** User-friendly name to identify the climate preset. */
51571
52312
  name?: ((string | null) | undefined) | undefined;
52313
+ /** Display name for the climate preset. */
51572
52314
  display_name?: string | undefined;
52315
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51573
52316
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
52317
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51574
52318
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
52319
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51575
52320
  cooling_set_point_celsius?: (number | undefined) | undefined;
52321
+ /** Temperature to which the thermostat should heat (in °C). */
51576
52322
  heating_set_point_celsius?: (number | undefined) | undefined;
52323
+ /** Temperature to which the thermostat should cool (in °F). */
51577
52324
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
52325
+ /** Temperature to which the thermostat should heat (in °F). */
51578
52326
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
52327
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51579
52328
  manual_override_allowed?: boolean | undefined;
51580
52329
  } | undefined;
51581
52330
  available_climate_presets?: Array<{
52331
+ /** Unique key to identify the climate preset. */
51582
52332
  climate_preset_key: string;
52333
+ /** Indicates whether this climate preset key can be edited. */
51583
52334
  can_edit: boolean;
52335
+ /** Indicates whether this climate preset key can be deleted. */
51584
52336
  can_delete: boolean;
52337
+ /** User-friendly name to identify the climate preset. */
51585
52338
  name?: (string | null) | undefined;
52339
+ /** Display name for the climate preset. */
51586
52340
  display_name: string;
52341
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
51587
52342
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
52343
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
51588
52344
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
52345
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
51589
52346
  cooling_set_point_celsius?: number | undefined;
52347
+ /** Temperature to which the thermostat should heat (in °C). */
51590
52348
  heating_set_point_celsius?: number | undefined;
52349
+ /** Temperature to which the thermostat should cool (in °F). */
51591
52350
  cooling_set_point_fahrenheit?: number | undefined;
52351
+ /** Temperature to which the thermostat should heat (in °F). */
51592
52352
  heating_set_point_fahrenheit?: number | undefined;
52353
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
51593
52354
  manual_override_allowed: boolean;
51594
52355
  }> | undefined;
51595
52356
  fallback_climate_preset_key?: (string | null) | undefined;
51596
52357
  active_thermostat_schedule?: ({
52358
+ /** ID of the climate schedule. */
51597
52359
  thermostat_schedule_id: string;
52360
+ /** ID of the desired thermostat device. */
51598
52361
  device_id: string;
52362
+ /** User-friendly name to identify the climate schedule. */
51599
52363
  name?: string | undefined;
52364
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
51600
52365
  climate_preset_key: string;
52366
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
51601
52367
  max_override_period_minutes: number;
52368
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51602
52369
  starts_at: string;
52370
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51603
52371
  ends_at: string;
52372
+ /** Date and time at which the climate schedule was created. */
51604
52373
  created_at: string;
51605
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
52374
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
51606
52375
  errors?: any;
51607
52376
  } | null) | undefined;
51608
52377
  min_cooling_set_point_celsius?: number | undefined;
@@ -51672,12 +52441,13 @@ interface Routes {
51672
52441
  method: 'POST';
51673
52442
  queryParams: {};
51674
52443
  jsonBody: {
51675
- /** ID of the thermostat device. */
52444
+ /** ID of the desired thermostat device. */
51676
52445
  device_id: string;
51677
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
52446
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
51678
52447
  heating_set_point_celsius?: number | undefined;
51679
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
52448
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
51680
52449
  heating_set_point_fahrenheit?: number | undefined;
52450
+ /** */
51681
52451
  sync?: boolean;
51682
52452
  };
51683
52453
  commonParams: {};
@@ -52410,16 +53180,17 @@ interface Routes {
52410
53180
  method: 'POST';
52411
53181
  queryParams: {};
52412
53182
  jsonBody: {
52413
- /** ID of the thermostat device. */
53183
+ /** ID of the desired thermostat device. */
52414
53184
  device_id: string;
52415
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
53185
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
52416
53186
  heating_set_point_celsius?: number | undefined;
52417
- /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
53187
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
52418
53188
  heating_set_point_fahrenheit?: number | undefined;
52419
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
53189
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
52420
53190
  cooling_set_point_celsius?: number | undefined;
52421
- /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
53191
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
52422
53192
  cooling_set_point_fahrenheit?: number | undefined;
53193
+ /** */
52423
53194
  sync?: boolean;
52424
53195
  };
52425
53196
  commonParams: {};
@@ -53153,19 +53924,31 @@ interface Routes {
53153
53924
  queryParams: {};
53154
53925
  jsonBody: {};
53155
53926
  commonParams: {
53156
- /** List all devices owned by this connected account */
53927
+ /** ID of the connected account by which to filter. */
53157
53928
  connected_account_id?: string | undefined;
53929
+ /** Array of IDs of the connected accounts by which to filter devices. */
53158
53930
  connected_account_ids?: string[] | undefined;
53931
+ /** ID of the Connect Webview by which to filter devices. */
53159
53932
  connect_webview_id?: string | undefined;
53933
+ /** Device type by which to filter devices. */
53160
53934
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
53935
+ /** Array of device types by which to filter devices. */
53161
53936
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
53937
+ /** Manufacturer by which to filter devices. */
53162
53938
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
53939
+ /** Array of device IDs by which to filter devices. */
53163
53940
  device_ids?: string[] | undefined;
53941
+ /** Numerical limit on the number of devices to return. */
53164
53942
  limit?: number;
53943
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
53165
53944
  created_before?: Date | undefined;
53945
+ /** Your own internal user ID for the user by which to filter devices. */
53166
53946
  user_identifier_key?: string | undefined;
53947
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
53167
53948
  custom_metadata_has?: Record<string, string | boolean> | undefined;
53949
+ /** */
53168
53950
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
53951
+ /** */
53169
53952
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
53170
53953
  };
53171
53954
  formData: {};
@@ -53517,60 +54300,104 @@ interface Routes {
53517
54300
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
53518
54301
  is_temporary_manual_override_active?: boolean | undefined;
53519
54302
  current_climate_setting?: {
54303
+ /** Unique key to identify the climate preset. */
53520
54304
  climate_preset_key?: string | undefined;
54305
+ /** Indicates whether this climate preset key can be edited. */
53521
54306
  can_edit?: boolean | undefined;
54307
+ /** Indicates whether this climate preset key can be deleted. */
53522
54308
  can_delete?: boolean | undefined;
54309
+ /** User-friendly name to identify the climate preset. */
53523
54310
  name?: ((string | null) | undefined) | undefined;
54311
+ /** Display name for the climate preset. */
53524
54312
  display_name?: string | undefined;
54313
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53525
54314
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54315
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53526
54316
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54317
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53527
54318
  cooling_set_point_celsius?: (number | undefined) | undefined;
54319
+ /** Temperature to which the thermostat should heat (in °C). */
53528
54320
  heating_set_point_celsius?: (number | undefined) | undefined;
54321
+ /** Temperature to which the thermostat should cool (in °F). */
53529
54322
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54323
+ /** Temperature to which the thermostat should heat (in °F). */
53530
54324
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54325
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53531
54326
  manual_override_allowed?: boolean | undefined;
53532
54327
  } | undefined;
53533
54328
  /**
53534
54329
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
53535
54330
  default_climate_setting?: {
54331
+ /** Unique key to identify the climate preset. */
53536
54332
  climate_preset_key?: string | undefined;
54333
+ /** Indicates whether this climate preset key can be edited. */
53537
54334
  can_edit?: boolean | undefined;
54335
+ /** Indicates whether this climate preset key can be deleted. */
53538
54336
  can_delete?: boolean | undefined;
54337
+ /** User-friendly name to identify the climate preset. */
53539
54338
  name?: ((string | null) | undefined) | undefined;
54339
+ /** Display name for the climate preset. */
53540
54340
  display_name?: string | undefined;
54341
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53541
54342
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54343
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53542
54344
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54345
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53543
54346
  cooling_set_point_celsius?: (number | undefined) | undefined;
54347
+ /** Temperature to which the thermostat should heat (in °C). */
53544
54348
  heating_set_point_celsius?: (number | undefined) | undefined;
54349
+ /** Temperature to which the thermostat should cool (in °F). */
53545
54350
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54351
+ /** Temperature to which the thermostat should heat (in °F). */
53546
54352
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54353
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53547
54354
  manual_override_allowed?: boolean | undefined;
53548
54355
  } | undefined;
53549
54356
  available_climate_presets?: Array<{
54357
+ /** Unique key to identify the climate preset. */
53550
54358
  climate_preset_key: string;
54359
+ /** Indicates whether this climate preset key can be edited. */
53551
54360
  can_edit: boolean;
54361
+ /** Indicates whether this climate preset key can be deleted. */
53552
54362
  can_delete: boolean;
54363
+ /** User-friendly name to identify the climate preset. */
53553
54364
  name?: (string | null) | undefined;
54365
+ /** Display name for the climate preset. */
53554
54366
  display_name: string;
54367
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53555
54368
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54369
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53556
54370
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
54371
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53557
54372
  cooling_set_point_celsius?: number | undefined;
54373
+ /** Temperature to which the thermostat should heat (in °C). */
53558
54374
  heating_set_point_celsius?: number | undefined;
54375
+ /** Temperature to which the thermostat should cool (in °F). */
53559
54376
  cooling_set_point_fahrenheit?: number | undefined;
54377
+ /** Temperature to which the thermostat should heat (in °F). */
53560
54378
  heating_set_point_fahrenheit?: number | undefined;
54379
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53561
54380
  manual_override_allowed: boolean;
53562
54381
  }> | undefined;
53563
54382
  fallback_climate_preset_key?: (string | null) | undefined;
53564
54383
  active_thermostat_schedule?: ({
54384
+ /** ID of the climate schedule. */
53565
54385
  thermostat_schedule_id: string;
54386
+ /** ID of the desired thermostat device. */
53566
54387
  device_id: string;
54388
+ /** User-friendly name to identify the climate schedule. */
53567
54389
  name?: string | undefined;
54390
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
53568
54391
  climate_preset_key: string;
54392
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
53569
54393
  max_override_period_minutes: number;
54394
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53570
54395
  starts_at: string;
54396
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53571
54397
  ends_at: string;
54398
+ /** Date and time at which the climate schedule was created. */
53572
54399
  created_at: string;
53573
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
54400
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
53574
54401
  errors?: any;
53575
54402
  } | null) | undefined;
53576
54403
  min_cooling_set_point_celsius?: number | undefined;
@@ -53980,60 +54807,104 @@ interface Routes {
53980
54807
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
53981
54808
  is_temporary_manual_override_active?: boolean | undefined;
53982
54809
  current_climate_setting?: {
54810
+ /** Unique key to identify the climate preset. */
53983
54811
  climate_preset_key?: string | undefined;
54812
+ /** Indicates whether this climate preset key can be edited. */
53984
54813
  can_edit?: boolean | undefined;
54814
+ /** Indicates whether this climate preset key can be deleted. */
53985
54815
  can_delete?: boolean | undefined;
54816
+ /** User-friendly name to identify the climate preset. */
53986
54817
  name?: ((string | null) | undefined) | undefined;
54818
+ /** Display name for the climate preset. */
53987
54819
  display_name?: string | undefined;
54820
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
53988
54821
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54822
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
53989
54823
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54824
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
53990
54825
  cooling_set_point_celsius?: (number | undefined) | undefined;
54826
+ /** Temperature to which the thermostat should heat (in °C). */
53991
54827
  heating_set_point_celsius?: (number | undefined) | undefined;
54828
+ /** Temperature to which the thermostat should cool (in °F). */
53992
54829
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54830
+ /** Temperature to which the thermostat should heat (in °F). */
53993
54831
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54832
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
53994
54833
  manual_override_allowed?: boolean | undefined;
53995
54834
  } | undefined;
53996
54835
  /**
53997
54836
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
53998
54837
  default_climate_setting?: {
54838
+ /** Unique key to identify the climate preset. */
53999
54839
  climate_preset_key?: string | undefined;
54840
+ /** Indicates whether this climate preset key can be edited. */
54000
54841
  can_edit?: boolean | undefined;
54842
+ /** Indicates whether this climate preset key can be deleted. */
54001
54843
  can_delete?: boolean | undefined;
54844
+ /** User-friendly name to identify the climate preset. */
54002
54845
  name?: ((string | null) | undefined) | undefined;
54846
+ /** Display name for the climate preset. */
54003
54847
  display_name?: string | undefined;
54848
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
54004
54849
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
54850
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
54005
54851
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
54852
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
54006
54853
  cooling_set_point_celsius?: (number | undefined) | undefined;
54854
+ /** Temperature to which the thermostat should heat (in °C). */
54007
54855
  heating_set_point_celsius?: (number | undefined) | undefined;
54856
+ /** Temperature to which the thermostat should cool (in °F). */
54008
54857
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
54858
+ /** Temperature to which the thermostat should heat (in °F). */
54009
54859
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
54860
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
54010
54861
  manual_override_allowed?: boolean | undefined;
54011
54862
  } | undefined;
54012
54863
  available_climate_presets?: Array<{
54864
+ /** Unique key to identify the climate preset. */
54013
54865
  climate_preset_key: string;
54866
+ /** Indicates whether this climate preset key can be edited. */
54014
54867
  can_edit: boolean;
54868
+ /** Indicates whether this climate preset key can be deleted. */
54015
54869
  can_delete: boolean;
54870
+ /** User-friendly name to identify the climate preset. */
54016
54871
  name?: (string | null) | undefined;
54872
+ /** Display name for the climate preset. */
54017
54873
  display_name: string;
54874
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
54018
54875
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54876
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
54019
54877
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
54878
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
54020
54879
  cooling_set_point_celsius?: number | undefined;
54880
+ /** Temperature to which the thermostat should heat (in °C). */
54021
54881
  heating_set_point_celsius?: number | undefined;
54882
+ /** Temperature to which the thermostat should cool (in °F). */
54022
54883
  cooling_set_point_fahrenheit?: number | undefined;
54884
+ /** Temperature to which the thermostat should heat (in °F). */
54023
54885
  heating_set_point_fahrenheit?: number | undefined;
54886
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
54024
54887
  manual_override_allowed: boolean;
54025
54888
  }> | undefined;
54026
54889
  fallback_climate_preset_key?: (string | null) | undefined;
54027
54890
  active_thermostat_schedule?: ({
54891
+ /** ID of the climate schedule. */
54028
54892
  thermostat_schedule_id: string;
54893
+ /** ID of the desired thermostat device. */
54029
54894
  device_id: string;
54895
+ /** User-friendly name to identify the climate schedule. */
54030
54896
  name?: string | undefined;
54897
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54031
54898
  climate_preset_key: string;
54899
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54032
54900
  max_override_period_minutes: number;
54901
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54033
54902
  starts_at: string;
54903
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54034
54904
  ends_at: string;
54905
+ /** Date and time at which the climate schedule was created. */
54035
54906
  created_at: string;
54036
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
54907
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54037
54908
  errors?: any;
54038
54909
  } | null) | undefined;
54039
54910
  min_cooling_set_point_celsius?: number | undefined;
@@ -54103,8 +54974,9 @@ interface Routes {
54103
54974
  method: 'POST';
54104
54975
  queryParams: {};
54105
54976
  jsonBody: {
54106
- /** ID of the thermostat device. */
54977
+ /** ID of the desired thermostat device. */
54107
54978
  device_id: string;
54979
+ /** */
54108
54980
  sync?: boolean;
54109
54981
  };
54110
54982
  commonParams: {};
@@ -54837,26 +55709,40 @@ interface Routes {
54837
55709
  method: 'POST';
54838
55710
  queryParams: {};
54839
55711
  jsonBody: {
55712
+ /** ID of the desired thermostat device. */
54840
55713
  device_id: string;
55714
+ /** User-friendly name to identify the climate schedule. */
54841
55715
  name?: string | undefined;
55716
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54842
55717
  climate_preset_key: string;
55718
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54843
55719
  max_override_period_minutes?: number;
55720
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54844
55721
  starts_at: string;
55722
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54845
55723
  ends_at: string;
54846
55724
  };
54847
55725
  commonParams: {};
54848
55726
  formData: {};
54849
55727
  jsonResponse: {
54850
55728
  thermostat_schedule: {
55729
+ /** ID of the climate schedule. */
54851
55730
  thermostat_schedule_id: string;
55731
+ /** ID of the desired thermostat device. */
54852
55732
  device_id: string;
55733
+ /** User-friendly name to identify the climate schedule. */
54853
55734
  name?: string | undefined;
55735
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54854
55736
  climate_preset_key: string;
55737
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54855
55738
  max_override_period_minutes: number;
55739
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54856
55740
  starts_at: string;
55741
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54857
55742
  ends_at: string;
55743
+ /** Date and time at which the climate schedule was created. */
54858
55744
  created_at: string;
54859
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
55745
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54860
55746
  errors?: any;
54861
55747
  };
54862
55748
  };
@@ -54867,6 +55753,7 @@ interface Routes {
54867
55753
  queryParams: {};
54868
55754
  jsonBody: {};
54869
55755
  commonParams: {
55756
+ /** ID of the desired climate schedule. */
54870
55757
  thermostat_schedule_id: string;
54871
55758
  };
54872
55759
  formData: {};
@@ -54878,20 +55765,29 @@ interface Routes {
54878
55765
  queryParams: {};
54879
55766
  jsonBody: {};
54880
55767
  commonParams: {
55768
+ /** ID of the desired climate schedule. */
54881
55769
  thermostat_schedule_id: string;
54882
55770
  };
54883
55771
  formData: {};
54884
55772
  jsonResponse: {
54885
55773
  thermostat_schedule: {
55774
+ /** ID of the climate schedule. */
54886
55775
  thermostat_schedule_id: string;
55776
+ /** ID of the desired thermostat device. */
54887
55777
  device_id: string;
55778
+ /** User-friendly name to identify the climate schedule. */
54888
55779
  name?: string | undefined;
55780
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54889
55781
  climate_preset_key: string;
55782
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54890
55783
  max_override_period_minutes: number;
55784
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54891
55785
  starts_at: string;
55786
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54892
55787
  ends_at: string;
55788
+ /** Date and time at which the climate schedule was created. */
54893
55789
  created_at: string;
54894
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
55790
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54895
55791
  errors?: any;
54896
55792
  };
54897
55793
  };
@@ -54902,21 +55798,31 @@ interface Routes {
54902
55798
  queryParams: {};
54903
55799
  jsonBody: {};
54904
55800
  commonParams: {
55801
+ /** ID of the desired thermostat device. */
54905
55802
  device_id: string;
55803
+ /** User identifier key by which to filter the list of returned climate schedules. */
54906
55804
  user_identifier_key?: string | undefined;
54907
55805
  };
54908
55806
  formData: {};
54909
55807
  jsonResponse: {
54910
55808
  thermostat_schedules: Array<{
55809
+ /** ID of the climate schedule. */
54911
55810
  thermostat_schedule_id: string;
55811
+ /** ID of the desired thermostat device. */
54912
55812
  device_id: string;
55813
+ /** User-friendly name to identify the climate schedule. */
54913
55814
  name?: string | undefined;
55815
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54914
55816
  climate_preset_key: string;
55817
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54915
55818
  max_override_period_minutes: number;
55819
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54916
55820
  starts_at: string;
55821
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54917
55822
  ends_at: string;
55823
+ /** Date and time at which the climate schedule was created. */
54918
55824
  created_at: string;
54919
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
55825
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
54920
55826
  errors?: any;
54921
55827
  }>;
54922
55828
  };
@@ -54926,11 +55832,17 @@ interface Routes {
54926
55832
  method: 'PATCH' | 'POST';
54927
55833
  queryParams: {};
54928
55834
  jsonBody: {
55835
+ /** ID of the desired climate schedule. */
54929
55836
  thermostat_schedule_id: string;
55837
+ /** User-friendly name to identify the climate schedule. */
54930
55838
  name?: string | undefined;
55839
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54931
55840
  climate_preset_key?: string | undefined;
55841
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
54932
55842
  max_override_period_minutes?: number | undefined;
55843
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54933
55844
  starts_at?: string | undefined;
55845
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54934
55846
  ends_at?: string | undefined;
54935
55847
  };
54936
55848
  commonParams: {};
@@ -54942,7 +55854,9 @@ interface Routes {
54942
55854
  method: 'POST';
54943
55855
  queryParams: {};
54944
55856
  jsonBody: {
55857
+ /** ID of the desired thermostat device. */
54945
55858
  device_id: string;
55859
+ /** Climate preset key of the desired climate preset. */
54946
55860
  climate_preset_key: string;
54947
55861
  };
54948
55862
  commonParams: {};
@@ -54954,13 +55868,13 @@ interface Routes {
54954
55868
  method: 'POST';
54955
55869
  queryParams: {};
54956
55870
  jsonBody: {
54957
- /** ID of the thermostat device. */
54958
55871
  device_id: string;
54959
55872
  /**
54960
55873
  * @deprecated Use `fan_mode_setting` instead. */
54961
55874
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
54962
- /** Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings). */
55875
+ /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
54963
55876
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
55877
+ /** */
54964
55878
  sync?: boolean;
54965
55879
  };
54966
55880
  commonParams: {};
@@ -55693,10 +56607,15 @@ interface Routes {
55693
56607
  method: 'POST' | 'PATCH';
55694
56608
  queryParams: {};
55695
56609
  jsonBody: {
56610
+ /** ID of the desired thermostat device. */
55696
56611
  device_id: string;
56612
+ /** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
55697
56613
  lower_limit_celsius?: (number | undefined) | null;
56614
+ /** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
55698
56615
  lower_limit_fahrenheit?: (number | undefined) | null;
56616
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
55699
56617
  upper_limit_celsius?: (number | undefined) | null;
56618
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
55700
56619
  upper_limit_fahrenheit?: (number | undefined) | null;
55701
56620
  };
55702
56621
  commonParams: {};
@@ -55708,15 +56627,25 @@ interface Routes {
55708
56627
  method: 'POST' | 'PATCH';
55709
56628
  queryParams: {};
55710
56629
  jsonBody: {
56630
+ /** ID of the desired thermostat device. */
55711
56631
  device_id: string;
56632
+ /** Unique key to identify the climate preset. */
55712
56633
  climate_preset_key: string;
56634
+ /** User-friendly name to identify the climate preset. */
55713
56635
  name?: (string | null) | undefined;
56636
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
55714
56637
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56638
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
55715
56639
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
56640
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
55716
56641
  cooling_set_point_celsius?: number | undefined;
56642
+ /** Temperature to which the thermostat should heat (in °C). */
55717
56643
  heating_set_point_celsius?: number | undefined;
56644
+ /** Temperature to which the thermostat should cool (in °F). */
55718
56645
  cooling_set_point_fahrenheit?: number | undefined;
56646
+ /** Temperature to which the thermostat should heat (in °F). */
55719
56647
  heating_set_point_fahrenheit?: number | undefined;
56648
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
55720
56649
  manual_override_allowed: boolean;
55721
56650
  };
55722
56651
  commonParams: {};
@@ -56259,60 +57188,104 @@ interface Routes {
56259
57188
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56260
57189
  is_temporary_manual_override_active?: boolean | undefined;
56261
57190
  current_climate_setting?: {
57191
+ /** Unique key to identify the climate preset. */
56262
57192
  climate_preset_key?: string | undefined;
57193
+ /** Indicates whether this climate preset key can be edited. */
56263
57194
  can_edit?: boolean | undefined;
57195
+ /** Indicates whether this climate preset key can be deleted. */
56264
57196
  can_delete?: boolean | undefined;
57197
+ /** User-friendly name to identify the climate preset. */
56265
57198
  name?: ((string | null) | undefined) | undefined;
57199
+ /** Display name for the climate preset. */
56266
57200
  display_name?: string | undefined;
57201
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56267
57202
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57203
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56268
57204
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57205
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56269
57206
  cooling_set_point_celsius?: (number | undefined) | undefined;
57207
+ /** Temperature to which the thermostat should heat (in °C). */
56270
57208
  heating_set_point_celsius?: (number | undefined) | undefined;
57209
+ /** Temperature to which the thermostat should cool (in °F). */
56271
57210
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57211
+ /** Temperature to which the thermostat should heat (in °F). */
56272
57212
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57213
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56273
57214
  manual_override_allowed?: boolean | undefined;
56274
57215
  } | undefined;
56275
57216
  /**
56276
57217
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
56277
57218
  default_climate_setting?: {
57219
+ /** Unique key to identify the climate preset. */
56278
57220
  climate_preset_key?: string | undefined;
57221
+ /** Indicates whether this climate preset key can be edited. */
56279
57222
  can_edit?: boolean | undefined;
57223
+ /** Indicates whether this climate preset key can be deleted. */
56280
57224
  can_delete?: boolean | undefined;
57225
+ /** User-friendly name to identify the climate preset. */
56281
57226
  name?: ((string | null) | undefined) | undefined;
57227
+ /** Display name for the climate preset. */
56282
57228
  display_name?: string | undefined;
57229
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56283
57230
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57231
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56284
57232
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57233
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56285
57234
  cooling_set_point_celsius?: (number | undefined) | undefined;
57235
+ /** Temperature to which the thermostat should heat (in °C). */
56286
57236
  heating_set_point_celsius?: (number | undefined) | undefined;
57237
+ /** Temperature to which the thermostat should cool (in °F). */
56287
57238
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57239
+ /** Temperature to which the thermostat should heat (in °F). */
56288
57240
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57241
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56289
57242
  manual_override_allowed?: boolean | undefined;
56290
57243
  } | undefined;
56291
57244
  available_climate_presets?: Array<{
57245
+ /** Unique key to identify the climate preset. */
56292
57246
  climate_preset_key: string;
57247
+ /** Indicates whether this climate preset key can be edited. */
56293
57248
  can_edit: boolean;
57249
+ /** Indicates whether this climate preset key can be deleted. */
56294
57250
  can_delete: boolean;
57251
+ /** User-friendly name to identify the climate preset. */
56295
57252
  name?: (string | null) | undefined;
57253
+ /** Display name for the climate preset. */
56296
57254
  display_name: string;
57255
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56297
57256
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
57257
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56298
57258
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
57259
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56299
57260
  cooling_set_point_celsius?: number | undefined;
57261
+ /** Temperature to which the thermostat should heat (in °C). */
56300
57262
  heating_set_point_celsius?: number | undefined;
57263
+ /** Temperature to which the thermostat should cool (in °F). */
56301
57264
  cooling_set_point_fahrenheit?: number | undefined;
57265
+ /** Temperature to which the thermostat should heat (in °F). */
56302
57266
  heating_set_point_fahrenheit?: number | undefined;
57267
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56303
57268
  manual_override_allowed: boolean;
56304
57269
  }> | undefined;
56305
57270
  fallback_climate_preset_key?: (string | null) | undefined;
56306
57271
  active_thermostat_schedule?: ({
57272
+ /** ID of the climate schedule. */
56307
57273
  thermostat_schedule_id: string;
57274
+ /** ID of the desired thermostat device. */
56308
57275
  device_id: string;
57276
+ /** User-friendly name to identify the climate schedule. */
56309
57277
  name?: string | undefined;
57278
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
56310
57279
  climate_preset_key: string;
57280
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
56311
57281
  max_override_period_minutes: number;
57282
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56312
57283
  starts_at: string;
57284
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56313
57285
  ends_at: string;
57286
+ /** Date and time at which the climate schedule was created. */
56314
57287
  created_at: string;
56315
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
57288
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
56316
57289
  errors?: any;
56317
57290
  } | null) | undefined;
56318
57291
  min_cooling_set_point_celsius?: number | undefined;
@@ -56724,60 +57697,104 @@ interface Routes {
56724
57697
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
56725
57698
  is_temporary_manual_override_active?: boolean | undefined;
56726
57699
  current_climate_setting?: {
57700
+ /** Unique key to identify the climate preset. */
56727
57701
  climate_preset_key?: string | undefined;
57702
+ /** Indicates whether this climate preset key can be edited. */
56728
57703
  can_edit?: boolean | undefined;
57704
+ /** Indicates whether this climate preset key can be deleted. */
56729
57705
  can_delete?: boolean | undefined;
57706
+ /** User-friendly name to identify the climate preset. */
56730
57707
  name?: ((string | null) | undefined) | undefined;
57708
+ /** Display name for the climate preset. */
56731
57709
  display_name?: string | undefined;
57710
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56732
57711
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57712
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56733
57713
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57714
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56734
57715
  cooling_set_point_celsius?: (number | undefined) | undefined;
57716
+ /** Temperature to which the thermostat should heat (in °C). */
56735
57717
  heating_set_point_celsius?: (number | undefined) | undefined;
57718
+ /** Temperature to which the thermostat should cool (in °F). */
56736
57719
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57720
+ /** Temperature to which the thermostat should heat (in °F). */
56737
57721
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57722
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56738
57723
  manual_override_allowed?: boolean | undefined;
56739
57724
  } | undefined;
56740
57725
  /**
56741
57726
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
56742
57727
  default_climate_setting?: {
57728
+ /** Unique key to identify the climate preset. */
56743
57729
  climate_preset_key?: string | undefined;
57730
+ /** Indicates whether this climate preset key can be edited. */
56744
57731
  can_edit?: boolean | undefined;
57732
+ /** Indicates whether this climate preset key can be deleted. */
56745
57733
  can_delete?: boolean | undefined;
57734
+ /** User-friendly name to identify the climate preset. */
56746
57735
  name?: ((string | null) | undefined) | undefined;
57736
+ /** Display name for the climate preset. */
56747
57737
  display_name?: string | undefined;
57738
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56748
57739
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
57740
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56749
57741
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
57742
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56750
57743
  cooling_set_point_celsius?: (number | undefined) | undefined;
57744
+ /** Temperature to which the thermostat should heat (in °C). */
56751
57745
  heating_set_point_celsius?: (number | undefined) | undefined;
57746
+ /** Temperature to which the thermostat should cool (in °F). */
56752
57747
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
57748
+ /** Temperature to which the thermostat should heat (in °F). */
56753
57749
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
57750
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56754
57751
  manual_override_allowed?: boolean | undefined;
56755
57752
  } | undefined;
56756
57753
  available_climate_presets?: Array<{
57754
+ /** Unique key to identify the climate preset. */
56757
57755
  climate_preset_key: string;
57756
+ /** Indicates whether this climate preset key can be edited. */
56758
57757
  can_edit: boolean;
57758
+ /** Indicates whether this climate preset key can be deleted. */
56759
57759
  can_delete: boolean;
57760
+ /** User-friendly name to identify the climate preset. */
56760
57761
  name?: (string | null) | undefined;
57762
+ /** Display name for the climate preset. */
56761
57763
  display_name: string;
57764
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
56762
57765
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
57766
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
56763
57767
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
57768
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
56764
57769
  cooling_set_point_celsius?: number | undefined;
57770
+ /** Temperature to which the thermostat should heat (in °C). */
56765
57771
  heating_set_point_celsius?: number | undefined;
57772
+ /** Temperature to which the thermostat should cool (in °F). */
56766
57773
  cooling_set_point_fahrenheit?: number | undefined;
57774
+ /** Temperature to which the thermostat should heat (in °F). */
56767
57775
  heating_set_point_fahrenheit?: number | undefined;
57776
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
56768
57777
  manual_override_allowed: boolean;
56769
57778
  }> | undefined;
56770
57779
  fallback_climate_preset_key?: (string | null) | undefined;
56771
57780
  active_thermostat_schedule?: ({
57781
+ /** ID of the climate schedule. */
56772
57782
  thermostat_schedule_id: string;
57783
+ /** ID of the desired thermostat device. */
56773
57784
  device_id: string;
57785
+ /** User-friendly name to identify the climate schedule. */
56774
57786
  name?: string | undefined;
57787
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
56775
57788
  climate_preset_key: string;
57789
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
56776
57790
  max_override_period_minutes: number;
57791
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56777
57792
  starts_at: string;
57793
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56778
57794
  ends_at: string;
57795
+ /** Date and time at which the climate schedule was created. */
56779
57796
  created_at: string;
56780
- /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
57797
+ /** Array of errors associated with the climate schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
56781
57798
  errors?: any;
56782
57799
  } | null) | undefined;
56783
57800
  min_cooling_set_point_celsius?: number | undefined;
@@ -56913,21 +57930,21 @@ interface Routes {
56913
57930
  created_at: string;
56914
57931
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
56915
57932
  message: string;
56916
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
57933
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
56917
57934
  error_code: 'salto_ks_subscription_limit_exceeded';
56918
57935
  } | {
56919
57936
  /** Date and time at which Seam created the error. */
56920
57937
  created_at: string;
56921
57938
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
56922
57939
  message: string;
56923
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
57940
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
56924
57941
  error_code: 'acs_system_disconnected';
56925
57942
  } | {
56926
57943
  /** Date and time at which Seam created the error. */
56927
57944
  created_at: string;
56928
57945
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
56929
57946
  message: string;
56930
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
57947
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
56931
57948
  error_code: 'account_disconnected';
56932
57949
  }>;
56933
57950
  /** Warnings associated with the `acs_system`. */