@seamapi/types 1.291.0 → 1.292.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +656 -178
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1023 -39
- package/lib/seam/connect/models/thermostats/climate-preset.js +41 -12
- package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +37 -11
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +218 -1
- package/lib/seam/connect/openapi.js +590 -130
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +805 -38
- package/package.json +1 -1
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +49 -12
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +51 -15
- package/src/lib/seam/connect/openapi.ts +746 -130
- package/src/lib/seam/connect/route-types.ts +805 -38
|
@@ -5767,60 +5767,105 @@ 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;
|
|
5850
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
5814
5851
|
active_thermostat_schedule?: ({
|
|
5852
|
+
/** ID of the thermostat schedule. */
|
|
5815
5853
|
thermostat_schedule_id: string;
|
|
5854
|
+
/** ID of the desired thermostat device. */
|
|
5816
5855
|
device_id: string;
|
|
5856
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
5817
5857
|
name?: string | undefined;
|
|
5858
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
5818
5859
|
climate_preset_key: string;
|
|
5860
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
5819
5861
|
max_override_period_minutes: number;
|
|
5862
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
5820
5863
|
starts_at: string;
|
|
5864
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
5821
5865
|
ends_at: string;
|
|
5866
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
5822
5867
|
created_at: string;
|
|
5823
|
-
/**
|
|
5868
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
5824
5869
|
errors?: any;
|
|
5825
5870
|
} | null) | undefined;
|
|
5826
5871
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -10107,60 +10152,105 @@ export interface Routes {
|
|
|
10107
10152
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
10108
10153
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
10109
10154
|
current_climate_setting?: {
|
|
10155
|
+
/** Unique key to identify the climate preset. */
|
|
10110
10156
|
climate_preset_key?: string | undefined;
|
|
10157
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10111
10158
|
can_edit?: boolean | undefined;
|
|
10159
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10112
10160
|
can_delete?: boolean | undefined;
|
|
10161
|
+
/** User-friendly name to identify the climate preset. */
|
|
10113
10162
|
name?: ((string | null) | undefined) | undefined;
|
|
10163
|
+
/** Display name for the climate preset. */
|
|
10114
10164
|
display_name?: string | undefined;
|
|
10165
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10115
10166
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
10167
|
+
/** 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
10168
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
10169
|
+
/** 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
10170
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
10171
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10118
10172
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
10173
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10119
10174
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10175
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10120
10176
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10177
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10121
10178
|
manual_override_allowed?: boolean | undefined;
|
|
10122
10179
|
} | undefined;
|
|
10123
10180
|
/**
|
|
10124
10181
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
10125
10182
|
default_climate_setting?: {
|
|
10183
|
+
/** Unique key to identify the climate preset. */
|
|
10126
10184
|
climate_preset_key?: string | undefined;
|
|
10185
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10127
10186
|
can_edit?: boolean | undefined;
|
|
10187
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10128
10188
|
can_delete?: boolean | undefined;
|
|
10189
|
+
/** User-friendly name to identify the climate preset. */
|
|
10129
10190
|
name?: ((string | null) | undefined) | undefined;
|
|
10191
|
+
/** Display name for the climate preset. */
|
|
10130
10192
|
display_name?: string | undefined;
|
|
10193
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10131
10194
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
10195
|
+
/** 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
10196
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
10197
|
+
/** 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
10198
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
10199
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10134
10200
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
10201
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10135
10202
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10203
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10136
10204
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10205
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10137
10206
|
manual_override_allowed?: boolean | undefined;
|
|
10138
10207
|
} | undefined;
|
|
10139
10208
|
available_climate_presets?: Array<{
|
|
10209
|
+
/** Unique key to identify the climate preset. */
|
|
10140
10210
|
climate_preset_key: string;
|
|
10211
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10141
10212
|
can_edit: boolean;
|
|
10213
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10142
10214
|
can_delete: boolean;
|
|
10215
|
+
/** User-friendly name to identify the climate preset. */
|
|
10143
10216
|
name?: (string | null) | undefined;
|
|
10217
|
+
/** Display name for the climate preset. */
|
|
10144
10218
|
display_name: string;
|
|
10219
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10145
10220
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
10221
|
+
/** 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
10222
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
10223
|
+
/** 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
10224
|
cooling_set_point_celsius?: number | undefined;
|
|
10225
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10148
10226
|
heating_set_point_celsius?: number | undefined;
|
|
10227
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10149
10228
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
10229
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10150
10230
|
heating_set_point_fahrenheit?: number | undefined;
|
|
10231
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10151
10232
|
manual_override_allowed: boolean;
|
|
10152
10233
|
}> | undefined;
|
|
10153
10234
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
10235
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
10154
10236
|
active_thermostat_schedule?: ({
|
|
10237
|
+
/** ID of the thermostat schedule. */
|
|
10155
10238
|
thermostat_schedule_id: string;
|
|
10239
|
+
/** ID of the desired thermostat device. */
|
|
10156
10240
|
device_id: string;
|
|
10241
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
10157
10242
|
name?: string | undefined;
|
|
10243
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
10158
10244
|
climate_preset_key: string;
|
|
10245
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
10159
10246
|
max_override_period_minutes: number;
|
|
10247
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10160
10248
|
starts_at: string;
|
|
10249
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10161
10250
|
ends_at: string;
|
|
10251
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
10162
10252
|
created_at: string;
|
|
10163
|
-
/**
|
|
10253
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
10164
10254
|
errors?: any;
|
|
10165
10255
|
} | null) | undefined;
|
|
10166
10256
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -10231,19 +10321,31 @@ export interface Routes {
|
|
|
10231
10321
|
queryParams: {};
|
|
10232
10322
|
jsonBody: {};
|
|
10233
10323
|
commonParams: {
|
|
10234
|
-
/**
|
|
10324
|
+
/** ID of the connected account by which to filter. */
|
|
10235
10325
|
connected_account_id?: string | undefined;
|
|
10326
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
10236
10327
|
connected_account_ids?: string[] | undefined;
|
|
10328
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
10237
10329
|
connect_webview_id?: string | undefined;
|
|
10330
|
+
/** Device type by which to filter devices. */
|
|
10238
10331
|
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;
|
|
10332
|
+
/** Array of device types by which to filter devices. */
|
|
10239
10333
|
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;
|
|
10334
|
+
/** Manufacturer by which to filter devices. */
|
|
10240
10335
|
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;
|
|
10336
|
+
/** Array of device IDs by which to filter devices. */
|
|
10241
10337
|
device_ids?: string[] | undefined;
|
|
10338
|
+
/** Numerical limit on the number of devices to return. */
|
|
10242
10339
|
limit?: number;
|
|
10340
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
10243
10341
|
created_before?: Date | undefined;
|
|
10342
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
10244
10343
|
user_identifier_key?: string | undefined;
|
|
10344
|
+
/** 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
10345
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
10346
|
+
/** */
|
|
10246
10347
|
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;
|
|
10348
|
+
/** */
|
|
10247
10349
|
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
10350
|
};
|
|
10249
10351
|
formData: {};
|
|
@@ -10595,60 +10697,105 @@ export interface Routes {
|
|
|
10595
10697
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
10596
10698
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
10597
10699
|
current_climate_setting?: {
|
|
10700
|
+
/** Unique key to identify the climate preset. */
|
|
10598
10701
|
climate_preset_key?: string | undefined;
|
|
10702
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10599
10703
|
can_edit?: boolean | undefined;
|
|
10704
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10600
10705
|
can_delete?: boolean | undefined;
|
|
10706
|
+
/** User-friendly name to identify the climate preset. */
|
|
10601
10707
|
name?: ((string | null) | undefined) | undefined;
|
|
10708
|
+
/** Display name for the climate preset. */
|
|
10602
10709
|
display_name?: string | undefined;
|
|
10710
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10603
10711
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
10712
|
+
/** 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
10713
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
10714
|
+
/** 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
10715
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
10716
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10606
10717
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
10718
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10607
10719
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10720
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10608
10721
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10722
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10609
10723
|
manual_override_allowed?: boolean | undefined;
|
|
10610
10724
|
} | undefined;
|
|
10611
10725
|
/**
|
|
10612
10726
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
10613
10727
|
default_climate_setting?: {
|
|
10728
|
+
/** Unique key to identify the climate preset. */
|
|
10614
10729
|
climate_preset_key?: string | undefined;
|
|
10730
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10615
10731
|
can_edit?: boolean | undefined;
|
|
10732
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10616
10733
|
can_delete?: boolean | undefined;
|
|
10734
|
+
/** User-friendly name to identify the climate preset. */
|
|
10617
10735
|
name?: ((string | null) | undefined) | undefined;
|
|
10736
|
+
/** Display name for the climate preset. */
|
|
10618
10737
|
display_name?: string | undefined;
|
|
10738
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10619
10739
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
10740
|
+
/** 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
10741
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
10742
|
+
/** 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
10743
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
10744
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10622
10745
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
10746
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10623
10747
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10748
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10624
10749
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
10750
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10625
10751
|
manual_override_allowed?: boolean | undefined;
|
|
10626
10752
|
} | undefined;
|
|
10627
10753
|
available_climate_presets?: Array<{
|
|
10754
|
+
/** Unique key to identify the climate preset. */
|
|
10628
10755
|
climate_preset_key: string;
|
|
10756
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
10629
10757
|
can_edit: boolean;
|
|
10758
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
10630
10759
|
can_delete: boolean;
|
|
10760
|
+
/** User-friendly name to identify the climate preset. */
|
|
10631
10761
|
name?: (string | null) | undefined;
|
|
10762
|
+
/** Display name for the climate preset. */
|
|
10632
10763
|
display_name: string;
|
|
10764
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
10633
10765
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
10766
|
+
/** 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
10767
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
10768
|
+
/** 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
10769
|
cooling_set_point_celsius?: number | undefined;
|
|
10770
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
10636
10771
|
heating_set_point_celsius?: number | undefined;
|
|
10772
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
10637
10773
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
10774
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
10638
10775
|
heating_set_point_fahrenheit?: number | undefined;
|
|
10776
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
10639
10777
|
manual_override_allowed: boolean;
|
|
10640
10778
|
}> | undefined;
|
|
10641
10779
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
10780
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
10642
10781
|
active_thermostat_schedule?: ({
|
|
10782
|
+
/** ID of the thermostat schedule. */
|
|
10643
10783
|
thermostat_schedule_id: string;
|
|
10784
|
+
/** ID of the desired thermostat device. */
|
|
10644
10785
|
device_id: string;
|
|
10786
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
10645
10787
|
name?: string | undefined;
|
|
10788
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
10646
10789
|
climate_preset_key: string;
|
|
10790
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
10647
10791
|
max_override_period_minutes: number;
|
|
10792
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10648
10793
|
starts_at: string;
|
|
10794
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10649
10795
|
ends_at: string;
|
|
10796
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
10650
10797
|
created_at: string;
|
|
10651
|
-
/**
|
|
10798
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
10652
10799
|
errors?: any;
|
|
10653
10800
|
} | null) | undefined;
|
|
10654
10801
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -10892,19 +11039,31 @@ export interface Routes {
|
|
|
10892
11039
|
queryParams: {};
|
|
10893
11040
|
jsonBody: {};
|
|
10894
11041
|
commonParams: {
|
|
10895
|
-
/**
|
|
11042
|
+
/** ID of the connected account by which to filter. */
|
|
10896
11043
|
connected_account_id?: string | undefined;
|
|
11044
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
10897
11045
|
connected_account_ids?: string[] | undefined;
|
|
11046
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
10898
11047
|
connect_webview_id?: string | undefined;
|
|
11048
|
+
/** Device type by which to filter devices. */
|
|
10899
11049
|
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;
|
|
11050
|
+
/** Array of device types by which to filter devices. */
|
|
10900
11051
|
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;
|
|
11052
|
+
/** Manufacturer by which to filter devices. */
|
|
10901
11053
|
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;
|
|
11054
|
+
/** Array of device IDs by which to filter devices. */
|
|
10902
11055
|
device_ids?: string[] | undefined;
|
|
11056
|
+
/** Numerical limit on the number of devices to return. */
|
|
10903
11057
|
limit?: number;
|
|
11058
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
10904
11059
|
created_before?: Date | undefined;
|
|
11060
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
10905
11061
|
user_identifier_key?: string | undefined;
|
|
11062
|
+
/** 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
11063
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
11064
|
+
/** */
|
|
10907
11065
|
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;
|
|
11066
|
+
/** */
|
|
10908
11067
|
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
11068
|
};
|
|
10910
11069
|
formData: {};
|
|
@@ -11486,60 +11645,105 @@ export interface Routes {
|
|
|
11486
11645
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
11487
11646
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
11488
11647
|
current_climate_setting?: {
|
|
11648
|
+
/** Unique key to identify the climate preset. */
|
|
11489
11649
|
climate_preset_key?: string | undefined;
|
|
11650
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11490
11651
|
can_edit?: boolean | undefined;
|
|
11652
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11491
11653
|
can_delete?: boolean | undefined;
|
|
11654
|
+
/** User-friendly name to identify the climate preset. */
|
|
11492
11655
|
name?: ((string | null) | undefined) | undefined;
|
|
11656
|
+
/** Display name for the climate preset. */
|
|
11493
11657
|
display_name?: string | undefined;
|
|
11658
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11494
11659
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
11660
|
+
/** 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
11661
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
11662
|
+
/** 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
11663
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
11664
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11497
11665
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
11666
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11498
11667
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
11668
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11499
11669
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
11670
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11500
11671
|
manual_override_allowed?: boolean | undefined;
|
|
11501
11672
|
} | undefined;
|
|
11502
11673
|
/**
|
|
11503
11674
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
11504
11675
|
default_climate_setting?: {
|
|
11676
|
+
/** Unique key to identify the climate preset. */
|
|
11505
11677
|
climate_preset_key?: string | undefined;
|
|
11678
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11506
11679
|
can_edit?: boolean | undefined;
|
|
11680
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11507
11681
|
can_delete?: boolean | undefined;
|
|
11682
|
+
/** User-friendly name to identify the climate preset. */
|
|
11508
11683
|
name?: ((string | null) | undefined) | undefined;
|
|
11684
|
+
/** Display name for the climate preset. */
|
|
11509
11685
|
display_name?: string | undefined;
|
|
11686
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11510
11687
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
11688
|
+
/** 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
11689
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
11690
|
+
/** 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
11691
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
11692
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11513
11693
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
11694
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11514
11695
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
11696
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11515
11697
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
11698
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11516
11699
|
manual_override_allowed?: boolean | undefined;
|
|
11517
11700
|
} | undefined;
|
|
11518
11701
|
available_climate_presets?: Array<{
|
|
11702
|
+
/** Unique key to identify the climate preset. */
|
|
11519
11703
|
climate_preset_key: string;
|
|
11704
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11520
11705
|
can_edit: boolean;
|
|
11706
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11521
11707
|
can_delete: boolean;
|
|
11708
|
+
/** User-friendly name to identify the climate preset. */
|
|
11522
11709
|
name?: (string | null) | undefined;
|
|
11710
|
+
/** Display name for the climate preset. */
|
|
11523
11711
|
display_name: string;
|
|
11712
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11524
11713
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
11714
|
+
/** 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
11715
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
11716
|
+
/** 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
11717
|
cooling_set_point_celsius?: number | undefined;
|
|
11718
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11527
11719
|
heating_set_point_celsius?: number | undefined;
|
|
11720
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11528
11721
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
11722
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11529
11723
|
heating_set_point_fahrenheit?: number | undefined;
|
|
11724
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11530
11725
|
manual_override_allowed: boolean;
|
|
11531
11726
|
}> | undefined;
|
|
11532
11727
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
11728
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
11533
11729
|
active_thermostat_schedule?: ({
|
|
11730
|
+
/** ID of the thermostat schedule. */
|
|
11534
11731
|
thermostat_schedule_id: string;
|
|
11732
|
+
/** ID of the desired thermostat device. */
|
|
11535
11733
|
device_id: string;
|
|
11734
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
11536
11735
|
name?: string | undefined;
|
|
11736
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
11537
11737
|
climate_preset_key: string;
|
|
11738
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
11538
11739
|
max_override_period_minutes: number;
|
|
11740
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
11539
11741
|
starts_at: string;
|
|
11742
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
11540
11743
|
ends_at: string;
|
|
11744
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
11541
11745
|
created_at: string;
|
|
11542
|
-
/**
|
|
11746
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
11543
11747
|
errors?: any;
|
|
11544
11748
|
} | null) | undefined;
|
|
11545
11749
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -11949,60 +12153,105 @@ export interface Routes {
|
|
|
11949
12153
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
11950
12154
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
11951
12155
|
current_climate_setting?: {
|
|
12156
|
+
/** Unique key to identify the climate preset. */
|
|
11952
12157
|
climate_preset_key?: string | undefined;
|
|
12158
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11953
12159
|
can_edit?: boolean | undefined;
|
|
12160
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11954
12161
|
can_delete?: boolean | undefined;
|
|
12162
|
+
/** User-friendly name to identify the climate preset. */
|
|
11955
12163
|
name?: ((string | null) | undefined) | undefined;
|
|
12164
|
+
/** Display name for the climate preset. */
|
|
11956
12165
|
display_name?: string | undefined;
|
|
12166
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11957
12167
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
12168
|
+
/** 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
12169
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
12170
|
+
/** 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
12171
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
12172
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11960
12173
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
12174
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11961
12175
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12176
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11962
12177
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12178
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11963
12179
|
manual_override_allowed?: boolean | undefined;
|
|
11964
12180
|
} | undefined;
|
|
11965
12181
|
/**
|
|
11966
12182
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
11967
12183
|
default_climate_setting?: {
|
|
12184
|
+
/** Unique key to identify the climate preset. */
|
|
11968
12185
|
climate_preset_key?: string | undefined;
|
|
12186
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11969
12187
|
can_edit?: boolean | undefined;
|
|
12188
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11970
12189
|
can_delete?: boolean | undefined;
|
|
12190
|
+
/** User-friendly name to identify the climate preset. */
|
|
11971
12191
|
name?: ((string | null) | undefined) | undefined;
|
|
12192
|
+
/** Display name for the climate preset. */
|
|
11972
12193
|
display_name?: string | undefined;
|
|
12194
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11973
12195
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
12196
|
+
/** 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
12197
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
12198
|
+
/** 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
12199
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
12200
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11976
12201
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
12202
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11977
12203
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12204
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11978
12205
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12206
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11979
12207
|
manual_override_allowed?: boolean | undefined;
|
|
11980
12208
|
} | undefined;
|
|
11981
12209
|
available_climate_presets?: Array<{
|
|
12210
|
+
/** Unique key to identify the climate preset. */
|
|
11982
12211
|
climate_preset_key: string;
|
|
12212
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
11983
12213
|
can_edit: boolean;
|
|
12214
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
11984
12215
|
can_delete: boolean;
|
|
12216
|
+
/** User-friendly name to identify the climate preset. */
|
|
11985
12217
|
name?: (string | null) | undefined;
|
|
12218
|
+
/** Display name for the climate preset. */
|
|
11986
12219
|
display_name: string;
|
|
12220
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
11987
12221
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
12222
|
+
/** 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
12223
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
12224
|
+
/** 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
12225
|
cooling_set_point_celsius?: number | undefined;
|
|
12226
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
11990
12227
|
heating_set_point_celsius?: number | undefined;
|
|
12228
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
11991
12229
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
12230
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
11992
12231
|
heating_set_point_fahrenheit?: number | undefined;
|
|
12232
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
11993
12233
|
manual_override_allowed: boolean;
|
|
11994
12234
|
}> | undefined;
|
|
11995
12235
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
12236
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
11996
12237
|
active_thermostat_schedule?: ({
|
|
12238
|
+
/** ID of the thermostat schedule. */
|
|
11997
12239
|
thermostat_schedule_id: string;
|
|
12240
|
+
/** ID of the desired thermostat device. */
|
|
11998
12241
|
device_id: string;
|
|
12242
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
11999
12243
|
name?: string | undefined;
|
|
12244
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
12000
12245
|
climate_preset_key: string;
|
|
12246
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
12001
12247
|
max_override_period_minutes: number;
|
|
12248
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12002
12249
|
starts_at: string;
|
|
12250
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12003
12251
|
ends_at: string;
|
|
12252
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
12004
12253
|
created_at: string;
|
|
12005
|
-
/**
|
|
12254
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
12006
12255
|
errors?: any;
|
|
12007
12256
|
} | null) | undefined;
|
|
12008
12257
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -12073,19 +12322,31 @@ export interface Routes {
|
|
|
12073
12322
|
queryParams: {};
|
|
12074
12323
|
jsonBody: {};
|
|
12075
12324
|
commonParams: {
|
|
12076
|
-
/**
|
|
12325
|
+
/** ID of the connected account by which to filter. */
|
|
12077
12326
|
connected_account_id?: string | undefined;
|
|
12327
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
12078
12328
|
connected_account_ids?: string[] | undefined;
|
|
12329
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
12079
12330
|
connect_webview_id?: string | undefined;
|
|
12331
|
+
/** Device type by which to filter devices. */
|
|
12080
12332
|
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;
|
|
12333
|
+
/** Array of device types by which to filter devices. */
|
|
12081
12334
|
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;
|
|
12335
|
+
/** Manufacturer by which to filter devices. */
|
|
12082
12336
|
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;
|
|
12337
|
+
/** Array of device IDs by which to filter devices. */
|
|
12083
12338
|
device_ids?: string[] | undefined;
|
|
12339
|
+
/** Numerical limit on the number of devices to return. */
|
|
12084
12340
|
limit?: number;
|
|
12341
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
12085
12342
|
created_before?: Date | undefined;
|
|
12343
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
12086
12344
|
user_identifier_key?: string | undefined;
|
|
12345
|
+
/** 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
12346
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
12347
|
+
/** */
|
|
12088
12348
|
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;
|
|
12349
|
+
/** */
|
|
12089
12350
|
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
12351
|
};
|
|
12091
12352
|
formData: {};
|
|
@@ -12437,60 +12698,105 @@ export interface Routes {
|
|
|
12437
12698
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
12438
12699
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
12439
12700
|
current_climate_setting?: {
|
|
12701
|
+
/** Unique key to identify the climate preset. */
|
|
12440
12702
|
climate_preset_key?: string | undefined;
|
|
12703
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12441
12704
|
can_edit?: boolean | undefined;
|
|
12705
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12442
12706
|
can_delete?: boolean | undefined;
|
|
12707
|
+
/** User-friendly name to identify the climate preset. */
|
|
12443
12708
|
name?: ((string | null) | undefined) | undefined;
|
|
12709
|
+
/** Display name for the climate preset. */
|
|
12444
12710
|
display_name?: string | undefined;
|
|
12711
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12445
12712
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
12713
|
+
/** 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
12714
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
12715
|
+
/** 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
12716
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
12717
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12448
12718
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
12719
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12449
12720
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12721
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12450
12722
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12723
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12451
12724
|
manual_override_allowed?: boolean | undefined;
|
|
12452
12725
|
} | undefined;
|
|
12453
12726
|
/**
|
|
12454
12727
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
12455
12728
|
default_climate_setting?: {
|
|
12729
|
+
/** Unique key to identify the climate preset. */
|
|
12456
12730
|
climate_preset_key?: string | undefined;
|
|
12731
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12457
12732
|
can_edit?: boolean | undefined;
|
|
12733
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12458
12734
|
can_delete?: boolean | undefined;
|
|
12735
|
+
/** User-friendly name to identify the climate preset. */
|
|
12459
12736
|
name?: ((string | null) | undefined) | undefined;
|
|
12737
|
+
/** Display name for the climate preset. */
|
|
12460
12738
|
display_name?: string | undefined;
|
|
12739
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12461
12740
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
12741
|
+
/** 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
12742
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
12743
|
+
/** 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
12744
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
12745
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12464
12746
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
12747
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12465
12748
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12749
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12466
12750
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
12751
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12467
12752
|
manual_override_allowed?: boolean | undefined;
|
|
12468
12753
|
} | undefined;
|
|
12469
12754
|
available_climate_presets?: Array<{
|
|
12755
|
+
/** Unique key to identify the climate preset. */
|
|
12470
12756
|
climate_preset_key: string;
|
|
12757
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12471
12758
|
can_edit: boolean;
|
|
12759
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12472
12760
|
can_delete: boolean;
|
|
12761
|
+
/** User-friendly name to identify the climate preset. */
|
|
12473
12762
|
name?: (string | null) | undefined;
|
|
12763
|
+
/** Display name for the climate preset. */
|
|
12474
12764
|
display_name: string;
|
|
12765
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12475
12766
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
12767
|
+
/** 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
12768
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
12769
|
+
/** 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
12770
|
cooling_set_point_celsius?: number | undefined;
|
|
12771
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12478
12772
|
heating_set_point_celsius?: number | undefined;
|
|
12773
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12479
12774
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
12775
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12480
12776
|
heating_set_point_fahrenheit?: number | undefined;
|
|
12777
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12481
12778
|
manual_override_allowed: boolean;
|
|
12482
12779
|
}> | undefined;
|
|
12483
12780
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
12781
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
12484
12782
|
active_thermostat_schedule?: ({
|
|
12783
|
+
/** ID of the thermostat schedule. */
|
|
12485
12784
|
thermostat_schedule_id: string;
|
|
12785
|
+
/** ID of the desired thermostat device. */
|
|
12486
12786
|
device_id: string;
|
|
12787
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
12487
12788
|
name?: string | undefined;
|
|
12789
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
12488
12790
|
climate_preset_key: string;
|
|
12791
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
12489
12792
|
max_override_period_minutes: number;
|
|
12793
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12490
12794
|
starts_at: string;
|
|
12795
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12491
12796
|
ends_at: string;
|
|
12797
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
12492
12798
|
created_at: string;
|
|
12493
|
-
/**
|
|
12799
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
12494
12800
|
errors?: any;
|
|
12495
12801
|
} | null) | undefined;
|
|
12496
12802
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -12900,60 +13206,105 @@ export interface Routes {
|
|
|
12900
13206
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
12901
13207
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
12902
13208
|
current_climate_setting?: {
|
|
13209
|
+
/** Unique key to identify the climate preset. */
|
|
12903
13210
|
climate_preset_key?: string | undefined;
|
|
13211
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12904
13212
|
can_edit?: boolean | undefined;
|
|
13213
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12905
13214
|
can_delete?: boolean | undefined;
|
|
13215
|
+
/** User-friendly name to identify the climate preset. */
|
|
12906
13216
|
name?: ((string | null) | undefined) | undefined;
|
|
13217
|
+
/** Display name for the climate preset. */
|
|
12907
13218
|
display_name?: string | undefined;
|
|
13219
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12908
13220
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
13221
|
+
/** 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
13222
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
13223
|
+
/** 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
13224
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
13225
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12911
13226
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
13227
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12912
13228
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
13229
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12913
13230
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
13231
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12914
13232
|
manual_override_allowed?: boolean | undefined;
|
|
12915
13233
|
} | undefined;
|
|
12916
13234
|
/**
|
|
12917
13235
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
12918
13236
|
default_climate_setting?: {
|
|
13237
|
+
/** Unique key to identify the climate preset. */
|
|
12919
13238
|
climate_preset_key?: string | undefined;
|
|
13239
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12920
13240
|
can_edit?: boolean | undefined;
|
|
13241
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12921
13242
|
can_delete?: boolean | undefined;
|
|
13243
|
+
/** User-friendly name to identify the climate preset. */
|
|
12922
13244
|
name?: ((string | null) | undefined) | undefined;
|
|
13245
|
+
/** Display name for the climate preset. */
|
|
12923
13246
|
display_name?: string | undefined;
|
|
13247
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12924
13248
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
13249
|
+
/** 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
13250
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
13251
|
+
/** 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
13252
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
13253
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12927
13254
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
13255
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12928
13256
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
13257
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12929
13258
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
13259
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12930
13260
|
manual_override_allowed?: boolean | undefined;
|
|
12931
13261
|
} | undefined;
|
|
12932
13262
|
available_climate_presets?: Array<{
|
|
13263
|
+
/** Unique key to identify the climate preset. */
|
|
12933
13264
|
climate_preset_key: string;
|
|
13265
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12934
13266
|
can_edit: boolean;
|
|
13267
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12935
13268
|
can_delete: boolean;
|
|
13269
|
+
/** User-friendly name to identify the climate preset. */
|
|
12936
13270
|
name?: (string | null) | undefined;
|
|
13271
|
+
/** Display name for the climate preset. */
|
|
12937
13272
|
display_name: string;
|
|
13273
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12938
13274
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
13275
|
+
/** 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
13276
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
13277
|
+
/** 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
13278
|
cooling_set_point_celsius?: number | undefined;
|
|
13279
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12941
13280
|
heating_set_point_celsius?: number | undefined;
|
|
13281
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12942
13282
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
13283
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12943
13284
|
heating_set_point_fahrenheit?: number | undefined;
|
|
13285
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12944
13286
|
manual_override_allowed: boolean;
|
|
12945
13287
|
}> | undefined;
|
|
12946
13288
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
13289
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
12947
13290
|
active_thermostat_schedule?: ({
|
|
13291
|
+
/** ID of the thermostat schedule. */
|
|
12948
13292
|
thermostat_schedule_id: string;
|
|
13293
|
+
/** ID of the desired thermostat device. */
|
|
12949
13294
|
device_id: string;
|
|
13295
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
12950
13296
|
name?: string | undefined;
|
|
13297
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
12951
13298
|
climate_preset_key: string;
|
|
13299
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
12952
13300
|
max_override_period_minutes: number;
|
|
13301
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12953
13302
|
starts_at: string;
|
|
13303
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12954
13304
|
ends_at: string;
|
|
13305
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
12955
13306
|
created_at: string;
|
|
12956
|
-
/**
|
|
13307
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
12957
13308
|
errors?: any;
|
|
12958
13309
|
} | null) | undefined;
|
|
12959
13310
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -14524,19 +14875,31 @@ export interface Routes {
|
|
|
14524
14875
|
queryParams: {};
|
|
14525
14876
|
jsonBody: {};
|
|
14526
14877
|
commonParams: {
|
|
14527
|
-
/**
|
|
14878
|
+
/** ID of the connected account by which to filter. */
|
|
14528
14879
|
connected_account_id?: string | undefined;
|
|
14880
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
14529
14881
|
connected_account_ids?: string[] | undefined;
|
|
14882
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
14530
14883
|
connect_webview_id?: string | undefined;
|
|
14884
|
+
/** Device type by which to filter devices. */
|
|
14531
14885
|
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;
|
|
14886
|
+
/** Array of device types by which to filter devices. */
|
|
14532
14887
|
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;
|
|
14888
|
+
/** Manufacturer by which to filter devices. */
|
|
14533
14889
|
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;
|
|
14890
|
+
/** Array of device IDs by which to filter devices. */
|
|
14534
14891
|
device_ids?: string[] | undefined;
|
|
14892
|
+
/** Numerical limit on the number of devices to return. */
|
|
14535
14893
|
limit?: number;
|
|
14894
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
14536
14895
|
created_before?: Date | undefined;
|
|
14896
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
14537
14897
|
user_identifier_key?: string | undefined;
|
|
14898
|
+
/** 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
14899
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
14900
|
+
/** */
|
|
14539
14901
|
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;
|
|
14902
|
+
/** */
|
|
14540
14903
|
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
14904
|
};
|
|
14542
14905
|
formData: {};
|
|
@@ -14888,60 +15251,105 @@ export interface Routes {
|
|
|
14888
15251
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
14889
15252
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
14890
15253
|
current_climate_setting?: {
|
|
15254
|
+
/** Unique key to identify the climate preset. */
|
|
14891
15255
|
climate_preset_key?: string | undefined;
|
|
15256
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14892
15257
|
can_edit?: boolean | undefined;
|
|
15258
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14893
15259
|
can_delete?: boolean | undefined;
|
|
15260
|
+
/** User-friendly name to identify the climate preset. */
|
|
14894
15261
|
name?: ((string | null) | undefined) | undefined;
|
|
15262
|
+
/** Display name for the climate preset. */
|
|
14895
15263
|
display_name?: string | undefined;
|
|
15264
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14896
15265
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
15266
|
+
/** 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
15267
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
15268
|
+
/** 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
15269
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
15270
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14899
15271
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
15272
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14900
15273
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15274
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14901
15275
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15276
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14902
15277
|
manual_override_allowed?: boolean | undefined;
|
|
14903
15278
|
} | undefined;
|
|
14904
15279
|
/**
|
|
14905
15280
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
14906
15281
|
default_climate_setting?: {
|
|
15282
|
+
/** Unique key to identify the climate preset. */
|
|
14907
15283
|
climate_preset_key?: string | undefined;
|
|
15284
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14908
15285
|
can_edit?: boolean | undefined;
|
|
15286
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14909
15287
|
can_delete?: boolean | undefined;
|
|
15288
|
+
/** User-friendly name to identify the climate preset. */
|
|
14910
15289
|
name?: ((string | null) | undefined) | undefined;
|
|
15290
|
+
/** Display name for the climate preset. */
|
|
14911
15291
|
display_name?: string | undefined;
|
|
15292
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14912
15293
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
15294
|
+
/** 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
15295
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
15296
|
+
/** 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
15297
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
15298
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14915
15299
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
15300
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14916
15301
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15302
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14917
15303
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15304
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14918
15305
|
manual_override_allowed?: boolean | undefined;
|
|
14919
15306
|
} | undefined;
|
|
14920
15307
|
available_climate_presets?: Array<{
|
|
15308
|
+
/** Unique key to identify the climate preset. */
|
|
14921
15309
|
climate_preset_key: string;
|
|
15310
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14922
15311
|
can_edit: boolean;
|
|
15312
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14923
15313
|
can_delete: boolean;
|
|
15314
|
+
/** User-friendly name to identify the climate preset. */
|
|
14924
15315
|
name?: (string | null) | undefined;
|
|
15316
|
+
/** Display name for the climate preset. */
|
|
14925
15317
|
display_name: string;
|
|
15318
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14926
15319
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
15320
|
+
/** 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
15321
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
15322
|
+
/** 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
15323
|
cooling_set_point_celsius?: number | undefined;
|
|
15324
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14929
15325
|
heating_set_point_celsius?: number | undefined;
|
|
15326
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14930
15327
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
15328
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14931
15329
|
heating_set_point_fahrenheit?: number | undefined;
|
|
15330
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14932
15331
|
manual_override_allowed: boolean;
|
|
14933
15332
|
}> | undefined;
|
|
14934
15333
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
15334
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
14935
15335
|
active_thermostat_schedule?: ({
|
|
15336
|
+
/** ID of the thermostat schedule. */
|
|
14936
15337
|
thermostat_schedule_id: string;
|
|
15338
|
+
/** ID of the desired thermostat device. */
|
|
14937
15339
|
device_id: string;
|
|
15340
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
14938
15341
|
name?: string | undefined;
|
|
15342
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
14939
15343
|
climate_preset_key: string;
|
|
15344
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
14940
15345
|
max_override_period_minutes: number;
|
|
15346
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
14941
15347
|
starts_at: string;
|
|
15348
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
14942
15349
|
ends_at: string;
|
|
15350
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
14943
15351
|
created_at: string;
|
|
14944
|
-
/**
|
|
15352
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
14945
15353
|
errors?: any;
|
|
14946
15354
|
} | null) | undefined;
|
|
14947
15355
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -15351,60 +15759,105 @@ export interface Routes {
|
|
|
15351
15759
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
15352
15760
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
15353
15761
|
current_climate_setting?: {
|
|
15762
|
+
/** Unique key to identify the climate preset. */
|
|
15354
15763
|
climate_preset_key?: string | undefined;
|
|
15764
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15355
15765
|
can_edit?: boolean | undefined;
|
|
15766
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15356
15767
|
can_delete?: boolean | undefined;
|
|
15768
|
+
/** User-friendly name to identify the climate preset. */
|
|
15357
15769
|
name?: ((string | null) | undefined) | undefined;
|
|
15770
|
+
/** Display name for the climate preset. */
|
|
15358
15771
|
display_name?: string | undefined;
|
|
15772
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15359
15773
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
15774
|
+
/** 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
15775
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
15776
|
+
/** 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
15777
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
15778
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15362
15779
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
15780
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15363
15781
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15782
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15364
15783
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15784
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15365
15785
|
manual_override_allowed?: boolean | undefined;
|
|
15366
15786
|
} | undefined;
|
|
15367
15787
|
/**
|
|
15368
15788
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
15369
15789
|
default_climate_setting?: {
|
|
15790
|
+
/** Unique key to identify the climate preset. */
|
|
15370
15791
|
climate_preset_key?: string | undefined;
|
|
15792
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15371
15793
|
can_edit?: boolean | undefined;
|
|
15794
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15372
15795
|
can_delete?: boolean | undefined;
|
|
15796
|
+
/** User-friendly name to identify the climate preset. */
|
|
15373
15797
|
name?: ((string | null) | undefined) | undefined;
|
|
15798
|
+
/** Display name for the climate preset. */
|
|
15374
15799
|
display_name?: string | undefined;
|
|
15800
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15375
15801
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
15802
|
+
/** 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
15803
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
15804
|
+
/** 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
15805
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
15806
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15378
15807
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
15808
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15379
15809
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15810
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15380
15811
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
15812
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15381
15813
|
manual_override_allowed?: boolean | undefined;
|
|
15382
15814
|
} | undefined;
|
|
15383
15815
|
available_climate_presets?: Array<{
|
|
15816
|
+
/** Unique key to identify the climate preset. */
|
|
15384
15817
|
climate_preset_key: string;
|
|
15818
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15385
15819
|
can_edit: boolean;
|
|
15820
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15386
15821
|
can_delete: boolean;
|
|
15822
|
+
/** User-friendly name to identify the climate preset. */
|
|
15387
15823
|
name?: (string | null) | undefined;
|
|
15824
|
+
/** Display name for the climate preset. */
|
|
15388
15825
|
display_name: string;
|
|
15826
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15389
15827
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
15828
|
+
/** 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
15829
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
15830
|
+
/** 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
15831
|
cooling_set_point_celsius?: number | undefined;
|
|
15832
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15392
15833
|
heating_set_point_celsius?: number | undefined;
|
|
15834
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15393
15835
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
15836
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15394
15837
|
heating_set_point_fahrenheit?: number | undefined;
|
|
15838
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15395
15839
|
manual_override_allowed: boolean;
|
|
15396
15840
|
}> | undefined;
|
|
15397
15841
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
15842
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
15398
15843
|
active_thermostat_schedule?: ({
|
|
15844
|
+
/** ID of the thermostat schedule. */
|
|
15399
15845
|
thermostat_schedule_id: string;
|
|
15846
|
+
/** ID of the desired thermostat device. */
|
|
15400
15847
|
device_id: string;
|
|
15848
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
15401
15849
|
name?: string | undefined;
|
|
15850
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
15402
15851
|
climate_preset_key: string;
|
|
15852
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
15403
15853
|
max_override_period_minutes: number;
|
|
15854
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15404
15855
|
starts_at: string;
|
|
15856
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15405
15857
|
ends_at: string;
|
|
15858
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
15406
15859
|
created_at: string;
|
|
15407
|
-
/**
|
|
15860
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
15408
15861
|
errors?: any;
|
|
15409
15862
|
} | null) | undefined;
|
|
15410
15863
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -17919,7 +18372,9 @@ export interface Routes {
|
|
|
17919
18372
|
method: 'POST';
|
|
17920
18373
|
queryParams: {};
|
|
17921
18374
|
jsonBody: {
|
|
18375
|
+
/** ID of the desired thermostat device. */
|
|
17922
18376
|
device_id: string;
|
|
18377
|
+
/** Climate preset key of the desired climate preset. */
|
|
17923
18378
|
climate_preset_key: string;
|
|
17924
18379
|
};
|
|
17925
18380
|
commonParams: {};
|
|
@@ -18652,12 +19107,13 @@ export interface Routes {
|
|
|
18652
19107
|
method: 'POST';
|
|
18653
19108
|
queryParams: {};
|
|
18654
19109
|
jsonBody: {
|
|
18655
|
-
/** ID of the thermostat device. */
|
|
19110
|
+
/** ID of the desired thermostat device. */
|
|
18656
19111
|
device_id: string;
|
|
18657
|
-
/**
|
|
19112
|
+
/** 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
19113
|
cooling_set_point_celsius?: number | undefined;
|
|
18659
|
-
/**
|
|
19114
|
+
/** 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
19115
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
19116
|
+
/** */
|
|
18661
19117
|
sync?: boolean;
|
|
18662
19118
|
};
|
|
18663
19119
|
commonParams: {};
|
|
@@ -19390,15 +19846,25 @@ export interface Routes {
|
|
|
19390
19846
|
method: 'POST';
|
|
19391
19847
|
queryParams: {};
|
|
19392
19848
|
jsonBody: {
|
|
19849
|
+
/** ID of the desired thermostat device. */
|
|
19393
19850
|
device_id: string;
|
|
19851
|
+
/** Unique key to identify the climate preset. */
|
|
19394
19852
|
climate_preset_key: string;
|
|
19853
|
+
/** User-friendly name to identify the climate preset. */
|
|
19395
19854
|
name?: (string | null) | undefined;
|
|
19855
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19396
19856
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
19857
|
+
/** 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
19858
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
19859
|
+
/** 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
19860
|
cooling_set_point_celsius?: number | undefined;
|
|
19861
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19399
19862
|
heating_set_point_celsius?: number | undefined;
|
|
19863
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19400
19864
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
19865
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19401
19866
|
heating_set_point_fahrenheit?: number | undefined;
|
|
19867
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19402
19868
|
manual_override_allowed: boolean;
|
|
19403
19869
|
};
|
|
19404
19870
|
commonParams: {};
|
|
@@ -19410,7 +19876,9 @@ export interface Routes {
|
|
|
19410
19876
|
method: 'POST' | 'DELETE';
|
|
19411
19877
|
queryParams: {};
|
|
19412
19878
|
jsonBody: {
|
|
19879
|
+
/** ID of the desired thermostat device. */
|
|
19413
19880
|
device_id: string;
|
|
19881
|
+
/** Climate preset key of the desired climate preset. */
|
|
19414
19882
|
climate_preset_key: string;
|
|
19415
19883
|
};
|
|
19416
19884
|
commonParams: {};
|
|
@@ -19423,9 +19891,9 @@ export interface Routes {
|
|
|
19423
19891
|
queryParams: {};
|
|
19424
19892
|
jsonBody: {};
|
|
19425
19893
|
commonParams: {
|
|
19426
|
-
/** ID of the thermostat device. */
|
|
19894
|
+
/** ID of the desired thermostat device. */
|
|
19427
19895
|
device_id?: string | undefined;
|
|
19428
|
-
/**
|
|
19896
|
+
/** User-friendly name of the desired thermostat device. */
|
|
19429
19897
|
name?: string | undefined;
|
|
19430
19898
|
};
|
|
19431
19899
|
formData: {};
|
|
@@ -19777,60 +20245,105 @@ export interface Routes {
|
|
|
19777
20245
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
19778
20246
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
19779
20247
|
current_climate_setting?: {
|
|
20248
|
+
/** Unique key to identify the climate preset. */
|
|
19780
20249
|
climate_preset_key?: string | undefined;
|
|
20250
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19781
20251
|
can_edit?: boolean | undefined;
|
|
20252
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19782
20253
|
can_delete?: boolean | undefined;
|
|
20254
|
+
/** User-friendly name to identify the climate preset. */
|
|
19783
20255
|
name?: ((string | null) | undefined) | undefined;
|
|
20256
|
+
/** Display name for the climate preset. */
|
|
19784
20257
|
display_name?: string | undefined;
|
|
20258
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19785
20259
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
20260
|
+
/** 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
20261
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
20262
|
+
/** 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
20263
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
20264
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19788
20265
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
20266
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19789
20267
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
20268
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19790
20269
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
20270
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19791
20271
|
manual_override_allowed?: boolean | undefined;
|
|
19792
20272
|
} | undefined;
|
|
19793
20273
|
/**
|
|
19794
20274
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
19795
20275
|
default_climate_setting?: {
|
|
20276
|
+
/** Unique key to identify the climate preset. */
|
|
19796
20277
|
climate_preset_key?: string | undefined;
|
|
20278
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19797
20279
|
can_edit?: boolean | undefined;
|
|
20280
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19798
20281
|
can_delete?: boolean | undefined;
|
|
20282
|
+
/** User-friendly name to identify the climate preset. */
|
|
19799
20283
|
name?: ((string | null) | undefined) | undefined;
|
|
20284
|
+
/** Display name for the climate preset. */
|
|
19800
20285
|
display_name?: string | undefined;
|
|
20286
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19801
20287
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
20288
|
+
/** 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
20289
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
20290
|
+
/** 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
20291
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
20292
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19804
20293
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
20294
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19805
20295
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
20296
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19806
20297
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
20298
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19807
20299
|
manual_override_allowed?: boolean | undefined;
|
|
19808
20300
|
} | undefined;
|
|
19809
20301
|
available_climate_presets?: Array<{
|
|
20302
|
+
/** Unique key to identify the climate preset. */
|
|
19810
20303
|
climate_preset_key: string;
|
|
20304
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19811
20305
|
can_edit: boolean;
|
|
20306
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19812
20307
|
can_delete: boolean;
|
|
20308
|
+
/** User-friendly name to identify the climate preset. */
|
|
19813
20309
|
name?: (string | null) | undefined;
|
|
20310
|
+
/** Display name for the climate preset. */
|
|
19814
20311
|
display_name: string;
|
|
20312
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19815
20313
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
20314
|
+
/** 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
20315
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
20316
|
+
/** 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
20317
|
cooling_set_point_celsius?: number | undefined;
|
|
20318
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19818
20319
|
heating_set_point_celsius?: number | undefined;
|
|
20320
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19819
20321
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
20322
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19820
20323
|
heating_set_point_fahrenheit?: number | undefined;
|
|
20324
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19821
20325
|
manual_override_allowed: boolean;
|
|
19822
20326
|
}> | undefined;
|
|
19823
20327
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
20328
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
19824
20329
|
active_thermostat_schedule?: ({
|
|
20330
|
+
/** ID of the thermostat schedule. */
|
|
19825
20331
|
thermostat_schedule_id: string;
|
|
20332
|
+
/** ID of the desired thermostat device. */
|
|
19826
20333
|
device_id: string;
|
|
20334
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
19827
20335
|
name?: string | undefined;
|
|
20336
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
19828
20337
|
climate_preset_key: string;
|
|
20338
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
19829
20339
|
max_override_period_minutes: number;
|
|
20340
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19830
20341
|
starts_at: string;
|
|
20342
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19831
20343
|
ends_at: string;
|
|
20344
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
19832
20345
|
created_at: string;
|
|
19833
|
-
/**
|
|
20346
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
19834
20347
|
errors?: any;
|
|
19835
20348
|
} | null) | undefined;
|
|
19836
20349
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -19900,12 +20413,13 @@ export interface Routes {
|
|
|
19900
20413
|
method: 'POST';
|
|
19901
20414
|
queryParams: {};
|
|
19902
20415
|
jsonBody: {
|
|
19903
|
-
/** ID of the thermostat device. */
|
|
20416
|
+
/** ID of the desired thermostat device. */
|
|
19904
20417
|
device_id: string;
|
|
19905
|
-
/**
|
|
20418
|
+
/** 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
20419
|
heating_set_point_celsius?: number | undefined;
|
|
19907
|
-
/**
|
|
20420
|
+
/** 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
20421
|
heating_set_point_fahrenheit?: number | undefined;
|
|
20422
|
+
/** */
|
|
19909
20423
|
sync?: boolean;
|
|
19910
20424
|
};
|
|
19911
20425
|
commonParams: {};
|
|
@@ -20638,16 +21152,17 @@ export interface Routes {
|
|
|
20638
21152
|
method: 'POST';
|
|
20639
21153
|
queryParams: {};
|
|
20640
21154
|
jsonBody: {
|
|
20641
|
-
/** ID of the thermostat device. */
|
|
21155
|
+
/** ID of the desired thermostat device. */
|
|
20642
21156
|
device_id: string;
|
|
20643
|
-
/**
|
|
21157
|
+
/** 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
21158
|
heating_set_point_celsius?: number | undefined;
|
|
20645
|
-
/**
|
|
21159
|
+
/** 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
21160
|
heating_set_point_fahrenheit?: number | undefined;
|
|
20647
|
-
/**
|
|
21161
|
+
/** 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
21162
|
cooling_set_point_celsius?: number | undefined;
|
|
20649
|
-
/**
|
|
21163
|
+
/** 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
21164
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
21165
|
+
/** */
|
|
20651
21166
|
sync?: boolean;
|
|
20652
21167
|
};
|
|
20653
21168
|
commonParams: {};
|
|
@@ -21381,19 +21896,31 @@ export interface Routes {
|
|
|
21381
21896
|
queryParams: {};
|
|
21382
21897
|
jsonBody: {};
|
|
21383
21898
|
commonParams: {
|
|
21384
|
-
/**
|
|
21899
|
+
/** ID of the connected account by which to filter. */
|
|
21385
21900
|
connected_account_id?: string | undefined;
|
|
21901
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
21386
21902
|
connected_account_ids?: string[] | undefined;
|
|
21903
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
21387
21904
|
connect_webview_id?: string | undefined;
|
|
21905
|
+
/** Device type by which to filter devices. */
|
|
21388
21906
|
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;
|
|
21907
|
+
/** Array of device types by which to filter devices. */
|
|
21389
21908
|
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;
|
|
21909
|
+
/** Manufacturer by which to filter devices. */
|
|
21390
21910
|
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;
|
|
21911
|
+
/** Array of device IDs by which to filter devices. */
|
|
21391
21912
|
device_ids?: string[] | undefined;
|
|
21913
|
+
/** Numerical limit on the number of devices to return. */
|
|
21392
21914
|
limit?: number;
|
|
21915
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
21393
21916
|
created_before?: Date | undefined;
|
|
21917
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
21394
21918
|
user_identifier_key?: string | undefined;
|
|
21919
|
+
/** 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
21920
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
21921
|
+
/** */
|
|
21396
21922
|
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;
|
|
21923
|
+
/** */
|
|
21397
21924
|
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
21925
|
};
|
|
21399
21926
|
formData: {};
|
|
@@ -21745,60 +22272,105 @@ export interface Routes {
|
|
|
21745
22272
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
21746
22273
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
21747
22274
|
current_climate_setting?: {
|
|
22275
|
+
/** Unique key to identify the climate preset. */
|
|
21748
22276
|
climate_preset_key?: string | undefined;
|
|
22277
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
21749
22278
|
can_edit?: boolean | undefined;
|
|
22279
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
21750
22280
|
can_delete?: boolean | undefined;
|
|
22281
|
+
/** User-friendly name to identify the climate preset. */
|
|
21751
22282
|
name?: ((string | null) | undefined) | undefined;
|
|
22283
|
+
/** Display name for the climate preset. */
|
|
21752
22284
|
display_name?: string | undefined;
|
|
22285
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
21753
22286
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
22287
|
+
/** 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
22288
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
22289
|
+
/** 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
22290
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
22291
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
21756
22292
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
22293
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
21757
22294
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22295
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
21758
22296
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22297
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
21759
22298
|
manual_override_allowed?: boolean | undefined;
|
|
21760
22299
|
} | undefined;
|
|
21761
22300
|
/**
|
|
21762
22301
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
21763
22302
|
default_climate_setting?: {
|
|
22303
|
+
/** Unique key to identify the climate preset. */
|
|
21764
22304
|
climate_preset_key?: string | undefined;
|
|
22305
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
21765
22306
|
can_edit?: boolean | undefined;
|
|
22307
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
21766
22308
|
can_delete?: boolean | undefined;
|
|
22309
|
+
/** User-friendly name to identify the climate preset. */
|
|
21767
22310
|
name?: ((string | null) | undefined) | undefined;
|
|
22311
|
+
/** Display name for the climate preset. */
|
|
21768
22312
|
display_name?: string | undefined;
|
|
22313
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
21769
22314
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
22315
|
+
/** 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
22316
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
22317
|
+
/** 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
22318
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
22319
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
21772
22320
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
22321
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
21773
22322
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22323
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
21774
22324
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22325
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
21775
22326
|
manual_override_allowed?: boolean | undefined;
|
|
21776
22327
|
} | undefined;
|
|
21777
22328
|
available_climate_presets?: Array<{
|
|
22329
|
+
/** Unique key to identify the climate preset. */
|
|
21778
22330
|
climate_preset_key: string;
|
|
22331
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
21779
22332
|
can_edit: boolean;
|
|
22333
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
21780
22334
|
can_delete: boolean;
|
|
22335
|
+
/** User-friendly name to identify the climate preset. */
|
|
21781
22336
|
name?: (string | null) | undefined;
|
|
22337
|
+
/** Display name for the climate preset. */
|
|
21782
22338
|
display_name: string;
|
|
22339
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
21783
22340
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
22341
|
+
/** 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
22342
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
22343
|
+
/** 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
22344
|
cooling_set_point_celsius?: number | undefined;
|
|
22345
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
21786
22346
|
heating_set_point_celsius?: number | undefined;
|
|
22347
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
21787
22348
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
22349
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
21788
22350
|
heating_set_point_fahrenheit?: number | undefined;
|
|
22351
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
21789
22352
|
manual_override_allowed: boolean;
|
|
21790
22353
|
}> | undefined;
|
|
21791
22354
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
22355
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
21792
22356
|
active_thermostat_schedule?: ({
|
|
22357
|
+
/** ID of the thermostat schedule. */
|
|
21793
22358
|
thermostat_schedule_id: string;
|
|
22359
|
+
/** ID of the desired thermostat device. */
|
|
21794
22360
|
device_id: string;
|
|
22361
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
21795
22362
|
name?: string | undefined;
|
|
22363
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
21796
22364
|
climate_preset_key: string;
|
|
22365
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
21797
22366
|
max_override_period_minutes: number;
|
|
22367
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
21798
22368
|
starts_at: string;
|
|
22369
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
21799
22370
|
ends_at: string;
|
|
22371
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
21800
22372
|
created_at: string;
|
|
21801
|
-
/**
|
|
22373
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
21802
22374
|
errors?: any;
|
|
21803
22375
|
} | null) | undefined;
|
|
21804
22376
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -22208,60 +22780,105 @@ export interface Routes {
|
|
|
22208
22780
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
22209
22781
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
22210
22782
|
current_climate_setting?: {
|
|
22783
|
+
/** Unique key to identify the climate preset. */
|
|
22211
22784
|
climate_preset_key?: string | undefined;
|
|
22785
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
22212
22786
|
can_edit?: boolean | undefined;
|
|
22787
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
22213
22788
|
can_delete?: boolean | undefined;
|
|
22789
|
+
/** User-friendly name to identify the climate preset. */
|
|
22214
22790
|
name?: ((string | null) | undefined) | undefined;
|
|
22791
|
+
/** Display name for the climate preset. */
|
|
22215
22792
|
display_name?: string | undefined;
|
|
22793
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
22216
22794
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
22795
|
+
/** 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
22796
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
22797
|
+
/** 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
22798
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
22799
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
22219
22800
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
22801
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
22220
22802
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22803
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
22221
22804
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22805
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
22222
22806
|
manual_override_allowed?: boolean | undefined;
|
|
22223
22807
|
} | undefined;
|
|
22224
22808
|
/**
|
|
22225
22809
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
22226
22810
|
default_climate_setting?: {
|
|
22811
|
+
/** Unique key to identify the climate preset. */
|
|
22227
22812
|
climate_preset_key?: string | undefined;
|
|
22813
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
22228
22814
|
can_edit?: boolean | undefined;
|
|
22815
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
22229
22816
|
can_delete?: boolean | undefined;
|
|
22817
|
+
/** User-friendly name to identify the climate preset. */
|
|
22230
22818
|
name?: ((string | null) | undefined) | undefined;
|
|
22819
|
+
/** Display name for the climate preset. */
|
|
22231
22820
|
display_name?: string | undefined;
|
|
22821
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
22232
22822
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
22823
|
+
/** 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
22824
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
22825
|
+
/** 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
22826
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
22827
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
22235
22828
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
22829
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
22236
22830
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22831
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
22237
22832
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
22833
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
22238
22834
|
manual_override_allowed?: boolean | undefined;
|
|
22239
22835
|
} | undefined;
|
|
22240
22836
|
available_climate_presets?: Array<{
|
|
22837
|
+
/** Unique key to identify the climate preset. */
|
|
22241
22838
|
climate_preset_key: string;
|
|
22839
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
22242
22840
|
can_edit: boolean;
|
|
22841
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
22243
22842
|
can_delete: boolean;
|
|
22843
|
+
/** User-friendly name to identify the climate preset. */
|
|
22244
22844
|
name?: (string | null) | undefined;
|
|
22845
|
+
/** Display name for the climate preset. */
|
|
22245
22846
|
display_name: string;
|
|
22847
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
22246
22848
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
22849
|
+
/** 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
22850
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
22851
|
+
/** 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
22852
|
cooling_set_point_celsius?: number | undefined;
|
|
22853
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
22249
22854
|
heating_set_point_celsius?: number | undefined;
|
|
22855
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
22250
22856
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
22857
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
22251
22858
|
heating_set_point_fahrenheit?: number | undefined;
|
|
22859
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
22252
22860
|
manual_override_allowed: boolean;
|
|
22253
22861
|
}> | undefined;
|
|
22254
22862
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
22863
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
22255
22864
|
active_thermostat_schedule?: ({
|
|
22865
|
+
/** ID of the thermostat schedule. */
|
|
22256
22866
|
thermostat_schedule_id: string;
|
|
22867
|
+
/** ID of the desired thermostat device. */
|
|
22257
22868
|
device_id: string;
|
|
22869
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
22258
22870
|
name?: string | undefined;
|
|
22871
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
22259
22872
|
climate_preset_key: string;
|
|
22873
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
22260
22874
|
max_override_period_minutes: number;
|
|
22875
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
22261
22876
|
starts_at: string;
|
|
22877
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
22262
22878
|
ends_at: string;
|
|
22879
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
22263
22880
|
created_at: string;
|
|
22264
|
-
/**
|
|
22881
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
22265
22882
|
errors?: any;
|
|
22266
22883
|
} | null) | undefined;
|
|
22267
22884
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -22331,8 +22948,9 @@ export interface Routes {
|
|
|
22331
22948
|
method: 'POST';
|
|
22332
22949
|
queryParams: {};
|
|
22333
22950
|
jsonBody: {
|
|
22334
|
-
/** ID of the thermostat device. */
|
|
22951
|
+
/** ID of the desired thermostat device. */
|
|
22335
22952
|
device_id: string;
|
|
22953
|
+
/** */
|
|
22336
22954
|
sync?: boolean;
|
|
22337
22955
|
};
|
|
22338
22956
|
commonParams: {};
|
|
@@ -23065,26 +23683,41 @@ export interface Routes {
|
|
|
23065
23683
|
method: 'POST';
|
|
23066
23684
|
queryParams: {};
|
|
23067
23685
|
jsonBody: {
|
|
23686
|
+
/** ID of the desired thermostat device. */
|
|
23068
23687
|
device_id: string;
|
|
23688
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
23069
23689
|
name?: string | undefined;
|
|
23690
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
23070
23691
|
climate_preset_key: string;
|
|
23692
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
23071
23693
|
max_override_period_minutes?: number;
|
|
23694
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23072
23695
|
starts_at: string;
|
|
23696
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23073
23697
|
ends_at: string;
|
|
23074
23698
|
};
|
|
23075
23699
|
commonParams: {};
|
|
23076
23700
|
formData: {};
|
|
23077
23701
|
jsonResponse: {
|
|
23702
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
23078
23703
|
thermostat_schedule: {
|
|
23704
|
+
/** ID of the thermostat schedule. */
|
|
23079
23705
|
thermostat_schedule_id: string;
|
|
23706
|
+
/** ID of the desired thermostat device. */
|
|
23080
23707
|
device_id: string;
|
|
23708
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
23081
23709
|
name?: string | undefined;
|
|
23710
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
23082
23711
|
climate_preset_key: string;
|
|
23712
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
23083
23713
|
max_override_period_minutes: number;
|
|
23714
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23084
23715
|
starts_at: string;
|
|
23716
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23085
23717
|
ends_at: string;
|
|
23718
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
23086
23719
|
created_at: string;
|
|
23087
|
-
/**
|
|
23720
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
23088
23721
|
errors?: any;
|
|
23089
23722
|
};
|
|
23090
23723
|
};
|
|
@@ -23095,6 +23728,7 @@ export interface Routes {
|
|
|
23095
23728
|
queryParams: {};
|
|
23096
23729
|
jsonBody: {};
|
|
23097
23730
|
commonParams: {
|
|
23731
|
+
/** ID of the desired thermostat schedule. */
|
|
23098
23732
|
thermostat_schedule_id: string;
|
|
23099
23733
|
};
|
|
23100
23734
|
formData: {};
|
|
@@ -23106,20 +23740,30 @@ export interface Routes {
|
|
|
23106
23740
|
queryParams: {};
|
|
23107
23741
|
jsonBody: {};
|
|
23108
23742
|
commonParams: {
|
|
23743
|
+
/** ID of the desired thermostat schedule. */
|
|
23109
23744
|
thermostat_schedule_id: string;
|
|
23110
23745
|
};
|
|
23111
23746
|
formData: {};
|
|
23112
23747
|
jsonResponse: {
|
|
23748
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
23113
23749
|
thermostat_schedule: {
|
|
23750
|
+
/** ID of the thermostat schedule. */
|
|
23114
23751
|
thermostat_schedule_id: string;
|
|
23752
|
+
/** ID of the desired thermostat device. */
|
|
23115
23753
|
device_id: string;
|
|
23754
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
23116
23755
|
name?: string | undefined;
|
|
23756
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
23117
23757
|
climate_preset_key: string;
|
|
23758
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
23118
23759
|
max_override_period_minutes: number;
|
|
23760
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23119
23761
|
starts_at: string;
|
|
23762
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23120
23763
|
ends_at: string;
|
|
23764
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
23121
23765
|
created_at: string;
|
|
23122
|
-
/**
|
|
23766
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
23123
23767
|
errors?: any;
|
|
23124
23768
|
};
|
|
23125
23769
|
};
|
|
@@ -23130,21 +23774,31 @@ export interface Routes {
|
|
|
23130
23774
|
queryParams: {};
|
|
23131
23775
|
jsonBody: {};
|
|
23132
23776
|
commonParams: {
|
|
23777
|
+
/** ID of the desired thermostat device. */
|
|
23133
23778
|
device_id: string;
|
|
23779
|
+
/** User identifier key by which to filter the list of returned thermostat schedules. */
|
|
23134
23780
|
user_identifier_key?: string | undefined;
|
|
23135
23781
|
};
|
|
23136
23782
|
formData: {};
|
|
23137
23783
|
jsonResponse: {
|
|
23138
23784
|
thermostat_schedules: Array<{
|
|
23785
|
+
/** ID of the thermostat schedule. */
|
|
23139
23786
|
thermostat_schedule_id: string;
|
|
23787
|
+
/** ID of the desired thermostat device. */
|
|
23140
23788
|
device_id: string;
|
|
23789
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
23141
23790
|
name?: string | undefined;
|
|
23791
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
23142
23792
|
climate_preset_key: string;
|
|
23793
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
23143
23794
|
max_override_period_minutes: number;
|
|
23795
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23144
23796
|
starts_at: string;
|
|
23797
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23145
23798
|
ends_at: string;
|
|
23799
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
23146
23800
|
created_at: string;
|
|
23147
|
-
/**
|
|
23801
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
23148
23802
|
errors?: any;
|
|
23149
23803
|
}>;
|
|
23150
23804
|
};
|
|
@@ -23154,11 +23808,17 @@ export interface Routes {
|
|
|
23154
23808
|
method: 'PATCH' | 'POST';
|
|
23155
23809
|
queryParams: {};
|
|
23156
23810
|
jsonBody: {
|
|
23811
|
+
/** ID of the desired thermostat schedule. */
|
|
23157
23812
|
thermostat_schedule_id: string;
|
|
23813
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
23158
23814
|
name?: string | undefined;
|
|
23815
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
23159
23816
|
climate_preset_key?: string | undefined;
|
|
23817
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
23160
23818
|
max_override_period_minutes?: number | undefined;
|
|
23819
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23161
23820
|
starts_at?: string | undefined;
|
|
23821
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23162
23822
|
ends_at?: string | undefined;
|
|
23163
23823
|
};
|
|
23164
23824
|
commonParams: {};
|
|
@@ -23170,7 +23830,9 @@ export interface Routes {
|
|
|
23170
23830
|
method: 'POST';
|
|
23171
23831
|
queryParams: {};
|
|
23172
23832
|
jsonBody: {
|
|
23833
|
+
/** ID of the desired thermostat device. */
|
|
23173
23834
|
device_id: string;
|
|
23835
|
+
/** Climate preset key of the desired climate preset. */
|
|
23174
23836
|
climate_preset_key: string;
|
|
23175
23837
|
};
|
|
23176
23838
|
commonParams: {};
|
|
@@ -23182,13 +23844,13 @@ export interface Routes {
|
|
|
23182
23844
|
method: 'POST';
|
|
23183
23845
|
queryParams: {};
|
|
23184
23846
|
jsonBody: {
|
|
23185
|
-
/** ID of the thermostat device. */
|
|
23186
23847
|
device_id: string;
|
|
23187
23848
|
/**
|
|
23188
23849
|
* @deprecated Use `fan_mode_setting` instead. */
|
|
23189
23850
|
fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
|
|
23190
|
-
/**
|
|
23851
|
+
/** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
|
|
23191
23852
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
23853
|
+
/** */
|
|
23192
23854
|
sync?: boolean;
|
|
23193
23855
|
};
|
|
23194
23856
|
commonParams: {};
|
|
@@ -23921,10 +24583,15 @@ export interface Routes {
|
|
|
23921
24583
|
method: 'POST' | 'PATCH';
|
|
23922
24584
|
queryParams: {};
|
|
23923
24585
|
jsonBody: {
|
|
24586
|
+
/** ID of the desired thermostat device. */
|
|
23924
24587
|
device_id: string;
|
|
24588
|
+
/** 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
24589
|
lower_limit_celsius?: (number | undefined) | null;
|
|
24590
|
+
/** 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
24591
|
lower_limit_fahrenheit?: (number | undefined) | null;
|
|
24592
|
+
/** 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
24593
|
upper_limit_celsius?: (number | undefined) | null;
|
|
24594
|
+
/** 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
24595
|
upper_limit_fahrenheit?: (number | undefined) | null;
|
|
23929
24596
|
};
|
|
23930
24597
|
commonParams: {};
|
|
@@ -23936,15 +24603,25 @@ export interface Routes {
|
|
|
23936
24603
|
method: 'POST' | 'PATCH';
|
|
23937
24604
|
queryParams: {};
|
|
23938
24605
|
jsonBody: {
|
|
24606
|
+
/** ID of the desired thermostat device. */
|
|
23939
24607
|
device_id: string;
|
|
24608
|
+
/** Unique key to identify the climate preset. */
|
|
23940
24609
|
climate_preset_key: string;
|
|
24610
|
+
/** User-friendly name to identify the climate preset. */
|
|
23941
24611
|
name?: (string | null) | undefined;
|
|
24612
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
23942
24613
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
24614
|
+
/** 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
24615
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
24616
|
+
/** 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
24617
|
cooling_set_point_celsius?: number | undefined;
|
|
24618
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
23945
24619
|
heating_set_point_celsius?: number | undefined;
|
|
24620
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
23946
24621
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
24622
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
23947
24623
|
heating_set_point_fahrenheit?: number | undefined;
|
|
24624
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
23948
24625
|
manual_override_allowed: boolean;
|
|
23949
24626
|
};
|
|
23950
24627
|
commonParams: {};
|
|
@@ -24487,60 +25164,105 @@ export interface Routes {
|
|
|
24487
25164
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
24488
25165
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
24489
25166
|
current_climate_setting?: {
|
|
25167
|
+
/** Unique key to identify the climate preset. */
|
|
24490
25168
|
climate_preset_key?: string | undefined;
|
|
25169
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24491
25170
|
can_edit?: boolean | undefined;
|
|
25171
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24492
25172
|
can_delete?: boolean | undefined;
|
|
25173
|
+
/** User-friendly name to identify the climate preset. */
|
|
24493
25174
|
name?: ((string | null) | undefined) | undefined;
|
|
25175
|
+
/** Display name for the climate preset. */
|
|
24494
25176
|
display_name?: string | undefined;
|
|
25177
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24495
25178
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
25179
|
+
/** 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
25180
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
25181
|
+
/** 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
25182
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
25183
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24498
25184
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
25185
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24499
25186
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25187
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24500
25188
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25189
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24501
25190
|
manual_override_allowed?: boolean | undefined;
|
|
24502
25191
|
} | undefined;
|
|
24503
25192
|
/**
|
|
24504
25193
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
24505
25194
|
default_climate_setting?: {
|
|
25195
|
+
/** Unique key to identify the climate preset. */
|
|
24506
25196
|
climate_preset_key?: string | undefined;
|
|
25197
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24507
25198
|
can_edit?: boolean | undefined;
|
|
25199
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24508
25200
|
can_delete?: boolean | undefined;
|
|
25201
|
+
/** User-friendly name to identify the climate preset. */
|
|
24509
25202
|
name?: ((string | null) | undefined) | undefined;
|
|
25203
|
+
/** Display name for the climate preset. */
|
|
24510
25204
|
display_name?: string | undefined;
|
|
25205
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24511
25206
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
25207
|
+
/** 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
25208
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
25209
|
+
/** 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
25210
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
25211
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24514
25212
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
25213
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24515
25214
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25215
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24516
25216
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25217
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24517
25218
|
manual_override_allowed?: boolean | undefined;
|
|
24518
25219
|
} | undefined;
|
|
24519
25220
|
available_climate_presets?: Array<{
|
|
25221
|
+
/** Unique key to identify the climate preset. */
|
|
24520
25222
|
climate_preset_key: string;
|
|
25223
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24521
25224
|
can_edit: boolean;
|
|
25225
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24522
25226
|
can_delete: boolean;
|
|
25227
|
+
/** User-friendly name to identify the climate preset. */
|
|
24523
25228
|
name?: (string | null) | undefined;
|
|
25229
|
+
/** Display name for the climate preset. */
|
|
24524
25230
|
display_name: string;
|
|
25231
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24525
25232
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
25233
|
+
/** 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
25234
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
25235
|
+
/** 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
25236
|
cooling_set_point_celsius?: number | undefined;
|
|
25237
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24528
25238
|
heating_set_point_celsius?: number | undefined;
|
|
25239
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24529
25240
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
25241
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24530
25242
|
heating_set_point_fahrenheit?: number | undefined;
|
|
25243
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24531
25244
|
manual_override_allowed: boolean;
|
|
24532
25245
|
}> | undefined;
|
|
24533
25246
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
25247
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
24534
25248
|
active_thermostat_schedule?: ({
|
|
25249
|
+
/** ID of the thermostat schedule. */
|
|
24535
25250
|
thermostat_schedule_id: string;
|
|
25251
|
+
/** ID of the desired thermostat device. */
|
|
24536
25252
|
device_id: string;
|
|
25253
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
24537
25254
|
name?: string | undefined;
|
|
25255
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
24538
25256
|
climate_preset_key: string;
|
|
25257
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
24539
25258
|
max_override_period_minutes: number;
|
|
25259
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24540
25260
|
starts_at: string;
|
|
25261
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24541
25262
|
ends_at: string;
|
|
25263
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
24542
25264
|
created_at: string;
|
|
24543
|
-
/**
|
|
25265
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
24544
25266
|
errors?: any;
|
|
24545
25267
|
} | null) | undefined;
|
|
24546
25268
|
min_cooling_set_point_celsius?: number | undefined;
|
|
@@ -24952,60 +25674,105 @@ export interface Routes {
|
|
|
24952
25674
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
24953
25675
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
24954
25676
|
current_climate_setting?: {
|
|
25677
|
+
/** Unique key to identify the climate preset. */
|
|
24955
25678
|
climate_preset_key?: string | undefined;
|
|
25679
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24956
25680
|
can_edit?: boolean | undefined;
|
|
25681
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24957
25682
|
can_delete?: boolean | undefined;
|
|
25683
|
+
/** User-friendly name to identify the climate preset. */
|
|
24958
25684
|
name?: ((string | null) | undefined) | undefined;
|
|
25685
|
+
/** Display name for the climate preset. */
|
|
24959
25686
|
display_name?: string | undefined;
|
|
25687
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24960
25688
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
25689
|
+
/** 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
25690
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
25691
|
+
/** 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
25692
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
25693
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24963
25694
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
25695
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24964
25696
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25697
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24965
25698
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25699
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24966
25700
|
manual_override_allowed?: boolean | undefined;
|
|
24967
25701
|
} | undefined;
|
|
24968
25702
|
/**
|
|
24969
25703
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
24970
25704
|
default_climate_setting?: {
|
|
25705
|
+
/** Unique key to identify the climate preset. */
|
|
24971
25706
|
climate_preset_key?: string | undefined;
|
|
25707
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24972
25708
|
can_edit?: boolean | undefined;
|
|
25709
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24973
25710
|
can_delete?: boolean | undefined;
|
|
25711
|
+
/** User-friendly name to identify the climate preset. */
|
|
24974
25712
|
name?: ((string | null) | undefined) | undefined;
|
|
25713
|
+
/** Display name for the climate preset. */
|
|
24975
25714
|
display_name?: string | undefined;
|
|
25715
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24976
25716
|
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
25717
|
+
/** 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
25718
|
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
25719
|
+
/** 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
25720
|
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
25721
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24979
25722
|
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
25723
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24980
25724
|
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25725
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24981
25726
|
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
25727
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24982
25728
|
manual_override_allowed?: boolean | undefined;
|
|
24983
25729
|
} | undefined;
|
|
24984
25730
|
available_climate_presets?: Array<{
|
|
25731
|
+
/** Unique key to identify the climate preset. */
|
|
24985
25732
|
climate_preset_key: string;
|
|
25733
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24986
25734
|
can_edit: boolean;
|
|
25735
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24987
25736
|
can_delete: boolean;
|
|
25737
|
+
/** User-friendly name to identify the climate preset. */
|
|
24988
25738
|
name?: (string | null) | undefined;
|
|
25739
|
+
/** Display name for the climate preset. */
|
|
24989
25740
|
display_name: string;
|
|
25741
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24990
25742
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
25743
|
+
/** 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
25744
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
25745
|
+
/** 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
25746
|
cooling_set_point_celsius?: number | undefined;
|
|
25747
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24993
25748
|
heating_set_point_celsius?: number | undefined;
|
|
25749
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24994
25750
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
25751
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24995
25752
|
heating_set_point_fahrenheit?: number | undefined;
|
|
25753
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24996
25754
|
manual_override_allowed: boolean;
|
|
24997
25755
|
}> | undefined;
|
|
24998
25756
|
fallback_climate_preset_key?: (string | null) | undefined;
|
|
25757
|
+
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
24999
25758
|
active_thermostat_schedule?: ({
|
|
25759
|
+
/** ID of the thermostat schedule. */
|
|
25000
25760
|
thermostat_schedule_id: string;
|
|
25761
|
+
/** ID of the desired thermostat device. */
|
|
25001
25762
|
device_id: string;
|
|
25763
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
25002
25764
|
name?: string | undefined;
|
|
25765
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
25003
25766
|
climate_preset_key: string;
|
|
25767
|
+
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
25004
25768
|
max_override_period_minutes: number;
|
|
25769
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25005
25770
|
starts_at: string;
|
|
25771
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25006
25772
|
ends_at: string;
|
|
25773
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
25007
25774
|
created_at: string;
|
|
25008
|
-
/**
|
|
25775
|
+
/** Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
25009
25776
|
errors?: any;
|
|
25010
25777
|
} | null) | undefined;
|
|
25011
25778
|
min_cooling_set_point_celsius?: number | undefined;
|