@seamapi/http 2.49.0 → 2.51.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-grant.d.ts +0 -4
- package/lib/resources/acs-access-group.d.ts +0 -8
- package/lib/resources/acs-system.d.ts +14 -16
- package/lib/resources/acs-user.d.ts +0 -4
- package/lib/resources/client-session.d.ts +0 -5
- package/lib/resources/connect-webview.d.ts +1 -1
- package/lib/resources/connected-account.d.ts +1 -27
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +208 -241
- package/lib/resources/event.d.ts +4 -43
- package/lib/resources/phone.d.ts +30 -0
- package/lib/resources/unmanaged-access-grant.d.ts +0 -4
- package/lib/resources/unmanaged-device.d.ts +34 -31
- package/lib/resources/workspace.d.ts +0 -5
- package/lib/routes/access-codes/access-codes.d.ts +0 -4
- package/lib/routes/access-grants/access-grants.d.ts +0 -25
- package/lib/routes/acs/entrances/entrances.d.ts +0 -4
- package/lib/routes/acs/users/users.d.ts +1 -9
- package/lib/routes/acs/users/users.js +0 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +1 -16
- package/lib/routes/client-sessions/client-sessions.js +0 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
- package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +4 -12
- package/lib/routes/devices/devices.d.ts +3 -7
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/spaces/spaces.d.ts +13 -0
- package/lib/routes/thermostats/thermostats.d.ts +3 -13
- package/lib/routes/workspaces/workspaces.d.ts +0 -21
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-grant.ts +0 -5
- package/src/lib/resources/acs-access-group.ts +0 -20
- package/src/lib/resources/acs-system.ts +17 -35
- package/src/lib/resources/acs-user.ts +0 -4
- package/src/lib/resources/client-session.ts +0 -6
- package/src/lib/resources/connect-webview.ts +1 -0
- package/src/lib/resources/connected-account.ts +1 -28
- package/src/lib/resources/device-provider.ts +4 -0
- package/src/lib/resources/device.ts +2351 -2388
- package/src/lib/resources/event.ts +4 -53
- package/src/lib/resources/phone.ts +36 -0
- package/src/lib/resources/unmanaged-access-grant.ts +0 -5
- package/src/lib/resources/unmanaged-device.ts +119 -105
- package/src/lib/resources/workspace.ts +0 -6
- package/src/lib/routes/access-codes/access-codes.ts +0 -4
- package/src/lib/routes/access-grants/access-grants.ts +0 -27
- package/src/lib/routes/acs/entrances/entrances.ts +0 -4
- package/src/lib/routes/acs/users/users.ts +0 -10
- package/src/lib/routes/client-sessions/client-sessions.ts +0 -17
- package/src/lib/routes/connect-webviews/connect-webviews.ts +5 -0
- package/src/lib/routes/connected-accounts/connected-accounts.ts +1 -0
- package/src/lib/routes/customers/customers.ts +4 -14
- package/src/lib/routes/devices/devices.ts +14 -4
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +14 -0
- package/src/lib/routes/locks/locks.ts +3 -0
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/spaces/spaces.ts +16 -0
- package/src/lib/routes/thermostats/thermostats.ts +3 -10
- package/src/lib/routes/workspaces/workspaces.ts +0 -21
- package/src/lib/version.ts +1 -1
|
@@ -2,6 +2,10 @@
|
|
|
2
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
|
+
/**
|
|
6
|
+
* Air quality index, if the device measures it.
|
|
7
|
+
*/
|
|
8
|
+
air_quality_index?: number | undefined;
|
|
5
9
|
/**
|
|
6
10
|
* Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
|
|
7
11
|
*/
|
|
@@ -93,7 +97,15 @@ export type Device = {
|
|
|
93
97
|
/**
|
|
94
98
|
* 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).
|
|
95
99
|
*/
|
|
96
|
-
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
100
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone' | 'pool'>;
|
|
101
|
+
/**
|
|
102
|
+
* Carbon dioxide concentration in parts per million, if the device measures it.
|
|
103
|
+
*/
|
|
104
|
+
co2_ppm?: number | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* Carbon monoxide concentration in parts per million, if the device measures it.
|
|
107
|
+
*/
|
|
108
|
+
co_ppm?: number | undefined;
|
|
97
109
|
/**
|
|
98
110
|
* Unique identifier for the account associated with the device.
|
|
99
111
|
*/
|
|
@@ -151,7 +163,7 @@ export type Device = {
|
|
|
151
163
|
/**
|
|
152
164
|
* Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
|
|
153
165
|
*/
|
|
154
|
-
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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_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' | 'eufy_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' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker';
|
|
166
|
+
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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_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' | 'tuya_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'sensibo_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | 'alertify_sensor' | 'hayward_pool_system' | 'hayward_pool';
|
|
155
167
|
/**
|
|
156
168
|
* 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.
|
|
157
169
|
*/
|
|
@@ -448,10 +460,22 @@ export type Device = {
|
|
|
448
460
|
*/
|
|
449
461
|
message: string;
|
|
450
462
|
}>;
|
|
463
|
+
/**
|
|
464
|
+
* Estimated number of occupants detected by the device.
|
|
465
|
+
*/
|
|
466
|
+
estimated_occupant_count?: number | undefined;
|
|
451
467
|
/**
|
|
452
468
|
* Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
453
469
|
*/
|
|
454
470
|
is_managed: true;
|
|
471
|
+
/**
|
|
472
|
+
* Indicates whether the device detects occupancy.
|
|
473
|
+
*/
|
|
474
|
+
is_occupancy_detected?: boolean | undefined;
|
|
475
|
+
/**
|
|
476
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
477
|
+
*/
|
|
478
|
+
is_smoking_detected?: boolean | undefined;
|
|
455
479
|
/**
|
|
456
480
|
* Location information for the device.
|
|
457
481
|
*/
|
|
@@ -468,20 +492,88 @@ export type Device = {
|
|
|
468
492
|
* Time zone of the device location.
|
|
469
493
|
*/
|
|
470
494
|
time_zone?: string | undefined;
|
|
495
|
+
} | undefined;
|
|
496
|
+
/**
|
|
497
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
498
|
+
*/
|
|
499
|
+
mold_risk_level?: string | undefined;
|
|
500
|
+
/**
|
|
501
|
+
* Additional sensors of the same kind on the device, each with a stable `sensor_name`. Present only when the device has more than one sensor of a kind or no single main sensor.
|
|
502
|
+
*/
|
|
503
|
+
named_sensors?: Array<{
|
|
471
504
|
/**
|
|
472
|
-
*
|
|
473
|
-
* @deprecated Use `time_zone` instead.
|
|
505
|
+
* Air quality index, if the device measures it.
|
|
474
506
|
*/
|
|
475
|
-
|
|
476
|
-
|
|
507
|
+
air_quality_index?: number | undefined;
|
|
508
|
+
/**
|
|
509
|
+
* Carbon dioxide concentration in parts per million, if the device measures it.
|
|
510
|
+
*/
|
|
511
|
+
co2_ppm?: number | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* Carbon monoxide concentration in parts per million, if the device measures it.
|
|
514
|
+
*/
|
|
515
|
+
co_ppm?: number | undefined;
|
|
516
|
+
/**
|
|
517
|
+
* Display name of the sensor. Defaults to `sensor_name`.
|
|
518
|
+
*/
|
|
519
|
+
display_name: string;
|
|
520
|
+
/**
|
|
521
|
+
* Estimated number of occupants detected by the device.
|
|
522
|
+
*/
|
|
523
|
+
estimated_occupant_count?: number | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* Indicates whether the device detects occupancy.
|
|
526
|
+
*/
|
|
527
|
+
is_occupancy_detected?: boolean | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
530
|
+
*/
|
|
531
|
+
is_smoking_detected?: boolean | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
534
|
+
*/
|
|
535
|
+
mold_risk_level?: string | undefined;
|
|
536
|
+
/**
|
|
537
|
+
* Noise level in decibels, if the device measures noise.
|
|
538
|
+
*/
|
|
539
|
+
noise_level_decibels?: number | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
542
|
+
*/
|
|
543
|
+
noise_level_nrs?: number | undefined;
|
|
544
|
+
/**
|
|
545
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
546
|
+
*/
|
|
547
|
+
relative_humidity?: number | undefined;
|
|
548
|
+
/**
|
|
549
|
+
* Stable, hardware-defined name of the sensor, such as a port number.
|
|
550
|
+
*/
|
|
551
|
+
sensor_name: string;
|
|
552
|
+
/**
|
|
553
|
+
* Temperature in °C, if the device measures temperature.
|
|
554
|
+
*/
|
|
555
|
+
temperature_celsius?: number | undefined;
|
|
556
|
+
/**
|
|
557
|
+
* Temperature in °F, if the device measures temperature.
|
|
558
|
+
*/
|
|
559
|
+
temperature_fahrenheit?: number | undefined;
|
|
560
|
+
}> | undefined;
|
|
477
561
|
/**
|
|
478
562
|
* Optional nickname to describe the device, settable through Seam.
|
|
479
563
|
*/
|
|
480
564
|
nickname?: string | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* Noise level in decibels, if the device measures noise.
|
|
567
|
+
*/
|
|
568
|
+
noise_level_decibels?: number | undefined;
|
|
569
|
+
/**
|
|
570
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
571
|
+
*/
|
|
572
|
+
noise_level_nrs?: number | undefined;
|
|
481
573
|
/**
|
|
482
574
|
* Properties of the device.
|
|
483
575
|
*/
|
|
484
|
-
properties
|
|
576
|
+
properties?: {
|
|
485
577
|
/**
|
|
486
578
|
* Accessory keypad properties and state.
|
|
487
579
|
*/
|
|
@@ -547,10 +639,6 @@ export type Device = {
|
|
|
547
639
|
* Device model-related properties.
|
|
548
640
|
*/
|
|
549
641
|
model: {
|
|
550
|
-
/**
|
|
551
|
-
* @deprecated use device.properties.model.can_connect_accessory_keypad
|
|
552
|
-
*/
|
|
553
|
-
accessory_keypad_supported?: boolean | undefined;
|
|
554
642
|
/**
|
|
555
643
|
* Indicates whether the device can connect a accessory keypad.
|
|
556
644
|
*/
|
|
@@ -567,14 +655,6 @@ export type Device = {
|
|
|
567
655
|
* Display name that corresponds to the manufacturer-specific terminology for the device.
|
|
568
656
|
*/
|
|
569
657
|
manufacturer_display_name: string;
|
|
570
|
-
/**
|
|
571
|
-
* @deprecated use device.can_program_offline_access_codes.
|
|
572
|
-
*/
|
|
573
|
-
offline_access_codes_supported?: boolean | undefined;
|
|
574
|
-
/**
|
|
575
|
-
* @deprecated use device.can_program_online_access_codes.
|
|
576
|
-
*/
|
|
577
|
-
online_access_codes_supported?: boolean | undefined;
|
|
578
658
|
};
|
|
579
659
|
/**
|
|
580
660
|
* Name of the device.
|
|
@@ -585,32 +665,14 @@ export type Device = {
|
|
|
585
665
|
* Indicates current noise level in decibels, if the device supports noise detection.
|
|
586
666
|
*/
|
|
587
667
|
noise_level_decibels?: number | undefined;
|
|
588
|
-
/**
|
|
589
|
-
* Indicates whether it is currently possible to use offline access codes for the device.
|
|
590
|
-
* @deprecated use device.can_program_offline_access_codes
|
|
591
|
-
*/
|
|
592
|
-
offline_access_codes_enabled?: boolean | undefined;
|
|
593
668
|
/**
|
|
594
669
|
* Indicates whether the device is online.
|
|
595
670
|
*/
|
|
596
671
|
online: boolean;
|
|
597
|
-
/**
|
|
598
|
-
* Indicates whether it is currently possible to use online access codes for the device.
|
|
599
|
-
* @deprecated use device.can_program_online_access_codes
|
|
600
|
-
*/
|
|
601
|
-
online_access_codes_enabled?: boolean | undefined;
|
|
602
672
|
/**
|
|
603
673
|
* Serial number of the device.
|
|
604
674
|
*/
|
|
605
675
|
serial_number?: string | undefined;
|
|
606
|
-
/**
|
|
607
|
-
* @deprecated use device.properties.model.can_connect_accessory_keypad
|
|
608
|
-
*/
|
|
609
|
-
supports_accessory_keypad?: boolean | undefined;
|
|
610
|
-
/**
|
|
611
|
-
* @deprecated use offline_access_codes_enabled
|
|
612
|
-
*/
|
|
613
|
-
supports_offline_access_codes?: boolean | undefined;
|
|
614
676
|
/**
|
|
615
677
|
* ASSA ABLOY Credential Service metadata for the phone.
|
|
616
678
|
*/
|
|
@@ -922,11 +984,6 @@ export type Device = {
|
|
|
922
984
|
*/
|
|
923
985
|
prefix?: number | undefined;
|
|
924
986
|
}> | undefined;
|
|
925
|
-
/**
|
|
926
|
-
* Site ID for a dormakaba Oracode device.
|
|
927
|
-
* @deprecated Previously marked as "@DEPRECATED."
|
|
928
|
-
*/
|
|
929
|
-
site_id?: number | null | undefined;
|
|
930
987
|
/**
|
|
931
988
|
* Site name for a dormakaba Oracode device.
|
|
932
989
|
*/
|
|
@@ -1485,44 +1542,6 @@ export type Device = {
|
|
|
1485
1542
|
*/
|
|
1486
1543
|
site_name?: string | undefined;
|
|
1487
1544
|
} | undefined;
|
|
1488
|
-
/**
|
|
1489
|
-
* Metada for a Salto device.
|
|
1490
|
-
* @deprecated Use `salto_ks_metadata` instead.
|
|
1491
|
-
*/
|
|
1492
|
-
salto_metadata?: {
|
|
1493
|
-
/**
|
|
1494
|
-
* Battery level for a Salto device.
|
|
1495
|
-
*/
|
|
1496
|
-
battery_level?: string | undefined;
|
|
1497
|
-
/**
|
|
1498
|
-
* Customer reference for a Salto device.
|
|
1499
|
-
*/
|
|
1500
|
-
customer_reference?: string | undefined;
|
|
1501
|
-
/**
|
|
1502
|
-
* Lock ID for a Salto device.
|
|
1503
|
-
*/
|
|
1504
|
-
lock_id?: string | undefined;
|
|
1505
|
-
/**
|
|
1506
|
-
* Lock type for a Salto device.
|
|
1507
|
-
*/
|
|
1508
|
-
lock_type?: string | undefined;
|
|
1509
|
-
/**
|
|
1510
|
-
* Locked state for a Salto device.
|
|
1511
|
-
*/
|
|
1512
|
-
locked_state?: string | undefined;
|
|
1513
|
-
/**
|
|
1514
|
-
* Model for a Salto device.
|
|
1515
|
-
*/
|
|
1516
|
-
model?: string | undefined;
|
|
1517
|
-
/**
|
|
1518
|
-
* Site ID for the Salto KS site to which the device belongs.
|
|
1519
|
-
*/
|
|
1520
|
-
site_id?: string | undefined;
|
|
1521
|
-
/**
|
|
1522
|
-
* Site name for the Salto KS site to which the device belongs.
|
|
1523
|
-
*/
|
|
1524
|
-
site_name?: string | undefined;
|
|
1525
|
-
} | undefined;
|
|
1526
1545
|
/**
|
|
1527
1546
|
* Metadata for a Schlage device.
|
|
1528
1547
|
*/
|
|
@@ -1569,15 +1588,44 @@ export type Device = {
|
|
|
1569
1588
|
* Device name for a Sensi device.
|
|
1570
1589
|
*/
|
|
1571
1590
|
device_name?: string | undefined;
|
|
1572
|
-
/**
|
|
1573
|
-
* Deprecated. Seam no longer sets this field.
|
|
1574
|
-
*/
|
|
1575
|
-
dual_setpoints_not_supported?: boolean | undefined;
|
|
1576
1591
|
/**
|
|
1577
1592
|
* Product type for a Sensi device.
|
|
1578
1593
|
*/
|
|
1579
1594
|
product_type?: string | undefined;
|
|
1580
1595
|
} | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* Metadata for a Sensibo device.
|
|
1598
|
+
*/
|
|
1599
|
+
sensibo_metadata?: {
|
|
1600
|
+
/**
|
|
1601
|
+
* Firmware version of the Sensibo device.
|
|
1602
|
+
*/
|
|
1603
|
+
firmware_version?: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* MAC address of the Sensibo device.
|
|
1606
|
+
*/
|
|
1607
|
+
mac_address?: string | undefined;
|
|
1608
|
+
/**
|
|
1609
|
+
* ID of the Sensibo device, which Sensibo calls a pod.
|
|
1610
|
+
*/
|
|
1611
|
+
pod_id?: string | undefined;
|
|
1612
|
+
/**
|
|
1613
|
+
* Product model of the Sensibo device, such as `skyv2` or `air`.
|
|
1614
|
+
*/
|
|
1615
|
+
product_model?: string | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* Name of the room that the Sensibo device is in.
|
|
1618
|
+
*/
|
|
1619
|
+
room_name?: string | undefined;
|
|
1620
|
+
/**
|
|
1621
|
+
* Serial number of the Sensibo device.
|
|
1622
|
+
*/
|
|
1623
|
+
serial_number?: string | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* Temperature unit that the Sensibo device displays: `C` or `F`.
|
|
1626
|
+
*/
|
|
1627
|
+
temperature_unit?: string | undefined;
|
|
1628
|
+
} | undefined;
|
|
1581
1629
|
/**
|
|
1582
1630
|
* Metadata for a SmartThings device.
|
|
1583
1631
|
*/
|
|
@@ -1761,6 +1809,39 @@ export type Device = {
|
|
|
1761
1809
|
wireless_keypad_name?: string | undefined;
|
|
1762
1810
|
}> | undefined;
|
|
1763
1811
|
} | undefined;
|
|
1812
|
+
/**
|
|
1813
|
+
* Metadata for a Tuya device.
|
|
1814
|
+
*/
|
|
1815
|
+
tuya_metadata?: {
|
|
1816
|
+
/**
|
|
1817
|
+
* Tuya product category code for the device (e.g. ms).
|
|
1818
|
+
*/
|
|
1819
|
+
category?: string | undefined;
|
|
1820
|
+
/**
|
|
1821
|
+
* Device ID for a Tuya device.
|
|
1822
|
+
*/
|
|
1823
|
+
device_id?: string | undefined;
|
|
1824
|
+
/**
|
|
1825
|
+
* Device name for a Tuya device.
|
|
1826
|
+
*/
|
|
1827
|
+
device_name?: string | undefined;
|
|
1828
|
+
/**
|
|
1829
|
+
* Model reported for a Tuya device.
|
|
1830
|
+
*/
|
|
1831
|
+
model?: string | null | undefined;
|
|
1832
|
+
/**
|
|
1833
|
+
* Tuya product ID for the device.
|
|
1834
|
+
*/
|
|
1835
|
+
product_id?: string | undefined;
|
|
1836
|
+
/**
|
|
1837
|
+
* Tuya product name for the device.
|
|
1838
|
+
*/
|
|
1839
|
+
product_name?: string | undefined;
|
|
1840
|
+
/**
|
|
1841
|
+
* Time zone reported for a Tuya device (e.g. +08:00).
|
|
1842
|
+
*/
|
|
1843
|
+
time_zone?: string | null | undefined;
|
|
1844
|
+
} | undefined;
|
|
1764
1845
|
/**
|
|
1765
1846
|
* Metadata for a 2N device.
|
|
1766
1847
|
*/
|
|
@@ -2079,69 +2160,6 @@ export type Device = {
|
|
|
2079
2160
|
* 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).
|
|
2080
2161
|
*/
|
|
2081
2162
|
supports_backup_access_code_pool?: boolean | undefined;
|
|
2082
|
-
/**
|
|
2083
|
-
* Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2084
|
-
* @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
|
|
2085
|
-
*/
|
|
2086
|
-
active_thermostat_schedule?: {
|
|
2087
|
-
/**
|
|
2088
|
-
* 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).
|
|
2089
|
-
*/
|
|
2090
|
-
climate_preset_key: string;
|
|
2091
|
-
/**
|
|
2092
|
-
* Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
2093
|
-
*/
|
|
2094
|
-
created_at: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
2097
|
-
*/
|
|
2098
|
-
device_id: string;
|
|
2099
|
-
/**
|
|
2100
|
-
* 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.
|
|
2101
|
-
*/
|
|
2102
|
-
ends_at: string;
|
|
2103
|
-
/**
|
|
2104
|
-
* Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2105
|
-
*/
|
|
2106
|
-
errors: Array<{
|
|
2107
|
-
/**
|
|
2108
|
-
* Date and time at which Seam created the error.
|
|
2109
|
-
*/
|
|
2110
|
-
created_at: string;
|
|
2111
|
-
/**
|
|
2112
|
-
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
2113
|
-
*/
|
|
2114
|
-
error_code: string;
|
|
2115
|
-
/**
|
|
2116
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2117
|
-
*/
|
|
2118
|
-
message: string;
|
|
2119
|
-
}>;
|
|
2120
|
-
/**
|
|
2121
|
-
* 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.
|
|
2122
|
-
*/
|
|
2123
|
-
is_override_allowed?: boolean | undefined;
|
|
2124
|
-
/**
|
|
2125
|
-
* 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).
|
|
2126
|
-
*/
|
|
2127
|
-
max_override_period_minutes?: number | null | undefined;
|
|
2128
|
-
/**
|
|
2129
|
-
* User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2130
|
-
*/
|
|
2131
|
-
name: string | null;
|
|
2132
|
-
/**
|
|
2133
|
-
* 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.
|
|
2134
|
-
*/
|
|
2135
|
-
starts_at: string;
|
|
2136
|
-
/**
|
|
2137
|
-
* ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2138
|
-
*/
|
|
2139
|
-
thermostat_schedule_id: string;
|
|
2140
|
-
/**
|
|
2141
|
-
* ID of the workspace that contains the thermostat schedule.
|
|
2142
|
-
*/
|
|
2143
|
-
workspace_id: string;
|
|
2144
|
-
} | null | undefined;
|
|
2145
2163
|
/**
|
|
2146
2164
|
* ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2147
2165
|
*/
|
|
@@ -2219,11 +2237,6 @@ export type Device = {
|
|
|
2219
2237
|
* 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`.
|
|
2220
2238
|
*/
|
|
2221
2239
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2222
|
-
/**
|
|
2223
|
-
* 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).
|
|
2224
|
-
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2225
|
-
*/
|
|
2226
|
-
manual_override_allowed: boolean;
|
|
2227
2240
|
/**
|
|
2228
2241
|
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2229
2242
|
*/
|
|
@@ -2306,90 +2319,6 @@ export type Device = {
|
|
|
2306
2319
|
* 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`.
|
|
2307
2320
|
*/
|
|
2308
2321
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2309
|
-
/**
|
|
2310
|
-
* 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).
|
|
2311
|
-
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2312
|
-
*/
|
|
2313
|
-
manual_override_allowed?: boolean | undefined;
|
|
2314
|
-
/**
|
|
2315
|
-
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2316
|
-
*/
|
|
2317
|
-
name?: string | null | undefined;
|
|
2318
|
-
} | undefined;
|
|
2319
|
-
/**
|
|
2320
|
-
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead.
|
|
2321
|
-
*/
|
|
2322
|
-
default_climate_setting?: {
|
|
2323
|
-
/**
|
|
2324
|
-
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
2325
|
-
*/
|
|
2326
|
-
can_delete?: boolean | undefined;
|
|
2327
|
-
/**
|
|
2328
|
-
* Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
2329
|
-
*/
|
|
2330
|
-
can_edit?: boolean | undefined;
|
|
2331
|
-
/**
|
|
2332
|
-
* 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.
|
|
2333
|
-
*/
|
|
2334
|
-
can_use_with_thermostat_daily_programs?: boolean | undefined;
|
|
2335
|
-
/**
|
|
2336
|
-
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2337
|
-
*/
|
|
2338
|
-
climate_preset_key?: string | undefined;
|
|
2339
|
-
/**
|
|
2340
|
-
* The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
2341
|
-
*/
|
|
2342
|
-
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
2343
|
-
/**
|
|
2344
|
-
* 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).
|
|
2345
|
-
*/
|
|
2346
|
-
cooling_set_point_celsius?: number | undefined;
|
|
2347
|
-
/**
|
|
2348
|
-
* 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).
|
|
2349
|
-
*/
|
|
2350
|
-
cooling_set_point_fahrenheit?: number | undefined;
|
|
2351
|
-
/**
|
|
2352
|
-
* Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2353
|
-
*/
|
|
2354
|
-
display_name?: string | undefined;
|
|
2355
|
-
/**
|
|
2356
|
-
* Metadata specific to the Ecobee climate, if applicable.
|
|
2357
|
-
*/
|
|
2358
|
-
ecobee_metadata?: {
|
|
2359
|
-
/**
|
|
2360
|
-
* Reference to the Ecobee climate, if applicable.
|
|
2361
|
-
*/
|
|
2362
|
-
climate_ref?: string | undefined;
|
|
2363
|
-
/**
|
|
2364
|
-
* Indicates if the climate preset is optimized by Ecobee.
|
|
2365
|
-
*/
|
|
2366
|
-
is_optimized?: boolean | undefined;
|
|
2367
|
-
/**
|
|
2368
|
-
* Indicates whether the climate preset is owned by the user or the system.
|
|
2369
|
-
*/
|
|
2370
|
-
owner?: 'user' | 'system' | undefined;
|
|
2371
|
-
} | undefined;
|
|
2372
|
-
/**
|
|
2373
|
-
* 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`.
|
|
2374
|
-
*/
|
|
2375
|
-
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
2376
|
-
/**
|
|
2377
|
-
* 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).
|
|
2378
|
-
*/
|
|
2379
|
-
heating_set_point_celsius?: number | undefined;
|
|
2380
|
-
/**
|
|
2381
|
-
* 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).
|
|
2382
|
-
*/
|
|
2383
|
-
heating_set_point_fahrenheit?: number | undefined;
|
|
2384
|
-
/**
|
|
2385
|
-
* 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`.
|
|
2386
|
-
*/
|
|
2387
|
-
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
2388
|
-
/**
|
|
2389
|
-
* 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).
|
|
2390
|
-
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
2391
|
-
*/
|
|
2392
|
-
manual_override_allowed?: boolean | undefined;
|
|
2393
2322
|
/**
|
|
2394
2323
|
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
2395
2324
|
*/
|
|
@@ -2399,10 +2328,6 @@ export type Device = {
|
|
|
2399
2328
|
* 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.
|
|
2400
2329
|
*/
|
|
2401
2330
|
fallback_climate_preset_key?: string | null | undefined;
|
|
2402
|
-
/**
|
|
2403
|
-
* @deprecated Use `current_climate_setting.fan_mode_setting` instead.
|
|
2404
|
-
*/
|
|
2405
|
-
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
2406
2331
|
/**
|
|
2407
2332
|
* Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
|
|
2408
2333
|
*/
|
|
@@ -2579,11 +2504,23 @@ export type Device = {
|
|
|
2579
2504
|
*/
|
|
2580
2505
|
wednesday_program_id: string | null;
|
|
2581
2506
|
} | null | undefined;
|
|
2582
|
-
};
|
|
2507
|
+
} | undefined;
|
|
2508
|
+
/**
|
|
2509
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
2510
|
+
*/
|
|
2511
|
+
relative_humidity?: number | undefined;
|
|
2583
2512
|
/**
|
|
2584
2513
|
* IDs of the spaces the device is in.
|
|
2585
2514
|
*/
|
|
2586
2515
|
space_ids: Array<string>;
|
|
2516
|
+
/**
|
|
2517
|
+
* Temperature in °C, if the device measures temperature.
|
|
2518
|
+
*/
|
|
2519
|
+
temperature_celsius?: number | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* Temperature in °F, if the device measures temperature.
|
|
2522
|
+
*/
|
|
2523
|
+
temperature_fahrenheit?: number | undefined;
|
|
2587
2524
|
/**
|
|
2588
2525
|
* Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
|
|
2589
2526
|
*/
|
|
@@ -2920,6 +2857,21 @@ export type Device = {
|
|
|
2920
2857
|
*/
|
|
2921
2858
|
warning_code: 'hub_required_for_additional_capabilities';
|
|
2922
2859
|
} /**
|
|
2860
|
+
* Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back.
|
|
2861
|
+
*/ | {
|
|
2862
|
+
/**
|
|
2863
|
+
* Date and time at which Seam created the warning.
|
|
2864
|
+
*/
|
|
2865
|
+
created_at: string;
|
|
2866
|
+
/**
|
|
2867
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
2868
|
+
*/
|
|
2869
|
+
message: string;
|
|
2870
|
+
/**
|
|
2871
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
2872
|
+
*/
|
|
2873
|
+
warning_code: 'service_mode';
|
|
2874
|
+
} /**
|
|
2923
2875
|
* Indicates a provider-specific issue that may affect device functionality.
|
|
2924
2876
|
*/ | {
|
|
2925
2877
|
/**
|
|
@@ -3018,6 +2970,21 @@ export type Device = {
|
|
|
3018
2970
|
*/
|
|
3019
2971
|
warning_code: 'max_access_codes_reached';
|
|
3020
2972
|
} /**
|
|
2973
|
+
* Indicates that a third-party subscription is required to enable additional device capabilities.
|
|
2974
|
+
*/ | {
|
|
2975
|
+
/**
|
|
2976
|
+
* Date and time at which Seam created the warning.
|
|
2977
|
+
*/
|
|
2978
|
+
created_at: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
2981
|
+
*/
|
|
2982
|
+
message: string;
|
|
2983
|
+
/**
|
|
2984
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
2985
|
+
*/
|
|
2986
|
+
warning_code: 'subscription_required_for_additional_capabilities';
|
|
2987
|
+
} /**
|
|
3021
2988
|
* Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
|
|
3022
2989
|
*/ | {
|
|
3023
2990
|
/**
|