@seamapi/types 1.291.0 → 1.292.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4413,22 +4413,47 @@ export default {
4413
4413
  properties: {
4414
4414
  active_thermostat_schedule: {
4415
4415
  default: null,
4416
+ description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
4416
4417
  nullable: true,
4417
4418
  properties: {
4418
- climate_preset_key: { type: 'string' },
4419
- created_at: { format: 'date-time', type: 'string' },
4420
- device_id: { format: 'uuid', type: 'string' },
4421
- ends_at: { format: 'date-time', type: 'string' },
4419
+ climate_preset_key: {
4420
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
4421
+ type: 'string',
4422
+ },
4423
+ created_at: {
4424
+ description: 'Date and time at which the thermostat schedule was created.',
4425
+ format: 'date-time',
4426
+ type: 'string',
4427
+ },
4428
+ device_id: {
4429
+ description: 'ID of the desired thermostat device.',
4430
+ format: 'uuid',
4431
+ type: 'string',
4432
+ },
4433
+ ends_at: {
4434
+ description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
4435
+ format: 'date-time',
4436
+ type: 'string',
4437
+ },
4422
4438
  errors: {
4423
- 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.',
4439
+ description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
4424
4440
  },
4425
4441
  max_override_period_minutes: {
4442
+ 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-thermostat-schedules#specifying-manual-override-permissions).",
4426
4443
  minimum: 0,
4427
4444
  type: 'integer',
4428
4445
  },
4429
- name: { type: 'string' },
4430
- starts_at: { format: 'date-time', type: 'string' },
4446
+ name: {
4447
+ description: 'User-friendly name to identify the thermostat schedule.',
4448
+ type: 'string',
4449
+ },
4450
+ starts_at: {
4451
+ description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
4452
+ format: 'date-time',
4453
+ type: 'string',
4454
+ },
4431
4455
  thermostat_schedule_id: {
4456
+ description: 'ID of the thermostat schedule.',
4432
4457
  format: 'uuid',
4433
4458
  type: 'string',
4434
4459
  },
@@ -4447,37 +4472,59 @@ export default {
4447
4472
  available_climate_presets: {
4448
4473
  items: {
4449
4474
  properties: {
4450
- can_delete: { type: 'boolean' },
4451
- can_edit: { type: 'boolean' },
4452
- climate_preset_key: { type: 'string' },
4475
+ can_delete: {
4476
+ description: 'Indicates whether this climate preset key can be deleted.',
4477
+ type: 'boolean',
4478
+ },
4479
+ can_edit: {
4480
+ description: 'Indicates whether this climate preset key can be edited.',
4481
+ type: 'boolean',
4482
+ },
4483
+ climate_preset_key: {
4484
+ description: 'Unique key to identify the climate preset.',
4485
+ type: 'string',
4486
+ },
4453
4487
  cooling_set_point_celsius: {
4488
+ 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).',
4454
4489
  format: 'float',
4455
4490
  type: 'number',
4456
4491
  },
4457
4492
  cooling_set_point_fahrenheit: {
4493
+ description: 'Temperature to which the thermostat should cool (in °F).',
4458
4494
  format: 'float',
4459
4495
  type: 'number',
4460
4496
  },
4461
- display_name: { type: 'string' },
4497
+ display_name: {
4498
+ description: 'Display name for the climate preset.',
4499
+ type: 'string',
4500
+ },
4462
4501
  fan_mode_setting: {
4502
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4463
4503
  enum: ['auto', 'on', 'circulate'],
4464
4504
  type: 'string',
4465
4505
  },
4466
4506
  heating_set_point_celsius: {
4507
+ description: 'Temperature to which the thermostat should heat (in °C).',
4467
4508
  format: 'float',
4468
4509
  type: 'number',
4469
4510
  },
4470
4511
  heating_set_point_fahrenheit: {
4512
+ description: 'Temperature to which the thermostat should heat (in °F).',
4471
4513
  format: 'float',
4472
4514
  type: 'number',
4473
4515
  },
4474
4516
  hvac_mode_setting: {
4517
+ 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`.',
4475
4518
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4476
4519
  type: 'string',
4477
4520
  },
4478
- manual_override_allowed: { type: 'boolean' },
4521
+ manual_override_allowed: {
4522
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4523
+ type: 'boolean',
4524
+ },
4479
4525
  name: {
4480
4526
  default: null,
4527
+ description: 'User-friendly name to identify the climate preset.',
4481
4528
  nullable: true,
4482
4529
  type: 'string',
4483
4530
  },
@@ -4509,37 +4556,59 @@ export default {
4509
4556
  },
4510
4557
  current_climate_setting: {
4511
4558
  properties: {
4512
- can_delete: { type: 'boolean' },
4513
- can_edit: { type: 'boolean' },
4514
- climate_preset_key: { type: 'string' },
4559
+ can_delete: {
4560
+ description: 'Indicates whether this climate preset key can be deleted.',
4561
+ type: 'boolean',
4562
+ },
4563
+ can_edit: {
4564
+ description: 'Indicates whether this climate preset key can be edited.',
4565
+ type: 'boolean',
4566
+ },
4567
+ climate_preset_key: {
4568
+ description: 'Unique key to identify the climate preset.',
4569
+ type: 'string',
4570
+ },
4515
4571
  cooling_set_point_celsius: {
4572
+ 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).',
4516
4573
  format: 'float',
4517
4574
  type: 'number',
4518
4575
  },
4519
4576
  cooling_set_point_fahrenheit: {
4577
+ description: 'Temperature to which the thermostat should cool (in °F).',
4520
4578
  format: 'float',
4521
4579
  type: 'number',
4522
4580
  },
4523
- display_name: { type: 'string' },
4581
+ display_name: {
4582
+ description: 'Display name for the climate preset.',
4583
+ type: 'string',
4584
+ },
4524
4585
  fan_mode_setting: {
4586
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4525
4587
  enum: ['auto', 'on', 'circulate'],
4526
4588
  type: 'string',
4527
4589
  },
4528
4590
  heating_set_point_celsius: {
4591
+ description: 'Temperature to which the thermostat should heat (in °C).',
4529
4592
  format: 'float',
4530
4593
  type: 'number',
4531
4594
  },
4532
4595
  heating_set_point_fahrenheit: {
4596
+ description: 'Temperature to which the thermostat should heat (in °F).',
4533
4597
  format: 'float',
4534
4598
  type: 'number',
4535
4599
  },
4536
4600
  hvac_mode_setting: {
4601
+ 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`.',
4537
4602
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4538
4603
  type: 'string',
4539
4604
  },
4540
- manual_override_allowed: { type: 'boolean' },
4605
+ manual_override_allowed: {
4606
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4607
+ type: 'boolean',
4608
+ },
4541
4609
  name: {
4542
4610
  default: null,
4611
+ description: 'User-friendly name to identify the climate preset.',
4543
4612
  nullable: true,
4544
4613
  type: 'string',
4545
4614
  },
@@ -4549,37 +4618,59 @@ export default {
4549
4618
  default_climate_setting: {
4550
4619
  deprecated: true,
4551
4620
  properties: {
4552
- can_delete: { type: 'boolean' },
4553
- can_edit: { type: 'boolean' },
4554
- climate_preset_key: { type: 'string' },
4621
+ can_delete: {
4622
+ description: 'Indicates whether this climate preset key can be deleted.',
4623
+ type: 'boolean',
4624
+ },
4625
+ can_edit: {
4626
+ description: 'Indicates whether this climate preset key can be edited.',
4627
+ type: 'boolean',
4628
+ },
4629
+ climate_preset_key: {
4630
+ description: 'Unique key to identify the climate preset.',
4631
+ type: 'string',
4632
+ },
4555
4633
  cooling_set_point_celsius: {
4634
+ 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).',
4556
4635
  format: 'float',
4557
4636
  type: 'number',
4558
4637
  },
4559
4638
  cooling_set_point_fahrenheit: {
4639
+ description: 'Temperature to which the thermostat should cool (in °F).',
4560
4640
  format: 'float',
4561
4641
  type: 'number',
4562
4642
  },
4563
- display_name: { type: 'string' },
4643
+ display_name: {
4644
+ description: 'Display name for the climate preset.',
4645
+ type: 'string',
4646
+ },
4564
4647
  fan_mode_setting: {
4648
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4565
4649
  enum: ['auto', 'on', 'circulate'],
4566
4650
  type: 'string',
4567
4651
  },
4568
4652
  heating_set_point_celsius: {
4653
+ description: 'Temperature to which the thermostat should heat (in °C).',
4569
4654
  format: 'float',
4570
4655
  type: 'number',
4571
4656
  },
4572
4657
  heating_set_point_fahrenheit: {
4658
+ description: 'Temperature to which the thermostat should heat (in °F).',
4573
4659
  format: 'float',
4574
4660
  type: 'number',
4575
4661
  },
4576
4662
  hvac_mode_setting: {
4663
+ 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`.',
4577
4664
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4578
4665
  type: 'string',
4579
4666
  },
4580
- manual_override_allowed: { type: 'boolean' },
4667
+ manual_override_allowed: {
4668
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
4669
+ type: 'boolean',
4670
+ },
4581
4671
  name: {
4582
4672
  default: null,
4673
+ description: 'User-friendly name to identify the climate preset.',
4583
4674
  nullable: true,
4584
4675
  type: 'string',
4585
4676
  },
@@ -5072,18 +5163,49 @@ export default {
5072
5163
  type: 'object',
5073
5164
  },
5074
5165
  thermostat_schedule: {
5166
+ description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
5075
5167
  properties: {
5076
- climate_preset_key: { type: 'string' },
5077
- created_at: { format: 'date-time', type: 'string' },
5078
- device_id: { format: 'uuid', type: 'string' },
5079
- ends_at: { format: 'date-time', type: 'string' },
5168
+ climate_preset_key: {
5169
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
5170
+ type: 'string',
5171
+ },
5172
+ created_at: {
5173
+ description: 'Date and time at which the thermostat schedule was created.',
5174
+ format: 'date-time',
5175
+ type: 'string',
5176
+ },
5177
+ device_id: {
5178
+ description: 'ID of the desired thermostat device.',
5179
+ format: 'uuid',
5180
+ type: 'string',
5181
+ },
5182
+ ends_at: {
5183
+ description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
5184
+ format: 'date-time',
5185
+ type: 'string',
5186
+ },
5080
5187
  errors: {
5081
- 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.',
5188
+ description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
5189
+ },
5190
+ max_override_period_minutes: {
5191
+ 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-thermostat-schedules#specifying-manual-override-permissions).",
5192
+ minimum: 0,
5193
+ type: 'integer',
5194
+ },
5195
+ name: {
5196
+ description: 'User-friendly name to identify the thermostat schedule.',
5197
+ type: 'string',
5198
+ },
5199
+ starts_at: {
5200
+ description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
5201
+ format: 'date-time',
5202
+ type: 'string',
5203
+ },
5204
+ thermostat_schedule_id: {
5205
+ description: 'ID of the thermostat schedule.',
5206
+ format: 'uuid',
5207
+ type: 'string',
5082
5208
  },
5083
- max_override_period_minutes: { minimum: 0, type: 'integer' },
5084
- name: { type: 'string' },
5085
- starts_at: { format: 'date-time', type: 'string' },
5086
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
5087
5209
  },
5088
5210
  required: [
5089
5211
  'thermostat_schedule_id',
@@ -12222,34 +12344,47 @@ export default {
12222
12344
  },
12223
12345
  '/devices/list': {
12224
12346
  post: {
12347
+ description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
12225
12348
  operationId: 'devicesListPost',
12226
12349
  requestBody: {
12227
12350
  content: {
12228
12351
  'application/json': {
12229
12352
  schema: {
12230
12353
  properties: {
12231
- connect_webview_id: { format: 'uuid', type: 'string' },
12354
+ connect_webview_id: {
12355
+ description: 'ID of the Connect Webview by which to filter devices.',
12356
+ format: 'uuid',
12357
+ type: 'string',
12358
+ },
12232
12359
  connected_account_id: {
12233
- description: 'List all devices owned by this connected account',
12360
+ description: 'ID of the connected account by which to filter.',
12234
12361
  format: 'uuid',
12235
12362
  type: 'string',
12236
12363
  },
12237
12364
  connected_account_ids: {
12365
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
12238
12366
  items: { format: 'uuid', type: 'string' },
12239
12367
  type: 'array',
12240
12368
  },
12241
- created_before: { format: 'date-time', type: 'string' },
12369
+ created_before: {
12370
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
12371
+ format: 'date-time',
12372
+ type: 'string',
12373
+ },
12242
12374
  custom_metadata_has: {
12243
12375
  additionalProperties: {
12244
12376
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
12245
12377
  },
12378
+ 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.',
12246
12379
  type: 'object',
12247
12380
  },
12248
12381
  device_ids: {
12382
+ description: 'Array of device IDs by which to filter devices.',
12249
12383
  items: { format: 'uuid', type: 'string' },
12250
12384
  type: 'array',
12251
12385
  },
12252
12386
  device_type: {
12387
+ description: 'Device type by which to filter devices.',
12253
12388
  oneOf: [
12254
12389
  {
12255
12390
  enum: [
@@ -12306,6 +12441,7 @@ export default {
12306
12441
  ],
12307
12442
  },
12308
12443
  device_types: {
12444
+ description: 'Array of device types by which to filter devices.',
12309
12445
  items: {
12310
12446
  oneOf: [
12311
12447
  {
@@ -12385,6 +12521,7 @@ export default {
12385
12521
  type: 'string',
12386
12522
  },
12387
12523
  type: 'array',
12524
+ 'x-undocumented': 'Only used internally.',
12388
12525
  },
12389
12526
  include_if: {
12390
12527
  items: {
@@ -12404,9 +12541,16 @@ export default {
12404
12541
  type: 'string',
12405
12542
  },
12406
12543
  type: 'array',
12544
+ 'x-undocumented': 'Only used internally.',
12545
+ },
12546
+ limit: {
12547
+ default: 500,
12548
+ description: 'Numerical limit on the number of devices to return.',
12549
+ format: 'float',
12550
+ type: 'number',
12407
12551
  },
12408
- limit: { default: 500, format: 'float', type: 'number' },
12409
12552
  manufacturer: {
12553
+ description: 'Manufacturer by which to filter devices.',
12410
12554
  enum: [
12411
12555
  'akuvox',
12412
12556
  'august',
@@ -12446,7 +12590,10 @@ export default {
12446
12590
  ],
12447
12591
  type: 'string',
12448
12592
  },
12449
- user_identifier_key: { type: 'string' },
12593
+ user_identifier_key: {
12594
+ description: 'Your own internal user ID for the user by which to filter devices.',
12595
+ type: 'string',
12596
+ },
12450
12597
  },
12451
12598
  type: 'object',
12452
12599
  },
@@ -12487,6 +12634,7 @@ export default {
12487
12634
  'x-fern-sdk-method-name': 'list',
12488
12635
  'x-fern-sdk-return-value': 'devices',
12489
12636
  'x-response-key': 'devices',
12637
+ 'x-title': 'List Devices',
12490
12638
  },
12491
12639
  },
12492
12640
  '/devices/list_device_providers': {
@@ -12732,28 +12880,40 @@ export default {
12732
12880
  'application/json': {
12733
12881
  schema: {
12734
12882
  properties: {
12735
- connect_webview_id: { format: 'uuid', type: 'string' },
12883
+ connect_webview_id: {
12884
+ description: 'ID of the Connect Webview by which to filter devices.',
12885
+ format: 'uuid',
12886
+ type: 'string',
12887
+ },
12736
12888
  connected_account_id: {
12737
- description: 'List all devices owned by this connected account',
12889
+ description: 'ID of the connected account by which to filter.',
12738
12890
  format: 'uuid',
12739
12891
  type: 'string',
12740
12892
  },
12741
12893
  connected_account_ids: {
12894
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
12742
12895
  items: { format: 'uuid', type: 'string' },
12743
12896
  type: 'array',
12744
12897
  },
12745
- created_before: { format: 'date-time', type: 'string' },
12898
+ created_before: {
12899
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
12900
+ format: 'date-time',
12901
+ type: 'string',
12902
+ },
12746
12903
  custom_metadata_has: {
12747
12904
  additionalProperties: {
12748
12905
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
12749
12906
  },
12907
+ 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.',
12750
12908
  type: 'object',
12751
12909
  },
12752
12910
  device_ids: {
12911
+ description: 'Array of device IDs by which to filter devices.',
12753
12912
  items: { format: 'uuid', type: 'string' },
12754
12913
  type: 'array',
12755
12914
  },
12756
12915
  device_type: {
12916
+ description: 'Device type by which to filter devices.',
12757
12917
  oneOf: [
12758
12918
  {
12759
12919
  enum: [
@@ -12810,6 +12970,7 @@ export default {
12810
12970
  ],
12811
12971
  },
12812
12972
  device_types: {
12973
+ description: 'Array of device types by which to filter devices.',
12813
12974
  items: {
12814
12975
  oneOf: [
12815
12976
  {
@@ -12889,6 +13050,7 @@ export default {
12889
13050
  type: 'string',
12890
13051
  },
12891
13052
  type: 'array',
13053
+ 'x-undocumented': 'Only used internally.',
12892
13054
  },
12893
13055
  include_if: {
12894
13056
  items: {
@@ -12908,9 +13070,16 @@ export default {
12908
13070
  type: 'string',
12909
13071
  },
12910
13072
  type: 'array',
13073
+ 'x-undocumented': 'Only used internally.',
13074
+ },
13075
+ limit: {
13076
+ default: 500,
13077
+ description: 'Numerical limit on the number of devices to return.',
13078
+ format: 'float',
13079
+ type: 'number',
12911
13080
  },
12912
- limit: { default: 500, format: 'float', type: 'number' },
12913
13081
  manufacturer: {
13082
+ description: 'Manufacturer by which to filter devices.',
12914
13083
  enum: [
12915
13084
  'akuvox',
12916
13085
  'august',
@@ -12950,7 +13119,10 @@ export default {
12950
13119
  ],
12951
13120
  type: 'string',
12952
13121
  },
12953
- user_identifier_key: { type: 'string' },
13122
+ user_identifier_key: {
13123
+ description: 'Your own internal user ID for the user by which to filter devices.',
13124
+ type: 'string',
13125
+ },
12954
13126
  },
12955
13127
  type: 'object',
12956
13128
  },
@@ -13540,28 +13712,40 @@ export default {
13540
13712
  'application/json': {
13541
13713
  schema: {
13542
13714
  properties: {
13543
- connect_webview_id: { format: 'uuid', type: 'string' },
13715
+ connect_webview_id: {
13716
+ description: 'ID of the Connect Webview by which to filter devices.',
13717
+ format: 'uuid',
13718
+ type: 'string',
13719
+ },
13544
13720
  connected_account_id: {
13545
- description: 'List all devices owned by this connected account',
13721
+ description: 'ID of the connected account by which to filter.',
13546
13722
  format: 'uuid',
13547
13723
  type: 'string',
13548
13724
  },
13549
13725
  connected_account_ids: {
13726
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
13550
13727
  items: { format: 'uuid', type: 'string' },
13551
13728
  type: 'array',
13552
13729
  },
13553
- created_before: { format: 'date-time', type: 'string' },
13730
+ created_before: {
13731
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
13732
+ format: 'date-time',
13733
+ type: 'string',
13734
+ },
13554
13735
  custom_metadata_has: {
13555
13736
  additionalProperties: {
13556
13737
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
13557
13738
  },
13739
+ 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.',
13558
13740
  type: 'object',
13559
13741
  },
13560
13742
  device_ids: {
13743
+ description: 'Array of device IDs by which to filter devices.',
13561
13744
  items: { format: 'uuid', type: 'string' },
13562
13745
  type: 'array',
13563
13746
  },
13564
13747
  device_type: {
13748
+ description: 'Device type by which to filter devices.',
13565
13749
  oneOf: [
13566
13750
  {
13567
13751
  enum: [
@@ -13618,6 +13802,7 @@ export default {
13618
13802
  ],
13619
13803
  },
13620
13804
  device_types: {
13805
+ description: 'Array of device types by which to filter devices.',
13621
13806
  items: {
13622
13807
  oneOf: [
13623
13808
  {
@@ -13697,6 +13882,7 @@ export default {
13697
13882
  type: 'string',
13698
13883
  },
13699
13884
  type: 'array',
13885
+ 'x-undocumented': 'Only used internally.',
13700
13886
  },
13701
13887
  include_if: {
13702
13888
  items: {
@@ -13716,9 +13902,16 @@ export default {
13716
13902
  type: 'string',
13717
13903
  },
13718
13904
  type: 'array',
13905
+ 'x-undocumented': 'Only used internally.',
13906
+ },
13907
+ limit: {
13908
+ default: 500,
13909
+ description: 'Numerical limit on the number of devices to return.',
13910
+ format: 'float',
13911
+ type: 'number',
13719
13912
  },
13720
- limit: { default: 500, format: 'float', type: 'number' },
13721
13913
  manufacturer: {
13914
+ description: 'Manufacturer by which to filter devices.',
13722
13915
  enum: [
13723
13916
  'akuvox',
13724
13917
  'august',
@@ -13758,7 +13951,10 @@ export default {
13758
13951
  ],
13759
13952
  type: 'string',
13760
13953
  },
13761
- user_identifier_key: { type: 'string' },
13954
+ user_identifier_key: {
13955
+ description: 'Your own internal user ID for the user by which to filter devices.',
13956
+ type: 'string',
13957
+ },
13762
13958
  },
13763
13959
  type: 'object',
13764
13960
  },
@@ -14006,28 +14202,40 @@ export default {
14006
14202
  'application/json': {
14007
14203
  schema: {
14008
14204
  properties: {
14009
- connect_webview_id: { format: 'uuid', type: 'string' },
14205
+ connect_webview_id: {
14206
+ description: 'ID of the Connect Webview by which to filter devices.',
14207
+ format: 'uuid',
14208
+ type: 'string',
14209
+ },
14010
14210
  connected_account_id: {
14011
- description: 'List all devices owned by this connected account',
14211
+ description: 'ID of the connected account by which to filter.',
14012
14212
  format: 'uuid',
14013
14213
  type: 'string',
14014
14214
  },
14015
14215
  connected_account_ids: {
14216
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
14016
14217
  items: { format: 'uuid', type: 'string' },
14017
14218
  type: 'array',
14018
14219
  },
14019
- created_before: { format: 'date-time', type: 'string' },
14220
+ created_before: {
14221
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
14222
+ format: 'date-time',
14223
+ type: 'string',
14224
+ },
14020
14225
  custom_metadata_has: {
14021
14226
  additionalProperties: {
14022
14227
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
14023
14228
  },
14229
+ 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.',
14024
14230
  type: 'object',
14025
14231
  },
14026
14232
  device_ids: {
14233
+ description: 'Array of device IDs by which to filter devices.',
14027
14234
  items: { format: 'uuid', type: 'string' },
14028
14235
  type: 'array',
14029
14236
  },
14030
14237
  device_type: {
14238
+ description: 'Device type by which to filter devices.',
14031
14239
  oneOf: [
14032
14240
  {
14033
14241
  enum: [
@@ -14084,6 +14292,7 @@ export default {
14084
14292
  ],
14085
14293
  },
14086
14294
  device_types: {
14295
+ description: 'Array of device types by which to filter devices.',
14087
14296
  items: {
14088
14297
  oneOf: [
14089
14298
  {
@@ -14163,6 +14372,7 @@ export default {
14163
14372
  type: 'string',
14164
14373
  },
14165
14374
  type: 'array',
14375
+ 'x-undocumented': 'Only used internally.',
14166
14376
  },
14167
14377
  include_if: {
14168
14378
  items: {
@@ -14182,9 +14392,16 @@ export default {
14182
14392
  type: 'string',
14183
14393
  },
14184
14394
  type: 'array',
14395
+ 'x-undocumented': 'Only used internally.',
14396
+ },
14397
+ limit: {
14398
+ default: 500,
14399
+ description: 'Numerical limit on the number of devices to return.',
14400
+ format: 'float',
14401
+ type: 'number',
14185
14402
  },
14186
- limit: { default: 500, format: 'float', type: 'number' },
14187
14403
  manufacturer: {
14404
+ description: 'Manufacturer by which to filter devices.',
14188
14405
  enum: [
14189
14406
  'akuvox',
14190
14407
  'august',
@@ -14224,7 +14441,10 @@ export default {
14224
14441
  ],
14225
14442
  type: 'string',
14226
14443
  },
14227
- user_identifier_key: { type: 'string' },
14444
+ user_identifier_key: {
14445
+ description: 'Your own internal user ID for the user by which to filter devices.',
14446
+ type: 'string',
14447
+ },
14228
14448
  },
14229
14449
  type: 'object',
14230
14450
  },
@@ -14869,14 +15089,22 @@ export default {
14869
15089
  },
14870
15090
  '/thermostats/activate_climate_preset': {
14871
15091
  post: {
15092
+ 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).',
14872
15093
  operationId: 'thermostatsActivateClimatePresetPost',
14873
15094
  requestBody: {
14874
15095
  content: {
14875
15096
  'application/json': {
14876
15097
  schema: {
14877
15098
  properties: {
14878
- climate_preset_key: { type: 'string' },
14879
- device_id: { format: 'uuid', type: 'string' },
15099
+ climate_preset_key: {
15100
+ description: 'Climate preset key of the desired climate preset.',
15101
+ type: 'string',
15102
+ },
15103
+ device_id: {
15104
+ description: 'ID of the desired thermostat device.',
15105
+ format: 'uuid',
15106
+ type: 'string',
15107
+ },
14880
15108
  },
14881
15109
  required: ['device_id', 'climate_preset_key'],
14882
15110
  type: 'object',
@@ -14916,11 +15144,12 @@ export default {
14916
15144
  'x-fern-sdk-method-name': 'activate_climate_preset',
14917
15145
  'x-fern-sdk-return-value': 'action_attempt',
14918
15146
  'x-response-key': 'action_attempt',
15147
+ 'x-title': 'Activate a Climate Preset',
14919
15148
  },
14920
15149
  },
14921
15150
  '/thermostats/cool': {
14922
15151
  post: {
14923
- 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).',
15152
+ 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).',
14924
15153
  operationId: 'thermostatsCoolPost',
14925
15154
  requestBody: {
14926
15155
  content: {
@@ -14928,21 +15157,25 @@ export default {
14928
15157
  schema: {
14929
15158
  properties: {
14930
15159
  cooling_set_point_celsius: {
14931
- 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.',
15160
+ 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.',
14932
15161
  format: 'float',
14933
15162
  type: 'number',
14934
15163
  },
14935
15164
  cooling_set_point_fahrenheit: {
14936
- 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.',
15165
+ 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.',
14937
15166
  format: 'float',
14938
15167
  type: 'number',
14939
15168
  },
14940
15169
  device_id: {
14941
- description: 'ID of the thermostat device.',
15170
+ description: 'ID of the desired thermostat device.',
14942
15171
  format: 'uuid',
14943
15172
  type: 'string',
14944
15173
  },
14945
- sync: { default: false, type: 'boolean' },
15174
+ sync: {
15175
+ default: false,
15176
+ type: 'boolean',
15177
+ 'x-undocumented': 'Only used internally.',
15178
+ },
14946
15179
  },
14947
15180
  required: ['device_id'],
14948
15181
  type: 'object',
@@ -14988,40 +15221,62 @@ export default {
14988
15221
  },
14989
15222
  '/thermostats/create_climate_preset': {
14990
15223
  post: {
15224
+ 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).',
14991
15225
  operationId: 'thermostatsCreateClimatePresetPost',
14992
15226
  requestBody: {
14993
15227
  content: {
14994
15228
  'application/json': {
14995
15229
  schema: {
14996
15230
  properties: {
14997
- climate_preset_key: { type: 'string' },
15231
+ climate_preset_key: {
15232
+ description: 'Unique key to identify the climate preset.',
15233
+ type: 'string',
15234
+ },
14998
15235
  cooling_set_point_celsius: {
15236
+ 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).',
14999
15237
  format: 'float',
15000
15238
  type: 'number',
15001
15239
  },
15002
15240
  cooling_set_point_fahrenheit: {
15241
+ description: 'Temperature to which the thermostat should cool (in °F).',
15003
15242
  format: 'float',
15004
15243
  type: 'number',
15005
15244
  },
15006
- device_id: { format: 'uuid', type: 'string' },
15245
+ device_id: {
15246
+ description: 'ID of the desired thermostat device.',
15247
+ format: 'uuid',
15248
+ type: 'string',
15249
+ },
15007
15250
  fan_mode_setting: {
15251
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
15008
15252
  enum: ['auto', 'on', 'circulate'],
15009
15253
  type: 'string',
15010
15254
  },
15011
15255
  heating_set_point_celsius: {
15256
+ description: 'Temperature to which the thermostat should heat (in °C).',
15012
15257
  format: 'float',
15013
15258
  type: 'number',
15014
15259
  },
15015
15260
  heating_set_point_fahrenheit: {
15261
+ description: 'Temperature to which the thermostat should heat (in °F).',
15016
15262
  format: 'float',
15017
15263
  type: 'number',
15018
15264
  },
15019
15265
  hvac_mode_setting: {
15266
+ 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`.',
15020
15267
  enum: ['off', 'heat', 'cool', 'heat_cool'],
15021
15268
  type: 'string',
15022
15269
  },
15023
- manual_override_allowed: { type: 'boolean' },
15024
- name: { default: null, nullable: true, type: 'string' },
15270
+ manual_override_allowed: {
15271
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
15272
+ type: 'boolean',
15273
+ },
15274
+ name: {
15275
+ default: null,
15276
+ description: 'User-friendly name to identify the climate preset.',
15277
+ nullable: true,
15278
+ type: 'string',
15279
+ },
15025
15280
  },
15026
15281
  required: [
15027
15282
  'device_id',
@@ -15059,18 +15314,27 @@ export default {
15059
15314
  'x-fern-sdk-group-name': ['thermostats'],
15060
15315
  'x-fern-sdk-method-name': 'create_climate_preset',
15061
15316
  'x-response-key': null,
15317
+ 'x-title': 'Create a Climate Preset',
15062
15318
  },
15063
15319
  },
15064
15320
  '/thermostats/delete_climate_preset': {
15065
15321
  post: {
15322
+ 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).',
15066
15323
  operationId: 'thermostatsDeleteClimatePresetPost',
15067
15324
  requestBody: {
15068
15325
  content: {
15069
15326
  'application/json': {
15070
15327
  schema: {
15071
15328
  properties: {
15072
- climate_preset_key: { type: 'string' },
15073
- device_id: { format: 'uuid', type: 'string' },
15329
+ climate_preset_key: {
15330
+ description: 'Climate preset key of the desired climate preset.',
15331
+ type: 'string',
15332
+ },
15333
+ device_id: {
15334
+ description: 'ID of the desired thermostat device.',
15335
+ format: 'uuid',
15336
+ type: 'string',
15337
+ },
15074
15338
  },
15075
15339
  required: ['device_id', 'climate_preset_key'],
15076
15340
  type: 'object',
@@ -15104,11 +15368,12 @@ export default {
15104
15368
  'x-fern-sdk-group-name': ['thermostats'],
15105
15369
  'x-fern-sdk-method-name': 'delete_climate_preset',
15106
15370
  'x-response-key': null,
15371
+ 'x-title': 'Delete a Climate Preset',
15107
15372
  },
15108
15373
  },
15109
15374
  '/thermostats/get': {
15110
15375
  post: {
15111
- description: 'Returns a specific thermostat.',
15376
+ description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15112
15377
  operationId: 'thermostatsGetPost',
15113
15378
  requestBody: {
15114
15379
  content: {
@@ -15116,12 +15381,12 @@ export default {
15116
15381
  schema: {
15117
15382
  properties: {
15118
15383
  device_id: {
15119
- description: 'ID of the thermostat device.',
15384
+ description: 'ID of the desired thermostat device.',
15120
15385
  format: 'uuid',
15121
15386
  type: 'string',
15122
15387
  },
15123
15388
  name: {
15124
- description: 'Name of the thermostat.',
15389
+ description: 'User-friendly name of the desired thermostat device.',
15125
15390
  type: 'string',
15126
15391
  },
15127
15392
  },
@@ -15163,11 +15428,12 @@ export default {
15163
15428
  'x-fern-sdk-return-value': 'thermostat',
15164
15429
  'x-response-key': 'thermostat',
15165
15430
  'x-title': 'Get a Thermostat',
15431
+ 'x-undocumented': 'Will be removed.',
15166
15432
  },
15167
15433
  },
15168
15434
  '/thermostats/heat': {
15169
15435
  post: {
15170
- 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).',
15436
+ 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).',
15171
15437
  operationId: 'thermostatsHeatPost',
15172
15438
  requestBody: {
15173
15439
  content: {
@@ -15175,21 +15441,25 @@ export default {
15175
15441
  schema: {
15176
15442
  properties: {
15177
15443
  device_id: {
15178
- description: 'ID of the thermostat device.',
15444
+ description: 'ID of the desired thermostat device.',
15179
15445
  format: 'uuid',
15180
15446
  type: 'string',
15181
15447
  },
15182
15448
  heating_set_point_celsius: {
15183
- 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.',
15449
+ 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.',
15184
15450
  format: 'float',
15185
15451
  type: 'number',
15186
15452
  },
15187
15453
  heating_set_point_fahrenheit: {
15188
- 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.',
15454
+ 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.',
15189
15455
  format: 'float',
15190
15456
  type: 'number',
15191
15457
  },
15192
- sync: { default: false, type: 'boolean' },
15458
+ sync: {
15459
+ default: false,
15460
+ type: 'boolean',
15461
+ 'x-undocumented': 'Only used internally.',
15462
+ },
15193
15463
  },
15194
15464
  required: ['device_id'],
15195
15465
  type: 'object',
@@ -15235,7 +15505,7 @@ export default {
15235
15505
  },
15236
15506
  '/thermostats/heat_cool': {
15237
15507
  post: {
15238
- 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).',
15508
+ 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).',
15239
15509
  operationId: 'thermostatsHeatCoolPost',
15240
15510
  requestBody: {
15241
15511
  content: {
@@ -15243,31 +15513,35 @@ export default {
15243
15513
  schema: {
15244
15514
  properties: {
15245
15515
  cooling_set_point_celsius: {
15246
- 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.',
15516
+ 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.',
15247
15517
  format: 'float',
15248
15518
  type: 'number',
15249
15519
  },
15250
15520
  cooling_set_point_fahrenheit: {
15251
- description: 'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
15521
+ 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.',
15252
15522
  format: 'float',
15253
15523
  type: 'number',
15254
15524
  },
15255
15525
  device_id: {
15256
- description: 'ID of the thermostat device.',
15526
+ description: 'ID of the desired thermostat device.',
15257
15527
  format: 'uuid',
15258
15528
  type: 'string',
15259
15529
  },
15260
15530
  heating_set_point_celsius: {
15261
- 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.',
15531
+ 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.',
15262
15532
  format: 'float',
15263
15533
  type: 'number',
15264
15534
  },
15265
15535
  heating_set_point_fahrenheit: {
15266
- description: 'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
15536
+ 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.',
15267
15537
  format: 'float',
15268
15538
  type: 'number',
15269
15539
  },
15270
- sync: { default: false, type: 'boolean' },
15540
+ sync: {
15541
+ default: false,
15542
+ type: 'boolean',
15543
+ 'x-undocumented': 'Only used internally.',
15544
+ },
15271
15545
  },
15272
15546
  required: ['device_id'],
15273
15547
  type: 'object',
@@ -15313,35 +15587,47 @@ export default {
15313
15587
  },
15314
15588
  '/thermostats/list': {
15315
15589
  post: {
15316
- description: 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
15590
+ description: 'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
15317
15591
  operationId: 'thermostatsListPost',
15318
15592
  requestBody: {
15319
15593
  content: {
15320
15594
  'application/json': {
15321
15595
  schema: {
15322
15596
  properties: {
15323
- connect_webview_id: { format: 'uuid', type: 'string' },
15597
+ connect_webview_id: {
15598
+ description: 'ID of the Connect Webview by which to filter devices.',
15599
+ format: 'uuid',
15600
+ type: 'string',
15601
+ },
15324
15602
  connected_account_id: {
15325
- description: 'List all devices owned by this connected account',
15603
+ description: 'ID of the connected account by which to filter.',
15326
15604
  format: 'uuid',
15327
15605
  type: 'string',
15328
15606
  },
15329
15607
  connected_account_ids: {
15608
+ description: 'Array of IDs of the connected accounts by which to filter devices.',
15330
15609
  items: { format: 'uuid', type: 'string' },
15331
15610
  type: 'array',
15332
15611
  },
15333
- created_before: { format: 'date-time', type: 'string' },
15612
+ created_before: {
15613
+ description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
15614
+ format: 'date-time',
15615
+ type: 'string',
15616
+ },
15334
15617
  custom_metadata_has: {
15335
15618
  additionalProperties: {
15336
15619
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
15337
15620
  },
15621
+ 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.',
15338
15622
  type: 'object',
15339
15623
  },
15340
15624
  device_ids: {
15625
+ description: 'Array of device IDs by which to filter devices.',
15341
15626
  items: { format: 'uuid', type: 'string' },
15342
15627
  type: 'array',
15343
15628
  },
15344
15629
  device_type: {
15630
+ description: 'Device type by which to filter devices.',
15345
15631
  oneOf: [
15346
15632
  {
15347
15633
  enum: [
@@ -15398,6 +15684,7 @@ export default {
15398
15684
  ],
15399
15685
  },
15400
15686
  device_types: {
15687
+ description: 'Array of device types by which to filter devices.',
15401
15688
  items: {
15402
15689
  oneOf: [
15403
15690
  {
@@ -15477,6 +15764,7 @@ export default {
15477
15764
  type: 'string',
15478
15765
  },
15479
15766
  type: 'array',
15767
+ 'x-undocumented': 'Only used internally.',
15480
15768
  },
15481
15769
  include_if: {
15482
15770
  items: {
@@ -15496,9 +15784,16 @@ export default {
15496
15784
  type: 'string',
15497
15785
  },
15498
15786
  type: 'array',
15787
+ 'x-undocumented': 'Only used internally.',
15788
+ },
15789
+ limit: {
15790
+ default: 500,
15791
+ description: 'Numerical limit on the number of devices to return.',
15792
+ format: 'float',
15793
+ type: 'number',
15499
15794
  },
15500
- limit: { default: 500, format: 'float', type: 'number' },
15501
15795
  manufacturer: {
15796
+ description: 'Manufacturer by which to filter devices.',
15502
15797
  enum: [
15503
15798
  'akuvox',
15504
15799
  'august',
@@ -15538,7 +15833,10 @@ export default {
15538
15833
  ],
15539
15834
  type: 'string',
15540
15835
  },
15541
- user_identifier_key: { type: 'string' },
15836
+ user_identifier_key: {
15837
+ description: 'Your own internal user ID for the user by which to filter devices.',
15838
+ type: 'string',
15839
+ },
15542
15840
  },
15543
15841
  type: 'object',
15544
15842
  },
@@ -15588,7 +15886,7 @@ export default {
15588
15886
  },
15589
15887
  '/thermostats/off': {
15590
15888
  post: {
15591
- 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).',
15889
+ 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).',
15592
15890
  operationId: 'thermostatsOffPost',
15593
15891
  requestBody: {
15594
15892
  content: {
@@ -15596,11 +15894,15 @@ export default {
15596
15894
  schema: {
15597
15895
  properties: {
15598
15896
  device_id: {
15599
- description: 'ID of the thermostat device.',
15897
+ description: 'ID of the desired thermostat device.',
15600
15898
  format: 'uuid',
15601
15899
  type: 'string',
15602
15900
  },
15603
- sync: { default: false, type: 'boolean' },
15901
+ sync: {
15902
+ default: false,
15903
+ type: 'boolean',
15904
+ 'x-undocumented': 'Only used internally.',
15905
+ },
15604
15906
  },
15605
15907
  required: ['device_id'],
15606
15908
  type: 'object',
@@ -15646,22 +15948,39 @@ export default {
15646
15948
  },
15647
15949
  '/thermostats/schedules/create': {
15648
15950
  post: {
15951
+ description: 'Creates a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15649
15952
  operationId: 'thermostatsSchedulesCreatePost',
15650
15953
  requestBody: {
15651
15954
  content: {
15652
15955
  'application/json': {
15653
15956
  schema: {
15654
15957
  properties: {
15655
- climate_preset_key: { type: 'string' },
15656
- device_id: { type: 'string' },
15657
- ends_at: { type: 'string' },
15958
+ climate_preset_key: {
15959
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
15960
+ type: 'string',
15961
+ },
15962
+ device_id: {
15963
+ description: 'ID of the desired thermostat device.',
15964
+ type: 'string',
15965
+ },
15966
+ ends_at: {
15967
+ description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
15968
+ type: 'string',
15969
+ },
15658
15970
  max_override_period_minutes: {
15659
15971
  default: 0,
15972
+ 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-thermostat-schedules#specifying-manual-override-permissions).",
15660
15973
  minimum: 0,
15661
15974
  type: 'integer',
15662
15975
  },
15663
- name: { type: 'string' },
15664
- starts_at: { type: 'string' },
15976
+ name: {
15977
+ description: 'User-friendly name to identify the thermostat schedule.',
15978
+ type: 'string',
15979
+ },
15980
+ starts_at: {
15981
+ description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
15982
+ type: 'string',
15983
+ },
15665
15984
  },
15666
15985
  required: [
15667
15986
  'device_id',
@@ -15707,17 +16026,23 @@ export default {
15707
16026
  'x-fern-sdk-method-name': 'create',
15708
16027
  'x-fern-sdk-return-value': 'thermostat_schedule',
15709
16028
  'x-response-key': 'thermostat_schedule',
16029
+ 'x-title': 'Create a Thermostat Schedule',
15710
16030
  },
15711
16031
  },
15712
16032
  '/thermostats/schedules/delete': {
15713
16033
  post: {
16034
+ description: 'Deletes a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15714
16035
  operationId: 'thermostatsSchedulesDeletePost',
15715
16036
  requestBody: {
15716
16037
  content: {
15717
16038
  'application/json': {
15718
16039
  schema: {
15719
16040
  properties: {
15720
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16041
+ thermostat_schedule_id: {
16042
+ description: 'ID of the desired thermostat schedule.',
16043
+ format: 'uuid',
16044
+ type: 'string',
16045
+ },
15721
16046
  },
15722
16047
  required: ['thermostat_schedule_id'],
15723
16048
  type: 'object',
@@ -15752,17 +16077,23 @@ export default {
15752
16077
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
15753
16078
  'x-fern-sdk-method-name': 'delete',
15754
16079
  'x-response-key': null,
16080
+ 'x-title': 'Delete a Thermostat Schedule',
15755
16081
  },
15756
16082
  },
15757
16083
  '/thermostats/schedules/get': {
15758
16084
  post: {
16085
+ description: 'Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
15759
16086
  operationId: 'thermostatsSchedulesGetPost',
15760
16087
  requestBody: {
15761
16088
  content: {
15762
16089
  'application/json': {
15763
16090
  schema: {
15764
16091
  properties: {
15765
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16092
+ thermostat_schedule_id: {
16093
+ description: 'ID of the desired thermostat schedule.',
16094
+ format: 'uuid',
16095
+ type: 'string',
16096
+ },
15766
16097
  },
15767
16098
  required: ['thermostat_schedule_id'],
15768
16099
  type: 'object',
@@ -15803,18 +16134,27 @@ export default {
15803
16134
  'x-fern-sdk-method-name': 'get',
15804
16135
  'x-fern-sdk-return-value': 'thermostat_schedule',
15805
16136
  'x-response-key': 'thermostat_schedule',
16137
+ 'x-title': 'Get a Thermostat Schedule',
15806
16138
  },
15807
16139
  },
15808
16140
  '/thermostats/schedules/list': {
15809
16141
  post: {
16142
+ description: 'Returns a list of all [thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15810
16143
  operationId: 'thermostatsSchedulesListPost',
15811
16144
  requestBody: {
15812
16145
  content: {
15813
16146
  'application/json': {
15814
16147
  schema: {
15815
16148
  properties: {
15816
- device_id: { format: 'uuid', type: 'string' },
15817
- user_identifier_key: { type: 'string' },
16149
+ device_id: {
16150
+ description: 'ID of the desired thermostat device.',
16151
+ format: 'uuid',
16152
+ type: 'string',
16153
+ },
16154
+ user_identifier_key: {
16155
+ description: 'User identifier key by which to filter the list of returned thermostat schedules.',
16156
+ type: 'string',
16157
+ },
15818
16158
  },
15819
16159
  required: ['device_id'],
15820
16160
  type: 'object',
@@ -15858,22 +16198,44 @@ export default {
15858
16198
  'x-fern-sdk-method-name': 'list',
15859
16199
  'x-fern-sdk-return-value': 'thermostat_schedules',
15860
16200
  'x-response-key': 'thermostat_schedules',
16201
+ 'x-title': 'List Thermostat Schedules',
15861
16202
  },
15862
16203
  },
15863
16204
  '/thermostats/schedules/update': {
15864
16205
  patch: {
16206
+ description: 'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
15865
16207
  operationId: 'thermostatsSchedulesUpdatePatch',
15866
16208
  requestBody: {
15867
16209
  content: {
15868
16210
  'application/json': {
15869
16211
  schema: {
15870
16212
  properties: {
15871
- climate_preset_key: { type: 'string' },
15872
- ends_at: { type: 'string' },
15873
- max_override_period_minutes: { minimum: 0, type: 'integer' },
15874
- name: { type: 'string' },
15875
- starts_at: { type: 'string' },
15876
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16213
+ climate_preset_key: {
16214
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
16215
+ type: 'string',
16216
+ },
16217
+ ends_at: {
16218
+ description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16219
+ type: 'string',
16220
+ },
16221
+ max_override_period_minutes: {
16222
+ 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-thermostat-schedules#specifying-manual-override-permissions).",
16223
+ minimum: 0,
16224
+ type: 'integer',
16225
+ },
16226
+ name: {
16227
+ description: 'User-friendly name to identify the thermostat schedule.',
16228
+ type: 'string',
16229
+ },
16230
+ starts_at: {
16231
+ description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16232
+ type: 'string',
16233
+ },
16234
+ thermostat_schedule_id: {
16235
+ description: 'ID of the desired thermostat schedule.',
16236
+ format: 'uuid',
16237
+ type: 'string',
16238
+ },
15877
16239
  },
15878
16240
  required: ['thermostat_schedule_id'],
15879
16241
  type: 'object',
@@ -15907,20 +16269,42 @@ export default {
15907
16269
  tags: ['/thermostats'],
15908
16270
  'x-fern-ignore': true,
15909
16271
  'x-response-key': null,
16272
+ 'x-title': 'Update a Thermostat Schedule',
15910
16273
  },
15911
16274
  post: {
16275
+ description: 'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
15912
16276
  operationId: 'thermostatsSchedulesUpdatePost',
15913
16277
  requestBody: {
15914
16278
  content: {
15915
16279
  'application/json': {
15916
16280
  schema: {
15917
16281
  properties: {
15918
- climate_preset_key: { type: 'string' },
15919
- ends_at: { type: 'string' },
15920
- max_override_period_minutes: { minimum: 0, type: 'integer' },
15921
- name: { type: 'string' },
15922
- starts_at: { type: 'string' },
15923
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16282
+ climate_preset_key: {
16283
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
16284
+ type: 'string',
16285
+ },
16286
+ ends_at: {
16287
+ description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16288
+ type: 'string',
16289
+ },
16290
+ max_override_period_minutes: {
16291
+ 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-thermostat-schedules#specifying-manual-override-permissions).",
16292
+ minimum: 0,
16293
+ type: 'integer',
16294
+ },
16295
+ name: {
16296
+ description: 'User-friendly name to identify the thermostat schedule.',
16297
+ type: 'string',
16298
+ },
16299
+ starts_at: {
16300
+ description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16301
+ type: 'string',
16302
+ },
16303
+ thermostat_schedule_id: {
16304
+ description: 'ID of the desired thermostat schedule.',
16305
+ format: 'uuid',
16306
+ type: 'string',
16307
+ },
15924
16308
  },
15925
16309
  required: ['thermostat_schedule_id'],
15926
16310
  type: 'object',
@@ -15955,18 +16339,27 @@ export default {
15955
16339
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
15956
16340
  'x-fern-sdk-method-name': 'update',
15957
16341
  'x-response-key': null,
16342
+ 'x-title': 'Update a Thermostat Schedule',
15958
16343
  },
15959
16344
  },
15960
16345
  '/thermostats/set_fallback_climate_preset': {
15961
16346
  post: {
16347
+ 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).',
15962
16348
  operationId: 'thermostatsSetFallbackClimatePresetPost',
15963
16349
  requestBody: {
15964
16350
  content: {
15965
16351
  'application/json': {
15966
16352
  schema: {
15967
16353
  properties: {
15968
- climate_preset_key: { type: 'string' },
15969
- device_id: { format: 'uuid', type: 'string' },
16354
+ climate_preset_key: {
16355
+ description: 'Climate preset key of the desired climate preset.',
16356
+ type: 'string',
16357
+ },
16358
+ device_id: {
16359
+ description: 'ID of the desired thermostat device.',
16360
+ format: 'uuid',
16361
+ type: 'string',
16362
+ },
15970
16363
  },
15971
16364
  required: ['device_id', 'climate_preset_key'],
15972
16365
  type: 'object',
@@ -16000,22 +16393,19 @@ export default {
16000
16393
  'x-fern-sdk-group-name': ['thermostats'],
16001
16394
  'x-fern-sdk-method-name': 'set_fallback_climate_preset',
16002
16395
  'x-response-key': null,
16396
+ 'x-title': 'Set the Fallback Climate Preset',
16003
16397
  },
16004
16398
  },
16005
16399
  '/thermostats/set_fan_mode': {
16006
16400
  post: {
16007
- 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).',
16401
+ 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).',
16008
16402
  operationId: 'thermostatsSetFanModePost',
16009
16403
  requestBody: {
16010
16404
  content: {
16011
16405
  'application/json': {
16012
16406
  schema: {
16013
16407
  properties: {
16014
- device_id: {
16015
- description: 'ID of the thermostat device.',
16016
- format: 'uuid',
16017
- type: 'string',
16018
- },
16408
+ device_id: { format: 'uuid', type: 'string' },
16019
16409
  fan_mode: {
16020
16410
  deprecated: true,
16021
16411
  enum: ['auto', 'on', 'circulate'],
@@ -16023,11 +16413,15 @@ export default {
16023
16413
  'x-deprecated': 'Use `fan_mode_setting` instead.',
16024
16414
  },
16025
16415
  fan_mode_setting: {
16026
- 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).',
16416
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
16027
16417
  enum: ['auto', 'on', 'circulate'],
16028
16418
  type: 'string',
16029
16419
  },
16030
- sync: { default: false, type: 'boolean' },
16420
+ sync: {
16421
+ default: false,
16422
+ type: 'boolean',
16423
+ 'x-undocumented': 'Only used internally.',
16424
+ },
16031
16425
  },
16032
16426
  required: ['device_id'],
16033
16427
  type: 'object',
@@ -16068,38 +16462,47 @@ export default {
16068
16462
  'x-fern-sdk-method-name': 'set_fan_mode',
16069
16463
  'x-fern-sdk-return-value': 'action_attempt',
16070
16464
  'x-response-key': 'action_attempt',
16071
- 'x-title': 'Set Fan Mode Setting',
16465
+ 'x-title': 'Set the Fan Mode Setting',
16072
16466
  },
16073
16467
  },
16074
16468
  '/thermostats/set_temperature_threshold': {
16075
16469
  patch: {
16470
+ 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.',
16076
16471
  operationId: 'thermostatsSetTemperatureThresholdPatch',
16077
16472
  requestBody: {
16078
16473
  content: {
16079
16474
  'application/json': {
16080
16475
  schema: {
16081
16476
  properties: {
16082
- device_id: { format: 'uuid', type: 'string' },
16477
+ device_id: {
16478
+ description: 'ID of the desired thermostat device.',
16479
+ format: 'uuid',
16480
+ type: 'string',
16481
+ },
16083
16482
  lower_limit_celsius: {
16084
16483
  default: null,
16484
+ 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.',
16085
16485
  format: 'float',
16086
16486
  nullable: true,
16087
16487
  type: 'number',
16088
16488
  },
16089
16489
  lower_limit_fahrenheit: {
16090
16490
  default: null,
16491
+ 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.',
16091
16492
  format: 'float',
16092
16493
  nullable: true,
16093
16494
  type: 'number',
16094
16495
  },
16095
16496
  upper_limit_celsius: {
16096
16497
  default: null,
16498
+ 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.',
16097
16499
  format: 'float',
16098
16500
  nullable: true,
16099
16501
  type: 'number',
16100
16502
  },
16101
16503
  upper_limit_fahrenheit: {
16102
16504
  default: null,
16505
+ 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.',
16103
16506
  format: 'float',
16104
16507
  nullable: true,
16105
16508
  type: 'number',
@@ -16136,35 +16539,45 @@ export default {
16136
16539
  tags: ['/thermostats'],
16137
16540
  'x-fern-ignore': true,
16138
16541
  'x-response-key': null,
16542
+ 'x-title': 'Set a Temperature Threshold',
16139
16543
  },
16140
16544
  post: {
16545
+ 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.',
16141
16546
  operationId: 'thermostatsSetTemperatureThresholdPost',
16142
16547
  requestBody: {
16143
16548
  content: {
16144
16549
  'application/json': {
16145
16550
  schema: {
16146
16551
  properties: {
16147
- device_id: { format: 'uuid', type: 'string' },
16552
+ device_id: {
16553
+ description: 'ID of the desired thermostat device.',
16554
+ format: 'uuid',
16555
+ type: 'string',
16556
+ },
16148
16557
  lower_limit_celsius: {
16149
16558
  default: null,
16559
+ 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.',
16150
16560
  format: 'float',
16151
16561
  nullable: true,
16152
16562
  type: 'number',
16153
16563
  },
16154
16564
  lower_limit_fahrenheit: {
16155
16565
  default: null,
16566
+ 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.',
16156
16567
  format: 'float',
16157
16568
  nullable: true,
16158
16569
  type: 'number',
16159
16570
  },
16160
16571
  upper_limit_celsius: {
16161
16572
  default: null,
16573
+ 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.',
16162
16574
  format: 'float',
16163
16575
  nullable: true,
16164
16576
  type: 'number',
16165
16577
  },
16166
16578
  upper_limit_fahrenheit: {
16167
16579
  default: null,
16580
+ 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.',
16168
16581
  format: 'float',
16169
16582
  nullable: true,
16170
16583
  type: 'number',
@@ -16202,44 +16615,67 @@ export default {
16202
16615
  'x-fern-sdk-group-name': ['thermostats'],
16203
16616
  'x-fern-sdk-method-name': 'set_temperature_threshold',
16204
16617
  'x-response-key': null,
16618
+ 'x-title': 'Set a Temperature Threshold',
16205
16619
  },
16206
16620
  },
16207
16621
  '/thermostats/update_climate_preset': {
16208
16622
  patch: {
16623
+ 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).',
16209
16624
  operationId: 'thermostatsUpdateClimatePresetPatch',
16210
16625
  requestBody: {
16211
16626
  content: {
16212
16627
  'application/json': {
16213
16628
  schema: {
16214
16629
  properties: {
16215
- climate_preset_key: { type: 'string' },
16630
+ climate_preset_key: {
16631
+ description: 'Unique key to identify the climate preset.',
16632
+ type: 'string',
16633
+ },
16216
16634
  cooling_set_point_celsius: {
16635
+ 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).',
16217
16636
  format: 'float',
16218
16637
  type: 'number',
16219
16638
  },
16220
16639
  cooling_set_point_fahrenheit: {
16640
+ description: 'Temperature to which the thermostat should cool (in °F).',
16221
16641
  format: 'float',
16222
16642
  type: 'number',
16223
16643
  },
16224
- device_id: { format: 'uuid', type: 'string' },
16644
+ device_id: {
16645
+ description: 'ID of the desired thermostat device.',
16646
+ format: 'uuid',
16647
+ type: 'string',
16648
+ },
16225
16649
  fan_mode_setting: {
16650
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16226
16651
  enum: ['auto', 'on', 'circulate'],
16227
16652
  type: 'string',
16228
16653
  },
16229
16654
  heating_set_point_celsius: {
16655
+ description: 'Temperature to which the thermostat should heat (in °C).',
16230
16656
  format: 'float',
16231
16657
  type: 'number',
16232
16658
  },
16233
16659
  heating_set_point_fahrenheit: {
16660
+ description: 'Temperature to which the thermostat should heat (in °F).',
16234
16661
  format: 'float',
16235
16662
  type: 'number',
16236
16663
  },
16237
16664
  hvac_mode_setting: {
16665
+ 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`.',
16238
16666
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16239
16667
  type: 'string',
16240
16668
  },
16241
- manual_override_allowed: { type: 'boolean' },
16242
- name: { default: null, nullable: true, type: 'string' },
16669
+ manual_override_allowed: {
16670
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16671
+ type: 'boolean',
16672
+ },
16673
+ name: {
16674
+ default: null,
16675
+ description: 'User-friendly name to identify the climate preset.',
16676
+ nullable: true,
16677
+ type: 'string',
16678
+ },
16243
16679
  },
16244
16680
  required: [
16245
16681
  'device_id',
@@ -16276,42 +16712,65 @@ export default {
16276
16712
  tags: ['/thermostats'],
16277
16713
  'x-fern-ignore': true,
16278
16714
  'x-response-key': null,
16715
+ 'x-title': 'Update a Climate Preset',
16279
16716
  },
16280
16717
  post: {
16718
+ 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).',
16281
16719
  operationId: 'thermostatsUpdateClimatePresetPost',
16282
16720
  requestBody: {
16283
16721
  content: {
16284
16722
  'application/json': {
16285
16723
  schema: {
16286
16724
  properties: {
16287
- climate_preset_key: { type: 'string' },
16725
+ climate_preset_key: {
16726
+ description: 'Unique key to identify the climate preset.',
16727
+ type: 'string',
16728
+ },
16288
16729
  cooling_set_point_celsius: {
16730
+ 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).',
16289
16731
  format: 'float',
16290
16732
  type: 'number',
16291
16733
  },
16292
16734
  cooling_set_point_fahrenheit: {
16735
+ description: 'Temperature to which the thermostat should cool (in °F).',
16293
16736
  format: 'float',
16294
16737
  type: 'number',
16295
16738
  },
16296
- device_id: { format: 'uuid', type: 'string' },
16739
+ device_id: {
16740
+ description: 'ID of the desired thermostat device.',
16741
+ format: 'uuid',
16742
+ type: 'string',
16743
+ },
16297
16744
  fan_mode_setting: {
16745
+ description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16298
16746
  enum: ['auto', 'on', 'circulate'],
16299
16747
  type: 'string',
16300
16748
  },
16301
16749
  heating_set_point_celsius: {
16750
+ description: 'Temperature to which the thermostat should heat (in °C).',
16302
16751
  format: 'float',
16303
16752
  type: 'number',
16304
16753
  },
16305
16754
  heating_set_point_fahrenheit: {
16755
+ description: 'Temperature to which the thermostat should heat (in °F).',
16306
16756
  format: 'float',
16307
16757
  type: 'number',
16308
16758
  },
16309
16759
  hvac_mode_setting: {
16760
+ 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`.',
16310
16761
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16311
16762
  type: 'string',
16312
16763
  },
16313
- manual_override_allowed: { type: 'boolean' },
16314
- name: { default: null, nullable: true, type: 'string' },
16764
+ manual_override_allowed: {
16765
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
16766
+ type: 'boolean',
16767
+ },
16768
+ name: {
16769
+ default: null,
16770
+ description: 'User-friendly name to identify the climate preset.',
16771
+ nullable: true,
16772
+ type: 'string',
16773
+ },
16315
16774
  },
16316
16775
  required: [
16317
16776
  'device_id',
@@ -16349,6 +16808,7 @@ export default {
16349
16808
  'x-fern-sdk-group-name': ['thermostats'],
16350
16809
  'x-fern-sdk-method-name': 'update_climate_preset',
16351
16810
  'x-response-key': null,
16811
+ 'x-title': 'Update a Climate Preset',
16352
16812
  },
16353
16813
  },
16354
16814
  '/user_identities/add_acs_user': {