@seamapi/http 2.48.0 → 2.50.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/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +110 -1
- package/lib/resources/unmanaged-device.d.ts +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
- package/lib/routes/devices/devices.d.ts +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +4 -4
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +114 -0
- package/src/lib/resources/unmanaged-device.ts +1 -0
- package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
- package/src/lib/routes/devices/devices.ts +3 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/version.ts +1 -1
|
@@ -90,7 +90,7 @@ export type DeviceProvider = {
|
|
|
90
90
|
/**
|
|
91
91
|
* Name of the device provider.
|
|
92
92
|
*/
|
|
93
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
93
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
94
94
|
/**
|
|
95
95
|
* Display name for the device provider.
|
|
96
96
|
*/
|
|
@@ -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
|
*/
|
|
@@ -94,6 +98,14 @@ export type Device = {
|
|
|
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
100
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
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' | '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' | 'alertify_sensor';
|
|
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
|
*/
|
|
@@ -452,6 +464,14 @@ export type Device = {
|
|
|
452
464
|
* 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
465
|
*/
|
|
454
466
|
is_managed: true;
|
|
467
|
+
/**
|
|
468
|
+
* Indicates whether the device detects that the space is occupied, if the device measures occupancy.
|
|
469
|
+
*/
|
|
470
|
+
is_occupied?: boolean | undefined;
|
|
471
|
+
/**
|
|
472
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
473
|
+
*/
|
|
474
|
+
is_smoking_detected?: boolean | undefined;
|
|
455
475
|
/**
|
|
456
476
|
* Location information for the device.
|
|
457
477
|
*/
|
|
@@ -474,10 +494,87 @@ export type Device = {
|
|
|
474
494
|
*/
|
|
475
495
|
timezone?: string | undefined;
|
|
476
496
|
} | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
499
|
+
*/
|
|
500
|
+
mold_risk_level?: string | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* 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.
|
|
503
|
+
*/
|
|
504
|
+
named_sensors?: Array<{
|
|
505
|
+
/**
|
|
506
|
+
* Air quality index, if the device measures it.
|
|
507
|
+
*/
|
|
508
|
+
air_quality_index?: number | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* Carbon dioxide concentration in parts per million, if the device measures it.
|
|
511
|
+
*/
|
|
512
|
+
co2_ppm?: number | undefined;
|
|
513
|
+
/**
|
|
514
|
+
* Carbon monoxide concentration in parts per million, if the device measures it.
|
|
515
|
+
*/
|
|
516
|
+
co_ppm?: number | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* Display name of the sensor. Defaults to `sensor_name`.
|
|
519
|
+
*/
|
|
520
|
+
display_name: string;
|
|
521
|
+
/**
|
|
522
|
+
* Indicates whether the device detects that the space is occupied, if the device measures occupancy.
|
|
523
|
+
*/
|
|
524
|
+
is_occupied?: boolean | undefined;
|
|
525
|
+
/**
|
|
526
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
527
|
+
*/
|
|
528
|
+
is_smoking_detected?: boolean | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
531
|
+
*/
|
|
532
|
+
mold_risk_level?: string | undefined;
|
|
533
|
+
/**
|
|
534
|
+
* Noise level in decibels, if the device measures noise.
|
|
535
|
+
*/
|
|
536
|
+
noise_level_decibels?: number | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
539
|
+
*/
|
|
540
|
+
noise_level_nrs?: number | undefined;
|
|
541
|
+
/**
|
|
542
|
+
* Number of occupants the device detects, if the device counts occupants.
|
|
543
|
+
*/
|
|
544
|
+
occupant_count?: number | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
547
|
+
*/
|
|
548
|
+
relative_humidity?: number | undefined;
|
|
549
|
+
/**
|
|
550
|
+
* Stable, hardware-defined name of the sensor, such as a port number.
|
|
551
|
+
*/
|
|
552
|
+
sensor_name: string;
|
|
553
|
+
/**
|
|
554
|
+
* Temperature in °C, if the device measures temperature.
|
|
555
|
+
*/
|
|
556
|
+
temperature_celsius?: number | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* Temperature in °F, if the device measures temperature.
|
|
559
|
+
*/
|
|
560
|
+
temperature_fahrenheit?: number | undefined;
|
|
561
|
+
}> | undefined;
|
|
477
562
|
/**
|
|
478
563
|
* Optional nickname to describe the device, settable through Seam.
|
|
479
564
|
*/
|
|
480
565
|
nickname?: string | undefined;
|
|
566
|
+
/**
|
|
567
|
+
* Noise level in decibels, if the device measures noise.
|
|
568
|
+
*/
|
|
569
|
+
noise_level_decibels?: number | undefined;
|
|
570
|
+
/**
|
|
571
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
572
|
+
*/
|
|
573
|
+
noise_level_nrs?: number | undefined;
|
|
574
|
+
/**
|
|
575
|
+
* Number of occupants the device detects, if the device counts occupants.
|
|
576
|
+
*/
|
|
577
|
+
occupant_count?: number | undefined;
|
|
481
578
|
/**
|
|
482
579
|
* Properties of the device.
|
|
483
580
|
*/
|
|
@@ -2580,10 +2677,22 @@ export type Device = {
|
|
|
2580
2677
|
wednesday_program_id: string | null;
|
|
2581
2678
|
} | null | undefined;
|
|
2582
2679
|
};
|
|
2680
|
+
/**
|
|
2681
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
2682
|
+
*/
|
|
2683
|
+
relative_humidity?: number | undefined;
|
|
2583
2684
|
/**
|
|
2584
2685
|
* IDs of the spaces the device is in.
|
|
2585
2686
|
*/
|
|
2586
2687
|
space_ids: Array<string>;
|
|
2688
|
+
/**
|
|
2689
|
+
* Temperature in °C, if the device measures temperature.
|
|
2690
|
+
*/
|
|
2691
|
+
temperature_celsius?: number | undefined;
|
|
2692
|
+
/**
|
|
2693
|
+
* Temperature in °F, if the device measures temperature.
|
|
2694
|
+
*/
|
|
2695
|
+
temperature_fahrenheit?: number | undefined;
|
|
2587
2696
|
/**
|
|
2588
2697
|
* 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
2698
|
*/
|
|
@@ -113,7 +113,7 @@ export type UnmanagedDevice = {
|
|
|
113
113
|
/**
|
|
114
114
|
* 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`.
|
|
115
115
|
*/
|
|
116
|
-
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';
|
|
116
|
+
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' | 'alertify_sensor';
|
|
117
117
|
/**
|
|
118
118
|
* 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.
|
|
119
119
|
*/
|
|
@@ -50,7 +50,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
50
50
|
/**
|
|
51
51
|
* Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters.
|
|
52
52
|
*/
|
|
53
|
-
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
53
|
+
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
54
54
|
/**
|
|
55
55
|
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
56
56
|
*/
|
|
@@ -101,11 +101,11 @@ export type DevicesListParameters = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Device type for which you want to list devices.
|
|
103
103
|
*/
|
|
104
|
-
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' | undefined;
|
|
104
|
+
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' | 'alertify_sensor' | undefined;
|
|
105
105
|
/**
|
|
106
106
|
* Array of device types for which you want to list devices.
|
|
107
107
|
*/
|
|
108
|
-
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | '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'> | undefined;
|
|
108
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | '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' | 'alertify_sensor'> | undefined;
|
|
109
109
|
/**
|
|
110
110
|
* Numerical limit on the number of devices to return.
|
|
111
111
|
*/
|
|
@@ -113,7 +113,7 @@ export type DevicesListParameters = {
|
|
|
113
113
|
/**
|
|
114
114
|
* Manufacturer for which you want to list devices.
|
|
115
115
|
*/
|
|
116
|
-
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
116
|
+
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
119
119
|
*/
|
|
@@ -84,11 +84,11 @@ export type DevicesUnmanagedListParameters = {
|
|
|
84
84
|
/**
|
|
85
85
|
* Device type for which you want to list devices.
|
|
86
86
|
*/
|
|
87
|
-
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' | undefined;
|
|
87
|
+
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' | 'alertify_sensor' | undefined;
|
|
88
88
|
/**
|
|
89
89
|
* Array of device types for which you want to list devices.
|
|
90
90
|
*/
|
|
91
|
-
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | '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'> | undefined;
|
|
91
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | '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' | 'alertify_sensor'> | undefined;
|
|
92
92
|
/**
|
|
93
93
|
* Numerical limit on the number of devices to return.
|
|
94
94
|
*/
|
|
@@ -96,7 +96,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
96
96
|
/**
|
|
97
97
|
* Manufacturer for which you want to list devices.
|
|
98
98
|
*/
|
|
99
|
-
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
99
|
+
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'alertify' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
102
102
|
*/
|
|
@@ -48,7 +48,7 @@ export type NoiseSensorsListParameters = {
|
|
|
48
48
|
/**
|
|
49
49
|
* Manufacturers of the noise sensors that you want to list.
|
|
50
50
|
*/
|
|
51
|
-
manufacturer?: 'minut' | 'noiseaware' | undefined;
|
|
51
|
+
manufacturer?: 'minut' | 'noiseaware' | 'alertify' | undefined;
|
|
52
52
|
};
|
|
53
53
|
/**
|
|
54
54
|
* @deprecated Use NoiseSensorsListRequest instead.
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.50.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.50.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -85,10 +85,10 @@
|
|
|
85
85
|
"axios-retry": "^4.4.2"
|
|
86
86
|
},
|
|
87
87
|
"devDependencies": {
|
|
88
|
-
"@seamapi/blueprint": "^1.
|
|
88
|
+
"@seamapi/blueprint": "^1.13.2",
|
|
89
89
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
90
|
-
"@seamapi/smith": "^1.
|
|
91
|
-
"@seamapi/types": "1.
|
|
90
|
+
"@seamapi/smith": "^1.2.0",
|
|
91
|
+
"@seamapi/types": "1.1187.0",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -7,6 +7,10 @@
|
|
|
7
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
|
+
/**
|
|
11
|
+
* Air quality index, if the device measures it.
|
|
12
|
+
*/
|
|
13
|
+
air_quality_index?: number | undefined
|
|
10
14
|
/**
|
|
11
15
|
* 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.
|
|
12
16
|
*/
|
|
@@ -107,6 +111,14 @@ export type Device = {
|
|
|
107
111
|
| 'phone'
|
|
108
112
|
>
|
|
109
113
|
|
|
114
|
+
/**
|
|
115
|
+
* Carbon dioxide concentration in parts per million, if the device measures it.
|
|
116
|
+
*/
|
|
117
|
+
co2_ppm?: number | undefined
|
|
118
|
+
/**
|
|
119
|
+
* Carbon monoxide concentration in parts per million, if the device measures it.
|
|
120
|
+
*/
|
|
121
|
+
co_ppm?: number | undefined
|
|
110
122
|
/**
|
|
111
123
|
* Unique identifier for the account associated with the device.
|
|
112
124
|
*/
|
|
@@ -228,6 +240,7 @@ export type Device = {
|
|
|
228
240
|
| 'reolink_camera'
|
|
229
241
|
| 'unifi_protect_camera'
|
|
230
242
|
| 'sonos_speaker'
|
|
243
|
+
| 'alertify_sensor'
|
|
231
244
|
|
|
232
245
|
/**
|
|
233
246
|
* 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.
|
|
@@ -591,6 +604,14 @@ export type Device = {
|
|
|
591
604
|
*/
|
|
592
605
|
is_managed: true
|
|
593
606
|
|
|
607
|
+
/**
|
|
608
|
+
* Indicates whether the device detects that the space is occupied, if the device measures occupancy.
|
|
609
|
+
*/
|
|
610
|
+
is_occupied?: boolean | undefined
|
|
611
|
+
/**
|
|
612
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
613
|
+
*/
|
|
614
|
+
is_smoking_detected?: boolean | undefined
|
|
594
615
|
/**
|
|
595
616
|
* Location information for the device.
|
|
596
617
|
*/
|
|
@@ -615,10 +636,91 @@ export type Device = {
|
|
|
615
636
|
timezone?: string | undefined
|
|
616
637
|
}
|
|
617
638
|
| undefined
|
|
639
|
+
/**
|
|
640
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
641
|
+
*/
|
|
642
|
+
mold_risk_level?: string | undefined
|
|
643
|
+
/**
|
|
644
|
+
* 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.
|
|
645
|
+
*/
|
|
646
|
+
named_sensors?:
|
|
647
|
+
| Array<{
|
|
648
|
+
/**
|
|
649
|
+
* Air quality index, if the device measures it.
|
|
650
|
+
*/
|
|
651
|
+
air_quality_index?: number | undefined
|
|
652
|
+
/**
|
|
653
|
+
* Carbon dioxide concentration in parts per million, if the device measures it.
|
|
654
|
+
*/
|
|
655
|
+
co2_ppm?: number | undefined
|
|
656
|
+
/**
|
|
657
|
+
* Carbon monoxide concentration in parts per million, if the device measures it.
|
|
658
|
+
*/
|
|
659
|
+
co_ppm?: number | undefined
|
|
660
|
+
/**
|
|
661
|
+
* Display name of the sensor. Defaults to `sensor_name`.
|
|
662
|
+
*/
|
|
663
|
+
display_name: string
|
|
664
|
+
|
|
665
|
+
/**
|
|
666
|
+
* Indicates whether the device detects that the space is occupied, if the device measures occupancy.
|
|
667
|
+
*/
|
|
668
|
+
is_occupied?: boolean | undefined
|
|
669
|
+
/**
|
|
670
|
+
* Indicates whether the device detects smoking, if the device measures it.
|
|
671
|
+
*/
|
|
672
|
+
is_smoking_detected?: boolean | undefined
|
|
673
|
+
/**
|
|
674
|
+
* Mold risk level as reported by the device, if the device measures it.
|
|
675
|
+
*/
|
|
676
|
+
mold_risk_level?: string | undefined
|
|
677
|
+
/**
|
|
678
|
+
* Noise level in decibels, if the device measures noise.
|
|
679
|
+
*/
|
|
680
|
+
noise_level_decibels?: number | undefined
|
|
681
|
+
/**
|
|
682
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
683
|
+
*/
|
|
684
|
+
noise_level_nrs?: number | undefined
|
|
685
|
+
/**
|
|
686
|
+
* Number of occupants the device detects, if the device counts occupants.
|
|
687
|
+
*/
|
|
688
|
+
occupant_count?: number | undefined
|
|
689
|
+
/**
|
|
690
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
691
|
+
*/
|
|
692
|
+
relative_humidity?: number | undefined
|
|
693
|
+
/**
|
|
694
|
+
* Stable, hardware-defined name of the sensor, such as a port number.
|
|
695
|
+
*/
|
|
696
|
+
sensor_name: string
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* Temperature in °C, if the device measures temperature.
|
|
700
|
+
*/
|
|
701
|
+
temperature_celsius?: number | undefined
|
|
702
|
+
/**
|
|
703
|
+
* Temperature in °F, if the device measures temperature.
|
|
704
|
+
*/
|
|
705
|
+
temperature_fahrenheit?: number | undefined
|
|
706
|
+
}>
|
|
707
|
+
| undefined
|
|
618
708
|
/**
|
|
619
709
|
* Optional nickname to describe the device, settable through Seam.
|
|
620
710
|
*/
|
|
621
711
|
nickname?: string | undefined
|
|
712
|
+
/**
|
|
713
|
+
* Noise level in decibels, if the device measures noise.
|
|
714
|
+
*/
|
|
715
|
+
noise_level_decibels?: number | undefined
|
|
716
|
+
/**
|
|
717
|
+
* Noise level as a Noise Risk Score (NRS), if the device reports one.
|
|
718
|
+
*/
|
|
719
|
+
noise_level_nrs?: number | undefined
|
|
720
|
+
/**
|
|
721
|
+
* Number of occupants the device detects, if the device counts occupants.
|
|
722
|
+
*/
|
|
723
|
+
occupant_count?: number | undefined
|
|
622
724
|
/**
|
|
623
725
|
* Properties of the device.
|
|
624
726
|
*/
|
|
@@ -2963,11 +3065,23 @@ export type Device = {
|
|
|
2963
3065
|
| undefined
|
|
2964
3066
|
}
|
|
2965
3067
|
|
|
3068
|
+
/**
|
|
3069
|
+
* Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
|
|
3070
|
+
*/
|
|
3071
|
+
relative_humidity?: number | undefined
|
|
2966
3072
|
/**
|
|
2967
3073
|
* IDs of the spaces the device is in.
|
|
2968
3074
|
*/
|
|
2969
3075
|
space_ids: Array<string>
|
|
2970
3076
|
|
|
3077
|
+
/**
|
|
3078
|
+
* Temperature in °C, if the device measures temperature.
|
|
3079
|
+
*/
|
|
3080
|
+
temperature_celsius?: number | undefined
|
|
3081
|
+
/**
|
|
3082
|
+
* Temperature in °F, if the device measures temperature.
|
|
3083
|
+
*/
|
|
3084
|
+
temperature_fahrenheit?: number | undefined
|
|
2971
3085
|
/**
|
|
2972
3086
|
* 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.
|
|
2973
3087
|
*/
|
|
@@ -183,6 +183,7 @@ export type UnmanagedDevice = {
|
|
|
183
183
|
| 'reolink_camera'
|
|
184
184
|
| 'unifi_protect_camera'
|
|
185
185
|
| 'sonos_speaker'
|
|
186
|
+
| 'alertify_sensor'
|
|
186
187
|
|
|
187
188
|
/**
|
|
188
189
|
* 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.
|
|
@@ -392,6 +392,7 @@ export type DevicesListParameters = {
|
|
|
392
392
|
| 'reolink_camera'
|
|
393
393
|
| 'unifi_protect_camera'
|
|
394
394
|
| 'sonos_speaker'
|
|
395
|
+
| 'alertify_sensor'
|
|
395
396
|
| undefined
|
|
396
397
|
/**
|
|
397
398
|
* Array of device types for which you want to list devices.
|
|
@@ -450,6 +451,7 @@ export type DevicesListParameters = {
|
|
|
450
451
|
| 'reolink_camera'
|
|
451
452
|
| 'unifi_protect_camera'
|
|
452
453
|
| 'sonos_speaker'
|
|
454
|
+
| 'alertify_sensor'
|
|
453
455
|
>
|
|
454
456
|
| undefined
|
|
455
457
|
/**
|
|
@@ -511,6 +513,7 @@ export type DevicesListParameters = {
|
|
|
511
513
|
| 'reolink'
|
|
512
514
|
| 'unifi_protect'
|
|
513
515
|
| 'yale_connect'
|
|
516
|
+
| 'alertify'
|
|
514
517
|
| 'ical'
|
|
515
518
|
| 'lodgify'
|
|
516
519
|
| 'hostaway'
|
|
@@ -339,6 +339,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
339
339
|
| 'reolink_camera'
|
|
340
340
|
| 'unifi_protect_camera'
|
|
341
341
|
| 'sonos_speaker'
|
|
342
|
+
| 'alertify_sensor'
|
|
342
343
|
| undefined
|
|
343
344
|
/**
|
|
344
345
|
* Array of device types for which you want to list devices.
|
|
@@ -397,6 +398,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
397
398
|
| 'reolink_camera'
|
|
398
399
|
| 'unifi_protect_camera'
|
|
399
400
|
| 'sonos_speaker'
|
|
401
|
+
| 'alertify_sensor'
|
|
400
402
|
>
|
|
401
403
|
| undefined
|
|
402
404
|
/**
|
|
@@ -458,6 +460,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
458
460
|
| 'reolink'
|
|
459
461
|
| 'unifi_protect'
|
|
460
462
|
| 'yale_connect'
|
|
463
|
+
| 'alertify'
|
|
461
464
|
| 'ical'
|
|
462
465
|
| 'lodgify'
|
|
463
466
|
| 'hostaway'
|
|
@@ -220,7 +220,7 @@ export type NoiseSensorsListParameters = {
|
|
|
220
220
|
/**
|
|
221
221
|
* Manufacturers of the noise sensors that you want to list.
|
|
222
222
|
*/
|
|
223
|
-
manufacturer?: 'minut' | 'noiseaware' | undefined
|
|
223
|
+
manufacturer?: 'minut' | 'noiseaware' | 'alertify' | undefined
|
|
224
224
|
}
|
|
225
225
|
|
|
226
226
|
/**
|
package/src/lib/version.ts
CHANGED