@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.
Files changed (28) hide show
  1. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +9 -9
  2. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +9 -9
  3. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +3 -3
  4. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  5. package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
  6. package/lib/seam/connect/models/devices/device-metadata.js +31 -0
  7. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  8. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  9. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  10. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  11. package/lib/seam/connect/models/devices/device-type.d.ts +7 -1
  12. package/lib/seam/connect/models/devices/device-type.js +8 -0
  13. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device.d.ts +371 -26
  15. package/lib/seam/connect/models/devices/device.js +159 -0
  16. package/lib/seam/connect/models/devices/device.js.map +1 -1
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +205 -16
  18. package/lib/seam/connect/openapi.js +229 -1
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1117 -97
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +3 -3
  23. package/src/lib/seam/connect/models/devices/device-metadata.ts +32 -0
  24. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  25. package/src/lib/seam/connect/models/devices/device-type.ts +16 -0
  26. package/src/lib/seam/connect/models/devices/device.ts +187 -0
  27. package/src/lib/seam/connect/openapi.ts +257 -1
  28. package/src/lib/seam/connect/route-types.ts +1240 -69
@@ -14238,6 +14238,11 @@ const openapi = {
14238
14238
  enum: ['sonos_speaker'],
14239
14239
  type: 'string',
14240
14240
  },
14241
+ {
14242
+ description: 'Device type for environmental sensors.',
14243
+ enum: ['alertify_sensor'],
14244
+ type: 'string',
14245
+ },
14241
14246
  ],
14242
14247
  },
