@seamapi/types 1.290.0 → 1.292.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/connect.cjs +688 -193
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1099 -82
  4. package/lib/seam/connect/models/acs/acs-encoder.d.ts +52 -7
  5. package/lib/seam/connect/models/acs/acs-encoder.js +28 -4
  6. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.js +15 -9
  8. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  9. package/lib/seam/connect/models/events/acs/encoders.d.ts +126 -0
  10. package/lib/seam/connect/models/events/acs/encoders.js +20 -0
  11. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -0
  12. package/lib/seam/connect/models/events/acs/index.d.ts +60 -0
  13. package/lib/seam/connect/models/events/acs/index.js +2 -0
  14. package/lib/seam/connect/models/events/acs/index.js.map +1 -1
  15. package/lib/seam/connect/models/events/seam-event.d.ts +60 -0
  16. package/lib/seam/connect/models/thermostats/climate-preset.js +41 -12
  17. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  18. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +30 -9
  19. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  20. package/lib/seam/connect/openapi.d.ts +218 -23
  21. package/lib/seam/connect/openapi.js +598 -133
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +803 -52
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-encoder.ts +40 -6
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +29 -21
  27. package/src/lib/seam/connect/models/events/acs/encoders.ts +28 -0
  28. package/src/lib/seam/connect/models/events/acs/index.ts +2 -0
  29. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +49 -12
  30. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +38 -9
  31. package/src/lib/seam/connect/openapi.ts +754 -133
  32. package/src/lib/seam/connect/route-types.ts +805 -50
@@ -700,6 +700,8 @@ export default {
700
700
  type: 'object',
701
701
  },
