@seamapi/types 1.291.0 → 1.292.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +651 -177
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1005 -39
- package/lib/seam/connect/models/thermostats/climate-preset.js +41 -12
- package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +30 -9
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +216 -1
- package/lib/seam/connect/openapi.js +588 -130
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +789 -38
- package/package.json +1 -1
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +49 -12
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +38 -9
- package/src/lib/seam/connect/openapi.ts +741 -130
- package/src/lib/seam/connect/route-types.ts +789 -38
|
@@ -4415,20 +4415,44 @@ export default {
|
|
|
4415
4415
|
default: null,
|
|
4416
4416
|
nullable: true,
|
|
4417
4417
|
properties: {
|
|
4418
|
-
climate_preset_key: {
|
|
4419
|
-
|
|
4420
|
-
|
|
4421
|
-
|
|
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
|
+
},
|
|
4422
4437
|
errors: {
|
|
4423
|
-
description: '
|
|
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.',
|
|
4424
4439
|
},
|
|
4425
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).",
|
|
4426
4442
|
minimum: 0,
|
|
4427
4443
|
type: 'integer',
|
|
4428
4444
|
},
|
|
4429
|
-
name: {
|
|
4430
|
-
|
|
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
|
+
},
|
|
4431
4454
|
thermostat_schedule_id: {
|
|
4455
|
+
description: 'ID of the climate schedule.',
|
|
4432
4456
|
format: 'uuid',
|
|
4433
4457
|
type: 'string',
|
|
4434
4458
|
},
|
|
@@ -4447,37 +4471,59 @@ export default {
|
|
|
4447
4471
|
available_climate_presets: {
|
|
4448
4472
|
items: {
|
|
4449
4473
|
properties: {
|
|
4450
|
-
can_delete: {
|
|
4451
|
-
|
|
4452
|
-
|
|
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
|
+
},
|
|
4453
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).',
|
|
4454
4488
|
format: 'float',
|
|
4455
4489
|
type: 'number',
|
|
4456
4490
|
},
|
|
4457
4491
|
cooling_set_point_fahrenheit: {
|
|
4492
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
4458
4493
|
format: 'float',
|
|
4459
4494
|
type: 'number',
|
|
4460
4495
|
},
|
|
4461
|
-
display_name: {
|
|
4496
|
+
display_name: {
|
|
4497
|
+
description: 'Display name for the climate preset.',
|
|
4498
|
+
type: 'string',
|
|
4499
|
+
},
|
|
4462
4500
|
fan_mode_setting: {
|
|
4501
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4463
4502
|
enum: ['auto', 'on', 'circulate'],
|
|
4464
4503
|
type: 'string',
|
|
4465
4504
|
},
|
|
4466
4505
|
heating_set_point_celsius: {
|
|
4506
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
4467
4507
|
format: 'float',
|
|
4468
4508
|
type: 'number',
|
|
4469
4509
|
},
|
|
4470
4510
|
heating_set_point_fahrenheit: {
|
|
4511
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
4471
4512
|
format: 'float',
|
|
4472
4513
|
type: 'number',
|
|
4473
4514
|
},
|
|
4474
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`.',
|
|
4475
4517
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4476
4518
|
type: 'string',
|
|
4477
4519
|
},
|
|
4478
|
-
manual_override_allowed: {
|
|
4520
|
+
manual_override_allowed: {
|
|
4521
|
+
description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4522
|
+
type: 'boolean',
|
|
4523
|
+
},
|
|
4479
4524
|
name: {
|
|
4480
4525
|
default: null,
|
|
4526
|
+
description: 'User-friendly name to identify the climate preset.',
|
|
4481
4527
|
nullable: true,
|
|
4482
4528
|
type: 'string',
|
|
4483
4529
|
},
|
|
@@ -4509,37 +4555,59 @@ export default {
|
|
|
4509
4555
|
},
|
|
4510
4556
|
current_climate_setting: {
|
|
4511
4557
|
properties: {
|
|
4512
|
-
can_delete: {
|
|
4513
|
-
|
|
4514
|
-
|
|
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
|
+
},
|
|
4515
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).',
|
|
4516
4572
|
format: 'float',
|
|
4517
4573
|
type: 'number',
|
|
4518
4574
|
},
|
|
4519
4575
|
cooling_set_point_fahrenheit: {
|
|
4576
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
4520
4577
|
format: 'float',
|
|
4521
4578
|
type: 'number',
|
|
4522
4579
|
},
|
|
4523
|
-
display_name: {
|
|
4580
|
+
display_name: {
|
|
4581
|
+
description: 'Display name for the climate preset.',
|
|
4582
|
+
type: 'string',
|
|
4583
|
+
},
|
|
4524
4584
|
fan_mode_setting: {
|
|
4585
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4525
4586
|
enum: ['auto', 'on', 'circulate'],
|
|
4526
4587
|
type: 'string',
|
|
4527
4588
|
},
|
|
4528
4589
|
heating_set_point_celsius: {
|
|
4590
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
4529
4591
|
format: 'float',
|
|
4530
4592
|
type: 'number',
|
|
4531
4593
|
},
|
|
4532
4594
|
heating_set_point_fahrenheit: {
|
|
4595
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
4533
4596
|
format: 'float',
|
|
4534
4597
|
type: 'number',
|
|
4535
4598
|
},
|
|
4536
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`.',
|
|
4537
4601
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4538
4602
|
type: 'string',
|
|
4539
4603
|
},
|
|
4540
|
-
manual_override_allowed: {
|
|
4604
|
+
manual_override_allowed: {
|
|
4605
|
+
description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4606
|
+
type: 'boolean',
|
|
4607
|
+
},
|
|
4541
4608
|
name: {
|
|
4542
4609
|
default: null,
|
|
4610
|
+
description: 'User-friendly name to identify the climate preset.',
|
|
4543
4611
|
nullable: true,
|
|
4544
4612
|
type: 'string',
|
|
4545
4613
|
},
|
|
@@ -4549,37 +4617,59 @@ export default {
|
|
|
4549
4617
|
default_climate_setting: {
|
|
4550
4618
|
deprecated: true,
|
|
4551
4619
|
properties: {
|
|
4552
|
-
can_delete: {
|
|
4553
|
-
|
|
4554
|
-
|
|
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
|
+
},
|
|
4555
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).',
|
|
4556
4634
|
format: 'float',
|
|
4557
4635
|
type: 'number',
|
|
4558
4636
|
},
|
|
4559
4637
|
cooling_set_point_fahrenheit: {
|
|
4638
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
4560
4639
|
format: 'float',
|
|
4561
4640
|
type: 'number',
|
|
4562
4641
|
},
|
|
4563
|
-
display_name: {
|
|
4642
|
+
display_name: {
|
|
4643
|
+
description: 'Display name for the climate preset.',
|
|
4644
|
+
type: 'string',
|
|
4645
|
+
},
|
|
4564
4646
|
fan_mode_setting: {
|
|
4647
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4565
4648
|
enum: ['auto', 'on', 'circulate'],
|
|
4566
4649
|
type: 'string',
|
|
4567
4650
|
},
|
|
4568
4651
|
heating_set_point_celsius: {
|
|
4652
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
4569
4653
|
format: 'float',
|
|
4570
4654
|
type: 'number',
|
|
4571
4655
|
},
|
|
4572
4656
|
heating_set_point_fahrenheit: {
|
|
4657
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
4573
4658
|
format: 'float',
|
|
4574
4659
|
type: 'number',
|
|
4575
4660
|
},
|
|
4576
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`.',
|
|
4577
4663
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4578
4664
|
type: 'string',
|
|
4579
4665
|
},
|
|
4580
|
-
manual_override_allowed: {
|
|
4666
|
+
manual_override_allowed: {
|
|
4667
|
+
description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4668
|
+
type: 'boolean',
|
|
4669
|
+
},
|
|
4581
4670
|
name: {
|
|
4582
4671
|
default: null,
|
|
4672
|
+
description: 'User-friendly name to identify the climate preset.',
|
|
4583
4673
|
nullable: true,
|
|
4584
4674
|
type: 'string',
|
|
4585
4675
|
},
|
|
@@ -5073,17 +5163,47 @@ export default {
|
|
|
5073
5163
|
},
|
|
5074
5164
|
thermostat_schedule: {
|
|
5075
5165
|
properties: {
|
|
5076
|
-
climate_preset_key: {
|
|
5077
|
-
|
|
5078
|
-
|
|
5079
|
-
|
|
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
|
+
},
|
|
5080
5185
|
errors: {
|
|
5081
|
-
description: '
|
|
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',
|
|
5082
5206
|
},
|
|
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
5207
|
},
|
|
5088
5208
|
required: [
|
|
5089
5209
|
'thermostat_schedule_id',
|
|
@@ -12222,34 +12342,47 @@ export default {
|
|
|
12222
12342
|
},
|
|
12223
12343
|
'/devices/list': {
|
|
12224
12344
|
post: {
|
|
12345
|
+
description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
|
|
12225
12346
|
operationId: 'devicesListPost',
|
|
12226
12347
|
requestBody: {
|
|
12227
12348
|
content: {
|
|
12228
12349
|
'application/json': {
|
|
12229
12350
|
schema: {
|
|
12230
12351
|
properties: {
|
|
12231
|
-
connect_webview_id: {
|
|
12352
|
+
connect_webview_id: {
|
|
12353
|
+
description: 'ID of the Connect Webview by which to filter devices.',
|
|
12354
|
+
format: 'uuid',
|
|
12355
|
+
type: 'string',
|
|
12356
|
+
},
|
|
12232
12357
|
connected_account_id: {
|
|
12233
|
-
description: '
|
|
12358
|
+
description: 'ID of the connected account by which to filter.',
|
|
12234
12359
|
format: 'uuid',
|
|
12235
12360
|
type: 'string',
|
|
12236
12361
|
},
|
|
12237
12362
|
connected_account_ids: {
|
|
12363
|
+
description: 'Array of IDs of the connected accounts by which to filter devices.',
|
|
12238
12364
|
items: { format: 'uuid', type: 'string' },
|
|
12239
12365
|
type: 'array',
|
|
12240
12366
|
},
|
|
12241
|
-
created_before: {
|
|
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
|
+
},
|
|
12242
12372
|
custom_metadata_has: {
|
|
12243
12373
|
additionalProperties: {
|
|
12244
12374
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
12245
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.',
|
|
12246
12377
|
type: 'object',
|
|
12247
12378
|
},
|
|
12248
12379
|
device_ids: {
|
|
12380
|
+
description: 'Array of device IDs by which to filter devices.',
|
|
12249
12381
|
items: { format: 'uuid', type: 'string' },
|
|
12250
12382
|
type: 'array',
|
|
12251
12383
|
},
|
|
12252
12384
|
device_type: {
|
|
12385
|
+
description: 'Device type by which to filter devices.',
|
|
12253
12386
|
oneOf: [
|
|
12254
12387
|
{
|
|
12255
12388
|
enum: [
|
|
@@ -12306,6 +12439,7 @@ export default {
|
|
|
12306
12439
|
],
|
|
12307
12440
|
},
|
|
12308
12441
|
device_types: {
|
|
12442
|
+
description: 'Array of device types by which to filter devices.',
|
|
12309
12443
|
items: {
|
|
12310
12444
|
oneOf: [
|
|
12311
12445
|
{
|
|
@@ -12385,6 +12519,7 @@ export default {
|
|
|
12385
12519
|
type: 'string',
|
|
12386
12520
|
},
|
|
12387
12521
|
type: 'array',
|
|
12522
|
+
'x-undocumented': 'Only used internally.',
|
|
12388
12523
|
},
|
|
12389
12524
|
include_if: {
|
|
12390
12525
|
items: {
|
|
@@ -12404,9 +12539,16 @@ export default {
|
|
|
12404
12539
|
type: 'string',
|
|
12405
12540
|
},
|
|
12406
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',
|
|
12407
12549
|
},
|
|
12408
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
12409
12550
|
manufacturer: {
|
|
12551
|
+
description: 'Manufacturer by which to filter devices.',
|
|
12410
12552
|
enum: [
|
|
12411
12553
|
'akuvox',
|
|
12412
12554
|
'august',
|
|
@@ -12446,7 +12588,10 @@ export default {
|
|
|
12446
12588
|
],
|
|
12447
12589
|
type: 'string',
|
|
12448
12590
|
},
|
|
12449
|
-
user_identifier_key: {
|
|
12591
|
+
user_identifier_key: {
|
|
12592
|
+
description: 'Your own internal user ID for the user by which to filter devices.',
|
|
12593
|
+
type: 'string',
|
|
12594
|
+
},
|
|
12450
12595
|
},
|
|
12451
12596
|
type: 'object',
|
|
12452
12597
|
},
|
|
@@ -12487,6 +12632,7 @@ export default {
|
|
|
12487
12632
|
'x-fern-sdk-method-name': 'list',
|
|
12488
12633
|
'x-fern-sdk-return-value': 'devices',
|
|
12489
12634
|
'x-response-key': 'devices',
|
|
12635
|
+
'x-title': 'List Devices',
|
|
12490
12636
|
},
|
|
12491
12637
|
},
|
|
12492
12638
|
'/devices/list_device_providers': {
|
|
@@ -12732,28 +12878,40 @@ export default {
|
|
|
12732
12878
|
'application/json': {
|
|
12733
12879
|
schema: {
|
|
12734
12880
|
properties: {
|
|
12735
|
-
connect_webview_id: {
|
|
12881
|
+
connect_webview_id: {
|
|
12882
|
+
description: 'ID of the Connect Webview by which to filter devices.',
|
|
12883
|
+
format: 'uuid',
|
|
12884
|
+
type: 'string',
|
|
12885
|
+
},
|
|
12736
12886
|
connected_account_id: {
|
|
12737
|
-
description: '
|
|
12887
|
+
description: 'ID of the connected account by which to filter.',
|
|
12738
12888
|
format: 'uuid',
|
|
12739
12889
|
type: 'string',
|
|
12740
12890
|
},
|
|
12741
12891
|
connected_account_ids: {
|
|
12892
|
+
description: 'Array of IDs of the connected accounts by which to filter devices.',
|
|
12742
12893
|
items: { format: 'uuid', type: 'string' },
|
|
12743
12894
|
type: 'array',
|
|
12744
12895
|
},
|
|
12745
|
-
created_before: {
|
|
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
|
+
},
|
|
12746
12901
|
custom_metadata_has: {
|
|
12747
12902
|
additionalProperties: {
|
|
12748
12903
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
12749
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.',
|
|
12750
12906
|
type: 'object',
|
|
12751
12907
|
},
|
|
12752
12908
|
device_ids: {
|
|
12909
|
+
description: 'Array of device IDs by which to filter devices.',
|
|
12753
12910
|
items: { format: 'uuid', type: 'string' },
|
|
12754
12911
|
type: 'array',
|
|
12755
12912
|
},
|
|
12756
12913
|
device_type: {
|
|
12914
|
+
description: 'Device type by which to filter devices.',
|
|
12757
12915
|
oneOf: [
|
|
12758
12916
|
{
|
|
12759
12917
|
enum: [
|
|
@@ -12810,6 +12968,7 @@ export default {
|
|
|
12810
12968
|
],
|
|
12811
12969
|
},
|
|
12812
12970
|
device_types: {
|
|
12971
|
+
description: 'Array of device types by which to filter devices.',
|
|
12813
12972
|
items: {
|
|
12814
12973
|
oneOf: [
|
|
12815
12974
|
{
|
|
@@ -12889,6 +13048,7 @@ export default {
|
|
|
12889
13048
|
type: 'string',
|
|
12890
13049
|
},
|
|
12891
13050
|
type: 'array',
|
|
13051
|
+
'x-undocumented': 'Only used internally.',
|
|
12892
13052
|
},
|
|
12893
13053
|
include_if: {
|
|
12894
13054
|
items: {
|
|
@@ -12908,9 +13068,16 @@ export default {
|
|
|
12908
13068
|
type: 'string',
|
|
12909
13069
|
},
|
|
12910
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',
|
|
12911
13078
|
},
|
|
12912
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
12913
13079
|
manufacturer: {
|
|
13080
|
+
description: 'Manufacturer by which to filter devices.',
|
|
12914
13081
|
enum: [
|
|
12915
13082
|
'akuvox',
|
|
12916
13083
|
'august',
|
|
@@ -12950,7 +13117,10 @@ export default {
|
|
|
12950
13117
|
],
|
|
12951
13118
|
type: 'string',
|
|
12952
13119
|
},
|
|
12953
|
-
user_identifier_key: {
|
|
13120
|
+
user_identifier_key: {
|
|
13121
|
+
description: 'Your own internal user ID for the user by which to filter devices.',
|
|
13122
|
+
type: 'string',
|
|
13123
|
+
},
|
|
12954
13124
|
},
|
|
12955
13125
|
type: 'object',
|
|
12956
13126
|
},
|
|
@@ -13540,28 +13710,40 @@ export default {
|
|
|
13540
13710
|
'application/json': {
|
|
13541
13711
|
schema: {
|
|
13542
13712
|
properties: {
|
|
13543
|
-
connect_webview_id: {
|
|
13713
|
+
connect_webview_id: {
|
|
13714
|
+
description: 'ID of the Connect Webview by which to filter devices.',
|
|
13715
|
+
format: 'uuid',
|
|
13716
|
+
type: 'string',
|
|
13717
|
+
},
|
|
13544
13718
|
connected_account_id: {
|
|
13545
|
-
description: '
|
|
13719
|
+
description: 'ID of the connected account by which to filter.',
|
|
13546
13720
|
format: 'uuid',
|
|
13547
13721
|
type: 'string',
|
|
13548
13722
|
},
|
|
13549
13723
|
connected_account_ids: {
|
|
13724
|
+
description: 'Array of IDs of the connected accounts by which to filter devices.',
|
|
13550
13725
|
items: { format: 'uuid', type: 'string' },
|
|
13551
13726
|
type: 'array',
|
|
13552
13727
|
},
|
|
13553
|
-
created_before: {
|
|
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
|
+
},
|
|
13554
13733
|
custom_metadata_has: {
|
|
13555
13734
|
additionalProperties: {
|
|
13556
13735
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
13557
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.',
|
|
13558
13738
|
type: 'object',
|
|
13559
13739
|
},
|
|
13560
13740
|
device_ids: {
|
|
13741
|
+
description: 'Array of device IDs by which to filter devices.',
|
|
13561
13742
|
items: { format: 'uuid', type: 'string' },
|
|
13562
13743
|
type: 'array',
|
|
13563
13744
|
},
|
|
13564
13745
|
device_type: {
|
|
13746
|
+
description: 'Device type by which to filter devices.',
|
|
13565
13747
|
oneOf: [
|
|
13566
13748
|
{
|
|
13567
13749
|
enum: [
|
|
@@ -13618,6 +13800,7 @@ export default {
|
|
|
13618
13800
|
],
|
|
13619
13801
|
},
|
|
13620
13802
|
device_types: {
|
|
13803
|
+
description: 'Array of device types by which to filter devices.',
|
|
13621
13804
|
items: {
|
|
13622
13805
|
oneOf: [
|
|
13623
13806
|
{
|
|
@@ -13697,6 +13880,7 @@ export default {
|
|
|
13697
13880
|
type: 'string',
|
|
13698
13881
|
},
|
|
13699
13882
|
type: 'array',
|
|
13883
|
+
'x-undocumented': 'Only used internally.',
|
|
13700
13884
|
},
|
|
13701
13885
|
include_if: {
|
|
13702
13886
|
items: {
|
|
@@ -13716,9 +13900,16 @@ export default {
|
|
|
13716
13900
|
type: 'string',
|
|
13717
13901
|
},
|
|
13718
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',
|
|
13719
13910
|
},
|
|
13720
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
13721
13911
|
manufacturer: {
|
|
13912
|
+
description: 'Manufacturer by which to filter devices.',
|
|
13722
13913
|
enum: [
|
|
13723
13914
|
'akuvox',
|
|
13724
13915
|
'august',
|
|
@@ -13758,7 +13949,10 @@ export default {
|
|
|
13758
13949
|
],
|
|
13759
13950
|
type: 'string',
|
|
13760
13951
|
},
|
|
13761
|
-
user_identifier_key: {
|
|
13952
|
+
user_identifier_key: {
|
|
13953
|
+
description: 'Your own internal user ID for the user by which to filter devices.',
|
|
13954
|
+
type: 'string',
|
|
13955
|
+
},
|
|
13762
13956
|
},
|
|
13763
13957
|
type: 'object',
|
|
13764
13958
|
},
|
|
@@ -14006,28 +14200,40 @@ export default {
|
|
|
14006
14200
|
'application/json': {
|
|
14007
14201
|
schema: {
|
|
14008
14202
|
properties: {
|
|
14009
|
-
connect_webview_id: {
|
|
14203
|
+
connect_webview_id: {
|
|
14204
|
+
description: 'ID of the Connect Webview by which to filter devices.',
|
|
14205
|
+
format: 'uuid',
|
|
14206
|
+
type: 'string',
|
|
14207
|
+
},
|
|
14010
14208
|
connected_account_id: {
|
|
14011
|
-
description: '
|
|
14209
|
+
description: 'ID of the connected account by which to filter.',
|
|
14012
14210
|
format: 'uuid',
|
|
14013
14211
|
type: 'string',
|
|
14014
14212
|
},
|
|
14015
14213
|
connected_account_ids: {
|
|
14214
|
+
description: 'Array of IDs of the connected accounts by which to filter devices.',
|
|
14016
14215
|
items: { format: 'uuid', type: 'string' },
|
|
14017
14216
|
type: 'array',
|
|
14018
14217
|
},
|
|
14019
|
-
created_before: {
|
|
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
|
+
},
|
|
14020
14223
|
custom_metadata_has: {
|
|
14021
14224
|
additionalProperties: {
|
|
14022
14225
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
14023
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.',
|
|
14024
14228
|
type: 'object',
|
|
14025
14229
|
},
|
|
14026
14230
|
device_ids: {
|
|
14231
|
+
description: 'Array of device IDs by which to filter devices.',
|
|
14027
14232
|
items: { format: 'uuid', type: 'string' },
|
|
14028
14233
|
type: 'array',
|
|
14029
14234
|
},
|
|
14030
14235
|
device_type: {
|
|
14236
|
+
description: 'Device type by which to filter devices.',
|
|
14031
14237
|
oneOf: [
|
|
14032
14238
|
{
|
|
14033
14239
|
enum: [
|
|
@@ -14084,6 +14290,7 @@ export default {
|
|
|
14084
14290
|
],
|
|
14085
14291
|
},
|
|
14086
14292
|
device_types: {
|
|
14293
|
+
description: 'Array of device types by which to filter devices.',
|
|
14087
14294
|
items: {
|
|
14088
14295
|
oneOf: [
|
|
14089
14296
|
{
|
|
@@ -14163,6 +14370,7 @@ export default {
|
|
|
14163
14370
|
type: 'string',
|
|
14164
14371
|
},
|
|
14165
14372
|
type: 'array',
|
|
14373
|
+
'x-undocumented': 'Only used internally.',
|
|
14166
14374
|
},
|
|
14167
14375
|
include_if: {
|
|
14168
14376
|
items: {
|
|
@@ -14182,9 +14390,16 @@ export default {
|
|
|
14182
14390
|
type: 'string',
|
|
14183
14391
|
},
|
|
14184
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',
|
|
14185
14400
|
},
|
|
14186
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
14187
14401
|
manufacturer: {
|
|
14402
|
+
description: 'Manufacturer by which to filter devices.',
|
|
14188
14403
|
enum: [
|
|
14189
14404
|
'akuvox',
|
|
14190
14405
|
'august',
|
|
@@ -14224,7 +14439,10 @@ export default {
|
|
|
14224
14439
|
],
|
|
14225
14440
|
type: 'string',
|
|
14226
14441
|
},
|
|
14227
|
-
user_identifier_key: {
|
|
14442
|
+
user_identifier_key: {
|
|
14443
|
+
description: 'Your own internal user ID for the user by which to filter devices.',
|
|
14444
|
+
type: 'string',
|
|
14445
|
+
},
|
|
14228
14446
|
},
|
|
14229
14447
|
type: 'object',
|
|
14230
14448
|
},
|
|
@@ -14869,14 +15087,22 @@ export default {
|
|
|
14869
15087
|
},
|
|
14870
15088
|
'/thermostats/activate_climate_preset': {
|
|
14871
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).',
|
|
14872
15091
|
operationId: 'thermostatsActivateClimatePresetPost',
|
|
14873
15092
|
requestBody: {
|
|
14874
15093
|
content: {
|
|
14875
15094
|
'application/json': {
|
|
14876
15095
|
schema: {
|
|
14877
15096
|
properties: {
|
|
14878
|
-
climate_preset_key: {
|
|
14879
|
-
|
|
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
|
+
},
|
|
14880
15106
|
},
|
|
14881
15107
|
required: ['device_id', 'climate_preset_key'],
|
|
14882
15108
|
type: 'object',
|
|
@@ -14916,11 +15142,12 @@ export default {
|
|
|
14916
15142
|
'x-fern-sdk-method-name': 'activate_climate_preset',
|
|
14917
15143
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
14918
15144
|
'x-response-key': 'action_attempt',
|
|
15145
|
+
'x-title': 'Activate a Climate Preset',
|
|
14919
15146
|
},
|
|
14920
15147
|
},
|
|
14921
15148
|
'/thermostats/cool': {
|
|
14922
15149
|
post: {
|
|
14923
|
-
description: 'Sets a thermostat
|
|
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).',
|
|
14924
15151
|
operationId: 'thermostatsCoolPost',
|
|
14925
15152
|
requestBody: {
|
|
14926
15153
|
content: {
|
|
@@ -14928,21 +15155,25 @@ export default {
|
|
|
14928
15155
|
schema: {
|
|
14929
15156
|
properties: {
|
|
14930
15157
|
cooling_set_point_celsius: {
|
|
14931
|
-
description: '
|
|
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.',
|
|
14932
15159
|
format: 'float',
|
|
14933
15160
|
type: 'number',
|
|
14934
15161
|
},
|
|
14935
15162
|
cooling_set_point_fahrenheit: {
|
|
14936
|
-
description: '
|
|
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.',
|
|
14937
15164
|
format: 'float',
|
|
14938
15165
|
type: 'number',
|
|
14939
15166
|
},
|
|
14940
15167
|
device_id: {
|
|
14941
|
-
description: 'ID of the thermostat device.',
|
|
15168
|
+
description: 'ID of the desired thermostat device.',
|
|
14942
15169
|
format: 'uuid',
|
|
14943
15170
|
type: 'string',
|
|
14944
15171
|
},
|
|
14945
|
-
sync: {
|
|
15172
|
+
sync: {
|
|
15173
|
+
default: false,
|
|
15174
|
+
type: 'boolean',
|
|
15175
|
+
'x-undocumented': 'Only used internally.',
|
|
15176
|
+
},
|
|
14946
15177
|
},
|
|
14947
15178
|
required: ['device_id'],
|
|
14948
15179
|
type: 'object',
|
|
@@ -14988,40 +15219,62 @@ export default {
|
|
|
14988
15219
|
},
|
|
14989
15220
|
'/thermostats/create_climate_preset': {
|
|
14990
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).',
|
|
14991
15223
|
operationId: 'thermostatsCreateClimatePresetPost',
|
|
14992
15224
|
requestBody: {
|
|
14993
15225
|
content: {
|
|
14994
15226
|
'application/json': {
|
|
14995
15227
|
schema: {
|
|
14996
15228
|
properties: {
|
|
14997
|
-
climate_preset_key: {
|
|
15229
|
+
climate_preset_key: {
|
|
15230
|
+
description: 'Unique key to identify the climate preset.',
|
|
15231
|
+
type: 'string',
|
|
15232
|
+
},
|
|
14998
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).',
|
|
14999
15235
|
format: 'float',
|
|
15000
15236
|
type: 'number',
|
|
15001
15237
|
},
|
|
15002
15238
|
cooling_set_point_fahrenheit: {
|
|
15239
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
15003
15240
|
format: 'float',
|
|
15004
15241
|
type: 'number',
|
|
15005
15242
|
},
|
|
15006
|
-
device_id: {
|
|
15243
|
+
device_id: {
|
|
15244
|
+
description: 'ID of the desired thermostat device.',
|
|
15245
|
+
format: 'uuid',
|
|
15246
|
+
type: 'string',
|
|
15247
|
+
},
|
|
15007
15248
|
fan_mode_setting: {
|
|
15249
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
15008
15250
|
enum: ['auto', 'on', 'circulate'],
|
|
15009
15251
|
type: 'string',
|
|
15010
15252
|
},
|
|
15011
15253
|
heating_set_point_celsius: {
|
|
15254
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
15012
15255
|
format: 'float',
|
|
15013
15256
|
type: 'number',
|
|
15014
15257
|
},
|
|
15015
15258
|
heating_set_point_fahrenheit: {
|
|
15259
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
15016
15260
|
format: 'float',
|
|
15017
15261
|
type: 'number',
|
|
15018
15262
|
},
|
|
15019
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`.',
|
|
15020
15265
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
15021
15266
|
type: 'string',
|
|
15022
15267
|
},
|
|
15023
|
-
manual_override_allowed: {
|
|
15024
|
-
|
|
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
|
+
},
|
|
15025
15278
|
},
|
|
15026
15279
|
required: [
|
|
15027
15280
|
'device_id',
|
|
@@ -15059,18 +15312,27 @@ export default {
|
|
|
15059
15312
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
15060
15313
|
'x-fern-sdk-method-name': 'create_climate_preset',
|
|
15061
15314
|
'x-response-key': null,
|
|
15315
|
+
'x-title': 'Create a Climate Preset',
|
|
15062
15316
|
},
|
|
15063
15317
|
},
|
|
15064
15318
|
'/thermostats/delete_climate_preset': {
|
|
15065
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).',
|
|
15066
15321
|
operationId: 'thermostatsDeleteClimatePresetPost',
|
|
15067
15322
|
requestBody: {
|
|
15068
15323
|
content: {
|
|
15069
15324
|
'application/json': {
|
|
15070
15325
|
schema: {
|
|
15071
15326
|
properties: {
|
|
15072
|
-
climate_preset_key: {
|
|
15073
|
-
|
|
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
|
+
},
|
|
15074
15336
|
},
|
|
15075
15337
|
required: ['device_id', 'climate_preset_key'],
|
|
15076
15338
|
type: 'object',
|
|
@@ -15104,11 +15366,12 @@ export default {
|
|
|
15104
15366
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
15105
15367
|
'x-fern-sdk-method-name': 'delete_climate_preset',
|
|
15106
15368
|
'x-response-key': null,
|
|
15369
|
+
'x-title': 'Delete a Climate Preset',
|
|
15107
15370
|
},
|
|
15108
15371
|
},
|
|
15109
15372
|
'/thermostats/get': {
|
|
15110
15373
|
post: {
|
|
15111
|
-
description: 'Returns a
|
|
15374
|
+
description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
15112
15375
|
operationId: 'thermostatsGetPost',
|
|
15113
15376
|
requestBody: {
|
|
15114
15377
|
content: {
|
|
@@ -15116,12 +15379,12 @@ export default {
|
|
|
15116
15379
|
schema: {
|
|
15117
15380
|
properties: {
|
|
15118
15381
|
device_id: {
|
|
15119
|
-
description: 'ID of the thermostat device.',
|
|
15382
|
+
description: 'ID of the desired thermostat device.',
|
|
15120
15383
|
format: 'uuid',
|
|
15121
15384
|
type: 'string',
|
|
15122
15385
|
},
|
|
15123
15386
|
name: {
|
|
15124
|
-
description: '
|
|
15387
|
+
description: 'User-friendly name of the desired thermostat device.',
|
|
15125
15388
|
type: 'string',
|
|
15126
15389
|
},
|
|
15127
15390
|
},
|
|
@@ -15163,11 +15426,12 @@ export default {
|
|
|
15163
15426
|
'x-fern-sdk-return-value': 'thermostat',
|
|
15164
15427
|
'x-response-key': 'thermostat',
|
|
15165
15428
|
'x-title': 'Get a Thermostat',
|
|
15429
|
+
'x-undocumented': 'Will be removed.',
|
|
15166
15430
|
},
|
|
15167
15431
|
},
|
|
15168
15432
|
'/thermostats/heat': {
|
|
15169
15433
|
post: {
|
|
15170
|
-
description: 'Sets a thermostat
|
|
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).',
|
|
15171
15435
|
operationId: 'thermostatsHeatPost',
|
|
15172
15436
|
requestBody: {
|
|
15173
15437
|
content: {
|
|
@@ -15175,21 +15439,25 @@ export default {
|
|
|
15175
15439
|
schema: {
|
|
15176
15440
|
properties: {
|
|
15177
15441
|
device_id: {
|
|
15178
|
-
description: 'ID of the thermostat device.',
|
|
15442
|
+
description: 'ID of the desired thermostat device.',
|
|
15179
15443
|
format: 'uuid',
|
|
15180
15444
|
type: 'string',
|
|
15181
15445
|
},
|
|
15182
15446
|
heating_set_point_celsius: {
|
|
15183
|
-
description: '
|
|
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.',
|
|
15184
15448
|
format: 'float',
|
|
15185
15449
|
type: 'number',
|
|
15186
15450
|
},
|
|
15187
15451
|
heating_set_point_fahrenheit: {
|
|
15188
|
-
description: '
|
|
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.',
|
|
15189
15453
|
format: 'float',
|
|
15190
15454
|
type: 'number',
|
|
15191
15455
|
},
|
|
15192
|
-
sync: {
|
|
15456
|
+
sync: {
|
|
15457
|
+
default: false,
|
|
15458
|
+
type: 'boolean',
|
|
15459
|
+
'x-undocumented': 'Only used internally.',
|
|
15460
|
+
},
|
|
15193
15461
|
},
|
|
15194
15462
|
required: ['device_id'],
|
|
15195
15463
|
type: 'object',
|
|
@@ -15235,7 +15503,7 @@ export default {
|
|
|
15235
15503
|
},
|
|
15236
15504
|
'/thermostats/heat_cool': {
|
|
15237
15505
|
post: {
|
|
15238
|
-
description: '
|
|
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).',
|
|
15239
15507
|
operationId: 'thermostatsHeatCoolPost',
|
|
15240
15508
|
requestBody: {
|
|
15241
15509
|
content: {
|
|
@@ -15243,31 +15511,35 @@ export default {
|
|
|
15243
15511
|
schema: {
|
|
15244
15512
|
properties: {
|
|
15245
15513
|
cooling_set_point_celsius: {
|
|
15246
|
-
description: '
|
|
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.',
|
|
15247
15515
|
format: 'float',
|
|
15248
15516
|
type: 'number',
|
|
15249
15517
|
},
|
|
15250
15518
|
cooling_set_point_fahrenheit: {
|
|
15251
|
-
description: '
|
|
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.',
|
|
15252
15520
|
format: 'float',
|
|
15253
15521
|
type: 'number',
|
|
15254
15522
|
},
|
|
15255
15523
|
device_id: {
|
|
15256
|
-
description: 'ID of the thermostat device.',
|
|
15524
|
+
description: 'ID of the desired thermostat device.',
|
|
15257
15525
|
format: 'uuid',
|
|
15258
15526
|
type: 'string',
|
|
15259
15527
|
},
|
|
15260
15528
|
heating_set_point_celsius: {
|
|
15261
|
-
description: '
|
|
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.',
|
|
15262
15530
|
format: 'float',
|
|
15263
15531
|
type: 'number',
|
|
15264
15532
|
},
|
|
15265
15533
|
heating_set_point_fahrenheit: {
|
|
15266
|
-
description: '
|
|
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.',
|
|
15267
15535
|
format: 'float',
|
|
15268
15536
|
type: 'number',
|
|
15269
15537
|
},
|
|
15270
|
-
sync: {
|
|
15538
|
+
sync: {
|
|
15539
|
+
default: false,
|
|
15540
|
+
type: 'boolean',
|
|
15541
|
+
'x-undocumented': 'Only used internally.',
|
|
15542
|
+
},
|
|
15271
15543
|
},
|
|
15272
15544
|
required: ['device_id'],
|
|
15273
15545
|
type: 'object',
|
|
@@ -15313,35 +15585,47 @@ export default {
|
|
|
15313
15585
|
},
|
|
15314
15586
|
'/thermostats/list': {
|
|
15315
15587
|
post: {
|
|
15316
|
-
description: 'Returns a list of thermostats
|
|
15588
|
+
description: 'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
15317
15589
|
operationId: 'thermostatsListPost',
|
|
15318
15590
|
requestBody: {
|
|
15319
15591
|
content: {
|
|
15320
15592
|
'application/json': {
|
|
15321
15593
|
schema: {
|
|
15322
15594
|
properties: {
|
|
15323
|
-
connect_webview_id: {
|
|
15595
|
+
connect_webview_id: {
|
|
15596
|
+
description: 'ID of the Connect Webview by which to filter devices.',
|
|
15597
|
+
format: 'uuid',
|
|
15598
|
+
type: 'string',
|
|
15599
|
+
},
|
|
15324
15600
|
connected_account_id: {
|
|
15325
|
-
description: '
|
|
15601
|
+
description: 'ID of the connected account by which to filter.',
|
|
15326
15602
|
format: 'uuid',
|
|
15327
15603
|
type: 'string',
|
|
15328
15604
|
},
|
|
15329
15605
|
connected_account_ids: {
|
|
15606
|
+
description: 'Array of IDs of the connected accounts by which to filter devices.',
|
|
15330
15607
|
items: { format: 'uuid', type: 'string' },
|
|
15331
15608
|
type: 'array',
|
|
15332
15609
|
},
|
|
15333
|
-
created_before: {
|
|
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
|
+
},
|
|
15334
15615
|
custom_metadata_has: {
|
|
15335
15616
|
additionalProperties: {
|
|
15336
15617
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15337
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.',
|
|
15338
15620
|
type: 'object',
|
|
15339
15621
|
},
|
|
15340
15622
|
device_ids: {
|
|
15623
|
+
description: 'Array of device IDs by which to filter devices.',
|
|
15341
15624
|
items: { format: 'uuid', type: 'string' },
|
|
15342
15625
|
type: 'array',
|
|
15343
15626
|
},
|
|
15344
15627
|
device_type: {
|
|
15628
|
+
description: 'Device type by which to filter devices.',
|
|
15345
15629
|
oneOf: [
|
|
15346
15630
|
{
|
|
15347
15631
|
enum: [
|
|
@@ -15398,6 +15682,7 @@ export default {
|
|
|
15398
15682
|
],
|
|
15399
15683
|
},
|
|
15400
15684
|
device_types: {
|
|
15685
|
+
description: 'Array of device types by which to filter devices.',
|
|
15401
15686
|
items: {
|
|
15402
15687
|
oneOf: [
|
|
15403
15688
|
{
|
|
@@ -15477,6 +15762,7 @@ export default {
|
|
|
15477
15762
|
type: 'string',
|
|
15478
15763
|
},
|
|
15479
15764
|
type: 'array',
|
|
15765
|
+
'x-undocumented': 'Only used internally.',
|
|
15480
15766
|
},
|
|
15481
15767
|
include_if: {
|
|
15482
15768
|
items: {
|
|
@@ -15496,9 +15782,16 @@ export default {
|
|
|
15496
15782
|
type: 'string',
|
|
15497
15783
|
},
|
|
15498
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',
|
|
15499
15792
|
},
|
|
15500
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
15501
15793
|
manufacturer: {
|
|
15794
|
+
description: 'Manufacturer by which to filter devices.',
|
|
15502
15795
|
enum: [
|
|
15503
15796
|
'akuvox',
|
|
15504
15797
|
'august',
|
|
@@ -15538,7 +15831,10 @@ export default {
|
|
|
15538
15831
|
],
|
|
15539
15832
|
type: 'string',
|
|
15540
15833
|
},
|
|
15541
|
-
user_identifier_key: {
|
|
15834
|
+
user_identifier_key: {
|
|
15835
|
+
description: 'Your own internal user ID for the user by which to filter devices.',
|
|
15836
|
+
type: 'string',
|
|
15837
|
+
},
|
|
15542
15838
|
},
|
|
15543
15839
|
type: 'object',
|
|
15544
15840
|
},
|
|
@@ -15588,7 +15884,7 @@ export default {
|
|
|
15588
15884
|
},
|
|
15589
15885
|
'/thermostats/off': {
|
|
15590
15886
|
post: {
|
|
15591
|
-
description: 'Sets a thermostat to "off" mode
|
|
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).',
|
|
15592
15888
|
operationId: 'thermostatsOffPost',
|
|
15593
15889
|
requestBody: {
|
|
15594
15890
|
content: {
|
|
@@ -15596,11 +15892,15 @@ export default {
|
|
|
15596
15892
|
schema: {
|
|
15597
15893
|
properties: {
|
|
15598
15894
|
device_id: {
|
|
15599
|
-
description: 'ID of the thermostat device.',
|
|
15895
|
+
description: 'ID of the desired thermostat device.',
|
|
15600
15896
|
format: 'uuid',
|
|
15601
15897
|
type: 'string',
|
|
15602
15898
|
},
|
|
15603
|
-
sync: {
|
|
15899
|
+
sync: {
|
|
15900
|
+
default: false,
|
|
15901
|
+
type: 'boolean',
|
|
15902
|
+
'x-undocumented': 'Only used internally.',
|
|
15903
|
+
},
|
|
15604
15904
|
},
|
|
15605
15905
|
required: ['device_id'],
|
|
15606
15906
|
type: 'object',
|
|
@@ -15646,22 +15946,39 @@ export default {
|
|
|
15646
15946
|
},
|
|
15647
15947
|
'/thermostats/schedules/create': {
|
|
15648
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).',
|
|
15649
15950
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
15650
15951
|
requestBody: {
|
|
15651
15952
|
content: {
|
|
15652
15953
|
'application/json': {
|
|
15653
15954
|
schema: {
|
|
15654
15955
|
properties: {
|
|
15655
|
-
climate_preset_key: {
|
|
15656
|
-
|
|
15657
|
-
|
|
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
|
+
},
|
|
15658
15968
|
max_override_period_minutes: {
|
|
15659
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).",
|
|
15660
15971
|
minimum: 0,
|
|
15661
15972
|
type: 'integer',
|
|
15662
15973
|
},
|
|
15663
|
-
name: {
|
|
15664
|
-
|
|
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
|
+
},
|
|
15665
15982
|
},
|
|
15666
15983
|
required: [
|
|
15667
15984
|
'device_id',
|
|
@@ -15707,17 +16024,23 @@ export default {
|
|
|
15707
16024
|
'x-fern-sdk-method-name': 'create',
|
|
15708
16025
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
15709
16026
|
'x-response-key': 'thermostat_schedule',
|
|
16027
|
+
'x-title': 'Create a Climate Schedule',
|
|
15710
16028
|
},
|
|
15711
16029
|
},
|
|
15712
16030
|
'/thermostats/schedules/delete': {
|
|
15713
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).',
|
|
15714
16033
|
operationId: 'thermostatsSchedulesDeletePost',
|
|
15715
16034
|
requestBody: {
|
|
15716
16035
|
content: {
|
|
15717
16036
|
'application/json': {
|
|
15718
16037
|
schema: {
|
|
15719
16038
|
properties: {
|
|
15720
|
-
thermostat_schedule_id: {
|
|
16039
|
+
thermostat_schedule_id: {
|
|
16040
|
+
description: 'ID of the desired climate schedule.',
|
|
16041
|
+
format: 'uuid',
|
|
16042
|
+
type: 'string',
|
|
16043
|
+
},
|
|
15721
16044
|
},
|
|
15722
16045
|
required: ['thermostat_schedule_id'],
|
|
15723
16046
|
type: 'object',
|
|
@@ -15752,17 +16075,23 @@ export default {
|
|
|
15752
16075
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
15753
16076
|
'x-fern-sdk-method-name': 'delete',
|
|
15754
16077
|
'x-response-key': null,
|
|
16078
|
+
'x-title': 'Delete a Climate Schedule',
|
|
15755
16079
|
},
|
|
15756
16080
|
},
|
|
15757
16081
|
'/thermostats/schedules/get': {
|
|
15758
16082
|
post: {
|
|
16083
|
+
description: 'Returns a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
15759
16084
|
operationId: 'thermostatsSchedulesGetPost',
|
|
15760
16085
|
requestBody: {
|
|
15761
16086
|
content: {
|
|
15762
16087
|
'application/json': {
|
|
15763
16088
|
schema: {
|
|
15764
16089
|
properties: {
|
|
15765
|
-
thermostat_schedule_id: {
|
|
16090
|
+
thermostat_schedule_id: {
|
|
16091
|
+
description: 'ID of the desired climate schedule.',
|
|
16092
|
+
format: 'uuid',
|
|
16093
|
+
type: 'string',
|
|
16094
|
+
},
|
|
15766
16095
|
},
|
|
15767
16096
|
required: ['thermostat_schedule_id'],
|
|
15768
16097
|
type: 'object',
|
|
@@ -15803,18 +16132,27 @@ export default {
|
|
|
15803
16132
|
'x-fern-sdk-method-name': 'get',
|
|
15804
16133
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
15805
16134
|
'x-response-key': 'thermostat_schedule',
|
|
16135
|
+
'x-title': 'Get a Climate Schedule',
|
|
15806
16136
|
},
|
|
15807
16137
|
},
|
|
15808
16138
|
'/thermostats/schedules/list': {
|
|
15809
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).',
|
|
15810
16141
|
operationId: 'thermostatsSchedulesListPost',
|
|
15811
16142
|
requestBody: {
|
|
15812
16143
|
content: {
|
|
15813
16144
|
'application/json': {
|
|
15814
16145
|
schema: {
|
|
15815
16146
|
properties: {
|
|
15816
|
-
device_id: {
|
|
15817
|
-
|
|
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
|
+
},
|
|
15818
16156
|
},
|
|
15819
16157
|
required: ['device_id'],
|
|
15820
16158
|
type: 'object',
|
|
@@ -15858,22 +16196,44 @@ export default {
|
|
|
15858
16196
|
'x-fern-sdk-method-name': 'list',
|
|
15859
16197
|
'x-fern-sdk-return-value': 'thermostat_schedules',
|
|
15860
16198
|
'x-response-key': 'thermostat_schedules',
|
|
16199
|
+
'x-title': 'List Climate Schedules',
|
|
15861
16200
|
},
|
|
15862
16201
|
},
|
|
15863
16202
|
'/thermostats/schedules/update': {
|
|
15864
16203
|
patch: {
|
|
16204
|
+
description: 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
15865
16205
|
operationId: 'thermostatsSchedulesUpdatePatch',
|
|
15866
16206
|
requestBody: {
|
|
15867
16207
|
content: {
|
|
15868
16208
|
'application/json': {
|
|
15869
16209
|
schema: {
|
|
15870
16210
|
properties: {
|
|
15871
|
-
climate_preset_key: {
|
|
15872
|
-
|
|
15873
|
-
|
|
15874
|
-
|
|
15875
|
-
|
|
15876
|
-
|
|
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
|
+
},
|
|
15877
16237
|
},
|
|
15878
16238
|
required: ['thermostat_schedule_id'],
|
|
15879
16239
|
type: 'object',
|
|
@@ -15907,20 +16267,42 @@ export default {
|
|
|
15907
16267
|
tags: ['/thermostats'],
|
|
15908
16268
|
'x-fern-ignore': true,
|
|
15909
16269
|
'x-response-key': null,
|
|
16270
|
+
'x-title': 'Update a Climate Schedule',
|
|
15910
16271
|
},
|
|
15911
16272
|
post: {
|
|
16273
|
+
description: 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
15912
16274
|
operationId: 'thermostatsSchedulesUpdatePost',
|
|
15913
16275
|
requestBody: {
|
|
15914
16276
|
content: {
|
|
15915
16277
|
'application/json': {
|
|
15916
16278
|
schema: {
|
|
15917
16279
|
properties: {
|
|
15918
|
-
climate_preset_key: {
|
|
15919
|
-
|
|
15920
|
-
|
|
15921
|
-
|
|
15922
|
-
|
|
15923
|
-
|
|
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
|
+
},
|
|
15924
16306
|
},
|
|
15925
16307
|
required: ['thermostat_schedule_id'],
|
|
15926
16308
|
type: 'object',
|
|
@@ -15955,18 +16337,27 @@ export default {
|
|
|
15955
16337
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
15956
16338
|
'x-fern-sdk-method-name': 'update',
|
|
15957
16339
|
'x-response-key': null,
|
|
16340
|
+
'x-title': 'Update a Climate Schedule',
|
|
15958
16341
|
},
|
|
15959
16342
|
},
|
|
15960
16343
|
'/thermostats/set_fallback_climate_preset': {
|
|
15961
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).',
|
|
15962
16346
|
operationId: 'thermostatsSetFallbackClimatePresetPost',
|
|
15963
16347
|
requestBody: {
|
|
15964
16348
|
content: {
|
|
15965
16349
|
'application/json': {
|
|
15966
16350
|
schema: {
|
|
15967
16351
|
properties: {
|
|
15968
|
-
climate_preset_key: {
|
|
15969
|
-
|
|
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
|
+
},
|
|
15970
16361
|
},
|
|
15971
16362
|
required: ['device_id', 'climate_preset_key'],
|
|
15972
16363
|
type: 'object',
|
|
@@ -16000,22 +16391,19 @@ export default {
|
|
|
16000
16391
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16001
16392
|
'x-fern-sdk-method-name': 'set_fallback_climate_preset',
|
|
16002
16393
|
'x-response-key': null,
|
|
16394
|
+
'x-title': 'Set the Fallback Climate Preset',
|
|
16003
16395
|
},
|
|
16004
16396
|
},
|
|
16005
16397
|
'/thermostats/set_fan_mode': {
|
|
16006
16398
|
post: {
|
|
16007
|
-
description: 'Sets the fan mode setting
|
|
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).',
|
|
16008
16400
|
operationId: 'thermostatsSetFanModePost',
|
|
16009
16401
|
requestBody: {
|
|
16010
16402
|
content: {
|
|
16011
16403
|
'application/json': {
|
|
16012
16404
|
schema: {
|
|
16013
16405
|
properties: {
|
|
16014
|
-
device_id: {
|
|
16015
|
-
description: 'ID of the thermostat device.',
|
|
16016
|
-
format: 'uuid',
|
|
16017
|
-
type: 'string',
|
|
16018
|
-
},
|
|
16406
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
16019
16407
|
fan_mode: {
|
|
16020
16408
|
deprecated: true,
|
|
16021
16409
|
enum: ['auto', 'on', 'circulate'],
|
|
@@ -16023,11 +16411,15 @@ export default {
|
|
|
16023
16411
|
'x-deprecated': 'Use `fan_mode_setting` instead.',
|
|
16024
16412
|
},
|
|
16025
16413
|
fan_mode_setting: {
|
|
16026
|
-
description: '
|
|
16414
|
+
description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
|
|
16027
16415
|
enum: ['auto', 'on', 'circulate'],
|
|
16028
16416
|
type: 'string',
|
|
16029
16417
|
},
|
|
16030
|
-
sync: {
|
|
16418
|
+
sync: {
|
|
16419
|
+
default: false,
|
|
16420
|
+
type: 'boolean',
|
|
16421
|
+
'x-undocumented': 'Only used internally.',
|
|
16422
|
+
},
|
|
16031
16423
|
},
|
|
16032
16424
|
required: ['device_id'],
|
|
16033
16425
|
type: 'object',
|
|
@@ -16068,38 +16460,47 @@ export default {
|
|
|
16068
16460
|
'x-fern-sdk-method-name': 'set_fan_mode',
|
|
16069
16461
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
16070
16462
|
'x-response-key': 'action_attempt',
|
|
16071
|
-
'x-title': 'Set Fan Mode Setting',
|
|
16463
|
+
'x-title': 'Set the Fan Mode Setting',
|
|
16072
16464
|
},
|
|
16073
16465
|
},
|
|
16074
16466
|
'/thermostats/set_temperature_threshold': {
|
|
16075
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.',
|
|
16076
16469
|
operationId: 'thermostatsSetTemperatureThresholdPatch',
|
|
16077
16470
|
requestBody: {
|
|
16078
16471
|
content: {
|
|
16079
16472
|
'application/json': {
|
|
16080
16473
|
schema: {
|
|
16081
16474
|
properties: {
|
|
16082
|
-
device_id: {
|
|
16475
|
+
device_id: {
|
|
16476
|
+
description: 'ID of the desired thermostat device.',
|
|
16477
|
+
format: 'uuid',
|
|
16478
|
+
type: 'string',
|
|
16479
|
+
},
|
|
16083
16480
|
lower_limit_celsius: {
|
|
16084
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.',
|
|
16085
16483
|
format: 'float',
|
|
16086
16484
|
nullable: true,
|
|
16087
16485
|
type: 'number',
|
|
16088
16486
|
},
|
|
16089
16487
|
lower_limit_fahrenheit: {
|
|
16090
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.',
|
|
16091
16490
|
format: 'float',
|
|
16092
16491
|
nullable: true,
|
|
16093
16492
|
type: 'number',
|
|
16094
16493
|
},
|
|
16095
16494
|
upper_limit_celsius: {
|
|
16096
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.',
|
|
16097
16497
|
format: 'float',
|
|
16098
16498
|
nullable: true,
|
|
16099
16499
|
type: 'number',
|
|
16100
16500
|
},
|
|
16101
16501
|
upper_limit_fahrenheit: {
|
|
16102
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.',
|
|
16103
16504
|
format: 'float',
|
|
16104
16505
|
nullable: true,
|
|
16105
16506
|
type: 'number',
|
|
@@ -16136,35 +16537,45 @@ export default {
|
|
|
16136
16537
|
tags: ['/thermostats'],
|
|
16137
16538
|
'x-fern-ignore': true,
|
|
16138
16539
|
'x-response-key': null,
|
|
16540
|
+
'x-title': 'Set a Temperature Threshold',
|
|
16139
16541
|
},
|
|
16140
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.',
|
|
16141
16544
|
operationId: 'thermostatsSetTemperatureThresholdPost',
|
|
16142
16545
|
requestBody: {
|
|
16143
16546
|
content: {
|
|
16144
16547
|
'application/json': {
|
|
16145
16548
|
schema: {
|
|
16146
16549
|
properties: {
|
|
16147
|
-
device_id: {
|
|
16550
|
+
device_id: {
|
|
16551
|
+
description: 'ID of the desired thermostat device.',
|
|
16552
|
+
format: 'uuid',
|
|
16553
|
+
type: 'string',
|
|
16554
|
+
},
|
|
16148
16555
|
lower_limit_celsius: {
|
|
16149
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.',
|
|
16150
16558
|
format: 'float',
|
|
16151
16559
|
nullable: true,
|
|
16152
16560
|
type: 'number',
|
|
16153
16561
|
},
|
|
16154
16562
|
lower_limit_fahrenheit: {
|
|
16155
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.',
|
|
16156
16565
|
format: 'float',
|
|
16157
16566
|
nullable: true,
|
|
16158
16567
|
type: 'number',
|
|
16159
16568
|
},
|
|
16160
16569
|
upper_limit_celsius: {
|
|
16161
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.',
|
|
16162
16572
|
format: 'float',
|
|
16163
16573
|
nullable: true,
|
|
16164
16574
|
type: 'number',
|
|
16165
16575
|
},
|
|
16166
16576
|
upper_limit_fahrenheit: {
|
|
16167
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.',
|
|
16168
16579
|
format: 'float',
|
|
16169
16580
|
nullable: true,
|
|
16170
16581
|
type: 'number',
|
|
@@ -16202,44 +16613,67 @@ export default {
|
|
|
16202
16613
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16203
16614
|
'x-fern-sdk-method-name': 'set_temperature_threshold',
|
|
16204
16615
|
'x-response-key': null,
|
|
16616
|
+
'x-title': 'Set a Temperature Threshold',
|
|
16205
16617
|
},
|
|
16206
16618
|
},
|
|
16207
16619
|
'/thermostats/update_climate_preset': {
|
|
16208
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).',
|
|
16209
16622
|
operationId: 'thermostatsUpdateClimatePresetPatch',
|
|
16210
16623
|
requestBody: {
|
|
16211
16624
|
content: {
|
|
16212
16625
|
'application/json': {
|
|
16213
16626
|
schema: {
|
|
16214
16627
|
properties: {
|
|
16215
|
-
climate_preset_key: {
|
|
16628
|
+
climate_preset_key: {
|
|
16629
|
+
description: 'Unique key to identify the climate preset.',
|
|
16630
|
+
type: 'string',
|
|
16631
|
+
},
|
|
16216
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).',
|
|
16217
16634
|
format: 'float',
|
|
16218
16635
|
type: 'number',
|
|
16219
16636
|
},
|
|
16220
16637
|
cooling_set_point_fahrenheit: {
|
|
16638
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
16221
16639
|
format: 'float',
|
|
16222
16640
|
type: 'number',
|
|
16223
16641
|
},
|
|
16224
|
-
device_id: {
|
|
16642
|
+
device_id: {
|
|
16643
|
+
description: 'ID of the desired thermostat device.',
|
|
16644
|
+
format: 'uuid',
|
|
16645
|
+
type: 'string',
|
|
16646
|
+
},
|
|
16225
16647
|
fan_mode_setting: {
|
|
16648
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
16226
16649
|
enum: ['auto', 'on', 'circulate'],
|
|
16227
16650
|
type: 'string',
|
|
16228
16651
|
},
|
|
16229
16652
|
heating_set_point_celsius: {
|
|
16653
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
16230
16654
|
format: 'float',
|
|
16231
16655
|
type: 'number',
|
|
16232
16656
|
},
|
|
16233
16657
|
heating_set_point_fahrenheit: {
|
|
16658
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
16234
16659
|
format: 'float',
|
|
16235
16660
|
type: 'number',
|
|
16236
16661
|
},
|
|
16237
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`.',
|
|
16238
16664
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
16239
16665
|
type: 'string',
|
|
16240
16666
|
},
|
|
16241
|
-
manual_override_allowed: {
|
|
16242
|
-
|
|
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
|
+
},
|
|
16243
16677
|
},
|
|
16244
16678
|
required: [
|
|
16245
16679
|
'device_id',
|
|
@@ -16276,42 +16710,65 @@ export default {
|
|
|
16276
16710
|
tags: ['/thermostats'],
|
|
16277
16711
|
'x-fern-ignore': true,
|
|
16278
16712
|
'x-response-key': null,
|
|
16713
|
+
'x-title': 'Update a Climate Preset',
|
|
16279
16714
|
},
|
|
16280
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).',
|
|
16281
16717
|
operationId: 'thermostatsUpdateClimatePresetPost',
|
|
16282
16718
|
requestBody: {
|
|
16283
16719
|
content: {
|
|
16284
16720
|
'application/json': {
|
|
16285
16721
|
schema: {
|
|
16286
16722
|
properties: {
|
|
16287
|
-
climate_preset_key: {
|
|
16723
|
+
climate_preset_key: {
|
|
16724
|
+
description: 'Unique key to identify the climate preset.',
|
|
16725
|
+
type: 'string',
|
|
16726
|
+
},
|
|
16288
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).',
|
|
16289
16729
|
format: 'float',
|
|
16290
16730
|
type: 'number',
|
|
16291
16731
|
},
|
|
16292
16732
|
cooling_set_point_fahrenheit: {
|
|
16733
|
+
description: 'Temperature to which the thermostat should cool (in °F).',
|
|
16293
16734
|
format: 'float',
|
|
16294
16735
|
type: 'number',
|
|
16295
16736
|
},
|
|
16296
|
-
device_id: {
|
|
16737
|
+
device_id: {
|
|
16738
|
+
description: 'ID of the desired thermostat device.',
|
|
16739
|
+
format: 'uuid',
|
|
16740
|
+
type: 'string',
|
|
16741
|
+
},
|
|
16297
16742
|
fan_mode_setting: {
|
|
16743
|
+
description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
16298
16744
|
enum: ['auto', 'on', 'circulate'],
|
|
16299
16745
|
type: 'string',
|
|
16300
16746
|
},
|
|
16301
16747
|
heating_set_point_celsius: {
|
|
16748
|
+
description: 'Temperature to which the thermostat should heat (in °C).',
|
|
16302
16749
|
format: 'float',
|
|
16303
16750
|
type: 'number',
|
|
16304
16751
|
},
|
|
16305
16752
|
heating_set_point_fahrenheit: {
|
|
16753
|
+
description: 'Temperature to which the thermostat should heat (in °F).',
|
|
16306
16754
|
format: 'float',
|
|
16307
16755
|
type: 'number',
|
|
16308
16756
|
},
|
|
16309
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`.',
|
|
16310
16759
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
16311
16760
|
type: 'string',
|
|
16312
16761
|
},
|
|
16313
|
-
manual_override_allowed: {
|
|
16314
|
-
|
|
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
|
+
},
|
|
16315
16772
|
},
|
|
16316
16773
|
required: [
|
|
16317
16774
|
'device_id',
|
|
@@ -16349,6 +16806,7 @@ export default {
|
|
|
16349
16806
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16350
16807
|
'x-fern-sdk-method-name': 'update_climate_preset',
|
|
16351
16808
|
'x-response-key': null,
|
|
16809
|
+
'x-title': 'Update a Climate Preset',
|
|
16352
16810
|
},
|
|
16353
16811
|
},
|
|
16354
16812
|
'/user_identities/add_acs_user': {
|