14243
14248
  display_name: {
@@ -14806,6 +14811,13 @@ const openapi = {
14806
14811
  type: 'object',
14807
14812
  'x-property-group-key': 'hardware',
14808
14813
  },
14814
+ air_quality_index: {
14815
+ description: 'Air quality index, if the device measures it. `null` until the first value arrives.',
14816
+ format: 'float',
14817
+ nullable: true,
14818
+ type: 'number',
14819
+ 'x-property-group-key': 'sensors',
14820
+ },
14809
14821
  appearance: {
14810
14822
  description: 'Appearance-related properties, as reported by the device.',
14811
14823
  properties: {
@@ -14846,6 +14858,20 @@ const openapi = {
14846
14858
  type: 'number',
14847
14859
  'x-property-group-key': 'hardware',
14848
14860
  },
14861
+ co2_ppm: {
14862
+ description: 'Carbon dioxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
14863
+ format: 'float',
14864
+ nullable: true,
14865
+ type: 'number',
14866
+ 'x-property-group-key': 'sensors',
14867
+ },
14868
+ co_ppm: {
14869
+ description: 'Carbon monoxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
14870
+ format: 'float',
14871
+ nullable: true,
14872
+ type: 'number',
14873
+ 'x-property-group-key': 'sensors',
14874
+ },
14849
14875
  currently_triggering_noise_threshold_ids: {
14850
14876
  description: 'Array of noise threshold IDs that are currently triggering.',
14851
14877
  items: { type: 'string' },
@@ -14868,6 +14894,18 @@ const openapi = {
14868
14894
  type: 'string',
14869
14895
  'x-property-group-key': 'hardware',
14870
14896
  },
14897
+ is_occupied: {
14898
+ description: 'Indicates whether the device detects that the space is occupied, if the device measures occupancy. `null` until the first value arrives.',
14899
+ nullable: true,
14900
+ type: 'boolean',
14901
+ 'x-property-group-key': 'sensors',
14902
+ },
14903
+ is_smoking_detected: {
14904
+ description: 'Indicates whether the device detects smoking, if the device measures it. `null` until the first value arrives.',
14905
+ nullable: true,
14906
+ type: 'boolean',
14907
+ 'x-property-group-key': 'sensors',
14908
+ },
14871
14909
  manufacturer: {
14872
14910
  description: '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.',
14873
14911
  type: 'string',
@@ -14914,18 +14952,147 @@ const openapi = {
14914
14952
  ],
14915
14953
  type: 'object',
14916
14954
  },
14955
+ mold_risk_level: {
14956
+ description: 'Mold risk level as reported by the device, if the device measures it. `null` until the first value arrives.',
14957
+ nullable: true,
14958
+ type: 'string',
14959
+ 'x-property-group-key': 'sensors',
14960
+ },
14917
14961
  name: {
14918
14962
  deprecated: true,
14919
14963
  description: 'Name of the device.',
14920
14964
  type: 'string',
14921
14965
  'x-deprecated': 'use device.display_name instead',
14922
14966
  },
14967
+ named_sensors: {
14968
+ description: '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.',
14969
+ items: {
14970
+ description: 'A sensor on the device, with the same measurement fields as the device.',
14971
+ properties: {
14972
+ air_quality_index: {
14973
+ description: 'Air quality index, if the device measures it. `null` until the first value arrives.',
14974
+ format: 'float',
14975
+ nullable: true,
14976
+ type: 'number',
14977
+ 'x-property-group-key': 'sensors',
14978
+ },
14979
+ co2_ppm: {
14980
+ description: 'Carbon dioxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
14981
+ format: 'float',
14982
+ nullable: true,
14983
+ type: 'number',
14984
+ 'x-property-group-key': 'sensors',
14985
+ },
14986
+ co_ppm: {
14987
+ description: 'Carbon monoxide concentration in parts per million, if the device measures it. `null` until the first value arrives.',
14988
+ format: 'float',
14989
+ nullable: true,
14990
+ type: 'number',
14991
+ 'x-property-group-key': 'sensors',
14992
+ },
14993
+ display_name: {
14994
+ description: 'Display name of the sensor. Defaults to `sensor_name`.',
14995
+ type: 'string',
14996
+ 'x-property-group-key': 'sensors',
14997
+ },
14998
+ is_occupied: {
14999
+ description: 'Indicates whether the device detects that the space is occupied, if the device measures occupancy. `null` until the first value arrives.',
15000
+ nullable: true,
15001
+ type: 'boolean',
15002
+ 'x-property-group-key': 'sensors',
15003
+ },
15004
+ is_smoking_detected: {
15005
+ description: 'Indicates whether the device detects smoking, if the device measures it. `null` until the first value arrives.',
15006
+ nullable: true,
15007
+ type: 'boolean',
15008
+ 'x-property-group-key': 'sensors',
15009
+ },
15010
+ mold_risk_level: {
15011
+ description: 'Mold risk level as reported by the device, if the device measures it. `null` until the first value arrives.',
15012
+ nullable: true,
15013
+ type: 'string',
15014
+ 'x-property-group-key': 'sensors',
15015
+ },
15016
+ noise_level_decibels: {
15017
+ description: 'Noise level in decibels. `null` until the first value arrives.',
15018
+ format: 'float',
15019
+ nullable: true,
15020
+ type: 'number',
15021
+ 'x-property-group-key': 'sensors',
15022
+ },
15023
+ noise_level_nrs: {
15024
+ description: 'Noise level as a Noise Risk Score (NRS), if the device reports one. `null` until the first value arrives.',
15025
+ format: 'float',
15026
+ nullable: true,
15027
+ type: 'number',
15028
+ 'x-property-group-key': 'sensors',
15029
+ },
15030
+ occupant_count: {
15031
+ description: 'Number of occupants the device detects, if the device counts occupants. `null` until the first value arrives.',
15032
+ format: 'float',
15033
+ nullable: true,
15034
+ type: 'number',
15035
+ 'x-property-group-key': 'sensors',
15036
+ },
15037
+ relative_humidity: {
15038
+ description: 'Reported relative humidity, as a value between 0 and 1, inclusive. `null` until the first value arrives.',
15039
+ format: 'float',
15040
+ maximum: 1,
15041
+ minimum: 0,
15042
+ nullable: true,
15043
+ type: 'number',
15044
+ 'x-property-group-key': 'sensors',
15045
+ },
15046
+ sensor_name: {
15047
+ description: 'Stable, hardware-defined name of the sensor, such as a port number.',
15048
+ type: 'string',
15049
+ 'x-property-group-key': 'sensors',
15050
+ },
15051
+ temperature_celsius: {
15052
+ description: 'Reported temperature in °C. `null` until the first value arrives.',
15053
+ format: 'float',
15054
+ nullable: true,
15055
+ type: 'number',
15056
+ 'x-property-group-key': 'sensors',
15057
+ },
15058
+ temperature_fahrenheit: {
15059
+ description: 'Reported temperature in °F. `null` until the first value arrives.',
15060
+ format: 'float',
15061
+ nullable: true,
15062
+ type: 'number',
15063
+ 'x-property-group-key': 'sensors',
15064
+ },
15065
+ },
15066
+ required: ['sensor_name', 'display_name'],
15067
+ type: 'object',
15068
+ 'x-property-groups': {
15069
+ sensors: { name: 'Sensors' },
15070
+ },
15071
+ },
15072
+ type: 'array',
15073
+ 'x-property-group-key': 'sensors',
15074
+ },
14923
15075
  noise_level_decibels: {
14924
15076
  description: 'Indicates current noise level in decibels, if the device supports noise detection.',
14925
15077
  format: 'float',
15078
+ nullable: true,
14926
15079
  type: 'number',
14927
15080
  'x-property-group-key': 'noise_sensors',
14928
15081
  },
15082
+ noise_level_nrs: {
15083
+ description: 'Noise level as a Noise Risk Score (NRS), if the device reports one. `null` until the first value arrives.',
15084
+ format: 'float',
15085
+ nullable: true,
15086
+ type: 'number',
15087
+ 'x-property-group-key': 'sensors',
15088
+ },
15089
+ occupant_count: {
15090
+ description: 'Number of occupants the device detects, if the device counts occupants. `null` until the first value arrives.',
15091
+ format: 'float',
15092
+ nullable: true,
15093
+ type: 'number',
15094
+ 'x-property-group-key': 'sensors',
15095
+ },
14929
15096
  offline_access_codes_enabled: {
14930
15097
  deprecated: true,
14931
15098
  description: 'Indicates whether it is currently possible to use offline access codes for the device.',
@@ -15031,6 +15198,34 @@ const openapi = {
15031
15198
  },
15032
15199
  type: 'object',
15033
15200
  },
15201
+ alertify_metadata: {
15202
+ description: 'Metadata for an Alertify sensor.',
15203
+ properties: {
15204
+ building_id: {
15205
+ description: 'ID of the Alertify building that contains the unit.',
15206
+ nullable: true,
15207
+ type: 'string',
15208
+ },
15209
+ device_id: {
15210
+ description: 'Device ID reported by Alertify.',
15211
+ type: 'string',
15212
+ },
15213
+ device_name: {
15214
+ description: 'Device name, as set in the Alertify dashboard.',
15215
+ type: 'string',
15216
+ },
15217
+ unit_id: {
15218
+ description: 'ID of the Alertify unit where the device is installed.',
15219
+ type: 'string',
15220
+ },
15221
+ unit_name: {
15222
+ description: 'Name of the Alertify unit where the device is installed.',
15223
+ type: 'string',
15224
+ },
15225
+ },
15226
+ type: 'object',
15227
+ 'x-undocumented': 'Unreleased.',
15228
+ },
15034
15229
  aqara_metadata: {
15035
15230
  description: 'Metadata for an Aqara device.',
15036
15231
  properties: {
@@ -17379,18 +17574,21 @@ const openapi = {
17379
17574
  format: 'float',
17380
17575
  maximum: 1,
17381
17576
  minimum: 0,
17577
+ nullable: true,
17382
17578
  type: 'number',
17383
17579
  'x-property-group-key': 'thermostats',
17384
17580
  },
17385
17581
  temperature_celsius: {
17386
17582
  description: 'Reported temperature in °C.',
17387
17583
  format: 'float',
17584
+ nullable: true,
17388
17585
  type: 'number',
17389
17586
  'x-property-group-key': 'thermostats',
17390
17587
  },
17391
17588
  temperature_fahrenheit: {
17392
17589
  description: 'Reported temperature in °F.',
17393
17590
  format: 'float',
17591
+ nullable: true,
17394
17592
  type: 'number',
17395
17593
  'x-property-group-key': 'thermostats',
17396
17594
  },
@@ -17584,6 +17782,7 @@ const openapi = {
17584
17782
  noise_sensors: { name: 'Noise Sensors' },
17585
17783
  phones: { name: 'Phones' },
17586
17784
  provider_metadata: { name: 'Provider Metadata' },
17785
+ sensors: { name: 'Sensors' },
17587
17786
  speakers: { name: 'Speakers' },
17588
17787
  thermostats: { name: 'Thermostats' },
17589
17788
  },
@@ -18491,6 +18690,7 @@ const openapi = {
18491
18690
  'reolink',
18492
18691
  'unifi_protect',
18493
18692
  'yale_connect',
18693
+ 'alertify',
18494
18694
  'ical',
18495
18695
  'lodgify',
18496
18696
  'hostaway',
@@ -36947,6 +37147,11 @@ const openapi = {
36947
37147
  enum: ['sonos_speaker'],
36948
37148
  type: 'string',
36949
37149
  },
37150
+ {
37151
+ description: 'Device type for environmental sensors.',
37152
+ enum: ['alertify_sensor'],
37153
+ type: 'string',
37154
+ },
36950
37155
  ],
36951
37156
  },
36952
37157
  display_name: {
@@ -47134,6 +47339,7 @@ const openapi = {
47134
47339
  'reolink',
47135
47340
  'unifi_protect',
47136
47341
  'yale_connect',
47342
+ 'alertify',
47137
47343
  'ical',
47138
47344
  'lodgify',
47139
47345
  'hostaway',
@@ -50733,6 +50939,11 @@ const openapi = {
50733
50939
  enum: ['sonos_speaker'],
50734
50940
  type: 'string',
50735
50941
  },
50942
+ {
50943
+ description: 'Device type for environmental sensors.',
50944
+ enum: ['alertify_sensor'],
50945
+ type: 'string',
50946
+ },
50736
50947
  ],
50737
50948
  },
50738
50949
  },
@@ -50827,6 +51038,11 @@ const openapi = {
50827
51038
  enum: ['sonos_speaker'],
50828
51039
  type: 'string',
50829
51040
  },
51041
+ {
51042
+ description: 'Device type for environmental sensors.',
51043
+ enum: ['alertify_sensor'],
51044
+ type: 'string',
51045
+ },
50830
51046
  ],
50831
51047
  },
50832
51048
  type: 'array',
@@ -50889,6 +51105,7 @@ const openapi = {
50889
51105
  'reolink',
50890
51106
  'unifi_protect',
50891
51107
  'yale_connect',
51108
+ 'alertify',
50892
51109
  'ical',
50893
51110
  'lodgify',
50894
51111
  'hostaway',
@@ -53061,6 +53278,11 @@ const openapi = {
53061
53278
  enum: ['sonos_speaker'],
53062
53279
  type: 'string',
53063
53280
  },
53281
+ {
53282
+ description: 'Device type for environmental sensors.',
53283
+ enum: ['alertify_sensor'],
53284
+ type: 'string',
53285
+ },
53064
53286
  ],
53065
53287
  },
53066
53288
  },
@@ -53155,6 +53377,11 @@ const openapi = {
53155
53377
  enum: ['sonos_speaker'],
53156
53378
  type: 'string',
53157
53379
  },
53380
+ {
53381
+ description: 'Device type for environmental sensors.',
53382
+ enum: ['alertify_sensor'],
53383
+ type: 'string',
53384
+ },
53158
53385
  ],
53159
53386
  },
53160
53387
  type: 'array',
@@ -53217,6 +53444,7 @@ const openapi = {
53217
53444
  'reolink',
53218
53445
  'unifi_protect',
53219
53446
  'yale_connect',
53447
+ 'alertify',
53220
53448
  'ical',
53221
53449
  'lodgify',
53222
53450
  'hostaway',
@@ -55045,7 +55273,7 @@ const openapi = {
55045
55273
  name: 'manufacturer',
55046
55274
  schema: {
55047
55275
  description: 'Manufacturers of the noise sensors that you want to list.',
55048
- enum: ['minut', 'noiseaware'],
55276
+ enum: ['minut', 'noiseaware', 'alertify'],
55049
55277
  type: 'string',
55050
55278
  },
55051
55279
  },