@seamapi/types 1.1184.0 → 1.1186.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/seam/connect/models/devices/capability-properties/index.d.ts +9 -9
- package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +9 -9
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js +3 -3
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
- package/lib/seam/connect/models/devices/device-metadata.js +31 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +7 -1
- package/lib/seam/connect/models/devices/device-type.js +8 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +371 -26
- package/lib/seam/connect/models/devices/device.js +159 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +205 -16
- package/lib/seam/connect/openapi.js +229 -1
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1117 -97
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +3 -3
- package/src/lib/seam/connect/models/devices/device-metadata.ts +32 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +16 -0
- package/src/lib/seam/connect/models/devices/device.ts +187 -0
- package/src/lib/seam/connect/openapi.ts +257 -1
- package/src/lib/seam/connect/route-types.ts +1240 -69
|
@@ -16041,6 +16041,11 @@ const openapi: OpenAPISpec = {
|
|
|
16041
16041
|
enum: ['sonos_speaker'],
|
|
16042
16042
|
type: 'string',
|
|
16043
16043
|
},
|
|
16044
|
+
{
|
|
16045
|
+
description: 'Device type for environmental sensors.',
|
|
16046
|
+
enum: ['alertify_sensor'],
|
|
16047
|
+
type: 'string',
|
|
16048
|
+
},
|
|
16044
16049
|
],
|
|
16045
16050
|
},
|
|
16046
16051
|
display_name: {
|
|
@@ -16685,6 +16690,14 @@ const openapi: OpenAPISpec = {
|
|
|
16685
16690
|
type: 'object',
|
|
16686
16691
|
'x-property-group-key': 'hardware',
|
|
16687
16692
|
},
|
|
16693
|
+
air_quality_index: {
|
|
16694
|
+
description:
|
|
16695
|
+
'Air quality index, if the device measures it. `null` until the first value arrives.',
|
|
16696
|
+
format: 'float',
|
|
16697
|
+
nullable: true,
|
|
16698
|
+
type: 'number',
|
|
16699
|
+
'x-property-group-key': 'sensors',
|
|
16700
|
+
},
|
|
16688
16701
|
appearance: {
|
|
16689
16702
|
description:
|
|
16690
16703
|
'Appearance-related properties, as reported by the device.',
|
|
@@ -16731,6 +16744,22 @@ const openapi: OpenAPISpec = {
|
|
|
16731
16744
|
type: 'number',
|
|
16732
16745
|
'x-property-group-key': 'hardware',
|
|
16733
16746
|
},
|
|
16747
|
+
co2_ppm: {
|
|
16748
|
+
description:
|
|
16749
|
+
'Carbon dioxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
|
|
16750
|
+
format: 'float',
|
|
16751
|
+
nullable: true,
|
|
16752
|
+
type: 'number',
|
|
16753
|
+
'x-property-group-key': 'sensors',
|
|
16754
|
+
},
|
|
16755
|
+
co_ppm: {
|
|
16756
|
+
description:
|
|
16757
|
+
'Carbon monoxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
|
|
16758
|
+
format: 'float',
|
|
16759
|
+
nullable: true,
|
|
16760
|
+
type: 'number',
|
|
16761
|
+
'x-property-group-key': 'sensors',
|
|
16762
|
+
},
|
|
16734
16763
|
currently_triggering_noise_threshold_ids: {
|
|
16735
16764
|
description:
|
|
16736
16765
|
'Array of noise threshold IDs that are currently triggering.',
|
|
@@ -16755,6 +16784,20 @@ const openapi: OpenAPISpec = {
|
|
|
16755
16784
|
type: 'string',
|
|
16756
16785
|
'x-property-group-key': 'hardware',
|
|
16757
16786
|
},
|
|
16787
|
+
is_occupied: {
|
|
16788
|
+
description:
|
|
16789
|
+
'Indicates whether the device detects that the space is occupied, if the device measures occupancy. `null` until the first value arrives.',
|
|
16790
|
+
nullable: true,
|
|
16791
|
+
type: 'boolean',
|
|
16792
|
+
'x-property-group-key': 'sensors',
|
|
16793
|
+
},
|
|
16794
|
+
is_smoking_detected: {
|
|
16795
|
+
description:
|
|
16796
|
+
'Indicates whether the device detects smoking, if the device measures it. `null` until the first value arrives.',
|
|
16797
|
+
nullable: true,
|
|
16798
|
+
type: 'boolean',
|
|
16799
|
+
'x-property-group-key': 'sensors',
|
|
16800
|
+
},
|
|
16758
16801
|
manufacturer: {
|
|
16759
16802
|
description:
|
|
16760
16803
|
'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
|
|
@@ -16809,19 +16852,167 @@ const openapi: OpenAPISpec = {
|
|
|
16809
16852
|
],
|
|
16810
16853
|
type: 'object',
|
|
16811
16854
|
},
|
|
16855
|
+
mold_risk_level: {
|
|
16856
|
+
description:
|
|
16857
|
+
'Mold risk level as reported by the device, if the device measures it. `null` until the first value arrives.',
|
|
16858
|
+
nullable: true,
|
|
16859
|
+
type: 'string',
|
|
16860
|
+
'x-property-group-key': 'sensors',
|
|
16861
|
+
},
|
|
16812
16862
|
name: {
|
|
16813
16863
|
deprecated: true,
|
|
16814
16864
|
description: 'Name of the device.',
|
|
16815
16865
|
type: 'string',
|
|
16816
16866
|
'x-deprecated': 'use device.display_name instead',
|
|
16817
16867
|
},
|
|
16868
|
+
named_sensors: {
|
|
16869
|
+
description:
|
|
16870
|
+
'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.',
|
|
16871
|
+
items: {
|
|
16872
|
+
description:
|
|
16873
|
+
'A sensor on the device, with the same measurement fields as the device.',
|
|
16874
|
+
properties: {
|
|
16875
|
+
air_quality_index: {
|
|
16876
|
+
description:
|
|
16877
|
+
'Air quality index, if the device measures it. `null` until the first value arrives.',
|
|
16878
|
+
format: 'float',
|
|
16879
|
+
nullable: true,
|
|
16880
|
+
type: 'number',
|
|
16881
|
+
'x-property-group-key': 'sensors',
|
|
16882
|
+
},
|
|
16883
|
+
co2_ppm: {
|
|
16884
|
+
description:
|
|
16885
|
+
'Carbon dioxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
|
|
16886
|
+
format: 'float',
|
|
16887
|
+
nullable: true,
|
|
16888
|
+
type: 'number',
|
|
16889
|
+
'x-property-group-key': 'sensors',
|
|
16890
|
+
},
|
|
16891
|
+
co_ppm: {
|
|
16892
|
+
description:
|
|
16893
|
+
'Carbon monoxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
|
|
16894
|
+
format: 'float',
|
|
16895
|
+
nullable: true,
|
|
16896
|
+
type: 'number',
|
|
16897
|
+
'x-property-group-key': 'sensors',
|
|
16898
|
+
},
|
|
16899
|
+
display_name: {
|
|
16900
|
+
description:
|
|
16901
|
+
'Display name of the sensor. Defaults to `sensor_name`.',
|
|
16902
|
+
type: 'string',
|
|
16903
|
+
'x-property-group-key': 'sensors',
|
|
16904
|
+
},
|
|
16905
|
+
is_occupied: {
|
|
16906
|
+
description:
|
|
16907
|
+
'Indicates whether the device detects that the space is occupied, if the device measures occupancy. `null` until the first value arrives.',
|
|
16908
|
+
nullable: true,
|
|
16909
|
+
type: 'boolean',
|
|
16910
|
+
'x-property-group-key': 'sensors',
|
|
16911
|
+
},
|
|
16912
|
+
is_smoking_detected: {
|
|
16913
|
+
description:
|
|
16914
|
+
'Indicates whether the device detects smoking, if the device measures it. `null` until the first value arrives.',
|
|
16915
|
+
nullable: true,
|
|
16916
|
+
type: 'boolean',
|
|
16917
|
+
'x-property-group-key': 'sensors',
|
|
16918
|
+
},
|
|
16919
|
+
mold_risk_level: {
|
|
16920
|
+
description:
|
|
16921
|
+
'Mold risk level as reported by the device, if the device measures it. `null` until the first value arrives.',
|
|
16922
|
+
nullable: true,
|
|
16923
|
+
type: 'string',
|
|
16924
|
+
'x-property-group-key': 'sensors',
|
|
16925
|
+
},
|
|
16926
|
+
noise_level_decibels: {
|
|
16927
|
+
description:
|
|
16928
|
+
'Noise level in decibels. `null` until the first value arrives.',
|
|
16929
|
+
format: 'float',
|
|
16930
|
+
nullable: true,
|
|
16931
|
+
type: 'number',
|
|
16932
|
+
'x-property-group-key': 'sensors',
|
|
16933
|
+
},
|
|
16934
|
+
noise_level_nrs: {
|
|
16935
|
+
description:
|
|
16936
|
+
'Noise level as a Noise Risk Score (NRS), if the device reports one. `null` until the first value arrives.',
|
|
16937
|
+
format: 'float',
|
|
16938
|
+
nullable: true,
|
|
16939
|
+
type: 'number',
|
|
16940
|
+
'x-property-group-key': 'sensors',
|
|
16941
|
+
},
|
|
16942
|
+
occupant_count: {
|
|
16943
|
+
description:
|
|
16944
|
+
'Number of occupants the device detects, if the device counts occupants. `null` until the first value arrives.',
|
|
16945
|
+
format: 'float',
|
|
16946
|
+
nullable: true,
|
|
16947
|
+
type: 'number',
|
|
16948
|
+
'x-property-group-key': 'sensors',
|
|
16949
|
+
},
|
|
16950
|
+
relative_humidity: {
|
|
16951
|
+
description:
|
|
16952
|
+
'Reported relative humidity, as a value between 0 and 1, inclusive. `null` until the first value arrives.',
|
|
16953
|
+
format: 'float',
|
|
16954
|
+
maximum: 1,
|
|
16955
|
+
minimum: 0,
|
|
16956
|
+
nullable: true,
|
|
16957
|
+
type: 'number',
|
|
16958
|
+
'x-property-group-key': 'sensors',
|
|
16959
|
+
},
|
|
16960
|
+
sensor_name: {
|
|
16961
|
+
description:
|
|
16962
|
+
'Stable, hardware-defined name of the sensor, such as a port number.',
|
|
16963
|
+
type: 'string',
|
|
16964
|
+
'x-property-group-key': 'sensors',
|
|
16965
|
+
},
|
|
16966
|
+
temperature_celsius: {
|
|
16967
|
+
description:
|
|
16968
|
+
'Reported temperature in °C. `null` until the first value arrives.',
|
|
16969
|
+
format: 'float',
|
|
16970
|
+
nullable: true,
|
|
16971
|
+
type: 'number',
|
|
16972
|
+
'x-property-group-key': 'sensors',
|
|
16973
|
+
},
|
|
16974
|
+
temperature_fahrenheit: {
|
|
16975
|
+
description:
|
|
16976
|
+
'Reported temperature in °F. `null` until the first value arrives.',
|
|
16977
|
+
format: 'float',
|
|
16978
|
+
nullable: true,
|
|
16979
|
+
type: 'number',
|
|
16980
|
+
'x-property-group-key': 'sensors',
|
|
16981
|
+
},
|
|
16982
|
+
},
|
|
16983
|
+
required: ['sensor_name', 'display_name'],
|
|
16984
|
+
type: 'object',
|
|
16985
|
+
'x-property-groups': {
|
|
16986
|
+
sensors: { name: 'Sensors' },
|
|
16987
|
+
},
|
|
16988
|
+
},
|
|
16989
|
+
type: 'array',
|
|
16990
|
+
'x-property-group-key': 'sensors',
|
|
16991
|
+
},
|
|
16818
16992
|
noise_level_decibels: {
|
|
16819
16993
|
description:
|
|
16820
16994
|
'Indicates current noise level in decibels, if the device supports noise detection.',
|
|
16821
16995
|
format: 'float',
|
|
16996
|
+
nullable: true,
|
|
16822
16997
|
type: 'number',
|
|
16823
16998
|
'x-property-group-key': 'noise_sensors',
|
|
16824
16999
|
},
|
|
17000
|
+
noise_level_nrs: {
|
|
17001
|
+
description:
|
|
17002
|
+
'Noise level as a Noise Risk Score (NRS), if the device reports one. `null` until the first value arrives.',
|
|
17003
|
+
format: 'float',
|
|
17004
|
+
nullable: true,
|
|
17005
|
+
type: 'number',
|
|
17006
|
+
'x-property-group-key': 'sensors',
|
|
17007
|
+
},
|
|
17008
|
+
occupant_count: {
|
|
17009
|
+
description:
|
|
17010
|
+
'Number of occupants the device detects, if the device counts occupants. `null` until the first value arrives.',
|
|
17011
|
+
format: 'float',
|
|
17012
|
+
nullable: true,
|
|
17013
|
+
type: 'number',
|
|
17014
|
+
'x-property-group-key': 'sensors',
|
|
17015
|
+
},
|
|
16825
17016
|
offline_access_codes_enabled: {
|
|
16826
17017
|
deprecated: true,
|
|
16827
17018
|
description:
|
|
@@ -16941,6 +17132,38 @@ const openapi: OpenAPISpec = {
|
|
|
16941
17132
|
},
|
|
16942
17133
|
type: 'object',
|
|
16943
17134
|
},
|
|
17135
|
+
alertify_metadata: {
|
|
17136
|
+
description: 'Metadata for an Alertify sensor.',
|
|
17137
|
+
properties: {
|
|
17138
|
+
building_id: {
|
|
17139
|
+
description:
|
|
17140
|
+
'ID of the Alertify building that contains the unit.',
|
|
17141
|
+
nullable: true,
|
|
17142
|
+
type: 'string',
|
|
17143
|
+
},
|
|
17144
|
+
device_id: {
|
|
17145
|
+
description: 'Device ID reported by Alertify.',
|
|
17146
|
+
type: 'string',
|
|
17147
|
+
},
|
|
17148
|
+
device_name: {
|
|
17149
|
+
description:
|
|
17150
|
+
'Device name, as set in the Alertify dashboard.',
|
|
17151
|
+
type: 'string',
|
|
17152
|
+
},
|
|
17153
|
+
unit_id: {
|
|
17154
|
+
description:
|
|
17155
|
+
'ID of the Alertify unit where the device is installed.',
|
|
17156
|
+
type: 'string',
|
|
17157
|
+
},
|
|
17158
|
+
unit_name: {
|
|
17159
|
+
description:
|
|
17160
|
+
'Name of the Alertify unit where the device is installed.',
|
|
17161
|
+
type: 'string',
|
|
17162
|
+
},
|
|
17163
|
+
},
|
|
17164
|
+
type: 'object',
|
|
17165
|
+
'x-undocumented': 'Unreleased.',
|
|
17166
|
+
},
|
|
16944
17167
|
aqara_metadata: {
|
|
16945
17168
|
description: 'Metadata for an Aqara device.',
|
|
16946
17169
|
properties: {
|
|
@@ -19591,18 +19814,21 @@ const openapi: OpenAPISpec = {
|
|
|
19591
19814
|
format: 'float',
|
|
19592
19815
|
maximum: 1,
|
|
19593
19816
|
minimum: 0,
|
|
19817
|
+
nullable: true,
|
|
19594
19818
|
type: 'number',
|
|
19595
19819
|
'x-property-group-key': 'thermostats',
|
|
19596
19820
|
},
|
|
19597
19821
|
temperature_celsius: {
|
|
19598
19822
|
description: 'Reported temperature in °C.',
|
|
19599
19823
|
format: 'float',
|
|
19824
|
+
nullable: true,
|
|
19600
19825
|
type: 'number',
|
|
19601
19826
|
'x-property-group-key': 'thermostats',
|
|
19602
19827
|
},
|
|
19603
19828
|
temperature_fahrenheit: {
|
|
19604
19829
|
description: 'Reported temperature in °F.',
|
|
19605
19830
|
format: 'float',
|
|
19831
|
+
nullable: true,
|
|
19606
19832
|
type: 'number',
|
|
19607
19833
|
'x-property-group-key': 'thermostats',
|
|
19608
19834
|
},
|
|
@@ -19823,6 +20049,7 @@ const openapi: OpenAPISpec = {
|
|
|
19823
20049
|
noise_sensors: { name: 'Noise Sensors' },
|
|
19824
20050
|
phones: { name: 'Phones' },
|
|
19825
20051
|
provider_metadata: { name: 'Provider Metadata' },
|
|
20052
|
+
sensors: { name: 'Sensors' },
|
|
19826
20053
|
speakers: { name: 'Speakers' },
|
|
19827
20054
|
thermostats: { name: 'Thermostats' },
|
|
19828
20055
|
},
|
|
@@ -20874,6 +21101,7 @@ const openapi: OpenAPISpec = {
|
|
|
20874
21101
|
'reolink',
|
|
20875
21102
|
'unifi_protect',
|
|
20876
21103
|
'yale_connect',
|
|
21104
|
+
'alertify',
|
|
20877
21105
|
'ical',
|
|
20878
21106
|
'lodgify',
|
|
20879
21107
|
'hostaway',
|
|
@@ -41349,6 +41577,11 @@ const openapi: OpenAPISpec = {
|
|
|
41349
41577
|
enum: ['sonos_speaker'],
|
|
41350
41578
|
type: 'string',
|
|
41351
41579
|
},
|
|
41580
|
+
{
|
|
41581
|
+
description: 'Device type for environmental sensors.',
|
|
41582
|
+
enum: ['alertify_sensor'],
|
|
41583
|
+
type: 'string',
|
|
41584
|
+
},
|
|
41352
41585
|
],
|
|
41353
41586
|
},
|
|
41354
41587
|
display_name: {
|
|
@@ -52270,6 +52503,7 @@ const openapi: OpenAPISpec = {
|
|
|
52270
52503
|
'reolink',
|
|
52271
52504
|
'unifi_protect',
|
|
52272
52505
|
'yale_connect',
|
|
52506
|
+
'alertify',
|
|
52273
52507
|
'ical',
|
|
52274
52508
|
'lodgify',
|
|
52275
52509
|
'hostaway',
|
|
@@ -56256,6 +56490,11 @@ const openapi: OpenAPISpec = {
|
|
|
56256
56490
|
enum: ['sonos_speaker'],
|
|
56257
56491
|
type: 'string',
|
|
56258
56492
|
},
|
|
56493
|
+
{
|
|
56494
|
+
description: 'Device type for environmental sensors.',
|
|
56495
|
+
enum: ['alertify_sensor'],
|
|
56496
|
+
type: 'string',
|
|
56497
|
+
},
|
|
56259
56498
|
],
|
|
56260
56499
|
},
|
|
56261
56500
|
},
|
|
@@ -56351,6 +56590,11 @@ const openapi: OpenAPISpec = {
|
|
|
56351
56590
|
enum: ['sonos_speaker'],
|
|
56352
56591
|
type: 'string',
|
|
56353
56592
|
},
|
|
56593
|
+
{
|
|
56594
|
+
description: 'Device type for environmental sensors.',
|
|
56595
|
+
enum: ['alertify_sensor'],
|
|
56596
|
+
type: 'string',
|
|
56597
|
+
},
|
|
56354
56598
|
],
|
|
56355
56599
|
},
|
|
56356
56600
|
type: 'array',
|
|
@@ -56413,6 +56657,7 @@ const openapi: OpenAPISpec = {
|
|
|
56413
56657
|
'reolink',
|
|
56414
56658
|
'unifi_protect',
|
|
56415
56659
|
'yale_connect',
|
|
56660
|
+
'alertify',
|
|
56416
56661
|
'ical',
|
|
56417
56662
|
'lodgify',
|
|
56418
56663
|
'hostaway',
|
|
@@ -58614,6 +58859,11 @@ const openapi: OpenAPISpec = {
|
|
|
58614
58859
|
enum: ['sonos_speaker'],
|
|
58615
58860
|
type: 'string',
|
|
58616
58861
|
},
|
|
58862
|
+
{
|
|
58863
|
+
description: 'Device type for environmental sensors.',
|
|
58864
|
+
enum: ['alertify_sensor'],
|
|
58865
|
+
type: 'string',
|
|
58866
|
+
},
|
|
58617
58867
|
],
|
|
58618
58868
|
},
|
|
58619
58869
|
},
|
|
@@ -58709,6 +58959,11 @@ const openapi: OpenAPISpec = {
|
|
|
58709
58959
|
enum: ['sonos_speaker'],
|
|
58710
58960
|
type: 'string',
|
|
58711
58961
|
},
|
|
58962
|
+
{
|
|
58963
|
+
description: 'Device type for environmental sensors.',
|
|
58964
|
+
enum: ['alertify_sensor'],
|
|
58965
|
+
type: 'string',
|
|
58966
|
+
},
|
|
58712
58967
|
],
|
|
58713
58968
|
},
|
|
58714
58969
|
type: 'array',
|
|
@@ -58771,6 +59026,7 @@ const openapi: OpenAPISpec = {
|
|
|
58771
59026
|
'reolink',
|
|
58772
59027
|
'unifi_protect',
|
|
58773
59028
|
'yale_connect',
|
|
59029
|
+
'alertify',
|
|
58774
59030
|
'ical',
|
|
58775
59031
|
'lodgify',
|
|
58776
59032
|
'hostaway',
|
|
@@ -60663,7 +60919,7 @@ const openapi: OpenAPISpec = {
|
|
|
60663
60919
|
schema: {
|
|
60664
60920
|
description:
|
|
60665
60921
|
'Manufacturers of the noise sensors that you want to list.',
|
|
60666
|
-
enum: ['minut', 'noiseaware'],
|
|
60922
|
+
enum: ['minut', 'noiseaware', 'alertify'],
|
|
60667
60923
|
type: 'string',
|
|
60668
60924
|
},
|
|
60669
60925
|
},
|