@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.
@@ -13935,6 +13935,12 @@ const openapi = {
13935
13935
  device: {
13936
13936
  description: 'Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.',
13937
13937
  properties: {
13938
+ air_quality_index: {
13939
+ description: 'Air quality index, if the device measures it.',
13940
+ format: 'float',
13941
+ type: 'number',
13942
+ 'x-property-group-key': 'sensors',
13943
+ },
13938
13944
  can_activate_weekly_program: {
13939
13945
  description: '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.',
13940
13946
  type: 'boolean',
@@ -14079,6 +14085,18 @@ const openapi = {
14079
14085
  },
14080
14086
  type: 'array',
14081
14087
  },
14088
+ co2_ppm: {
14089
+ description: 'Carbon dioxide concentration in parts per million, if the device measures it.',
14090
+ format: 'float',
14091
+ type: 'number',
14092
+ 'x-property-group-key': 'sensors',
14093
+ },
14094
+ co_ppm: {
14095
+ description: 'Carbon monoxide concentration in parts per million, if the device measures it.',
14096
+ format: 'float',
14097
+ type: 'number',
14098
+ 'x-property-group-key': 'sensors',
14099
+ },
14082
14100
  connected_account_id: {
14083
14101
  description: 'Unique identifier for the account associated with the device.',
14084
14102
  format: 'uuid',
@@ -14749,6 +14767,16 @@ const openapi = {
14749
14767
  enum: [true],
14750
14768
  type: 'boolean',
14751
14769
  },
14770
+ is_occupied: {
14771
+ description: 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
14772
+ type: 'boolean',
14773
+ 'x-property-group-key': 'sensors',
14774
+ },
14775
+ is_smoking_detected: {
14776
+ description: 'Indicates whether the device detects smoking, if the device measures it.',
14777
+ type: 'boolean',
14778
+ 'x-property-group-key': 'sensors',
14779
+ },
14752
14780
  location: {
14753
14781
  description: 'Location information for the device.',
14754
14782
  properties: {
@@ -14774,10 +14802,127 @@ const openapi = {
14774
14802
  type: 'object',
14775
14803
  'x-property-group-key': 'hardware',
14776
14804
  },
14805
+ mold_risk_level: {
14806
+ description: 'Mold risk level as reported by the device, if the device measures it.',
14807
+ type: 'string',
14808
+ 'x-property-group-key': 'sensors',
14809
+ },
14810
+ named_sensors: {
14811
+ 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.',
14812
+ items: {
14813
+ description: 'A sensor on the device, with the same measurement fields as the device.',
14814
+ properties: {
14815
+ air_quality_index: {
14816
+ description: 'Air quality index, if the device measures it.',
14817
+ format: 'float',
14818
+ type: 'number',
14819
+ 'x-property-group-key': 'sensors',
14820
+ },
14821
+ co2_ppm: {
14822
+ description: 'Carbon dioxide concentration in parts per million, if the device measures it.',
14823
+ format: 'float',
14824
+ type: 'number',
14825
+ 'x-property-group-key': 'sensors',
14826
+ },
14827
+ co_ppm: {
14828
+ description: 'Carbon monoxide concentration in parts per million, if the device measures it.',
14829
+ format: 'float',
14830
+ type: 'number',
14831
+ 'x-property-group-key': 'sensors',
14832
+ },
14833
+ display_name: {
14834
+ description: 'Display name of the sensor. Defaults to `sensor_name`.',
14835
+ type: 'string',
14836
+ 'x-property-group-key': 'sensors',
14837
+ },
14838
+ is_occupied: {
14839
+ description: 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
14840
+ type: 'boolean',
14841
+ 'x-property-group-key': 'sensors',
14842
+ },
14843
+ is_smoking_detected: {
14844
+ description: 'Indicates whether the device detects smoking, if the device measures it.',
14845
+ type: 'boolean',
14846
+ 'x-property-group-key': 'sensors',
14847
+ },
14848
+ mold_risk_level: {
14849
+ description: 'Mold risk level as reported by the device, if the device measures it.',
14850
+ type: 'string',
14851
+ 'x-property-group-key': 'sensors',
14852
+ },
14853
+ noise_level_decibels: {
14854
+ description: 'Noise level in decibels, if the device measures noise.',
14855
+ format: 'float',
14856
+ type: 'number',
14857
+ 'x-property-group-key': 'sensors',
14858
+ },
14859
+ noise_level_nrs: {
14860
+ description: 'Noise level as a Noise Risk Score (NRS), if the device reports one.',
14861
+ format: 'float',
14862
+ type: 'number',
14863
+ 'x-property-group-key': 'sensors',
14864
+ },
14865
+ occupant_count: {
14866
+ description: 'Number of occupants the device detects, if the device counts occupants.',
14867
+ format: 'float',
14868
+ type: 'number',
14869
+ 'x-property-group-key': 'sensors',
14870
+ },
14871
+ relative_humidity: {
14872
+ description: 'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
14873
+ format: 'float',
14874
+ maximum: 1,
14875
+ minimum: 0,
14876
+ type: 'number',
14877
+ 'x-property-group-key': 'sensors',
14878
+ },
14879
+ sensor_name: {
14880
+ description: 'Stable, hardware-defined name of the sensor, such as a port number.',
14881
+ type: 'string',
14882
+ 'x-property-group-key': 'sensors',
14883
+ },
14884
+ temperature_celsius: {
14885
+ description: 'Temperature in °C, if the device measures temperature.',
14886
+ format: 'float',
14887
+ type: 'number',
14888
+ 'x-property-group-key': 'sensors',
14889
+ },
14890
+ temperature_fahrenheit: {
14891
+ description: 'Temperature in °F, if the device measures temperature.',
14892
+ format: 'float',
14893
+ type: 'number',
14894
+ 'x-property-group-key': 'sensors',
14895
+ },
14896
+ },
14897
+ required: ['sensor_name', 'display_name'],
14898
+ type: 'object',
14899
+ 'x-property-groups': { sensors: { name: 'Sensors' } },
14900
+ },
14901
+ type: 'array',
14902
+ 'x-property-group-key': 'sensors',
14903
+ },
14777
14904
  nickname: {
14778
14905
  description: 'Optional nickname to describe the device, settable through Seam.',
14779
14906
  type: 'string',
14780
14907
  },
14908
+ noise_level_decibels: {
14909
+ description: 'Noise level in decibels, if the device measures noise.',
14910
+ format: 'float',
14911
+ type: 'number',
14912
+ 'x-property-group-key': 'sensors',
14913
+ },
14914
+ noise_level_nrs: {
14915
+ description: 'Noise level as a Noise Risk Score (NRS), if the device reports one.',
14916
+ format: 'float',
14917
+ type: 'number',
14918
+ 'x-property-group-key': 'sensors',
14919
+ },
14920
+ occupant_count: {
14921
+ description: 'Number of occupants the device detects, if the device counts occupants.',
14922
+ format: 'float',
14923
+ type: 'number',
14924
+ 'x-property-group-key': 'sensors',
14925
+ },
14781
14926
  properties: {
14782
14927
  allOf: [
14783
14928
  {
@@ -14811,13 +14956,6 @@ const openapi = {
14811
14956
  type: 'object',
14812
14957
  'x-property-group-key': 'hardware',
14813
14958
  },
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
- },
14821
14959
  appearance: {
14822
14960
  description: 'Appearance-related properties, as reported by the device.',
14823
14961
  properties: {
@@ -14858,20 +14996,6 @@ const openapi = {
14858
14996
  type: 'number',
14859
14997
  'x-property-group-key': 'hardware',
14860
14998
  },
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
- },
14875
14999
  currently_triggering_noise_threshold_ids: {
14876
15000
  description: 'Array of noise threshold IDs that are currently triggering.',
14877
15001
  items: { type: 'string' },
@@ -14894,18 +15018,6 @@ const openapi = {
14894
15018
  type: 'string',
14895
15019
  'x-property-group-key': 'hardware',
14896
15020
  },
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
- },
14909
15021
  manufacturer: {
14910
15022
  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.',
14911
15023
  type: 'string',
@@ -14952,147 +15064,18 @@ const openapi = {
14952
15064
  ],
14953
15065
  type: 'object',
14954
15066
  },
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
- },
14961
15067
  name: {
14962
15068
  deprecated: true,
14963
15069
  description: 'Name of the device.',
14964
15070
  type: 'string',
14965
15071
  'x-deprecated': 'use device.display_name instead',
14966
15072
  },
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
- },
15075
15073
  noise_level_decibels: {
15076
15074
  description: 'Indicates current noise level in decibels, if the device supports noise detection.',
15077
15075
  format: 'float',
15078
- nullable: true,
15079
15076
  type: 'number',
15080
15077
  'x-property-group-key': 'noise_sensors',
15081
15078
  },
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
- },
15096
15079
  offline_access_codes_enabled: {
15097
15080
  deprecated: true,
15098
15081
  description: 'Indicates whether it is currently possible to use offline access codes for the device.',
@@ -17574,21 +17557,18 @@ const openapi = {
17574
17557
  format: 'float',
17575
17558
  maximum: 1,
17576
17559
  minimum: 0,
17577
- nullable: true,
17578
17560
  type: 'number',
17579
17561
  'x-property-group-key': 'thermostats',
17580
17562
  },
17581
17563
  temperature_celsius: {
17582
17564
  description: 'Reported temperature in °C.',
17583
17565
  format: 'float',
17584
- nullable: true,
17585
17566
  type: 'number',
17586
17567
  'x-property-group-key': 'thermostats',
17587
17568
  },
17588
17569
  temperature_fahrenheit: {
17589
17570
  description: 'Reported temperature in °F.',
17590
17571
  format: 'float',
17591
- nullable: true,
17592
17572
  type: 'number',
17593
17573
  'x-property-group-key': 'thermostats',
17594
17574
  },
@@ -17782,16 +17762,35 @@ const openapi = {
17782
17762
  noise_sensors: { name: 'Noise Sensors' },
17783
17763
  phones: { name: 'Phones' },
17784
17764
  provider_metadata: { name: 'Provider Metadata' },
17785
- sensors: { name: 'Sensors' },
17786
17765
  speakers: { name: 'Speakers' },
17787
17766
  thermostats: { name: 'Thermostats' },
17788
17767
  },
17789
17768
  },
17769
+ relative_humidity: {
17770
+ description: 'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
17771
+ format: 'float',
17772
+ maximum: 1,
17773
+ minimum: 0,
17774
+ type: 'number',
17775
+ 'x-property-group-key': 'sensors',
17776
+ },
17790
17777
  space_ids: {
17791
17778
  description: 'IDs of the spaces the device is in.',
17792
17779
  items: { format: 'uuid', type: 'string' },
17793
17780
  type: 'array',
17794
17781
  },
17782
+ temperature_celsius: {
17783
+ description: 'Temperature in °C, if the device measures temperature.',
17784
+ format: 'float',
17785
+ type: 'number',
17786
+ 'x-property-group-key': 'sensors',
17787
+ },
17788
+ temperature_fahrenheit: {
17789
+ description: 'Temperature in °F, if the device measures temperature.',
17790
+ format: 'float',
17791
+ type: 'number',
17792
+ 'x-property-group-key': 'sensors',
17793
+ },
17795
17794
  warnings: {
17796
17795
  description: '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.',
17797
17796
  items: {
@@ -18488,6 +18487,7 @@ const openapi = {
18488
18487
  noise_sensors: { name: 'Noise Sensors' },
18489
18488
  phones: { name: 'Phones' },
18490
18489
  provider_metadata: { name: 'Provider Metadata' },
18490
+ sensors: { name: 'Sensors' },
18491
18491
  speakers: { name: 'Speakers' },
18492
18492
  thermostats: { name: 'Thermostats' },
18493
18493
  },