@seamapi/types 1.291.0 → 1.292.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5767,60 +5767,104 @@ export interface Routes {
5767
5767
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
5768
5768
  is_temporary_manual_override_active?: boolean | undefined;
5769
5769
  current_climate_setting?: {
5770
+ /** Unique key to identify the climate preset. */
5770
5771
  climate_preset_key?: string | undefined;
5772
+ /** Indicates whether this climate preset key can be edited. */
5771
5773
  can_edit?: boolean | undefined;
5774
+ /** Indicates whether this climate preset key can be deleted. */
5772
5775
  can_delete?: boolean | undefined;
5776
+ /** User-friendly name to identify the climate preset. */
5773
5777
  name?: ((string | null) | undefined) | undefined;
5778
+ /** Display name for the climate preset. */
5774
5779
  display_name?: string | undefined;
5780
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5775
5781
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
5782
+ /** 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`. */
5776
5783
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5784
+ /** 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). */
5777
5785
  cooling_set_point_celsius?: (number | undefined) | undefined;
5786
+ /** Temperature to which the thermostat should heat (in °C). */
5778
5787
  heating_set_point_celsius?: (number | undefined) | undefined;
5788
+ /** Temperature to which the thermostat should cool (in °F). */
5779
5789
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5790
+ /** Temperature to which the thermostat should heat (in °F). */
5780
5791
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
5792
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5781
5793
  manual_override_allowed?: boolean | undefined;
5782
5794
  } | undefined;
5783
5795
  /**
5784
5796
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5785
5797
  default_climate_setting?: {
5798
+ /** Unique key to identify the climate preset. */
5786
5799
  climate_preset_key?: string | undefined;
5800
+ /** Indicates whether this climate preset key can be edited. */
5787
5801
  can_edit?: boolean | undefined;
5802
+ /** Indicates whether this climate preset key can be deleted. */
5788
5803
  can_delete?: boolean | undefined;
5804
+ /** User-friendly name to identify the climate preset. */
5789
5805
  name?: ((string | null) | undefined) | undefined;
5806
+ /** Display name for the climate preset. */
5790
5807
  display_name?: string | undefined;
5808
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5791
5809
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
5810
+ /** 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`. */
5792
5811
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5812
+ /** 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). */
5793
5813
  cooling_set_point_celsius?: (number | undefined) | undefined;
5814
+ /** Temperature to which the thermostat should heat (in °C). */
5794
5815
  heating_set_point_celsius?: (number | undefined) | undefined;
5816
+ /** Temperature to which the thermostat should cool (in °F). */
5795
5817
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5818
+ /** Temperature to which the thermostat should heat (in °F). */
5796
5819
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
5820
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5797
5821
  manual_override_allowed?: boolean | undefined;
5798
5822
  } | undefined;
5799
5823
  available_climate_presets?: Array<{
5824
+ /** Unique key to identify the climate preset. */
5800
5825
  climate_preset_key: string;
5826
+ /** Indicates whether this climate preset key can be edited. */
5801
5827
  can_edit: boolean;
5828
+ /** Indicates whether this climate preset key can be deleted. */
5802
5829
  can_delete: boolean;
5830
+ /** User-friendly name to identify the climate preset. */
5803
5831
  name?: (string | null) | undefined;
5832
+ /** Display name for the climate preset. */
5804
5833
  display_name: string;
5834
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5805
5835
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
5836
+ /** 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`. */
5806
5837
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5838
+ /** 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). */
5807
5839
  cooling_set_point_celsius?: number | undefined;
5840
+ /** Temperature to which the thermostat should heat (in °C). */
5808
5841
  heating_set_point_celsius?: number | undefined;
5842
+ /** Temperature to which the thermostat should cool (in °F). */
5809
5843
  cooling_set_point_fahrenheit?: number | undefined;
5844
+ /** Temperature to which the thermostat should heat (in °F). */
5810
5845
  heating_set_point_fahrenheit?: number | undefined;
5846
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5811
5847
  manual_override_allowed: boolean;
5812
5848
  }> | undefined;
5813
5849
  fallback_climate_preset_key?: (string | null) | undefined;
5814
5850
  active_thermostat_schedule?: ({
5851
+ /** ID of the climate schedule. */
5815
5852
  thermostat_schedule_id: string;
5853
+ /** ID of the desired thermostat device. */
5816
5854
  device_id: string;
5855
+ /** User-friendly name to identify the climate schedule. */
5817
5856
  name?: string | undefined;
5857
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
5818
5858
  climate_preset_key: string;
5859
+ /** 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). */
5819
5860
  max_override_period_minutes: number;
5861
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
5820
5862
  starts_at: string;
5863
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
5821
5864
  ends_at: string;
5865
+ /** Date and time at which the climate schedule was created. */
5822
5866
  created_at: string;
5823
- /** 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. */
5867
+ /** 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. */
5824
5868
  errors?: any;
5825
5869
  } | null) | undefined;
5826
5870
  min_cooling_set_point_celsius?: number | undefined;
@@ -10107,60 +10151,104 @@ export interface Routes {
10107
10151
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
10108
10152
  is_temporary_manual_override_active?: boolean | undefined;
10109
10153
  current_climate_setting?: {
10154
+ /** Unique key to identify the climate preset. */
10110
10155
  climate_preset_key?: string | undefined;
10156
+ /** Indicates whether this climate preset key can be edited. */
10111
10157
  can_edit?: boolean | undefined;
10158
+ /** Indicates whether this climate preset key can be deleted. */
10112
10159
  can_delete?: boolean | undefined;
10160
+ /** User-friendly name to identify the climate preset. */
10113
10161
  name?: ((string | null) | undefined) | undefined;
10162
+ /** Display name for the climate preset. */
10114
10163
  display_name?: string | undefined;
10164
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10115
10165
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
10166
+ /** 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`. */
10116
10167
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
10168
+ /** 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). */
10117
10169
  cooling_set_point_celsius?: (number | undefined) | undefined;
10170
+ /** Temperature to which the thermostat should heat (in °C). */
10118
10171
  heating_set_point_celsius?: (number | undefined) | undefined;
10172
+ /** Temperature to which the thermostat should cool (in °F). */
10119
10173
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10174
+ /** Temperature to which the thermostat should heat (in °F). */
10120
10175
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
10176
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10121
10177
  manual_override_allowed?: boolean | undefined;
10122
10178
  } | undefined;
10123
10179
  /**
10124
10180
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
10125
10181
  default_climate_setting?: {
10182
+ /** Unique key to identify the climate preset. */
10126
10183
  climate_preset_key?: string | undefined;
10184
+ /** Indicates whether this climate preset key can be edited. */
10127
10185
  can_edit?: boolean | undefined;
10186
+ /** Indicates whether this climate preset key can be deleted. */
10128
10187
  can_delete?: boolean | undefined;
10188
+ /** User-friendly name to identify the climate preset. */
10129
10189
  name?: ((string | null) | undefined) | undefined;
10190
+ /** Display name for the climate preset. */
10130
10191
  display_name?: string | undefined;
10192
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10131
10193
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
10194
+ /** 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`. */
10132
10195
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
10196
+ /** 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). */
10133
10197
  cooling_set_point_celsius?: (number | undefined) | undefined;
10198
+ /** Temperature to which the thermostat should heat (in °C). */
10134
10199
  heating_set_point_celsius?: (number | undefined) | undefined;
10200
+ /** Temperature to which the thermostat should cool (in °F). */
10135
10201
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10202
+ /** Temperature to which the thermostat should heat (in °F). */
10136
10203
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
10204
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10137
10205
  manual_override_allowed?: boolean | undefined;
10138
10206
  } | undefined;
10139
10207
  available_climate_presets?: Array<{
10208
+ /** Unique key to identify the climate preset. */
10140
10209
  climate_preset_key: string;
10210
+ /** Indicates whether this climate preset key can be edited. */
10141
10211
  can_edit: boolean;
10212
+ /** Indicates whether this climate preset key can be deleted. */
10142
10213
  can_delete: boolean;
10214
+ /** User-friendly name to identify the climate preset. */
10143
10215
  name?: (string | null) | undefined;
10216
+ /** Display name for the climate preset. */
10144
10217
  display_name: string;
10218
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10145
10219
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
10220
+ /** 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`. */
10146
10221
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10222
+ /** 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). */
10147
10223
  cooling_set_point_celsius?: number | undefined;
10224
+ /** Temperature to which the thermostat should heat (in °C). */
10148
10225
  heating_set_point_celsius?: number | undefined;
10226
+ /** Temperature to which the thermostat should cool (in °F). */
10149
10227
  cooling_set_point_fahrenheit?: number | undefined;
10228
+ /** Temperature to which the thermostat should heat (in °F). */
10150
10229
  heating_set_point_fahrenheit?: number | undefined;
10230
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10151
10231
  manual_override_allowed: boolean;
10152
10232
  }> | undefined;
10153
10233
  fallback_climate_preset_key?: (string | null) | undefined;
10154
10234
  active_thermostat_schedule?: ({
10235
+ /** ID of the climate schedule. */
10155
10236
  thermostat_schedule_id: string;
10237
+ /** ID of the desired thermostat device. */
10156
10238
  device_id: string;
10239
+ /** User-friendly name to identify the climate schedule. */
10157
10240
  name?: string | undefined;
10241
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
10158
10242
  climate_preset_key: string;
10243
+ /** 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). */
10159
10244
  max_override_period_minutes: number;
10245
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10160
10246
  starts_at: string;
10247
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10161
10248
  ends_at: string;
10249
+ /** Date and time at which the climate schedule was created. */
10162
10250
  created_at: string;
10163
- /** 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. */
10251
+ /** 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. */
10164
10252
  errors?: any;
10165
10253
  } | null) | undefined;
10166
10254
  min_cooling_set_point_celsius?: number | undefined;