702
702
  {
703
+ description:
704
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
703
705
  properties: {
704
706
  created_at: {
705
707
  description:
@@ -709,7 +711,7 @@ export default {
709
711
  },
710
712
  error_code: {
711
713
  description:
712
- 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
714
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
713
715
  enum: ['salto_ks_subscription_limit_exceeded'],
714
716
  type: 'string',
715
717
  },
@@ -723,6 +725,8 @@ export default {
723
725
  type: 'object',
724
726
  },
725
727
  {
728
+ description:
729
+ 'Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
726
730
  properties: {
727
731
  created_at: {
728
732
  description:
@@ -732,7 +736,7 @@ export default {
732
736
  },
733
737
  error_code: {
734
738
  description:
735
- 'Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
739
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
736
740
  enum: ['acs_system_disconnected'],
737
741
  type: 'string',
738
742
  },
@@ -746,6 +750,8 @@ export default {
746
750
  type: 'object',
747
751
  },
748
752
  {
753
+ description:
754
+ 'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
749
755
  properties: {
750
756
  created_at: {
751
757
  description:
@@ -755,7 +761,7 @@ export default {
755
761
  },
756
762
  error_code: {
757
763
  description:
758
- 'Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.',
764
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
759
765
  enum: ['account_disconnected'],
760
766
  type: 'string',
761
767
  },
@@ -4612,21 +4618,51 @@ export default {
4612
4618
  default: null,
4613
4619
  nullable: true,
4614
4620
  properties: {
4615
- climate_preset_key: { type: 'string' },
4616
- created_at: { format: 'date-time', type: 'string' },
4617
- device_id: { format: 'uuid', type: 'string' },
4618
- ends_at: { format: 'date-time', type: 'string' },
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
+ },
4619
4643
  errors: {
4620
4644
  description:
4621
- 'Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
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.',
4622
4646
  },
4623
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).",
4624
4650
  minimum: 0,
4625
4651
  type: 'integer',
4626
4652
  },
4627
- name: { type: 'string' },
4628
- starts_at: { format: 'date-time', type: 'string' },
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
+ },
4629
4664
  thermostat_schedule_id: {
4665
+ description: 'ID of the climate schedule.',
4630
4666
  format: 'uuid',
4631
4667
  type: 'string',
4632
4668
  },
@@ -4645,37 +4681,71 @@ export default {
4645
4681
  available_climate_presets: {
4646
4682
  items: {
4647
4683
  properties: {
4648
- can_delete: { type: 'boolean' },
4649
- can_edit: { type: 'boolean' },
4650
- climate_preset_key: { type: 'string' },
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
+ },
4651
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).',
4652
4702
  format: 'float',
4653
4703
  type: 'number',
4654
4704
  },
4655
4705
  cooling_set_point_fahrenheit: {
4706
+ description:
4707
+ 'Temperature to which the thermostat should cool (in °F).',
4656
4708
  format: 'float',
4657
4709
  type: 'number',
4658
4710
  },
4659
- display_name: { type: 'string' },
4711
+ display_name: {
4712
+ description:
4713
+ 'Display name for the climate preset.',
4714
+ type: 'string',
4715
+ },
4660
4716
  fan_mode_setting: {
4717
+ description:
4718
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4661
4719
  enum: ['auto', 'on', 'circulate'],
4662
4720
  type: 'string',
4663
4721
  },
4664
4722
  heating_set_point_celsius: {
4723
+ description:
4724
+ 'Temperature to which the thermostat should heat (in °C).',
4665
4725
  format: 'float',
4666
4726
  type: 'number',
4667
4727
  },
4668
4728
  heating_set_point_fahrenheit: {
4729
+ description:
4730
+ 'Temperature to which the thermostat should heat (in °F).',
4669
4731
  format: 'float',
4670
4732
  type: 'number',
4671
4733
  },
4672
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`.',
4673
4737
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4674
4738
  type: 'string',
4675
4739
  },
4676
- manual_override_allowed: { type: 'boolean' },
4740
+ manual_override_allowed: {
4741
+ description:
4742
+ "Indicates whether a person at the thermostat can change the thermostat's settings.",
4743
+ type: 'boolean',
4744
+ },
4677
4745
  name: {
4678
4746
  default: null,
4747
+ description:
4748
+ 'User-friendly name to identify the climate preset.',
4679
4749
  nullable: true,
4680
4750
  type: 'string',
4681
4751
  },
@@ -4707,37 +4777,70 @@ export default {
4707
4777
  },
4708
4778
  current_climate_setting: {
4709
4779
  properties: {
4710
- can_delete: { type: 'boolean' },
4711
- can_edit: { type: 'boolean' },
4712
- climate_preset_key: { type: 'string' },
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
+ },
4713
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).',
4714
4798
  format: 'float',
4715
4799
  type: 'number',
4716
4800
  },
4717
4801
  cooling_set_point_fahrenheit: {
4802
+ description:
4803
+ 'Temperature to which the thermostat should cool (in °F).',
4718
4804
  format: 'float',
4719
4805
  type: 'number',
4720
4806
  },
4721
- display_name: { type: 'string' },
4807
+ display_name: {
4808
+ description: 'Display name for the climate preset.',
4809
+ type: 'string',
4810
+ },
4722
4811
  fan_mode_setting: {
4812
+ description:
4813
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4723
4814
  enum: ['auto', 'on', 'circulate'],
4724
4815
  type: 'string',
4725
4816
  },
4726
4817
  heating_set_point_celsius: {
4818
+ description:
4819
+ 'Temperature to which the thermostat should heat (in °C).',
4727
4820
  format: 'float',
4728
4821
  type: 'number',
4729
4822
  },
4730
4823
  heating_set_point_fahrenheit: {
4824
+ description:
4825
+ 'Temperature to which the thermostat should heat (in °F).',
4731
4826
  format: 'float',
4732
4827
  type: 'number',
4733
4828
  },
4734
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`.',
4735
4832
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4736
4833
  type: 'string',
4737
4834
  },
4738
- manual_override_allowed: { type: 'boolean' },
4835
+ manual_override_allowed: {
4836
+ description:
4837
+ "Indicates whether a person at the thermostat can change the thermostat's settings.",
4838
+ type: 'boolean',
4839
+ },
4739
4840
  name: {
4740
4841
  default: null,
4842
+ description:
4843
+ 'User-friendly name to identify the climate preset.',
4741
4844
  nullable: true,
4742
4845
  type: 'string',
4743
4846
  },
@@ -4747,37 +4850,70 @@ export default {
4747
4850
  default_climate_setting: {
4748
4851
  deprecated: true,
4749
4852
  properties: {
4750
- can_delete: { type: 'boolean' },
4751
- can_edit: { type: 'boolean' },
4752
- climate_preset_key: { type: 'string' },
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
+ },
4753
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).',
4754
4871
  format: 'float',
4755
4872
  type: 'number',
4756
4873
  },
4757
4874
  cooling_set_point_fahrenheit: {
4875
+ description:
4876
+ 'Temperature to which the thermostat should cool (in °F).',
4758
4877
  format: 'float',
4759
4878
  type: 'number',
4760
4879
  },
4761
- display_name: { type: 'string' },
4880
+ display_name: {
4881
+ description: 'Display name for the climate preset.',
4882
+ type: 'string',
4883
+ },
4762
4884
  fan_mode_setting: {
4885
+ description:
4886
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
4763
4887
  enum: ['auto', 'on', 'circulate'],
4764
4888
  type: 'string',
4765
4889
  },
4766
4890
  heating_set_point_celsius: {
4891
+ description:
4892
+ 'Temperature to which the thermostat should heat (in °C).',
4767
4893
  format: 'float',
4768
4894
  type: 'number',
4769
4895
  },
4770
4896
  heating_set_point_fahrenheit: {
4897
+ description:
4898
+ 'Temperature to which the thermostat should heat (in °F).',
4771
4899
  format: 'float',
4772
4900
  type: 'number',
4773
4901
  },
4774
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`.',
4775
4905
  enum: ['off', 'heat', 'cool', 'heat_cool'],
4776
4906
  type: 'string',
4777
4907
  },
4778
- manual_override_allowed: { type: 'boolean' },
4908
+ manual_override_allowed: {
4909
+ description:
4910
+ "Indicates whether a person at the thermostat can change the thermostat's settings.",
4911
+ type: 'boolean',
4912
+ },
4779
4913
  name: {
4780
4914
  default: null,
4915
+ description:
4916
+ 'User-friendly name to identify the climate preset.',
4781
4917
  nullable: true,
4782
4918
  type: 'string',
4783
4919
  },
@@ -5282,18 +5418,53 @@ export default {
5282
5418
  },
5283
5419
  thermostat_schedule: {
5284
5420
  properties: {
5285
- climate_preset_key: { type: 'string' },
5286
- created_at: { format: 'date-time', type: 'string' },
5287
- device_id: { format: 'uuid', type: 'string' },
5288
- ends_at: { format: 'date-time', type: 'string' },
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
+ },
5289
5443
  errors: {
5290
5444
  description:
5291
- 'Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
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',
5292
5467
  },
5293
- max_override_period_minutes: { minimum: 0, type: 'integer' },
5294
- name: { type: 'string' },
5295
- starts_at: { format: 'date-time', type: 'string' },
5296
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
5297
5468
  },
5298
5469
  required: [
5299
5470
  'thermostat_schedule_id',
@@ -12666,35 +12837,54 @@ export default {
12666
12837
  },
12667
12838
  '/devices/list': {
12668
12839
  post: {
12840
+ description:
12841
+ 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).',
12669
12842
  operationId: 'devicesListPost',
12670
12843
  requestBody: {
12671
12844
  content: {
12672
12845
  'application/json': {
12673
12846
  schema: {
12674
12847
  properties: {
12675
- connect_webview_id: { format: 'uuid', type: 'string' },
12848
+ connect_webview_id: {
12849
+ description:
12850
+ 'ID of the Connect Webview by which to filter devices.',
12851
+ format: 'uuid',
12852
+ type: 'string',
12853
+ },
12676
12854
  connected_account_id: {
12677
12855
  description:
12678
- 'List all devices owned by this connected account',
12856
+ 'ID of the connected account by which to filter.',
12679
12857
  format: 'uuid',
12680
12858
  type: 'string',
12681
12859
  },
12682
12860
  connected_account_ids: {
12861
+ description:
12862
+ 'Array of IDs of the connected accounts by which to filter devices.',
12683
12863
  items: { format: 'uuid', type: 'string' },
12684
12864
  type: 'array',
12685
12865
  },
12686
- created_before: { format: 'date-time', type: 'string' },
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
+ },
12687
12872
  custom_metadata_has: {
12688
12873
  additionalProperties: {
12689
12874
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
12690
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.',
12691
12878
  type: 'object',
12692
12879
  },
12693
12880
  device_ids: {
12881
+ description:
12882
+ 'Array of device IDs by which to filter devices.',
12694
12883
  items: { format: 'uuid', type: 'string' },
12695
12884
  type: 'array',
12696
12885
  },
12697
12886
  device_type: {
12887
+ description: 'Device type by which to filter devices.',
12698
12888
  oneOf: [
12699
12889
  {
12700
12890
  enum: [
@@ -12751,6 +12941,8 @@ export default {
12751
12941
  ],
12752
12942
  },
12753
12943
  device_types: {
12944
+ description:
12945
+ 'Array of device types by which to filter devices.',
12754
12946
  items: {
12755
12947
  oneOf: [
12756
12948
  {
@@ -12830,6 +13022,7 @@ export default {
12830
13022
  type: 'string',
12831
13023
  },
12832
13024
  type: 'array',
13025
+ 'x-undocumented': 'Only used internally.',
12833
13026
  },
12834
13027
  include_if: {
12835
13028
  items: {
@@ -12849,9 +13042,17 @@ export default {
12849
13042
  type: 'string',
12850
13043
  },
12851
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',
12852
13053
  },
12853
- limit: { default: 500, format: 'float', type: 'number' },
12854
13054
  manufacturer: {
13055
+ description: 'Manufacturer by which to filter devices.',
12855
13056
  enum: [
12856
13057
  'akuvox',
12857
13058
  'august',
@@ -12891,7 +13092,11 @@ export default {
12891
13092
  ],
12892
13093
  type: 'string',
12893
13094
  },
12894
- user_identifier_key: { type: 'string' },
13095
+ user_identifier_key: {
13096
+ description:
13097
+ 'Your own internal user ID for the user by which to filter devices.',
13098
+ type: 'string',
13099
+ },
12895
13100
  },
12896
13101
  type: 'object',
12897
13102
  },
@@ -12932,6 +13137,7 @@ export default {
12932
13137
  'x-fern-sdk-method-name': 'list',
12933
13138
  'x-fern-sdk-return-value': 'devices',
12934
13139
  'x-response-key': 'devices',
13140
+ 'x-title': 'List Devices',
12935
13141
  },
12936
13142
  },
12937
13143
  '/devices/list_device_providers': {
@@ -13177,29 +13383,46 @@ export default {
13177
13383
  'application/json': {
13178
13384
  schema: {
13179
13385
  properties: {
13180
- connect_webview_id: { format: 'uuid', type: 'string' },
13386
+ connect_webview_id: {
13387
+ description:
13388
+ 'ID of the Connect Webview by which to filter devices.',
13389
+ format: 'uuid',
13390
+ type: 'string',
13391
+ },
13181
13392
  connected_account_id: {
13182
13393
  description:
13183
- 'List all devices owned by this connected account',
13394
+ 'ID of the connected account by which to filter.',
13184
13395
  format: 'uuid',
13185
13396
  type: 'string',
13186
13397
  },
13187
13398
  connected_account_ids: {
13399
+ description:
13400
+ 'Array of IDs of the connected accounts by which to filter devices.',
13188
13401
  items: { format: 'uuid', type: 'string' },
13189
13402
  type: 'array',
13190
13403
  },
13191
- created_before: { format: 'date-time', type: 'string' },
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
+ },
13192
13410
  custom_metadata_has: {
13193
13411
  additionalProperties: {
13194
13412
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
13195
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.',
13196
13416
  type: 'object',
13197
13417
  },
13198
13418
  device_ids: {
13419
+ description:
13420
+ 'Array of device IDs by which to filter devices.',
13199
13421
  items: { format: 'uuid', type: 'string' },
13200
13422
  type: 'array',
13201
13423
  },
13202
13424
  device_type: {
13425
+ description: 'Device type by which to filter devices.',
13203
13426
  oneOf: [
13204
13427
  {
13205
13428
  enum: [
@@ -13256,6 +13479,8 @@ export default {
13256
13479
  ],
13257
13480
  },
13258
13481
  device_types: {
13482
+ description:
13483
+ 'Array of device types by which to filter devices.',
13259
13484
  items: {
13260
13485
  oneOf: [
13261
13486
  {
@@ -13335,6 +13560,7 @@ export default {
13335
13560
  type: 'string',
13336
13561
  },
13337
13562
  type: 'array',
13563
+ 'x-undocumented': 'Only used internally.',
13338
13564
  },
13339
13565
  include_if: {
13340
13566
  items: {
@@ -13354,9 +13580,17 @@ export default {
13354
13580
  type: 'string',
13355
13581
  },
13356
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',
13357
13591
  },
13358
- limit: { default: 500, format: 'float', type: 'number' },
13359
13592
  manufacturer: {
13593
+ description: 'Manufacturer by which to filter devices.',
13360
13594
  enum: [
13361
13595
  'akuvox',
13362
13596
  'august',
@@ -13396,7 +13630,11 @@ export default {
13396
13630
  ],
13397
13631
  type: 'string',
13398
13632
  },
13399
- user_identifier_key: { type: 'string' },
13633
+ user_identifier_key: {
13634
+ description:
13635
+ 'Your own internal user ID for the user by which to filter devices.',
13636
+ type: 'string',
13637
+ },
13400
13638
  },
13401
13639
  type: 'object',
13402
13640
  },
@@ -13789,6 +14027,8 @@ export default {
13789
14027
  'acs_user.deleted',
13790
14028
  'acs_credential.deleted',
13791
14029
  'acs_credential.issued',
14030
+ 'acs_encoder.added',
14031
+ 'acs_encoder.removed',
13792
14032
  'enrollment_automation.deleted',
13793
14033
  'client_session.deleted',
13794
14034
  'action_attempt.lock_door.succeeded',
@@ -13863,6 +14103,8 @@ export default {
13863
14103
  'acs_user.deleted',
13864
14104
  'acs_credential.deleted',
13865
14105
  'acs_credential.issued',
14106
+ 'acs_encoder.added',
14107
+ 'acs_encoder.removed',
13866
14108
  'enrollment_automation.deleted',
13867
14109
  'client_session.deleted',
13868
14110
  'action_attempt.lock_door.succeeded',
@@ -13982,29 +14224,46 @@ export default {
13982
14224
  'application/json': {
13983
14225
  schema: {
13984
14226
  properties: {
13985
- connect_webview_id: { format: 'uuid', type: 'string' },
14227
+ connect_webview_id: {
14228
+ description:
14229
+ 'ID of the Connect Webview by which to filter devices.',
14230
+ format: 'uuid',
14231
+ type: 'string',
14232
+ },
13986
14233
  connected_account_id: {
13987
14234
  description:
13988
- 'List all devices owned by this connected account',
14235
+ 'ID of the connected account by which to filter.',
13989
14236
  format: 'uuid',
13990
14237
  type: 'string',
13991
14238
  },
13992
14239
  connected_account_ids: {
14240
+ description:
14241
+ 'Array of IDs of the connected accounts by which to filter devices.',
13993
14242
  items: { format: 'uuid', type: 'string' },
13994
14243
  type: 'array',
13995
14244
  },
13996
- created_before: { format: 'date-time', type: 'string' },
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
+ },
13997
14251
  custom_metadata_has: {
13998
14252
  additionalProperties: {
13999
14253
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
14000
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.',
14001
14257
  type: 'object',
14002
14258
  },
14003
14259
  device_ids: {
14260
+ description:
14261
+ 'Array of device IDs by which to filter devices.',
14004
14262
  items: { format: 'uuid', type: 'string' },
14005
14263
  type: 'array',
14006
14264
  },
14007
14265
  device_type: {
14266
+ description: 'Device type by which to filter devices.',
14008
14267
  oneOf: [
14009
14268
  {
14010
14269
  enum: [
@@ -14061,6 +14320,8 @@ export default {
14061
14320
  ],
14062
14321
  },
14063
14322
  device_types: {
14323
+ description:
14324
+ 'Array of device types by which to filter devices.',
14064
14325
  items: {
14065
14326
  oneOf: [
14066
14327
  {
@@ -14140,6 +14401,7 @@ export default {
14140
14401
  type: 'string',
14141
14402
  },
14142
14403
  type: 'array',
14404
+ 'x-undocumented': 'Only used internally.',
14143
14405
  },
14144
14406
  include_if: {
14145
14407
  items: {
@@ -14159,9 +14421,17 @@ export default {
14159
14421
  type: 'string',
14160
14422
  },
14161
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',
14162
14432
  },
14163
- limit: { default: 500, format: 'float', type: 'number' },
14164
14433
  manufacturer: {
14434
+ description: 'Manufacturer by which to filter devices.',
14165
14435
  enum: [
14166
14436
  'akuvox',
14167
14437
  'august',
@@ -14201,7 +14471,11 @@ export default {
14201
14471
  ],
14202
14472
  type: 'string',
14203
14473
  },
14204
- user_identifier_key: { type: 'string' },
14474
+ user_identifier_key: {
14475
+ description:
14476
+ 'Your own internal user ID for the user by which to filter devices.',
14477
+ type: 'string',
14478
+ },
14205
14479
  },
14206
14480
  type: 'object',
14207
14481
  },
@@ -14449,29 +14723,46 @@ export default {
14449
14723
  'application/json': {
14450
14724
  schema: {
14451
14725
  properties: {
14452
- connect_webview_id: { format: 'uuid', type: 'string' },
14726
+ connect_webview_id: {
14727
+ description:
14728
+ 'ID of the Connect Webview by which to filter devices.',
14729
+ format: 'uuid',
14730
+ type: 'string',
14731
+ },
14453
14732
  connected_account_id: {
14454
14733
  description:
14455
- 'List all devices owned by this connected account',
14734
+ 'ID of the connected account by which to filter.',
14456
14735
  format: 'uuid',
14457
14736
  type: 'string',
14458
14737
  },
14459
14738
  connected_account_ids: {
14739
+ description:
14740
+ 'Array of IDs of the connected accounts by which to filter devices.',
14460
14741
  items: { format: 'uuid', type: 'string' },
14461
14742
  type: 'array',
14462
14743
  },
14463
- created_before: { format: 'date-time', type: 'string' },
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
+ },
14464
14750
  custom_metadata_has: {
14465
14751
  additionalProperties: {
14466
14752
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
14467
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.',
14468
14756
  type: 'object',
14469
14757
  },
14470
14758
  device_ids: {
14759
+ description:
14760
+ 'Array of device IDs by which to filter devices.',
14471
14761
  items: { format: 'uuid', type: 'string' },
14472
14762
  type: 'array',
14473
14763
  },
14474
14764
  device_type: {
14765
+ description: 'Device type by which to filter devices.',
14475
14766
  oneOf: [
14476
14767
  {
14477
14768
  enum: [
@@ -14528,6 +14819,8 @@ export default {
14528
14819
  ],
14529
14820
  },
14530
14821
  device_types: {
14822
+ description:
14823
+ 'Array of device types by which to filter devices.',
14531
14824
  items: {
14532
14825
  oneOf: [
14533
14826
  {
@@ -14607,6 +14900,7 @@ export default {
14607
14900
  type: 'string',
14608
14901
  },
14609
14902
  type: 'array',
14903
+ 'x-undocumented': 'Only used internally.',
14610
14904
  },
14611
14905
  include_if: {
14612
14906
  items: {
@@ -14626,9 +14920,17 @@ export default {
14626
14920
  type: 'string',
14627
14921
  },
14628
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',
14629
14931
  },
14630
- limit: { default: 500, format: 'float', type: 'number' },
14631
14932
  manufacturer: {
14933
+ description: 'Manufacturer by which to filter devices.',
14632
14934
  enum: [
14633
14935
  'akuvox',
14634
14936
  'august',
@@ -14668,7 +14970,11 @@ export default {
14668
14970
  ],
14669
14971
  type: 'string',
14670
14972
  },
14671
- user_identifier_key: { type: 'string' },
14973
+ user_identifier_key: {
14974
+ description:
14975
+ 'Your own internal user ID for the user by which to filter devices.',
14976
+ type: 'string',
14977
+ },
14672
14978
  },
14673
14979
  type: 'object',
14674
14980
  },
@@ -15313,14 +15619,24 @@ export default {
15313
15619
  },
15314
15620
  '/thermostats/activate_climate_preset': {
15315
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).',
15316
15624
  operationId: 'thermostatsActivateClimatePresetPost',
15317
15625
  requestBody: {
15318
15626
  content: {
15319
15627
  'application/json': {
15320
15628
  schema: {
15321
15629
  properties: {
15322
- climate_preset_key: { type: 'string' },
15323
- device_id: { format: 'uuid', type: 'string' },
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
+ },
15324
15640
  },
15325
15641
  required: ['device_id', 'climate_preset_key'],
15326
15642
  type: 'object',
@@ -15360,12 +15676,13 @@ export default {
15360
15676
  'x-fern-sdk-method-name': 'activate_climate_preset',
15361
15677
  'x-fern-sdk-return-value': 'action_attempt',
15362
15678
  'x-response-key': 'action_attempt',
15679
+ 'x-title': 'Activate a Climate Preset',
15363
15680
  },
15364
15681
  },
15365
15682
  '/thermostats/cool': {
15366
15683
  post: {
15367
15684
  description:
15368
- 'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
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).',
15369
15686
  operationId: 'thermostatsCoolPost',
15370
15687
  requestBody: {
15371
15688
  content: {
@@ -15374,22 +15691,26 @@ export default {
15374
15691
  properties: {
15375
15692
  cooling_set_point_celsius: {
15376
15693
  description:
15377
- 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
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.',
15378
15695
  format: 'float',
15379
15696
  type: 'number',
15380
15697
  },
15381
15698
  cooling_set_point_fahrenheit: {
15382
15699
  description:
15383
- 'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
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.',
15384
15701
  format: 'float',
15385
15702
  type: 'number',
15386
15703
  },
15387
15704
  device_id: {
15388
- description: 'ID of the thermostat device.',
15705
+ description: 'ID of the desired thermostat device.',
15389
15706
  format: 'uuid',
15390
15707
  type: 'string',
15391
15708
  },
15392
- sync: { default: false, type: 'boolean' },
15709
+ sync: {
15710
+ default: false,
15711
+ type: 'boolean',
15712
+ 'x-undocumented': 'Only used internally.',
15713
+ },
15393
15714
  },
15394
15715
  required: ['device_id'],
15395
15716
  type: 'object',
@@ -15435,40 +15756,71 @@ export default {
15435
15756
  },
15436
15757
  '/thermostats/create_climate_preset': {
15437
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).',
15438
15761
  operationId: 'thermostatsCreateClimatePresetPost',
15439
15762
  requestBody: {
15440
15763
  content: {
15441
15764
  'application/json': {
15442
15765
  schema: {
15443
15766
  properties: {
15444
- climate_preset_key: { type: 'string' },
15767
+ climate_preset_key: {
15768
+ description: 'Unique key to identify the climate preset.',
15769
+ type: 'string',
15770
+ },
15445
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).',
15446
15774
  format: 'float',
15447
15775
  type: 'number',
15448
15776
  },
15449
15777
  cooling_set_point_fahrenheit: {
15778
+ description:
15779
+ 'Temperature to which the thermostat should cool (in °F).',
15450
15780
  format: 'float',
15451
15781
  type: 'number',
15452
15782
  },
15453
- device_id: { format: 'uuid', type: 'string' },
15783
+ device_id: {
15784
+ description: 'ID of the desired thermostat device.',
15785
+ format: 'uuid',
15786
+ type: 'string',
15787
+ },
15454
15788
  fan_mode_setting: {
15789
+ description:
15790
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
15455
15791
  enum: ['auto', 'on', 'circulate'],
15456
15792
  type: 'string',
15457
15793
  },
15458
15794
  heating_set_point_celsius: {
15795
+ description:
15796
+ 'Temperature to which the thermostat should heat (in °C).',
15459
15797
  format: 'float',
15460
15798
  type: 'number',
15461
15799
  },
15462
15800
  heating_set_point_fahrenheit: {
15801
+ description:
15802
+ 'Temperature to which the thermostat should heat (in °F).',
15463
15803
  format: 'float',
15464
15804
  type: 'number',
15465
15805
  },
15466
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`.',
15467
15809
  enum: ['off', 'heat', 'cool', 'heat_cool'],
15468
15810
  type: 'string',
15469
15811
  },
15470
- manual_override_allowed: { type: 'boolean' },
15471
- name: { default: null, nullable: true, type: 'string' },
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
+ },
15472
15824
  },
15473
15825
  required: [
15474
15826
  'device_id',
@@ -15506,18 +15858,29 @@ export default {
15506
15858
  'x-fern-sdk-group-name': ['thermostats'],
15507
15859
  'x-fern-sdk-method-name': 'create_climate_preset',
15508
15860
  'x-response-key': null,
15861
+ 'x-title': 'Create a Climate Preset',
15509
15862
  },
15510
15863
  },
15511
15864
  '/thermostats/delete_climate_preset': {
15512
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).',
15513
15868
  operationId: 'thermostatsDeleteClimatePresetPost',
15514
15869
  requestBody: {
15515
15870
  content: {
15516
15871
  'application/json': {
15517
15872
  schema: {
15518
15873
  properties: {
15519
- climate_preset_key: { type: 'string' },
15520
- device_id: { format: 'uuid', type: 'string' },
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
+ },
15521
15884
  },
15522
15885
  required: ['device_id', 'climate_preset_key'],
15523
15886
  type: 'object',
@@ -15551,11 +15914,13 @@ export default {
15551
15914
  'x-fern-sdk-group-name': ['thermostats'],
15552
15915
  'x-fern-sdk-method-name': 'delete_climate_preset',
15553
15916
  'x-response-key': null,
15917
+ 'x-title': 'Delete a Climate Preset',
15554
15918
  },
15555
15919
  },
15556
15920
  '/thermostats/get': {
15557
15921
  post: {
15558
- description: 'Returns a specific thermostat.',
15922
+ description:
15923
+ 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
15559
15924
  operationId: 'thermostatsGetPost',
15560
15925
  requestBody: {
15561
15926
  content: {
@@ -15563,12 +15928,13 @@ export default {
15563
15928
  schema: {
15564
15929
  properties: {
15565
15930
  device_id: {
15566
- description: 'ID of the thermostat device.',
15931
+ description: 'ID of the desired thermostat device.',
15567
15932
  format: 'uuid',
15568
15933
  type: 'string',
15569
15934
  },
15570
15935
  name: {
15571
- description: 'Name of the thermostat.',
15936
+ description:
15937
+ 'User-friendly name of the desired thermostat device.',
15572
15938
  type: 'string',
15573
15939
  },
15574
15940
  },
@@ -15610,12 +15976,13 @@ export default {
15610
15976
  'x-fern-sdk-return-value': 'thermostat',
15611
15977
  'x-response-key': 'thermostat',
15612
15978
  'x-title': 'Get a Thermostat',
15979
+ 'x-undocumented': 'Will be removed.',
15613
15980
  },
15614
15981
  },
15615
15982
  '/thermostats/heat': {
15616
15983
  post: {
15617
15984
  description:
15618
- 'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
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).',
15619
15986
  operationId: 'thermostatsHeatPost',
15620
15987
  requestBody: {
15621
15988
  content: {
@@ -15623,23 +15990,27 @@ export default {
15623
15990
  schema: {
15624
15991
  properties: {
15625
15992
  device_id: {
15626
- description: 'ID of the thermostat device.',
15993
+ description: 'ID of the desired thermostat device.',
15627
15994
  format: 'uuid',
15628
15995
  type: 'string',
15629
15996
  },
15630
15997
  heating_set_point_celsius: {
15631
15998
  description:
15632
- 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
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.',
15633
16000
  format: 'float',
15634
16001
  type: 'number',
15635
16002
  },
15636
16003
  heating_set_point_fahrenheit: {
15637
16004
  description:
15638
- 'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
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.',
15639
16006
  format: 'float',
15640
16007
  type: 'number',
15641
16008
  },
15642
- sync: { default: false, type: 'boolean' },
16009
+ sync: {
16010
+ default: false,
16011
+ type: 'boolean',
16012
+ 'x-undocumented': 'Only used internally.',
16013
+ },
15643
16014
  },
15644
16015
  required: ['device_id'],
15645
16016
  type: 'object',
@@ -15686,7 +16057,7 @@ export default {
15686
16057
  '/thermostats/heat_cool': {
15687
16058
  post: {
15688
16059
  description:
15689
- 'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
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).',
15690
16061
  operationId: 'thermostatsHeatCoolPost',
15691
16062
  requestBody: {
15692
16063
  content: {
@@ -15695,34 +16066,38 @@ export default {
15695
16066
  properties: {
15696
16067
  cooling_set_point_celsius: {
15697
16068
  description:
15698
- 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
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.',
15699
16070
  format: 'float',
15700
16071
  type: 'number',
15701
16072
  },
15702
16073
  cooling_set_point_fahrenheit: {
15703
16074
  description:
15704
- 'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
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.',
15705
16076
  format: 'float',
15706
16077
  type: 'number',
15707
16078
  },
15708
16079
  device_id: {
15709
- description: 'ID of the thermostat device.',
16080
+ description: 'ID of the desired thermostat device.',
15710
16081
  format: 'uuid',
15711
16082
  type: 'string',
15712
16083
  },
15713
16084
  heating_set_point_celsius: {
15714
16085
  description:
15715
- 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
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.',
15716
16087
  format: 'float',
15717
16088
  type: 'number',
15718
16089
  },
15719
16090
  heating_set_point_fahrenheit: {
15720
16091
  description:
15721
- 'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
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.',
15722
16093
  format: 'float',
15723
16094
  type: 'number',
15724
16095
  },
15725
- sync: { default: false, type: 'boolean' },
16096
+ sync: {
16097
+ default: false,
16098
+ type: 'boolean',
16099
+ 'x-undocumented': 'Only used internally.',
16100
+ },
15726
16101
  },
15727
16102
  required: ['device_id'],
15728
16103
  type: 'object',
@@ -15769,36 +16144,53 @@ export default {
15769
16144
  '/thermostats/list': {
15770
16145
  post: {
15771
16146
  description:
15772
- 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
16147
+ 'Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).',
15773
16148
  operationId: 'thermostatsListPost',
15774
16149
  requestBody: {
15775
16150
  content: {
15776
16151
  'application/json': {
15777
16152
  schema: {
15778
16153
  properties: {
15779
- connect_webview_id: { format: 'uuid', type: 'string' },
16154
+ connect_webview_id: {
16155
+ description:
16156
+ 'ID of the Connect Webview by which to filter devices.',
16157
+ format: 'uuid',
16158
+ type: 'string',
16159
+ },
15780
16160
  connected_account_id: {
15781
16161
  description:
15782
- 'List all devices owned by this connected account',
16162
+ 'ID of the connected account by which to filter.',
15783
16163
  format: 'uuid',
15784
16164
  type: 'string',
15785
16165
  },
15786
16166
  connected_account_ids: {
16167
+ description:
16168
+ 'Array of IDs of the connected accounts by which to filter devices.',
15787
16169
  items: { format: 'uuid', type: 'string' },
15788
16170
  type: 'array',
15789
16171
  },
15790
- created_before: { format: 'date-time', type: 'string' },
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
+ },
15791
16178
  custom_metadata_has: {
15792
16179
  additionalProperties: {
15793
16180
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
15794
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.',
15795
16184
  type: 'object',
15796
16185
  },
15797
16186
  device_ids: {
16187
+ description:
16188
+ 'Array of device IDs by which to filter devices.',
15798
16189
  items: { format: 'uuid', type: 'string' },
15799
16190
  type: 'array',
15800
16191
  },
15801
16192
  device_type: {
16193
+ description: 'Device type by which to filter devices.',
15802
16194
  oneOf: [
15803
16195
  {
15804
16196
  enum: [
@@ -15855,6 +16247,8 @@ export default {
15855
16247
  ],
15856
16248
  },
15857
16249
  device_types: {
16250
+ description:
16251
+ 'Array of device types by which to filter devices.',
15858
16252
  items: {
15859
16253
  oneOf: [
15860
16254
  {
@@ -15934,6 +16328,7 @@ export default {
15934
16328
  type: 'string',
15935
16329
  },
15936
16330
  type: 'array',
16331
+ 'x-undocumented': 'Only used internally.',
15937
16332
  },
15938
16333
  include_if: {
15939
16334
  items: {
@@ -15953,9 +16348,17 @@ export default {
15953
16348
  type: 'string',
15954
16349
  },
15955
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',
15956
16359
  },
15957
- limit: { default: 500, format: 'float', type: 'number' },
15958
16360
  manufacturer: {
16361
+ description: 'Manufacturer by which to filter devices.',
15959
16362
  enum: [
15960
16363
  'akuvox',
15961
16364
  'august',
@@ -15995,7 +16398,11 @@ export default {
15995
16398
  ],
15996
16399
  type: 'string',
15997
16400
  },
15998
- user_identifier_key: { type: 'string' },
16401
+ user_identifier_key: {
16402
+ description:
16403
+ 'Your own internal user ID for the user by which to filter devices.',
16404
+ type: 'string',
16405
+ },
15999
16406
  },
16000
16407
  type: 'object',
16001
16408
  },
@@ -16046,7 +16453,7 @@ export default {
16046
16453
  '/thermostats/off': {
16047
16454
  post: {
16048
16455
  description:
16049
- 'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
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).',
16050
16457
  operationId: 'thermostatsOffPost',
16051
16458
  requestBody: {
16052
16459
  content: {
@@ -16054,11 +16461,15 @@ export default {
16054
16461
  schema: {
16055
16462
  properties: {
16056
16463
  device_id: {
16057
- description: 'ID of the thermostat device.',
16464
+ description: 'ID of the desired thermostat device.',
16058
16465
  format: 'uuid',
16059
16466
  type: 'string',
16060
16467
  },
16061
- sync: { default: false, type: 'boolean' },
16468
+ sync: {
16469
+ default: false,
16470
+ type: 'boolean',
16471
+ 'x-undocumented': 'Only used internally.',
16472
+ },
16062
16473
  },
16063
16474
  required: ['device_id'],
16064
16475
  type: 'object',
@@ -16104,22 +16515,45 @@ export default {
16104
16515
  },
16105
16516
  '/thermostats/schedules/create': {
16106
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).',
16107
16520
  operationId: 'thermostatsSchedulesCreatePost',
16108
16521
  requestBody: {
16109
16522
  content: {
16110
16523
  'application/json': {
16111
16524
  schema: {
16112
16525
  properties: {
16113
- climate_preset_key: { type: 'string' },
16114
- device_id: { type: 'string' },
16115
- ends_at: { type: 'string' },
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
+ },
16116
16540
  max_override_period_minutes: {
16117
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).",
16118
16544
  minimum: 0,
16119
16545
  type: 'integer',
16120
16546
  },
16121
- name: { type: 'string' },
16122
- starts_at: { type: 'string' },
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
+ },
16123
16557
  },
16124
16558
  required: [
16125
16559
  'device_id',
@@ -16165,17 +16599,24 @@ export default {
16165
16599
  'x-fern-sdk-method-name': 'create',
16166
16600
  'x-fern-sdk-return-value': 'thermostat_schedule',
16167
16601
  'x-response-key': 'thermostat_schedule',
16602
+ 'x-title': 'Create a Climate Schedule',
16168
16603
  },
16169
16604
  },
16170
16605
  '/thermostats/schedules/delete': {
16171
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).',
16172
16609
  operationId: 'thermostatsSchedulesDeletePost',
16173
16610
  requestBody: {
16174
16611
  content: {
16175
16612
  'application/json': {
16176
16613
  schema: {
16177
16614
  properties: {
16178
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16615
+ thermostat_schedule_id: {
16616
+ description: 'ID of the desired climate schedule.',
16617
+ format: 'uuid',
16618
+ type: 'string',
16619
+ },
16179
16620
  },
16180
16621
  required: ['thermostat_schedule_id'],
16181
16622
  type: 'object',
@@ -16210,17 +16651,24 @@ export default {
16210
16651
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
16211
16652
  'x-fern-sdk-method-name': 'delete',
16212
16653
  'x-response-key': null,
16654
+ 'x-title': 'Delete a Climate Schedule',
16213
16655
  },
16214
16656
  },
16215
16657
  '/thermostats/schedules/get': {
16216
16658
  post: {
16659
+ description:
16660
+ 'Returns a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
16217
16661
  operationId: 'thermostatsSchedulesGetPost',
16218
16662
  requestBody: {
16219
16663
  content: {
16220
16664
  'application/json': {
16221
16665
  schema: {
16222
16666
  properties: {
16223
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
16667
+ thermostat_schedule_id: {
16668
+ description: 'ID of the desired climate schedule.',
16669
+ format: 'uuid',
16670
+ type: 'string',
16671
+ },
16224
16672
  },
16225
16673
  required: ['thermostat_schedule_id'],
16226
16674
  type: 'object',
@@ -16261,18 +16709,29 @@ export default {
16261
16709
  'x-fern-sdk-method-name': 'get',
16262
16710
  'x-fern-sdk-return-value': 'thermostat_schedule',
16263
16711
  'x-response-key': 'thermostat_schedule',
16712
+ 'x-title': 'Get a Climate Schedule',
16264
16713
  },
16265
16714
  },
16266
16715
  '/thermostats/schedules/list': {
16267
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).',
16268
16719
  operationId: 'thermostatsSchedulesListPost',
16269
16720
  requestBody: {
16270
16721
  content: {
16271
16722
  'application/json': {
16272
16723
  schema: {
16273
16724
  properties: {
16274
- device_id: { format: 'uuid', type: 'string' },
16275
- user_identifier_key: { type: 'string' },
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
+ },
16276
16735
  },
16277
16736
  required: ['device_id'],
16278
16737
  type: 'object',
@@ -16316,22 +16775,50 @@ export default {
16316
16775
  'x-fern-sdk-method-name': 'list',
16317
16776
  'x-fern-sdk-return-value': 'thermostat_schedules',
16318
16777
  'x-response-key': 'thermostat_schedules',
16778
+ 'x-title': 'List Climate Schedules',
16319
16779
  },
16320
16780
  },
16321
16781
  '/thermostats/schedules/update': {
16322
16782
  patch: {
16783
+ description:
16784
+ 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
16323
16785
  operationId: 'thermostatsSchedulesUpdatePatch',
16324
16786
  requestBody: {
16325
16787
  content: {
16326
16788
  'application/json': {
16327
16789
  schema: {
16328
16790
  properties: {
16329
- climate_preset_key: { type: 'string' },
16330
- ends_at: { type: 'string' },
16331
- max_override_period_minutes: { minimum: 0, type: 'integer' },
16332
- name: { type: 'string' },
16333
- starts_at: { type: 'string' },
16334
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
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
+ },
16335
16822
  },
16336
16823
  required: ['thermostat_schedule_id'],
16337
16824
  type: 'object',
@@ -16365,20 +16852,48 @@ export default {
16365
16852
  tags: ['/thermostats'],
16366
16853
  'x-fern-ignore': true,
16367
16854
  'x-response-key': null,
16855
+ 'x-title': 'Update a Climate Schedule',
16368
16856
  },
16369
16857
  post: {
16858
+ description:
16859
+ 'Updates a specified [climate schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules).',
16370
16860
  operationId: 'thermostatsSchedulesUpdatePost',
16371
16861
  requestBody: {
16372
16862
  content: {
16373
16863
  'application/json': {
16374
16864
  schema: {
16375
16865
  properties: {
16376
- climate_preset_key: { type: 'string' },
16377
- ends_at: { type: 'string' },
16378
- max_override_period_minutes: { minimum: 0, type: 'integer' },
16379
- name: { type: 'string' },
16380
- starts_at: { type: 'string' },
16381
- thermostat_schedule_id: { format: 'uuid', type: 'string' },
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
+ },
16382
16897
  },
16383
16898
  required: ['thermostat_schedule_id'],
16384
16899
  type: 'object',
@@ -16413,18 +16928,29 @@ export default {
16413
16928
  'x-fern-sdk-group-name': ['thermostats', 'schedules'],
16414
16929
  'x-fern-sdk-method-name': 'update',
16415
16930
  'x-response-key': null,
16931
+ 'x-title': 'Update a Climate Schedule',
16416
16932
  },
16417
16933
  },
16418
16934
  '/thermostats/set_fallback_climate_preset': {
16419
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).',
16420
16938
  operationId: 'thermostatsSetFallbackClimatePresetPost',
16421
16939
  requestBody: {
16422
16940
  content: {
16423
16941
  'application/json': {
16424
16942
  schema: {
16425
16943
  properties: {
16426
- climate_preset_key: { type: 'string' },
16427
- device_id: { format: 'uuid', type: 'string' },
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
+ },
16428
16954
  },
16429
16955
  required: ['device_id', 'climate_preset_key'],
16430
16956
  type: 'object',
@@ -16458,23 +16984,20 @@ export default {
16458
16984
  'x-fern-sdk-group-name': ['thermostats'],
16459
16985
  'x-fern-sdk-method-name': 'set_fallback_climate_preset',
16460
16986
  'x-response-key': null,
16987
+ 'x-title': 'Set the Fallback Climate Preset',
16461
16988
  },
16462
16989
  },
16463
16990
  '/thermostats/set_fan_mode': {
16464
16991
  post: {
16465
16992
  description:
16466
- 'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
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).',
16467
16994
  operationId: 'thermostatsSetFanModePost',
16468
16995
  requestBody: {
16469
16996
  content: {
16470
16997
  'application/json': {
16471
16998
  schema: {
16472
16999
  properties: {
16473
- device_id: {
16474
- description: 'ID of the thermostat device.',
16475
- format: 'uuid',
16476
- type: 'string',
16477
- },
17000
+ device_id: { format: 'uuid', type: 'string' },
16478
17001
  fan_mode: {
16479
17002
  deprecated: true,
16480
17003
  enum: ['auto', 'on', 'circulate'],
@@ -16483,11 +17006,15 @@ export default {
16483
17006
  },
16484
17007
  fan_mode_setting: {
16485
17008
  description:
16486
- 'Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
17009
+ 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.',
16487
17010
  enum: ['auto', 'on', 'circulate'],
16488
17011
  type: 'string',
16489
17012
  },
16490
- sync: { default: false, type: 'boolean' },
17013
+ sync: {
17014
+ default: false,
17015
+ type: 'boolean',
17016
+ 'x-undocumented': 'Only used internally.',
17017
+ },
16491
17018
  },
16492
17019
  required: ['device_id'],
16493
17020
  type: 'object',
@@ -16528,38 +17055,52 @@ export default {
16528
17055
  'x-fern-sdk-method-name': 'set_fan_mode',
16529
17056
  'x-fern-sdk-return-value': 'action_attempt',
16530
17057
  'x-response-key': 'action_attempt',
16531
- 'x-title': 'Set Fan Mode Setting',
17058
+ 'x-title': 'Set the Fan Mode Setting',
16532
17059
  },
16533
17060
  },
16534
17061
  '/thermostats/set_temperature_threshold': {
16535
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.',
16536
17065
  operationId: 'thermostatsSetTemperatureThresholdPatch',
16537
17066
  requestBody: {
16538
17067
  content: {
16539
17068
  'application/json': {
16540
17069
  schema: {
16541
17070
  properties: {
16542
- device_id: { format: 'uuid', type: 'string' },
17071
+ device_id: {
17072
+ description: 'ID of the desired thermostat device.',
17073
+ format: 'uuid',
17074
+ type: 'string',
17075
+ },
16543
17076
  lower_limit_celsius: {
16544
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.',
16545
17080
  format: 'float',
16546
17081
  nullable: true,
16547
17082
  type: 'number',
16548
17083
  },
16549
17084
  lower_limit_fahrenheit: {
16550
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.',
16551
17088
  format: 'float',
16552
17089
  nullable: true,
16553
17090
  type: 'number',
16554
17091
  },
16555
17092
  upper_limit_celsius: {
16556
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.',
16557
17096
  format: 'float',
16558
17097
  nullable: true,
16559
17098
  type: 'number',
16560
17099
  },
16561
17100
  upper_limit_fahrenheit: {
16562
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.',
16563
17104
  format: 'float',
16564
17105
  nullable: true,
16565
17106
  type: 'number',
@@ -16596,35 +17137,50 @@ export default {
16596
17137
  tags: ['/thermostats'],
16597
17138
  'x-fern-ignore': true,
16598
17139
  'x-response-key': null,
17140
+ 'x-title': 'Set a Temperature Threshold',
16599
17141
  },
16600
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.',
16601
17145
  operationId: 'thermostatsSetTemperatureThresholdPost',
16602
17146
  requestBody: {
16603
17147
  content: {
16604
17148
  'application/json': {
16605
17149
  schema: {
16606
17150
  properties: {
16607
- device_id: { format: 'uuid', type: 'string' },
17151
+ device_id: {
17152
+ description: 'ID of the desired thermostat device.',
17153
+ format: 'uuid',
17154
+ type: 'string',
17155
+ },
16608
17156
  lower_limit_celsius: {
16609
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.',
16610
17160
  format: 'float',
16611
17161
  nullable: true,
16612
17162
  type: 'number',
16613
17163
  },
16614
17164
  lower_limit_fahrenheit: {
16615
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.',
16616
17168
  format: 'float',
16617
17169
  nullable: true,
16618
17170
  type: 'number',
16619
17171
  },
16620
17172
  upper_limit_celsius: {
16621
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.',
16622
17176
  format: 'float',
16623
17177
  nullable: true,
16624
17178
  type: 'number',
16625
17179
  },
16626
17180
  upper_limit_fahrenheit: {
16627
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.',
16628
17184
  format: 'float',
16629
17185
  nullable: true,
16630
17186
  type: 'number',
@@ -16662,44 +17218,76 @@ export default {
16662
17218
  'x-fern-sdk-group-name': ['thermostats'],
16663
17219
  'x-fern-sdk-method-name': 'set_temperature_threshold',
16664
17220
  'x-response-key': null,
17221
+ 'x-title': 'Set a Temperature Threshold',
16665
17222
  },
16666
17223
  },
16667
17224
  '/thermostats/update_climate_preset': {
16668
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).',
16669
17228
  operationId: 'thermostatsUpdateClimatePresetPatch',
16670
17229
  requestBody: {
16671
17230
  content: {
16672
17231
  'application/json': {
16673
17232
  schema: {
16674
17233
  properties: {
16675
- climate_preset_key: { type: 'string' },
17234
+ climate_preset_key: {
17235
+ description: 'Unique key to identify the climate preset.',
17236
+ type: 'string',
17237
+ },
16676
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).',
16677
17241
  format: 'float',
16678
17242
  type: 'number',
16679
17243
  },
16680
17244
  cooling_set_point_fahrenheit: {
17245
+ description:
17246
+ 'Temperature to which the thermostat should cool (in °F).',
16681
17247
  format: 'float',
16682
17248
  type: 'number',
16683
17249
  },
16684
- device_id: { format: 'uuid', type: 'string' },
17250
+ device_id: {
17251
+ description: 'ID of the desired thermostat device.',
17252
+ format: 'uuid',
17253
+ type: 'string',
17254
+ },
16685
17255
  fan_mode_setting: {
17256
+ description:
17257
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16686
17258
  enum: ['auto', 'on', 'circulate'],
16687
17259
  type: 'string',
16688
17260
  },
16689
17261
  heating_set_point_celsius: {
17262
+ description:
17263
+ 'Temperature to which the thermostat should heat (in °C).',
16690
17264
  format: 'float',
16691
17265
  type: 'number',
16692
17266
  },
16693
17267
  heating_set_point_fahrenheit: {
17268
+ description:
17269
+ 'Temperature to which the thermostat should heat (in °F).',
16694
17270
  format: 'float',
16695
17271
  type: 'number',
16696
17272
  },
16697
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`.',
16698
17276
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16699
17277
  type: 'string',
16700
17278
  },
16701
- manual_override_allowed: { type: 'boolean' },
16702
- name: { default: null, nullable: true, type: 'string' },
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
+ },
16703
17291
  },
16704
17292
  required: [
16705
17293
  'device_id',
@@ -16736,42 +17324,74 @@ export default {
16736
17324
  tags: ['/thermostats'],
16737
17325
  'x-fern-ignore': true,
16738
17326
  'x-response-key': null,
17327
+ 'x-title': 'Update a Climate Preset',
16739
17328
  },
16740
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).',
16741
17332
  operationId: 'thermostatsUpdateClimatePresetPost',
16742
17333
  requestBody: {
16743
17334
  content: {
16744
17335
  'application/json': {
16745
17336
  schema: {
16746
17337
  properties: {
16747
- climate_preset_key: { type: 'string' },
17338
+ climate_preset_key: {
17339
+ description: 'Unique key to identify the climate preset.',
17340
+ type: 'string',
17341
+ },
16748
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).',
16749
17345
  format: 'float',
16750
17346
  type: 'number',
16751
17347
  },
16752
17348
  cooling_set_point_fahrenheit: {
17349
+ description:
17350
+ 'Temperature to which the thermostat should cool (in °F).',
16753
17351
  format: 'float',
16754
17352
  type: 'number',
16755
17353
  },
16756
- device_id: { format: 'uuid', type: 'string' },
17354
+ device_id: {
17355
+ description: 'ID of the desired thermostat device.',
17356
+ format: 'uuid',
17357
+ type: 'string',
17358
+ },
16757
17359
  fan_mode_setting: {
17360
+ description:
17361
+ 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
16758
17362
  enum: ['auto', 'on', 'circulate'],
16759
17363
  type: 'string',
16760
17364
  },
16761
17365
  heating_set_point_celsius: {
17366
+ description:
17367
+ 'Temperature to which the thermostat should heat (in °C).',
16762
17368
  format: 'float',
16763
17369
  type: 'number',
16764
17370
  },
16765
17371
  heating_set_point_fahrenheit: {
17372
+ description:
17373
+ 'Temperature to which the thermostat should heat (in °F).',
16766
17374
  format: 'float',
16767
17375
  type: 'number',
16768
17376
  },
16769
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`.',
16770
17380
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16771
17381
  type: 'string',
16772
17382
  },
16773
- manual_override_allowed: { type: 'boolean' },
16774
- name: { default: null, nullable: true, type: 'string' },
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
+ },
16775
17395
  },
16776
17396
  required: [
16777
17397
  'device_id',
@@ -16809,6 +17429,7 @@ export default {
16809
17429
  'x-fern-sdk-group-name': ['thermostats'],
16810
17430
  'x-fern-sdk-method-name': 'update_climate_preset',
16811
17431
  'x-response-key': null,
17432
+ 'x-title': 'Update a Climate Preset',
16812
17433
  },
16813
17434
  },
16814
17435
  '/user_identities/add_acs_user': {