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