@@ -10231,19 +10319,31 @@ export interface Routes {
10231
10319
  queryParams: {};
10232
10320
  jsonBody: {};
10233
10321
  commonParams: {
10234
- /** List all devices owned by this connected account */
10322
+ /** ID of the connected account by which to filter. */
10235
10323
  connected_account_id?: string | undefined;
10324
+ /** Array of IDs of the connected accounts by which to filter devices. */
10236
10325
  connected_account_ids?: string[] | undefined;
10326
+ /** ID of the Connect Webview by which to filter devices. */
10237
10327
  connect_webview_id?: string | undefined;
10328
+ /** Device type by which to filter devices. */
10238
10329
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
10330
+ /** Array of device types by which to filter devices. */
10239
10331
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
10332
+ /** Manufacturer by which to filter devices. */
10240
10333
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
10334
+ /** Array of device IDs by which to filter devices. */
10241
10335
  device_ids?: string[] | undefined;
10336
+ /** Numerical limit on the number of devices to return. */
10242
10337
  limit?: number;
10338
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
10243
10339
  created_before?: Date | undefined;
10340
+ /** Your own internal user ID for the user by which to filter devices. */
10244
10341
  user_identifier_key?: string | undefined;
10342
+ /** 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. */
10245
10343
  custom_metadata_has?: Record<string, string | boolean> | undefined;
10344
+ /** */
10246
10345
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
10346
+ /** */
10247
10347
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
10248
10348
  };
10249
10349
  formData: {};
@@ -10595,60 +10695,104 @@ export interface Routes {
10595
10695
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
10596
10696
  is_temporary_manual_override_active?: boolean | undefined;
10597
10697
  current_climate_setting?: {
10698
+ /** Unique key to identify the climate preset. */
10598
10699
  climate_preset_key?: string | undefined;
10700
+ /** Indicates whether this climate preset key can be edited. */
10599
10701
  can_edit?: boolean | undefined;
10702
+ /** Indicates whether this climate preset key can be deleted. */
10600
10703
  can_delete?: boolean | undefined;
10704
+ /** User-friendly name to identify the climate preset. */
10601
10705
  name?: ((string | null) | undefined) | undefined;
10706
+ /** Display name for the climate preset. */
10602
10707
  display_name?: string | undefined;
10708
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10603
10709
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
10710
+ /** 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`. */
10604
10711
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
10712
+ /** 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). */
10605
10713
  cooling_set_point_celsius?: (number | undefined) | undefined;
10714
+ /** Temperature to which the thermostat should heat (in °C). */
10606
10715
  heating_set_point_celsius?: (number | undefined) | undefined;
10716
+ /** Temperature to which the thermostat should cool (in °F). */
10607
10717
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10718
+ /** Temperature to which the thermostat should heat (in °F). */
10608
10719
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
10720
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10609
10721
  manual_override_allowed?: boolean | undefined;
10610
10722
  } | undefined;
10611
10723
  /**
10612
10724
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
10613
10725
  default_climate_setting?: {
10726
+ /** Unique key to identify the climate preset. */
10614
10727
  climate_preset_key?: string | undefined;
10728
+ /** Indicates whether this climate preset key can be edited. */
10615
10729
  can_edit?: boolean | undefined;
10730
+ /** Indicates whether this climate preset key can be deleted. */
10616
10731
  can_delete?: boolean | undefined;
10732
+ /** User-friendly name to identify the climate preset. */
10617
10733
  name?: ((string | null) | undefined) | undefined;
10734
+ /** Display name for the climate preset. */
10618
10735
  display_name?: string | undefined;
10736
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10619
10737
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
10738
+ /** 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`. */
10620
10739
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
10740
+ /** 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). */
10621
10741
  cooling_set_point_celsius?: (number | undefined) | undefined;
10742
+ /** Temperature to which the thermostat should heat (in °C). */
10622
10743
  heating_set_point_celsius?: (number | undefined) | undefined;
10744
+ /** Temperature to which the thermostat should cool (in °F). */
10623
10745
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
10746
+ /** Temperature to which the thermostat should heat (in °F). */
10624
10747
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
10748
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10625
10749
  manual_override_allowed?: boolean | undefined;
10626
10750
  } | undefined;
10627
10751
  available_climate_presets?: Array<{
10752
+ /** Unique key to identify the climate preset. */
10628
10753
  climate_preset_key: string;
10754
+ /** Indicates whether this climate preset key can be edited. */
10629
10755
  can_edit: boolean;
10756
+ /** Indicates whether this climate preset key can be deleted. */
10630
10757
  can_delete: boolean;
10758
+ /** User-friendly name to identify the climate preset. */
10631
10759
  name?: (string | null) | undefined;
10760
+ /** Display name for the climate preset. */
10632
10761
  display_name: string;
10762
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
10633
10763
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
10764
+ /** 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`. */
10634
10765
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
10766
+ /** 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). */
10635
10767
  cooling_set_point_celsius?: number | undefined;
10768
+ /** Temperature to which the thermostat should heat (in °C). */
10636
10769
  heating_set_point_celsius?: number | undefined;
10770
+ /** Temperature to which the thermostat should cool (in °F). */
10637
10771
  cooling_set_point_fahrenheit?: number | undefined;
10772
+ /** Temperature to which the thermostat should heat (in °F). */
10638
10773
  heating_set_point_fahrenheit?: number | undefined;
10774
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
10639
10775
  manual_override_allowed: boolean;
10640
10776
  }> | undefined;
10641
10777
  fallback_climate_preset_key?: (string | null) | undefined;
10642
10778
  active_thermostat_schedule?: ({
10779
+ /** ID of the climate schedule. */
10643
10780
  thermostat_schedule_id: string;
10781
+ /** ID of the desired thermostat device. */
10644
10782
  device_id: string;
10783
+ /** User-friendly name to identify the climate schedule. */
10645
10784
  name?: string | undefined;
10785
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
10646
10786
  climate_preset_key: string;
10787
+ /** 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). */
10647
10788
  max_override_period_minutes: number;
10789
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10648
10790
  starts_at: string;
10791
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10649
10792
  ends_at: string;
10793
+ /** Date and time at which the climate schedule was created. */
10650
10794
  created_at: string;
10651
- /** 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. */
10795
+ /** 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. */
10652
10796
  errors?: any;
10653
10797
  } | null) | undefined;
10654
10798
  min_cooling_set_point_celsius?: number | undefined;
@@ -10892,19 +11036,31 @@ export interface Routes {
10892
11036
  queryParams: {};
10893
11037
  jsonBody: {};
10894
11038
  commonParams: {
10895
- /** List all devices owned by this connected account */
11039
+ /** ID of the connected account by which to filter. */
10896
11040
  connected_account_id?: string | undefined;
11041
+ /** Array of IDs of the connected accounts by which to filter devices. */
10897
11042
  connected_account_ids?: string[] | undefined;
11043
+ /** ID of the Connect Webview by which to filter devices. */
10898
11044
  connect_webview_id?: string | undefined;
11045
+ /** Device type by which to filter devices. */
10899
11046
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
11047
+ /** Array of device types by which to filter devices. */
10900
11048
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
11049
+ /** Manufacturer by which to filter devices. */
10901
11050
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
11051
+ /** Array of device IDs by which to filter devices. */
10902
11052
  device_ids?: string[] | undefined;
11053
+ /** Numerical limit on the number of devices to return. */
10903
11054
  limit?: number;
11055
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
10904
11056
  created_before?: Date | undefined;
11057
+ /** Your own internal user ID for the user by which to filter devices. */
10905
11058
  user_identifier_key?: string | undefined;
11059
+ /** 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. */
10906
11060
  custom_metadata_has?: Record<string, string | boolean> | undefined;
11061
+ /** */
10907
11062
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
11063
+ /** */
10908
11064
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
10909
11065
  };
10910
11066
  formData: {};
@@ -11486,60 +11642,104 @@ export interface Routes {
11486
11642
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
11487
11643
  is_temporary_manual_override_active?: boolean | undefined;
11488
11644
  current_climate_setting?: {
11645
+ /** Unique key to identify the climate preset. */
11489
11646
  climate_preset_key?: string | undefined;
11647
+ /** Indicates whether this climate preset key can be edited. */
11490
11648
  can_edit?: boolean | undefined;
11649
+ /** Indicates whether this climate preset key can be deleted. */
11491
11650
  can_delete?: boolean | undefined;
11651
+ /** User-friendly name to identify the climate preset. */
11492
11652
  name?: ((string | null) | undefined) | undefined;
11653
+ /** Display name for the climate preset. */
11493
11654
  display_name?: string | undefined;
11655
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11494
11656
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
11657
+ /** 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`. */
11495
11658
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
11659
+ /** 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). */
11496
11660
  cooling_set_point_celsius?: (number | undefined) | undefined;
11661
+ /** Temperature to which the thermostat should heat (in °C). */
11497
11662
  heating_set_point_celsius?: (number | undefined) | undefined;
11663
+ /** Temperature to which the thermostat should cool (in °F). */
11498
11664
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11665
+ /** Temperature to which the thermostat should heat (in °F). */
11499
11666
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
11667
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11500
11668
  manual_override_allowed?: boolean | undefined;
11501
11669
  } | undefined;
11502
11670
  /**
11503
11671
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11504
11672
  default_climate_setting?: {
11673
+ /** Unique key to identify the climate preset. */
11505
11674
  climate_preset_key?: string | undefined;
11675
+ /** Indicates whether this climate preset key can be edited. */
11506
11676
  can_edit?: boolean | undefined;
11677
+ /** Indicates whether this climate preset key can be deleted. */
11507
11678
  can_delete?: boolean | undefined;
11679
+ /** User-friendly name to identify the climate preset. */
11508
11680
  name?: ((string | null) | undefined) | undefined;
11681
+ /** Display name for the climate preset. */
11509
11682
  display_name?: string | undefined;
11683
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11510
11684
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
11685
+ /** 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`. */
11511
11686
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
11687
+ /** 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). */
11512
11688
  cooling_set_point_celsius?: (number | undefined) | undefined;
11689
+ /** Temperature to which the thermostat should heat (in °C). */
11513
11690
  heating_set_point_celsius?: (number | undefined) | undefined;
11691
+ /** Temperature to which the thermostat should cool (in °F). */
11514
11692
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11693
+ /** Temperature to which the thermostat should heat (in °F). */
11515
11694
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
11695
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11516
11696
  manual_override_allowed?: boolean | undefined;
11517
11697
  } | undefined;
11518
11698
  available_climate_presets?: Array<{
11699
+ /** Unique key to identify the climate preset. */
11519
11700
  climate_preset_key: string;
11701
+ /** Indicates whether this climate preset key can be edited. */
11520
11702
  can_edit: boolean;
11703
+ /** Indicates whether this climate preset key can be deleted. */
11521
11704
  can_delete: boolean;
11705
+ /** User-friendly name to identify the climate preset. */
11522
11706
  name?: (string | null) | undefined;
11707
+ /** Display name for the climate preset. */
11523
11708
  display_name: string;
11709
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11524
11710
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
11711
+ /** 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`. */
11525
11712
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11713
+ /** 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). */
11526
11714
  cooling_set_point_celsius?: number | undefined;
11715
+ /** Temperature to which the thermostat should heat (in °C). */
11527
11716
  heating_set_point_celsius?: number | undefined;
11717
+ /** Temperature to which the thermostat should cool (in °F). */
11528
11718
  cooling_set_point_fahrenheit?: number | undefined;
11719
+ /** Temperature to which the thermostat should heat (in °F). */
11529
11720
  heating_set_point_fahrenheit?: number | undefined;
11721
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11530
11722
  manual_override_allowed: boolean;
11531
11723
  }> | undefined;
11532
11724
  fallback_climate_preset_key?: (string | null) | undefined;
11533
11725
  active_thermostat_schedule?: ({
11726
+ /** ID of the climate schedule. */
11534
11727
  thermostat_schedule_id: string;
11728
+ /** ID of the desired thermostat device. */
11535
11729
  device_id: string;
11730
+ /** User-friendly name to identify the climate schedule. */
11536
11731
  name?: string | undefined;
11732
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
11537
11733
  climate_preset_key: string;
11734
+ /** 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). */
11538
11735
  max_override_period_minutes: number;
11736
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11539
11737
  starts_at: string;
11738
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11540
11739
  ends_at: string;
11740
+ /** Date and time at which the climate schedule was created. */
11541
11741
  created_at: string;
11542
- /** 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. */
11742
+ /** 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. */
11543
11743
  errors?: any;
11544
11744
  } | null) | undefined;
11545
11745
  min_cooling_set_point_celsius?: number | undefined;
@@ -11949,60 +12149,104 @@ export interface Routes {
11949
12149
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
11950
12150
  is_temporary_manual_override_active?: boolean | undefined;
11951
12151
  current_climate_setting?: {
12152
+ /** Unique key to identify the climate preset. */
11952
12153
  climate_preset_key?: string | undefined;
12154
+ /** Indicates whether this climate preset key can be edited. */
11953
12155
  can_edit?: boolean | undefined;
12156
+ /** Indicates whether this climate preset key can be deleted. */
11954
12157
  can_delete?: boolean | undefined;
12158
+ /** User-friendly name to identify the climate preset. */
11955
12159
  name?: ((string | null) | undefined) | undefined;
12160
+ /** Display name for the climate preset. */
11956
12161
  display_name?: string | undefined;
12162
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11957
12163
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
12164
+ /** 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`. */
11958
12165
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12166
+ /** 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). */
11959
12167
  cooling_set_point_celsius?: (number | undefined) | undefined;
12168
+ /** Temperature to which the thermostat should heat (in °C). */
11960
12169
  heating_set_point_celsius?: (number | undefined) | undefined;
12170
+ /** Temperature to which the thermostat should cool (in °F). */
11961
12171
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12172
+ /** Temperature to which the thermostat should heat (in °F). */
11962
12173
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
12174
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11963
12175
  manual_override_allowed?: boolean | undefined;
11964
12176
  } | undefined;
11965
12177
  /**
11966
12178
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
11967
12179
  default_climate_setting?: {
12180
+ /** Unique key to identify the climate preset. */
11968
12181
  climate_preset_key?: string | undefined;
12182
+ /** Indicates whether this climate preset key can be edited. */
11969
12183
  can_edit?: boolean | undefined;
12184
+ /** Indicates whether this climate preset key can be deleted. */
11970
12185
  can_delete?: boolean | undefined;
12186
+ /** User-friendly name to identify the climate preset. */
11971
12187
  name?: ((string | null) | undefined) | undefined;
12188
+ /** Display name for the climate preset. */
11972
12189
  display_name?: string | undefined;
12190
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11973
12191
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
12192
+ /** 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`. */
11974
12193
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12194
+ /** 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). */
11975
12195
  cooling_set_point_celsius?: (number | undefined) | undefined;
12196
+ /** Temperature to which the thermostat should heat (in °C). */
11976
12197
  heating_set_point_celsius?: (number | undefined) | undefined;
12198
+ /** Temperature to which the thermostat should cool (in °F). */
11977
12199
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12200
+ /** Temperature to which the thermostat should heat (in °F). */
11978
12201
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
12202
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11979
12203
  manual_override_allowed?: boolean | undefined;
11980
12204
  } | undefined;
11981
12205
  available_climate_presets?: Array<{
12206
+ /** Unique key to identify the climate preset. */
11982
12207
  climate_preset_key: string;
12208
+ /** Indicates whether this climate preset key can be edited. */
11983
12209
  can_edit: boolean;
12210
+ /** Indicates whether this climate preset key can be deleted. */
11984
12211
  can_delete: boolean;
12212
+ /** User-friendly name to identify the climate preset. */
11985
12213
  name?: (string | null) | undefined;
12214
+ /** Display name for the climate preset. */
11986
12215
  display_name: string;
12216
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
11987
12217
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
12218
+ /** 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`. */
11988
12219
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12220
+ /** 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). */
11989
12221
  cooling_set_point_celsius?: number | undefined;
12222
+ /** Temperature to which the thermostat should heat (in °C). */
11990
12223
  heating_set_point_celsius?: number | undefined;
12224
+ /** Temperature to which the thermostat should cool (in °F). */
11991
12225
  cooling_set_point_fahrenheit?: number | undefined;
12226
+ /** Temperature to which the thermostat should heat (in °F). */
11992
12227
  heating_set_point_fahrenheit?: number | undefined;
12228
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
11993
12229
  manual_override_allowed: boolean;
11994
12230
  }> | undefined;
11995
12231
  fallback_climate_preset_key?: (string | null) | undefined;
11996
12232
  active_thermostat_schedule?: ({
12233
+ /** ID of the climate schedule. */
11997
12234
  thermostat_schedule_id: string;
12235
+ /** ID of the desired thermostat device. */
11998
12236
  device_id: string;
12237
+ /** User-friendly name to identify the climate schedule. */
11999
12238
  name?: string | undefined;
12239
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12000
12240
  climate_preset_key: string;
12241
+ /** 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). */
12001
12242
  max_override_period_minutes: number;
12243
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12002
12244
  starts_at: string;
12245
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12003
12246
  ends_at: string;
12247
+ /** Date and time at which the climate schedule was created. */
12004
12248
  created_at: string;
12005
- /** 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. */
12249
+ /** 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. */
12006
12250
  errors?: any;
12007
12251
  } | null) | undefined;
12008
12252
  min_cooling_set_point_celsius?: number | undefined;
@@ -12073,19 +12317,31 @@ export interface Routes {
12073
12317
  queryParams: {};
12074
12318
  jsonBody: {};
12075
12319
  commonParams: {
12076
- /** List all devices owned by this connected account */
12320
+ /** ID of the connected account by which to filter. */
12077
12321
  connected_account_id?: string | undefined;
12322
+ /** Array of IDs of the connected accounts by which to filter devices. */
12078
12323
  connected_account_ids?: string[] | undefined;
12324
+ /** ID of the Connect Webview by which to filter devices. */
12079
12325
  connect_webview_id?: string | undefined;
12326
+ /** Device type by which to filter devices. */
12080
12327
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
12328
+ /** Array of device types by which to filter devices. */
12081
12329
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
12330
+ /** Manufacturer by which to filter devices. */
12082
12331
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
12332
+ /** Array of device IDs by which to filter devices. */
12083
12333
  device_ids?: string[] | undefined;
12334
+ /** Numerical limit on the number of devices to return. */
12084
12335
  limit?: number;
12336
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
12085
12337
  created_before?: Date | undefined;
12338
+ /** Your own internal user ID for the user by which to filter devices. */
12086
12339
  user_identifier_key?: string | undefined;
12340
+ /** 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. */
12087
12341
  custom_metadata_has?: Record<string, string | boolean> | undefined;
12342
+ /** */
12088
12343
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
12344
+ /** */
12089
12345
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
12090
12346
  };
12091
12347
  formData: {};
@@ -12437,60 +12693,104 @@ export interface Routes {
12437
12693
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
12438
12694
  is_temporary_manual_override_active?: boolean | undefined;
12439
12695
  current_climate_setting?: {
12696
+ /** Unique key to identify the climate preset. */
12440
12697
  climate_preset_key?: string | undefined;
12698
+ /** Indicates whether this climate preset key can be edited. */
12441
12699
  can_edit?: boolean | undefined;
12700
+ /** Indicates whether this climate preset key can be deleted. */
12442
12701
  can_delete?: boolean | undefined;
12702
+ /** User-friendly name to identify the climate preset. */
12443
12703
  name?: ((string | null) | undefined) | undefined;
12704
+ /** Display name for the climate preset. */
12444
12705
  display_name?: string | undefined;
12706
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12445
12707
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
12708
+ /** 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`. */
12446
12709
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12710
+ /** 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). */
12447
12711
  cooling_set_point_celsius?: (number | undefined) | undefined;
12712
+ /** Temperature to which the thermostat should heat (in °C). */
12448
12713
  heating_set_point_celsius?: (number | undefined) | undefined;
12714
+ /** Temperature to which the thermostat should cool (in °F). */
12449
12715
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12716
+ /** Temperature to which the thermostat should heat (in °F). */
12450
12717
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
12718
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12451
12719
  manual_override_allowed?: boolean | undefined;
12452
12720
  } | undefined;
12453
12721
  /**
12454
12722
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12455
12723
  default_climate_setting?: {
12724
+ /** Unique key to identify the climate preset. */
12456
12725
  climate_preset_key?: string | undefined;
12726
+ /** Indicates whether this climate preset key can be edited. */
12457
12727
  can_edit?: boolean | undefined;
12728
+ /** Indicates whether this climate preset key can be deleted. */
12458
12729
  can_delete?: boolean | undefined;
12730
+ /** User-friendly name to identify the climate preset. */
12459
12731
  name?: ((string | null) | undefined) | undefined;
12732
+ /** Display name for the climate preset. */
12460
12733
  display_name?: string | undefined;
12734
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12461
12735
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
12736
+ /** 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`. */
12462
12737
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
12738
+ /** 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). */
12463
12739
  cooling_set_point_celsius?: (number | undefined) | undefined;
12740
+ /** Temperature to which the thermostat should heat (in °C). */
12464
12741
  heating_set_point_celsius?: (number | undefined) | undefined;
12742
+ /** Temperature to which the thermostat should cool (in °F). */
12465
12743
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12744
+ /** Temperature to which the thermostat should heat (in °F). */
12466
12745
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
12746
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12467
12747
  manual_override_allowed?: boolean | undefined;
12468
12748
  } | undefined;
12469
12749
  available_climate_presets?: Array<{
12750
+ /** Unique key to identify the climate preset. */
12470
12751
  climate_preset_key: string;
12752
+ /** Indicates whether this climate preset key can be edited. */
12471
12753
  can_edit: boolean;
12754
+ /** Indicates whether this climate preset key can be deleted. */
12472
12755
  can_delete: boolean;
12756
+ /** User-friendly name to identify the climate preset. */
12473
12757
  name?: (string | null) | undefined;
12758
+ /** Display name for the climate preset. */
12474
12759
  display_name: string;
12760
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12475
12761
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
12762
+ /** 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`. */
12476
12763
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12764
+ /** 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). */
12477
12765
  cooling_set_point_celsius?: number | undefined;
12766
+ /** Temperature to which the thermostat should heat (in °C). */
12478
12767
  heating_set_point_celsius?: number | undefined;
12768
+ /** Temperature to which the thermostat should cool (in °F). */
12479
12769
  cooling_set_point_fahrenheit?: number | undefined;
12770
+ /** Temperature to which the thermostat should heat (in °F). */
12480
12771
  heating_set_point_fahrenheit?: number | undefined;
12772
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12481
12773
  manual_override_allowed: boolean;
12482
12774
  }> | undefined;
12483
12775
  fallback_climate_preset_key?: (string | null) | undefined;
12484
12776
  active_thermostat_schedule?: ({
12777
+ /** ID of the climate schedule. */
12485
12778
  thermostat_schedule_id: string;
12779
+ /** ID of the desired thermostat device. */
12486
12780
  device_id: string;
12781
+ /** User-friendly name to identify the climate schedule. */
12487
12782
  name?: string | undefined;
12783
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12488
12784
  climate_preset_key: string;
12785
+ /** 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). */
12489
12786
  max_override_period_minutes: number;
12787
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12490
12788
  starts_at: string;
12789
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12491
12790
  ends_at: string;
12791
+ /** Date and time at which the climate schedule was created. */
12492
12792
  created_at: string;
12493
- /** 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. */
12793
+ /** 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. */
12494
12794
  errors?: any;
12495
12795
  } | null) | undefined;
12496
12796
  min_cooling_set_point_celsius?: number | undefined;
@@ -12900,60 +13200,104 @@ export interface Routes {
12900
13200
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
12901
13201
  is_temporary_manual_override_active?: boolean | undefined;
12902
13202
  current_climate_setting?: {
13203
+ /** Unique key to identify the climate preset. */
12903
13204
  climate_preset_key?: string | undefined;
13205
+ /** Indicates whether this climate preset key can be edited. */
12904
13206
  can_edit?: boolean | undefined;
13207
+ /** Indicates whether this climate preset key can be deleted. */
12905
13208
  can_delete?: boolean | undefined;
13209
+ /** User-friendly name to identify the climate preset. */
12906
13210
  name?: ((string | null) | undefined) | undefined;
13211
+ /** Display name for the climate preset. */
12907
13212
  display_name?: string | undefined;
13213
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12908
13214
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
13215
+ /** 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`. */
12909
13216
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
13217
+ /** 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). */
12910
13218
  cooling_set_point_celsius?: (number | undefined) | undefined;
13219
+ /** Temperature to which the thermostat should heat (in °C). */
12911
13220
  heating_set_point_celsius?: (number | undefined) | undefined;
13221
+ /** Temperature to which the thermostat should cool (in °F). */
12912
13222
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13223
+ /** Temperature to which the thermostat should heat (in °F). */
12913
13224
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
13225
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12914
13226
  manual_override_allowed?: boolean | undefined;
12915
13227
  } | undefined;
12916
13228
  /**
12917
13229
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12918
13230
  default_climate_setting?: {
13231
+ /** Unique key to identify the climate preset. */
12919
13232
  climate_preset_key?: string | undefined;
13233
+ /** Indicates whether this climate preset key can be edited. */
12920
13234
  can_edit?: boolean | undefined;
13235
+ /** Indicates whether this climate preset key can be deleted. */
12921
13236
  can_delete?: boolean | undefined;
13237
+ /** User-friendly name to identify the climate preset. */
12922
13238
  name?: ((string | null) | undefined) | undefined;
13239
+ /** Display name for the climate preset. */
12923
13240
  display_name?: string | undefined;
13241
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12924
13242
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
13243
+ /** 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`. */
12925
13244
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
13245
+ /** 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). */
12926
13246
  cooling_set_point_celsius?: (number | undefined) | undefined;
13247
+ /** Temperature to which the thermostat should heat (in °C). */
12927
13248
  heating_set_point_celsius?: (number | undefined) | undefined;
13249
+ /** Temperature to which the thermostat should cool (in °F). */
12928
13250
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13251
+ /** Temperature to which the thermostat should heat (in °F). */
12929
13252
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
13253
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12930
13254
  manual_override_allowed?: boolean | undefined;
12931
13255
  } | undefined;
12932
13256
  available_climate_presets?: Array<{
13257
+ /** Unique key to identify the climate preset. */
12933
13258
  climate_preset_key: string;
13259
+ /** Indicates whether this climate preset key can be edited. */
12934
13260
  can_edit: boolean;
13261
+ /** Indicates whether this climate preset key can be deleted. */
12935
13262
  can_delete: boolean;
13263
+ /** User-friendly name to identify the climate preset. */
12936
13264
  name?: (string | null) | undefined;
13265
+ /** Display name for the climate preset. */
12937
13266
  display_name: string;
13267
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12938
13268
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
13269
+ /** 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`. */
12939
13270
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13271
+ /** 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). */
12940
13272
  cooling_set_point_celsius?: number | undefined;
13273
+ /** Temperature to which the thermostat should heat (in °C). */
12941
13274
  heating_set_point_celsius?: number | undefined;
13275
+ /** Temperature to which the thermostat should cool (in °F). */
12942
13276
  cooling_set_point_fahrenheit?: number | undefined;
13277
+ /** Temperature to which the thermostat should heat (in °F). */
12943
13278
  heating_set_point_fahrenheit?: number | undefined;
13279
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12944
13280
  manual_override_allowed: boolean;
12945
13281
  }> | undefined;
12946
13282
  fallback_climate_preset_key?: (string | null) | undefined;
12947
13283
  active_thermostat_schedule?: ({
13284
+ /** ID of the climate schedule. */
12948
13285
  thermostat_schedule_id: string;
13286
+ /** ID of the desired thermostat device. */
12949
13287
  device_id: string;
13288
+ /** User-friendly name to identify the climate schedule. */
12950
13289
  name?: string | undefined;
13290
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12951
13291
  climate_preset_key: string;
13292
+ /** 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). */
12952
13293
  max_override_period_minutes: number;
13294
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12953
13295
  starts_at: string;
13296
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12954
13297
  ends_at: string;
13298
+ /** Date and time at which the climate schedule was created. */
12955
13299
  created_at: string;
12956
- /** 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. */
13300
+ /** 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. */
12957
13301
  errors?: any;
12958
13302
  } | null) | undefined;
12959
13303
  min_cooling_set_point_celsius?: number | undefined;
@@ -14524,19 +14868,31 @@ export interface Routes {
14524
14868
  queryParams: {};
14525
14869
  jsonBody: {};
14526
14870
  commonParams: {
14527
- /** List all devices owned by this connected account */
14871
+ /** ID of the connected account by which to filter. */
14528
14872
  connected_account_id?: string | undefined;
14873
+ /** Array of IDs of the connected accounts by which to filter devices. */
14529
14874
  connected_account_ids?: string[] | undefined;
14875
+ /** ID of the Connect Webview by which to filter devices. */
14530
14876
  connect_webview_id?: string | undefined;
14877
+ /** Device type by which to filter devices. */
14531
14878
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
14879
+ /** Array of device types by which to filter devices. */
14532
14880
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
14881
+ /** Manufacturer by which to filter devices. */
14533
14882
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
14883
+ /** Array of device IDs by which to filter devices. */
14534
14884
  device_ids?: string[] | undefined;
14885
+ /** Numerical limit on the number of devices to return. */
14535
14886
  limit?: number;
14887
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
14536
14888
  created_before?: Date | undefined;
14889
+ /** Your own internal user ID for the user by which to filter devices. */
14537
14890
  user_identifier_key?: string | undefined;
14891
+ /** 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. */
14538
14892
  custom_metadata_has?: Record<string, string | boolean> | undefined;
14893
+ /** */
14539
14894
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
14895
+ /** */
14540
14896
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
14541
14897
  };
14542
14898
  formData: {};
@@ -14888,60 +15244,104 @@ export interface Routes {
14888
15244
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
14889
15245
  is_temporary_manual_override_active?: boolean | undefined;
14890
15246
  current_climate_setting?: {
15247
+ /** Unique key to identify the climate preset. */
14891
15248
  climate_preset_key?: string | undefined;
15249
+ /** Indicates whether this climate preset key can be edited. */
14892
15250
  can_edit?: boolean | undefined;
15251
+ /** Indicates whether this climate preset key can be deleted. */
14893
15252
  can_delete?: boolean | undefined;
15253
+ /** User-friendly name to identify the climate preset. */
14894
15254
  name?: ((string | null) | undefined) | undefined;
15255
+ /** Display name for the climate preset. */
14895
15256
  display_name?: string | undefined;
15257
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14896
15258
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
15259
+ /** 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`. */
14897
15260
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15261
+ /** 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). */
14898
15262
  cooling_set_point_celsius?: (number | undefined) | undefined;
15263
+ /** Temperature to which the thermostat should heat (in °C). */
14899
15264
  heating_set_point_celsius?: (number | undefined) | undefined;
15265
+ /** Temperature to which the thermostat should cool (in °F). */
14900
15266
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15267
+ /** Temperature to which the thermostat should heat (in °F). */
14901
15268
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
15269
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14902
15270
  manual_override_allowed?: boolean | undefined;
14903
15271
  } | undefined;
14904
15272
  /**
14905
15273
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14906
15274
  default_climate_setting?: {
15275
+ /** Unique key to identify the climate preset. */
14907
15276
  climate_preset_key?: string | undefined;
15277
+ /** Indicates whether this climate preset key can be edited. */
14908
15278
  can_edit?: boolean | undefined;
15279
+ /** Indicates whether this climate preset key can be deleted. */
14909
15280
  can_delete?: boolean | undefined;
15281
+ /** User-friendly name to identify the climate preset. */
14910
15282
  name?: ((string | null) | undefined) | undefined;
15283
+ /** Display name for the climate preset. */
14911
15284
  display_name?: string | undefined;
15285
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14912
15286
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
15287
+ /** 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`. */
14913
15288
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15289
+ /** 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). */
14914
15290
  cooling_set_point_celsius?: (number | undefined) | undefined;
15291
+ /** Temperature to which the thermostat should heat (in °C). */
14915
15292
  heating_set_point_celsius?: (number | undefined) | undefined;
15293
+ /** Temperature to which the thermostat should cool (in °F). */
14916
15294
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15295
+ /** Temperature to which the thermostat should heat (in °F). */
14917
15296
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
15297
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14918
15298
  manual_override_allowed?: boolean | undefined;
14919
15299
  } | undefined;
14920
15300
  available_climate_presets?: Array<{
15301
+ /** Unique key to identify the climate preset. */
14921
15302
  climate_preset_key: string;
15303
+ /** Indicates whether this climate preset key can be edited. */
14922
15304
  can_edit: boolean;
15305
+ /** Indicates whether this climate preset key can be deleted. */
14923
15306
  can_delete: boolean;
15307
+ /** User-friendly name to identify the climate preset. */
14924
15308
  name?: (string | null) | undefined;
15309
+ /** Display name for the climate preset. */
14925
15310
  display_name: string;
15311
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14926
15312
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
15313
+ /** 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`. */
14927
15314
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15315
+ /** 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). */
14928
15316
  cooling_set_point_celsius?: number | undefined;
15317
+ /** Temperature to which the thermostat should heat (in °C). */
14929
15318
  heating_set_point_celsius?: number | undefined;
15319
+ /** Temperature to which the thermostat should cool (in °F). */
14930
15320
  cooling_set_point_fahrenheit?: number | undefined;
15321
+ /** Temperature to which the thermostat should heat (in °F). */
14931
15322
  heating_set_point_fahrenheit?: number | undefined;
15323
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14932
15324
  manual_override_allowed: boolean;
14933
15325
  }> | undefined;
14934
15326
  fallback_climate_preset_key?: (string | null) | undefined;
14935
15327
  active_thermostat_schedule?: ({
15328
+ /** ID of the climate schedule. */
14936
15329
  thermostat_schedule_id: string;
15330
+ /** ID of the desired thermostat device. */
14937
15331
  device_id: string;
15332
+ /** User-friendly name to identify the climate schedule. */
14938
15333
  name?: string | undefined;
15334
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
14939
15335
  climate_preset_key: string;
15336
+ /** 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). */
14940
15337
  max_override_period_minutes: number;
15338
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14941
15339
  starts_at: string;
15340
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14942
15341
  ends_at: string;
15342
+ /** Date and time at which the climate schedule was created. */
14943
15343
  created_at: string;
14944
- /** 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. */
15344
+ /** 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. */
14945
15345
  errors?: any;
14946
15346
  } | null) | undefined;
14947
15347
  min_cooling_set_point_celsius?: number | undefined;
@@ -15351,60 +15751,104 @@ export interface Routes {
15351
15751
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
15352
15752
  is_temporary_manual_override_active?: boolean | undefined;
15353
15753
  current_climate_setting?: {
15754
+ /** Unique key to identify the climate preset. */
15354
15755
  climate_preset_key?: string | undefined;
15756
+ /** Indicates whether this climate preset key can be edited. */
15355
15757
  can_edit?: boolean | undefined;
15758
+ /** Indicates whether this climate preset key can be deleted. */
15356
15759
  can_delete?: boolean | undefined;
15760
+ /** User-friendly name to identify the climate preset. */
15357
15761
  name?: ((string | null) | undefined) | undefined;
15762
+ /** Display name for the climate preset. */
15358
15763
  display_name?: string | undefined;
15764
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15359
15765
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
15766
+ /** 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`. */
15360
15767
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15768
+ /** 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). */
15361
15769
  cooling_set_point_celsius?: (number | undefined) | undefined;
15770
+ /** Temperature to which the thermostat should heat (in °C). */
15362
15771
  heating_set_point_celsius?: (number | undefined) | undefined;
15772
+ /** Temperature to which the thermostat should cool (in °F). */
15363
15773
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15774
+ /** Temperature to which the thermostat should heat (in °F). */
15364
15775
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
15776
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15365
15777
  manual_override_allowed?: boolean | undefined;
15366
15778
  } | undefined;
15367
15779
  /**
15368
15780
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
15369
15781
  default_climate_setting?: {
15782
+ /** Unique key to identify the climate preset. */
15370
15783
  climate_preset_key?: string | undefined;
15784
+ /** Indicates whether this climate preset key can be edited. */
15371
15785
  can_edit?: boolean | undefined;
15786
+ /** Indicates whether this climate preset key can be deleted. */
15372
15787
  can_delete?: boolean | undefined;
15788
+ /** User-friendly name to identify the climate preset. */
15373
15789
  name?: ((string | null) | undefined) | undefined;
15790
+ /** Display name for the climate preset. */
15374
15791
  display_name?: string | undefined;
15792
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15375
15793
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
15794
+ /** 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`. */
15376
15795
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
15796
+ /** 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). */
15377
15797
  cooling_set_point_celsius?: (number | undefined) | undefined;
15798
+ /** Temperature to which the thermostat should heat (in °C). */
15378
15799
  heating_set_point_celsius?: (number | undefined) | undefined;
15800
+ /** Temperature to which the thermostat should cool (in °F). */
15379
15801
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
15802
+ /** Temperature to which the thermostat should heat (in °F). */
15380
15803
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
15804
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15381
15805
  manual_override_allowed?: boolean | undefined;
15382
15806
  } | undefined;
15383
15807
  available_climate_presets?: Array<{
15808
+ /** Unique key to identify the climate preset. */
15384
15809
  climate_preset_key: string;
15810
+ /** Indicates whether this climate preset key can be edited. */
15385
15811
  can_edit: boolean;
15812
+ /** Indicates whether this climate preset key can be deleted. */
15386
15813
  can_delete: boolean;
15814
+ /** User-friendly name to identify the climate preset. */
15387
15815
  name?: (string | null) | undefined;
15816
+ /** Display name for the climate preset. */
15388
15817
  display_name: string;
15818
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15389
15819
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
15820
+ /** 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`. */
15390
15821
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
15822
+ /** 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). */
15391
15823
  cooling_set_point_celsius?: number | undefined;
15824
+ /** Temperature to which the thermostat should heat (in °C). */
15392
15825
  heating_set_point_celsius?: number | undefined;
15826
+ /** Temperature to which the thermostat should cool (in °F). */
15393
15827
  cooling_set_point_fahrenheit?: number | undefined;
15828
+ /** Temperature to which the thermostat should heat (in °F). */
15394
15829
  heating_set_point_fahrenheit?: number | undefined;
15830
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15395
15831
  manual_override_allowed: boolean;
15396
15832
  }> | undefined;
15397
15833
  fallback_climate_preset_key?: (string | null) | undefined;
15398
15834
  active_thermostat_schedule?: ({
15835
+ /** ID of the climate schedule. */
15399
15836
  thermostat_schedule_id: string;
15837
+ /** ID of the desired thermostat device. */
15400
15838
  device_id: string;
15839
+ /** User-friendly name to identify the climate schedule. */
15401
15840
  name?: string | undefined;
15841
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
15402
15842
  climate_preset_key: string;
15843
+ /** 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). */
15403
15844
  max_override_period_minutes: number;
15845
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15404
15846
  starts_at: string;
15847
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15405
15848
  ends_at: string;
15849
+ /** Date and time at which the climate schedule was created. */
15406
15850
  created_at: string;
15407
- /** 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. */
15851
+ /** 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. */
15408
15852
  errors?: any;
15409
15853
  } | null) | undefined;
15410
15854
  min_cooling_set_point_celsius?: number | undefined;
@@ -17919,7 +18363,9 @@ export interface Routes {
17919
18363
  method: 'POST';
17920
18364
  queryParams: {};
17921
18365
  jsonBody: {
18366
+ /** ID of the desired thermostat device. */
17922
18367
  device_id: string;
18368
+ /** Climate preset key of the desired climate preset. */
17923
18369
  climate_preset_key: string;
17924
18370
  };
17925
18371
  commonParams: {};
@@ -18652,12 +19098,13 @@ export interface Routes {
18652
19098
  method: 'POST';
18653
19099
  queryParams: {};
18654
19100
  jsonBody: {
18655
- /** ID of the thermostat device. */
19101
+ /** ID of the desired thermostat device. */
18656
19102
  device_id: string;
18657
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
19103
+ /** 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. */
18658
19104
  cooling_set_point_celsius?: number | undefined;
18659
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
19105
+ /** 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. */
18660
19106
  cooling_set_point_fahrenheit?: number | undefined;
19107
+ /** */
18661
19108
  sync?: boolean;
18662
19109
  };
18663
19110
  commonParams: {};
@@ -19390,15 +19837,25 @@ export interface Routes {
19390
19837
  method: 'POST';
19391
19838
  queryParams: {};
19392
19839
  jsonBody: {
19840
+ /** ID of the desired thermostat device. */
19393
19841
  device_id: string;
19842
+ /** Unique key to identify the climate preset. */
19394
19843
  climate_preset_key: string;
19844
+ /** User-friendly name to identify the climate preset. */
19395
19845
  name?: (string | null) | undefined;
19846
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19396
19847
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
19848
+ /** 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`. */
19397
19849
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
19850
+ /** 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). */
19398
19851
  cooling_set_point_celsius?: number | undefined;
19852
+ /** Temperature to which the thermostat should heat (in °C). */
19399
19853
  heating_set_point_celsius?: number | undefined;
19854
+ /** Temperature to which the thermostat should cool (in °F). */
19400
19855
  cooling_set_point_fahrenheit?: number | undefined;
19856
+ /** Temperature to which the thermostat should heat (in °F). */
19401
19857
  heating_set_point_fahrenheit?: number | undefined;
19858
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19402
19859
  manual_override_allowed: boolean;
19403
19860
  };
19404
19861
  commonParams: {};
@@ -19410,7 +19867,9 @@ export interface Routes {
19410
19867
  method: 'POST' | 'DELETE';
19411
19868
  queryParams: {};
19412
19869
  jsonBody: {
19870
+ /** ID of the desired thermostat device. */
19413
19871
  device_id: string;
19872
+ /** Climate preset key of the desired climate preset. */
19414
19873
  climate_preset_key: string;
19415
19874
  };
19416
19875
  commonParams: {};
@@ -19423,9 +19882,9 @@ export interface Routes {
19423
19882
  queryParams: {};
19424
19883
  jsonBody: {};
19425
19884
  commonParams: {
19426
- /** ID of the thermostat device. */
19885
+ /** ID of the desired thermostat device. */
19427
19886
  device_id?: string | undefined;
19428
- /** Name of the thermostat. */
19887
+ /** User-friendly name of the desired thermostat device. */
19429
19888
  name?: string | undefined;
19430
19889
  };
19431
19890
  formData: {};
@@ -19777,60 +20236,104 @@ export interface Routes {
19777
20236
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
19778
20237
  is_temporary_manual_override_active?: boolean | undefined;
19779
20238
  current_climate_setting?: {
20239
+ /** Unique key to identify the climate preset. */
19780
20240
  climate_preset_key?: string | undefined;
20241
+ /** Indicates whether this climate preset key can be edited. */
19781
20242
  can_edit?: boolean | undefined;
20243
+ /** Indicates whether this climate preset key can be deleted. */
19782
20244
  can_delete?: boolean | undefined;
20245
+ /** User-friendly name to identify the climate preset. */
19783
20246
  name?: ((string | null) | undefined) | undefined;
20247
+ /** Display name for the climate preset. */
19784
20248
  display_name?: string | undefined;
20249
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19785
20250
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
20251
+ /** 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`. */
19786
20252
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
20253
+ /** 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). */
19787
20254
  cooling_set_point_celsius?: (number | undefined) | undefined;
20255
+ /** Temperature to which the thermostat should heat (in °C). */
19788
20256
  heating_set_point_celsius?: (number | undefined) | undefined;
20257
+ /** Temperature to which the thermostat should cool (in °F). */
19789
20258
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
20259
+ /** Temperature to which the thermostat should heat (in °F). */
19790
20260
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
20261
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19791
20262
  manual_override_allowed?: boolean | undefined;
19792
20263
  } | undefined;
19793
20264
  /**
19794
20265
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
19795
20266
  default_climate_setting?: {
20267
+ /** Unique key to identify the climate preset. */
19796
20268
  climate_preset_key?: string | undefined;
20269
+ /** Indicates whether this climate preset key can be edited. */
19797
20270
  can_edit?: boolean | undefined;
20271
+ /** Indicates whether this climate preset key can be deleted. */
19798
20272
  can_delete?: boolean | undefined;
20273
+ /** User-friendly name to identify the climate preset. */
19799
20274
  name?: ((string | null) | undefined) | undefined;
20275
+ /** Display name for the climate preset. */
19800
20276
  display_name?: string | undefined;
20277
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19801
20278
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
20279
+ /** 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`. */
19802
20280
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
20281
+ /** 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). */
19803
20282
  cooling_set_point_celsius?: (number | undefined) | undefined;
20283
+ /** Temperature to which the thermostat should heat (in °C). */
19804
20284
  heating_set_point_celsius?: (number | undefined) | undefined;
20285
+ /** Temperature to which the thermostat should cool (in °F). */
19805
20286
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
20287
+ /** Temperature to which the thermostat should heat (in °F). */
19806
20288
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
20289
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19807
20290
  manual_override_allowed?: boolean | undefined;
19808
20291
  } | undefined;
19809
20292
  available_climate_presets?: Array<{
20293
+ /** Unique key to identify the climate preset. */
19810
20294
  climate_preset_key: string;
20295
+ /** Indicates whether this climate preset key can be edited. */
19811
20296
  can_edit: boolean;
20297
+ /** Indicates whether this climate preset key can be deleted. */
19812
20298
  can_delete: boolean;
20299
+ /** User-friendly name to identify the climate preset. */
19813
20300
  name?: (string | null) | undefined;
20301
+ /** Display name for the climate preset. */
19814
20302
  display_name: string;
20303
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19815
20304
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
20305
+ /** 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`. */
19816
20306
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
20307
+ /** 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). */
19817
20308
  cooling_set_point_celsius?: number | undefined;
20309
+ /** Temperature to which the thermostat should heat (in °C). */
19818
20310
  heating_set_point_celsius?: number | undefined;
20311
+ /** Temperature to which the thermostat should cool (in °F). */
19819
20312
  cooling_set_point_fahrenheit?: number | undefined;
20313
+ /** Temperature to which the thermostat should heat (in °F). */
19820
20314
  heating_set_point_fahrenheit?: number | undefined;
20315
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19821
20316
  manual_override_allowed: boolean;
19822
20317
  }> | undefined;
19823
20318
  fallback_climate_preset_key?: (string | null) | undefined;
19824
20319
  active_thermostat_schedule?: ({
20320
+ /** ID of the climate schedule. */
19825
20321
  thermostat_schedule_id: string;
20322
+ /** ID of the desired thermostat device. */
19826
20323
  device_id: string;
20324
+ /** User-friendly name to identify the climate schedule. */
19827
20325
  name?: string | undefined;
20326
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
19828
20327
  climate_preset_key: string;
20328
+ /** 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). */
19829
20329
  max_override_period_minutes: number;
20330
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19830
20331
  starts_at: string;
20332
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19831
20333
  ends_at: string;
20334
+ /** Date and time at which the climate schedule was created. */
19832
20335
  created_at: string;
19833
- /** 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. */
20336
+ /** 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. */
19834
20337
  errors?: any;
19835
20338
  } | null) | undefined;
19836
20339
  min_cooling_set_point_celsius?: number | undefined;
@@ -19900,12 +20403,13 @@ export interface Routes {
19900
20403
  method: 'POST';
19901
20404
  queryParams: {};
19902
20405
  jsonBody: {
19903
- /** ID of the thermostat device. */
20406
+ /** ID of the desired thermostat device. */
19904
20407
  device_id: string;
19905
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
20408
+ /** 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. */
19906
20409
  heating_set_point_celsius?: number | undefined;
19907
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
20410
+ /** 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. */
19908
20411
  heating_set_point_fahrenheit?: number | undefined;
20412
+ /** */
19909
20413
  sync?: boolean;
19910
20414
  };
19911
20415
  commonParams: {};
@@ -20638,16 +21142,17 @@ export interface Routes {
20638
21142
  method: 'POST';
20639
21143
  queryParams: {};
20640
21144
  jsonBody: {
20641
- /** ID of the thermostat device. */
21145
+ /** ID of the desired thermostat device. */
20642
21146
  device_id: string;
20643
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
21147
+ /** 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. */
20644
21148
  heating_set_point_celsius?: number | undefined;
20645
- /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
21149
+ /** 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. */
20646
21150
  heating_set_point_fahrenheit?: number | undefined;
20647
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
21151
+ /** 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. */
20648
21152
  cooling_set_point_celsius?: number | undefined;
20649
- /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
21153
+ /** 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. */
20650
21154
  cooling_set_point_fahrenheit?: number | undefined;
21155
+ /** */
20651
21156
  sync?: boolean;
20652
21157
  };
20653
21158
  commonParams: {};
@@ -21381,19 +21886,31 @@ export interface Routes {
21381
21886
  queryParams: {};
21382
21887
  jsonBody: {};
21383
21888
  commonParams: {
21384
- /** List all devices owned by this connected account */
21889
+ /** ID of the connected account by which to filter. */
21385
21890
  connected_account_id?: string | undefined;
21891
+ /** Array of IDs of the connected accounts by which to filter devices. */
21386
21892
  connected_account_ids?: string[] | undefined;
21893
+ /** ID of the Connect Webview by which to filter devices. */
21387
21894
  connect_webview_id?: string | undefined;
21895
+ /** Device type by which to filter devices. */
21388
21896
  device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')) | undefined;
21897
+ /** Array of device types by which to filter devices. */
21389
21898
  device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder')> | undefined;
21899
+ /** Manufacturer by which to filter devices. */
21390
21900
  manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo' | 'akiles') | undefined;
21901
+ /** Array of device IDs by which to filter devices. */
21391
21902
  device_ids?: string[] | undefined;
21903
+ /** Numerical limit on the number of devices to return. */
21392
21904
  limit?: number;
21905
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
21393
21906
  created_before?: Date | undefined;
21907
+ /** Your own internal user ID for the user by which to filter devices. */
21394
21908
  user_identifier_key?: string | undefined;
21909
+ /** 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. */
21395
21910
  custom_metadata_has?: Record<string, string | boolean> | undefined;
21911
+ /** */
21396
21912
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
21913
+ /** */
21397
21914
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
21398
21915
  };
21399
21916
  formData: {};
@@ -21745,60 +22262,104 @@ export interface Routes {
21745
22262
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
21746
22263
  is_temporary_manual_override_active?: boolean | undefined;
21747
22264
  current_climate_setting?: {
22265
+ /** Unique key to identify the climate preset. */
21748
22266
  climate_preset_key?: string | undefined;
22267
+ /** Indicates whether this climate preset key can be edited. */
21749
22268
  can_edit?: boolean | undefined;
22269
+ /** Indicates whether this climate preset key can be deleted. */
21750
22270
  can_delete?: boolean | undefined;
22271
+ /** User-friendly name to identify the climate preset. */
21751
22272
  name?: ((string | null) | undefined) | undefined;
22273
+ /** Display name for the climate preset. */
21752
22274
  display_name?: string | undefined;
22275
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
21753
22276
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
22277
+ /** 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`. */
21754
22278
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
22279
+ /** 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). */
21755
22280
  cooling_set_point_celsius?: (number | undefined) | undefined;
22281
+ /** Temperature to which the thermostat should heat (in °C). */
21756
22282
  heating_set_point_celsius?: (number | undefined) | undefined;
22283
+ /** Temperature to which the thermostat should cool (in °F). */
21757
22284
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
22285
+ /** Temperature to which the thermostat should heat (in °F). */
21758
22286
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
22287
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
21759
22288
  manual_override_allowed?: boolean | undefined;
21760
22289
  } | undefined;
21761
22290
  /**
21762
22291
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
21763
22292
  default_climate_setting?: {
22293
+ /** Unique key to identify the climate preset. */
21764
22294
  climate_preset_key?: string | undefined;
22295
+ /** Indicates whether this climate preset key can be edited. */
21765
22296
  can_edit?: boolean | undefined;
22297
+ /** Indicates whether this climate preset key can be deleted. */
21766
22298
  can_delete?: boolean | undefined;
22299
+ /** User-friendly name to identify the climate preset. */
21767
22300
  name?: ((string | null) | undefined) | undefined;
22301
+ /** Display name for the climate preset. */
21768
22302
  display_name?: string | undefined;
22303
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
21769
22304
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
22305
+ /** 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`. */
21770
22306
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
22307
+ /** 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). */
21771
22308
  cooling_set_point_celsius?: (number | undefined) | undefined;
22309
+ /** Temperature to which the thermostat should heat (in °C). */
21772
22310
  heating_set_point_celsius?: (number | undefined) | undefined;
22311
+ /** Temperature to which the thermostat should cool (in °F). */
21773
22312
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
22313
+ /** Temperature to which the thermostat should heat (in °F). */
21774
22314
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
22315
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
21775
22316
  manual_override_allowed?: boolean | undefined;
21776
22317
  } | undefined;
21777
22318
  available_climate_presets?: Array<{
22319
+ /** Unique key to identify the climate preset. */
21778
22320
  climate_preset_key: string;
22321
+ /** Indicates whether this climate preset key can be edited. */
21779
22322
  can_edit: boolean;
22323
+ /** Indicates whether this climate preset key can be deleted. */
21780
22324
  can_delete: boolean;
22325
+ /** User-friendly name to identify the climate preset. */
21781
22326
  name?: (string | null) | undefined;
22327
+ /** Display name for the climate preset. */
21782
22328
  display_name: string;
22329
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
21783
22330
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
22331
+ /** 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`. */
21784
22332
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
22333
+ /** 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). */
21785
22334
  cooling_set_point_celsius?: number | undefined;
22335
+ /** Temperature to which the thermostat should heat (in °C). */
21786
22336
  heating_set_point_celsius?: number | undefined;
22337
+ /** Temperature to which the thermostat should cool (in °F). */
21787
22338
  cooling_set_point_fahrenheit?: number | undefined;
22339
+ /** Temperature to which the thermostat should heat (in °F). */
21788
22340
  heating_set_point_fahrenheit?: number | undefined;
22341
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
21789
22342
  manual_override_allowed: boolean;
21790
22343
  }> | undefined;
21791
22344
  fallback_climate_preset_key?: (string | null) | undefined;
21792
22345
  active_thermostat_schedule?: ({
22346
+ /** ID of the climate schedule. */
21793
22347
  thermostat_schedule_id: string;
22348
+ /** ID of the desired thermostat device. */
21794
22349
  device_id: string;
22350
+ /** User-friendly name to identify the climate schedule. */
21795
22351
  name?: string | undefined;
22352
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
21796
22353
  climate_preset_key: string;
22354
+ /** 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). */
21797
22355
  max_override_period_minutes: number;
22356
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21798
22357
  starts_at: string;
22358
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21799
22359
  ends_at: string;
22360
+ /** Date and time at which the climate schedule was created. */
21800
22361
  created_at: string;
21801
- /** 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. */
22362
+ /** 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. */
21802
22363
  errors?: any;
21803
22364
  } | null) | undefined;
21804
22365
  min_cooling_set_point_celsius?: number | undefined;
@@ -22208,60 +22769,104 @@ export interface Routes {
22208
22769
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
22209
22770
  is_temporary_manual_override_active?: boolean | undefined;
22210
22771
  current_climate_setting?: {
22772
+ /** Unique key to identify the climate preset. */
22211
22773
  climate_preset_key?: string | undefined;
22774
+ /** Indicates whether this climate preset key can be edited. */
22212
22775
  can_edit?: boolean | undefined;
22776
+ /** Indicates whether this climate preset key can be deleted. */
22213
22777
  can_delete?: boolean | undefined;
22778
+ /** User-friendly name to identify the climate preset. */
22214
22779
  name?: ((string | null) | undefined) | undefined;
22780
+ /** Display name for the climate preset. */
22215
22781
  display_name?: string | undefined;
22782
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
22216
22783
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
22784
+ /** 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`. */
22217
22785
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
22786
+ /** 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). */
22218
22787
  cooling_set_point_celsius?: (number | undefined) | undefined;
22788
+ /** Temperature to which the thermostat should heat (in °C). */
22219
22789
  heating_set_point_celsius?: (number | undefined) | undefined;
22790
+ /** Temperature to which the thermostat should cool (in °F). */
22220
22791
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
22792
+ /** Temperature to which the thermostat should heat (in °F). */
22221
22793
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
22794
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
22222
22795
  manual_override_allowed?: boolean | undefined;
22223
22796
  } | undefined;
22224
22797
  /**
22225
22798
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
22226
22799
  default_climate_setting?: {
22800
+ /** Unique key to identify the climate preset. */
22227
22801
  climate_preset_key?: string | undefined;
22802
+ /** Indicates whether this climate preset key can be edited. */
22228
22803
  can_edit?: boolean | undefined;
22804
+ /** Indicates whether this climate preset key can be deleted. */
22229
22805
  can_delete?: boolean | undefined;
22806
+ /** User-friendly name to identify the climate preset. */
22230
22807
  name?: ((string | null) | undefined) | undefined;
22808
+ /** Display name for the climate preset. */
22231
22809
  display_name?: string | undefined;
22810
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
22232
22811
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
22812
+ /** 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`. */
22233
22813
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
22814
+ /** 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). */
22234
22815
  cooling_set_point_celsius?: (number | undefined) | undefined;
22816
+ /** Temperature to which the thermostat should heat (in °C). */
22235
22817
  heating_set_point_celsius?: (number | undefined) | undefined;
22818
+ /** Temperature to which the thermostat should cool (in °F). */
22236
22819
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
22820
+ /** Temperature to which the thermostat should heat (in °F). */
22237
22821
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
22822
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
22238
22823
  manual_override_allowed?: boolean | undefined;
22239
22824
  } | undefined;
22240
22825
  available_climate_presets?: Array<{
22826
+ /** Unique key to identify the climate preset. */
22241
22827
  climate_preset_key: string;
22828
+ /** Indicates whether this climate preset key can be edited. */
22242
22829
  can_edit: boolean;
22830
+ /** Indicates whether this climate preset key can be deleted. */
22243
22831
  can_delete: boolean;
22832
+ /** User-friendly name to identify the climate preset. */
22244
22833
  name?: (string | null) | undefined;
22834
+ /** Display name for the climate preset. */
22245
22835
  display_name: string;
22836
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
22246
22837
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
22838
+ /** 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`. */
22247
22839
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
22840
+ /** 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). */
22248
22841
  cooling_set_point_celsius?: number | undefined;
22842
+ /** Temperature to which the thermostat should heat (in °C). */
22249
22843
  heating_set_point_celsius?: number | undefined;
22844
+ /** Temperature to which the thermostat should cool (in °F). */
22250
22845
  cooling_set_point_fahrenheit?: number | undefined;
22846
+ /** Temperature to which the thermostat should heat (in °F). */
22251
22847
  heating_set_point_fahrenheit?: number | undefined;
22848
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
22252
22849
  manual_override_allowed: boolean;
22253
22850
  }> | undefined;
22254
22851
  fallback_climate_preset_key?: (string | null) | undefined;
22255
22852
  active_thermostat_schedule?: ({
22853
+ /** ID of the climate schedule. */
22256
22854
  thermostat_schedule_id: string;
22855
+ /** ID of the desired thermostat device. */
22257
22856
  device_id: string;
22857
+ /** User-friendly name to identify the climate schedule. */
22258
22858
  name?: string | undefined;
22859
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
22259
22860
  climate_preset_key: string;
22861
+ /** 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). */
22260
22862
  max_override_period_minutes: number;
22863
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22261
22864
  starts_at: string;
22865
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22262
22866
  ends_at: string;
22867
+ /** Date and time at which the climate schedule was created. */
22263
22868
  created_at: string;
22264
- /** 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. */
22869
+ /** 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. */
22265
22870
  errors?: any;
22266
22871
  } | null) | undefined;
22267
22872
  min_cooling_set_point_celsius?: number | undefined;
@@ -22331,8 +22936,9 @@ export interface Routes {
22331
22936
  method: 'POST';
22332
22937
  queryParams: {};
22333
22938
  jsonBody: {
22334
- /** ID of the thermostat device. */
22939
+ /** ID of the desired thermostat device. */
22335
22940
  device_id: string;
22941
+ /** */
22336
22942
  sync?: boolean;
22337
22943
  };
22338
22944
  commonParams: {};
@@ -23065,26 +23671,40 @@ export interface Routes {
23065
23671
  method: 'POST';
23066
23672
  queryParams: {};
23067
23673
  jsonBody: {
23674
+ /** ID of the desired thermostat device. */
23068
23675
  device_id: string;
23676
+ /** User-friendly name to identify the climate schedule. */
23069
23677
  name?: string | undefined;
23678
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23070
23679
  climate_preset_key: string;
23680
+ /** 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). */
23071
23681
  max_override_period_minutes?: number;
23682
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23072
23683
  starts_at: string;
23684
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23073
23685
  ends_at: string;
23074
23686
  };
23075
23687
  commonParams: {};
23076
23688
  formData: {};
23077
23689
  jsonResponse: {
23078
23690
  thermostat_schedule: {
23691
+ /** ID of the climate schedule. */
23079
23692
  thermostat_schedule_id: string;
23693
+ /** ID of the desired thermostat device. */
23080
23694
  device_id: string;
23695
+ /** User-friendly name to identify the climate schedule. */
23081
23696
  name?: string | undefined;
23697
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23082
23698
  climate_preset_key: string;
23699
+ /** 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). */
23083
23700
  max_override_period_minutes: number;
23701
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23084
23702
  starts_at: string;
23703
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23085
23704
  ends_at: string;
23705
+ /** Date and time at which the climate schedule was created. */
23086
23706
  created_at: string;
23087
- /** 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. */
23707
+ /** 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. */
23088
23708
  errors?: any;
23089
23709
  };
23090
23710
  };
@@ -23095,6 +23715,7 @@ export interface Routes {
23095
23715
  queryParams: {};
23096
23716
  jsonBody: {};
23097
23717
  commonParams: {
23718
+ /** ID of the desired climate schedule. */
23098
23719
  thermostat_schedule_id: string;
23099
23720
  };
23100
23721
  formData: {};
@@ -23106,20 +23727,29 @@ export interface Routes {
23106
23727
  queryParams: {};
23107
23728
  jsonBody: {};
23108
23729
  commonParams: {
23730
+ /** ID of the desired climate schedule. */
23109
23731
  thermostat_schedule_id: string;
23110
23732
  };
23111
23733
  formData: {};
23112
23734
  jsonResponse: {
23113
23735
  thermostat_schedule: {
23736
+ /** ID of the climate schedule. */
23114
23737
  thermostat_schedule_id: string;
23738
+ /** ID of the desired thermostat device. */
23115
23739
  device_id: string;
23740
+ /** User-friendly name to identify the climate schedule. */
23116
23741
  name?: string | undefined;
23742
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23117
23743
  climate_preset_key: string;
23744
+ /** 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). */
23118
23745
  max_override_period_minutes: number;
23746
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23119
23747
  starts_at: string;
23748
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23120
23749
  ends_at: string;
23750
+ /** Date and time at which the climate schedule was created. */
23121
23751
  created_at: string;
23122
- /** 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. */
23752
+ /** 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. */
23123
23753
  errors?: any;
23124
23754
  };
23125
23755
  };
@@ -23130,21 +23760,31 @@ export interface Routes {
23130
23760
  queryParams: {};
23131
23761
  jsonBody: {};
23132
23762
  commonParams: {
23763
+ /** ID of the desired thermostat device. */
23133
23764
  device_id: string;
23765
+ /** User identifier key by which to filter the list of returned climate schedules. */
23134
23766
  user_identifier_key?: string | undefined;
23135
23767
  };
23136
23768
  formData: {};
23137
23769
  jsonResponse: {
23138
23770
  thermostat_schedules: Array<{
23771
+ /** ID of the climate schedule. */
23139
23772
  thermostat_schedule_id: string;
23773
+ /** ID of the desired thermostat device. */
23140
23774
  device_id: string;
23775
+ /** User-friendly name to identify the climate schedule. */
23141
23776
  name?: string | undefined;
23777
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23142
23778
  climate_preset_key: string;
23779
+ /** 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). */
23143
23780
  max_override_period_minutes: number;
23781
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23144
23782
  starts_at: string;
23783
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23145
23784
  ends_at: string;
23785
+ /** Date and time at which the climate schedule was created. */
23146
23786
  created_at: string;
23147
- /** 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. */
23787
+ /** 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. */
23148
23788
  errors?: any;
23149
23789
  }>;
23150
23790
  };
@@ -23154,11 +23794,17 @@ export interface Routes {
23154
23794
  method: 'PATCH' | 'POST';
23155
23795
  queryParams: {};
23156
23796
  jsonBody: {
23797
+ /** ID of the desired climate schedule. */
23157
23798
  thermostat_schedule_id: string;
23799
+ /** User-friendly name to identify the climate schedule. */
23158
23800
  name?: string | undefined;
23801
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23159
23802
  climate_preset_key?: string | undefined;
23803
+ /** 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). */
23160
23804
  max_override_period_minutes?: number | undefined;
23805
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23161
23806
  starts_at?: string | undefined;
23807
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23162
23808
  ends_at?: string | undefined;
23163
23809
  };
23164
23810
  commonParams: {};
@@ -23170,7 +23816,9 @@ export interface Routes {
23170
23816
  method: 'POST';
23171
23817
  queryParams: {};
23172
23818
  jsonBody: {
23819
+ /** ID of the desired thermostat device. */
23173
23820
  device_id: string;
23821
+ /** Climate preset key of the desired climate preset. */
23174
23822
  climate_preset_key: string;
23175
23823
  };
23176
23824
  commonParams: {};
@@ -23182,13 +23830,13 @@ export interface Routes {
23182
23830
  method: 'POST';
23183
23831
  queryParams: {};
23184
23832
  jsonBody: {
23185
- /** ID of the thermostat device. */
23186
23833
  device_id: string;
23187
23834
  /**
23188
23835
  * @deprecated Use `fan_mode_setting` instead. */
23189
23836
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
23190
- /** 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). */
23837
+ /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
23191
23838
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
23839
+ /** */
23192
23840
  sync?: boolean;
23193
23841
  };
23194
23842
  commonParams: {};
@@ -23921,10 +24569,15 @@ export interface Routes {
23921
24569
  method: 'POST' | 'PATCH';
23922
24570
  queryParams: {};
23923
24571
  jsonBody: {
24572
+ /** ID of the desired thermostat device. */
23924
24573
  device_id: string;
24574
+ /** 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. */
23925
24575
  lower_limit_celsius?: (number | undefined) | null;
24576
+ /** 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. */
23926
24577
  lower_limit_fahrenheit?: (number | undefined) | null;
24578
+ /** 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. */
23927
24579
  upper_limit_celsius?: (number | undefined) | null;
24580
+ /** 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. */
23928
24581
  upper_limit_fahrenheit?: (number | undefined) | null;
23929
24582
  };
23930
24583
  commonParams: {};
@@ -23936,15 +24589,25 @@ export interface Routes {
23936
24589
  method: 'POST' | 'PATCH';
23937
24590
  queryParams: {};
23938
24591
  jsonBody: {
24592
+ /** ID of the desired thermostat device. */
23939
24593
  device_id: string;
24594
+ /** Unique key to identify the climate preset. */
23940
24595
  climate_preset_key: string;
24596
+ /** User-friendly name to identify the climate preset. */
23941
24597
  name?: (string | null) | undefined;
24598
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
23942
24599
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
24600
+ /** 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`. */
23943
24601
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
24602
+ /** 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). */
23944
24603
  cooling_set_point_celsius?: number | undefined;
24604
+ /** Temperature to which the thermostat should heat (in °C). */
23945
24605
  heating_set_point_celsius?: number | undefined;
24606
+ /** Temperature to which the thermostat should cool (in °F). */
23946
24607
  cooling_set_point_fahrenheit?: number | undefined;
24608
+ /** Temperature to which the thermostat should heat (in °F). */
23947
24609
  heating_set_point_fahrenheit?: number | undefined;
24610
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
23948
24611
  manual_override_allowed: boolean;
23949
24612
  };
23950
24613
  commonParams: {};
@@ -24487,60 +25150,104 @@ export interface Routes {
24487
25150
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
24488
25151
  is_temporary_manual_override_active?: boolean | undefined;
24489
25152
  current_climate_setting?: {
25153
+ /** Unique key to identify the climate preset. */
24490
25154
  climate_preset_key?: string | undefined;
25155
+ /** Indicates whether this climate preset key can be edited. */
24491
25156
  can_edit?: boolean | undefined;
25157
+ /** Indicates whether this climate preset key can be deleted. */
24492
25158
  can_delete?: boolean | undefined;
25159
+ /** User-friendly name to identify the climate preset. */
24493
25160
  name?: ((string | null) | undefined) | undefined;
25161
+ /** Display name for the climate preset. */
24494
25162
  display_name?: string | undefined;
25163
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24495
25164
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
25165
+ /** 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`. */
24496
25166
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
25167
+ /** 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). */
24497
25168
  cooling_set_point_celsius?: (number | undefined) | undefined;
25169
+ /** Temperature to which the thermostat should heat (in °C). */
24498
25170
  heating_set_point_celsius?: (number | undefined) | undefined;
25171
+ /** Temperature to which the thermostat should cool (in °F). */
24499
25172
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
25173
+ /** Temperature to which the thermostat should heat (in °F). */
24500
25174
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
25175
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24501
25176
  manual_override_allowed?: boolean | undefined;
24502
25177
  } | undefined;
24503
25178
  /**
24504
25179
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
24505
25180
  default_climate_setting?: {
25181
+ /** Unique key to identify the climate preset. */
24506
25182
  climate_preset_key?: string | undefined;
25183
+ /** Indicates whether this climate preset key can be edited. */
24507
25184
  can_edit?: boolean | undefined;
25185
+ /** Indicates whether this climate preset key can be deleted. */
24508
25186
  can_delete?: boolean | undefined;
25187
+ /** User-friendly name to identify the climate preset. */
24509
25188
  name?: ((string | null) | undefined) | undefined;
25189
+ /** Display name for the climate preset. */
24510
25190
  display_name?: string | undefined;
25191
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24511
25192
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
25193
+ /** 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`. */
24512
25194
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
25195
+ /** 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). */
24513
25196
  cooling_set_point_celsius?: (number | undefined) | undefined;
25197
+ /** Temperature to which the thermostat should heat (in °C). */
24514
25198
  heating_set_point_celsius?: (number | undefined) | undefined;
25199
+ /** Temperature to which the thermostat should cool (in °F). */
24515
25200
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
25201
+ /** Temperature to which the thermostat should heat (in °F). */
24516
25202
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
25203
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24517
25204
  manual_override_allowed?: boolean | undefined;
24518
25205
  } | undefined;
24519
25206
  available_climate_presets?: Array<{
25207
+ /** Unique key to identify the climate preset. */
24520
25208
  climate_preset_key: string;
25209
+ /** Indicates whether this climate preset key can be edited. */
24521
25210
  can_edit: boolean;
25211
+ /** Indicates whether this climate preset key can be deleted. */
24522
25212
  can_delete: boolean;
25213
+ /** User-friendly name to identify the climate preset. */
24523
25214
  name?: (string | null) | undefined;
25215
+ /** Display name for the climate preset. */
24524
25216
  display_name: string;
25217
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24525
25218
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
25219
+ /** 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`. */
24526
25220
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
25221
+ /** 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). */
24527
25222
  cooling_set_point_celsius?: number | undefined;
25223
+ /** Temperature to which the thermostat should heat (in °C). */
24528
25224
  heating_set_point_celsius?: number | undefined;
25225
+ /** Temperature to which the thermostat should cool (in °F). */
24529
25226
  cooling_set_point_fahrenheit?: number | undefined;
25227
+ /** Temperature to which the thermostat should heat (in °F). */
24530
25228
  heating_set_point_fahrenheit?: number | undefined;
25229
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24531
25230
  manual_override_allowed: boolean;
24532
25231
  }> | undefined;
24533
25232
  fallback_climate_preset_key?: (string | null) | undefined;
24534
25233
  active_thermostat_schedule?: ({
25234
+ /** ID of the climate schedule. */
24535
25235
  thermostat_schedule_id: string;
25236
+ /** ID of the desired thermostat device. */
24536
25237
  device_id: string;
25238
+ /** User-friendly name to identify the climate schedule. */
24537
25239
  name?: string | undefined;
25240
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
24538
25241
  climate_preset_key: string;
25242
+ /** 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). */
24539
25243
  max_override_period_minutes: number;
25244
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24540
25245
  starts_at: string;
25246
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24541
25247
  ends_at: string;
25248
+ /** Date and time at which the climate schedule was created. */
24542
25249
  created_at: string;
24543
- /** 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. */
25250
+ /** 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. */
24544
25251
  errors?: any;
24545
25252
  } | null) | undefined;
24546
25253
  min_cooling_set_point_celsius?: number | undefined;
@@ -24952,60 +25659,104 @@ export interface Routes {
24952
25659
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
24953
25660
  is_temporary_manual_override_active?: boolean | undefined;
24954
25661
  current_climate_setting?: {
25662
+ /** Unique key to identify the climate preset. */
24955
25663
  climate_preset_key?: string | undefined;
25664
+ /** Indicates whether this climate preset key can be edited. */
24956
25665
  can_edit?: boolean | undefined;
25666
+ /** Indicates whether this climate preset key can be deleted. */
24957
25667
  can_delete?: boolean | undefined;
25668
+ /** User-friendly name to identify the climate preset. */
24958
25669
  name?: ((string | null) | undefined) | undefined;
25670
+ /** Display name for the climate preset. */
24959
25671
  display_name?: string | undefined;
25672
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24960
25673
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
25674
+ /** 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`. */
24961
25675
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
25676
+ /** 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). */
24962
25677
  cooling_set_point_celsius?: (number | undefined) | undefined;
25678
+ /** Temperature to which the thermostat should heat (in °C). */
24963
25679
  heating_set_point_celsius?: (number | undefined) | undefined;
25680
+ /** Temperature to which the thermostat should cool (in °F). */
24964
25681
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
25682
+ /** Temperature to which the thermostat should heat (in °F). */
24965
25683
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
25684
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24966
25685
  manual_override_allowed?: boolean | undefined;
24967
25686
  } | undefined;
24968
25687
  /**
24969
25688
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
24970
25689
  default_climate_setting?: {
25690
+ /** Unique key to identify the climate preset. */
24971
25691
  climate_preset_key?: string | undefined;
25692
+ /** Indicates whether this climate preset key can be edited. */
24972
25693
  can_edit?: boolean | undefined;
25694
+ /** Indicates whether this climate preset key can be deleted. */
24973
25695
  can_delete?: boolean | undefined;
25696
+ /** User-friendly name to identify the climate preset. */
24974
25697
  name?: ((string | null) | undefined) | undefined;
25698
+ /** Display name for the climate preset. */
24975
25699
  display_name?: string | undefined;
25700
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24976
25701
  fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
25702
+ /** 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`. */
24977
25703
  hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
25704
+ /** 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). */
24978
25705
  cooling_set_point_celsius?: (number | undefined) | undefined;
25706
+ /** Temperature to which the thermostat should heat (in °C). */
24979
25707
  heating_set_point_celsius?: (number | undefined) | undefined;
25708
+ /** Temperature to which the thermostat should cool (in °F). */
24980
25709
  cooling_set_point_fahrenheit?: (number | undefined) | undefined;
25710
+ /** Temperature to which the thermostat should heat (in °F). */
24981
25711
  heating_set_point_fahrenheit?: (number | undefined) | undefined;
25712
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24982
25713
  manual_override_allowed?: boolean | undefined;
24983
25714
  } | undefined;
24984
25715
  available_climate_presets?: Array<{
25716
+ /** Unique key to identify the climate preset. */
24985
25717
  climate_preset_key: string;
25718
+ /** Indicates whether this climate preset key can be edited. */
24986
25719
  can_edit: boolean;
25720
+ /** Indicates whether this climate preset key can be deleted. */
24987
25721
  can_delete: boolean;
25722
+ /** User-friendly name to identify the climate preset. */
24988
25723
  name?: (string | null) | undefined;
25724
+ /** Display name for the climate preset. */
24989
25725
  display_name: string;
25726
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24990
25727
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
25728
+ /** 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`. */
24991
25729
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
25730
+ /** 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). */
24992
25731
  cooling_set_point_celsius?: number | undefined;
25732
+ /** Temperature to which the thermostat should heat (in °C). */
24993
25733
  heating_set_point_celsius?: number | undefined;
25734
+ /** Temperature to which the thermostat should cool (in °F). */
24994
25735
  cooling_set_point_fahrenheit?: number | undefined;
25736
+ /** Temperature to which the thermostat should heat (in °F). */
24995
25737
  heating_set_point_fahrenheit?: number | undefined;
25738
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24996
25739
  manual_override_allowed: boolean;
24997
25740
  }> | undefined;
24998
25741
  fallback_climate_preset_key?: (string | null) | undefined;
24999
25742
  active_thermostat_schedule?: ({
25743
+ /** ID of the climate schedule. */
25000
25744
  thermostat_schedule_id: string;
25745
+ /** ID of the desired thermostat device. */
25001
25746
  device_id: string;
25747
+ /** User-friendly name to identify the climate schedule. */
25002
25748
  name?: string | undefined;
25749
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
25003
25750
  climate_preset_key: string;
25751
+ /** 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). */
25004
25752
  max_override_period_minutes: number;
25753
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25005
25754
  starts_at: string;
25755
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25006
25756
  ends_at: string;
25757
+ /** Date and time at which the climate schedule was created. */
25007
25758
  created_at: string;
25008
- /** 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. */
25759
+ /** 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. */
25009
25760
  errors?: any;
25010
25761
  } | null) | undefined;
25011
25762
  min_cooling_set_point_celsius?: number | undefined;