@seamapi/http 2.31.0 → 2.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +6 -6
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +6 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [device](https://
|
|
7
|
+
* Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
8
8
|
*/
|
|
9
9
|
export type Device = {
|
|
10
10
|
/**
|
|
@@ -88,7 +88,7 @@ export type Device = {
|
|
|
88
88
|
*/
|
|
89
89
|
can_unlock_with_code?: boolean | undefined
|
|
90
90
|
/**
|
|
91
|
-
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://
|
|
91
|
+
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
92
92
|
*/
|
|
93
93
|
capabilities_supported: Array<
|
|
94
94
|
| 'access_code'
|
|
@@ -110,7 +110,7 @@ export type Device = {
|
|
|
110
110
|
created_at: string
|
|
111
111
|
|
|
112
112
|
/**
|
|
113
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
113
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
114
114
|
*/
|
|
115
115
|
custom_metadata: Record<string, string | boolean>
|
|
116
116
|
|
|
@@ -211,6 +211,7 @@ export type Device = {
|
|
|
211
211
|
| 'ios_phone'
|
|
212
212
|
| 'android_phone'
|
|
213
213
|
| 'ring_camera'
|
|
214
|
+
| 'tapo_camera'
|
|
214
215
|
|
|
215
216
|
/**
|
|
216
217
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
@@ -236,7 +237,7 @@ export type Device = {
|
|
|
236
237
|
error_code: 'account_disconnected'
|
|
237
238
|
|
|
238
239
|
/**
|
|
239
|
-
* Indicates that the error is a [connected account](https://
|
|
240
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
240
241
|
*/
|
|
241
242
|
is_connected_account_error: true
|
|
242
243
|
|
|
@@ -264,7 +265,7 @@ export type Device = {
|
|
|
264
265
|
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
265
266
|
|
|
266
267
|
/**
|
|
267
|
-
* Indicates that the error is a [connected account](https://
|
|
268
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
268
269
|
*/
|
|
269
270
|
is_connected_account_error: true
|
|
270
271
|
|
|
@@ -292,7 +293,7 @@ export type Device = {
|
|
|
292
293
|
error_code: 'insufficient_permissions'
|
|
293
294
|
|
|
294
295
|
/**
|
|
295
|
-
* Indicates that the error is a [connected account](https://
|
|
296
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
296
297
|
*/
|
|
297
298
|
is_connected_account_error: true
|
|
298
299
|
|
|
@@ -320,7 +321,7 @@ export type Device = {
|
|
|
320
321
|
error_code: 'dormakaba_sites_disconnected'
|
|
321
322
|
|
|
322
323
|
/**
|
|
323
|
-
* Indicates that the error is a [connected account](https://
|
|
324
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
324
325
|
*/
|
|
325
326
|
is_connected_account_error: true
|
|
326
327
|
|
|
@@ -426,7 +427,7 @@ export type Device = {
|
|
|
426
427
|
*/
|
|
427
428
|
message: string
|
|
428
429
|
} /**
|
|
429
|
-
* Indicates that the [backup access code pool](https://
|
|
430
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
430
431
|
*/
|
|
431
432
|
| {
|
|
432
433
|
/**
|
|
@@ -541,7 +542,7 @@ export type Device = {
|
|
|
541
542
|
*/
|
|
542
543
|
message: string
|
|
543
544
|
} /**
|
|
544
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
545
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
545
546
|
*/
|
|
546
547
|
| {
|
|
547
548
|
/**
|
|
@@ -555,7 +556,7 @@ export type Device = {
|
|
|
555
556
|
error_code: 'bridge_disconnected'
|
|
556
557
|
|
|
557
558
|
/**
|
|
558
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
559
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
559
560
|
*/
|
|
560
561
|
is_bridge_error?: boolean | undefined
|
|
561
562
|
/**
|
|
@@ -570,7 +571,7 @@ export type Device = {
|
|
|
570
571
|
>
|
|
571
572
|
|
|
572
573
|
/**
|
|
573
|
-
* Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://
|
|
574
|
+
* Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
574
575
|
*/
|
|
575
576
|
is_managed: true
|
|
576
577
|
|
|
@@ -1791,6 +1792,25 @@ export type Device = {
|
|
|
1791
1792
|
serial_no?: string | undefined
|
|
1792
1793
|
}
|
|
1793
1794
|
| undefined
|
|
1795
|
+
/**
|
|
1796
|
+
* Metadata for a Tapo camera.
|
|
1797
|
+
*/
|
|
1798
|
+
tapo_metadata?:
|
|
1799
|
+
| {
|
|
1800
|
+
/**
|
|
1801
|
+
* Firmware version reported by the camera.
|
|
1802
|
+
*/
|
|
1803
|
+
firmware_version?: string | undefined
|
|
1804
|
+
/**
|
|
1805
|
+
* Hardware version reported by the camera.
|
|
1806
|
+
*/
|
|
1807
|
+
hardware_version?: string | undefined
|
|
1808
|
+
/**
|
|
1809
|
+
* Model reported by the Tapo camera.
|
|
1810
|
+
*/
|
|
1811
|
+
model?: string | undefined
|
|
1812
|
+
}
|
|
1813
|
+
| undefined
|
|
1794
1814
|
/**
|
|
1795
1815
|
* Metadata for a Tedee device.
|
|
1796
1816
|
*/
|
|
@@ -2023,7 +2043,7 @@ export type Device = {
|
|
|
2023
2043
|
*/
|
|
2024
2044
|
auto_lock_enabled?: boolean | undefined
|
|
2025
2045
|
/**
|
|
2026
|
-
* Indicates whether the [backup access code pool](https://
|
|
2046
|
+
* Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update).
|
|
2027
2047
|
*/
|
|
2028
2048
|
backup_access_code_pool_enabled?: boolean | undefined
|
|
2029
2049
|
/**
|
|
@@ -2203,37 +2223,37 @@ export type Device = {
|
|
|
2203
2223
|
*/
|
|
2204
2224
|
supported_code_lengths?: Array<number> | undefined
|
|
2205
2225
|
/**
|
|
2206
|
-
* Indicates whether the device supports a [backup access code pool](https://
|
|
2226
|
+
* Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
|
|
2207
2227
|
*/
|
|
2208
2228
|
supports_backup_access_code_pool?: boolean | undefined
|
|
2209
2229
|
/**
|
|
2210
|
-
* Active [thermostat schedule](https://
|
|
2230
|
+
* Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2211
2231
|
* @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
|
|
2212
2232
|
*/
|
|
2213
2233
|
active_thermostat_schedule?:
|
|
2214
2234
|
| {
|
|
2215
2235
|
/**
|
|
2216
|
-
* Key of the [climate preset](https://
|
|
2236
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2217
2237
|
*/
|
|
2218
2238
|
climate_preset_key: string
|
|
2219
2239
|
|
|
2220
2240
|
/**
|
|
2221
|
-
* Date and time at which the [thermostat schedule](https://
|
|
2241
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
2222
2242
|
*/
|
|
2223
2243
|
created_at: string
|
|
2224
2244
|
|
|
2225
2245
|
/**
|
|
2226
|
-
* ID of the desired [thermostat](https://
|
|
2246
|
+
* ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
2227
2247
|
*/
|
|
2228
2248
|
device_id: string
|
|
2229
2249
|
|
|
2230
2250
|
/**
|
|
2231
|
-
* Date and time at which the [thermostat schedule](https://
|
|
2251
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
2232
2252
|
*/
|
|
2233
2253
|
ends_at: string
|
|
2234
2254
|
|
|
2235
2255
|
/**
|
|
2236
|
-
* Errors associated with the [thermostat schedule](https://
|
|
2256
|
+
* Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2237
2257
|
*/
|
|
2238
2258
|
errors: Array<{
|
|
2239
2259
|
/**
|
|
@@ -2253,24 +2273,24 @@ export type Device = {
|
|
|
2253
2273
|
}>
|
|
2254
2274
|
|
|
2255
2275
|
/**
|
|
2256
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
2276
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
|
|
2257
2277
|
*/
|
|
2258
2278
|
is_override_allowed?: boolean | undefined
|
|
2259
2279
|
/**
|
|
2260
|
-
* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://
|
|
2280
|
+
* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
2261
2281
|
*/
|
|
2262
2282
|
max_override_period_minutes?: number | null | undefined
|
|
2263
2283
|
/**
|
|
2264
|
-
* User-friendly name to identify the [thermostat schedule](https://
|
|
2284
|
+
* User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2265
2285
|
*/
|
|
2266
2286
|
name: string | null
|
|
2267
2287
|
/**
|
|
2268
|
-
* Date and time at which the [thermostat schedule](https://
|
|
2288
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
2269
2289
|
*/
|
|
2270
2290
|
starts_at: string
|
|
2271
2291
|
|
|
2272
2292
|
/**
|
|
2273
|
-
* ID of the [thermostat schedule](https://
|
|
2293
|
+
* ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2274
2294
|
*/
|
|
2275
2295
|
thermostat_schedule_id: string
|
|
2276
2296
|
|
|
@@ -2282,7 +2302,7 @@ export type Device = {
|
|
|
2282
2302
|
| null
|
|
2283
2303
|
| undefined
|
|
2284
2304
|
/**
|
|
2285
|
-
* ID of the active [thermostat schedule](https://
|
|
2305
|
+
* ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2286
2306
|
*/
|
|
2287
2307
|
active_thermostat_schedule_id?: string | null | undefined
|
|
2288
2308
|
/**
|
|
@@ -2292,27 +2312,27 @@ export type Device = {
|
|
|
2292
2312
|
| Array<'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied'>
|
|
2293
2313
|
| undefined
|
|
2294
2314
|
/**
|
|
2295
|
-
* Available [climate presets](https://
|
|
2315
|
+
* Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
2296
2316
|
*/
|
|
2297
2317
|
available_climate_presets?:
|
|
2298
2318
|
| Array<{
|
|
2299
2319
|
/**
|
|
2300
|
-
* Indicates whether the [climate preset](https://
|
|
2320
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2301
2321
|
*/
|
|
2302
2322
|
can_delete: boolean
|
|
2303
2323
|
|
|
2304
2324
|
/**
|
|
2305
|
-
* Indicates whether the [climate preset](https://
|
|
2325
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2306
2326
|
*/
|
|
2307
2327
|
can_edit: boolean
|
|
2308
2328
|
|
|
2309
2329
|
/**
|
|
2310
|
-
* Indicates whether the [climate preset](https://
|
|
2330
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
2311
2331
|
*/
|
|
2312
2332
|
can_use_with_thermostat_daily_programs: boolean
|
|
2313
2333
|
|
|
2314
2334
|
/**
|
|
2315
|
-
* Unique key to identify the [climate preset](https://
|
|
2335
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2316
2336
|
*/
|
|
2317
2337
|
climate_preset_key: string
|
|
2318
2338
|
|
|
@@ -2328,15 +2348,15 @@ export type Device = {
|
|
|
2328
2348
|
| 'unoccupied'
|
|
2329
2349
|
| undefined
|
|
2330
2350
|
/**
|
|
2331
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2351
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2332
2352
|
*/
|
|
2333
2353
|
cooling_set_point_celsius?: number | undefined
|
|
2334
2354
|
/**
|
|
2335
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2355
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2336
2356
|
*/
|
|
2337
2357
|
cooling_set_point_fahrenheit?: number | undefined
|
|
2338
2358
|
/**
|
|
2339
|
-
* Display name for the [climate preset](https://
|
|
2359
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2340
2360
|
*/
|
|
2341
2361
|
display_name: string
|
|
2342
2362
|
|
|
@@ -2360,30 +2380,30 @@ export type Device = {
|
|
|
2360
2380
|
}
|
|
2361
2381
|
| undefined
|
|
2362
2382
|
/**
|
|
2363
|
-
* Desired [fan mode setting](https://
|
|
2383
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
2364
2384
|
*/
|
|
2365
2385
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
|
|
2366
2386
|
/**
|
|
2367
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2387
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2368
2388
|
*/
|
|
2369
2389
|
heating_set_point_celsius?: number | undefined
|
|
2370
2390
|
/**
|
|
2371
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2391
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2372
2392
|
*/
|
|
2373
2393
|
heating_set_point_fahrenheit?: number | undefined
|
|
2374
2394
|
/**
|
|
2375
|
-
* Desired [HVAC mode](https://
|
|
2395
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
2376
2396
|
*/
|
|
2377
2397
|
hvac_mode_setting?:
|
|
2378
2398
|
'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
|
|
2379
2399
|
/**
|
|
2380
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2400
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
2381
2401
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2382
2402
|
*/
|
|
2383
2403
|
manual_override_allowed: boolean
|
|
2384
2404
|
|
|
2385
2405
|
/**
|
|
2386
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2406
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2387
2407
|
*/
|
|
2388
2408
|
name?: string | null | undefined
|
|
2389
2409
|
}>
|
|
@@ -2403,19 +2423,19 @@ export type Device = {
|
|
|
2403
2423
|
current_climate_setting?:
|
|
2404
2424
|
| {
|
|
2405
2425
|
/**
|
|
2406
|
-
* Indicates whether the [climate preset](https://
|
|
2426
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2407
2427
|
*/
|
|
2408
2428
|
can_delete?: boolean | undefined
|
|
2409
2429
|
/**
|
|
2410
|
-
* Indicates whether the [climate preset](https://
|
|
2430
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2411
2431
|
*/
|
|
2412
2432
|
can_edit?: boolean | undefined
|
|
2413
2433
|
/**
|
|
2414
|
-
* Indicates whether the [climate preset](https://
|
|
2434
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
2415
2435
|
*/
|
|
2416
2436
|
can_use_with_thermostat_daily_programs?: boolean | undefined
|
|
2417
2437
|
/**
|
|
2418
|
-
* Unique key to identify the [climate preset](https://
|
|
2438
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2419
2439
|
*/
|
|
2420
2440
|
climate_preset_key?: string | undefined
|
|
2421
2441
|
/**
|
|
@@ -2430,15 +2450,15 @@ export type Device = {
|
|
|
2430
2450
|
| 'unoccupied'
|
|
2431
2451
|
| undefined
|
|
2432
2452
|
/**
|
|
2433
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2453
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2434
2454
|
*/
|
|
2435
2455
|
cooling_set_point_celsius?: number | undefined
|
|
2436
2456
|
/**
|
|
2437
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2457
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2438
2458
|
*/
|
|
2439
2459
|
cooling_set_point_fahrenheit?: number | undefined
|
|
2440
2460
|
/**
|
|
2441
|
-
* Display name for the [climate preset](https://
|
|
2461
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2442
2462
|
*/
|
|
2443
2463
|
display_name?: string | undefined
|
|
2444
2464
|
/**
|
|
@@ -2461,29 +2481,29 @@ export type Device = {
|
|
|
2461
2481
|
}
|
|
2462
2482
|
| undefined
|
|
2463
2483
|
/**
|
|
2464
|
-
* Desired [fan mode setting](https://
|
|
2484
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
2465
2485
|
*/
|
|
2466
2486
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
|
|
2467
2487
|
/**
|
|
2468
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2488
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2469
2489
|
*/
|
|
2470
2490
|
heating_set_point_celsius?: number | undefined
|
|
2471
2491
|
/**
|
|
2472
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2492
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2473
2493
|
*/
|
|
2474
2494
|
heating_set_point_fahrenheit?: number | undefined
|
|
2475
2495
|
/**
|
|
2476
|
-
* Desired [HVAC mode](https://
|
|
2496
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
2477
2497
|
*/
|
|
2478
2498
|
hvac_mode_setting?:
|
|
2479
2499
|
'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
|
|
2480
2500
|
/**
|
|
2481
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2501
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
2482
2502
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2483
2503
|
*/
|
|
2484
2504
|
manual_override_allowed?: boolean | undefined
|
|
2485
2505
|
/**
|
|
2486
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2506
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2487
2507
|
*/
|
|
2488
2508
|
name?: string | null | undefined
|
|
2489
2509
|
}
|
|
@@ -2494,19 +2514,19 @@ export type Device = {
|
|
|
2494
2514
|
default_climate_setting?:
|
|
2495
2515
|
| {
|
|
2496
2516
|
/**
|
|
2497
|
-
* Indicates whether the [climate preset](https://
|
|
2517
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2498
2518
|
*/
|
|
2499
2519
|
can_delete?: boolean | undefined
|
|
2500
2520
|
/**
|
|
2501
|
-
* Indicates whether the [climate preset](https://
|
|
2521
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2502
2522
|
*/
|
|
2503
2523
|
can_edit?: boolean | undefined
|
|
2504
2524
|
/**
|
|
2505
|
-
* Indicates whether the [climate preset](https://
|
|
2525
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
2506
2526
|
*/
|
|
2507
2527
|
can_use_with_thermostat_daily_programs?: boolean | undefined
|
|
2508
2528
|
/**
|
|
2509
|
-
* Unique key to identify the [climate preset](https://
|
|
2529
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2510
2530
|
*/
|
|
2511
2531
|
climate_preset_key?: string | undefined
|
|
2512
2532
|
/**
|
|
@@ -2521,15 +2541,15 @@ export type Device = {
|
|
|
2521
2541
|
| 'unoccupied'
|
|
2522
2542
|
| undefined
|
|
2523
2543
|
/**
|
|
2524
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2544
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2525
2545
|
*/
|
|
2526
2546
|
cooling_set_point_celsius?: number | undefined
|
|
2527
2547
|
/**
|
|
2528
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2548
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2529
2549
|
*/
|
|
2530
2550
|
cooling_set_point_fahrenheit?: number | undefined
|
|
2531
2551
|
/**
|
|
2532
|
-
* Display name for the [climate preset](https://
|
|
2552
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2533
2553
|
*/
|
|
2534
2554
|
display_name?: string | undefined
|
|
2535
2555
|
/**
|
|
@@ -2552,35 +2572,35 @@ export type Device = {
|
|
|
2552
2572
|
}
|
|
2553
2573
|
| undefined
|
|
2554
2574
|
/**
|
|
2555
|
-
* Desired [fan mode setting](https://
|
|
2575
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
2556
2576
|
*/
|
|
2557
2577
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined
|
|
2558
2578
|
/**
|
|
2559
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2579
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2560
2580
|
*/
|
|
2561
2581
|
heating_set_point_celsius?: number | undefined
|
|
2562
2582
|
/**
|
|
2563
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2583
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
2564
2584
|
*/
|
|
2565
2585
|
heating_set_point_fahrenheit?: number | undefined
|
|
2566
2586
|
/**
|
|
2567
|
-
* Desired [HVAC mode](https://
|
|
2587
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
2568
2588
|
*/
|
|
2569
2589
|
hvac_mode_setting?:
|
|
2570
2590
|
'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined
|
|
2571
2591
|
/**
|
|
2572
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2592
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
2573
2593
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2574
2594
|
*/
|
|
2575
2595
|
manual_override_allowed?: boolean | undefined
|
|
2576
2596
|
/**
|
|
2577
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2597
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2578
2598
|
*/
|
|
2579
2599
|
name?: string | null | undefined
|
|
2580
2600
|
}
|
|
2581
2601
|
| undefined
|
|
2582
2602
|
/**
|
|
2583
|
-
* Key of the [fallback climate preset](https://
|
|
2603
|
+
* Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
|
|
2584
2604
|
*/
|
|
2585
2605
|
fallback_climate_preset_key?: string | null | undefined
|
|
2586
2606
|
/**
|
|
@@ -2604,19 +2624,19 @@ export type Device = {
|
|
|
2604
2624
|
*/
|
|
2605
2625
|
is_temporary_manual_override_active?: boolean | undefined
|
|
2606
2626
|
/**
|
|
2607
|
-
* Maximum [cooling set point](https://
|
|
2627
|
+
* Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2608
2628
|
*/
|
|
2609
2629
|
max_cooling_set_point_celsius?: number | undefined
|
|
2610
2630
|
/**
|
|
2611
|
-
* Maximum [cooling set point](https://
|
|
2631
|
+
* Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2612
2632
|
*/
|
|
2613
2633
|
max_cooling_set_point_fahrenheit?: number | undefined
|
|
2614
2634
|
/**
|
|
2615
|
-
* Maximum [heating set point](https://
|
|
2635
|
+
* Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2616
2636
|
*/
|
|
2617
2637
|
max_heating_set_point_celsius?: number | undefined
|
|
2618
2638
|
/**
|
|
2619
|
-
* Maximum [heating set point](https://
|
|
2639
|
+
* Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2620
2640
|
*/
|
|
2621
2641
|
max_heating_set_point_fahrenheit?: number | undefined
|
|
2622
2642
|
/**
|
|
@@ -2629,27 +2649,27 @@ export type Device = {
|
|
|
2629
2649
|
max_unique_climate_presets_per_thermostat_weekly_program?:
|
|
2630
2650
|
number | undefined
|
|
2631
2651
|
/**
|
|
2632
|
-
* Minimum [cooling set point](https://
|
|
2652
|
+
* Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2633
2653
|
*/
|
|
2634
2654
|
min_cooling_set_point_celsius?: number | undefined
|
|
2635
2655
|
/**
|
|
2636
|
-
* Minimum [cooling set point](https://
|
|
2656
|
+
* Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2637
2657
|
*/
|
|
2638
2658
|
min_cooling_set_point_fahrenheit?: number | undefined
|
|
2639
2659
|
/**
|
|
2640
|
-
* Minimum [temperature difference](https://
|
|
2660
|
+
* Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.
|
|
2641
2661
|
*/
|
|
2642
2662
|
min_heating_cooling_delta_celsius?: number | undefined
|
|
2643
2663
|
/**
|
|
2644
|
-
* Minimum [temperature difference](https://
|
|
2664
|
+
* Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.
|
|
2645
2665
|
*/
|
|
2646
2666
|
min_heating_cooling_delta_fahrenheit?: number | undefined
|
|
2647
2667
|
/**
|
|
2648
|
-
* Minimum [heating set point](https://
|
|
2668
|
+
* Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2649
2669
|
*/
|
|
2650
2670
|
min_heating_set_point_celsius?: number | undefined
|
|
2651
2671
|
/**
|
|
2652
|
-
* Minimum [heating set point](https://
|
|
2672
|
+
* Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2653
2673
|
*/
|
|
2654
2674
|
min_heating_set_point_fahrenheit?: number | undefined
|
|
2655
2675
|
/**
|
|
@@ -2665,24 +2685,24 @@ export type Device = {
|
|
|
2665
2685
|
*/
|
|
2666
2686
|
temperature_fahrenheit?: number | undefined
|
|
2667
2687
|
/**
|
|
2668
|
-
* Current [temperature threshold](https://
|
|
2688
|
+
* Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2669
2689
|
*/
|
|
2670
2690
|
temperature_threshold?:
|
|
2671
2691
|
| {
|
|
2672
2692
|
/**
|
|
2673
|
-
* Lower limit in °C within the current [temperature threshold](https://
|
|
2693
|
+
* Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2674
2694
|
*/
|
|
2675
2695
|
lower_limit_celsius: number | null
|
|
2676
2696
|
/**
|
|
2677
|
-
* Lower limit in °F within the current [temperature threshold](https://
|
|
2697
|
+
* Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2678
2698
|
*/
|
|
2679
2699
|
lower_limit_fahrenheit: number | null
|
|
2680
2700
|
/**
|
|
2681
|
-
* Upper limit in °C within the current [temperature threshold](https://
|
|
2701
|
+
* Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2682
2702
|
*/
|
|
2683
2703
|
upper_limit_celsius: number | null
|
|
2684
2704
|
/**
|
|
2685
|
-
* Upper limit in °F within the current [temperature threshold](https://
|
|
2705
|
+
* Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2686
2706
|
*/
|
|
2687
2707
|
upper_limit_fahrenheit: number | null
|
|
2688
2708
|
}
|
|
@@ -2692,7 +2712,7 @@ export type Device = {
|
|
|
2692
2712
|
*/
|
|
2693
2713
|
thermostat_daily_program_period_precision_minutes?: number | undefined
|
|
2694
2714
|
/**
|
|
2695
|
-
* Configured [daily programs](https://
|
|
2715
|
+
* Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
2696
2716
|
*/
|
|
2697
2717
|
thermostat_daily_programs?:
|
|
2698
2718
|
| Array<{
|
|
@@ -2715,7 +2735,7 @@ export type Device = {
|
|
|
2715
2735
|
*/
|
|
2716
2736
|
periods: Array<{
|
|
2717
2737
|
/**
|
|
2718
|
-
* Key of the [climate preset](https://
|
|
2738
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
|
|
2719
2739
|
*/
|
|
2720
2740
|
climate_preset_key: string
|
|
2721
2741
|
|
|
@@ -2737,7 +2757,7 @@ export type Device = {
|
|
|
2737
2757
|
}>
|
|
2738
2758
|
| undefined
|
|
2739
2759
|
/**
|
|
2740
|
-
* Current [weekly program](https://
|
|
2760
|
+
* Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
2741
2761
|
*/
|
|
2742
2762
|
thermostat_weekly_program?:
|
|
2743
2763
|
| {
|