@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
@@ -649,6 +649,7 @@ export default {
649
649
  type: 'object',
650
650
  },
651
651
  {
652
+ description: '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.',
652
653
  properties: {
653
654
  created_at: {
654
655
  description: 'Date and time at which Seam created the error.',
@@ -656,7 +657,7 @@ export default {
656
657
  type: 'string',
657
658
  },
658
659
  error_code: {
659
- description: '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.',
660
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
660
661
  enum: ['salto_ks_subscription_limit_exceeded'],
661
662
  type: 'string',
662
663
  },
@@ -669,6 +670,7 @@ export default {
669
670
  type: 'object',
670
671
  },
671
672
  {
673
+ description: 'Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
672
674
  properties: {
673
675
  created_at: {
674
676
  description: 'Date and time at which Seam created the error.',
@@ -676,7 +678,7 @@ export default {
676
678
  type: 'string',
677
679
  },
678
680
  error_code: {
679
- description: '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.',
681
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
680
682
  enum: ['acs_system_disconnected'],
681
683
  type: 'string',
682
684
  },
@@ -689,6 +691,7 @@ export default {
689
691
  type: 'object',
690
692
  },
691
693
  {
694
+ description: 'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
692
695
  properties: {
693
696
  created_at: {
694
697
  description: 'Date and time at which Seam created the error.',
@@ -696,7 +699,7 @@ export default {
696
699
  type: 'string',
697
700
  },
698
701
  error_code: {
699
- description: 'Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.',
702
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
700
703
  enum: ['account_disconnected'],
701
704
  type: 'string',
702
705
  },
@@ -4412,20 +4415,44 @@ export default {
4412
4415
  default: null,
4413
4416
  nullable: true,
4414
4417
  properties: {
4415
- climate_preset_key: { type: 'string' },
4416
- created_at: { format: 'date-time', type: 'string' },
4417
- device_id: { format: 'uuid', type: 'string' },
4418
- ends_at: { format: 'date-time', type: 'string' },
4418
+ climate_preset_key: {
4419
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
4420
+ type: 'string',
4421
+ },
4422
+ created_at: {
4423
+ description: 'Date and time at which the climate schedule was created.',
4424
+ format: 'date-time',
4425
+ type: 'string',
4426
+ },
4427
+ device_id: {
4428
+ description: 'ID of the desired thermostat device.',
4429
+ format: 'uuid',
4430
+ type: 'string',
4431
+ },
4432
+ ends_at: {
4433
+ description: 'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
4434
+ format: 'date-time',
4435
+ type: 'string',
4436
+ },
4419
4437
  errors: {
4420
- description: '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.',
4438
+ description: '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.',
4421
4439
  },
4422
4440
  max_override_period_minutes: {
4441
+ description: "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).",
4423
4442
  minimum: 0,
4424
4443
  type: 'integer',
4425
4444
  },
4426
- name: { type: 'string' },
4427
- starts_at: { format: 'date-time', type: 'string' },
4445
+ name: {
4446
+ description: 'User-friendly name to identify the climate schedule.',
4447
+ type: 'string',
4448
+ },
4449
+ starts_at: {
4450
+ description: 'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
4451
+ format: 'date-time',
4452
+ type: 'string',
4453
+ },
4428
4454
  thermostat_schedule_id: {
4455
+ description: 'ID of the climate schedule.',
4429
4456
  format: 'uuid',
4430
4457
  type: 'string',
4431
4458
  },
@@ -4444,37 +4471,59 @@ export default {
4444
4471
  available_climate_presets: {
4445
4472
  items: {
4446
4473
  properties: {
4447
- can_delete: { type: 'boolean' },
4448
- can_edit: { type: 'boolean' },
4449
- climate_preset_key: { type: 'string' },
4474
+ can_delete: {
4475
+ description: 'Indicates whether this climate preset key can be deleted.',
4476
+ type: 'boolean',
4477
+ },
4478
+ can_edit: {
4479
+ description: 'Indicates whether this climate preset key can be edited.',
4480
+ type: 'boolean',
4481
+ },
4482
+ climate_preset_key: {
4483
+ description: 'Unique key to identify the climate preset.',
4484
+ type: 'string',
4485
+ },
4450
4486
  cooling_set_point_celsius: {
4487
+ description: '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).',
4451
4488
  format: 'float',
4452
4489
  type: 'number',
4453
4490
  },
4454
4491
  cooling_set_point_fahrenheit: {
4492
+ description: 'Temperature to which the thermostat should cool (in °F).',
4455
4493
  format: 'float',
4456
4494
  type: 'number',
4457
4495
  },
4458
- display_name: { type: 'string' },
4496
+ display_name: {
4497
+ description: 'Display name for the climate preset.',
4498
+ type: 'string',
4499
+ },
4459
4500
  fan_mode_setting: {
4501
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4460
4502
  enum: ['auto', 'on', 'circulate'],
4461
4503
  type: 'string',
4462
4504
  },
4463
4505
  heating_set_point_celsius: {
4506
+ description: 'Temperature to which the thermostat should heat (in °C).',
4464
4507
  format: 'float',
4465
4508
  type: 'number',
4466
4509
  },
4467
4510
  heating_set_point_fahrenheit: {
4511
+ description: 'Temperature to which the thermostat should heat (in °F).',
4468
4512
  format: 'float',
4469
4513
  type: 'number',
4470
4514
  },
4471
4515
  hvac_mode_setting: {
4516
+ description: '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`.',
4472
4517
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4473
4518
  type: 'string',
4474
4519
  },
4475
- manual_override_allowed: { type: 'boolean' },
4520
+ manual_override_allowed: {
4521
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4522
+ type: 'boolean',
4523
+ },
4476
4524
  name: {
4477
4525
  default: null,
4526
+ description: 'User-friendly name to identify the climate preset.',
4478
4527
  nullable: true,
4479
4528
  type: 'string',
4480
4529
  },
@@ -4506,37 +4555,59 @@ export default {
4506
4555
  },
4507
4556
  current_climate_setting: {
4508
4557
  properties: {
4509
- can_delete: { type: 'boolean' },
4510
- can_edit: { type: 'boolean' },
4511
- climate_preset_key: { type: 'string' },
4558
+ can_delete: {
4559
+ description: 'Indicates whether this climate preset key can be deleted.',
4560
+ type: 'boolean',
4561
+ },
4562
+ can_edit: {
4563
+ description: 'Indicates whether this climate preset key can be edited.',
4564
+ type: 'boolean',
4565
+ },
4566
+ climate_preset_key: {
4567
+ description: 'Unique key to identify the climate preset.',
4568
+ type: 'string',
4569
+ },
4512
4570
  cooling_set_point_celsius: {
4571
+ description: '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).',
4513
4572
  format: 'float',
4514
4573
  type: 'number',
4515
4574
  },
4516
4575
  cooling_set_point_fahrenheit: {
4576
+ description: 'Temperature to which the thermostat should cool (in °F).',
4517
4577
  format: 'float',
4518
4578
  type: 'number',
4519
4579
  },
4520
- display_name: { type: 'string' },
4580
+ display_name: {
4581
+ description: 'Display name for the climate preset.',
4582
+ type: 'string',
4583
+ },
4521
4584
  fan_mode_setting: {
4585
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4522
4586
  enum: ['auto', 'on', 'circulate'],
4523
4587
  type: 'string',
4524
4588
  },
4525
4589
  heating_set_point_celsius: {
4590
+ description: 'Temperature to which the thermostat should heat (in °C).',
4526
4591
  format: 'float',
4527
4592
  type: 'number',
4528
4593
  },
4529
4594
  heating_set_point_fahrenheit: {
4595
+ description: 'Temperature to which the thermostat should heat (in °F).',
4530
4596
  format: 'float',
4531
4597
  type: 'number',
4532
4598
  },
4533
4599
  hvac_mode_setting: {
4600
+ description: '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`.',
4534
4601
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4535
4602
  type: 'string',
4536
4603
  },
4537
- manual_override_allowed: { type: 'boolean' },
4604
+ manual_override_allowed: {
4605
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4606
+ type: 'boolean',
4607
+ },
4538
4608
  name: {
4539
4609
  default: null,
4610
+ description: 'User-friendly name to identify the climate preset.',
4540
4611
  nullable: true,
4541
4612
  type: 'string',
4542
4613
  },
@@ -4546,37 +4617,59 @@ export default {
4546
4617
  default_climate_setting: {
4547
4618
  deprecated: true,
4548
4619
  properties: {
4549
- can_delete: { type: 'boolean' },
4550
- can_edit: { type: 'boolean' },
4551
- climate_preset_key: { type: 'string' },
4620
+ can_delete: {
4621
+ description: 'Indicates whether this climate preset key can be deleted.',
4622
+ type: 'boolean',
4623
+ },
4624
+ can_edit: {
4625
+ description: 'Indicates whether this climate preset key can be edited.',
4626
+ type: 'boolean',
4627
+ },
4628
+ climate_preset_key: {
4629
+ description: 'Unique key to identify the climate preset.',
4630
+ type: 'string',
4631
+ },
4552
4632
  cooling_set_point_celsius: {
4633
+ description: '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).',
4553
4634
  format: 'float',
4554
4635
  type: 'number',
4555
4636
  },
4556
4637
  cooling_set_point_fahrenheit: {
4638
+ description: 'Temperature to which the thermostat should cool (in °F).',
4557
4639
  format: 'float',
4558
4640
  type: 'number',
4559
4641
  },
4560
- display_name: { type: 'string' },
4642
+ display_name: {
4643
+ description: 'Display name for the climate preset.',
4644
+ type: 'string',
4645
+ },
4561
4646
  fan_mode_setting: {
4647
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4562
4648
  enum: ['auto', 'on', 'circulate'],
4563
4649
  type: 'string',
4564
4650
  },
4565
4651
  heating_set_point_celsius: {
4652
+ description: 'Temperature to which the thermostat should heat (in °C).',
4566
4653
  format: 'float',
4567
4654
  type: 'number',
4568
4655
  },
4569
4656
  heating_set_point_fahrenheit: {
4657
+ description: 'Temperature to which the thermostat should heat (in °F).',
4570
4658
  format: 'float',
4571
4659
  type: 'number',
4572
4660
  },
4573
4661
  hvac_mode_setting: {
4662
+ description: '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`.',
4574
4663
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4575
4664
  type: 'string',
4576
4665
  },
4577
- manual_override_allowed: { type: 'boolean' },
4666
+ manual_override_allowed: {
4667
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4668
+ type: 'boolean',
4669
+ },
4578
4670
  name: {
4579
4671
  default: null,
4672
+ description: 'User-friendly name to identify the climate preset.',
4580
4673
  nullable: true,
4581
4674
  type: 'string',
4582
4675
  },
@@ -5070,17 +5163,47 @@ export default {
5070
5163
  },
5071
5164
  thermostat_schedule: {
5072
5165
  properties: {
5073
- climate_preset_key: { type: 'string' },
5074
- created_at: { format: 'date-time', type: 'string' },
5075
- device_id: { format: 'uuid', type: 'string' },
5076
- ends_at: { format: 'date-time', type: 'string' },
5166
+ climate_preset_key: {
5167
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
5168
+ type: 'string',
5169
+ },
5170
+ created_at: {
5171
+ description: 'Date and time at which the climate schedule was created.',
5172
+ format: 'date-time',
5173
+ type: 'string',
5174
+ },
5175
+ device_id: {
5176
+ description: 'ID of the desired thermostat device.',
5177
+ format: 'uuid',
5178
+ type: 'string',
5179
+ },
5180
+ ends_at: {
5181
+ description: 'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
5182
+ format: 'date-time',
5183
+ type: 'string',
5184
+ },
5077
5185
  errors: {
5078
- description: '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.',
5186
+ description: '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.',
5187
+ },
5188
+ max_override_period_minutes: {
5189
+ description: "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).",
5190
+ minimum: 0,
5191
+ type: 'integer',
5192
+ },
5193
+ name: {
5194
+ description: 'User-friendly name to identify the climate schedule.',
5195
+ type: 'string',
5196
+ },
5197
+ starts_at: {
5198
+ description: 'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
5199
+ format: 'date-time',
5200
+ type: 'string',
5201
+ },
5202
+ thermostat_schedule_id: {
5203
+ description: 'ID of the climate schedule.',
5204
+ format: 'uuid',
5205
+ type: 'string',
5079
5206
  },
5080
- max_override_period_minutes: { minimum: 0, type: 'integer' },
5081
- name: { type: 'string' },
5082
- starts_at: { format: 'date-time', type: 'string' },
5083
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
5084
5207
  },
5085
5208
  required: [
5086
5209
  'thermostat_schedule_id',
@@ -12219,34 +12342,47 @@ export default {
12219
12342
  },
12220
12343
  '/devices/list': {
12221
12344
  post: {
12345
+ description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
12222
12346
  operationId: 'devicesListPost',
12223
12347
  requestBody: {
12224
12348
  content: {
12225
12349
  'application/json': {
12226
12350
  schema: {
12227
12351
  properties: {
12228
- connect_webview_id: { format: 'uuid', type: 'string' },
12352
+ connect_webview_id: {
12353
+ description: 'ID of the Connect Webview by which to filter devices.',
12354
+ format: 'uuid',
12355
+ type: 'string',
12356
+ },
12229
12357
  connected_account_id: {
12230
- description: 'List all devices owned by this connected account',
12358
+ description: 'ID of the connected account by which to filter.',
12231
12359
  format: 'uuid',
12232
12360
  type: 'string',
12233
12361
  },
12234
12362
  connected_account_ids: {
12363
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
12235
12364
  items: { format: 'uuid', type: 'string' },
12236
12365
  type: 'array',
12237
12366
  },
12238
- created_before: { format: 'date-time', type: 'string' },
12367
+ created_before: {
12368
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
12369
+ format: 'date-time',
12370
+ type: 'string',
12371
+ },
12239
12372
  custom_metadata_has: {
12240
12373
  additionalProperties: {
12241
12374
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
12242
12375
  },
12376
+ description: '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.',
12243
12377
  type: 'object',
12244
12378
  },
12245
12379
  device_ids: {
12380
+ description: 'Array of device IDs by which to filter devices.',
12246
12381
  items: { format: 'uuid', type: 'string' },
12247
12382
  type: 'array',
12248
12383
  },
12249
12384
  device_type: {
12385
+ description: 'Device type by which to filter devices.',
12250
12386
  oneOf: [
12251
12387
  {
12252
12388
  enum: [
@@ -12303,6 +12439,7 @@ export default {
12303
12439
  ],
12304
12440
  },
12305
12441
  device_types: {
12442
+ description: 'Array of device types by which to filter devices.',
12306
12443
  items: {
12307
12444
  oneOf: [
12308
12445
  {
@@ -12382,6 +12519,7 @@ export default {
12382
12519
  type: 'string',
12383
12520
  },
12384
12521
  type: 'array',
12522
+ 'x-undocumented': 'Only used internally.',
12385
12523
  },
12386
12524
  include_if: {
12387
12525
  items: {
@@ -12401,9 +12539,16 @@ export default {
12401
12539
  type: 'string',
12402
12540
  },
12403
12541
  type: 'array',
12542
+ 'x-undocumented': 'Only used internally.',
12543
+ },
12544
+ limit: {
12545
+ default: 500,
12546
+ description: 'Numerical limit on the number of devices to return.',
12547
+ format: 'float',
12548
+ type: 'number',
12404
12549
  },
12405
- limit: { default: 500, format: 'float', type: 'number' },
12406
12550
  manufacturer: {
12551
+ description: 'Manufacturer by which to filter devices.',
12407
12552
  enum: [
12408
12553
  'akuvox',
12409
12554
  'august',
@@ -12443,7 +12588,10 @@ export default {
12443
12588
  ],
12444
12589
  type: 'string',
12445
12590
  },
12446
- user_identifier_key: { type: 'string' },
12591
+ user_identifier_key: {
12592
+ description: 'Your own internal user ID for the user by which to filter devices.',
12593
+ type: 'string',
12594
+ },
12447
12595
  },
12448
12596
  type: 'object',
12449
12597
  },
@@ -12484,6 +12632,7 @@ export default {
12484
12632
  'x-fern-sdk-method-name': 'list',
12485
12633
  'x-fern-sdk-return-value': 'devices',
12486
12634
  'x-response-key': 'devices',
12635
+ 'x-title': 'List Devices',
12487
12636
  },
12488
12637
  },
12489
12638
  '/devices/list_device_providers': {
@@ -12729,28 +12878,40 @@ export default {
12729
12878
  'application/json': {
12730
12879
  schema: {
12731
12880
  properties: {
12732
- connect_webview_id: { format: 'uuid', type: 'string' },
12881
+ connect_webview_id: {
12882
+ description: 'ID of the Connect Webview by which to filter devices.',
12883
+ format: 'uuid',
12884
+ type: 'string',
12885
+ },
12733
12886
  connected_account_id: {
12734
- description: 'List all devices owned by this connected account',
12887
+ description: 'ID of the connected account by which to filter.',
12735
12888
  format: 'uuid',
12736
12889
  type: 'string',
12737
12890
  },
12738
12891
  connected_account_ids: {
12892
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
12739
12893
  items: { format: 'uuid', type: 'string' },
12740
12894
  type: 'array',
12741
12895
  },
12742
- created_before: { format: 'date-time', type: 'string' },
12896
+ created_before: {
12897
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
12898
+ format: 'date-time',
12899
+ type: 'string',
12900
+ },
12743
12901
  custom_metadata_has: {
12744
12902
  additionalProperties: {
12745
12903
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
12746
12904
  },
12905
+ description: '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.',
12747
12906
  type: 'object',
12748
12907
  },
12749
12908
  device_ids: {
12909
+ description: 'Array of device IDs by which to filter devices.',
12750
12910
  items: { format: 'uuid', type: 'string' },
12751
12911
  type: 'array',
12752
12912
  },
12753
12913
  device_type: {
12914
+ description: 'Device type by which to filter devices.',
12754
12915
  oneOf: [
12755
12916
  {
12756
12917
  enum: [
@@ -12807,6 +12968,7 @@ export default {
12807
12968
  ],
12808
12969
  },
12809
12970
  device_types: {
12971
+ description: 'Array of device types by which to filter devices.',
12810
12972
  items: {
12811
12973
  oneOf: [
12812
12974
  {
@@ -12886,6 +13048,7 @@ export default {
12886
13048
  type: 'string',
12887
13049
  },
12888
13050
  type: 'array',
13051
+ 'x-undocumented': 'Only used internally.',
12889
13052
  },
12890
13053
  include_if: {
12891
13054
  items: {
@@ -12905,9 +13068,16 @@ export default {
12905
13068
  type: 'string',
12906
13069
  },
12907
13070
  type: 'array',
13071
+ 'x-undocumented': 'Only used internally.',
13072
+ },
13073
+ limit: {
13074
+ default: 500,
13075
+ description: 'Numerical limit on the number of devices to return.',
13076
+ format: 'float',
13077
+ type: 'number',
12908
13078
  },
12909
- limit: { default: 500, format: 'float', type: 'number' },
12910
13079
  manufacturer: {
13080
+ description: 'Manufacturer by which to filter devices.',
12911
13081
  enum: [
12912
13082
  'akuvox',
12913
13083
  'august',
@@ -12947,7 +13117,10 @@ export default {
12947
13117
  ],
12948
13118
  type: 'string',
12949
13119
  },
12950
- user_identifier_key: { type: 'string' },
13120
+ user_identifier_key: {
13121
+ description: 'Your own internal user ID for the user by which to filter devices.',
13122
+ type: 'string',
13123
+ },
12951
13124
  },
12952
13125
  type: 'object',
12953
13126
  },
@@ -13340,6 +13513,8 @@ export default {
13340
13513
  'acs_user.deleted',
13341
13514
  'acs_credential.deleted',
13342
13515
  'acs_credential.issued',
13516
+ 'acs_encoder.added',
13517
+ 'acs_encoder.removed',
13343
13518
  'enrollment_automation.deleted',
13344
13519
  'client_session.deleted',
13345
13520
  'action_attempt.lock_door.succeeded',
@@ -13414,6 +13589,8 @@ export default {
13414
13589
  'acs_user.deleted',
13415
13590
  'acs_credential.deleted',
13416
13591
  'acs_credential.issued',
13592
+ 'acs_encoder.added',
13593
+ 'acs_encoder.removed',
13417
13594
  'enrollment_automation.deleted',
13418
13595
  'client_session.deleted',
13419
13596
  'action_attempt.lock_door.succeeded',
@@ -13533,28 +13710,40 @@ export default {
13533
13710
  'application/json': {
13534
13711
  schema: {
13535
13712
  properties: {
13536
- connect_webview_id: { format: 'uuid', type: 'string' },
13713
+ connect_webview_id: {
13714
+ description: 'ID of the Connect Webview by which to filter devices.',
13715
+ format: 'uuid',
13716
+ type: 'string',
13717
+ },
13537
13718
  connected_account_id: {
13538
- description: 'List all devices owned by this connected account',
13719
+ description: 'ID of the connected account by which to filter.',
13539
13720
  format: 'uuid',
13540
13721
  type: 'string',
13541
13722
  },
13542
13723
  connected_account_ids: {
13724
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
13543
13725
  items: { format: 'uuid', type: 'string' },
13544
13726
  type: 'array',
13545
13727
  },
13546
- created_before: { format: 'date-time', type: 'string' },
13728
+ created_before: {
13729
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
13730
+ format: 'date-time',
13731
+ type: 'string',
13732
+ },
13547
13733
  custom_metadata_has: {
13548
13734
  additionalProperties: {
13549
13735
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
13550
13736
  },
13737
+ description: '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.',
13551
13738
  type: 'object',
13552
13739
  },
13553
13740
  device_ids: {
13741
+ description: 'Array of device IDs by which to filter devices.',
13554
13742
  items: { format: 'uuid', type: 'string' },
13555
13743
  type: 'array',
13556
13744
  },
13557
13745
  device_type: {
13746
+ description: 'Device type by which to filter devices.',
13558
13747
  oneOf: [
13559
13748
  {
13560
13749
  enum: [
@@ -13611,6 +13800,7 @@ export default {
13611
13800
  ],
13612
13801
  },
13613
13802
  device_types: {
13803
+ description: 'Array of device types by which to filter devices.',
13614
13804
  items: {
13615
13805
  oneOf: [
13616
13806
  {
@@ -13690,6 +13880,7 @@ export default {
13690
13880
  type: 'string',
13691
13881
  },
13692
13882
  type: 'array',
13883
+ 'x-undocumented': 'Only used internally.',
13693
13884
  },
13694
13885
  include_if: {
13695
13886
  items: {
@@ -13709,9 +13900,16 @@ export default {
13709
13900
  type: 'string',
13710
13901
  },
13711
13902
  type: 'array',
13903
+ 'x-undocumented': 'Only used internally.',
13904
+ },
13905
+ limit: {
13906
+ default: 500,
13907
+ description: 'Numerical limit on the number of devices to return.',
13908
+ format: 'float',
13909
+ type: 'number',
13712
13910
  },
13713
- limit: { default: 500, format: 'float', type: 'number' },
13714
13911
  manufacturer: {
13912
+ description: 'Manufacturer by which to filter devices.',
13715
13913
  enum: [
13716
13914
  'akuvox',
13717
13915
  'august',
@@ -13751,7 +13949,10 @@ export default {
13751
13949
  ],
13752
13950
  type: 'string',
13753
13951
  },
13754
- user_identifier_key: { type: 'string' },
13952
+ user_identifier_key: {
13953
+ description: 'Your own internal user ID for the user by which to filter devices.',
13954
+ type: 'string',
13955
+ },
13755
13956
  },
13756
13957
  type: 'object',
13757
13958
  },
@@ -13999,28 +14200,40 @@ export default {
13999
14200
  'application/json': {
14000
14201
  schema: {
14001
14202
  properties: {
14002
- connect_webview_id: { format: 'uuid', type: 'string' },
14203
+ connect_webview_id: {
14204
+ description: 'ID of the Connect Webview by which to filter devices.',
14205
+ format: 'uuid',
14206
+ type: 'string',
14207
+ },
14003
14208
  connected_account_id: {
14004
- description: 'List all devices owned by this connected account',
14209
+ description: 'ID of the connected account by which to filter.',
14005
14210
  format: 'uuid',
14006
14211
  type: 'string',
14007
14212
  },
14008
14213
  connected_account_ids: {
14214
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
14009
14215
  items: { format: 'uuid', type: 'string' },
14010
14216
  type: 'array',
14011
14217
  },
14012
- created_before: { format: 'date-time', type: 'string' },
14218
+ created_before: {
14219
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
14220
+ format: 'date-time',
14221
+ type: 'string',
14222
+ },
14013
14223
  custom_metadata_has: {
14014
14224
  additionalProperties: {
14015
14225
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
14016
14226
  },
14227
+ description: '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.',
14017
14228
  type: 'object',
14018
14229
  },
14019
14230
  device_ids: {
14231
+ description: 'Array of device IDs by which to filter devices.',
14020
14232
  items: { format: 'uuid', type: 'string' },
14021
14233
  type: 'array',
14022
14234
  },
14023
14235
  device_type: {
14236
+ description: 'Device type by which to filter devices.',
14024
14237
  oneOf: [
14025
14238
  {
14026
14239
  enum: [
@@ -14077,6 +14290,7 @@ export default {
14077
14290
  ],
14078
14291
  },
14079
14292
  device_types: {
14293
+ description: 'Array of device types by which to filter devices.',
14080
14294
  items: {
14081
14295
  oneOf: [
14082
14296
  {
@@ -14156,6 +14370,7 @@ export default {
14156
14370
  type: 'string',
14157
14371
  },
14158
14372
  type: 'array',
14373
+ 'x-undocumented': 'Only used internally.',
14159
14374
  },
14160
14375
  include_if: {
14161
14376
  items: {
@@ -14175,9 +14390,16 @@ export default {
14175
14390
  type: 'string',
14176
14391
  },
14177
14392
  type: 'array',
14393
+ 'x-undocumented': 'Only used internally.',
14394
+ },
14395
+ limit: {
14396
+ default: 500,
14397
+ description: 'Numerical limit on the number of devices to return.',
14398
+ format: 'float',
14399
+ type: 'number',
14178
14400
  },
14179
- limit: { default: 500, format: 'float', type: 'number' },
14180
14401
  manufacturer: {
14402
+ description: 'Manufacturer by which to filter devices.',
14181
14403
  enum: [
14182
14404
  'akuvox',
14183
14405
  'august',
@@ -14217,7 +14439,10 @@ export default {
14217
14439
  ],
14218
14440
  type: 'string',
14219
14441
  },
14220
- user_identifier_key: { type: 'string' },
14442
+ user_identifier_key: {
14443
+ description: 'Your own internal user ID for the user by which to filter devices.',
14444
+ type: 'string',
14445
+ },
14221
14446
  },
14222
14447
  type: 'object',
14223
14448
  },
@@ -14862,14 +15087,22 @@ export default {
14862
15087
  },
14863
15088
  '/thermostats/activate_climate_preset': {
14864
15089
  post: {
15090
+ description: 'Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
14865
15091
  operationId: 'thermostatsActivateClimatePresetPost',
14866
15092
  requestBody: {
14867
15093
  content: {
14868
15094
  'application/json': {
14869
15095
  schema: {
14870
15096
  properties: {
14871
- climate_preset_key: { type: 'string' },
14872
- device_id: { format: 'uuid', type: 'string' },
15097
+ climate_preset_key: {
15098
+ description: 'Climate preset key of the desired climate preset.',
15099
+ type: 'string',
15100
+ },
15101
+ device_id: {
15102
+ description: 'ID of the desired thermostat device.',
15103
+ format: 'uuid',
15104
+ type: 'string',
15105
+ },
14873
15106
  },
14874
15107
  required: ['device_id', 'climate_preset_key'],
14875
15108
  type: 'object',
@@ -14909,11 +15142,12 @@ export default {
14909
15142
  'x-fern-sdk-method-name': 'activate_climate_preset',
14910
15143
  'x-fern-sdk-return-value': 'action_attempt',
14911
15144
  'x-response-key': 'action_attempt',
15145
+ 'x-title': 'Activate a Climate Preset',
14912
15146
  },
14913
15147
  },
14914
15148
  '/thermostats/cool': {
14915
15149
  post: {
14916
- description: 'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15150
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
14917
15151
  operationId: 'thermostatsCoolPost',
14918
15152
  requestBody: {
14919
15153
  content: {
@@ -14921,21 +15155,25 @@ export default {
14921
15155
  schema: {
14922
15156
  properties: {
14923
15157
  cooling_set_point_celsius: {
14924
- description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
15158
+ description: '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.',
14925
15159
  format: 'float',
14926
15160
  type: 'number',
14927
15161
  },
14928
15162
  cooling_set_point_fahrenheit: {
14929
- description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
15163
+ description: '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.',
14930
15164
  format: 'float',
14931
15165
  type: 'number',
14932
15166
  },
14933
15167
  device_id: {
14934
- description: 'ID of the thermostat device.',
15168
+ description: 'ID of the desired thermostat device.',
14935
15169
  format: 'uuid',
14936
15170
  type: 'string',
14937
15171
  },
14938
- sync: { default: false, type: 'boolean' },
15172
+ sync: {
15173
+ default: false,
15174
+ type: 'boolean',
15175
+ 'x-undocumented': 'Only used internally.',
15176
+ },
14939
15177
  },
14940
15178
  required: ['device_id'],
14941
15179
  type: 'object',
@@ -14981,40 +15219,62 @@ export default {
14981
15219
  },
14982
15220
  '/thermostats/create_climate_preset': {
14983
15221
  post: {
15222
+ description: 'Creates a [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
14984
15223
  operationId: 'thermostatsCreateClimatePresetPost',
14985
15224
  requestBody: {
14986
15225
  content: {
14987
15226
  'application/json': {
14988
15227
  schema: {
14989
15228
  properties: {
14990
- climate_preset_key: { type: 'string' },
15229
+ climate_preset_key: {
15230
+ description: 'Unique key to identify the climate preset.',
15231
+ type: 'string',
15232
+ },
14991
15233
  cooling_set_point_celsius: {
15234
+ description: '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).',
14992
15235
  format: 'float',
14993
15236
  type: 'number',
14994
15237
  },
14995
15238
  cooling_set_point_fahrenheit: {
15239
+ description: 'Temperature to which the thermostat should cool (in °F).',
14996
15240
  format: 'float',
14997
15241
  type: 'number',
14998
15242
  },
14999
- device_id: { format: 'uuid', type: 'string' },
15243
+ device_id: {
15244
+ description: 'ID of the desired thermostat device.',
15245
+ format: 'uuid',
15246
+ type: 'string',
15247
+ },
15000
15248
  fan_mode_setting: {
15249
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
15001
15250
  enum: ['auto', 'on', 'circulate'],
15002
15251
  type: 'string',
15003
15252
  },
15004
15253
  heating_set_point_celsius: {
15254
+ description: 'Temperature to which the thermostat should heat (in °C).',
15005
15255
  format: 'float',
15006
15256
  type: 'number',
15007
15257
  },
15008
15258
  heating_set_point_fahrenheit: {
15259
+ description: 'Temperature to which the thermostat should heat (in °F).',
15009
15260
  format: 'float',
15010
15261
  type: 'number',
15011
15262
  },
15012
15263
  hvac_mode_setting: {
15264
+ description: '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`.',
15013
15265
  enum: ['off', 'heat', 'cool', 'heat_cool'],
15014
15266
  type: 'string',
15015
15267
  },
15016
- manual_override_allowed: { type: 'boolean' },
15017
- name: { default: null, nullable: true, type: 'string' },
15268
+ manual_override_allowed: {
15269
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
15270
+ type: 'boolean',
15271
+ },
15272
+ name: {
15273
+ default: null,
15274
+ description: 'User-friendly name to identify the climate preset.',
15275
+ nullable: true,
15276
+ type: 'string',
15277
+ },
15018
15278
  },
15019
15279
  required: [
15020
15280
  'device_id',
@@ -15052,18 +15312,27 @@ export default {
15052
15312
  'x-fern-sdk-group-name': ['thermostats'],
15053
15313
  'x-fern-sdk-method-name': 'create_climate_preset',
15054
15314
  'x-response-key': null,
15315
+ 'x-title': 'Create a Climate Preset',
15055
15316
  },
15056
15317
  },
15057
15318
  '/thermostats/delete_climate_preset': {
15058
15319
  post: {
15320
+ description: 'Deletes a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15059
15321
  operationId: 'thermostatsDeleteClimatePresetPost',
15060
15322
  requestBody: {
15061
15323
  content: {
15062
15324
  'application/json': {
15063
15325
  schema: {
15064
15326
  properties: {
15065
- climate_preset_key: { type: 'string' },
15066
- device_id: { format: 'uuid', type: 'string' },
15327
+ climate_preset_key: {
15328
+ description: 'Climate preset key of the desired climate preset.',
15329
+ type: 'string',
15330
+ },
15331
+ device_id: {
15332
+ description: 'ID of the desired thermostat device.',
15333
+ format: 'uuid',
15334
+ type: 'string',
15335
+ },
15067
15336
  },
15068
15337
  required: ['device_id', 'climate_preset_key'],
15069
15338
  type: 'object',
@@ -15097,11 +15366,12 @@ export default {
15097
15366
  'x-fern-sdk-group-name': ['thermostats'],
15098
15367
  'x-fern-sdk-method-name': 'delete_climate_preset',
15099
15368
  'x-response-key': null,
15369
+ 'x-title': 'Delete a Climate Preset',
15100
15370
  },
15101
15371
  },
15102
15372
  '/thermostats/get': {
15103
15373
  post: {
15104
- description: 'Returns a specific thermostat.',
15374
+ description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15105
15375
  operationId: 'thermostatsGetPost',
15106
15376
  requestBody: {
15107
15377
  content: {
@@ -15109,12 +15379,12 @@ export default {
15109
15379
  schema: {
15110
15380
  properties: {
15111
15381
  device_id: {
15112
- description: 'ID of the thermostat device.',
15382
+ description: 'ID of the desired thermostat device.',
15113
15383
  format: 'uuid',
15114
15384
  type: 'string',
15115
15385
  },
15116
15386
  name: {
15117
- description: 'Name of the thermostat.',
15387
+ description: 'User-friendly name of the desired thermostat device.',
15118
15388
  type: 'string',
15119
15389
  },
15120
15390
  },
@@ -15156,11 +15426,12 @@ export default {
15156
15426
  'x-fern-sdk-return-value': 'thermostat',
15157
15427
  'x-response-key': 'thermostat',
15158
15428
  'x-title': 'Get a Thermostat',
15429
+ 'x-undocumented': 'Will be removed.',
15159
15430
  },
15160
15431
  },
15161
15432
  '/thermostats/heat': {
15162
15433
  post: {
15163
- description: 'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15434
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15164
15435
  operationId: 'thermostatsHeatPost',
15165
15436
  requestBody: {
15166
15437
  content: {
@@ -15168,21 +15439,25 @@ export default {
15168
15439
  schema: {
15169
15440
  properties: {
15170
15441
  device_id: {
15171
- description: 'ID of the thermostat device.',
15442
+ description: 'ID of the desired thermostat device.',
15172
15443
  format: 'uuid',
15173
15444
  type: 'string',
15174
15445
  },
15175
15446
  heating_set_point_celsius: {
15176
- description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
15447
+ description: '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.',
15177
15448
  format: 'float',
15178
15449
  type: 'number',
15179
15450
  },
15180
15451
  heating_set_point_fahrenheit: {
15181
- description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
15452
+ description: '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.',
15182
15453
  format: 'float',
15183
15454
  type: 'number',
15184
15455
  },
15185
- sync: { default: false, type: 'boolean' },
15456
+ sync: {
15457
+ default: false,
15458
+ type: 'boolean',
15459
+ 'x-undocumented': 'Only used internally.',
15460
+ },
15186
15461
  },
15187
15462
  required: ['device_id'],
15188
15463
  type: 'object',
@@ -15228,7 +15503,7 @@ export default {
15228
15503
  },
15229
15504
  '/thermostats/heat_cool': {
15230
15505
  post: {
15231
- description: 'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
15506
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15232
15507
  operationId: 'thermostatsHeatCoolPost',
15233
15508
  requestBody: {
15234
15509
  content: {
@@ -15236,31 +15511,35 @@ export default {
15236
15511
  schema: {
15237
15512
  properties: {
15238
15513
  cooling_set_point_celsius: {
15239
- description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
15514
+ description: '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.',
15240
15515
  format: 'float',
15241
15516
  type: 'number',
15242
15517
  },
15243
15518
  cooling_set_point_fahrenheit: {
15244
- description: 'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
15519
+ description: '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.',
15245
15520
  format: 'float',
15246
15521
  type: 'number',
15247
15522
  },
15248
15523
  device_id: {
15249
- description: 'ID of the thermostat device.',
15524
+ description: 'ID of the desired thermostat device.',
15250
15525
  format: 'uuid',
15251
15526
  type: 'string',
15252
15527
  },
15253
15528
  heating_set_point_celsius: {
15254
- description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
15529
+ description: '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.',
15255
15530
  format: 'float',
15256
15531
  type: 'number',
15257
15532
  },
15258
15533
  heating_set_point_fahrenheit: {
15259
- description: 'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
15534
+ description: '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.',
15260
15535
  format: 'float',
15261
15536
  type: 'number',
15262
15537
  },
15263
- sync: { default: false, type: 'boolean' },
15538
+ sync: {
15539
+ default: false,
15540
+ type: 'boolean',
15541
+ 'x-undocumented': 'Only used internally.',
15542
+ },
15264
15543
  },
15265
15544
  required: ['device_id'],
15266
15545
  type: 'object',
@@ -15306,35 +15585,47 @@ export default {
15306
15585
  },
15307
15586
  '/thermostats/list': {
15308
15587
  post: {
15309
- description: 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
15588
+ description: 'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
15310
15589
  operationId: 'thermostatsListPost',
15311
15590
  requestBody: {
15312
15591
  content: {
15313
15592
  'application/json': {
15314
15593
  schema: {
15315
15594
  properties: {
15316
- connect_webview_id: { format: 'uuid', type: 'string' },
15595
+ connect_webview_id: {
15596
+ description: 'ID of the Connect Webview by which to filter devices.',
15597
+ format: 'uuid',
15598
+ type: 'string',
15599
+ },
15317
15600
  connected_account_id: {
15318
- description: 'List all devices owned by this connected account',
15601
+ description: 'ID of the connected account by which to filter.',
15319
15602
  format: 'uuid',
15320
15603
  type: 'string',
15321
15604
  },
15322
15605
  connected_account_ids: {
15606
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
15323
15607
  items: { format: 'uuid', type: 'string' },
15324
15608
  type: 'array',
15325
15609
  },
15326
- created_before: { format: 'date-time', type: 'string' },
15610
+ created_before: {
15611
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
15612
+ format: 'date-time',
15613
+ type: 'string',
15614
+ },
15327
15615
  custom_metadata_has: {
15328
15616
  additionalProperties: {
15329
15617
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
15330
15618
  },
15619
+ description: '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.',
15331
15620
  type: 'object',
15332
15621
  },
15333
15622
  device_ids: {
15623
+ description: 'Array of device IDs by which to filter devices.',
15334
15624
  items: { format: 'uuid', type: 'string' },
15335
15625
  type: 'array',
15336
15626
  },
15337
15627
  device_type: {
15628
+ description: 'Device type by which to filter devices.',
15338
15629
  oneOf: [
15339
15630
  {
15340
15631
  enum: [
@@ -15391,6 +15682,7 @@ export default {
15391
15682
  ],
15392
15683
  },
15393
15684
  device_types: {
15685
+ description: 'Array of device types by which to filter devices.',
15394
15686
  items: {
15395
15687
  oneOf: [
15396
15688
  {
@@ -15470,6 +15762,7 @@ export default {
15470
15762
  type: 'string',
15471
15763
  },
15472
15764
  type: 'array',
15765
+ 'x-undocumented': 'Only used internally.',
15473
15766
  },
15474
15767
  include_if: {
15475
15768
  items: {
@@ -15489,9 +15782,16 @@ export default {
15489
15782
  type: 'string',
15490
15783
  },
15491
15784
  type: 'array',
15785
+ 'x-undocumented': 'Only used internally.',
15786
+ },
15787
+ limit: {
15788
+ default: 500,
15789
+ description: 'Numerical limit on the number of devices to return.',
15790
+ format: 'float',
15791
+ type: 'number',
15492
15792
  },
15493
- limit: { default: 500, format: 'float', type: 'number' },
15494
15793
  manufacturer: {
15794
+ description: 'Manufacturer by which to filter devices.',
15495
15795
  enum: [
15496
15796
  'akuvox',
15497
15797
  'august',
@@ -15531,7 +15831,10 @@ export default {
15531
15831
  ],
15532
15832
  type: 'string',
15533
15833
  },
15534
- user_identifier_key: { type: 'string' },
15834
+ user_identifier_key: {
15835
+ description: 'Your own internal user ID for the user by which to filter devices.',
15836
+ type: 'string',
15837
+ },
15535
15838
  },
15536
15839
  type: 'object',
15537
15840
  },
@@ -15581,7 +15884,7 @@ export default {
15581
15884
  },
15582
15885
  '/thermostats/off': {
15583
15886
  post: {
15584
- description: 'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15887
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15585
15888
  operationId: 'thermostatsOffPost',
15586
15889
  requestBody: {
15587
15890
  content: {
@@ -15589,11 +15892,15 @@ export default {
15589
15892
  schema: {
15590
15893
  properties: {
15591
15894
  device_id: {
15592
- description: 'ID of the thermostat device.',
15895
+ description: 'ID of the desired thermostat device.',
15593
15896
  format: 'uuid',
15594
15897
  type: 'string',
15595
15898
  },
15596
- sync: { default: false, type: 'boolean' },
15899
+ sync: {
15900
+ default: false,
15901
+ type: 'boolean',
15902
+ 'x-undocumented': 'Only used internally.',
15903
+ },
15597
15904
  },
15598
15905
  required: ['device_id'],
15599
15906
  type: 'object',
@@ -15639,22 +15946,39 @@ export default {
15639
15946
  },
15640
15947
  '/thermostats/schedules/create': {
15641
15948
  post: {
15949
+ description: 'Creates a [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15642
15950
  operationId: 'thermostatsSchedulesCreatePost',
15643
15951
  requestBody: {
15644
15952
  content: {
15645
15953
  'application/json': {
15646
15954
  schema: {
15647
15955
  properties: {
15648
- climate_preset_key: { type: 'string' },
15649
- device_id: { type: 'string' },
15650
- ends_at: { type: 'string' },
15956
+ climate_preset_key: {
15957
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
15958
+ type: 'string',
15959
+ },
15960
+ device_id: {
15961
+ description: 'ID of the desired thermostat device.',
15962
+ type: 'string',
15963
+ },
15964
+ ends_at: {
15965
+ description: 'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
15966
+ type: 'string',
15967
+ },
15651
15968
  max_override_period_minutes: {
15652
15969
  default: 0,
15970
+ description: "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).",
15653
15971
  minimum: 0,
15654
15972
  type: 'integer',
15655
15973
  },
15656
- name: { type: 'string' },
15657
- starts_at: { type: 'string' },
15974
+ name: {
15975
+ description: 'User-friendly name to identify the climate schedule.',
15976
+ type: 'string',
15977
+ },
15978
+ starts_at: {
15979
+ description: 'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
15980
+ type: 'string',
15981
+ },
15658
15982
  },
15659
15983
  required: [
15660
15984
  'device_id',
@@ -15700,17 +16024,23 @@ export default {
15700
16024
  'x-fern-sdk-method-name': 'create',
15701
16025
  'x-fern-sdk-return-value': 'thermostat_schedule',
15702
16026
  'x-response-key': 'thermostat_schedule',
16027
+ 'x-title': 'Create a Climate Schedule',
15703
16028
  },
15704
16029
  },
15705
16030
  '/thermostats/schedules/delete': {
15706
16031
  post: {
16032
+ description: 'Deletes a [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15707
16033
  operationId: 'thermostatsSchedulesDeletePost',
15708
16034
  requestBody: {
15709
16035
  content: {
15710
16036
  'application/json': {
15711
16037
  schema: {
15712
16038
  properties: {
15713
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16039
+ thermostat_schedule_id: {
16040
+ description: 'ID of the desired climate schedule.',
16041
+ format: 'uuid',
16042
+ type: 'string',
16043
+ },
15714
16044
  },
15715
16045
  required: ['thermostat_schedule_id'],
15716
16046
  type: 'object',
@@ -15745,17 +16075,23 @@ export default {
15745
16075
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
15746
16076
  'x-fern-sdk-method-name': 'delete',
15747
16077
  'x-response-key': null,
16078
+ 'x-title': 'Delete a Climate Schedule',
15748
16079
  },
15749
16080
  },
15750
16081
  '/thermostats/schedules/get': {
15751
16082
  post: {
16083
+ description: 'Returns a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
15752
16084
  operationId: 'thermostatsSchedulesGetPost',
15753
16085
  requestBody: {
15754
16086
  content: {
15755
16087
  'application/json': {
15756
16088
  schema: {
15757
16089
  properties: {
15758
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16090
+ thermostat_schedule_id: {
16091
+ description: 'ID of the desired climate schedule.',
16092
+ format: 'uuid',
16093
+ type: 'string',
16094
+ },
15759
16095
  },
15760
16096
  required: ['thermostat_schedule_id'],
15761
16097
  type: 'object',
@@ -15796,18 +16132,27 @@ export default {
15796
16132
  'x-fern-sdk-method-name': 'get',
15797
16133
  'x-fern-sdk-return-value': 'thermostat_schedule',
15798
16134
  'x-response-key': 'thermostat_schedule',
16135
+ 'x-title': 'Get a Climate Schedule',
15799
16136
  },
15800
16137
  },
15801
16138
  '/thermostats/schedules/list': {
15802
16139
  post: {
16140
+ description: 'Returns a list of all [climate schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15803
16141
  operationId: 'thermostatsSchedulesListPost',
15804
16142
  requestBody: {
15805
16143
  content: {
15806
16144
  'application/json': {
15807
16145
  schema: {
15808
16146
  properties: {
15809
- device_id: { format: 'uuid', type: 'string' },
15810
- user_identifier_key: { type: 'string' },
16147
+ device_id: {
16148
+ description: 'ID of the desired thermostat device.',
16149
+ format: 'uuid',
16150
+ type: 'string',
16151
+ },
16152
+ user_identifier_key: {
16153
+ description: 'User identifier key by which to filter the list of returned climate schedules.',
16154
+ type: 'string',
16155
+ },
15811
16156
  },
15812
16157
  required: ['device_id'],
15813
16158
  type: 'object',
@@ -15851,22 +16196,44 @@ export default {
15851
16196
  'x-fern-sdk-method-name': 'list',
15852
16197
  'x-fern-sdk-return-value': 'thermostat_schedules',
15853
16198
  'x-response-key': 'thermostat_schedules',
16199
+ 'x-title': 'List Climate Schedules',
15854
16200
  },
15855
16201
  },
15856
16202
  '/thermostats/schedules/update': {
15857
16203
  patch: {
16204
+ description: 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
15858
16205
  operationId: 'thermostatsSchedulesUpdatePatch',
15859
16206
  requestBody: {
15860
16207
  content: {
15861
16208
  'application/json': {
15862
16209
  schema: {
15863
16210
  properties: {
15864
- climate_preset_key: { type: 'string' },
15865
- ends_at: { type: 'string' },
15866
- max_override_period_minutes: { minimum: 0, type: 'integer' },
15867
- name: { type: 'string' },
15868
- starts_at: { type: 'string' },
15869
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16211
+ climate_preset_key: {
16212
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
16213
+ type: 'string',
16214
+ },
16215
+ ends_at: {
16216
+ description: 'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16217
+ type: 'string',
16218
+ },
16219
+ max_override_period_minutes: {
16220
+ description: "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).",
16221
+ minimum: 0,
16222
+ type: 'integer',
16223
+ },
16224
+ name: {
16225
+ description: 'User-friendly name to identify the climate schedule.',
16226
+ type: 'string',
16227
+ },
16228
+ starts_at: {
16229
+ description: 'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16230
+ type: 'string',
16231
+ },
16232
+ thermostat_schedule_id: {
16233
+ description: 'ID of the desired climate schedule.',
16234
+ format: 'uuid',
16235
+ type: 'string',
16236
+ },
15870
16237
  },
15871
16238
  required: ['thermostat_schedule_id'],
15872
16239
  type: 'object',
@@ -15900,20 +16267,42 @@ export default {
15900
16267
  tags: ['/thermostats'],
15901
16268
  'x-fern-ignore': true,
15902
16269
  'x-response-key': null,
16270
+ 'x-title': 'Update a Climate Schedule',
15903
16271
  },
15904
16272
  post: {
16273
+ description: 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
15905
16274
  operationId: 'thermostatsSchedulesUpdatePost',
15906
16275
  requestBody: {
15907
16276
  content: {
15908
16277
  'application/json': {
15909
16278
  schema: {
15910
16279
  properties: {
15911
- climate_preset_key: { type: 'string' },
15912
- ends_at: { type: 'string' },
15913
- max_override_period_minutes: { minimum: 0, type: 'integer' },
15914
- name: { type: 'string' },
15915
- starts_at: { type: 'string' },
15916
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16280
+ climate_preset_key: {
16281
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
16282
+ type: 'string',
16283
+ },
16284
+ ends_at: {
16285
+ description: 'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16286
+ type: 'string',
16287
+ },
16288
+ max_override_period_minutes: {
16289
+ description: "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).",
16290
+ minimum: 0,
16291
+ type: 'integer',
16292
+ },
16293
+ name: {
16294
+ description: 'User-friendly name to identify the climate schedule.',
16295
+ type: 'string',
16296
+ },
16297
+ starts_at: {
16298
+ description: 'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16299
+ type: 'string',
16300
+ },
16301
+ thermostat_schedule_id: {
16302
+ description: 'ID of the desired climate schedule.',
16303
+ format: 'uuid',
16304
+ type: 'string',
16305
+ },
15917
16306
  },
15918
16307
  required: ['thermostat_schedule_id'],
15919
16308
  type: 'object',
@@ -15948,18 +16337,27 @@ export default {
15948
16337
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
15949
16338
  'x-fern-sdk-method-name': 'update',
15950
16339
  'x-response-key': null,
16340
+ 'x-title': 'Update a Climate Schedule',
15951
16341
  },
15952
16342
  },
15953
16343
  '/thermostats/set_fallback_climate_preset': {
15954
16344
  post: {
16345
+ description: 'Sets a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15955
16346
  operationId: 'thermostatsSetFallbackClimatePresetPost',
15956
16347
  requestBody: {
15957
16348
  content: {
15958
16349
  'application/json': {
15959
16350
  schema: {
15960
16351
  properties: {
15961
- climate_preset_key: { type: 'string' },
15962
- device_id: { format: 'uuid', type: 'string' },
16352
+ climate_preset_key: {
16353
+ description: 'Climate preset key of the desired climate preset.',
16354
+ type: 'string',
16355
+ },
16356
+ device_id: {
16357
+ description: 'ID of the desired thermostat device.',
16358
+ format: 'uuid',
16359
+ type: 'string',
16360
+ },
15963
16361
  },
15964
16362
  required: ['device_id', 'climate_preset_key'],
15965
16363
  type: 'object',
@@ -15993,22 +16391,19 @@ export default {
15993
16391
  'x-fern-sdk-group-name': ['thermostats'],
15994
16392
  'x-fern-sdk-method-name': 'set_fallback_climate_preset',
15995
16393
  'x-response-key': null,
16394
+ 'x-title': 'Set the Fallback Climate Preset',
15996
16395
  },
15997
16396
  },
15998
16397
  '/thermostats/set_fan_mode': {
15999
16398
  post: {
16000
- description: 'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
16399
+ description: 'Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
16001
16400
  operationId: 'thermostatsSetFanModePost',
16002
16401
  requestBody: {
16003
16402
  content: {
16004
16403
  'application/json': {
16005
16404
  schema: {
16006
16405
  properties: {
16007
- device_id: {
16008
- description: 'ID of the thermostat device.',
16009
- format: 'uuid',
16010
- type: 'string',
16011
- },
16406
+ device_id: { format: 'uuid', type: 'string' },
16012
16407
  fan_mode: {
16013
16408
  deprecated: true,
16014
16409
  enum: ['auto', 'on', 'circulate'],
@@ -16016,11 +16411,15 @@ export default {
16016
16411
  'x-deprecated': 'Use `fan_mode_setting` instead.',
16017
16412
  },
16018
16413
  fan_mode_setting: {
16019
- description: '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).',
16414
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
16020
16415
  enum: ['auto', 'on', 'circulate'],
16021
16416
  type: 'string',
16022
16417
  },
16023
- sync: { default: false, type: 'boolean' },
16418
+ sync: {
16419
+ default: false,
16420
+ type: 'boolean',
16421
+ 'x-undocumented': 'Only used internally.',
16422
+ },
16024
16423
  },
16025
16424
  required: ['device_id'],
16026
16425
  type: 'object',
@@ -16061,38 +16460,47 @@ export default {
16061
16460
  'x-fern-sdk-method-name': 'set_fan_mode',
16062
16461
  'x-fern-sdk-return-value': 'action_attempt',
16063
16462
  'x-response-key': 'action_attempt',
16064
- 'x-title': 'Set Fan Mode Setting',
16463
+ 'x-title': 'Set the Fan Mode Setting',
16065
16464
  },
16066
16465
  },
16067
16466
  '/thermostats/set_temperature_threshold': {
16068
16467
  patch: {
16468
+ description: 'Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.',
16069
16469
  operationId: 'thermostatsSetTemperatureThresholdPatch',
16070
16470
  requestBody: {
16071
16471
  content: {
16072
16472
  'application/json': {
16073
16473
  schema: {
16074
16474
  properties: {
16075
- device_id: { format: 'uuid', type: 'string' },
16475
+ device_id: {
16476
+ description: 'ID of the desired thermostat device.',
16477
+ format: 'uuid',
16478
+ type: 'string',
16479
+ },
16076
16480
  lower_limit_celsius: {
16077
16481
  default: null,
16482
+ description: '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.',
16078
16483
  format: 'float',
16079
16484
  nullable: true,
16080
16485
  type: 'number',
16081
16486
  },
16082
16487
  lower_limit_fahrenheit: {
16083
16488
  default: null,
16489
+ description: '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.',
16084
16490
  format: 'float',
16085
16491
  nullable: true,
16086
16492
  type: 'number',
16087
16493
  },
16088
16494
  upper_limit_celsius: {
16089
16495
  default: null,
16496
+ description: '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.',
16090
16497
  format: 'float',
16091
16498
  nullable: true,
16092
16499
  type: 'number',
16093
16500
  },
16094
16501
  upper_limit_fahrenheit: {
16095
16502
  default: null,
16503
+ description: '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.',
16096
16504
  format: 'float',
16097
16505
  nullable: true,
16098
16506
  type: 'number',
@@ -16129,35 +16537,45 @@ export default {
16129
16537
  tags: ['/thermostats'],
16130
16538
  'x-fern-ignore': true,
16131
16539
  'x-response-key': null,
16540
+ 'x-title': 'Set a Temperature Threshold',
16132
16541
  },
16133
16542
  post: {
16543
+ description: 'Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.',
16134
16544
  operationId: 'thermostatsSetTemperatureThresholdPost',
16135
16545
  requestBody: {
16136
16546
  content: {
16137
16547
  'application/json': {
16138
16548
  schema: {
16139
16549
  properties: {
16140
- device_id: { format: 'uuid', type: 'string' },
16550
+ device_id: {
16551
+ description: 'ID of the desired thermostat device.',
16552
+ format: 'uuid',
16553
+ type: 'string',
16554
+ },
16141
16555
  lower_limit_celsius: {
16142
16556
  default: null,
16557
+ description: '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.',
16143
16558
  format: 'float',
16144
16559
  nullable: true,
16145
16560
  type: 'number',
16146
16561
  },
16147
16562
  lower_limit_fahrenheit: {
16148
16563
  default: null,
16564
+ description: '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.',
16149
16565
  format: 'float',
16150
16566
  nullable: true,
16151
16567
  type: 'number',
16152
16568
  },
16153
16569
  upper_limit_celsius: {
16154
16570
  default: null,
16571
+ description: '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.',
16155
16572
  format: 'float',
16156
16573
  nullable: true,
16157
16574
  type: 'number',
16158
16575
  },
16159
16576
  upper_limit_fahrenheit: {
16160
16577
  default: null,
16578
+ description: '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.',
16161
16579
  format: 'float',
16162
16580
  nullable: true,
16163
16581
  type: 'number',
@@ -16195,44 +16613,67 @@ export default {
16195
16613
  'x-fern-sdk-group-name': ['thermostats'],
16196
16614
  'x-fern-sdk-method-name': 'set_temperature_threshold',
16197
16615
  'x-response-key': null,
16616
+ 'x-title': 'Set a Temperature Threshold',
16198
16617
  },
16199
16618
  },
16200
16619
  '/thermostats/update_climate_preset': {
16201
16620
  patch: {
16621
+ description: 'Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
16202
16622
  operationId: 'thermostatsUpdateClimatePresetPatch',
16203
16623
  requestBody: {
16204
16624
  content: {
16205
16625
  'application/json': {
16206
16626
  schema: {
16207
16627
  properties: {
16208
- climate_preset_key: { type: 'string' },
16628
+ climate_preset_key: {
16629
+ description: 'Unique key to identify the climate preset.',
16630
+ type: 'string',
16631
+ },
16209
16632
  cooling_set_point_celsius: {
16633
+ description: '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).',
16210
16634
  format: 'float',
16211
16635
  type: 'number',
16212
16636
  },
16213
16637
  cooling_set_point_fahrenheit: {
16638
+ description: 'Temperature to which the thermostat should cool (in °F).',
16214
16639
  format: 'float',
16215
16640
  type: 'number',
16216
16641
  },
16217
- device_id: { format: 'uuid', type: 'string' },
16642
+ device_id: {
16643
+ description: 'ID of the desired thermostat device.',
16644
+ format: 'uuid',
16645
+ type: 'string',
16646
+ },
16218
16647
  fan_mode_setting: {
16648
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16219
16649
  enum: ['auto', 'on', 'circulate'],
16220
16650
  type: 'string',
16221
16651
  },
16222
16652
  heating_set_point_celsius: {
16653
+ description: 'Temperature to which the thermostat should heat (in °C).',
16223
16654
  format: 'float',
16224
16655
  type: 'number',
16225
16656
  },
16226
16657
  heating_set_point_fahrenheit: {
16658
+ description: 'Temperature to which the thermostat should heat (in °F).',
16227
16659
  format: 'float',
16228
16660
  type: 'number',
16229
16661
  },
16230
16662
  hvac_mode_setting: {
16663
+ description: '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`.',
16231
16664
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16232
16665
  type: 'string',
16233
16666
  },
16234
- manual_override_allowed: { type: 'boolean' },
16235
- name: { default: null, nullable: true, type: 'string' },
16667
+ manual_override_allowed: {
16668
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16669
+ type: 'boolean',
16670
+ },
16671
+ name: {
16672
+ default: null,
16673
+ description: 'User-friendly name to identify the climate preset.',
16674
+ nullable: true,
16675
+ type: 'string',
16676
+ },
16236
16677
  },
16237
16678
  required: [
16238
16679
  'device_id',
@@ -16269,42 +16710,65 @@ export default {
16269
16710
  tags: ['/thermostats'],
16270
16711
  'x-fern-ignore': true,
16271
16712
  'x-response-key': null,
16713
+ 'x-title': 'Update a Climate Preset',
16272
16714
  },
16273
16715
  post: {
16716
+ description: 'Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
16274
16717
  operationId: 'thermostatsUpdateClimatePresetPost',
16275
16718
  requestBody: {
16276
16719
  content: {
16277
16720
  'application/json': {
16278
16721
  schema: {
16279
16722
  properties: {
16280
- climate_preset_key: { type: 'string' },
16723
+ climate_preset_key: {
16724
+ description: 'Unique key to identify the climate preset.',
16725
+ type: 'string',
16726
+ },
16281
16727
  cooling_set_point_celsius: {
16728
+ description: '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).',
16282
16729
  format: 'float',
16283
16730
  type: 'number',
16284
16731
  },
16285
16732
  cooling_set_point_fahrenheit: {
16733
+ description: 'Temperature to which the thermostat should cool (in °F).',
16286
16734
  format: 'float',
16287
16735
  type: 'number',
16288
16736
  },
16289
- device_id: { format: 'uuid', type: 'string' },
16737
+ device_id: {
16738
+ description: 'ID of the desired thermostat device.',
16739
+ format: 'uuid',
16740
+ type: 'string',
16741
+ },
16290
16742
  fan_mode_setting: {
16743
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16291
16744
  enum: ['auto', 'on', 'circulate'],
16292
16745
  type: 'string',
16293
16746
  },
16294
16747
  heating_set_point_celsius: {
16748
+ description: 'Temperature to which the thermostat should heat (in °C).',
16295
16749
  format: 'float',
16296
16750
  type: 'number',
16297
16751
  },
16298
16752
  heating_set_point_fahrenheit: {
16753
+ description: 'Temperature to which the thermostat should heat (in °F).',
16299
16754
  format: 'float',
16300
16755
  type: 'number',
16301
16756
  },
16302
16757
  hvac_mode_setting: {
16758
+ description: '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`.',
16303
16759
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16304
16760
  type: 'string',
16305
16761
  },
16306
- manual_override_allowed: { type: 'boolean' },
16307
- name: { default: null, nullable: true, type: 'string' },
16762
+ manual_override_allowed: {
16763
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16764
+ type: 'boolean',
16765
+ },
16766
+ name: {
16767
+ default: null,
16768
+ description: 'User-friendly name to identify the climate preset.',
16769
+ nullable: true,
16770
+ type: 'string',
16771
+ },
16308
16772
  },
16309
16773
  required: [
16310
16774
  'device_id',
@@ -16342,6 +16806,7 @@ export default {
16342
16806
  'x-fern-sdk-group-name': ['thermostats'],
16343
16807
  'x-fern-sdk-method-name': 'update_climate_preset',
16344
16808
  'x-response-key': null,
16809
+ 'x-title': 'Update a Climate Preset',
16345
16810
  },
16346
16811
  },
16347
16812
  '/user_identities/add_acs_user': {