@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
|
@@ -4618,21 +4618,51 @@ export default {
|
|
|
4618
4618
|
default: null,
|
|
4619
4619
|
nullable: true,
|
|
4620
4620
|
properties: {
|
|
4621
|
-
climate_preset_key: {
|
|
4622
|
-
|
|
4623
|
-
|
|
4624
|
-
|
|
4621
|
+
climate_preset_key: {
|
|
4622
|
+
description:
|
|
4623
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
|
|
4624
|
+
type: 'string',
|
|
4625
|
+
},
|
|
4626
|
+
created_at: {
|
|
4627
|
+
description:
|
|
4628
|
+
'Date and time at which the climate schedule was created.',
|
|
4629
|
+
format: 'date-time',
|
|
4630
|
+
type: 'string',
|
|
4631
|
+
},
|
|
4632
|
+
device_id: {
|
|
4633
|
+
description: 'ID of the desired thermostat device.',
|
|
4634
|
+
format: 'uuid',
|
|
4635
|
+
type: 'string',
|
|
4636
|
+
},
|
|
4637
|
+
ends_at: {
|
|
4638
|
+
description:
|
|
4639
|
+
'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4640
|
+
format: 'date-time',
|
|
4641
|
+
type: 'string',
|
|
4642
|
+
},
|
|
4625
4643
|
errors: {
|
|
4626
4644
|
description:
|
|
4627
|
-
'
|
|
4645
|
+
'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.',
|
|
4628
4646
|
},
|
|
4629
4647
|
max_override_period_minutes: {
|
|
4648
|
+
description:
|
|
4649
|
+
"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).",
|
|
4630
4650
|
minimum: 0,
|
|
4631
4651
|
type: 'integer',
|
|
4632
4652
|
},
|
|
4633
|
-
name: {
|
|
4634
|
-
|
|
4653
|
+
name: {
|
|
4654
|
+
description:
|
|
4655
|
+
'User-friendly name to identify the climate schedule.',
|
|
4656
|
+
type: 'string',
|
|
4657
|
+
},
|
|
4658
|
+
starts_at: {
|
|
4659
|
+
description:
|
|
4660
|
+
'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4661
|
+
format: 'date-time',
|
|
4662
|
+
type: 'string',
|
|
4663
|
+
},
|
|
4635
4664
|
thermostat_schedule_id: {
|
|
4665
|
+
description: 'ID of the climate schedule.',
|
|
4636
4666
|
format: 'uuid',
|
|
4637
4667
|
type: 'string',
|
|
4638
4668
|
},
|
|
@@ -4651,37 +4681,71 @@ export default {
|
|
|
4651
4681
|
available_climate_presets: {
|
|
4652
4682
|
items: {
|
|
4653
4683
|
properties: {
|
|
4654
|
-
can_delete: {
|
|
4655
|
-
|
|
4656
|
-
|
|
4684
|
+
can_delete: {
|
|
4685
|
+
description:
|
|
4686
|
+
'Indicates whether this climate preset key can be deleted.',
|
|
4687
|
+
type: 'boolean',
|
|
4688
|
+
},
|
|
4689
|
+
can_edit: {
|
|
4690
|
+
description:
|
|
4691
|
+
'Indicates whether this climate preset key can be edited.',
|
|
4692
|
+
type: 'boolean',
|
|
4693
|
+
},
|
|
4694
|
+
climate_preset_key: {
|
|
4695
|
+
description:
|
|
4696
|
+
'Unique key to identify the climate preset.',
|
|
4697
|
+
type: 'string',
|
|
4698
|
+
},
|
|
4657
4699
|
cooling_set_point_celsius: {
|
|
4700
|
+
description:
|
|
4701
|
+
'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).',
|
|
4658
4702
|
format: 'float',
|
|
4659
4703
|
type: 'number',
|
|
4660
4704
|
},
|
|
4661
4705
|
cooling_set_point_fahrenheit: {
|
|
4706
|
+
description:
|
|
4707
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
4662
4708
|
format: 'float',
|
|
4663
4709
|
type: 'number',
|
|
4664
4710
|
},
|
|
4665
|
-
display_name: {
|
|
4711
|
+
display_name: {
|
|
4712
|
+
description:
|
|
4713
|
+
'Display name for the climate preset.',
|
|
4714
|
+
type: 'string',
|
|
4715
|
+
},
|
|
4666
4716
|
fan_mode_setting: {
|
|
4717
|
+
description:
|
|
4718
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4667
4719
|
enum: ['auto', 'on', 'circulate'],
|
|
4668
4720
|
type: 'string',
|
|
4669
4721
|
},
|
|
4670
4722
|
heating_set_point_celsius: {
|
|
4723
|
+
description:
|
|
4724
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
4671
4725
|
format: 'float',
|
|
4672
4726
|
type: 'number',
|
|
4673
4727
|
},
|
|
4674
4728
|
heating_set_point_fahrenheit: {
|
|
4729
|
+
description:
|
|
4730
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
4675
4731
|
format: 'float',
|
|
4676
4732
|
type: 'number',
|
|
4677
4733
|
},
|
|
4678
4734
|
hvac_mode_setting: {
|
|
4735
|
+
description:
|
|
4736
|
+
'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`.',
|
|
4679
4737
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4680
4738
|
type: 'string',
|
|
4681
4739
|
},
|
|
4682
|
-
manual_override_allowed: {
|
|
4740
|
+
manual_override_allowed: {
|
|
4741
|
+
description:
|
|
4742
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4743
|
+
type: 'boolean',
|
|
4744
|
+
},
|
|
4683
4745
|
name: {
|
|
4684
4746
|
default: null,
|
|
4747
|
+
description:
|
|
4748
|
+
'User-friendly name to identify the climate preset.',
|
|
4685
4749
|
nullable: true,
|
|
4686
4750
|
type: 'string',
|
|
4687
4751
|
},
|
|
@@ -4713,37 +4777,70 @@ export default {
|
|
|
4713
4777
|
},
|
|
4714
4778
|
current_climate_setting: {
|
|
4715
4779
|
properties: {
|
|
4716
|
-
can_delete: {
|
|
4717
|
-
|
|
4718
|
-
|
|
4780
|
+
can_delete: {
|
|
4781
|
+
description:
|
|
4782
|
+
'Indicates whether this climate preset key can be deleted.',
|
|
4783
|
+
type: 'boolean',
|
|
4784
|
+
},
|
|
4785
|
+
can_edit: {
|
|
4786
|
+
description:
|
|
4787
|
+
'Indicates whether this climate preset key can be edited.',
|
|
4788
|
+
type: 'boolean',
|
|
4789
|
+
},
|
|
4790
|
+
climate_preset_key: {
|
|
4791
|
+
description:
|
|
4792
|
+
'Unique key to identify the climate preset.',
|
|
4793
|
+
type: 'string',
|
|
4794
|
+
},
|
|
4719
4795
|
cooling_set_point_celsius: {
|
|
4796
|
+
description:
|
|
4797
|
+
'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).',
|
|
4720
4798
|
format: 'float',
|
|
4721
4799
|
type: 'number',
|
|
4722
4800
|
},
|
|
4723
4801
|
cooling_set_point_fahrenheit: {
|
|
4802
|
+
description:
|
|
4803
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
4724
4804
|
format: 'float',
|
|
4725
4805
|
type: 'number',
|
|
4726
4806
|
},
|
|
4727
|
-
display_name: {
|
|
4807
|
+
display_name: {
|
|
4808
|
+
description: 'Display name for the climate preset.',
|
|
4809
|
+
type: 'string',
|
|
4810
|
+
},
|
|
4728
4811
|
fan_mode_setting: {
|
|
4812
|
+
description:
|
|
4813
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4729
4814
|
enum: ['auto', 'on', 'circulate'],
|
|
4730
4815
|
type: 'string',
|
|
4731
4816
|
},
|
|
4732
4817
|
heating_set_point_celsius: {
|
|
4818
|
+
description:
|
|
4819
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
4733
4820
|
format: 'float',
|
|
4734
4821
|
type: 'number',
|
|
4735
4822
|
},
|
|
4736
4823
|
heating_set_point_fahrenheit: {
|
|
4824
|
+
description:
|
|
4825
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
4737
4826
|
format: 'float',
|
|
4738
4827
|
type: 'number',
|
|
4739
4828
|
},
|
|
4740
4829
|
hvac_mode_setting: {
|
|
4830
|
+
description:
|
|
4831
|
+
'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`.',
|
|
4741
4832
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4742
4833
|
type: 'string',
|
|
4743
4834
|
},
|
|
4744
|
-
manual_override_allowed: {
|
|
4835
|
+
manual_override_allowed: {
|
|
4836
|
+
description:
|
|
4837
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4838
|
+
type: 'boolean',
|
|
4839
|
+
},
|
|
4745
4840
|
name: {
|
|
4746
4841
|
default: null,
|
|
4842
|
+
description:
|
|
4843
|
+
'User-friendly name to identify the climate preset.',
|
|
4747
4844
|
nullable: true,
|
|
4748
4845
|
type: 'string',
|
|
4749
4846
|
},
|
|
@@ -4753,37 +4850,70 @@ export default {
|
|
|
4753
4850
|
default_climate_setting: {
|
|
4754
4851
|
deprecated: true,
|
|
4755
4852
|
properties: {
|
|
4756
|
-
can_delete: {
|
|
4757
|
-
|
|
4758
|
-
|
|
4853
|
+
can_delete: {
|
|
4854
|
+
description:
|
|
4855
|
+
'Indicates whether this climate preset key can be deleted.',
|
|
4856
|
+
type: 'boolean',
|
|
4857
|
+
},
|
|
4858
|
+
can_edit: {
|
|
4859
|
+
description:
|
|
4860
|
+
'Indicates whether this climate preset key can be edited.',
|
|
4861
|
+
type: 'boolean',
|
|
4862
|
+
},
|
|
4863
|
+
climate_preset_key: {
|
|
4864
|
+
description:
|
|
4865
|
+
'Unique key to identify the climate preset.',
|
|
4866
|
+
type: 'string',
|
|
4867
|
+
},
|
|
4759
4868
|
cooling_set_point_celsius: {
|
|
4869
|
+
description:
|
|
4870
|
+
'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).',
|
|
4760
4871
|
format: 'float',
|
|
4761
4872
|
type: 'number',
|
|
4762
4873
|
},
|
|
4763
4874
|
cooling_set_point_fahrenheit: {
|
|
4875
|
+
description:
|
|
4876
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
4764
4877
|
format: 'float',
|
|
4765
4878
|
type: 'number',
|
|
4766
4879
|
},
|
|
4767
|
-
display_name: {
|
|
4880
|
+
display_name: {
|
|
4881
|
+
description: 'Display name for the climate preset.',
|
|
4882
|
+
type: 'string',
|
|
4883
|
+
},
|
|
4768
4884
|
fan_mode_setting: {
|
|
4885
|
+
description:
|
|
4886
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
4769
4887
|
enum: ['auto', 'on', 'circulate'],
|
|
4770
4888
|
type: 'string',
|
|
4771
4889
|
},
|
|
4772
4890
|
heating_set_point_celsius: {
|
|
4891
|
+
description:
|
|
4892
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
4773
4893
|
format: 'float',
|
|
4774
4894
|
type: 'number',
|
|
4775
4895
|
},
|
|
4776
4896
|
heating_set_point_fahrenheit: {
|
|
4897
|
+
description:
|
|
4898
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
4777
4899
|
format: 'float',
|
|
4778
4900
|
type: 'number',
|
|
4779
4901
|
},
|
|
4780
4902
|
hvac_mode_setting: {
|
|
4903
|
+
description:
|
|
4904
|
+
'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`.',
|
|
4781
4905
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
4782
4906
|
type: 'string',
|
|
4783
4907
|
},
|
|
4784
|
-
manual_override_allowed: {
|
|
4908
|
+
manual_override_allowed: {
|
|
4909
|
+
description:
|
|
4910
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
4911
|
+
type: 'boolean',
|
|
4912
|
+
},
|
|
4785
4913
|
name: {
|
|
4786
4914
|
default: null,
|
|
4915
|
+
description:
|
|
4916
|
+
'User-friendly name to identify the climate preset.',
|
|
4787
4917
|
nullable: true,
|
|
4788
4918
|
type: 'string',
|
|
4789
4919
|
},
|
|
@@ -5288,18 +5418,53 @@ export default {
|
|
|
5288
5418
|
},
|
|
5289
5419
|
thermostat_schedule: {
|
|
5290
5420
|
properties: {
|
|
5291
|
-
climate_preset_key: {
|
|
5292
|
-
|
|
5293
|
-
|
|
5294
|
-
|
|
5421
|
+
climate_preset_key: {
|
|
5422
|
+
description:
|
|
5423
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
|
|
5424
|
+
type: 'string',
|
|
5425
|
+
},
|
|
5426
|
+
created_at: {
|
|
5427
|
+
description:
|
|
5428
|
+
'Date and time at which the climate schedule was created.',
|
|
5429
|
+
format: 'date-time',
|
|
5430
|
+
type: 'string',
|
|
5431
|
+
},
|
|
5432
|
+
device_id: {
|
|
5433
|
+
description: 'ID of the desired thermostat device.',
|
|
5434
|
+
format: 'uuid',
|
|
5435
|
+
type: 'string',
|
|
5436
|
+
},
|
|
5437
|
+
ends_at: {
|
|
5438
|
+
description:
|
|
5439
|
+
'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5440
|
+
format: 'date-time',
|
|
5441
|
+
type: 'string',
|
|
5442
|
+
},
|
|
5295
5443
|
errors: {
|
|
5296
5444
|
description:
|
|
5297
|
-
'
|
|
5445
|
+
'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.',
|
|
5446
|
+
},
|
|
5447
|
+
max_override_period_minutes: {
|
|
5448
|
+
description:
|
|
5449
|
+
"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).",
|
|
5450
|
+
minimum: 0,
|
|
5451
|
+
type: 'integer',
|
|
5452
|
+
},
|
|
5453
|
+
name: {
|
|
5454
|
+
description: 'User-friendly name to identify the climate schedule.',
|
|
5455
|
+
type: 'string',
|
|
5456
|
+
},
|
|
5457
|
+
starts_at: {
|
|
5458
|
+
description:
|
|
5459
|
+
'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5460
|
+
format: 'date-time',
|
|
5461
|
+
type: 'string',
|
|
5462
|
+
},
|
|
5463
|
+
thermostat_schedule_id: {
|
|
5464
|
+
description: 'ID of the climate schedule.',
|
|
5465
|
+
format: 'uuid',
|
|
5466
|
+
type: 'string',
|
|
5298
5467
|
},
|
|
5299
|
-
max_override_period_minutes: { minimum: 0, type: 'integer' },
|
|
5300
|
-
name: { type: 'string' },
|
|
5301
|
-
starts_at: { format: 'date-time', type: 'string' },
|
|
5302
|
-
thermostat_schedule_id: { format: 'uuid', type: 'string' },
|
|
5303
5468
|
},
|
|
5304
5469
|
required: [
|
|
5305
5470
|
'thermostat_schedule_id',
|
|
@@ -12672,35 +12837,54 @@ export default {
|
|
|
12672
12837
|
},
|
|
12673
12838
|
'/devices/list': {
|
|
12674
12839
|
post: {
|
|
12840
|
+
description:
|
|
12841
|
+
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
|
|
12675
12842
|
operationId: 'devicesListPost',
|
|
12676
12843
|
requestBody: {
|
|
12677
12844
|
content: {
|
|
12678
12845
|
'application/json': {
|
|
12679
12846
|
schema: {
|
|
12680
12847
|
properties: {
|
|
12681
|
-
connect_webview_id: {
|
|
12848
|
+
connect_webview_id: {
|
|
12849
|
+
description:
|
|
12850
|
+
'ID of the Connect Webview by which to filter devices.',
|
|
12851
|
+
format: 'uuid',
|
|
12852
|
+
type: 'string',
|
|
12853
|
+
},
|
|
12682
12854
|
connected_account_id: {
|
|
12683
12855
|
description:
|
|
12684
|
-
'
|
|
12856
|
+
'ID of the connected account by which to filter.',
|
|
12685
12857
|
format: 'uuid',
|
|
12686
12858
|
type: 'string',
|
|
12687
12859
|
},
|
|
12688
12860
|
connected_account_ids: {
|
|
12861
|
+
description:
|
|
12862
|
+
'Array of IDs of the connected accounts by which to filter devices.',
|
|
12689
12863
|
items: { format: 'uuid', type: 'string' },
|
|
12690
12864
|
type: 'array',
|
|
12691
12865
|
},
|
|
12692
|
-
created_before: {
|
|
12866
|
+
created_before: {
|
|
12867
|
+
description:
|
|
12868
|
+
'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
|
|
12869
|
+
format: 'date-time',
|
|
12870
|
+
type: 'string',
|
|
12871
|
+
},
|
|
12693
12872
|
custom_metadata_has: {
|
|
12694
12873
|
additionalProperties: {
|
|
12695
12874
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
12696
12875
|
},
|
|
12876
|
+
description:
|
|
12877
|
+
'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.',
|
|
12697
12878
|
type: 'object',
|
|
12698
12879
|
},
|
|
12699
12880
|
device_ids: {
|
|
12881
|
+
description:
|
|
12882
|
+
'Array of device IDs by which to filter devices.',
|
|
12700
12883
|
items: { format: 'uuid', type: 'string' },
|
|
12701
12884
|
type: 'array',
|
|
12702
12885
|
},
|
|
12703
12886
|
device_type: {
|
|
12887
|
+
description: 'Device type by which to filter devices.',
|
|
12704
12888
|
oneOf: [
|
|
12705
12889
|
{
|
|
12706
12890
|
enum: [
|
|
@@ -12757,6 +12941,8 @@ export default {
|
|
|
12757
12941
|
],
|
|
12758
12942
|
},
|
|
12759
12943
|
device_types: {
|
|
12944
|
+
description:
|
|
12945
|
+
'Array of device types by which to filter devices.',
|
|
12760
12946
|
items: {
|
|
12761
12947
|
oneOf: [
|
|
12762
12948
|
{
|
|
@@ -12836,6 +13022,7 @@ export default {
|
|
|
12836
13022
|
type: 'string',
|
|
12837
13023
|
},
|
|
12838
13024
|
type: 'array',
|
|
13025
|
+
'x-undocumented': 'Only used internally.',
|
|
12839
13026
|
},
|
|
12840
13027
|
include_if: {
|
|
12841
13028
|
items: {
|
|
@@ -12855,9 +13042,17 @@ export default {
|
|
|
12855
13042
|
type: 'string',
|
|
12856
13043
|
},
|
|
12857
13044
|
type: 'array',
|
|
13045
|
+
'x-undocumented': 'Only used internally.',
|
|
13046
|
+
},
|
|
13047
|
+
limit: {
|
|
13048
|
+
default: 500,
|
|
13049
|
+
description:
|
|
13050
|
+
'Numerical limit on the number of devices to return.',
|
|
13051
|
+
format: 'float',
|
|
13052
|
+
type: 'number',
|
|
12858
13053
|
},
|
|
12859
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
12860
13054
|
manufacturer: {
|
|
13055
|
+
description: 'Manufacturer by which to filter devices.',
|
|
12861
13056
|
enum: [
|
|
12862
13057
|
'akuvox',
|
|
12863
13058
|
'august',
|
|
@@ -12897,7 +13092,11 @@ export default {
|
|
|
12897
13092
|
],
|
|
12898
13093
|
type: 'string',
|
|
12899
13094
|
},
|
|
12900
|
-
user_identifier_key: {
|
|
13095
|
+
user_identifier_key: {
|
|
13096
|
+
description:
|
|
13097
|
+
'Your own internal user ID for the user by which to filter devices.',
|
|
13098
|
+
type: 'string',
|
|
13099
|
+
},
|
|
12901
13100
|
},
|
|
12902
13101
|
type: 'object',
|
|
12903
13102
|
},
|
|
@@ -12938,6 +13137,7 @@ export default {
|
|
|
12938
13137
|
'x-fern-sdk-method-name': 'list',
|
|
12939
13138
|
'x-fern-sdk-return-value': 'devices',
|
|
12940
13139
|
'x-response-key': 'devices',
|
|
13140
|
+
'x-title': 'List Devices',
|
|
12941
13141
|
},
|
|
12942
13142
|
},
|
|
12943
13143
|
'/devices/list_device_providers': {
|
|
@@ -13183,29 +13383,46 @@ export default {
|
|
|
13183
13383
|
'application/json': {
|
|
13184
13384
|
schema: {
|
|
13185
13385
|
properties: {
|
|
13186
|
-
connect_webview_id: {
|
|
13386
|
+
connect_webview_id: {
|
|
13387
|
+
description:
|
|
13388
|
+
'ID of the Connect Webview by which to filter devices.',
|
|
13389
|
+
format: 'uuid',
|
|
13390
|
+
type: 'string',
|
|
13391
|
+
},
|
|
13187
13392
|
connected_account_id: {
|
|
13188
13393
|
description:
|
|
13189
|
-
'
|
|
13394
|
+
'ID of the connected account by which to filter.',
|
|
13190
13395
|
format: 'uuid',
|
|
13191
13396
|
type: 'string',
|
|
13192
13397
|
},
|
|
13193
13398
|
connected_account_ids: {
|
|
13399
|
+
description:
|
|
13400
|
+
'Array of IDs of the connected accounts by which to filter devices.',
|
|
13194
13401
|
items: { format: 'uuid', type: 'string' },
|
|
13195
13402
|
type: 'array',
|
|
13196
13403
|
},
|
|
13197
|
-
created_before: {
|
|
13404
|
+
created_before: {
|
|
13405
|
+
description:
|
|
13406
|
+
'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
|
|
13407
|
+
format: 'date-time',
|
|
13408
|
+
type: 'string',
|
|
13409
|
+
},
|
|
13198
13410
|
custom_metadata_has: {
|
|
13199
13411
|
additionalProperties: {
|
|
13200
13412
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
13201
13413
|
},
|
|
13414
|
+
description:
|
|
13415
|
+
'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.',
|
|
13202
13416
|
type: 'object',
|
|
13203
13417
|
},
|
|
13204
13418
|
device_ids: {
|
|
13419
|
+
description:
|
|
13420
|
+
'Array of device IDs by which to filter devices.',
|
|
13205
13421
|
items: { format: 'uuid', type: 'string' },
|
|
13206
13422
|
type: 'array',
|
|
13207
13423
|
},
|
|
13208
13424
|
device_type: {
|
|
13425
|
+
description: 'Device type by which to filter devices.',
|
|
13209
13426
|
oneOf: [
|
|
13210
13427
|
{
|
|
13211
13428
|
enum: [
|
|
@@ -13262,6 +13479,8 @@ export default {
|
|
|
13262
13479
|
],
|
|
13263
13480
|
},
|
|
13264
13481
|
device_types: {
|
|
13482
|
+
description:
|
|
13483
|
+
'Array of device types by which to filter devices.',
|
|
13265
13484
|
items: {
|
|
13266
13485
|
oneOf: [
|
|
13267
13486
|
{
|
|
@@ -13341,6 +13560,7 @@ export default {
|
|
|
13341
13560
|
type: 'string',
|
|
13342
13561
|
},
|
|
13343
13562
|
type: 'array',
|
|
13563
|
+
'x-undocumented': 'Only used internally.',
|
|
13344
13564
|
},
|
|
13345
13565
|
include_if: {
|
|
13346
13566
|
items: {
|
|
@@ -13360,9 +13580,17 @@ export default {
|
|
|
13360
13580
|
type: 'string',
|
|
13361
13581
|
},
|
|
13362
13582
|
type: 'array',
|
|
13583
|
+
'x-undocumented': 'Only used internally.',
|
|
13584
|
+
},
|
|
13585
|
+
limit: {
|
|
13586
|
+
default: 500,
|
|
13587
|
+
description:
|
|
13588
|
+
'Numerical limit on the number of devices to return.',
|
|
13589
|
+
format: 'float',
|
|
13590
|
+
type: 'number',
|
|
13363
13591
|
},
|
|
13364
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
13365
13592
|
manufacturer: {
|
|
13593
|
+
description: 'Manufacturer by which to filter devices.',
|
|
13366
13594
|
enum: [
|
|
13367
13595
|
'akuvox',
|
|
13368
13596
|
'august',
|
|
@@ -13402,7 +13630,11 @@ export default {
|
|
|
13402
13630
|
],
|
|
13403
13631
|
type: 'string',
|
|
13404
13632
|
},
|
|
13405
|
-
user_identifier_key: {
|
|
13633
|
+
user_identifier_key: {
|
|
13634
|
+
description:
|
|
13635
|
+
'Your own internal user ID for the user by which to filter devices.',
|
|
13636
|
+
type: 'string',
|
|
13637
|
+
},
|
|
13406
13638
|
},
|
|
13407
13639
|
type: 'object',
|
|
13408
13640
|
},
|
|
@@ -13992,29 +14224,46 @@ export default {
|
|
|
13992
14224
|
'application/json': {
|
|
13993
14225
|
schema: {
|
|
13994
14226
|
properties: {
|
|
13995
|
-
connect_webview_id: {
|
|
14227
|
+
connect_webview_id: {
|
|
14228
|
+
description:
|
|
14229
|
+
'ID of the Connect Webview by which to filter devices.',
|
|
14230
|
+
format: 'uuid',
|
|
14231
|
+
type: 'string',
|
|
14232
|
+
},
|
|
13996
14233
|
connected_account_id: {
|
|
13997
14234
|
description:
|
|
13998
|
-
'
|
|
14235
|
+
'ID of the connected account by which to filter.',
|
|
13999
14236
|
format: 'uuid',
|
|
14000
14237
|
type: 'string',
|
|
14001
14238
|
},
|
|
14002
14239
|
connected_account_ids: {
|
|
14240
|
+
description:
|
|
14241
|
+
'Array of IDs of the connected accounts by which to filter devices.',
|
|
14003
14242
|
items: { format: 'uuid', type: 'string' },
|
|
14004
14243
|
type: 'array',
|
|
14005
14244
|
},
|
|
14006
|
-
created_before: {
|
|
14245
|
+
created_before: {
|
|
14246
|
+
description:
|
|
14247
|
+
'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
|
|
14248
|
+
format: 'date-time',
|
|
14249
|
+
type: 'string',
|
|
14250
|
+
},
|
|
14007
14251
|
custom_metadata_has: {
|
|
14008
14252
|
additionalProperties: {
|
|
14009
14253
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
14010
14254
|
},
|
|
14255
|
+
description:
|
|
14256
|
+
'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.',
|
|
14011
14257
|
type: 'object',
|
|
14012
14258
|
},
|
|
14013
14259
|
device_ids: {
|
|
14260
|
+
description:
|
|
14261
|
+
'Array of device IDs by which to filter devices.',
|
|
14014
14262
|
items: { format: 'uuid', type: 'string' },
|
|
14015
14263
|
type: 'array',
|
|
14016
14264
|
},
|
|
14017
14265
|
device_type: {
|
|
14266
|
+
description: 'Device type by which to filter devices.',
|
|
14018
14267
|
oneOf: [
|
|
14019
14268
|
{
|
|
14020
14269
|
enum: [
|
|
@@ -14071,6 +14320,8 @@ export default {
|
|
|
14071
14320
|
],
|
|
14072
14321
|
},
|
|
14073
14322
|
device_types: {
|
|
14323
|
+
description:
|
|
14324
|
+
'Array of device types by which to filter devices.',
|
|
14074
14325
|
items: {
|
|
14075
14326
|
oneOf: [
|
|
14076
14327
|
{
|
|
@@ -14150,6 +14401,7 @@ export default {
|
|
|
14150
14401
|
type: 'string',
|
|
14151
14402
|
},
|
|
14152
14403
|
type: 'array',
|
|
14404
|
+
'x-undocumented': 'Only used internally.',
|
|
14153
14405
|
},
|
|
14154
14406
|
include_if: {
|
|
14155
14407
|
items: {
|
|
@@ -14169,9 +14421,17 @@ export default {
|
|
|
14169
14421
|
type: 'string',
|
|
14170
14422
|
},
|
|
14171
14423
|
type: 'array',
|
|
14424
|
+
'x-undocumented': 'Only used internally.',
|
|
14425
|
+
},
|
|
14426
|
+
limit: {
|
|
14427
|
+
default: 500,
|
|
14428
|
+
description:
|
|
14429
|
+
'Numerical limit on the number of devices to return.',
|
|
14430
|
+
format: 'float',
|
|
14431
|
+
type: 'number',
|
|
14172
14432
|
},
|
|
14173
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
14174
14433
|
manufacturer: {
|
|
14434
|
+
description: 'Manufacturer by which to filter devices.',
|
|
14175
14435
|
enum: [
|
|
14176
14436
|
'akuvox',
|
|
14177
14437
|
'august',
|
|
@@ -14211,7 +14471,11 @@ export default {
|
|
|
14211
14471
|
],
|
|
14212
14472
|
type: 'string',
|
|
14213
14473
|
},
|
|
14214
|
-
user_identifier_key: {
|
|
14474
|
+
user_identifier_key: {
|
|
14475
|
+
description:
|
|
14476
|
+
'Your own internal user ID for the user by which to filter devices.',
|
|
14477
|
+
type: 'string',
|
|
14478
|
+
},
|
|
14215
14479
|
},
|
|
14216
14480
|
type: 'object',
|
|
14217
14481
|
},
|
|
@@ -14459,29 +14723,46 @@ export default {
|
|
|
14459
14723
|
'application/json': {
|
|
14460
14724
|
schema: {
|
|
14461
14725
|
properties: {
|
|
14462
|
-
connect_webview_id: {
|
|
14726
|
+
connect_webview_id: {
|
|
14727
|
+
description:
|
|
14728
|
+
'ID of the Connect Webview by which to filter devices.',
|
|
14729
|
+
format: 'uuid',
|
|
14730
|
+
type: 'string',
|
|
14731
|
+
},
|
|
14463
14732
|
connected_account_id: {
|
|
14464
14733
|
description:
|
|
14465
|
-
'
|
|
14734
|
+
'ID of the connected account by which to filter.',
|
|
14466
14735
|
format: 'uuid',
|
|
14467
14736
|
type: 'string',
|
|
14468
14737
|
},
|
|
14469
14738
|
connected_account_ids: {
|
|
14739
|
+
description:
|
|
14740
|
+
'Array of IDs of the connected accounts by which to filter devices.',
|
|
14470
14741
|
items: { format: 'uuid', type: 'string' },
|
|
14471
14742
|
type: 'array',
|
|
14472
14743
|
},
|
|
14473
|
-
created_before: {
|
|
14744
|
+
created_before: {
|
|
14745
|
+
description:
|
|
14746
|
+
'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
|
|
14747
|
+
format: 'date-time',
|
|
14748
|
+
type: 'string',
|
|
14749
|
+
},
|
|
14474
14750
|
custom_metadata_has: {
|
|
14475
14751
|
additionalProperties: {
|
|
14476
14752
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
14477
14753
|
},
|
|
14754
|
+
description:
|
|
14755
|
+
'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.',
|
|
14478
14756
|
type: 'object',
|
|
14479
14757
|
},
|
|
14480
14758
|
device_ids: {
|
|
14759
|
+
description:
|
|
14760
|
+
'Array of device IDs by which to filter devices.',
|
|
14481
14761
|
items: { format: 'uuid', type: 'string' },
|
|
14482
14762
|
type: 'array',
|
|
14483
14763
|
},
|
|
14484
14764
|
device_type: {
|
|
14765
|
+
description: 'Device type by which to filter devices.',
|
|
14485
14766
|
oneOf: [
|
|
14486
14767
|
{
|
|
14487
14768
|
enum: [
|
|
@@ -14538,6 +14819,8 @@ export default {
|
|
|
14538
14819
|
],
|
|
14539
14820
|
},
|
|
14540
14821
|
device_types: {
|
|
14822
|
+
description:
|
|
14823
|
+
'Array of device types by which to filter devices.',
|
|
14541
14824
|
items: {
|
|
14542
14825
|
oneOf: [
|
|
14543
14826
|
{
|
|
@@ -14617,6 +14900,7 @@ export default {
|
|
|
14617
14900
|
type: 'string',
|
|
14618
14901
|
},
|
|
14619
14902
|
type: 'array',
|
|
14903
|
+
'x-undocumented': 'Only used internally.',
|
|
14620
14904
|
},
|
|
14621
14905
|
include_if: {
|
|
14622
14906
|
items: {
|
|
@@ -14636,9 +14920,17 @@ export default {
|
|
|
14636
14920
|
type: 'string',
|
|
14637
14921
|
},
|
|
14638
14922
|
type: 'array',
|
|
14923
|
+
'x-undocumented': 'Only used internally.',
|
|
14924
|
+
},
|
|
14925
|
+
limit: {
|
|
14926
|
+
default: 500,
|
|
14927
|
+
description:
|
|
14928
|
+
'Numerical limit on the number of devices to return.',
|
|
14929
|
+
format: 'float',
|
|
14930
|
+
type: 'number',
|
|
14639
14931
|
},
|
|
14640
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
14641
14932
|
manufacturer: {
|
|
14933
|
+
description: 'Manufacturer by which to filter devices.',
|
|
14642
14934
|
enum: [
|
|
14643
14935
|
'akuvox',
|
|
14644
14936
|
'august',
|
|
@@ -14678,7 +14970,11 @@ export default {
|
|
|
14678
14970
|
],
|
|
14679
14971
|
type: 'string',
|
|
14680
14972
|
},
|
|
14681
|
-
user_identifier_key: {
|
|
14973
|
+
user_identifier_key: {
|
|
14974
|
+
description:
|
|
14975
|
+
'Your own internal user ID for the user by which to filter devices.',
|
|
14976
|
+
type: 'string',
|
|
14977
|
+
},
|
|
14682
14978
|
},
|
|
14683
14979
|
type: 'object',
|
|
14684
14980
|
},
|
|
@@ -15323,14 +15619,24 @@ export default {
|
|
|
15323
15619
|
},
|
|
15324
15620
|
'/thermostats/activate_climate_preset': {
|
|
15325
15621
|
post: {
|
|
15622
|
+
description:
|
|
15623
|
+
'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).',
|
|
15326
15624
|
operationId: 'thermostatsActivateClimatePresetPost',
|
|
15327
15625
|
requestBody: {
|
|
15328
15626
|
content: {
|
|
15329
15627
|
'application/json': {
|
|
15330
15628
|
schema: {
|
|
15331
15629
|
properties: {
|
|
15332
|
-
climate_preset_key: {
|
|
15333
|
-
|
|
15630
|
+
climate_preset_key: {
|
|
15631
|
+
description:
|
|
15632
|
+
'Climate preset key of the desired climate preset.',
|
|
15633
|
+
type: 'string',
|
|
15634
|
+
},
|
|
15635
|
+
device_id: {
|
|
15636
|
+
description: 'ID of the desired thermostat device.',
|
|
15637
|
+
format: 'uuid',
|
|
15638
|
+
type: 'string',
|
|
15639
|
+
},
|
|
15334
15640
|
},
|
|
15335
15641
|
required: ['device_id', 'climate_preset_key'],
|
|
15336
15642
|
type: 'object',
|
|
@@ -15370,12 +15676,13 @@ export default {
|
|
|
15370
15676
|
'x-fern-sdk-method-name': 'activate_climate_preset',
|
|
15371
15677
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15372
15678
|
'x-response-key': 'action_attempt',
|
|
15679
|
+
'x-title': 'Activate a Climate Preset',
|
|
15373
15680
|
},
|
|
15374
15681
|
},
|
|
15375
15682
|
'/thermostats/cool': {
|
|
15376
15683
|
post: {
|
|
15377
15684
|
description:
|
|
15378
|
-
'Sets a thermostat
|
|
15685
|
+
'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).',
|
|
15379
15686
|
operationId: 'thermostatsCoolPost',
|
|
15380
15687
|
requestBody: {
|
|
15381
15688
|
content: {
|
|
@@ -15384,22 +15691,26 @@ export default {
|
|
|
15384
15691
|
properties: {
|
|
15385
15692
|
cooling_set_point_celsius: {
|
|
15386
15693
|
description:
|
|
15387
|
-
'
|
|
15694
|
+
'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.',
|
|
15388
15695
|
format: 'float',
|
|
15389
15696
|
type: 'number',
|
|
15390
15697
|
},
|
|
15391
15698
|
cooling_set_point_fahrenheit: {
|
|
15392
15699
|
description:
|
|
15393
|
-
'
|
|
15700
|
+
'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.',
|
|
15394
15701
|
format: 'float',
|
|
15395
15702
|
type: 'number',
|
|
15396
15703
|
},
|
|
15397
15704
|
device_id: {
|
|
15398
|
-
description: 'ID of the thermostat device.',
|
|
15705
|
+
description: 'ID of the desired thermostat device.',
|
|
15399
15706
|
format: 'uuid',
|
|
15400
15707
|
type: 'string',
|
|
15401
15708
|
},
|
|
15402
|
-
sync: {
|
|
15709
|
+
sync: {
|
|
15710
|
+
default: false,
|
|
15711
|
+
type: 'boolean',
|
|
15712
|
+
'x-undocumented': 'Only used internally.',
|
|
15713
|
+
},
|
|
15403
15714
|
},
|
|
15404
15715
|
required: ['device_id'],
|
|
15405
15716
|
type: 'object',
|
|
@@ -15445,40 +15756,71 @@ export default {
|
|
|
15445
15756
|
},
|
|
15446
15757
|
'/thermostats/create_climate_preset': {
|
|
15447
15758
|
post: {
|
|
15759
|
+
description:
|
|
15760
|
+
'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).',
|
|
15448
15761
|
operationId: 'thermostatsCreateClimatePresetPost',
|
|
15449
15762
|
requestBody: {
|
|
15450
15763
|
content: {
|
|
15451
15764
|
'application/json': {
|
|
15452
15765
|
schema: {
|
|
15453
15766
|
properties: {
|
|
15454
|
-
climate_preset_key: {
|
|
15767
|
+
climate_preset_key: {
|
|
15768
|
+
description: 'Unique key to identify the climate preset.',
|
|
15769
|
+
type: 'string',
|
|
15770
|
+
},
|
|
15455
15771
|
cooling_set_point_celsius: {
|
|
15772
|
+
description:
|
|
15773
|
+
'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).',
|
|
15456
15774
|
format: 'float',
|
|
15457
15775
|
type: 'number',
|
|
15458
15776
|
},
|
|
15459
15777
|
cooling_set_point_fahrenheit: {
|
|
15778
|
+
description:
|
|
15779
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
15460
15780
|
format: 'float',
|
|
15461
15781
|
type: 'number',
|
|
15462
15782
|
},
|
|
15463
|
-
device_id: {
|
|
15783
|
+
device_id: {
|
|
15784
|
+
description: 'ID of the desired thermostat device.',
|
|
15785
|
+
format: 'uuid',
|
|
15786
|
+
type: 'string',
|
|
15787
|
+
},
|
|
15464
15788
|
fan_mode_setting: {
|
|
15789
|
+
description:
|
|
15790
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
15465
15791
|
enum: ['auto', 'on', 'circulate'],
|
|
15466
15792
|
type: 'string',
|
|
15467
15793
|
},
|
|
15468
15794
|
heating_set_point_celsius: {
|
|
15795
|
+
description:
|
|
15796
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
15469
15797
|
format: 'float',
|
|
15470
15798
|
type: 'number',
|
|
15471
15799
|
},
|
|
15472
15800
|
heating_set_point_fahrenheit: {
|
|
15801
|
+
description:
|
|
15802
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
15473
15803
|
format: 'float',
|
|
15474
15804
|
type: 'number',
|
|
15475
15805
|
},
|
|
15476
15806
|
hvac_mode_setting: {
|
|
15807
|
+
description:
|
|
15808
|
+
'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`.',
|
|
15477
15809
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
15478
15810
|
type: 'string',
|
|
15479
15811
|
},
|
|
15480
|
-
manual_override_allowed: {
|
|
15481
|
-
|
|
15812
|
+
manual_override_allowed: {
|
|
15813
|
+
description:
|
|
15814
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
15815
|
+
type: 'boolean',
|
|
15816
|
+
},
|
|
15817
|
+
name: {
|
|
15818
|
+
default: null,
|
|
15819
|
+
description:
|
|
15820
|
+
'User-friendly name to identify the climate preset.',
|
|
15821
|
+
nullable: true,
|
|
15822
|
+
type: 'string',
|
|
15823
|
+
},
|
|
15482
15824
|
},
|
|
15483
15825
|
required: [
|
|
15484
15826
|
'device_id',
|
|
@@ -15516,18 +15858,29 @@ export default {
|
|
|
15516
15858
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
15517
15859
|
'x-fern-sdk-method-name': 'create_climate_preset',
|
|
15518
15860
|
'x-response-key': null,
|
|
15861
|
+
'x-title': 'Create a Climate Preset',
|
|
15519
15862
|
},
|
|
15520
15863
|
},
|
|
15521
15864
|
'/thermostats/delete_climate_preset': {
|
|
15522
15865
|
post: {
|
|
15866
|
+
description:
|
|
15867
|
+
'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).',
|
|
15523
15868
|
operationId: 'thermostatsDeleteClimatePresetPost',
|
|
15524
15869
|
requestBody: {
|
|
15525
15870
|
content: {
|
|
15526
15871
|
'application/json': {
|
|
15527
15872
|
schema: {
|
|
15528
15873
|
properties: {
|
|
15529
|
-
climate_preset_key: {
|
|
15530
|
-
|
|
15874
|
+
climate_preset_key: {
|
|
15875
|
+
description:
|
|
15876
|
+
'Climate preset key of the desired climate preset.',
|
|
15877
|
+
type: 'string',
|
|
15878
|
+
},
|
|
15879
|
+
device_id: {
|
|
15880
|
+
description: 'ID of the desired thermostat device.',
|
|
15881
|
+
format: 'uuid',
|
|
15882
|
+
type: 'string',
|
|
15883
|
+
},
|
|
15531
15884
|
},
|
|
15532
15885
|
required: ['device_id', 'climate_preset_key'],
|
|
15533
15886
|
type: 'object',
|
|
@@ -15561,11 +15914,13 @@ export default {
|
|
|
15561
15914
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
15562
15915
|
'x-fern-sdk-method-name': 'delete_climate_preset',
|
|
15563
15916
|
'x-response-key': null,
|
|
15917
|
+
'x-title': 'Delete a Climate Preset',
|
|
15564
15918
|
},
|
|
15565
15919
|
},
|
|
15566
15920
|
'/thermostats/get': {
|
|
15567
15921
|
post: {
|
|
15568
|
-
description:
|
|
15922
|
+
description:
|
|
15923
|
+
'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
15569
15924
|
operationId: 'thermostatsGetPost',
|
|
15570
15925
|
requestBody: {
|
|
15571
15926
|
content: {
|
|
@@ -15573,12 +15928,13 @@ export default {
|
|
|
15573
15928
|
schema: {
|
|
15574
15929
|
properties: {
|
|
15575
15930
|
device_id: {
|
|
15576
|
-
description: 'ID of the thermostat device.',
|
|
15931
|
+
description: 'ID of the desired thermostat device.',
|
|
15577
15932
|
format: 'uuid',
|
|
15578
15933
|
type: 'string',
|
|
15579
15934
|
},
|
|
15580
15935
|
name: {
|
|
15581
|
-
description:
|
|
15936
|
+
description:
|
|
15937
|
+
'User-friendly name of the desired thermostat device.',
|
|
15582
15938
|
type: 'string',
|
|
15583
15939
|
},
|
|
15584
15940
|
},
|
|
@@ -15620,12 +15976,13 @@ export default {
|
|
|
15620
15976
|
'x-fern-sdk-return-value': 'thermostat',
|
|
15621
15977
|
'x-response-key': 'thermostat',
|
|
15622
15978
|
'x-title': 'Get a Thermostat',
|
|
15979
|
+
'x-undocumented': 'Will be removed.',
|
|
15623
15980
|
},
|
|
15624
15981
|
},
|
|
15625
15982
|
'/thermostats/heat': {
|
|
15626
15983
|
post: {
|
|
15627
15984
|
description:
|
|
15628
|
-
'Sets a thermostat
|
|
15985
|
+
'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).',
|
|
15629
15986
|
operationId: 'thermostatsHeatPost',
|
|
15630
15987
|
requestBody: {
|
|
15631
15988
|
content: {
|
|
@@ -15633,23 +15990,27 @@ export default {
|
|
|
15633
15990
|
schema: {
|
|
15634
15991
|
properties: {
|
|
15635
15992
|
device_id: {
|
|
15636
|
-
description: 'ID of the thermostat device.',
|
|
15993
|
+
description: 'ID of the desired thermostat device.',
|
|
15637
15994
|
format: 'uuid',
|
|
15638
15995
|
type: 'string',
|
|
15639
15996
|
},
|
|
15640
15997
|
heating_set_point_celsius: {
|
|
15641
15998
|
description:
|
|
15642
|
-
'
|
|
15999
|
+
'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.',
|
|
15643
16000
|
format: 'float',
|
|
15644
16001
|
type: 'number',
|
|
15645
16002
|
},
|
|
15646
16003
|
heating_set_point_fahrenheit: {
|
|
15647
16004
|
description:
|
|
15648
|
-
'
|
|
16005
|
+
'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.',
|
|
15649
16006
|
format: 'float',
|
|
15650
16007
|
type: 'number',
|
|
15651
16008
|
},
|
|
15652
|
-
sync: {
|
|
16009
|
+
sync: {
|
|
16010
|
+
default: false,
|
|
16011
|
+
type: 'boolean',
|
|
16012
|
+
'x-undocumented': 'Only used internally.',
|
|
16013
|
+
},
|
|
15653
16014
|
},
|
|
15654
16015
|
required: ['device_id'],
|
|
15655
16016
|
type: 'object',
|
|
@@ -15696,7 +16057,7 @@ export default {
|
|
|
15696
16057
|
'/thermostats/heat_cool': {
|
|
15697
16058
|
post: {
|
|
15698
16059
|
description:
|
|
15699
|
-
'
|
|
16060
|
+
'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).',
|
|
15700
16061
|
operationId: 'thermostatsHeatCoolPost',
|
|
15701
16062
|
requestBody: {
|
|
15702
16063
|
content: {
|
|
@@ -15705,34 +16066,38 @@ export default {
|
|
|
15705
16066
|
properties: {
|
|
15706
16067
|
cooling_set_point_celsius: {
|
|
15707
16068
|
description:
|
|
15708
|
-
'
|
|
16069
|
+
'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.',
|
|
15709
16070
|
format: 'float',
|
|
15710
16071
|
type: 'number',
|
|
15711
16072
|
},
|
|
15712
16073
|
cooling_set_point_fahrenheit: {
|
|
15713
16074
|
description:
|
|
15714
|
-
'
|
|
16075
|
+
'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.',
|
|
15715
16076
|
format: 'float',
|
|
15716
16077
|
type: 'number',
|
|
15717
16078
|
},
|
|
15718
16079
|
device_id: {
|
|
15719
|
-
description: 'ID of the thermostat device.',
|
|
16080
|
+
description: 'ID of the desired thermostat device.',
|
|
15720
16081
|
format: 'uuid',
|
|
15721
16082
|
type: 'string',
|
|
15722
16083
|
},
|
|
15723
16084
|
heating_set_point_celsius: {
|
|
15724
16085
|
description:
|
|
15725
|
-
'
|
|
16086
|
+
'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.',
|
|
15726
16087
|
format: 'float',
|
|
15727
16088
|
type: 'number',
|
|
15728
16089
|
},
|
|
15729
16090
|
heating_set_point_fahrenheit: {
|
|
15730
16091
|
description:
|
|
15731
|
-
'
|
|
16092
|
+
'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.',
|
|
15732
16093
|
format: 'float',
|
|
15733
16094
|
type: 'number',
|
|
15734
16095
|
},
|
|
15735
|
-
sync: {
|
|
16096
|
+
sync: {
|
|
16097
|
+
default: false,
|
|
16098
|
+
type: 'boolean',
|
|
16099
|
+
'x-undocumented': 'Only used internally.',
|
|
16100
|
+
},
|
|
15736
16101
|
},
|
|
15737
16102
|
required: ['device_id'],
|
|
15738
16103
|
type: 'object',
|
|
@@ -15779,36 +16144,53 @@ export default {
|
|
|
15779
16144
|
'/thermostats/list': {
|
|
15780
16145
|
post: {
|
|
15781
16146
|
description:
|
|
15782
|
-
'Returns a list of thermostats
|
|
16147
|
+
'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
15783
16148
|
operationId: 'thermostatsListPost',
|
|
15784
16149
|
requestBody: {
|
|
15785
16150
|
content: {
|
|
15786
16151
|
'application/json': {
|
|
15787
16152
|
schema: {
|
|
15788
16153
|
properties: {
|
|
15789
|
-
connect_webview_id: {
|
|
16154
|
+
connect_webview_id: {
|
|
16155
|
+
description:
|
|
16156
|
+
'ID of the Connect Webview by which to filter devices.',
|
|
16157
|
+
format: 'uuid',
|
|
16158
|
+
type: 'string',
|
|
16159
|
+
},
|
|
15790
16160
|
connected_account_id: {
|
|
15791
16161
|
description:
|
|
15792
|
-
'
|
|
16162
|
+
'ID of the connected account by which to filter.',
|
|
15793
16163
|
format: 'uuid',
|
|
15794
16164
|
type: 'string',
|
|
15795
16165
|
},
|
|
15796
16166
|
connected_account_ids: {
|
|
16167
|
+
description:
|
|
16168
|
+
'Array of IDs of the connected accounts by which to filter devices.',
|
|
15797
16169
|
items: { format: 'uuid', type: 'string' },
|
|
15798
16170
|
type: 'array',
|
|
15799
16171
|
},
|
|
15800
|
-
created_before: {
|
|
16172
|
+
created_before: {
|
|
16173
|
+
description:
|
|
16174
|
+
'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
|
|
16175
|
+
format: 'date-time',
|
|
16176
|
+
type: 'string',
|
|
16177
|
+
},
|
|
15801
16178
|
custom_metadata_has: {
|
|
15802
16179
|
additionalProperties: {
|
|
15803
16180
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15804
16181
|
},
|
|
16182
|
+
description:
|
|
16183
|
+
'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.',
|
|
15805
16184
|
type: 'object',
|
|
15806
16185
|
},
|
|
15807
16186
|
device_ids: {
|
|
16187
|
+
description:
|
|
16188
|
+
'Array of device IDs by which to filter devices.',
|
|
15808
16189
|
items: { format: 'uuid', type: 'string' },
|
|
15809
16190
|
type: 'array',
|
|
15810
16191
|
},
|
|
15811
16192
|
device_type: {
|
|
16193
|
+
description: 'Device type by which to filter devices.',
|
|
15812
16194
|
oneOf: [
|
|
15813
16195
|
{
|
|
15814
16196
|
enum: [
|
|
@@ -15865,6 +16247,8 @@ export default {
|
|
|
15865
16247
|
],
|
|
15866
16248
|
},
|
|
15867
16249
|
device_types: {
|
|
16250
|
+
description:
|
|
16251
|
+
'Array of device types by which to filter devices.',
|
|
15868
16252
|
items: {
|
|
15869
16253
|
oneOf: [
|
|
15870
16254
|
{
|
|
@@ -15944,6 +16328,7 @@ export default {
|
|
|
15944
16328
|
type: 'string',
|
|
15945
16329
|
},
|
|
15946
16330
|
type: 'array',
|
|
16331
|
+
'x-undocumented': 'Only used internally.',
|
|
15947
16332
|
},
|
|
15948
16333
|
include_if: {
|
|
15949
16334
|
items: {
|
|
@@ -15963,9 +16348,17 @@ export default {
|
|
|
15963
16348
|
type: 'string',
|
|
15964
16349
|
},
|
|
15965
16350
|
type: 'array',
|
|
16351
|
+
'x-undocumented': 'Only used internally.',
|
|
16352
|
+
},
|
|
16353
|
+
limit: {
|
|
16354
|
+
default: 500,
|
|
16355
|
+
description:
|
|
16356
|
+
'Numerical limit on the number of devices to return.',
|
|
16357
|
+
format: 'float',
|
|
16358
|
+
type: 'number',
|
|
15966
16359
|
},
|
|
15967
|
-
limit: { default: 500, format: 'float', type: 'number' },
|
|
15968
16360
|
manufacturer: {
|
|
16361
|
+
description: 'Manufacturer by which to filter devices.',
|
|
15969
16362
|
enum: [
|
|
15970
16363
|
'akuvox',
|
|
15971
16364
|
'august',
|
|
@@ -16005,7 +16398,11 @@ export default {
|
|
|
16005
16398
|
],
|
|
16006
16399
|
type: 'string',
|
|
16007
16400
|
},
|
|
16008
|
-
user_identifier_key: {
|
|
16401
|
+
user_identifier_key: {
|
|
16402
|
+
description:
|
|
16403
|
+
'Your own internal user ID for the user by which to filter devices.',
|
|
16404
|
+
type: 'string',
|
|
16405
|
+
},
|
|
16009
16406
|
},
|
|
16010
16407
|
type: 'object',
|
|
16011
16408
|
},
|
|
@@ -16056,7 +16453,7 @@ export default {
|
|
|
16056
16453
|
'/thermostats/off': {
|
|
16057
16454
|
post: {
|
|
16058
16455
|
description:
|
|
16059
|
-
'Sets a thermostat to "off" mode
|
|
16456
|
+
'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).',
|
|
16060
16457
|
operationId: 'thermostatsOffPost',
|
|
16061
16458
|
requestBody: {
|
|
16062
16459
|
content: {
|
|
@@ -16064,11 +16461,15 @@ export default {
|
|
|
16064
16461
|
schema: {
|
|
16065
16462
|
properties: {
|
|
16066
16463
|
device_id: {
|
|
16067
|
-
description: 'ID of the thermostat device.',
|
|
16464
|
+
description: 'ID of the desired thermostat device.',
|
|
16068
16465
|
format: 'uuid',
|
|
16069
16466
|
type: 'string',
|
|
16070
16467
|
},
|
|
16071
|
-
sync: {
|
|
16468
|
+
sync: {
|
|
16469
|
+
default: false,
|
|
16470
|
+
type: 'boolean',
|
|
16471
|
+
'x-undocumented': 'Only used internally.',
|
|
16472
|
+
},
|
|
16072
16473
|
},
|
|
16073
16474
|
required: ['device_id'],
|
|
16074
16475
|
type: 'object',
|
|
@@ -16114,22 +16515,45 @@ export default {
|
|
|
16114
16515
|
},
|
|
16115
16516
|
'/thermostats/schedules/create': {
|
|
16116
16517
|
post: {
|
|
16518
|
+
description:
|
|
16519
|
+
'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).',
|
|
16117
16520
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
16118
16521
|
requestBody: {
|
|
16119
16522
|
content: {
|
|
16120
16523
|
'application/json': {
|
|
16121
16524
|
schema: {
|
|
16122
16525
|
properties: {
|
|
16123
|
-
climate_preset_key: {
|
|
16124
|
-
|
|
16125
|
-
|
|
16526
|
+
climate_preset_key: {
|
|
16527
|
+
description:
|
|
16528
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
|
|
16529
|
+
type: 'string',
|
|
16530
|
+
},
|
|
16531
|
+
device_id: {
|
|
16532
|
+
description: 'ID of the desired thermostat device.',
|
|
16533
|
+
type: 'string',
|
|
16534
|
+
},
|
|
16535
|
+
ends_at: {
|
|
16536
|
+
description:
|
|
16537
|
+
'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16538
|
+
type: 'string',
|
|
16539
|
+
},
|
|
16126
16540
|
max_override_period_minutes: {
|
|
16127
16541
|
default: 0,
|
|
16542
|
+
description:
|
|
16543
|
+
"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).",
|
|
16128
16544
|
minimum: 0,
|
|
16129
16545
|
type: 'integer',
|
|
16130
16546
|
},
|
|
16131
|
-
name: {
|
|
16132
|
-
|
|
16547
|
+
name: {
|
|
16548
|
+
description:
|
|
16549
|
+
'User-friendly name to identify the climate schedule.',
|
|
16550
|
+
type: 'string',
|
|
16551
|
+
},
|
|
16552
|
+
starts_at: {
|
|
16553
|
+
description:
|
|
16554
|
+
'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16555
|
+
type: 'string',
|
|
16556
|
+
},
|
|
16133
16557
|
},
|
|
16134
16558
|
required: [
|
|
16135
16559
|
'device_id',
|
|
@@ -16175,17 +16599,24 @@ export default {
|
|
|
16175
16599
|
'x-fern-sdk-method-name': 'create',
|
|
16176
16600
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16177
16601
|
'x-response-key': 'thermostat_schedule',
|
|
16602
|
+
'x-title': 'Create a Climate Schedule',
|
|
16178
16603
|
},
|
|
16179
16604
|
},
|
|
16180
16605
|
'/thermostats/schedules/delete': {
|
|
16181
16606
|
post: {
|
|
16607
|
+
description:
|
|
16608
|
+
'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).',
|
|
16182
16609
|
operationId: 'thermostatsSchedulesDeletePost',
|
|
16183
16610
|
requestBody: {
|
|
16184
16611
|
content: {
|
|
16185
16612
|
'application/json': {
|
|
16186
16613
|
schema: {
|
|
16187
16614
|
properties: {
|
|
16188
|
-
thermostat_schedule_id: {
|
|
16615
|
+
thermostat_schedule_id: {
|
|
16616
|
+
description: 'ID of the desired climate schedule.',
|
|
16617
|
+
format: 'uuid',
|
|
16618
|
+
type: 'string',
|
|
16619
|
+
},
|
|
16189
16620
|
},
|
|
16190
16621
|
required: ['thermostat_schedule_id'],
|
|
16191
16622
|
type: 'object',
|
|
@@ -16220,17 +16651,24 @@ export default {
|
|
|
16220
16651
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16221
16652
|
'x-fern-sdk-method-name': 'delete',
|
|
16222
16653
|
'x-response-key': null,
|
|
16654
|
+
'x-title': 'Delete a Climate Schedule',
|
|
16223
16655
|
},
|
|
16224
16656
|
},
|
|
16225
16657
|
'/thermostats/schedules/get': {
|
|
16226
16658
|
post: {
|
|
16659
|
+
description:
|
|
16660
|
+
'Returns a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
16227
16661
|
operationId: 'thermostatsSchedulesGetPost',
|
|
16228
16662
|
requestBody: {
|
|
16229
16663
|
content: {
|
|
16230
16664
|
'application/json': {
|
|
16231
16665
|
schema: {
|
|
16232
16666
|
properties: {
|
|
16233
|
-
thermostat_schedule_id: {
|
|
16667
|
+
thermostat_schedule_id: {
|
|
16668
|
+
description: 'ID of the desired climate schedule.',
|
|
16669
|
+
format: 'uuid',
|
|
16670
|
+
type: 'string',
|
|
16671
|
+
},
|
|
16234
16672
|
},
|
|
16235
16673
|
required: ['thermostat_schedule_id'],
|
|
16236
16674
|
type: 'object',
|
|
@@ -16271,18 +16709,29 @@ export default {
|
|
|
16271
16709
|
'x-fern-sdk-method-name': 'get',
|
|
16272
16710
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16273
16711
|
'x-response-key': 'thermostat_schedule',
|
|
16712
|
+
'x-title': 'Get a Climate Schedule',
|
|
16274
16713
|
},
|
|
16275
16714
|
},
|
|
16276
16715
|
'/thermostats/schedules/list': {
|
|
16277
16716
|
post: {
|
|
16717
|
+
description:
|
|
16718
|
+
'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).',
|
|
16278
16719
|
operationId: 'thermostatsSchedulesListPost',
|
|
16279
16720
|
requestBody: {
|
|
16280
16721
|
content: {
|
|
16281
16722
|
'application/json': {
|
|
16282
16723
|
schema: {
|
|
16283
16724
|
properties: {
|
|
16284
|
-
device_id: {
|
|
16285
|
-
|
|
16725
|
+
device_id: {
|
|
16726
|
+
description: 'ID of the desired thermostat device.',
|
|
16727
|
+
format: 'uuid',
|
|
16728
|
+
type: 'string',
|
|
16729
|
+
},
|
|
16730
|
+
user_identifier_key: {
|
|
16731
|
+
description:
|
|
16732
|
+
'User identifier key by which to filter the list of returned climate schedules.',
|
|
16733
|
+
type: 'string',
|
|
16734
|
+
},
|
|
16286
16735
|
},
|
|
16287
16736
|
required: ['device_id'],
|
|
16288
16737
|
type: 'object',
|
|
@@ -16326,22 +16775,50 @@ export default {
|
|
|
16326
16775
|
'x-fern-sdk-method-name': 'list',
|
|
16327
16776
|
'x-fern-sdk-return-value': 'thermostat_schedules',
|
|
16328
16777
|
'x-response-key': 'thermostat_schedules',
|
|
16778
|
+
'x-title': 'List Climate Schedules',
|
|
16329
16779
|
},
|
|
16330
16780
|
},
|
|
16331
16781
|
'/thermostats/schedules/update': {
|
|
16332
16782
|
patch: {
|
|
16783
|
+
description:
|
|
16784
|
+
'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
16333
16785
|
operationId: 'thermostatsSchedulesUpdatePatch',
|
|
16334
16786
|
requestBody: {
|
|
16335
16787
|
content: {
|
|
16336
16788
|
'application/json': {
|
|
16337
16789
|
schema: {
|
|
16338
16790
|
properties: {
|
|
16339
|
-
climate_preset_key: {
|
|
16340
|
-
|
|
16341
|
-
|
|
16342
|
-
|
|
16343
|
-
|
|
16344
|
-
|
|
16791
|
+
climate_preset_key: {
|
|
16792
|
+
description:
|
|
16793
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
|
|
16794
|
+
type: 'string',
|
|
16795
|
+
},
|
|
16796
|
+
ends_at: {
|
|
16797
|
+
description:
|
|
16798
|
+
'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16799
|
+
type: 'string',
|
|
16800
|
+
},
|
|
16801
|
+
max_override_period_minutes: {
|
|
16802
|
+
description:
|
|
16803
|
+
"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).",
|
|
16804
|
+
minimum: 0,
|
|
16805
|
+
type: 'integer',
|
|
16806
|
+
},
|
|
16807
|
+
name: {
|
|
16808
|
+
description:
|
|
16809
|
+
'User-friendly name to identify the climate schedule.',
|
|
16810
|
+
type: 'string',
|
|
16811
|
+
},
|
|
16812
|
+
starts_at: {
|
|
16813
|
+
description:
|
|
16814
|
+
'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16815
|
+
type: 'string',
|
|
16816
|
+
},
|
|
16817
|
+
thermostat_schedule_id: {
|
|
16818
|
+
description: 'ID of the desired climate schedule.',
|
|
16819
|
+
format: 'uuid',
|
|
16820
|
+
type: 'string',
|
|
16821
|
+
},
|
|
16345
16822
|
},
|
|
16346
16823
|
required: ['thermostat_schedule_id'],
|
|
16347
16824
|
type: 'object',
|
|
@@ -16375,20 +16852,48 @@ export default {
|
|
|
16375
16852
|
tags: ['/thermostats'],
|
|
16376
16853
|
'x-fern-ignore': true,
|
|
16377
16854
|
'x-response-key': null,
|
|
16855
|
+
'x-title': 'Update a Climate Schedule',
|
|
16378
16856
|
},
|
|
16379
16857
|
post: {
|
|
16858
|
+
description:
|
|
16859
|
+
'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
|
|
16380
16860
|
operationId: 'thermostatsSchedulesUpdatePost',
|
|
16381
16861
|
requestBody: {
|
|
16382
16862
|
content: {
|
|
16383
16863
|
'application/json': {
|
|
16384
16864
|
schema: {
|
|
16385
16865
|
properties: {
|
|
16386
|
-
climate_preset_key: {
|
|
16387
|
-
|
|
16388
|
-
|
|
16389
|
-
|
|
16390
|
-
|
|
16391
|
-
|
|
16866
|
+
climate_preset_key: {
|
|
16867
|
+
description:
|
|
16868
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule.',
|
|
16869
|
+
type: 'string',
|
|
16870
|
+
},
|
|
16871
|
+
ends_at: {
|
|
16872
|
+
description:
|
|
16873
|
+
'Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16874
|
+
type: 'string',
|
|
16875
|
+
},
|
|
16876
|
+
max_override_period_minutes: {
|
|
16877
|
+
description:
|
|
16878
|
+
"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).",
|
|
16879
|
+
minimum: 0,
|
|
16880
|
+
type: 'integer',
|
|
16881
|
+
},
|
|
16882
|
+
name: {
|
|
16883
|
+
description:
|
|
16884
|
+
'User-friendly name to identify the climate schedule.',
|
|
16885
|
+
type: 'string',
|
|
16886
|
+
},
|
|
16887
|
+
starts_at: {
|
|
16888
|
+
description:
|
|
16889
|
+
'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16890
|
+
type: 'string',
|
|
16891
|
+
},
|
|
16892
|
+
thermostat_schedule_id: {
|
|
16893
|
+
description: 'ID of the desired climate schedule.',
|
|
16894
|
+
format: 'uuid',
|
|
16895
|
+
type: 'string',
|
|
16896
|
+
},
|
|
16392
16897
|
},
|
|
16393
16898
|
required: ['thermostat_schedule_id'],
|
|
16394
16899
|
type: 'object',
|
|
@@ -16423,18 +16928,29 @@ export default {
|
|
|
16423
16928
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16424
16929
|
'x-fern-sdk-method-name': 'update',
|
|
16425
16930
|
'x-response-key': null,
|
|
16931
|
+
'x-title': 'Update a Climate Schedule',
|
|
16426
16932
|
},
|
|
16427
16933
|
},
|
|
16428
16934
|
'/thermostats/set_fallback_climate_preset': {
|
|
16429
16935
|
post: {
|
|
16936
|
+
description:
|
|
16937
|
+
'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).',
|
|
16430
16938
|
operationId: 'thermostatsSetFallbackClimatePresetPost',
|
|
16431
16939
|
requestBody: {
|
|
16432
16940
|
content: {
|
|
16433
16941
|
'application/json': {
|
|
16434
16942
|
schema: {
|
|
16435
16943
|
properties: {
|
|
16436
|
-
climate_preset_key: {
|
|
16437
|
-
|
|
16944
|
+
climate_preset_key: {
|
|
16945
|
+
description:
|
|
16946
|
+
'Climate preset key of the desired climate preset.',
|
|
16947
|
+
type: 'string',
|
|
16948
|
+
},
|
|
16949
|
+
device_id: {
|
|
16950
|
+
description: 'ID of the desired thermostat device.',
|
|
16951
|
+
format: 'uuid',
|
|
16952
|
+
type: 'string',
|
|
16953
|
+
},
|
|
16438
16954
|
},
|
|
16439
16955
|
required: ['device_id', 'climate_preset_key'],
|
|
16440
16956
|
type: 'object',
|
|
@@ -16468,23 +16984,20 @@ export default {
|
|
|
16468
16984
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16469
16985
|
'x-fern-sdk-method-name': 'set_fallback_climate_preset',
|
|
16470
16986
|
'x-response-key': null,
|
|
16987
|
+
'x-title': 'Set the Fallback Climate Preset',
|
|
16471
16988
|
},
|
|
16472
16989
|
},
|
|
16473
16990
|
'/thermostats/set_fan_mode': {
|
|
16474
16991
|
post: {
|
|
16475
16992
|
description:
|
|
16476
|
-
'Sets the fan mode setting
|
|
16993
|
+
'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).',
|
|
16477
16994
|
operationId: 'thermostatsSetFanModePost',
|
|
16478
16995
|
requestBody: {
|
|
16479
16996
|
content: {
|
|
16480
16997
|
'application/json': {
|
|
16481
16998
|
schema: {
|
|
16482
16999
|
properties: {
|
|
16483
|
-
device_id: {
|
|
16484
|
-
description: 'ID of the thermostat device.',
|
|
16485
|
-
format: 'uuid',
|
|
16486
|
-
type: 'string',
|
|
16487
|
-
},
|
|
17000
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
16488
17001
|
fan_mode: {
|
|
16489
17002
|
deprecated: true,
|
|
16490
17003
|
enum: ['auto', 'on', 'circulate'],
|
|
@@ -16493,11 +17006,15 @@ export default {
|
|
|
16493
17006
|
},
|
|
16494
17007
|
fan_mode_setting: {
|
|
16495
17008
|
description:
|
|
16496
|
-
'
|
|
17009
|
+
'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
|
|
16497
17010
|
enum: ['auto', 'on', 'circulate'],
|
|
16498
17011
|
type: 'string',
|
|
16499
17012
|
},
|
|
16500
|
-
sync: {
|
|
17013
|
+
sync: {
|
|
17014
|
+
default: false,
|
|
17015
|
+
type: 'boolean',
|
|
17016
|
+
'x-undocumented': 'Only used internally.',
|
|
17017
|
+
},
|
|
16501
17018
|
},
|
|
16502
17019
|
required: ['device_id'],
|
|
16503
17020
|
type: 'object',
|
|
@@ -16538,38 +17055,52 @@ export default {
|
|
|
16538
17055
|
'x-fern-sdk-method-name': 'set_fan_mode',
|
|
16539
17056
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
16540
17057
|
'x-response-key': 'action_attempt',
|
|
16541
|
-
'x-title': 'Set Fan Mode Setting',
|
|
17058
|
+
'x-title': 'Set the Fan Mode Setting',
|
|
16542
17059
|
},
|
|
16543
17060
|
},
|
|
16544
17061
|
'/thermostats/set_temperature_threshold': {
|
|
16545
17062
|
patch: {
|
|
17063
|
+
description:
|
|
17064
|
+
'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.',
|
|
16546
17065
|
operationId: 'thermostatsSetTemperatureThresholdPatch',
|
|
16547
17066
|
requestBody: {
|
|
16548
17067
|
content: {
|
|
16549
17068
|
'application/json': {
|
|
16550
17069
|
schema: {
|
|
16551
17070
|
properties: {
|
|
16552
|
-
device_id: {
|
|
17071
|
+
device_id: {
|
|
17072
|
+
description: 'ID of the desired thermostat device.',
|
|
17073
|
+
format: 'uuid',
|
|
17074
|
+
type: 'string',
|
|
17075
|
+
},
|
|
16553
17076
|
lower_limit_celsius: {
|
|
16554
17077
|
default: null,
|
|
17078
|
+
description:
|
|
17079
|
+
'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.',
|
|
16555
17080
|
format: 'float',
|
|
16556
17081
|
nullable: true,
|
|
16557
17082
|
type: 'number',
|
|
16558
17083
|
},
|
|
16559
17084
|
lower_limit_fahrenheit: {
|
|
16560
17085
|
default: null,
|
|
17086
|
+
description:
|
|
17087
|
+
'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.',
|
|
16561
17088
|
format: 'float',
|
|
16562
17089
|
nullable: true,
|
|
16563
17090
|
type: 'number',
|
|
16564
17091
|
},
|
|
16565
17092
|
upper_limit_celsius: {
|
|
16566
17093
|
default: null,
|
|
17094
|
+
description:
|
|
17095
|
+
'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.',
|
|
16567
17096
|
format: 'float',
|
|
16568
17097
|
nullable: true,
|
|
16569
17098
|
type: 'number',
|
|
16570
17099
|
},
|
|
16571
17100
|
upper_limit_fahrenheit: {
|
|
16572
17101
|
default: null,
|
|
17102
|
+
description:
|
|
17103
|
+
'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.',
|
|
16573
17104
|
format: 'float',
|
|
16574
17105
|
nullable: true,
|
|
16575
17106
|
type: 'number',
|
|
@@ -16606,35 +17137,50 @@ export default {
|
|
|
16606
17137
|
tags: ['/thermostats'],
|
|
16607
17138
|
'x-fern-ignore': true,
|
|
16608
17139
|
'x-response-key': null,
|
|
17140
|
+
'x-title': 'Set a Temperature Threshold',
|
|
16609
17141
|
},
|
|
16610
17142
|
post: {
|
|
17143
|
+
description:
|
|
17144
|
+
'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.',
|
|
16611
17145
|
operationId: 'thermostatsSetTemperatureThresholdPost',
|
|
16612
17146
|
requestBody: {
|
|
16613
17147
|
content: {
|
|
16614
17148
|
'application/json': {
|
|
16615
17149
|
schema: {
|
|
16616
17150
|
properties: {
|
|
16617
|
-
device_id: {
|
|
17151
|
+
device_id: {
|
|
17152
|
+
description: 'ID of the desired thermostat device.',
|
|
17153
|
+
format: 'uuid',
|
|
17154
|
+
type: 'string',
|
|
17155
|
+
},
|
|
16618
17156
|
lower_limit_celsius: {
|
|
16619
17157
|
default: null,
|
|
17158
|
+
description:
|
|
17159
|
+
'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.',
|
|
16620
17160
|
format: 'float',
|
|
16621
17161
|
nullable: true,
|
|
16622
17162
|
type: 'number',
|
|
16623
17163
|
},
|
|
16624
17164
|
lower_limit_fahrenheit: {
|
|
16625
17165
|
default: null,
|
|
17166
|
+
description:
|
|
17167
|
+
'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.',
|
|
16626
17168
|
format: 'float',
|
|
16627
17169
|
nullable: true,
|
|
16628
17170
|
type: 'number',
|
|
16629
17171
|
},
|
|
16630
17172
|
upper_limit_celsius: {
|
|
16631
17173
|
default: null,
|
|
17174
|
+
description:
|
|
17175
|
+
'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.',
|
|
16632
17176
|
format: 'float',
|
|
16633
17177
|
nullable: true,
|
|
16634
17178
|
type: 'number',
|
|
16635
17179
|
},
|
|
16636
17180
|
upper_limit_fahrenheit: {
|
|
16637
17181
|
default: null,
|
|
17182
|
+
description:
|
|
17183
|
+
'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.',
|
|
16638
17184
|
format: 'float',
|
|
16639
17185
|
nullable: true,
|
|
16640
17186
|
type: 'number',
|
|
@@ -16672,44 +17218,76 @@ export default {
|
|
|
16672
17218
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16673
17219
|
'x-fern-sdk-method-name': 'set_temperature_threshold',
|
|
16674
17220
|
'x-response-key': null,
|
|
17221
|
+
'x-title': 'Set a Temperature Threshold',
|
|
16675
17222
|
},
|
|
16676
17223
|
},
|
|
16677
17224
|
'/thermostats/update_climate_preset': {
|
|
16678
17225
|
patch: {
|
|
17226
|
+
description:
|
|
17227
|
+
'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).',
|
|
16679
17228
|
operationId: 'thermostatsUpdateClimatePresetPatch',
|
|
16680
17229
|
requestBody: {
|
|
16681
17230
|
content: {
|
|
16682
17231
|
'application/json': {
|
|
16683
17232
|
schema: {
|
|
16684
17233
|
properties: {
|
|
16685
|
-
climate_preset_key: {
|
|
17234
|
+
climate_preset_key: {
|
|
17235
|
+
description: 'Unique key to identify the climate preset.',
|
|
17236
|
+
type: 'string',
|
|
17237
|
+
},
|
|
16686
17238
|
cooling_set_point_celsius: {
|
|
17239
|
+
description:
|
|
17240
|
+
'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).',
|
|
16687
17241
|
format: 'float',
|
|
16688
17242
|
type: 'number',
|
|
16689
17243
|
},
|
|
16690
17244
|
cooling_set_point_fahrenheit: {
|
|
17245
|
+
description:
|
|
17246
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
16691
17247
|
format: 'float',
|
|
16692
17248
|
type: 'number',
|
|
16693
17249
|
},
|
|
16694
|
-
device_id: {
|
|
17250
|
+
device_id: {
|
|
17251
|
+
description: 'ID of the desired thermostat device.',
|
|
17252
|
+
format: 'uuid',
|
|
17253
|
+
type: 'string',
|
|
17254
|
+
},
|
|
16695
17255
|
fan_mode_setting: {
|
|
17256
|
+
description:
|
|
17257
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
16696
17258
|
enum: ['auto', 'on', 'circulate'],
|
|
16697
17259
|
type: 'string',
|
|
16698
17260
|
},
|
|
16699
17261
|
heating_set_point_celsius: {
|
|
17262
|
+
description:
|
|
17263
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
16700
17264
|
format: 'float',
|
|
16701
17265
|
type: 'number',
|
|
16702
17266
|
},
|
|
16703
17267
|
heating_set_point_fahrenheit: {
|
|
17268
|
+
description:
|
|
17269
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
16704
17270
|
format: 'float',
|
|
16705
17271
|
type: 'number',
|
|
16706
17272
|
},
|
|
16707
17273
|
hvac_mode_setting: {
|
|
17274
|
+
description:
|
|
17275
|
+
'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`.',
|
|
16708
17276
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
16709
17277
|
type: 'string',
|
|
16710
17278
|
},
|
|
16711
|
-
manual_override_allowed: {
|
|
16712
|
-
|
|
17279
|
+
manual_override_allowed: {
|
|
17280
|
+
description:
|
|
17281
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
17282
|
+
type: 'boolean',
|
|
17283
|
+
},
|
|
17284
|
+
name: {
|
|
17285
|
+
default: null,
|
|
17286
|
+
description:
|
|
17287
|
+
'User-friendly name to identify the climate preset.',
|
|
17288
|
+
nullable: true,
|
|
17289
|
+
type: 'string',
|
|
17290
|
+
},
|
|
16713
17291
|
},
|
|
16714
17292
|
required: [
|
|
16715
17293
|
'device_id',
|
|
@@ -16746,42 +17324,74 @@ export default {
|
|
|
16746
17324
|
tags: ['/thermostats'],
|
|
16747
17325
|
'x-fern-ignore': true,
|
|
16748
17326
|
'x-response-key': null,
|
|
17327
|
+
'x-title': 'Update a Climate Preset',
|
|
16749
17328
|
},
|
|
16750
17329
|
post: {
|
|
17330
|
+
description:
|
|
17331
|
+
'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).',
|
|
16751
17332
|
operationId: 'thermostatsUpdateClimatePresetPost',
|
|
16752
17333
|
requestBody: {
|
|
16753
17334
|
content: {
|
|
16754
17335
|
'application/json': {
|
|
16755
17336
|
schema: {
|
|
16756
17337
|
properties: {
|
|
16757
|
-
climate_preset_key: {
|
|
17338
|
+
climate_preset_key: {
|
|
17339
|
+
description: 'Unique key to identify the climate preset.',
|
|
17340
|
+
type: 'string',
|
|
17341
|
+
},
|
|
16758
17342
|
cooling_set_point_celsius: {
|
|
17343
|
+
description:
|
|
17344
|
+
'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).',
|
|
16759
17345
|
format: 'float',
|
|
16760
17346
|
type: 'number',
|
|
16761
17347
|
},
|
|
16762
17348
|
cooling_set_point_fahrenheit: {
|
|
17349
|
+
description:
|
|
17350
|
+
'Temperature to which the thermostat should cool (in °F).',
|
|
16763
17351
|
format: 'float',
|
|
16764
17352
|
type: 'number',
|
|
16765
17353
|
},
|
|
16766
|
-
device_id: {
|
|
17354
|
+
device_id: {
|
|
17355
|
+
description: 'ID of the desired thermostat device.',
|
|
17356
|
+
format: 'uuid',
|
|
17357
|
+
type: 'string',
|
|
17358
|
+
},
|
|
16767
17359
|
fan_mode_setting: {
|
|
17360
|
+
description:
|
|
17361
|
+
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
16768
17362
|
enum: ['auto', 'on', 'circulate'],
|
|
16769
17363
|
type: 'string',
|
|
16770
17364
|
},
|
|
16771
17365
|
heating_set_point_celsius: {
|
|
17366
|
+
description:
|
|
17367
|
+
'Temperature to which the thermostat should heat (in °C).',
|
|
16772
17368
|
format: 'float',
|
|
16773
17369
|
type: 'number',
|
|
16774
17370
|
},
|
|
16775
17371
|
heating_set_point_fahrenheit: {
|
|
17372
|
+
description:
|
|
17373
|
+
'Temperature to which the thermostat should heat (in °F).',
|
|
16776
17374
|
format: 'float',
|
|
16777
17375
|
type: 'number',
|
|
16778
17376
|
},
|
|
16779
17377
|
hvac_mode_setting: {
|
|
17378
|
+
description:
|
|
17379
|
+
'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`.',
|
|
16780
17380
|
enum: ['off', 'heat', 'cool', 'heat_cool'],
|
|
16781
17381
|
type: 'string',
|
|
16782
17382
|
},
|
|
16783
|
-
manual_override_allowed: {
|
|
16784
|
-
|
|
17383
|
+
manual_override_allowed: {
|
|
17384
|
+
description:
|
|
17385
|
+
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
17386
|
+
type: 'boolean',
|
|
17387
|
+
},
|
|
17388
|
+
name: {
|
|
17389
|
+
default: null,
|
|
17390
|
+
description:
|
|
17391
|
+
'User-friendly name to identify the climate preset.',
|
|
17392
|
+
nullable: true,
|
|
17393
|
+
type: 'string',
|
|
17394
|
+
},
|
|
16785
17395
|
},
|
|
16786
17396
|
required: [
|
|
16787
17397
|
'device_id',
|
|
@@ -16819,6 +17429,7 @@ export default {
|
|
|
16819
17429
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
16820
17430
|
'x-fern-sdk-method-name': 'update_climate_preset',
|
|
16821
17431
|
'x-response-key': null,
|
|
17432
|
+
'x-title': 'Update a Climate Preset',
|
|
16822
17433
|
},
|
|
16823
17434
|
},
|
|
16824
17435
|
'/user_identities/add_acs_user': {
|