@seamapi/types 1.1186.0 → 1.1187.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.
@@ -15701,6 +15701,12 @@ const openapi: OpenAPISpec = {
15701
15701
  description:
15702
15702
  'Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.',
15703
15703
  properties: {
15704
+ air_quality_index: {
15705
+ description: 'Air quality index, if the device measures it.',
15706
+ format: 'float',
15707
+ type: 'number',
15708
+ 'x-property-group-key': 'sensors',
15709
+ },
15704
15710
  can_activate_weekly_program: {
15705
15711
  description:
15706
15712
  '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.',
@@ -15872,6 +15878,20 @@ const openapi: OpenAPISpec = {
15872
15878
  },
15873
15879
  type: 'array',
15874
15880
  },
15881
+ co2_ppm: {
15882
+ description:
15883
+ 'Carbon dioxide concentration in parts per million, if the device measures it.',
15884
+ format: 'float',
15885
+ type: 'number',
15886
+ 'x-property-group-key': 'sensors',
15887
+ },
15888
+ co_ppm: {
15889
+ description:
15890
+ 'Carbon monoxide concentration in parts per million, if the device measures it.',
15891
+ format: 'float',
15892
+ type: 'number',
15893
+ 'x-property-group-key': 'sensors',
15894
+ },
15875
15895
  connected_account_id: {
15876
15896
  description:
15877
15897
  'Unique identifier for the account associated with the device.',
@@ -16623,6 +16643,18 @@ const openapi: OpenAPISpec = {
16623
16643
  enum: [true],
16624
16644
  type: 'boolean',
16625
16645
  },
16646
+ is_occupied: {
16647
+ description:
16648
+ 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
16649
+ type: 'boolean',
16650
+ 'x-property-group-key': 'sensors',
16651
+ },
16652
+ is_smoking_detected: {
16653
+ description:
16654
+ 'Indicates whether the device detects smoking, if the device measures it.',
16655
+ type: 'boolean',
16656
+ 'x-property-group-key': 'sensors',
16657
+ },
16626
16658
  location: {
16627
16659
  description: 'Location information for the device.',
16628
16660
  properties: {
@@ -16649,11 +16681,147 @@ const openapi: OpenAPISpec = {
16649
16681
  type: 'object',
16650
16682
  'x-property-group-key': 'hardware',
16651
16683
  },
16684
+ mold_risk_level: {
16685
+ description:
16686
+ 'Mold risk level as reported by the device, if the device measures it.',
16687
+ type: 'string',
16688
+ 'x-property-group-key': 'sensors',
16689
+ },
16690
+ named_sensors: {
16691
+ description:
16692
+ '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.',
16693
+ items: {
16694
+ description:
16695
+ 'A sensor on the device, with the same measurement fields as the device.',
16696
+ properties: {
16697
+ air_quality_index: {
16698
+ description: 'Air quality index, if the device measures it.',
16699
+ format: 'float',
16700
+ type: 'number',
16701
+ 'x-property-group-key': 'sensors',
16702
+ },
16703
+ co2_ppm: {
16704
+ description:
16705
+ 'Carbon dioxide concentration in parts per million, if the device measures it.',
16706
+ format: 'float',
16707
+ type: 'number',
16708
+ 'x-property-group-key': 'sensors',
16709
+ },
16710
+ co_ppm: {
16711
+ description:
16712
+ 'Carbon monoxide concentration in parts per million, if the device measures it.',
16713
+ format: 'float',
16714
+ type: 'number',
16715
+ 'x-property-group-key': 'sensors',
16716
+ },
16717
+ display_name: {
16718
+ description:
16719
+ 'Display name of the sensor. Defaults to `sensor_name`.',
16720
+ type: 'string',
16721
+ 'x-property-group-key': 'sensors',
16722
+ },
16723
+ is_occupied: {
16724
+ description:
16725
+ 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
16726
+ type: 'boolean',
16727
+ 'x-property-group-key': 'sensors',
16728
+ },
16729
+ is_smoking_detected: {
16730
+ description:
16731
+ 'Indicates whether the device detects smoking, if the device measures it.',
16732
+ type: 'boolean',
16733
+ 'x-property-group-key': 'sensors',
16734
+ },
16735
+ mold_risk_level: {
16736
+ description:
16737
+ 'Mold risk level as reported by the device, if the device measures it.',
16738
+ type: 'string',
16739
+ 'x-property-group-key': 'sensors',
16740
+ },
16741
+ noise_level_decibels: {
16742
+ description:
16743
+ 'Noise level in decibels, if the device measures noise.',
16744
+ format: 'float',
16745
+ type: 'number',
16746
+ 'x-property-group-key': 'sensors',
16747
+ },
16748
+ noise_level_nrs: {
16749
+ description:
16750
+ 'Noise level as a Noise Risk Score (NRS), if the device reports one.',
16751
+ format: 'float',
16752
+ type: 'number',
16753
+ 'x-property-group-key': 'sensors',
16754
+ },
16755
+ occupant_count: {
16756
+ description:
16757
+ 'Number of occupants the device detects, if the device counts occupants.',
16758
+ format: 'float',
16759
+ type: 'number',
16760
+ 'x-property-group-key': 'sensors',
16761
+ },
16762
+ relative_humidity: {
16763
+ description:
16764
+ 'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
16765
+ format: 'float',
16766
+ maximum: 1,
16767
+ minimum: 0,
16768
+ type: 'number',
16769
+ 'x-property-group-key': 'sensors',
16770
+ },
16771
+ sensor_name: {
16772
+ description:
16773
+ 'Stable, hardware-defined name of the sensor, such as a port number.',
16774
+ type: 'string',
16775
+ 'x-property-group-key': 'sensors',
16776
+ },
16777
+ temperature_celsius: {
16778
+ description:
16779
+ 'Temperature in °C, if the device measures temperature.',
16780
+ format: 'float',
16781
+ type: 'number',
16782
+ 'x-property-group-key': 'sensors',
16783
+ },
16784
+ temperature_fahrenheit: {
16785
+ description:
16786
+ 'Temperature in °F, if the device measures temperature.',
16787
+ format: 'float',
16788
+ type: 'number',
16789
+ 'x-property-group-key': 'sensors',
16790
+ },
16791
+ },
16792
+ required: ['sensor_name', 'display_name'],
16793
+ type: 'object',
16794
+ 'x-property-groups': { sensors: { name: 'Sensors' } },
16795
+ },
16796
+ type: 'array',
16797
+ 'x-property-group-key': 'sensors',
16798
+ },
16652
16799
  nickname: {
16653
16800
  description:
16654
16801
  'Optional nickname to describe the device, settable through Seam.',
16655
16802
  type: 'string',
16656
16803
  },
16804
+ noise_level_decibels: {
16805
+ description:
16806
+ 'Noise level in decibels, if the device measures noise.',
16807
+ format: 'float',
16808
+ type: 'number',
16809
+ 'x-property-group-key': 'sensors',
16810
+ },
16811
+ noise_level_nrs: {
16812
+ description:
16813
+ 'Noise level as a Noise Risk Score (NRS), if the device reports one.',
16814
+ format: 'float',
16815
+ type: 'number',
16816
+ 'x-property-group-key': 'sensors',
16817
+ },
16818
+ occupant_count: {
16819
+ description:
16820
+ 'Number of occupants the device detects, if the device counts occupants.',
16821
+ format: 'float',
16822
+ type: 'number',
16823
+ 'x-property-group-key': 'sensors',
16824
+ },
16657
16825
  properties: {
16658
16826
  allOf: [
16659
16827
  {
@@ -16690,14 +16858,6 @@ const openapi: OpenAPISpec = {
16690
16858
  type: 'object',
16691
16859
  'x-property-group-key': 'hardware',
16692
16860
  },
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
- },
16701
16861
  appearance: {
16702
16862
  description:
16703
16863
  'Appearance-related properties, as reported by the device.',
@@ -16744,22 +16904,6 @@ const openapi: OpenAPISpec = {
16744
16904
  type: 'number',
16745
16905
  'x-property-group-key': 'hardware',
16746
16906
  },
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
- },
16763
16907
  currently_triggering_noise_threshold_ids: {
16764
16908
  description:
16765
16909
  'Array of noise threshold IDs that are currently triggering.',
@@ -16784,20 +16928,6 @@ const openapi: OpenAPISpec = {
16784
16928
  type: 'string',
16785
16929
  'x-property-group-key': 'hardware',
16786
16930
  },
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
- },
16801
16931
  manufacturer: {
16802
16932
  description:
16803
16933
  '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.',
@@ -16852,167 +16982,19 @@ const openapi: OpenAPISpec = {
16852
16982
  ],
16853
16983
  type: 'object',
16854
16984
  },
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
- },
16862
16985
  name: {
16863
16986
  deprecated: true,
16864
16987
  description: 'Name of the device.',
16865
16988
  type: 'string',
16866
16989
  'x-deprecated': 'use device.display_name instead',
16867
16990
  },
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
- },
16992
16991
  noise_level_decibels: {
16993
16992
  description:
16994
16993
  'Indicates current noise level in decibels, if the device supports noise detection.',
16995
16994
  format: 'float',
16996
- nullable: true,
16997
16995
  type: 'number',
16998
16996
  'x-property-group-key': 'noise_sensors',
16999
16997
  },
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
- },
17016
16998
  offline_access_codes_enabled: {
17017
16999
  deprecated: true,
17018
17000
  description:
@@ -19814,21 +19796,18 @@ const openapi: OpenAPISpec = {
19814
19796
  format: 'float',
19815
19797
  maximum: 1,
19816
19798
  minimum: 0,
19817
- nullable: true,
19818
19799
  type: 'number',
19819
19800
  'x-property-group-key': 'thermostats',
19820
19801
  },
19821
19802
  temperature_celsius: {
19822
19803
  description: 'Reported temperature in °C.',
19823
19804
  format: 'float',
19824
- nullable: true,
19825
19805
  type: 'number',
19826
19806
  'x-property-group-key': 'thermostats',
19827
19807
  },
19828
19808
  temperature_fahrenheit: {
19829
19809
  description: 'Reported temperature in °F.',
19830
19810
  format: 'float',
19831
- nullable: true,
19832
19811
  type: 'number',
19833
19812
  'x-property-group-key': 'thermostats',
19834
19813
  },
@@ -20049,16 +20028,38 @@ const openapi: OpenAPISpec = {
20049
20028
  noise_sensors: { name: 'Noise Sensors' },
20050
20029
  phones: { name: 'Phones' },
20051
20030
  provider_metadata: { name: 'Provider Metadata' },
20052
- sensors: { name: 'Sensors' },
20053
20031
  speakers: { name: 'Speakers' },
20054
20032
  thermostats: { name: 'Thermostats' },
20055
20033
  },
20056
20034
  },
20035
+ relative_humidity: {
20036
+ description:
20037
+ 'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
20038
+ format: 'float',
20039
+ maximum: 1,
20040
+ minimum: 0,
20041
+ type: 'number',
20042
+ 'x-property-group-key': 'sensors',
20043
+ },
20057
20044
  space_ids: {
20058
20045
  description: 'IDs of the spaces the device is in.',
20059
20046
  items: { format: 'uuid', type: 'string' },
20060
20047
  type: 'array',
20061
20048
  },
20049
+ temperature_celsius: {
20050
+ description:
20051
+ 'Temperature in °C, if the device measures temperature.',
20052
+ format: 'float',
20053
+ type: 'number',
20054
+ 'x-property-group-key': 'sensors',
20055
+ },
20056
+ temperature_fahrenheit: {
20057
+ description:
20058
+ 'Temperature in °F, if the device measures temperature.',
20059
+ format: 'float',
20060
+ type: 'number',
20061
+ 'x-property-group-key': 'sensors',
20062
+ },
20062
20063
  warnings: {
20063
20064
  description:
20064
20065
  '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.',
@@ -20874,6 +20875,7 @@ const openapi: OpenAPISpec = {
20874
20875
  noise_sensors: { name: 'Noise Sensors' },
20875
20876
  phones: { name: 'Phones' },
20876
20877
  provider_metadata: { name: 'Provider Metadata' },
20878
+ sensors: { name: 'Sensors' },
20877
20879
  speakers: { name: 'Speakers' },
20878
20880
  thermostats: { name: 'Thermostats' },
20879
20881
  },