@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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [device](https://
|
|
2
|
+
* Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
3
3
|
*/
|
|
4
4
|
export type Device = {
|
|
5
5
|
/**
|
|
@@ -83,7 +83,7 @@ export type Device = {
|
|
|
83
83
|
*/
|
|
84
84
|
can_unlock_with_code?: boolean | undefined;
|
|
85
85
|
/**
|
|
86
|
-
* 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://
|
|
86
|
+
* 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).
|
|
87
87
|
*/
|
|
88
88
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
89
89
|
/**
|
|
@@ -95,7 +95,7 @@ export type Device = {
|
|
|
95
95
|
*/
|
|
96
96
|
created_at: string;
|
|
97
97
|
/**
|
|
98
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
98
|
+
* 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.
|
|
99
99
|
*/
|
|
100
100
|
custom_metadata: Record<string, string | boolean>;
|
|
101
101
|
/**
|
|
@@ -143,7 +143,7 @@ export type Device = {
|
|
|
143
143
|
/**
|
|
144
144
|
* Type of the device.
|
|
145
145
|
*/
|
|
146
|
-
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera';
|
|
146
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera';
|
|
147
147
|
/**
|
|
148
148
|
* 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.
|
|
149
149
|
*/
|
|
@@ -165,7 +165,7 @@ export type Device = {
|
|
|
165
165
|
*/
|
|
166
166
|
error_code: 'account_disconnected';
|
|
167
167
|
/**
|
|
168
|
-
* Indicates that the error is a [connected account](https://
|
|
168
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
169
169
|
*/
|
|
170
170
|
is_connected_account_error: true;
|
|
171
171
|
/**
|
|
@@ -188,7 +188,7 @@ export type Device = {
|
|
|
188
188
|
*/
|
|
189
189
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
190
190
|
/**
|
|
191
|
-
* Indicates that the error is a [connected account](https://
|
|
191
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
192
192
|
*/
|
|
193
193
|
is_connected_account_error: true;
|
|
194
194
|
/**
|
|
@@ -211,7 +211,7 @@ export type Device = {
|
|
|
211
211
|
*/
|
|
212
212
|
error_code: 'insufficient_permissions';
|
|
213
213
|
/**
|
|
214
|
-
* Indicates that the error is a [connected account](https://
|
|
214
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
215
215
|
*/
|
|
216
216
|
is_connected_account_error: true;
|
|
217
217
|
/**
|
|
@@ -234,7 +234,7 @@ export type Device = {
|
|
|
234
234
|
*/
|
|
235
235
|
error_code: 'dormakaba_sites_disconnected';
|
|
236
236
|
/**
|
|
237
|
-
* Indicates that the error is a [connected account](https://
|
|
237
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
238
238
|
*/
|
|
239
239
|
is_connected_account_error: true;
|
|
240
240
|
/**
|
|
@@ -322,7 +322,7 @@ export type Device = {
|
|
|
322
322
|
*/
|
|
323
323
|
message: string;
|
|
324
324
|
} /**
|
|
325
|
-
* Indicates that the [backup access code pool](https://
|
|
325
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
326
326
|
*/ | {
|
|
327
327
|
/**
|
|
328
328
|
* Date and time at which Seam created the error.
|
|
@@ -417,7 +417,7 @@ export type Device = {
|
|
|
417
417
|
*/
|
|
418
418
|
message: string;
|
|
419
419
|
} /**
|
|
420
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
420
|
+
* 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).
|
|
421
421
|
*/ | {
|
|
422
422
|
/**
|
|
423
423
|
* Date and time at which Seam created the error.
|
|
@@ -428,7 +428,7 @@ export type Device = {
|
|
|
428
428
|
*/
|
|
429
429
|
error_code: 'bridge_disconnected';
|
|
430
430
|
/**
|
|
431
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
431
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
432
432
|
*/
|
|
433
433
|
is_bridge_error?: boolean | undefined;
|
|
434
434
|
/**
|
|
@@ -441,7 +441,7 @@ export type Device = {
|
|
|
441
441
|
message: string;
|
|
442
442
|
}>;
|
|
443
443
|
/**
|
|
444
|
-
* Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://
|
|
444
|
+
* Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
445
445
|
*/
|
|
446
446
|
is_managed: true;
|
|
447
447
|
/**
|
|
@@ -1554,6 +1554,23 @@ export type Device = {
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
serial_no?: string | undefined;
|
|
1556
1556
|
} | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* Metadata for a Tapo camera.
|
|
1559
|
+
*/
|
|
1560
|
+
tapo_metadata?: {
|
|
1561
|
+
/**
|
|
1562
|
+
* Firmware version reported by the camera.
|
|
1563
|
+
*/
|
|
1564
|
+
firmware_version?: string | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* Hardware version reported by the camera.
|
|
1567
|
+
*/
|
|
1568
|
+
hardware_version?: string | undefined;
|
|
1569
|
+
/**
|
|
1570
|
+
* Model reported by the Tapo camera.
|
|
1571
|
+
*/
|
|
1572
|
+
model?: string | undefined;
|
|
1573
|
+
} | undefined;
|
|
1557
1574
|
/**
|
|
1558
1575
|
* Metadata for a Tedee device.
|
|
1559
1576
|
*/
|
|
@@ -1768,7 +1785,7 @@ export type Device = {
|
|
|
1768
1785
|
*/
|
|
1769
1786
|
auto_lock_enabled?: boolean | undefined;
|
|
1770
1787
|
/**
|
|
1771
|
-
* Indicates whether the [backup access code pool](https://
|
|
1788
|
+
* 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).
|
|
1772
1789
|
*/
|
|
1773
1790
|
backup_access_code_pool_enabled?: boolean | undefined;
|
|
1774
1791
|
/**
|
|
@@ -1915,32 +1932,32 @@ export type Device = {
|
|
|
1915
1932
|
*/
|
|
1916
1933
|
supported_code_lengths?: Array<number> | undefined;
|
|
1917
1934
|
/**
|
|
1918
|
-
* Indicates whether the device supports a [backup access code pool](https://
|
|
1935
|
+
* 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).
|
|
1919
1936
|
*/
|
|
1920
1937
|
supports_backup_access_code_pool?: boolean | undefined;
|
|
1921
1938
|
/**
|
|
1922
|
-
* Active [thermostat schedule](https://
|
|
1939
|
+
* Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1923
1940
|
* @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
|
|
1924
1941
|
*/
|
|
1925
1942
|
active_thermostat_schedule?: {
|
|
1926
1943
|
/**
|
|
1927
|
-
* Key of the [climate preset](https://
|
|
1944
|
+
* 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).
|
|
1928
1945
|
*/
|
|
1929
1946
|
climate_preset_key: string;
|
|
1930
1947
|
/**
|
|
1931
|
-
* Date and time at which the [thermostat schedule](https://
|
|
1948
|
+
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
1932
1949
|
*/
|
|
1933
1950
|
created_at: string;
|
|
1934
1951
|
/**
|
|
1935
|
-
* ID of the desired [thermostat](https://
|
|
1952
|
+
* ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
1936
1953
|
*/
|
|
1937
1954
|
device_id: string;
|
|
1938
1955
|
/**
|
|
1939
|
-
* Date and time at which the [thermostat schedule](https://
|
|
1956
|
+
* 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.
|
|
1940
1957
|
*/
|
|
1941
1958
|
ends_at: string;
|
|
1942
1959
|
/**
|
|
1943
|
-
* Errors associated with the [thermostat schedule](https://
|
|
1960
|
+
* Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1944
1961
|
*/
|
|
1945
1962
|
errors: Array<{
|
|
1946
1963
|
/**
|
|
@@ -1957,23 +1974,23 @@ export type Device = {
|
|
|
1957
1974
|
message: string;
|
|
1958
1975
|
}>;
|
|
1959
1976
|
/**
|
|
1960
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
1977
|
+
* 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.
|
|
1961
1978
|
*/
|
|
1962
1979
|
is_override_allowed?: boolean | undefined;
|
|
1963
1980
|
/**
|
|
1964
|
-
* 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://
|
|
1981
|
+
* 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).
|
|
1965
1982
|
*/
|
|
1966
1983
|
max_override_period_minutes?: number | null | undefined;
|
|
1967
1984
|
/**
|
|
1968
|
-
* User-friendly name to identify the [thermostat schedule](https://
|
|
1985
|
+
* User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1969
1986
|
*/
|
|
1970
1987
|
name: string | null;
|
|
1971
1988
|
/**
|
|
1972
|
-
* Date and time at which the [thermostat schedule](https://
|
|
1989
|
+
* 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.
|
|
1973
1990
|
*/
|
|
1974
1991
|
starts_at: string;
|
|
1975
1992
|
/**
|
|
1976
|
-
* ID of the [thermostat schedule](https://
|
|
1993
|
+
* ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1977
1994
|
*/
|
|
1978
1995
|
thermostat_schedule_id: string;
|
|
1979
1996
|
/**
|
|
@@ -1982,7 +1999,7 @@ export type Device = {
|
|
|
1982
1999
|
workspace_id: string;
|
|
1983
2000
|
} | null | undefined;
|
|
1984
2001
|
/**
|
|
1985
|
-
* ID of the active [thermostat schedule](https://
|
|
2002
|
+
* ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1986
2003
|
*/
|
|
1987
2004
|
active_thermostat_schedule_id?: string | null | undefined;
|
|
1988
2005
|
/**
|
|
@@ -1990,23 +2007,23 @@ export type Device = {
|
|
|
1990
2007
|
*/
|
|
1991
2008
|
available_climate_preset_modes?: Array<'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied'> | undefined;
|
|
1992
2009
|
/**
|
|
1993
|
-
* Available [climate presets](https://
|
|
2010
|
+
* Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
1994
2011
|
*/
|
|
1995
2012
|
available_climate_presets?: Array<{
|
|
1996
2013
|
/**
|
|
1997
|
-
* Indicates whether the [climate preset](https://
|
|
2014
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1998
2015
|
*/
|
|
1999
2016
|
can_delete: boolean;
|
|
2000
2017
|
/**
|
|
2001
|
-
* Indicates whether the [climate preset](https://
|
|
2018
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2002
2019
|
*/
|
|
2003
2020
|
can_edit: boolean;
|
|
2004
2021
|
/**
|
|
2005
|
-
* Indicates whether the [climate preset](https://
|
|
2022
|
+
* 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.
|
|
2006
2023
|
*/
|
|
2007
2024
|
can_use_with_thermostat_daily_programs: boolean;
|
|
2008
2025
|
/**
|
|
2009
|
-
* Unique key to identify the [climate preset](https://
|
|
2026
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2010
2027
|
*/
|
|
2011
2028
|
climate_preset_key: string;
|
|
2012
2029
|
/**
|
|
@@ -2014,15 +2031,15 @@ export type Device = {
|
|
|
2014
2031
|
*/
|
|
2015
2032
|
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
2016
2033
|
/**
|
|
2017
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2034
|
+
* 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).
|
|
2018
2035
|
*/
|
|
2019
2036
|
cooling_set_point_celsius?: number | undefined;
|
|
2020
2037
|
/**
|
|
2021
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2038
|
+
* 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).
|
|
2022
2039
|
*/
|
|
2023
2040
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
2024
2041
|
/**
|
|
2025
|
-
* Display name for the [climate preset](https://
|
|
2042
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2026
2043
|
*/
|
|
2027
2044
|
display_name: string;
|
|
2028
2045
|
/**
|
|
@@ -2043,28 +2060,28 @@ export type Device = {
|
|
|
2043
2060
|
owner?: 'user' | 'system' | undefined;
|
|
2044
2061
|
} | undefined;
|
|
2045
2062
|
/**
|
|
2046
|
-
* Desired [fan mode setting](https://
|
|
2063
|
+
* 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`.
|
|
2047
2064
|
*/
|
|
2048
2065
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
2049
2066
|
/**
|
|
2050
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2067
|
+
* 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).
|
|
2051
2068
|
*/
|
|
2052
2069
|
heating_set_point_celsius?: number | undefined;
|
|
2053
2070
|
/**
|
|
2054
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2071
|
+
* 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).
|
|
2055
2072
|
*/
|
|
2056
2073
|
heating_set_point_fahrenheit?: number | undefined;
|
|
2057
2074
|
/**
|
|
2058
|
-
* Desired [HVAC mode](https://
|
|
2075
|
+
* 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`.
|
|
2059
2076
|
*/
|
|
2060
2077
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2061
2078
|
/**
|
|
2062
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2079
|
+
* 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).
|
|
2063
2080
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2064
2081
|
*/
|
|
2065
2082
|
manual_override_allowed: boolean;
|
|
2066
2083
|
/**
|
|
2067
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2084
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2068
2085
|
*/
|
|
2069
2086
|
name?: string | null | undefined;
|
|
2070
2087
|
}> | undefined;
|
|
@@ -2081,19 +2098,19 @@ export type Device = {
|
|
|
2081
2098
|
*/
|
|
2082
2099
|
current_climate_setting?: {
|
|
2083
2100
|
/**
|
|
2084
|
-
* Indicates whether the [climate preset](https://
|
|
2101
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2085
2102
|
*/
|
|
2086
2103
|
can_delete?: boolean | undefined;
|
|
2087
2104
|
/**
|
|
2088
|
-
* Indicates whether the [climate preset](https://
|
|
2105
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2089
2106
|
*/
|
|
2090
2107
|
can_edit?: boolean | undefined;
|
|
2091
2108
|
/**
|
|
2092
|
-
* Indicates whether the [climate preset](https://
|
|
2109
|
+
* 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.
|
|
2093
2110
|
*/
|
|
2094
2111
|
can_use_with_thermostat_daily_programs?: boolean | undefined;
|
|
2095
2112
|
/**
|
|
2096
|
-
* Unique key to identify the [climate preset](https://
|
|
2113
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2097
2114
|
*/
|
|
2098
2115
|
climate_preset_key?: string | undefined;
|
|
2099
2116
|
/**
|
|
@@ -2101,15 +2118,15 @@ export type Device = {
|
|
|
2101
2118
|
*/
|
|
2102
2119
|
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
2103
2120
|
/**
|
|
2104
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2121
|
+
* 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).
|
|
2105
2122
|
*/
|
|
2106
2123
|
cooling_set_point_celsius?: number | undefined;
|
|
2107
2124
|
/**
|
|
2108
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2125
|
+
* 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).
|
|
2109
2126
|
*/
|
|
2110
2127
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
2111
2128
|
/**
|
|
2112
|
-
* Display name for the [climate preset](https://
|
|
2129
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2113
2130
|
*/
|
|
2114
2131
|
display_name?: string | undefined;
|
|
2115
2132
|
/**
|
|
@@ -2130,28 +2147,28 @@ export type Device = {
|
|
|
2130
2147
|
owner?: 'user' | 'system' | undefined;
|
|
2131
2148
|
} | undefined;
|
|
2132
2149
|
/**
|
|
2133
|
-
* Desired [fan mode setting](https://
|
|
2150
|
+
* 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`.
|
|
2134
2151
|
*/
|
|
2135
2152
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
2136
2153
|
/**
|
|
2137
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2154
|
+
* 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).
|
|
2138
2155
|
*/
|
|
2139
2156
|
heating_set_point_celsius?: number | undefined;
|
|
2140
2157
|
/**
|
|
2141
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2158
|
+
* 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).
|
|
2142
2159
|
*/
|
|
2143
2160
|
heating_set_point_fahrenheit?: number | undefined;
|
|
2144
2161
|
/**
|
|
2145
|
-
* Desired [HVAC mode](https://
|
|
2162
|
+
* 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`.
|
|
2146
2163
|
*/
|
|
2147
2164
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2148
2165
|
/**
|
|
2149
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2166
|
+
* 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).
|
|
2150
2167
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2151
2168
|
*/
|
|
2152
2169
|
manual_override_allowed?: boolean | undefined;
|
|
2153
2170
|
/**
|
|
2154
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2171
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2155
2172
|
*/
|
|
2156
2173
|
name?: string | null | undefined;
|
|
2157
2174
|
} | undefined;
|
|
@@ -2160,19 +2177,19 @@ export type Device = {
|
|
|
2160
2177
|
*/
|
|
2161
2178
|
default_climate_setting?: {
|
|
2162
2179
|
/**
|
|
2163
|
-
* Indicates whether the [climate preset](https://
|
|
2180
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2164
2181
|
*/
|
|
2165
2182
|
can_delete?: boolean | undefined;
|
|
2166
2183
|
/**
|
|
2167
|
-
* Indicates whether the [climate preset](https://
|
|
2184
|
+
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2168
2185
|
*/
|
|
2169
2186
|
can_edit?: boolean | undefined;
|
|
2170
2187
|
/**
|
|
2171
|
-
* Indicates whether the [climate preset](https://
|
|
2188
|
+
* 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.
|
|
2172
2189
|
*/
|
|
2173
2190
|
can_use_with_thermostat_daily_programs?: boolean | undefined;
|
|
2174
2191
|
/**
|
|
2175
|
-
* Unique key to identify the [climate preset](https://
|
|
2192
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2176
2193
|
*/
|
|
2177
2194
|
climate_preset_key?: string | undefined;
|
|
2178
2195
|
/**
|
|
@@ -2180,15 +2197,15 @@ export type Device = {
|
|
|
2180
2197
|
*/
|
|
2181
2198
|
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
2182
2199
|
/**
|
|
2183
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
2200
|
+
* 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).
|
|
2184
2201
|
*/
|
|
2185
2202
|
cooling_set_point_celsius?: number | undefined;
|
|
2186
2203
|
/**
|
|
2187
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
2204
|
+
* 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).
|
|
2188
2205
|
*/
|
|
2189
2206
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
2190
2207
|
/**
|
|
2191
|
-
* Display name for the [climate preset](https://
|
|
2208
|
+
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2192
2209
|
*/
|
|
2193
2210
|
display_name?: string | undefined;
|
|
2194
2211
|
/**
|
|
@@ -2209,33 +2226,33 @@ export type Device = {
|
|
|
2209
2226
|
owner?: 'user' | 'system' | undefined;
|
|
2210
2227
|
} | undefined;
|
|
2211
2228
|
/**
|
|
2212
|
-
* Desired [fan mode setting](https://
|
|
2229
|
+
* 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`.
|
|
2213
2230
|
*/
|
|
2214
2231
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
2215
2232
|
/**
|
|
2216
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
2233
|
+
* 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).
|
|
2217
2234
|
*/
|
|
2218
2235
|
heating_set_point_celsius?: number | undefined;
|
|
2219
2236
|
/**
|
|
2220
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
2237
|
+
* 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).
|
|
2221
2238
|
*/
|
|
2222
2239
|
heating_set_point_fahrenheit?: number | undefined;
|
|
2223
2240
|
/**
|
|
2224
|
-
* Desired [HVAC mode](https://
|
|
2241
|
+
* 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`.
|
|
2225
2242
|
*/
|
|
2226
2243
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2227
2244
|
/**
|
|
2228
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
2245
|
+
* 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).
|
|
2229
2246
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2230
2247
|
*/
|
|
2231
2248
|
manual_override_allowed?: boolean | undefined;
|
|
2232
2249
|
/**
|
|
2233
|
-
* User-friendly name to identify the [climate preset](https://
|
|
2250
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2234
2251
|
*/
|
|
2235
2252
|
name?: string | null | undefined;
|
|
2236
2253
|
} | undefined;
|
|
2237
2254
|
/**
|
|
2238
|
-
* Key of the [fallback climate preset](https://
|
|
2255
|
+
* 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.
|
|
2239
2256
|
*/
|
|
2240
2257
|
fallback_climate_preset_key?: string | null | undefined;
|
|
2241
2258
|
/**
|
|
@@ -2259,19 +2276,19 @@ export type Device = {
|
|
|
2259
2276
|
*/
|
|
2260
2277
|
is_temporary_manual_override_active?: boolean | undefined;
|
|
2261
2278
|
/**
|
|
2262
|
-
* Maximum [cooling set point](https://
|
|
2279
|
+
* Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2263
2280
|
*/
|
|
2264
2281
|
max_cooling_set_point_celsius?: number | undefined;
|
|
2265
2282
|
/**
|
|
2266
|
-
* Maximum [cooling set point](https://
|
|
2283
|
+
* Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2267
2284
|
*/
|
|
2268
2285
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
2269
2286
|
/**
|
|
2270
|
-
* Maximum [heating set point](https://
|
|
2287
|
+
* Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2271
2288
|
*/
|
|
2272
2289
|
max_heating_set_point_celsius?: number | undefined;
|
|
2273
2290
|
/**
|
|
2274
|
-
* Maximum [heating set point](https://
|
|
2291
|
+
* Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2275
2292
|
*/
|
|
2276
2293
|
max_heating_set_point_fahrenheit?: number | undefined;
|
|
2277
2294
|
/**
|
|
@@ -2283,27 +2300,27 @@ export type Device = {
|
|
|
2283
2300
|
*/
|
|
2284
2301
|
max_unique_climate_presets_per_thermostat_weekly_program?: number | undefined;
|
|
2285
2302
|
/**
|
|
2286
|
-
* Minimum [cooling set point](https://
|
|
2303
|
+
* Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2287
2304
|
*/
|
|
2288
2305
|
min_cooling_set_point_celsius?: number | undefined;
|
|
2289
2306
|
/**
|
|
2290
|
-
* Minimum [cooling set point](https://
|
|
2307
|
+
* Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2291
2308
|
*/
|
|
2292
2309
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
2293
2310
|
/**
|
|
2294
|
-
* Minimum [temperature difference](https://
|
|
2311
|
+
* 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.
|
|
2295
2312
|
*/
|
|
2296
2313
|
min_heating_cooling_delta_celsius?: number | undefined;
|
|
2297
2314
|
/**
|
|
2298
|
-
* Minimum [temperature difference](https://
|
|
2315
|
+
* 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.
|
|
2299
2316
|
*/
|
|
2300
2317
|
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
2301
2318
|
/**
|
|
2302
|
-
* Minimum [heating set point](https://
|
|
2319
|
+
* Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2303
2320
|
*/
|
|
2304
2321
|
min_heating_set_point_celsius?: number | undefined;
|
|
2305
2322
|
/**
|
|
2306
|
-
* Minimum [heating set point](https://
|
|
2323
|
+
* Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2307
2324
|
*/
|
|
2308
2325
|
min_heating_set_point_fahrenheit?: number | undefined;
|
|
2309
2326
|
/**
|
|
@@ -2319,23 +2336,23 @@ export type Device = {
|
|
|
2319
2336
|
*/
|
|
2320
2337
|
temperature_fahrenheit?: number | undefined;
|
|
2321
2338
|
/**
|
|
2322
|
-
* Current [temperature threshold](https://
|
|
2339
|
+
* Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
2323
2340
|
*/
|
|
2324
2341
|
temperature_threshold?: {
|
|
2325
2342
|
/**
|
|
2326
|
-
* Lower limit in °C within the current [temperature threshold](https://
|
|
2343
|
+
* 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.
|
|
2327
2344
|
*/
|
|
2328
2345
|
lower_limit_celsius: number | null;
|
|
2329
2346
|
/**
|
|
2330
|
-
* Lower limit in °F within the current [temperature threshold](https://
|
|
2347
|
+
* 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.
|
|
2331
2348
|
*/
|
|
2332
2349
|
lower_limit_fahrenheit: number | null;
|
|
2333
2350
|
/**
|
|
2334
|
-
* Upper limit in °C within the current [temperature threshold](https://
|
|
2351
|
+
* 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.
|
|
2335
2352
|
*/
|
|
2336
2353
|
upper_limit_celsius: number | null;
|
|
2337
2354
|
/**
|
|
2338
|
-
* Upper limit in °F within the current [temperature threshold](https://
|
|
2355
|
+
* 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.
|
|
2339
2356
|
*/
|
|
2340
2357
|
upper_limit_fahrenheit: number | null;
|
|
2341
2358
|
} | undefined;
|
|
@@ -2344,7 +2361,7 @@ export type Device = {
|
|
|
2344
2361
|
*/
|
|
2345
2362
|
thermostat_daily_program_period_precision_minutes?: number | undefined;
|
|
2346
2363
|
/**
|
|
2347
|
-
* Configured [daily programs](https://
|
|
2364
|
+
* Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
2348
2365
|
*/
|
|
2349
2366
|
thermostat_daily_programs?: Array<{
|
|
2350
2367
|
/**
|
|
@@ -2364,7 +2381,7 @@ export type Device = {
|
|
|
2364
2381
|
*/
|
|
2365
2382
|
periods: Array<{
|
|
2366
2383
|
/**
|
|
2367
|
-
* Key of the [climate preset](https://
|
|
2384
|
+
* 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`.
|
|
2368
2385
|
*/
|
|
2369
2386
|
climate_preset_key: string;
|
|
2370
2387
|
/**
|
|
@@ -2382,7 +2399,7 @@ export type Device = {
|
|
|
2382
2399
|
workspace_id: string;
|
|
2383
2400
|
}> | undefined;
|
|
2384
2401
|
/**
|
|
2385
|
-
* Current [weekly program](https://
|
|
2402
|
+
* Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
2386
2403
|
*/
|
|
2387
2404
|
thermostat_weekly_program?: {
|
|
2388
2405
|
/**
|