@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
|
@@ -6771,25 +6771,37 @@ export interface Routes {
|
|
|
6771
6771
|
is_temporary_manual_override_active?: boolean | undefined
|
|
6772
6772
|
current_climate_setting?:
|
|
6773
6773
|
| {
|
|
6774
|
+
/** Unique key to identify the climate preset. */
|
|
6774
6775
|
climate_preset_key?: string | undefined
|
|
6776
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
6775
6777
|
can_edit?: boolean | undefined
|
|
6778
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
6776
6779
|
can_delete?: boolean | undefined
|
|
6780
|
+
/** User-friendly name to identify the climate preset. */
|
|
6777
6781
|
name?: ((string | null) | undefined) | undefined
|
|
6782
|
+
/** Display name for the climate preset. */
|
|
6778
6783
|
display_name?: string | undefined
|
|
6784
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
6779
6785
|
fan_mode_setting?:
|
|
6780
6786
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
6781
6787
|
| undefined
|
|
6788
|
+
/** 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`. */
|
|
6782
6789
|
hvac_mode_setting?:
|
|
6783
6790
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
6784
6791
|
| undefined
|
|
6792
|
+
/** 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). */
|
|
6785
6793
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
6794
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
6786
6795
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
6796
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
6787
6797
|
cooling_set_point_fahrenheit?:
|
|
6788
6798
|
| (number | undefined)
|
|
6789
6799
|
| undefined
|
|
6800
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
6790
6801
|
heating_set_point_fahrenheit?:
|
|
6791
6802
|
| (number | undefined)
|
|
6792
6803
|
| undefined
|
|
6804
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
6793
6805
|
manual_override_allowed?: boolean | undefined
|
|
6794
6806
|
}
|
|
6795
6807
|
| undefined
|
|
@@ -6797,58 +6809,91 @@ export interface Routes {
|
|
|
6797
6809
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
6798
6810
|
default_climate_setting?:
|
|
6799
6811
|
| {
|
|
6812
|
+
/** Unique key to identify the climate preset. */
|
|
6800
6813
|
climate_preset_key?: string | undefined
|
|
6814
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
6801
6815
|
can_edit?: boolean | undefined
|
|
6816
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
6802
6817
|
can_delete?: boolean | undefined
|
|
6818
|
+
/** User-friendly name to identify the climate preset. */
|
|
6803
6819
|
name?: ((string | null) | undefined) | undefined
|
|
6820
|
+
/** Display name for the climate preset. */
|
|
6804
6821
|
display_name?: string | undefined
|
|
6822
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
6805
6823
|
fan_mode_setting?:
|
|
6806
6824
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
6807
6825
|
| undefined
|
|
6826
|
+
/** 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`. */
|
|
6808
6827
|
hvac_mode_setting?:
|
|
6809
6828
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
6810
6829
|
| undefined
|
|
6830
|
+
/** 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). */
|
|
6811
6831
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
6832
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
6812
6833
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
6834
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
6813
6835
|
cooling_set_point_fahrenheit?:
|
|
6814
6836
|
| (number | undefined)
|
|
6815
6837
|
| undefined
|
|
6838
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
6816
6839
|
heating_set_point_fahrenheit?:
|
|
6817
6840
|
| (number | undefined)
|
|
6818
6841
|
| undefined
|
|
6842
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
6819
6843
|
manual_override_allowed?: boolean | undefined
|
|
6820
6844
|
}
|
|
6821
6845
|
| undefined
|
|
6822
6846
|
available_climate_presets?:
|
|
6823
6847
|
| Array<{
|
|
6848
|
+
/** Unique key to identify the climate preset. */
|
|
6824
6849
|
climate_preset_key: string
|
|
6850
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
6825
6851
|
can_edit: boolean
|
|
6852
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
6826
6853
|
can_delete: boolean
|
|
6854
|
+
/** User-friendly name to identify the climate preset. */
|
|
6827
6855
|
name?: (string | null) | undefined
|
|
6856
|
+
/** Display name for the climate preset. */
|
|
6828
6857
|
display_name: string
|
|
6858
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
6829
6859
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
6860
|
+
/** 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`. */
|
|
6830
6861
|
hvac_mode_setting?:
|
|
6831
6862
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
6832
6863
|
| undefined
|
|
6864
|
+
/** 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). */
|
|
6833
6865
|
cooling_set_point_celsius?: number | undefined
|
|
6866
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
6834
6867
|
heating_set_point_celsius?: number | undefined
|
|
6868
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
6835
6869
|
cooling_set_point_fahrenheit?: number | undefined
|
|
6870
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
6836
6871
|
heating_set_point_fahrenheit?: number | undefined
|
|
6872
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
6837
6873
|
manual_override_allowed: boolean
|
|
6838
6874
|
}>
|
|
6839
6875
|
| undefined
|
|
6840
6876
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
6877
|
+
/** 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. */
|
|
6841
6878
|
active_thermostat_schedule?:
|
|
6842
6879
|
| ({
|
|
6880
|
+
/** ID of the thermostat schedule. */
|
|
6843
6881
|
thermostat_schedule_id: string
|
|
6882
|
+
/** ID of the desired thermostat device. */
|
|
6844
6883
|
device_id: string
|
|
6884
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
6845
6885
|
name?: string | undefined
|
|
6886
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
6846
6887
|
climate_preset_key: string
|
|
6888
|
+
/** 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). */
|
|
6847
6889
|
max_override_period_minutes: number
|
|
6890
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
6848
6891
|
starts_at: string
|
|
6892
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
6849
6893
|
ends_at: string
|
|
6894
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
6850
6895
|
created_at: string
|
|
6851
|
-
/**
|
|
6896
|
+
/** 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. */
|
|
6852
6897
|
errors?: any
|
|
6853
6898
|
} | null)
|
|
6854
6899
|
| undefined
|
|
@@ -12029,25 +12074,37 @@ export interface Routes {
|
|
|
12029
12074
|
is_temporary_manual_override_active?: boolean | undefined
|
|
12030
12075
|
current_climate_setting?:
|
|
12031
12076
|
| {
|
|
12077
|
+
/** Unique key to identify the climate preset. */
|
|
12032
12078
|
climate_preset_key?: string | undefined
|
|
12079
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12033
12080
|
can_edit?: boolean | undefined
|
|
12081
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12034
12082
|
can_delete?: boolean | undefined
|
|
12083
|
+
/** User-friendly name to identify the climate preset. */
|
|
12035
12084
|
name?: ((string | null) | undefined) | undefined
|
|
12085
|
+
/** Display name for the climate preset. */
|
|
12036
12086
|
display_name?: string | undefined
|
|
12087
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12037
12088
|
fan_mode_setting?:
|
|
12038
12089
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
12039
12090
|
| undefined
|
|
12091
|
+
/** 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`. */
|
|
12040
12092
|
hvac_mode_setting?:
|
|
12041
12093
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
12042
12094
|
| undefined
|
|
12095
|
+
/** 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). */
|
|
12043
12096
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
12097
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12044
12098
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
12099
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12045
12100
|
cooling_set_point_fahrenheit?:
|
|
12046
12101
|
| (number | undefined)
|
|
12047
12102
|
| undefined
|
|
12103
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12048
12104
|
heating_set_point_fahrenheit?:
|
|
12049
12105
|
| (number | undefined)
|
|
12050
12106
|
| undefined
|
|
12107
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12051
12108
|
manual_override_allowed?: boolean | undefined
|
|
12052
12109
|
}
|
|
12053
12110
|
| undefined
|
|
@@ -12055,58 +12112,91 @@ export interface Routes {
|
|
|
12055
12112
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
12056
12113
|
default_climate_setting?:
|
|
12057
12114
|
| {
|
|
12115
|
+
/** Unique key to identify the climate preset. */
|
|
12058
12116
|
climate_preset_key?: string | undefined
|
|
12117
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12059
12118
|
can_edit?: boolean | undefined
|
|
12119
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12060
12120
|
can_delete?: boolean | undefined
|
|
12121
|
+
/** User-friendly name to identify the climate preset. */
|
|
12061
12122
|
name?: ((string | null) | undefined) | undefined
|
|
12123
|
+
/** Display name for the climate preset. */
|
|
12062
12124
|
display_name?: string | undefined
|
|
12125
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12063
12126
|
fan_mode_setting?:
|
|
12064
12127
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
12065
12128
|
| undefined
|
|
12129
|
+
/** 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`. */
|
|
12066
12130
|
hvac_mode_setting?:
|
|
12067
12131
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
12068
12132
|
| undefined
|
|
12133
|
+
/** 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). */
|
|
12069
12134
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
12135
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12070
12136
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
12137
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12071
12138
|
cooling_set_point_fahrenheit?:
|
|
12072
12139
|
| (number | undefined)
|
|
12073
12140
|
| undefined
|
|
12141
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12074
12142
|
heating_set_point_fahrenheit?:
|
|
12075
12143
|
| (number | undefined)
|
|
12076
12144
|
| undefined
|
|
12145
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12077
12146
|
manual_override_allowed?: boolean | undefined
|
|
12078
12147
|
}
|
|
12079
12148
|
| undefined
|
|
12080
12149
|
available_climate_presets?:
|
|
12081
12150
|
| Array<{
|
|
12151
|
+
/** Unique key to identify the climate preset. */
|
|
12082
12152
|
climate_preset_key: string
|
|
12153
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12083
12154
|
can_edit: boolean
|
|
12155
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12084
12156
|
can_delete: boolean
|
|
12157
|
+
/** User-friendly name to identify the climate preset. */
|
|
12085
12158
|
name?: (string | null) | undefined
|
|
12159
|
+
/** Display name for the climate preset. */
|
|
12086
12160
|
display_name: string
|
|
12161
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12087
12162
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
12163
|
+
/** 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`. */
|
|
12088
12164
|
hvac_mode_setting?:
|
|
12089
12165
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
12090
12166
|
| undefined
|
|
12167
|
+
/** 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). */
|
|
12091
12168
|
cooling_set_point_celsius?: number | undefined
|
|
12169
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12092
12170
|
heating_set_point_celsius?: number | undefined
|
|
12171
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12093
12172
|
cooling_set_point_fahrenheit?: number | undefined
|
|
12173
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12094
12174
|
heating_set_point_fahrenheit?: number | undefined
|
|
12175
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12095
12176
|
manual_override_allowed: boolean
|
|
12096
12177
|
}>
|
|
12097
12178
|
| undefined
|
|
12098
12179
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
12180
|
+
/** 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. */
|
|
12099
12181
|
active_thermostat_schedule?:
|
|
12100
12182
|
| ({
|
|
12183
|
+
/** ID of the thermostat schedule. */
|
|
12101
12184
|
thermostat_schedule_id: string
|
|
12185
|
+
/** ID of the desired thermostat device. */
|
|
12102
12186
|
device_id: string
|
|
12187
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
12103
12188
|
name?: string | undefined
|
|
12189
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
12104
12190
|
climate_preset_key: string
|
|
12191
|
+
/** 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). */
|
|
12105
12192
|
max_override_period_minutes: number
|
|
12193
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12106
12194
|
starts_at: string
|
|
12195
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12107
12196
|
ends_at: string
|
|
12197
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
12108
12198
|
created_at: string
|
|
12109
|
-
/**
|
|
12199
|
+
/** 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. */
|
|
12110
12200
|
errors?: any
|
|
12111
12201
|
} | null)
|
|
12112
12202
|
| undefined
|
|
@@ -12186,10 +12276,13 @@ export interface Routes {
|
|
|
12186
12276
|
queryParams: {}
|
|
12187
12277
|
jsonBody: {}
|
|
12188
12278
|
commonParams: {
|
|
12189
|
-
/**
|
|
12279
|
+
/** ID of the connected account by which to filter. */
|
|
12190
12280
|
connected_account_id?: string | undefined
|
|
12281
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
12191
12282
|
connected_account_ids?: string[] | undefined
|
|
12283
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
12192
12284
|
connect_webview_id?: string | undefined
|
|
12285
|
+
/** Device type by which to filter devices. */
|
|
12193
12286
|
device_type?:
|
|
12194
12287
|
| (
|
|
12195
12288
|
| (
|
|
@@ -12231,6 +12324,7 @@ export interface Routes {
|
|
|
12231
12324
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
12232
12325
|
)
|
|
12233
12326
|
| undefined
|
|
12327
|
+
/** Array of device types by which to filter devices. */
|
|
12234
12328
|
device_types?:
|
|
12235
12329
|
| Array<
|
|
12236
12330
|
| (
|
|
@@ -12272,6 +12366,7 @@ export interface Routes {
|
|
|
12272
12366
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
12273
12367
|
>
|
|
12274
12368
|
| undefined
|
|
12369
|
+
/** Manufacturer by which to filter devices. */
|
|
12275
12370
|
manufacturer?:
|
|
12276
12371
|
| (
|
|
12277
12372
|
| 'akuvox'
|
|
@@ -12311,11 +12406,17 @@ export interface Routes {
|
|
|
12311
12406
|
| 'akiles'
|
|
12312
12407
|
)
|
|
12313
12408
|
| undefined
|
|
12409
|
+
/** Array of device IDs by which to filter devices. */
|
|
12314
12410
|
device_ids?: string[] | undefined
|
|
12411
|
+
/** Numerical limit on the number of devices to return. */
|
|
12315
12412
|
limit?: number
|
|
12413
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
12316
12414
|
created_before?: Date | undefined
|
|
12415
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
12317
12416
|
user_identifier_key?: string | undefined
|
|
12417
|
+
/** 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. */
|
|
12318
12418
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
12419
|
+
/** */
|
|
12319
12420
|
include_if?:
|
|
12320
12421
|
| Array<
|
|
12321
12422
|
| 'can_remotely_unlock'
|
|
@@ -12331,6 +12432,7 @@ export interface Routes {
|
|
|
12331
12432
|
| 'can_simulate_disconnection'
|
|
12332
12433
|
>
|
|
12333
12434
|
| undefined
|
|
12435
|
+
/** */
|
|
12334
12436
|
exclude_if?:
|
|
12335
12437
|
| Array<
|
|
12336
12438
|
| 'can_remotely_unlock'
|
|
@@ -12846,25 +12948,37 @@ export interface Routes {
|
|
|
12846
12948
|
is_temporary_manual_override_active?: boolean | undefined
|
|
12847
12949
|
current_climate_setting?:
|
|
12848
12950
|
| {
|
|
12951
|
+
/** Unique key to identify the climate preset. */
|
|
12849
12952
|
climate_preset_key?: string | undefined
|
|
12953
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12850
12954
|
can_edit?: boolean | undefined
|
|
12955
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12851
12956
|
can_delete?: boolean | undefined
|
|
12957
|
+
/** User-friendly name to identify the climate preset. */
|
|
12852
12958
|
name?: ((string | null) | undefined) | undefined
|
|
12959
|
+
/** Display name for the climate preset. */
|
|
12853
12960
|
display_name?: string | undefined
|
|
12961
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12854
12962
|
fan_mode_setting?:
|
|
12855
12963
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
12856
12964
|
| undefined
|
|
12965
|
+
/** 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`. */
|
|
12857
12966
|
hvac_mode_setting?:
|
|
12858
12967
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
12859
12968
|
| undefined
|
|
12969
|
+
/** 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). */
|
|
12860
12970
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
12971
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12861
12972
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
12973
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12862
12974
|
cooling_set_point_fahrenheit?:
|
|
12863
12975
|
| (number | undefined)
|
|
12864
12976
|
| undefined
|
|
12977
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12865
12978
|
heating_set_point_fahrenheit?:
|
|
12866
12979
|
| (number | undefined)
|
|
12867
12980
|
| undefined
|
|
12981
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12868
12982
|
manual_override_allowed?: boolean | undefined
|
|
12869
12983
|
}
|
|
12870
12984
|
| undefined
|
|
@@ -12872,58 +12986,91 @@ export interface Routes {
|
|
|
12872
12986
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
12873
12987
|
default_climate_setting?:
|
|
12874
12988
|
| {
|
|
12989
|
+
/** Unique key to identify the climate preset. */
|
|
12875
12990
|
climate_preset_key?: string | undefined
|
|
12991
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12876
12992
|
can_edit?: boolean | undefined
|
|
12993
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12877
12994
|
can_delete?: boolean | undefined
|
|
12995
|
+
/** User-friendly name to identify the climate preset. */
|
|
12878
12996
|
name?: ((string | null) | undefined) | undefined
|
|
12997
|
+
/** Display name for the climate preset. */
|
|
12879
12998
|
display_name?: string | undefined
|
|
12999
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12880
13000
|
fan_mode_setting?:
|
|
12881
13001
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
12882
13002
|
| undefined
|
|
13003
|
+
/** 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`. */
|
|
12883
13004
|
hvac_mode_setting?:
|
|
12884
13005
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
12885
13006
|
| undefined
|
|
13007
|
+
/** 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). */
|
|
12886
13008
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
13009
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12887
13010
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
13011
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12888
13012
|
cooling_set_point_fahrenheit?:
|
|
12889
13013
|
| (number | undefined)
|
|
12890
13014
|
| undefined
|
|
13015
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12891
13016
|
heating_set_point_fahrenheit?:
|
|
12892
13017
|
| (number | undefined)
|
|
12893
13018
|
| undefined
|
|
13019
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12894
13020
|
manual_override_allowed?: boolean | undefined
|
|
12895
13021
|
}
|
|
12896
13022
|
| undefined
|
|
12897
13023
|
available_climate_presets?:
|
|
12898
13024
|
| Array<{
|
|
13025
|
+
/** Unique key to identify the climate preset. */
|
|
12899
13026
|
climate_preset_key: string
|
|
13027
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
12900
13028
|
can_edit: boolean
|
|
13029
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
12901
13030
|
can_delete: boolean
|
|
13031
|
+
/** User-friendly name to identify the climate preset. */
|
|
12902
13032
|
name?: (string | null) | undefined
|
|
13033
|
+
/** Display name for the climate preset. */
|
|
12903
13034
|
display_name: string
|
|
13035
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
12904
13036
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
13037
|
+
/** 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`. */
|
|
12905
13038
|
hvac_mode_setting?:
|
|
12906
13039
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
12907
13040
|
| undefined
|
|
13041
|
+
/** 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). */
|
|
12908
13042
|
cooling_set_point_celsius?: number | undefined
|
|
13043
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
12909
13044
|
heating_set_point_celsius?: number | undefined
|
|
13045
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
12910
13046
|
cooling_set_point_fahrenheit?: number | undefined
|
|
13047
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
12911
13048
|
heating_set_point_fahrenheit?: number | undefined
|
|
13049
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
12912
13050
|
manual_override_allowed: boolean
|
|
12913
13051
|
}>
|
|
12914
13052
|
| undefined
|
|
12915
13053
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
13054
|
+
/** 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. */
|
|
12916
13055
|
active_thermostat_schedule?:
|
|
12917
13056
|
| ({
|
|
13057
|
+
/** ID of the thermostat schedule. */
|
|
12918
13058
|
thermostat_schedule_id: string
|
|
13059
|
+
/** ID of the desired thermostat device. */
|
|
12919
13060
|
device_id: string
|
|
13061
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
12920
13062
|
name?: string | undefined
|
|
13063
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
12921
13064
|
climate_preset_key: string
|
|
13065
|
+
/** 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). */
|
|
12922
13066
|
max_override_period_minutes: number
|
|
13067
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12923
13068
|
starts_at: string
|
|
13069
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
12924
13070
|
ends_at: string
|
|
13071
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
12925
13072
|
created_at: string
|
|
12926
|
-
/**
|
|
13073
|
+
/** 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. */
|
|
12927
13074
|
errors?: any
|
|
12928
13075
|
} | null)
|
|
12929
13076
|
| undefined
|
|
@@ -13285,10 +13432,13 @@ export interface Routes {
|
|
|
13285
13432
|
queryParams: {}
|
|
13286
13433
|
jsonBody: {}
|
|
13287
13434
|
commonParams: {
|
|
13288
|
-
/**
|
|
13435
|
+
/** ID of the connected account by which to filter. */
|
|
13289
13436
|
connected_account_id?: string | undefined
|
|
13437
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
13290
13438
|
connected_account_ids?: string[] | undefined
|
|
13439
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
13291
13440
|
connect_webview_id?: string | undefined
|
|
13441
|
+
/** Device type by which to filter devices. */
|
|
13292
13442
|
device_type?:
|
|
13293
13443
|
| (
|
|
13294
13444
|
| (
|
|
@@ -13330,6 +13480,7 @@ export interface Routes {
|
|
|
13330
13480
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
13331
13481
|
)
|
|
13332
13482
|
| undefined
|
|
13483
|
+
/** Array of device types by which to filter devices. */
|
|
13333
13484
|
device_types?:
|
|
13334
13485
|
| Array<
|
|
13335
13486
|
| (
|
|
@@ -13371,6 +13522,7 @@ export interface Routes {
|
|
|
13371
13522
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
13372
13523
|
>
|
|
13373
13524
|
| undefined
|
|
13525
|
+
/** Manufacturer by which to filter devices. */
|
|
13374
13526
|
manufacturer?:
|
|
13375
13527
|
| (
|
|
13376
13528
|
| 'akuvox'
|
|
@@ -13410,11 +13562,17 @@ export interface Routes {
|
|
|
13410
13562
|
| 'akiles'
|
|
13411
13563
|
)
|
|
13412
13564
|
| undefined
|
|
13565
|
+
/** Array of device IDs by which to filter devices. */
|
|
13413
13566
|
device_ids?: string[] | undefined
|
|
13567
|
+
/** Numerical limit on the number of devices to return. */
|
|
13414
13568
|
limit?: number
|
|
13569
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
13415
13570
|
created_before?: Date | undefined
|
|
13571
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
13416
13572
|
user_identifier_key?: string | undefined
|
|
13573
|
+
/** 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. */
|
|
13417
13574
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
13575
|
+
/** */
|
|
13418
13576
|
include_if?:
|
|
13419
13577
|
| Array<
|
|
13420
13578
|
| 'can_remotely_unlock'
|
|
@@ -13430,6 +13588,7 @@ export interface Routes {
|
|
|
13430
13588
|
| 'can_simulate_disconnection'
|
|
13431
13589
|
>
|
|
13432
13590
|
| undefined
|
|
13591
|
+
/** */
|
|
13433
13592
|
exclude_if?:
|
|
13434
13593
|
| Array<
|
|
13435
13594
|
| 'can_remotely_unlock'
|
|
@@ -14378,25 +14537,37 @@ export interface Routes {
|
|
|
14378
14537
|
is_temporary_manual_override_active?: boolean | undefined
|
|
14379
14538
|
current_climate_setting?:
|
|
14380
14539
|
| {
|
|
14540
|
+
/** Unique key to identify the climate preset. */
|
|
14381
14541
|
climate_preset_key?: string | undefined
|
|
14542
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14382
14543
|
can_edit?: boolean | undefined
|
|
14544
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14383
14545
|
can_delete?: boolean | undefined
|
|
14546
|
+
/** User-friendly name to identify the climate preset. */
|
|
14384
14547
|
name?: ((string | null) | undefined) | undefined
|
|
14548
|
+
/** Display name for the climate preset. */
|
|
14385
14549
|
display_name?: string | undefined
|
|
14550
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14386
14551
|
fan_mode_setting?:
|
|
14387
14552
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
14388
14553
|
| undefined
|
|
14554
|
+
/** 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`. */
|
|
14389
14555
|
hvac_mode_setting?:
|
|
14390
14556
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
14391
14557
|
| undefined
|
|
14558
|
+
/** 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). */
|
|
14392
14559
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
14560
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14393
14561
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
14562
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14394
14563
|
cooling_set_point_fahrenheit?:
|
|
14395
14564
|
| (number | undefined)
|
|
14396
14565
|
| undefined
|
|
14566
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14397
14567
|
heating_set_point_fahrenheit?:
|
|
14398
14568
|
| (number | undefined)
|
|
14399
14569
|
| undefined
|
|
14570
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14400
14571
|
manual_override_allowed?: boolean | undefined
|
|
14401
14572
|
}
|
|
14402
14573
|
| undefined
|
|
@@ -14404,58 +14575,91 @@ export interface Routes {
|
|
|
14404
14575
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
14405
14576
|
default_climate_setting?:
|
|
14406
14577
|
| {
|
|
14578
|
+
/** Unique key to identify the climate preset. */
|
|
14407
14579
|
climate_preset_key?: string | undefined
|
|
14580
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14408
14581
|
can_edit?: boolean | undefined
|
|
14582
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14409
14583
|
can_delete?: boolean | undefined
|
|
14584
|
+
/** User-friendly name to identify the climate preset. */
|
|
14410
14585
|
name?: ((string | null) | undefined) | undefined
|
|
14586
|
+
/** Display name for the climate preset. */
|
|
14411
14587
|
display_name?: string | undefined
|
|
14588
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14412
14589
|
fan_mode_setting?:
|
|
14413
14590
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
14414
14591
|
| undefined
|
|
14592
|
+
/** 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`. */
|
|
14415
14593
|
hvac_mode_setting?:
|
|
14416
14594
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
14417
14595
|
| undefined
|
|
14596
|
+
/** 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). */
|
|
14418
14597
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
14598
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14419
14599
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
14600
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14420
14601
|
cooling_set_point_fahrenheit?:
|
|
14421
14602
|
| (number | undefined)
|
|
14422
14603
|
| undefined
|
|
14604
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14423
14605
|
heating_set_point_fahrenheit?:
|
|
14424
14606
|
| (number | undefined)
|
|
14425
14607
|
| undefined
|
|
14608
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14426
14609
|
manual_override_allowed?: boolean | undefined
|
|
14427
14610
|
}
|
|
14428
14611
|
| undefined
|
|
14429
14612
|
available_climate_presets?:
|
|
14430
14613
|
| Array<{
|
|
14614
|
+
/** Unique key to identify the climate preset. */
|
|
14431
14615
|
climate_preset_key: string
|
|
14616
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
14432
14617
|
can_edit: boolean
|
|
14618
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
14433
14619
|
can_delete: boolean
|
|
14620
|
+
/** User-friendly name to identify the climate preset. */
|
|
14434
14621
|
name?: (string | null) | undefined
|
|
14622
|
+
/** Display name for the climate preset. */
|
|
14435
14623
|
display_name: string
|
|
14624
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
14436
14625
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
14626
|
+
/** 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`. */
|
|
14437
14627
|
hvac_mode_setting?:
|
|
14438
14628
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
14439
14629
|
| undefined
|
|
14630
|
+
/** 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). */
|
|
14440
14631
|
cooling_set_point_celsius?: number | undefined
|
|
14632
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
14441
14633
|
heating_set_point_celsius?: number | undefined
|
|
14634
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
14442
14635
|
cooling_set_point_fahrenheit?: number | undefined
|
|
14636
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
14443
14637
|
heating_set_point_fahrenheit?: number | undefined
|
|
14638
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
14444
14639
|
manual_override_allowed: boolean
|
|
14445
14640
|
}>
|
|
14446
14641
|
| undefined
|
|
14447
14642
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
14643
|
+
/** 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. */
|
|
14448
14644
|
active_thermostat_schedule?:
|
|
14449
14645
|
| ({
|
|
14646
|
+
/** ID of the thermostat schedule. */
|
|
14450
14647
|
thermostat_schedule_id: string
|
|
14648
|
+
/** ID of the desired thermostat device. */
|
|
14451
14649
|
device_id: string
|
|
14650
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
14452
14651
|
name?: string | undefined
|
|
14652
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
14453
14653
|
climate_preset_key: string
|
|
14654
|
+
/** 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). */
|
|
14454
14655
|
max_override_period_minutes: number
|
|
14656
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
14455
14657
|
starts_at: string
|
|
14658
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
14456
14659
|
ends_at: string
|
|
14660
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
14457
14661
|
created_at: string
|
|
14458
|
-
/**
|
|
14662
|
+
/** 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. */
|
|
14459
14663
|
errors?: any
|
|
14460
14664
|
} | null)
|
|
14461
14665
|
| undefined
|
|
@@ -15024,25 +15228,37 @@ export interface Routes {
|
|
|
15024
15228
|
is_temporary_manual_override_active?: boolean | undefined
|
|
15025
15229
|
current_climate_setting?:
|
|
15026
15230
|
| {
|
|
15231
|
+
/** Unique key to identify the climate preset. */
|
|
15027
15232
|
climate_preset_key?: string | undefined
|
|
15233
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15028
15234
|
can_edit?: boolean | undefined
|
|
15235
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15029
15236
|
can_delete?: boolean | undefined
|
|
15237
|
+
/** User-friendly name to identify the climate preset. */
|
|
15030
15238
|
name?: ((string | null) | undefined) | undefined
|
|
15239
|
+
/** Display name for the climate preset. */
|
|
15031
15240
|
display_name?: string | undefined
|
|
15241
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15032
15242
|
fan_mode_setting?:
|
|
15033
15243
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
15034
15244
|
| undefined
|
|
15245
|
+
/** 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`. */
|
|
15035
15246
|
hvac_mode_setting?:
|
|
15036
15247
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
15037
15248
|
| undefined
|
|
15249
|
+
/** 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). */
|
|
15038
15250
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
15251
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15039
15252
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
15253
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15040
15254
|
cooling_set_point_fahrenheit?:
|
|
15041
15255
|
| (number | undefined)
|
|
15042
15256
|
| undefined
|
|
15257
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15043
15258
|
heating_set_point_fahrenheit?:
|
|
15044
15259
|
| (number | undefined)
|
|
15045
15260
|
| undefined
|
|
15261
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15046
15262
|
manual_override_allowed?: boolean | undefined
|
|
15047
15263
|
}
|
|
15048
15264
|
| undefined
|
|
@@ -15050,58 +15266,91 @@ export interface Routes {
|
|
|
15050
15266
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
15051
15267
|
default_climate_setting?:
|
|
15052
15268
|
| {
|
|
15269
|
+
/** Unique key to identify the climate preset. */
|
|
15053
15270
|
climate_preset_key?: string | undefined
|
|
15271
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15054
15272
|
can_edit?: boolean | undefined
|
|
15273
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15055
15274
|
can_delete?: boolean | undefined
|
|
15275
|
+
/** User-friendly name to identify the climate preset. */
|
|
15056
15276
|
name?: ((string | null) | undefined) | undefined
|
|
15277
|
+
/** Display name for the climate preset. */
|
|
15057
15278
|
display_name?: string | undefined
|
|
15279
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15058
15280
|
fan_mode_setting?:
|
|
15059
15281
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
15060
15282
|
| undefined
|
|
15283
|
+
/** 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`. */
|
|
15061
15284
|
hvac_mode_setting?:
|
|
15062
15285
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
15063
15286
|
| undefined
|
|
15287
|
+
/** 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). */
|
|
15064
15288
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
15289
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15065
15290
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
15291
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15066
15292
|
cooling_set_point_fahrenheit?:
|
|
15067
15293
|
| (number | undefined)
|
|
15068
15294
|
| undefined
|
|
15295
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15069
15296
|
heating_set_point_fahrenheit?:
|
|
15070
15297
|
| (number | undefined)
|
|
15071
15298
|
| undefined
|
|
15299
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15072
15300
|
manual_override_allowed?: boolean | undefined
|
|
15073
15301
|
}
|
|
15074
15302
|
| undefined
|
|
15075
15303
|
available_climate_presets?:
|
|
15076
15304
|
| Array<{
|
|
15305
|
+
/** Unique key to identify the climate preset. */
|
|
15077
15306
|
climate_preset_key: string
|
|
15307
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15078
15308
|
can_edit: boolean
|
|
15309
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15079
15310
|
can_delete: boolean
|
|
15311
|
+
/** User-friendly name to identify the climate preset. */
|
|
15080
15312
|
name?: (string | null) | undefined
|
|
15313
|
+
/** Display name for the climate preset. */
|
|
15081
15314
|
display_name: string
|
|
15315
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15082
15316
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
15317
|
+
/** 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`. */
|
|
15083
15318
|
hvac_mode_setting?:
|
|
15084
15319
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
15085
15320
|
| undefined
|
|
15321
|
+
/** 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). */
|
|
15086
15322
|
cooling_set_point_celsius?: number | undefined
|
|
15323
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15087
15324
|
heating_set_point_celsius?: number | undefined
|
|
15325
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15088
15326
|
cooling_set_point_fahrenheit?: number | undefined
|
|
15327
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15089
15328
|
heating_set_point_fahrenheit?: number | undefined
|
|
15329
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15090
15330
|
manual_override_allowed: boolean
|
|
15091
15331
|
}>
|
|
15092
15332
|
| undefined
|
|
15093
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. */
|
|
15094
15335
|
active_thermostat_schedule?:
|
|
15095
15336
|
| ({
|
|
15337
|
+
/** ID of the thermostat schedule. */
|
|
15096
15338
|
thermostat_schedule_id: string
|
|
15339
|
+
/** ID of the desired thermostat device. */
|
|
15097
15340
|
device_id: string
|
|
15341
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
15098
15342
|
name?: string | undefined
|
|
15343
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
15099
15344
|
climate_preset_key: string
|
|
15345
|
+
/** 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). */
|
|
15100
15346
|
max_override_period_minutes: number
|
|
15347
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15101
15348
|
starts_at: string
|
|
15349
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15102
15350
|
ends_at: string
|
|
15351
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
15103
15352
|
created_at: string
|
|
15104
|
-
/**
|
|
15353
|
+
/** 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. */
|
|
15105
15354
|
errors?: any
|
|
15106
15355
|
} | null)
|
|
15107
15356
|
| undefined
|
|
@@ -15181,10 +15430,13 @@ export interface Routes {
|
|
|
15181
15430
|
queryParams: {}
|
|
15182
15431
|
jsonBody: {}
|
|
15183
15432
|
commonParams: {
|
|
15184
|
-
/**
|
|
15433
|
+
/** ID of the connected account by which to filter. */
|
|
15185
15434
|
connected_account_id?: string | undefined
|
|
15435
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
15186
15436
|
connected_account_ids?: string[] | undefined
|
|
15437
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
15187
15438
|
connect_webview_id?: string | undefined
|
|
15439
|
+
/** Device type by which to filter devices. */
|
|
15188
15440
|
device_type?:
|
|
15189
15441
|
| (
|
|
15190
15442
|
| (
|
|
@@ -15226,6 +15478,7 @@ export interface Routes {
|
|
|
15226
15478
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
15227
15479
|
)
|
|
15228
15480
|
| undefined
|
|
15481
|
+
/** Array of device types by which to filter devices. */
|
|
15229
15482
|
device_types?:
|
|
15230
15483
|
| Array<
|
|
15231
15484
|
| (
|
|
@@ -15267,6 +15520,7 @@ export interface Routes {
|
|
|
15267
15520
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
15268
15521
|
>
|
|
15269
15522
|
| undefined
|
|
15523
|
+
/** Manufacturer by which to filter devices. */
|
|
15270
15524
|
manufacturer?:
|
|
15271
15525
|
| (
|
|
15272
15526
|
| 'akuvox'
|
|
@@ -15306,11 +15560,17 @@ export interface Routes {
|
|
|
15306
15560
|
| 'akiles'
|
|
15307
15561
|
)
|
|
15308
15562
|
| undefined
|
|
15563
|
+
/** Array of device IDs by which to filter devices. */
|
|
15309
15564
|
device_ids?: string[] | undefined
|
|
15565
|
+
/** Numerical limit on the number of devices to return. */
|
|
15310
15566
|
limit?: number
|
|
15567
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
15311
15568
|
created_before?: Date | undefined
|
|
15569
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
15312
15570
|
user_identifier_key?: string | undefined
|
|
15571
|
+
/** 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. */
|
|
15313
15572
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
15573
|
+
/** */
|
|
15314
15574
|
include_if?:
|
|
15315
15575
|
| Array<
|
|
15316
15576
|
| 'can_remotely_unlock'
|
|
@@ -15326,6 +15586,7 @@ export interface Routes {
|
|
|
15326
15586
|
| 'can_simulate_disconnection'
|
|
15327
15587
|
>
|
|
15328
15588
|
| undefined
|
|
15589
|
+
/** */
|
|
15329
15590
|
exclude_if?:
|
|
15330
15591
|
| Array<
|
|
15331
15592
|
| 'can_remotely_unlock'
|
|
@@ -15841,25 +16102,37 @@ export interface Routes {
|
|
|
15841
16102
|
is_temporary_manual_override_active?: boolean | undefined
|
|
15842
16103
|
current_climate_setting?:
|
|
15843
16104
|
| {
|
|
16105
|
+
/** Unique key to identify the climate preset. */
|
|
15844
16106
|
climate_preset_key?: string | undefined
|
|
16107
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15845
16108
|
can_edit?: boolean | undefined
|
|
16109
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15846
16110
|
can_delete?: boolean | undefined
|
|
16111
|
+
/** User-friendly name to identify the climate preset. */
|
|
15847
16112
|
name?: ((string | null) | undefined) | undefined
|
|
16113
|
+
/** Display name for the climate preset. */
|
|
15848
16114
|
display_name?: string | undefined
|
|
16115
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15849
16116
|
fan_mode_setting?:
|
|
15850
16117
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
15851
16118
|
| undefined
|
|
16119
|
+
/** 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`. */
|
|
15852
16120
|
hvac_mode_setting?:
|
|
15853
16121
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
15854
16122
|
| undefined
|
|
16123
|
+
/** 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). */
|
|
15855
16124
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
16125
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15856
16126
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
16127
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15857
16128
|
cooling_set_point_fahrenheit?:
|
|
15858
16129
|
| (number | undefined)
|
|
15859
16130
|
| undefined
|
|
16131
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15860
16132
|
heating_set_point_fahrenheit?:
|
|
15861
16133
|
| (number | undefined)
|
|
15862
16134
|
| undefined
|
|
16135
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15863
16136
|
manual_override_allowed?: boolean | undefined
|
|
15864
16137
|
}
|
|
15865
16138
|
| undefined
|
|
@@ -15867,58 +16140,91 @@ export interface Routes {
|
|
|
15867
16140
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
15868
16141
|
default_climate_setting?:
|
|
15869
16142
|
| {
|
|
16143
|
+
/** Unique key to identify the climate preset. */
|
|
15870
16144
|
climate_preset_key?: string | undefined
|
|
16145
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15871
16146
|
can_edit?: boolean | undefined
|
|
16147
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15872
16148
|
can_delete?: boolean | undefined
|
|
16149
|
+
/** User-friendly name to identify the climate preset. */
|
|
15873
16150
|
name?: ((string | null) | undefined) | undefined
|
|
16151
|
+
/** Display name for the climate preset. */
|
|
15874
16152
|
display_name?: string | undefined
|
|
16153
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15875
16154
|
fan_mode_setting?:
|
|
15876
16155
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
15877
16156
|
| undefined
|
|
16157
|
+
/** 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`. */
|
|
15878
16158
|
hvac_mode_setting?:
|
|
15879
16159
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
15880
16160
|
| undefined
|
|
16161
|
+
/** 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). */
|
|
15881
16162
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
16163
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15882
16164
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
16165
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15883
16166
|
cooling_set_point_fahrenheit?:
|
|
15884
16167
|
| (number | undefined)
|
|
15885
16168
|
| undefined
|
|
16169
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15886
16170
|
heating_set_point_fahrenheit?:
|
|
15887
16171
|
| (number | undefined)
|
|
15888
16172
|
| undefined
|
|
16173
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15889
16174
|
manual_override_allowed?: boolean | undefined
|
|
15890
16175
|
}
|
|
15891
16176
|
| undefined
|
|
15892
16177
|
available_climate_presets?:
|
|
15893
16178
|
| Array<{
|
|
16179
|
+
/** Unique key to identify the climate preset. */
|
|
15894
16180
|
climate_preset_key: string
|
|
16181
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
15895
16182
|
can_edit: boolean
|
|
16183
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
15896
16184
|
can_delete: boolean
|
|
16185
|
+
/** User-friendly name to identify the climate preset. */
|
|
15897
16186
|
name?: (string | null) | undefined
|
|
16187
|
+
/** Display name for the climate preset. */
|
|
15898
16188
|
display_name: string
|
|
16189
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
15899
16190
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
16191
|
+
/** 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`. */
|
|
15900
16192
|
hvac_mode_setting?:
|
|
15901
16193
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
15902
16194
|
| undefined
|
|
16195
|
+
/** 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). */
|
|
15903
16196
|
cooling_set_point_celsius?: number | undefined
|
|
16197
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
15904
16198
|
heating_set_point_celsius?: number | undefined
|
|
16199
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
15905
16200
|
cooling_set_point_fahrenheit?: number | undefined
|
|
16201
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
15906
16202
|
heating_set_point_fahrenheit?: number | undefined
|
|
16203
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
15907
16204
|
manual_override_allowed: boolean
|
|
15908
16205
|
}>
|
|
15909
16206
|
| undefined
|
|
15910
16207
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
16208
|
+
/** 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. */
|
|
15911
16209
|
active_thermostat_schedule?:
|
|
15912
16210
|
| ({
|
|
16211
|
+
/** ID of the thermostat schedule. */
|
|
15913
16212
|
thermostat_schedule_id: string
|
|
16213
|
+
/** ID of the desired thermostat device. */
|
|
15914
16214
|
device_id: string
|
|
16215
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
15915
16216
|
name?: string | undefined
|
|
16217
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
15916
16218
|
climate_preset_key: string
|
|
16219
|
+
/** 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). */
|
|
15917
16220
|
max_override_period_minutes: number
|
|
16221
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15918
16222
|
starts_at: string
|
|
16223
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
15919
16224
|
ends_at: string
|
|
16225
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
15920
16226
|
created_at: string
|
|
15921
|
-
/**
|
|
16227
|
+
/** 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. */
|
|
15922
16228
|
errors?: any
|
|
15923
16229
|
} | null)
|
|
15924
16230
|
| undefined
|
|
@@ -16487,25 +16793,37 @@ export interface Routes {
|
|
|
16487
16793
|
is_temporary_manual_override_active?: boolean | undefined
|
|
16488
16794
|
current_climate_setting?:
|
|
16489
16795
|
| {
|
|
16796
|
+
/** Unique key to identify the climate preset. */
|
|
16490
16797
|
climate_preset_key?: string | undefined
|
|
16798
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
16491
16799
|
can_edit?: boolean | undefined
|
|
16800
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
16492
16801
|
can_delete?: boolean | undefined
|
|
16802
|
+
/** User-friendly name to identify the climate preset. */
|
|
16493
16803
|
name?: ((string | null) | undefined) | undefined
|
|
16804
|
+
/** Display name for the climate preset. */
|
|
16494
16805
|
display_name?: string | undefined
|
|
16806
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
16495
16807
|
fan_mode_setting?:
|
|
16496
16808
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
16497
16809
|
| undefined
|
|
16810
|
+
/** 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`. */
|
|
16498
16811
|
hvac_mode_setting?:
|
|
16499
16812
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
16500
16813
|
| undefined
|
|
16814
|
+
/** 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). */
|
|
16501
16815
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
16816
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
16502
16817
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
16818
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
16503
16819
|
cooling_set_point_fahrenheit?:
|
|
16504
16820
|
| (number | undefined)
|
|
16505
16821
|
| undefined
|
|
16822
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
16506
16823
|
heating_set_point_fahrenheit?:
|
|
16507
16824
|
| (number | undefined)
|
|
16508
16825
|
| undefined
|
|
16826
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
16509
16827
|
manual_override_allowed?: boolean | undefined
|
|
16510
16828
|
}
|
|
16511
16829
|
| undefined
|
|
@@ -16513,58 +16831,91 @@ export interface Routes {
|
|
|
16513
16831
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
16514
16832
|
default_climate_setting?:
|
|
16515
16833
|
| {
|
|
16834
|
+
/** Unique key to identify the climate preset. */
|
|
16516
16835
|
climate_preset_key?: string | undefined
|
|
16836
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
16517
16837
|
can_edit?: boolean | undefined
|
|
16838
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
16518
16839
|
can_delete?: boolean | undefined
|
|
16840
|
+
/** User-friendly name to identify the climate preset. */
|
|
16519
16841
|
name?: ((string | null) | undefined) | undefined
|
|
16842
|
+
/** Display name for the climate preset. */
|
|
16520
16843
|
display_name?: string | undefined
|
|
16844
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
16521
16845
|
fan_mode_setting?:
|
|
16522
16846
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
16523
16847
|
| undefined
|
|
16848
|
+
/** 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`. */
|
|
16524
16849
|
hvac_mode_setting?:
|
|
16525
16850
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
16526
16851
|
| undefined
|
|
16852
|
+
/** 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). */
|
|
16527
16853
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
16854
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
16528
16855
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
16856
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
16529
16857
|
cooling_set_point_fahrenheit?:
|
|
16530
16858
|
| (number | undefined)
|
|
16531
16859
|
| undefined
|
|
16860
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
16532
16861
|
heating_set_point_fahrenheit?:
|
|
16533
16862
|
| (number | undefined)
|
|
16534
16863
|
| undefined
|
|
16864
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
16535
16865
|
manual_override_allowed?: boolean | undefined
|
|
16536
16866
|
}
|
|
16537
16867
|
| undefined
|
|
16538
16868
|
available_climate_presets?:
|
|
16539
16869
|
| Array<{
|
|
16870
|
+
/** Unique key to identify the climate preset. */
|
|
16540
16871
|
climate_preset_key: string
|
|
16872
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
16541
16873
|
can_edit: boolean
|
|
16874
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
16542
16875
|
can_delete: boolean
|
|
16876
|
+
/** User-friendly name to identify the climate preset. */
|
|
16543
16877
|
name?: (string | null) | undefined
|
|
16878
|
+
/** Display name for the climate preset. */
|
|
16544
16879
|
display_name: string
|
|
16880
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
16545
16881
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
16882
|
+
/** 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`. */
|
|
16546
16883
|
hvac_mode_setting?:
|
|
16547
16884
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
16548
16885
|
| undefined
|
|
16886
|
+
/** 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). */
|
|
16549
16887
|
cooling_set_point_celsius?: number | undefined
|
|
16888
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
16550
16889
|
heating_set_point_celsius?: number | undefined
|
|
16890
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
16551
16891
|
cooling_set_point_fahrenheit?: number | undefined
|
|
16892
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
16552
16893
|
heating_set_point_fahrenheit?: number | undefined
|
|
16894
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
16553
16895
|
manual_override_allowed: boolean
|
|
16554
16896
|
}>
|
|
16555
16897
|
| undefined
|
|
16556
16898
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
16899
|
+
/** 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. */
|
|
16557
16900
|
active_thermostat_schedule?:
|
|
16558
16901
|
| ({
|
|
16902
|
+
/** ID of the thermostat schedule. */
|
|
16559
16903
|
thermostat_schedule_id: string
|
|
16904
|
+
/** ID of the desired thermostat device. */
|
|
16560
16905
|
device_id: string
|
|
16906
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
16561
16907
|
name?: string | undefined
|
|
16908
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
16562
16909
|
climate_preset_key: string
|
|
16910
|
+
/** 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). */
|
|
16563
16911
|
max_override_period_minutes: number
|
|
16912
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
16564
16913
|
starts_at: string
|
|
16914
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
16565
16915
|
ends_at: string
|
|
16916
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
16566
16917
|
created_at: string
|
|
16567
|
-
/**
|
|
16918
|
+
/** 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. */
|
|
16568
16919
|
errors?: any
|
|
16569
16920
|
} | null)
|
|
16570
16921
|
| undefined
|
|
@@ -18396,10 +18747,13 @@ export interface Routes {
|
|
|
18396
18747
|
queryParams: {}
|
|
18397
18748
|
jsonBody: {}
|
|
18398
18749
|
commonParams: {
|
|
18399
|
-
/**
|
|
18750
|
+
/** ID of the connected account by which to filter. */
|
|
18400
18751
|
connected_account_id?: string | undefined
|
|
18752
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
18401
18753
|
connected_account_ids?: string[] | undefined
|
|
18754
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
18402
18755
|
connect_webview_id?: string | undefined
|
|
18756
|
+
/** Device type by which to filter devices. */
|
|
18403
18757
|
device_type?:
|
|
18404
18758
|
| (
|
|
18405
18759
|
| (
|
|
@@ -18441,6 +18795,7 @@ export interface Routes {
|
|
|
18441
18795
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
18442
18796
|
)
|
|
18443
18797
|
| undefined
|
|
18798
|
+
/** Array of device types by which to filter devices. */
|
|
18444
18799
|
device_types?:
|
|
18445
18800
|
| Array<
|
|
18446
18801
|
| (
|
|
@@ -18482,6 +18837,7 @@ export interface Routes {
|
|
|
18482
18837
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
18483
18838
|
>
|
|
18484
18839
|
| undefined
|
|
18840
|
+
/** Manufacturer by which to filter devices. */
|
|
18485
18841
|
manufacturer?:
|
|
18486
18842
|
| (
|
|
18487
18843
|
| 'akuvox'
|
|
@@ -18521,11 +18877,17 @@ export interface Routes {
|
|
|
18521
18877
|
| 'akiles'
|
|
18522
18878
|
)
|
|
18523
18879
|
| undefined
|
|
18880
|
+
/** Array of device IDs by which to filter devices. */
|
|
18524
18881
|
device_ids?: string[] | undefined
|
|
18882
|
+
/** Numerical limit on the number of devices to return. */
|
|
18525
18883
|
limit?: number
|
|
18884
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
18526
18885
|
created_before?: Date | undefined
|
|
18886
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
18527
18887
|
user_identifier_key?: string | undefined
|
|
18888
|
+
/** 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. */
|
|
18528
18889
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
18890
|
+
/** */
|
|
18529
18891
|
include_if?:
|
|
18530
18892
|
| Array<
|
|
18531
18893
|
| 'can_remotely_unlock'
|
|
@@ -18541,6 +18903,7 @@ export interface Routes {
|
|
|
18541
18903
|
| 'can_simulate_disconnection'
|
|
18542
18904
|
>
|
|
18543
18905
|
| undefined
|
|
18906
|
+
/** */
|
|
18544
18907
|
exclude_if?:
|
|
18545
18908
|
| Array<
|
|
18546
18909
|
| 'can_remotely_unlock'
|
|
@@ -19056,25 +19419,37 @@ export interface Routes {
|
|
|
19056
19419
|
is_temporary_manual_override_active?: boolean | undefined
|
|
19057
19420
|
current_climate_setting?:
|
|
19058
19421
|
| {
|
|
19422
|
+
/** Unique key to identify the climate preset. */
|
|
19059
19423
|
climate_preset_key?: string | undefined
|
|
19424
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19060
19425
|
can_edit?: boolean | undefined
|
|
19426
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19061
19427
|
can_delete?: boolean | undefined
|
|
19428
|
+
/** User-friendly name to identify the climate preset. */
|
|
19062
19429
|
name?: ((string | null) | undefined) | undefined
|
|
19430
|
+
/** Display name for the climate preset. */
|
|
19063
19431
|
display_name?: string | undefined
|
|
19432
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19064
19433
|
fan_mode_setting?:
|
|
19065
19434
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
19066
19435
|
| undefined
|
|
19436
|
+
/** 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`. */
|
|
19067
19437
|
hvac_mode_setting?:
|
|
19068
19438
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
19069
19439
|
| undefined
|
|
19440
|
+
/** 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). */
|
|
19070
19441
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
19442
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19071
19443
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
19444
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19072
19445
|
cooling_set_point_fahrenheit?:
|
|
19073
19446
|
| (number | undefined)
|
|
19074
19447
|
| undefined
|
|
19448
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19075
19449
|
heating_set_point_fahrenheit?:
|
|
19076
19450
|
| (number | undefined)
|
|
19077
19451
|
| undefined
|
|
19452
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19078
19453
|
manual_override_allowed?: boolean | undefined
|
|
19079
19454
|
}
|
|
19080
19455
|
| undefined
|
|
@@ -19082,58 +19457,91 @@ export interface Routes {
|
|
|
19082
19457
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
19083
19458
|
default_climate_setting?:
|
|
19084
19459
|
| {
|
|
19460
|
+
/** Unique key to identify the climate preset. */
|
|
19085
19461
|
climate_preset_key?: string | undefined
|
|
19462
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19086
19463
|
can_edit?: boolean | undefined
|
|
19464
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19087
19465
|
can_delete?: boolean | undefined
|
|
19466
|
+
/** User-friendly name to identify the climate preset. */
|
|
19088
19467
|
name?: ((string | null) | undefined) | undefined
|
|
19468
|
+
/** Display name for the climate preset. */
|
|
19089
19469
|
display_name?: string | undefined
|
|
19470
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19090
19471
|
fan_mode_setting?:
|
|
19091
19472
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
19092
19473
|
| undefined
|
|
19474
|
+
/** 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`. */
|
|
19093
19475
|
hvac_mode_setting?:
|
|
19094
19476
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
19095
19477
|
| undefined
|
|
19478
|
+
/** 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). */
|
|
19096
19479
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
19480
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19097
19481
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
19482
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19098
19483
|
cooling_set_point_fahrenheit?:
|
|
19099
19484
|
| (number | undefined)
|
|
19100
19485
|
| undefined
|
|
19486
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19101
19487
|
heating_set_point_fahrenheit?:
|
|
19102
19488
|
| (number | undefined)
|
|
19103
19489
|
| undefined
|
|
19490
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19104
19491
|
manual_override_allowed?: boolean | undefined
|
|
19105
19492
|
}
|
|
19106
19493
|
| undefined
|
|
19107
19494
|
available_climate_presets?:
|
|
19108
19495
|
| Array<{
|
|
19496
|
+
/** Unique key to identify the climate preset. */
|
|
19109
19497
|
climate_preset_key: string
|
|
19498
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19110
19499
|
can_edit: boolean
|
|
19500
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19111
19501
|
can_delete: boolean
|
|
19502
|
+
/** User-friendly name to identify the climate preset. */
|
|
19112
19503
|
name?: (string | null) | undefined
|
|
19504
|
+
/** Display name for the climate preset. */
|
|
19113
19505
|
display_name: string
|
|
19506
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19114
19507
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
19508
|
+
/** 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`. */
|
|
19115
19509
|
hvac_mode_setting?:
|
|
19116
19510
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
19117
19511
|
| undefined
|
|
19512
|
+
/** 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). */
|
|
19118
19513
|
cooling_set_point_celsius?: number | undefined
|
|
19514
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19119
19515
|
heating_set_point_celsius?: number | undefined
|
|
19516
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19120
19517
|
cooling_set_point_fahrenheit?: number | undefined
|
|
19518
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19121
19519
|
heating_set_point_fahrenheit?: number | undefined
|
|
19520
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19122
19521
|
manual_override_allowed: boolean
|
|
19123
19522
|
}>
|
|
19124
19523
|
| undefined
|
|
19125
19524
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
19525
|
+
/** 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. */
|
|
19126
19526
|
active_thermostat_schedule?:
|
|
19127
19527
|
| ({
|
|
19528
|
+
/** ID of the thermostat schedule. */
|
|
19128
19529
|
thermostat_schedule_id: string
|
|
19530
|
+
/** ID of the desired thermostat device. */
|
|
19129
19531
|
device_id: string
|
|
19532
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
19130
19533
|
name?: string | undefined
|
|
19534
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
19131
19535
|
climate_preset_key: string
|
|
19536
|
+
/** 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). */
|
|
19132
19537
|
max_override_period_minutes: number
|
|
19538
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19133
19539
|
starts_at: string
|
|
19540
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19134
19541
|
ends_at: string
|
|
19542
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
19135
19543
|
created_at: string
|
|
19136
|
-
/**
|
|
19544
|
+
/** 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. */
|
|
19137
19545
|
errors?: any
|
|
19138
19546
|
} | null)
|
|
19139
19547
|
| undefined
|
|
@@ -19702,25 +20110,37 @@ export interface Routes {
|
|
|
19702
20110
|
is_temporary_manual_override_active?: boolean | undefined
|
|
19703
20111
|
current_climate_setting?:
|
|
19704
20112
|
| {
|
|
20113
|
+
/** Unique key to identify the climate preset. */
|
|
19705
20114
|
climate_preset_key?: string | undefined
|
|
20115
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19706
20116
|
can_edit?: boolean | undefined
|
|
20117
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19707
20118
|
can_delete?: boolean | undefined
|
|
20119
|
+
/** User-friendly name to identify the climate preset. */
|
|
19708
20120
|
name?: ((string | null) | undefined) | undefined
|
|
20121
|
+
/** Display name for the climate preset. */
|
|
19709
20122
|
display_name?: string | undefined
|
|
20123
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19710
20124
|
fan_mode_setting?:
|
|
19711
20125
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
19712
20126
|
| undefined
|
|
20127
|
+
/** 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`. */
|
|
19713
20128
|
hvac_mode_setting?:
|
|
19714
20129
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
19715
20130
|
| undefined
|
|
20131
|
+
/** 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). */
|
|
19716
20132
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
20133
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19717
20134
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
20135
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19718
20136
|
cooling_set_point_fahrenheit?:
|
|
19719
20137
|
| (number | undefined)
|
|
19720
20138
|
| undefined
|
|
20139
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19721
20140
|
heating_set_point_fahrenheit?:
|
|
19722
20141
|
| (number | undefined)
|
|
19723
20142
|
| undefined
|
|
20143
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19724
20144
|
manual_override_allowed?: boolean | undefined
|
|
19725
20145
|
}
|
|
19726
20146
|
| undefined
|
|
@@ -19728,58 +20148,91 @@ export interface Routes {
|
|
|
19728
20148
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
19729
20149
|
default_climate_setting?:
|
|
19730
20150
|
| {
|
|
20151
|
+
/** Unique key to identify the climate preset. */
|
|
19731
20152
|
climate_preset_key?: string | undefined
|
|
20153
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19732
20154
|
can_edit?: boolean | undefined
|
|
20155
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19733
20156
|
can_delete?: boolean | undefined
|
|
20157
|
+
/** User-friendly name to identify the climate preset. */
|
|
19734
20158
|
name?: ((string | null) | undefined) | undefined
|
|
20159
|
+
/** Display name for the climate preset. */
|
|
19735
20160
|
display_name?: string | undefined
|
|
20161
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19736
20162
|
fan_mode_setting?:
|
|
19737
20163
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
19738
20164
|
| undefined
|
|
20165
|
+
/** 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`. */
|
|
19739
20166
|
hvac_mode_setting?:
|
|
19740
20167
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
19741
20168
|
| undefined
|
|
20169
|
+
/** 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). */
|
|
19742
20170
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
20171
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19743
20172
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
20173
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19744
20174
|
cooling_set_point_fahrenheit?:
|
|
19745
20175
|
| (number | undefined)
|
|
19746
20176
|
| undefined
|
|
20177
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19747
20178
|
heating_set_point_fahrenheit?:
|
|
19748
20179
|
| (number | undefined)
|
|
19749
20180
|
| undefined
|
|
20181
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19750
20182
|
manual_override_allowed?: boolean | undefined
|
|
19751
20183
|
}
|
|
19752
20184
|
| undefined
|
|
19753
20185
|
available_climate_presets?:
|
|
19754
20186
|
| Array<{
|
|
20187
|
+
/** Unique key to identify the climate preset. */
|
|
19755
20188
|
climate_preset_key: string
|
|
20189
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
19756
20190
|
can_edit: boolean
|
|
20191
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
19757
20192
|
can_delete: boolean
|
|
20193
|
+
/** User-friendly name to identify the climate preset. */
|
|
19758
20194
|
name?: (string | null) | undefined
|
|
20195
|
+
/** Display name for the climate preset. */
|
|
19759
20196
|
display_name: string
|
|
20197
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
19760
20198
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
20199
|
+
/** 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`. */
|
|
19761
20200
|
hvac_mode_setting?:
|
|
19762
20201
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
19763
20202
|
| undefined
|
|
20203
|
+
/** 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). */
|
|
19764
20204
|
cooling_set_point_celsius?: number | undefined
|
|
20205
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
19765
20206
|
heating_set_point_celsius?: number | undefined
|
|
20207
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
19766
20208
|
cooling_set_point_fahrenheit?: number | undefined
|
|
20209
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
19767
20210
|
heating_set_point_fahrenheit?: number | undefined
|
|
20211
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
19768
20212
|
manual_override_allowed: boolean
|
|
19769
20213
|
}>
|
|
19770
20214
|
| undefined
|
|
19771
20215
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
20216
|
+
/** 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. */
|
|
19772
20217
|
active_thermostat_schedule?:
|
|
19773
20218
|
| ({
|
|
20219
|
+
/** ID of the thermostat schedule. */
|
|
19774
20220
|
thermostat_schedule_id: string
|
|
20221
|
+
/** ID of the desired thermostat device. */
|
|
19775
20222
|
device_id: string
|
|
20223
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
19776
20224
|
name?: string | undefined
|
|
20225
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
19777
20226
|
climate_preset_key: string
|
|
20227
|
+
/** 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). */
|
|
19778
20228
|
max_override_period_minutes: number
|
|
20229
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19779
20230
|
starts_at: string
|
|
20231
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
19780
20232
|
ends_at: string
|
|
20233
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
19781
20234
|
created_at: string
|
|
19782
|
-
/**
|
|
20235
|
+
/** 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. */
|
|
19783
20236
|
errors?: any
|
|
19784
20237
|
} | null)
|
|
19785
20238
|
| undefined
|
|
@@ -22705,7 +23158,9 @@ export interface Routes {
|
|
|
22705
23158
|
method: 'POST'
|
|
22706
23159
|
queryParams: {}
|
|
22707
23160
|
jsonBody: {
|
|
23161
|
+
/** ID of the desired thermostat device. */
|
|
22708
23162
|
device_id: string
|
|
23163
|
+
/** Climate preset key of the desired climate preset. */
|
|
22709
23164
|
climate_preset_key: string
|
|
22710
23165
|
}
|
|
22711
23166
|
commonParams: {}
|
|
@@ -23564,12 +24019,13 @@ export interface Routes {
|
|
|
23564
24019
|
method: 'POST'
|
|
23565
24020
|
queryParams: {}
|
|
23566
24021
|
jsonBody: {
|
|
23567
|
-
/** ID of the thermostat device. */
|
|
24022
|
+
/** ID of the desired thermostat device. */
|
|
23568
24023
|
device_id: string
|
|
23569
|
-
/**
|
|
24024
|
+
/** 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. */
|
|
23570
24025
|
cooling_set_point_celsius?: number | undefined
|
|
23571
|
-
/**
|
|
24026
|
+
/** 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. */
|
|
23572
24027
|
cooling_set_point_fahrenheit?: number | undefined
|
|
24028
|
+
/** */
|
|
23573
24029
|
sync?: boolean
|
|
23574
24030
|
}
|
|
23575
24031
|
commonParams: {}
|
|
@@ -24428,15 +24884,25 @@ export interface Routes {
|
|
|
24428
24884
|
method: 'POST'
|
|
24429
24885
|
queryParams: {}
|
|
24430
24886
|
jsonBody: {
|
|
24887
|
+
/** ID of the desired thermostat device. */
|
|
24431
24888
|
device_id: string
|
|
24889
|
+
/** Unique key to identify the climate preset. */
|
|
24432
24890
|
climate_preset_key: string
|
|
24891
|
+
/** User-friendly name to identify the climate preset. */
|
|
24433
24892
|
name?: (string | null) | undefined
|
|
24893
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24434
24894
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
24895
|
+
/** 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`. */
|
|
24435
24896
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
|
|
24897
|
+
/** 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). */
|
|
24436
24898
|
cooling_set_point_celsius?: number | undefined
|
|
24899
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24437
24900
|
heating_set_point_celsius?: number | undefined
|
|
24901
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24438
24902
|
cooling_set_point_fahrenheit?: number | undefined
|
|
24903
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24439
24904
|
heating_set_point_fahrenheit?: number | undefined
|
|
24905
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24440
24906
|
manual_override_allowed: boolean
|
|
24441
24907
|
}
|
|
24442
24908
|
commonParams: {}
|
|
@@ -24448,7 +24914,9 @@ export interface Routes {
|
|
|
24448
24914
|
method: 'POST' | 'DELETE'
|
|
24449
24915
|
queryParams: {}
|
|
24450
24916
|
jsonBody: {
|
|
24917
|
+
/** ID of the desired thermostat device. */
|
|
24451
24918
|
device_id: string
|
|
24919
|
+
/** Climate preset key of the desired climate preset. */
|
|
24452
24920
|
climate_preset_key: string
|
|
24453
24921
|
}
|
|
24454
24922
|
commonParams: {}
|
|
@@ -24461,9 +24929,9 @@ export interface Routes {
|
|
|
24461
24929
|
queryParams: {}
|
|
24462
24930
|
jsonBody: {}
|
|
24463
24931
|
commonParams: {
|
|
24464
|
-
/** ID of the thermostat device. */
|
|
24932
|
+
/** ID of the desired thermostat device. */
|
|
24465
24933
|
device_id?: string | undefined
|
|
24466
|
-
/**
|
|
24934
|
+
/** User-friendly name of the desired thermostat device. */
|
|
24467
24935
|
name?: string | undefined
|
|
24468
24936
|
}
|
|
24469
24937
|
formData: {}
|
|
@@ -24965,25 +25433,37 @@ export interface Routes {
|
|
|
24965
25433
|
is_temporary_manual_override_active?: boolean | undefined
|
|
24966
25434
|
current_climate_setting?:
|
|
24967
25435
|
| {
|
|
25436
|
+
/** Unique key to identify the climate preset. */
|
|
24968
25437
|
climate_preset_key?: string | undefined
|
|
25438
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24969
25439
|
can_edit?: boolean | undefined
|
|
25440
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24970
25441
|
can_delete?: boolean | undefined
|
|
25442
|
+
/** User-friendly name to identify the climate preset. */
|
|
24971
25443
|
name?: ((string | null) | undefined) | undefined
|
|
25444
|
+
/** Display name for the climate preset. */
|
|
24972
25445
|
display_name?: string | undefined
|
|
25446
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24973
25447
|
fan_mode_setting?:
|
|
24974
25448
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
24975
25449
|
| undefined
|
|
25450
|
+
/** 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`. */
|
|
24976
25451
|
hvac_mode_setting?:
|
|
24977
25452
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
24978
25453
|
| undefined
|
|
25454
|
+
/** 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). */
|
|
24979
25455
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
25456
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
24980
25457
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
25458
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
24981
25459
|
cooling_set_point_fahrenheit?:
|
|
24982
25460
|
| (number | undefined)
|
|
24983
25461
|
| undefined
|
|
25462
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
24984
25463
|
heating_set_point_fahrenheit?:
|
|
24985
25464
|
| (number | undefined)
|
|
24986
25465
|
| undefined
|
|
25466
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
24987
25467
|
manual_override_allowed?: boolean | undefined
|
|
24988
25468
|
}
|
|
24989
25469
|
| undefined
|
|
@@ -24991,58 +25471,91 @@ export interface Routes {
|
|
|
24991
25471
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
24992
25472
|
default_climate_setting?:
|
|
24993
25473
|
| {
|
|
25474
|
+
/** Unique key to identify the climate preset. */
|
|
24994
25475
|
climate_preset_key?: string | undefined
|
|
25476
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
24995
25477
|
can_edit?: boolean | undefined
|
|
25478
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
24996
25479
|
can_delete?: boolean | undefined
|
|
25480
|
+
/** User-friendly name to identify the climate preset. */
|
|
24997
25481
|
name?: ((string | null) | undefined) | undefined
|
|
25482
|
+
/** Display name for the climate preset. */
|
|
24998
25483
|
display_name?: string | undefined
|
|
25484
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
24999
25485
|
fan_mode_setting?:
|
|
25000
25486
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
25001
25487
|
| undefined
|
|
25488
|
+
/** 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`. */
|
|
25002
25489
|
hvac_mode_setting?:
|
|
25003
25490
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
25004
25491
|
| undefined
|
|
25492
|
+
/** 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). */
|
|
25005
25493
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
25494
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
25006
25495
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
25496
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
25007
25497
|
cooling_set_point_fahrenheit?:
|
|
25008
25498
|
| (number | undefined)
|
|
25009
25499
|
| undefined
|
|
25500
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
25010
25501
|
heating_set_point_fahrenheit?:
|
|
25011
25502
|
| (number | undefined)
|
|
25012
25503
|
| undefined
|
|
25504
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
25013
25505
|
manual_override_allowed?: boolean | undefined
|
|
25014
25506
|
}
|
|
25015
25507
|
| undefined
|
|
25016
25508
|
available_climate_presets?:
|
|
25017
25509
|
| Array<{
|
|
25510
|
+
/** Unique key to identify the climate preset. */
|
|
25018
25511
|
climate_preset_key: string
|
|
25512
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
25019
25513
|
can_edit: boolean
|
|
25514
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
25020
25515
|
can_delete: boolean
|
|
25516
|
+
/** User-friendly name to identify the climate preset. */
|
|
25021
25517
|
name?: (string | null) | undefined
|
|
25518
|
+
/** Display name for the climate preset. */
|
|
25022
25519
|
display_name: string
|
|
25520
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
25023
25521
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
25522
|
+
/** 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`. */
|
|
25024
25523
|
hvac_mode_setting?:
|
|
25025
25524
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
25026
25525
|
| undefined
|
|
25526
|
+
/** 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). */
|
|
25027
25527
|
cooling_set_point_celsius?: number | undefined
|
|
25528
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
25028
25529
|
heating_set_point_celsius?: number | undefined
|
|
25530
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
25029
25531
|
cooling_set_point_fahrenheit?: number | undefined
|
|
25532
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
25030
25533
|
heating_set_point_fahrenheit?: number | undefined
|
|
25534
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
25031
25535
|
manual_override_allowed: boolean
|
|
25032
25536
|
}>
|
|
25033
25537
|
| undefined
|
|
25034
25538
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
25539
|
+
/** 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. */
|
|
25035
25540
|
active_thermostat_schedule?:
|
|
25036
25541
|
| ({
|
|
25542
|
+
/** ID of the thermostat schedule. */
|
|
25037
25543
|
thermostat_schedule_id: string
|
|
25544
|
+
/** ID of the desired thermostat device. */
|
|
25038
25545
|
device_id: string
|
|
25546
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
25039
25547
|
name?: string | undefined
|
|
25548
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
25040
25549
|
climate_preset_key: string
|
|
25550
|
+
/** 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). */
|
|
25041
25551
|
max_override_period_minutes: number
|
|
25552
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25042
25553
|
starts_at: string
|
|
25554
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25043
25555
|
ends_at: string
|
|
25556
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
25044
25557
|
created_at: string
|
|
25045
|
-
/**
|
|
25558
|
+
/** 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. */
|
|
25046
25559
|
errors?: any
|
|
25047
25560
|
} | null)
|
|
25048
25561
|
| undefined
|
|
@@ -25121,12 +25634,13 @@ export interface Routes {
|
|
|
25121
25634
|
method: 'POST'
|
|
25122
25635
|
queryParams: {}
|
|
25123
25636
|
jsonBody: {
|
|
25124
|
-
/** ID of the thermostat device. */
|
|
25637
|
+
/** ID of the desired thermostat device. */
|
|
25125
25638
|
device_id: string
|
|
25126
|
-
/**
|
|
25639
|
+
/** 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. */
|
|
25127
25640
|
heating_set_point_celsius?: number | undefined
|
|
25128
|
-
/**
|
|
25641
|
+
/** 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. */
|
|
25129
25642
|
heating_set_point_fahrenheit?: number | undefined
|
|
25643
|
+
/** */
|
|
25130
25644
|
sync?: boolean
|
|
25131
25645
|
}
|
|
25132
25646
|
commonParams: {}
|
|
@@ -25985,16 +26499,17 @@ export interface Routes {
|
|
|
25985
26499
|
method: 'POST'
|
|
25986
26500
|
queryParams: {}
|
|
25987
26501
|
jsonBody: {
|
|
25988
|
-
/** ID of the thermostat device. */
|
|
26502
|
+
/** ID of the desired thermostat device. */
|
|
25989
26503
|
device_id: string
|
|
25990
|
-
/**
|
|
26504
|
+
/** 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. */
|
|
25991
26505
|
heating_set_point_celsius?: number | undefined
|
|
25992
|
-
/**
|
|
26506
|
+
/** 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. */
|
|
25993
26507
|
heating_set_point_fahrenheit?: number | undefined
|
|
25994
|
-
/**
|
|
26508
|
+
/** 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. */
|
|
25995
26509
|
cooling_set_point_celsius?: number | undefined
|
|
25996
|
-
/**
|
|
26510
|
+
/** 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. */
|
|
25997
26511
|
cooling_set_point_fahrenheit?: number | undefined
|
|
26512
|
+
/** */
|
|
25998
26513
|
sync?: boolean
|
|
25999
26514
|
}
|
|
26000
26515
|
commonParams: {}
|
|
@@ -26854,10 +27369,13 @@ export interface Routes {
|
|
|
26854
27369
|
queryParams: {}
|
|
26855
27370
|
jsonBody: {}
|
|
26856
27371
|
commonParams: {
|
|
26857
|
-
/**
|
|
27372
|
+
/** ID of the connected account by which to filter. */
|
|
26858
27373
|
connected_account_id?: string | undefined
|
|
27374
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
26859
27375
|
connected_account_ids?: string[] | undefined
|
|
27376
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
26860
27377
|
connect_webview_id?: string | undefined
|
|
27378
|
+
/** Device type by which to filter devices. */
|
|
26861
27379
|
device_type?:
|
|
26862
27380
|
| (
|
|
26863
27381
|
| (
|
|
@@ -26899,6 +27417,7 @@ export interface Routes {
|
|
|
26899
27417
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
26900
27418
|
)
|
|
26901
27419
|
| undefined
|
|
27420
|
+
/** Array of device types by which to filter devices. */
|
|
26902
27421
|
device_types?:
|
|
26903
27422
|
| Array<
|
|
26904
27423
|
| (
|
|
@@ -26940,6 +27459,7 @@ export interface Routes {
|
|
|
26940
27459
|
| ('visionline_encoder' | 'assa_abloy_vostio_encoder')
|
|
26941
27460
|
>
|
|
26942
27461
|
| undefined
|
|
27462
|
+
/** Manufacturer by which to filter devices. */
|
|
26943
27463
|
manufacturer?:
|
|
26944
27464
|
| (
|
|
26945
27465
|
| 'akuvox'
|
|
@@ -26979,11 +27499,17 @@ export interface Routes {
|
|
|
26979
27499
|
| 'akiles'
|
|
26980
27500
|
)
|
|
26981
27501
|
| undefined
|
|
27502
|
+
/** Array of device IDs by which to filter devices. */
|
|
26982
27503
|
device_ids?: string[] | undefined
|
|
27504
|
+
/** Numerical limit on the number of devices to return. */
|
|
26983
27505
|
limit?: number
|
|
27506
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
26984
27507
|
created_before?: Date | undefined
|
|
27508
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
26985
27509
|
user_identifier_key?: string | undefined
|
|
27510
|
+
/** 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. */
|
|
26986
27511
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
27512
|
+
/** */
|
|
26987
27513
|
include_if?:
|
|
26988
27514
|
| Array<
|
|
26989
27515
|
| 'can_remotely_unlock'
|
|
@@ -26999,6 +27525,7 @@ export interface Routes {
|
|
|
26999
27525
|
| 'can_simulate_disconnection'
|
|
27000
27526
|
>
|
|
27001
27527
|
| undefined
|
|
27528
|
+
/** */
|
|
27002
27529
|
exclude_if?:
|
|
27003
27530
|
| Array<
|
|
27004
27531
|
| 'can_remotely_unlock'
|
|
@@ -27514,25 +28041,37 @@ export interface Routes {
|
|
|
27514
28041
|
is_temporary_manual_override_active?: boolean | undefined
|
|
27515
28042
|
current_climate_setting?:
|
|
27516
28043
|
| {
|
|
28044
|
+
/** Unique key to identify the climate preset. */
|
|
27517
28045
|
climate_preset_key?: string | undefined
|
|
28046
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
27518
28047
|
can_edit?: boolean | undefined
|
|
28048
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
27519
28049
|
can_delete?: boolean | undefined
|
|
28050
|
+
/** User-friendly name to identify the climate preset. */
|
|
27520
28051
|
name?: ((string | null) | undefined) | undefined
|
|
28052
|
+
/** Display name for the climate preset. */
|
|
27521
28053
|
display_name?: string | undefined
|
|
28054
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
27522
28055
|
fan_mode_setting?:
|
|
27523
28056
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
27524
28057
|
| undefined
|
|
28058
|
+
/** 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`. */
|
|
27525
28059
|
hvac_mode_setting?:
|
|
27526
28060
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
27527
28061
|
| undefined
|
|
28062
|
+
/** 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). */
|
|
27528
28063
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
28064
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
27529
28065
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
28066
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
27530
28067
|
cooling_set_point_fahrenheit?:
|
|
27531
28068
|
| (number | undefined)
|
|
27532
28069
|
| undefined
|
|
28070
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
27533
28071
|
heating_set_point_fahrenheit?:
|
|
27534
28072
|
| (number | undefined)
|
|
27535
28073
|
| undefined
|
|
28074
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
27536
28075
|
manual_override_allowed?: boolean | undefined
|
|
27537
28076
|
}
|
|
27538
28077
|
| undefined
|
|
@@ -27540,58 +28079,91 @@ export interface Routes {
|
|
|
27540
28079
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
27541
28080
|
default_climate_setting?:
|
|
27542
28081
|
| {
|
|
28082
|
+
/** Unique key to identify the climate preset. */
|
|
27543
28083
|
climate_preset_key?: string | undefined
|
|
28084
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
27544
28085
|
can_edit?: boolean | undefined
|
|
28086
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
27545
28087
|
can_delete?: boolean | undefined
|
|
28088
|
+
/** User-friendly name to identify the climate preset. */
|
|
27546
28089
|
name?: ((string | null) | undefined) | undefined
|
|
28090
|
+
/** Display name for the climate preset. */
|
|
27547
28091
|
display_name?: string | undefined
|
|
28092
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
27548
28093
|
fan_mode_setting?:
|
|
27549
28094
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
27550
28095
|
| undefined
|
|
28096
|
+
/** 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`. */
|
|
27551
28097
|
hvac_mode_setting?:
|
|
27552
28098
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
27553
28099
|
| undefined
|
|
28100
|
+
/** 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). */
|
|
27554
28101
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
28102
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
27555
28103
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
28104
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
27556
28105
|
cooling_set_point_fahrenheit?:
|
|
27557
28106
|
| (number | undefined)
|
|
27558
28107
|
| undefined
|
|
28108
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
27559
28109
|
heating_set_point_fahrenheit?:
|
|
27560
28110
|
| (number | undefined)
|
|
27561
28111
|
| undefined
|
|
28112
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
27562
28113
|
manual_override_allowed?: boolean | undefined
|
|
27563
28114
|
}
|
|
27564
28115
|
| undefined
|
|
27565
28116
|
available_climate_presets?:
|
|
27566
28117
|
| Array<{
|
|
28118
|
+
/** Unique key to identify the climate preset. */
|
|
27567
28119
|
climate_preset_key: string
|
|
28120
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
27568
28121
|
can_edit: boolean
|
|
28122
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
27569
28123
|
can_delete: boolean
|
|
28124
|
+
/** User-friendly name to identify the climate preset. */
|
|
27570
28125
|
name?: (string | null) | undefined
|
|
28126
|
+
/** Display name for the climate preset. */
|
|
27571
28127
|
display_name: string
|
|
28128
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
27572
28129
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
28130
|
+
/** 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`. */
|
|
27573
28131
|
hvac_mode_setting?:
|
|
27574
28132
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
27575
28133
|
| undefined
|
|
28134
|
+
/** 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). */
|
|
27576
28135
|
cooling_set_point_celsius?: number | undefined
|
|
28136
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
27577
28137
|
heating_set_point_celsius?: number | undefined
|
|
28138
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
27578
28139
|
cooling_set_point_fahrenheit?: number | undefined
|
|
28140
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
27579
28141
|
heating_set_point_fahrenheit?: number | undefined
|
|
28142
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
27580
28143
|
manual_override_allowed: boolean
|
|
27581
28144
|
}>
|
|
27582
28145
|
| undefined
|
|
27583
28146
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
28147
|
+
/** 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. */
|
|
27584
28148
|
active_thermostat_schedule?:
|
|
27585
28149
|
| ({
|
|
28150
|
+
/** ID of the thermostat schedule. */
|
|
27586
28151
|
thermostat_schedule_id: string
|
|
28152
|
+
/** ID of the desired thermostat device. */
|
|
27587
28153
|
device_id: string
|
|
28154
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
27588
28155
|
name?: string | undefined
|
|
28156
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
27589
28157
|
climate_preset_key: string
|
|
28158
|
+
/** 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). */
|
|
27590
28159
|
max_override_period_minutes: number
|
|
28160
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
27591
28161
|
starts_at: string
|
|
28162
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
27592
28163
|
ends_at: string
|
|
28164
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
27593
28165
|
created_at: string
|
|
27594
|
-
/**
|
|
28166
|
+
/** 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. */
|
|
27595
28167
|
errors?: any
|
|
27596
28168
|
} | null)
|
|
27597
28169
|
| undefined
|
|
@@ -28160,25 +28732,37 @@ export interface Routes {
|
|
|
28160
28732
|
is_temporary_manual_override_active?: boolean | undefined
|
|
28161
28733
|
current_climate_setting?:
|
|
28162
28734
|
| {
|
|
28735
|
+
/** Unique key to identify the climate preset. */
|
|
28163
28736
|
climate_preset_key?: string | undefined
|
|
28737
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
28164
28738
|
can_edit?: boolean | undefined
|
|
28739
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
28165
28740
|
can_delete?: boolean | undefined
|
|
28741
|
+
/** User-friendly name to identify the climate preset. */
|
|
28166
28742
|
name?: ((string | null) | undefined) | undefined
|
|
28743
|
+
/** Display name for the climate preset. */
|
|
28167
28744
|
display_name?: string | undefined
|
|
28745
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
28168
28746
|
fan_mode_setting?:
|
|
28169
28747
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
28170
28748
|
| undefined
|
|
28749
|
+
/** 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`. */
|
|
28171
28750
|
hvac_mode_setting?:
|
|
28172
28751
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
28173
28752
|
| undefined
|
|
28753
|
+
/** 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). */
|
|
28174
28754
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
28755
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
28175
28756
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
28757
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
28176
28758
|
cooling_set_point_fahrenheit?:
|
|
28177
28759
|
| (number | undefined)
|
|
28178
28760
|
| undefined
|
|
28761
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
28179
28762
|
heating_set_point_fahrenheit?:
|
|
28180
28763
|
| (number | undefined)
|
|
28181
28764
|
| undefined
|
|
28765
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
28182
28766
|
manual_override_allowed?: boolean | undefined
|
|
28183
28767
|
}
|
|
28184
28768
|
| undefined
|
|
@@ -28186,58 +28770,91 @@ export interface Routes {
|
|
|
28186
28770
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
28187
28771
|
default_climate_setting?:
|
|
28188
28772
|
| {
|
|
28773
|
+
/** Unique key to identify the climate preset. */
|
|
28189
28774
|
climate_preset_key?: string | undefined
|
|
28775
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
28190
28776
|
can_edit?: boolean | undefined
|
|
28777
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
28191
28778
|
can_delete?: boolean | undefined
|
|
28779
|
+
/** User-friendly name to identify the climate preset. */
|
|
28192
28780
|
name?: ((string | null) | undefined) | undefined
|
|
28781
|
+
/** Display name for the climate preset. */
|
|
28193
28782
|
display_name?: string | undefined
|
|
28783
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
28194
28784
|
fan_mode_setting?:
|
|
28195
28785
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
28196
28786
|
| undefined
|
|
28787
|
+
/** 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`. */
|
|
28197
28788
|
hvac_mode_setting?:
|
|
28198
28789
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
28199
28790
|
| undefined
|
|
28791
|
+
/** 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). */
|
|
28200
28792
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
28793
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
28201
28794
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
28795
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
28202
28796
|
cooling_set_point_fahrenheit?:
|
|
28203
28797
|
| (number | undefined)
|
|
28204
28798
|
| undefined
|
|
28799
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
28205
28800
|
heating_set_point_fahrenheit?:
|
|
28206
28801
|
| (number | undefined)
|
|
28207
28802
|
| undefined
|
|
28803
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
28208
28804
|
manual_override_allowed?: boolean | undefined
|
|
28209
28805
|
}
|
|
28210
28806
|
| undefined
|
|
28211
28807
|
available_climate_presets?:
|
|
28212
28808
|
| Array<{
|
|
28809
|
+
/** Unique key to identify the climate preset. */
|
|
28213
28810
|
climate_preset_key: string
|
|
28811
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
28214
28812
|
can_edit: boolean
|
|
28813
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
28215
28814
|
can_delete: boolean
|
|
28815
|
+
/** User-friendly name to identify the climate preset. */
|
|
28216
28816
|
name?: (string | null) | undefined
|
|
28817
|
+
/** Display name for the climate preset. */
|
|
28217
28818
|
display_name: string
|
|
28819
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
28218
28820
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
28821
|
+
/** 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`. */
|
|
28219
28822
|
hvac_mode_setting?:
|
|
28220
28823
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
28221
28824
|
| undefined
|
|
28825
|
+
/** 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). */
|
|
28222
28826
|
cooling_set_point_celsius?: number | undefined
|
|
28827
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
28223
28828
|
heating_set_point_celsius?: number | undefined
|
|
28829
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
28224
28830
|
cooling_set_point_fahrenheit?: number | undefined
|
|
28831
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
28225
28832
|
heating_set_point_fahrenheit?: number | undefined
|
|
28833
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
28226
28834
|
manual_override_allowed: boolean
|
|
28227
28835
|
}>
|
|
28228
28836
|
| undefined
|
|
28229
28837
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
28838
|
+
/** 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. */
|
|
28230
28839
|
active_thermostat_schedule?:
|
|
28231
28840
|
| ({
|
|
28841
|
+
/** ID of the thermostat schedule. */
|
|
28232
28842
|
thermostat_schedule_id: string
|
|
28843
|
+
/** ID of the desired thermostat device. */
|
|
28233
28844
|
device_id: string
|
|
28845
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
28234
28846
|
name?: string | undefined
|
|
28847
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
28235
28848
|
climate_preset_key: string
|
|
28849
|
+
/** 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). */
|
|
28236
28850
|
max_override_period_minutes: number
|
|
28851
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
28237
28852
|
starts_at: string
|
|
28853
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
28238
28854
|
ends_at: string
|
|
28855
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
28239
28856
|
created_at: string
|
|
28240
|
-
/**
|
|
28857
|
+
/** 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. */
|
|
28241
28858
|
errors?: any
|
|
28242
28859
|
} | null)
|
|
28243
28860
|
| undefined
|
|
@@ -28316,8 +28933,9 @@ export interface Routes {
|
|
|
28316
28933
|
method: 'POST'
|
|
28317
28934
|
queryParams: {}
|
|
28318
28935
|
jsonBody: {
|
|
28319
|
-
/** ID of the thermostat device. */
|
|
28936
|
+
/** ID of the desired thermostat device. */
|
|
28320
28937
|
device_id: string
|
|
28938
|
+
/** */
|
|
28321
28939
|
sync?: boolean
|
|
28322
28940
|
}
|
|
28323
28941
|
commonParams: {}
|
|
@@ -29176,26 +29794,41 @@ export interface Routes {
|
|
|
29176
29794
|
method: 'POST'
|
|
29177
29795
|
queryParams: {}
|
|
29178
29796
|
jsonBody: {
|
|
29797
|
+
/** ID of the desired thermostat device. */
|
|
29179
29798
|
device_id: string
|
|
29799
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
29180
29800
|
name?: string | undefined
|
|
29801
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
29181
29802
|
climate_preset_key: string
|
|
29803
|
+
/** 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). */
|
|
29182
29804
|
max_override_period_minutes?: number
|
|
29805
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29183
29806
|
starts_at: string
|
|
29807
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29184
29808
|
ends_at: string
|
|
29185
29809
|
}
|
|
29186
29810
|
commonParams: {}
|
|
29187
29811
|
formData: {}
|
|
29188
29812
|
jsonResponse: {
|
|
29813
|
+
/** 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. */
|
|
29189
29814
|
thermostat_schedule: {
|
|
29815
|
+
/** ID of the thermostat schedule. */
|
|
29190
29816
|
thermostat_schedule_id: string
|
|
29817
|
+
/** ID of the desired thermostat device. */
|
|
29191
29818
|
device_id: string
|
|
29819
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
29192
29820
|
name?: string | undefined
|
|
29821
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
29193
29822
|
climate_preset_key: string
|
|
29823
|
+
/** 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). */
|
|
29194
29824
|
max_override_period_minutes: number
|
|
29825
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29195
29826
|
starts_at: string
|
|
29827
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29196
29828
|
ends_at: string
|
|
29829
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
29197
29830
|
created_at: string
|
|
29198
|
-
/**
|
|
29831
|
+
/** 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. */
|
|
29199
29832
|
errors?: any
|
|
29200
29833
|
}
|
|
29201
29834
|
}
|
|
@@ -29206,6 +29839,7 @@ export interface Routes {
|
|
|
29206
29839
|
queryParams: {}
|
|
29207
29840
|
jsonBody: {}
|
|
29208
29841
|
commonParams: {
|
|
29842
|
+
/** ID of the desired thermostat schedule. */
|
|
29209
29843
|
thermostat_schedule_id: string
|
|
29210
29844
|
}
|
|
29211
29845
|
formData: {}
|
|
@@ -29217,20 +29851,30 @@ export interface Routes {
|
|
|
29217
29851
|
queryParams: {}
|
|
29218
29852
|
jsonBody: {}
|
|
29219
29853
|
commonParams: {
|
|
29854
|
+
/** ID of the desired thermostat schedule. */
|
|
29220
29855
|
thermostat_schedule_id: string
|
|
29221
29856
|
}
|
|
29222
29857
|
formData: {}
|
|
29223
29858
|
jsonResponse: {
|
|
29859
|
+
/** 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. */
|
|
29224
29860
|
thermostat_schedule: {
|
|
29861
|
+
/** ID of the thermostat schedule. */
|
|
29225
29862
|
thermostat_schedule_id: string
|
|
29863
|
+
/** ID of the desired thermostat device. */
|
|
29226
29864
|
device_id: string
|
|
29865
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
29227
29866
|
name?: string | undefined
|
|
29867
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
29228
29868
|
climate_preset_key: string
|
|
29869
|
+
/** 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). */
|
|
29229
29870
|
max_override_period_minutes: number
|
|
29871
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29230
29872
|
starts_at: string
|
|
29873
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29231
29874
|
ends_at: string
|
|
29875
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
29232
29876
|
created_at: string
|
|
29233
|
-
/**
|
|
29877
|
+
/** 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. */
|
|
29234
29878
|
errors?: any
|
|
29235
29879
|
}
|
|
29236
29880
|
}
|
|
@@ -29241,21 +29885,31 @@ export interface Routes {
|
|
|
29241
29885
|
queryParams: {}
|
|
29242
29886
|
jsonBody: {}
|
|
29243
29887
|
commonParams: {
|
|
29888
|
+
/** ID of the desired thermostat device. */
|
|
29244
29889
|
device_id: string
|
|
29890
|
+
/** User identifier key by which to filter the list of returned thermostat schedules. */
|
|
29245
29891
|
user_identifier_key?: string | undefined
|
|
29246
29892
|
}
|
|
29247
29893
|
formData: {}
|
|
29248
29894
|
jsonResponse: {
|
|
29249
29895
|
thermostat_schedules: Array<{
|
|
29896
|
+
/** ID of the thermostat schedule. */
|
|
29250
29897
|
thermostat_schedule_id: string
|
|
29898
|
+
/** ID of the desired thermostat device. */
|
|
29251
29899
|
device_id: string
|
|
29900
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
29252
29901
|
name?: string | undefined
|
|
29902
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
29253
29903
|
climate_preset_key: string
|
|
29904
|
+
/** 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). */
|
|
29254
29905
|
max_override_period_minutes: number
|
|
29906
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29255
29907
|
starts_at: string
|
|
29908
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29256
29909
|
ends_at: string
|
|
29910
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
29257
29911
|
created_at: string
|
|
29258
|
-
/**
|
|
29912
|
+
/** 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. */
|
|
29259
29913
|
errors?: any
|
|
29260
29914
|
}>
|
|
29261
29915
|
}
|
|
@@ -29265,11 +29919,17 @@ export interface Routes {
|
|
|
29265
29919
|
method: 'PATCH' | 'POST'
|
|
29266
29920
|
queryParams: {}
|
|
29267
29921
|
jsonBody: {
|
|
29922
|
+
/** ID of the desired thermostat schedule. */
|
|
29268
29923
|
thermostat_schedule_id: string
|
|
29924
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
29269
29925
|
name?: string | undefined
|
|
29926
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
29270
29927
|
climate_preset_key?: string | undefined
|
|
29928
|
+
/** 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). */
|
|
29271
29929
|
max_override_period_minutes?: number | undefined
|
|
29930
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29272
29931
|
starts_at?: string | undefined
|
|
29932
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
29273
29933
|
ends_at?: string | undefined
|
|
29274
29934
|
}
|
|
29275
29935
|
commonParams: {}
|
|
@@ -29281,7 +29941,9 @@ export interface Routes {
|
|
|
29281
29941
|
method: 'POST'
|
|
29282
29942
|
queryParams: {}
|
|
29283
29943
|
jsonBody: {
|
|
29944
|
+
/** ID of the desired thermostat device. */
|
|
29284
29945
|
device_id: string
|
|
29946
|
+
/** Climate preset key of the desired climate preset. */
|
|
29285
29947
|
climate_preset_key: string
|
|
29286
29948
|
}
|
|
29287
29949
|
commonParams: {}
|
|
@@ -29293,13 +29955,13 @@ export interface Routes {
|
|
|
29293
29955
|
method: 'POST'
|
|
29294
29956
|
queryParams: {}
|
|
29295
29957
|
jsonBody: {
|
|
29296
|
-
/** ID of the thermostat device. */
|
|
29297
29958
|
device_id: string
|
|
29298
29959
|
/**
|
|
29299
29960
|
* @deprecated Use `fan_mode_setting` instead. */
|
|
29300
29961
|
fan_mode?: ('auto' | 'on' | 'circulate') | undefined
|
|
29301
|
-
/**
|
|
29962
|
+
/** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
|
|
29302
29963
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
29964
|
+
/** */
|
|
29303
29965
|
sync?: boolean
|
|
29304
29966
|
}
|
|
29305
29967
|
commonParams: {}
|
|
@@ -30158,10 +30820,15 @@ export interface Routes {
|
|
|
30158
30820
|
method: 'POST' | 'PATCH'
|
|
30159
30821
|
queryParams: {}
|
|
30160
30822
|
jsonBody: {
|
|
30823
|
+
/** ID of the desired thermostat device. */
|
|
30161
30824
|
device_id: string
|
|
30825
|
+
/** 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. */
|
|
30162
30826
|
lower_limit_celsius?: (number | undefined) | null
|
|
30827
|
+
/** 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. */
|
|
30163
30828
|
lower_limit_fahrenheit?: (number | undefined) | null
|
|
30829
|
+
/** 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. */
|
|
30164
30830
|
upper_limit_celsius?: (number | undefined) | null
|
|
30831
|
+
/** 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. */
|
|
30165
30832
|
upper_limit_fahrenheit?: (number | undefined) | null
|
|
30166
30833
|
}
|
|
30167
30834
|
commonParams: {}
|
|
@@ -30173,15 +30840,25 @@ export interface Routes {
|
|
|
30173
30840
|
method: 'POST' | 'PATCH'
|
|
30174
30841
|
queryParams: {}
|
|
30175
30842
|
jsonBody: {
|
|
30843
|
+
/** ID of the desired thermostat device. */
|
|
30176
30844
|
device_id: string
|
|
30845
|
+
/** Unique key to identify the climate preset. */
|
|
30177
30846
|
climate_preset_key: string
|
|
30847
|
+
/** User-friendly name to identify the climate preset. */
|
|
30178
30848
|
name?: (string | null) | undefined
|
|
30849
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
30179
30850
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
30851
|
+
/** 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`. */
|
|
30180
30852
|
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
|
|
30853
|
+
/** 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). */
|
|
30181
30854
|
cooling_set_point_celsius?: number | undefined
|
|
30855
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
30182
30856
|
heating_set_point_celsius?: number | undefined
|
|
30857
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
30183
30858
|
cooling_set_point_fahrenheit?: number | undefined
|
|
30859
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
30184
30860
|
heating_set_point_fahrenheit?: number | undefined
|
|
30861
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
30185
30862
|
manual_override_allowed: boolean
|
|
30186
30863
|
}
|
|
30187
30864
|
commonParams: {}
|
|
@@ -30876,25 +31553,37 @@ export interface Routes {
|
|
|
30876
31553
|
is_temporary_manual_override_active?: boolean | undefined
|
|
30877
31554
|
current_climate_setting?:
|
|
30878
31555
|
| {
|
|
31556
|
+
/** Unique key to identify the climate preset. */
|
|
30879
31557
|
climate_preset_key?: string | undefined
|
|
31558
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
30880
31559
|
can_edit?: boolean | undefined
|
|
31560
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
30881
31561
|
can_delete?: boolean | undefined
|
|
31562
|
+
/** User-friendly name to identify the climate preset. */
|
|
30882
31563
|
name?: ((string | null) | undefined) | undefined
|
|
31564
|
+
/** Display name for the climate preset. */
|
|
30883
31565
|
display_name?: string | undefined
|
|
31566
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
30884
31567
|
fan_mode_setting?:
|
|
30885
31568
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
30886
31569
|
| undefined
|
|
31570
|
+
/** 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`. */
|
|
30887
31571
|
hvac_mode_setting?:
|
|
30888
31572
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
30889
31573
|
| undefined
|
|
31574
|
+
/** 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). */
|
|
30890
31575
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
31576
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
30891
31577
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
31578
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
30892
31579
|
cooling_set_point_fahrenheit?:
|
|
30893
31580
|
| (number | undefined)
|
|
30894
31581
|
| undefined
|
|
31582
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
30895
31583
|
heating_set_point_fahrenheit?:
|
|
30896
31584
|
| (number | undefined)
|
|
30897
31585
|
| undefined
|
|
31586
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
30898
31587
|
manual_override_allowed?: boolean | undefined
|
|
30899
31588
|
}
|
|
30900
31589
|
| undefined
|
|
@@ -30902,58 +31591,91 @@ export interface Routes {
|
|
|
30902
31591
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
30903
31592
|
default_climate_setting?:
|
|
30904
31593
|
| {
|
|
31594
|
+
/** Unique key to identify the climate preset. */
|
|
30905
31595
|
climate_preset_key?: string | undefined
|
|
31596
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
30906
31597
|
can_edit?: boolean | undefined
|
|
31598
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
30907
31599
|
can_delete?: boolean | undefined
|
|
31600
|
+
/** User-friendly name to identify the climate preset. */
|
|
30908
31601
|
name?: ((string | null) | undefined) | undefined
|
|
31602
|
+
/** Display name for the climate preset. */
|
|
30909
31603
|
display_name?: string | undefined
|
|
31604
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
30910
31605
|
fan_mode_setting?:
|
|
30911
31606
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
30912
31607
|
| undefined
|
|
31608
|
+
/** 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`. */
|
|
30913
31609
|
hvac_mode_setting?:
|
|
30914
31610
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
30915
31611
|
| undefined
|
|
31612
|
+
/** 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). */
|
|
30916
31613
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
31614
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
30917
31615
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
31616
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
30918
31617
|
cooling_set_point_fahrenheit?:
|
|
30919
31618
|
| (number | undefined)
|
|
30920
31619
|
| undefined
|
|
31620
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
30921
31621
|
heating_set_point_fahrenheit?:
|
|
30922
31622
|
| (number | undefined)
|
|
30923
31623
|
| undefined
|
|
31624
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
30924
31625
|
manual_override_allowed?: boolean | undefined
|
|
30925
31626
|
}
|
|
30926
31627
|
| undefined
|
|
30927
31628
|
available_climate_presets?:
|
|
30928
31629
|
| Array<{
|
|
31630
|
+
/** Unique key to identify the climate preset. */
|
|
30929
31631
|
climate_preset_key: string
|
|
31632
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
30930
31633
|
can_edit: boolean
|
|
31634
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
30931
31635
|
can_delete: boolean
|
|
31636
|
+
/** User-friendly name to identify the climate preset. */
|
|
30932
31637
|
name?: (string | null) | undefined
|
|
31638
|
+
/** Display name for the climate preset. */
|
|
30933
31639
|
display_name: string
|
|
31640
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
30934
31641
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
31642
|
+
/** 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`. */
|
|
30935
31643
|
hvac_mode_setting?:
|
|
30936
31644
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
30937
31645
|
| undefined
|
|
31646
|
+
/** 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). */
|
|
30938
31647
|
cooling_set_point_celsius?: number | undefined
|
|
31648
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
30939
31649
|
heating_set_point_celsius?: number | undefined
|
|
31650
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
30940
31651
|
cooling_set_point_fahrenheit?: number | undefined
|
|
31652
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
30941
31653
|
heating_set_point_fahrenheit?: number | undefined
|
|
31654
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
30942
31655
|
manual_override_allowed: boolean
|
|
30943
31656
|
}>
|
|
30944
31657
|
| undefined
|
|
30945
31658
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
31659
|
+
/** 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. */
|
|
30946
31660
|
active_thermostat_schedule?:
|
|
30947
31661
|
| ({
|
|
31662
|
+
/** ID of the thermostat schedule. */
|
|
30948
31663
|
thermostat_schedule_id: string
|
|
31664
|
+
/** ID of the desired thermostat device. */
|
|
30949
31665
|
device_id: string
|
|
31666
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
30950
31667
|
name?: string | undefined
|
|
31668
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
30951
31669
|
climate_preset_key: string
|
|
31670
|
+
/** 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). */
|
|
30952
31671
|
max_override_period_minutes: number
|
|
31672
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
30953
31673
|
starts_at: string
|
|
31674
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
30954
31675
|
ends_at: string
|
|
31676
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
30955
31677
|
created_at: string
|
|
30956
|
-
/**
|
|
31678
|
+
/** 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. */
|
|
30957
31679
|
errors?: any
|
|
30958
31680
|
} | null)
|
|
30959
31681
|
| undefined
|
|
@@ -31524,25 +32246,37 @@ export interface Routes {
|
|
|
31524
32246
|
is_temporary_manual_override_active?: boolean | undefined
|
|
31525
32247
|
current_climate_setting?:
|
|
31526
32248
|
| {
|
|
32249
|
+
/** Unique key to identify the climate preset. */
|
|
31527
32250
|
climate_preset_key?: string | undefined
|
|
32251
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
31528
32252
|
can_edit?: boolean | undefined
|
|
32253
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
31529
32254
|
can_delete?: boolean | undefined
|
|
32255
|
+
/** User-friendly name to identify the climate preset. */
|
|
31530
32256
|
name?: ((string | null) | undefined) | undefined
|
|
32257
|
+
/** Display name for the climate preset. */
|
|
31531
32258
|
display_name?: string | undefined
|
|
32259
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
31532
32260
|
fan_mode_setting?:
|
|
31533
32261
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
31534
32262
|
| undefined
|
|
32263
|
+
/** 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`. */
|
|
31535
32264
|
hvac_mode_setting?:
|
|
31536
32265
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
31537
32266
|
| undefined
|
|
32267
|
+
/** 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). */
|
|
31538
32268
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
32269
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
31539
32270
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
32271
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
31540
32272
|
cooling_set_point_fahrenheit?:
|
|
31541
32273
|
| (number | undefined)
|
|
31542
32274
|
| undefined
|
|
32275
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
31543
32276
|
heating_set_point_fahrenheit?:
|
|
31544
32277
|
| (number | undefined)
|
|
31545
32278
|
| undefined
|
|
32279
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
31546
32280
|
manual_override_allowed?: boolean | undefined
|
|
31547
32281
|
}
|
|
31548
32282
|
| undefined
|
|
@@ -31550,58 +32284,91 @@ export interface Routes {
|
|
|
31550
32284
|
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
31551
32285
|
default_climate_setting?:
|
|
31552
32286
|
| {
|
|
32287
|
+
/** Unique key to identify the climate preset. */
|
|
31553
32288
|
climate_preset_key?: string | undefined
|
|
32289
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
31554
32290
|
can_edit?: boolean | undefined
|
|
32291
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
31555
32292
|
can_delete?: boolean | undefined
|
|
32293
|
+
/** User-friendly name to identify the climate preset. */
|
|
31556
32294
|
name?: ((string | null) | undefined) | undefined
|
|
32295
|
+
/** Display name for the climate preset. */
|
|
31557
32296
|
display_name?: string | undefined
|
|
32297
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
31558
32298
|
fan_mode_setting?:
|
|
31559
32299
|
| (('auto' | 'on' | 'circulate') | undefined)
|
|
31560
32300
|
| undefined
|
|
32301
|
+
/** 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`. */
|
|
31561
32302
|
hvac_mode_setting?:
|
|
31562
32303
|
| (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
|
|
31563
32304
|
| undefined
|
|
32305
|
+
/** 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). */
|
|
31564
32306
|
cooling_set_point_celsius?: (number | undefined) | undefined
|
|
32307
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
31565
32308
|
heating_set_point_celsius?: (number | undefined) | undefined
|
|
32309
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
31566
32310
|
cooling_set_point_fahrenheit?:
|
|
31567
32311
|
| (number | undefined)
|
|
31568
32312
|
| undefined
|
|
32313
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
31569
32314
|
heating_set_point_fahrenheit?:
|
|
31570
32315
|
| (number | undefined)
|
|
31571
32316
|
| undefined
|
|
32317
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
31572
32318
|
manual_override_allowed?: boolean | undefined
|
|
31573
32319
|
}
|
|
31574
32320
|
| undefined
|
|
31575
32321
|
available_climate_presets?:
|
|
31576
32322
|
| Array<{
|
|
32323
|
+
/** Unique key to identify the climate preset. */
|
|
31577
32324
|
climate_preset_key: string
|
|
32325
|
+
/** Indicates whether this climate preset key can be edited. */
|
|
31578
32326
|
can_edit: boolean
|
|
32327
|
+
/** Indicates whether this climate preset key can be deleted. */
|
|
31579
32328
|
can_delete: boolean
|
|
32329
|
+
/** User-friendly name to identify the climate preset. */
|
|
31580
32330
|
name?: (string | null) | undefined
|
|
32331
|
+
/** Display name for the climate preset. */
|
|
31581
32332
|
display_name: string
|
|
32333
|
+
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
31582
32334
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
|
|
32335
|
+
/** 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`. */
|
|
31583
32336
|
hvac_mode_setting?:
|
|
31584
32337
|
| ('off' | 'heat' | 'cool' | 'heat_cool')
|
|
31585
32338
|
| undefined
|
|
32339
|
+
/** 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). */
|
|
31586
32340
|
cooling_set_point_celsius?: number | undefined
|
|
32341
|
+
/** Temperature to which the thermostat should heat (in °C). */
|
|
31587
32342
|
heating_set_point_celsius?: number | undefined
|
|
32343
|
+
/** Temperature to which the thermostat should cool (in °F). */
|
|
31588
32344
|
cooling_set_point_fahrenheit?: number | undefined
|
|
32345
|
+
/** Temperature to which the thermostat should heat (in °F). */
|
|
31589
32346
|
heating_set_point_fahrenheit?: number | undefined
|
|
32347
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
31590
32348
|
manual_override_allowed: boolean
|
|
31591
32349
|
}>
|
|
31592
32350
|
| undefined
|
|
31593
32351
|
fallback_climate_preset_key?: (string | null) | undefined
|
|
32352
|
+
/** 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. */
|
|
31594
32353
|
active_thermostat_schedule?:
|
|
31595
32354
|
| ({
|
|
32355
|
+
/** ID of the thermostat schedule. */
|
|
31596
32356
|
thermostat_schedule_id: string
|
|
32357
|
+
/** ID of the desired thermostat device. */
|
|
31597
32358
|
device_id: string
|
|
32359
|
+
/** User-friendly name to identify the thermostat schedule. */
|
|
31598
32360
|
name?: string | undefined
|
|
32361
|
+
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
31599
32362
|
climate_preset_key: string
|
|
32363
|
+
/** 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). */
|
|
31600
32364
|
max_override_period_minutes: number
|
|
32365
|
+
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
31601
32366
|
starts_at: string
|
|
32367
|
+
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
31602
32368
|
ends_at: string
|
|
32369
|
+
/** Date and time at which the thermostat schedule was created. */
|
|
31603
32370
|
created_at: string
|
|
31604
|
-
/**
|
|
32371
|
+
/** 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. */
|
|
31605
32372
|
errors?: any
|
|
31606
32373
|
} | null)
|
|
31607
32374
|
| undefined
|