@seamapi/types 1.1186.0 → 1.1188.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1186.0",
3
+ "version": "1.1188.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -133,6 +133,12 @@ const base_configure_feature = base_feature.extend({
133
133
  .describe(
134
134
  'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
135
135
  ),
136
+ allow_bridge_replacement: z
137
+ .boolean()
138
+ .default(false)
139
+ .describe(
140
+ 'Indicates whether the customer can move a connected account to a new Seam Bridge when its current bridge is disconnected.',
141
+ ),
136
142
  })
137
143
 
138
144
  const base_features = z.object({
@@ -315,6 +321,7 @@ export const portal_configuration = portal_configuration_base
315
321
  allow_sound_automation_rule_customization: false,
316
322
  allow_sensor_automation_rule_customization: false,
317
323
  allow_notification_customization: false,
324
+ allow_bridge_replacement: false,
318
325
  },
319
326
  },
320
327
  is_embedded: false,
@@ -13,19 +13,19 @@ import {
13
13
 
14
14
  export const thermostat_capability_properties = z
15
15
  .object({
16
- temperature_fahrenheit: z.number().nullable().describe(`
16
+ temperature_fahrenheit: z.number().describe(`
17
17
  ---
18
18
  property_group_key: thermostats
19
19
  ---
20
20
  Reported temperature in °F.
21
21
  `),
22
- temperature_celsius: z.number().nullable().describe(`
22
+ temperature_celsius: z.number().describe(`
23
23
  ---
24
24
  property_group_key: thermostats
25
25
  ---
26
26
  Reported temperature in °C.
27
27
  `),
28
- relative_humidity: z.number().min(0).max(1).nullable().describe(`
28
+ relative_humidity: z.number().min(0).max(1).describe(`
29
29
  ---
30
30
  property_group_key: thermostats
31
31
  ---
@@ -853,169 +853,157 @@ export const device_manufacturer_info = z
853
853
 
854
854
  export type DeviceManufacturerInfo = z.infer<typeof device_manufacturer_info>
855
855
 
856
- const additional_sensor_measurement_properties = z.object({
857
- noise_level_nrs: z
856
+ const sensor_measurements = z.object({
857
+ temperature_celsius: z
858
858
  .number()
859
- .nullable()
860
859
  .describe(
861
860
  `
862
861
  ---
863
862
  property_group_key: sensors
864
863
  ---
865
- Noise level as a Noise Risk Score (NRS), if the device reports one. \`null\` until the first value arrives.
864
+ Temperature in °C, if the device measures temperature.
866
865
  `,
867
866
  )
868
867
  .optional(),
869
- co2_ppm: z
868
+ temperature_fahrenheit: z
870
869
  .number()
871
- .nullable()
872
870
  .describe(
873
871
  `
874
872
  ---
875
873
  property_group_key: sensors
876
874
  ---
877
- Carbon dioxide concentration in parts per million, if the device measures it. \`null\` until the first value arrives.
875
+ Temperature in °F, if the device measures temperature.
878
876
  `,
879
877
  )
880
878
  .optional(),
881
- co_ppm: z
879
+ relative_humidity: z
882
880
  .number()
883
- .nullable()
881
+ .min(0)
882
+ .max(1)
884
883
  .describe(
885
884
  `
886
885
  ---
887
886
  property_group_key: sensors
888
887
  ---
889
- Carbon monoxide concentration in parts per million, if the device measures it. \`null\` until the first value arrives.
888
+ Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.
890
889
  `,
891
890
  )
892
891
  .optional(),
893
- air_quality_index: z
892
+ noise_level_decibels: z
894
893
  .number()
895
- .nullable()
896
894
  .describe(
897
895
  `
898
896
  ---
899
897
  property_group_key: sensors
900
898
  ---
901
- Air quality index, if the device measures it. \`null\` until the first value arrives.
899
+ Noise level in decibels, if the device measures noise.
902
900
  `,
903
901
  )
904
902
  .optional(),
905
- mold_risk_level: z
906
- .string()
907
- .nullable()
903
+ noise_level_nrs: z
904
+ .number()
908
905
  .describe(
909
906
  `
910
907
  ---
911
908
  property_group_key: sensors
912
909
  ---
913
- Mold risk level as reported by the device, if the device measures it. \`null\` until the first value arrives.
910
+ Noise level as a Noise Risk Score (NRS), if the device reports one.
914
911
  `,
915
912
  )
916
913
  .optional(),
917
- is_occupied: z
918
- .boolean()
919
- .nullable()
914
+ co2_ppm: z
915
+ .number()
920
916
  .describe(
921
917
  `
922
918
  ---
923
919
  property_group_key: sensors
924
920
  ---
925
- Indicates whether the device detects that the space is occupied, if the device measures occupancy. \`null\` until the first value arrives.
921
+ Carbon dioxide concentration in parts per million, if the device measures it.
926
922
  `,
927
923
  )
928
924
  .optional(),
929
- occupant_count: z
925
+ co_ppm: z
930
926
  .number()
931
- .nullable()
932
927
  .describe(
933
928
  `
934
929
  ---
935
930
  property_group_key: sensors
936
931
  ---
937
- Number of occupants the device detects, if the device counts occupants. \`null\` until the first value arrives.
932
+ Carbon monoxide concentration in parts per million, if the device measures it.
938
933
  `,
939
934
  )
940
935
  .optional(),
941
- is_smoking_detected: z
942
- .boolean()
943
- .nullable()
936
+ air_quality_index: z
937
+ .number()
944
938
  .describe(
945
939
  `
946
940
  ---
947
941
  property_group_key: sensors
948
942
  ---
949
- Indicates whether the device detects smoking, if the device measures it. \`null\` until the first value arrives.
943
+ Air quality index, if the device measures it.
950
944
  `,
951
945
  )
952
946
  .optional(),
953
- })
954
-
955
- export const named_sensor = z.object({
956
- sensor_name: z.string().describe(`
957
- ---
958
- property_group_key: sensors
959
- ---
960
- Stable, hardware-defined name of the sensor, such as a port number.
961
- `),
962
- display_name: z.string().describe(`
963
- ---
964
- property_group_key: sensors
965
- ---
966
- Display name of the sensor. Defaults to \`sensor_name\`.
967
- `),
968
- temperature_celsius: z
969
- .number()
970
- .nullable()
947
+ mold_risk_level: z
948
+ .string()
971
949
  .describe(
972
950
  `
973
951
  ---
974
952
  property_group_key: sensors
975
953
  ---
976
- Reported temperature in °C. \`null\` until the first value arrives.
954
+ Mold risk level as reported by the device, if the device measures it.
977
955
  `,
978
956
  )
979
957
  .optional(),
980
- temperature_fahrenheit: z
981
- .number()
982
- .nullable()
958
+ is_occupied: z
959
+ .boolean()
983
960
  .describe(
984
961
  `
985
962
  ---
986
963
  property_group_key: sensors
987
964
  ---
988
- Reported temperature in °F. \`null\` until the first value arrives.
965
+ Indicates whether the device detects that the space is occupied, if the device measures occupancy.
989
966
  `,
990
967
  )
991
968
  .optional(),
992
- relative_humidity: z
969
+ occupant_count: z
993
970
  .number()
994
- .min(0)
995
- .max(1)
996
- .nullable()
997
971
  .describe(
998
972
  `
999
973
  ---
1000
974
  property_group_key: sensors
1001
975
  ---
1002
- Reported relative humidity, as a value between 0 and 1, inclusive. \`null\` until the first value arrives.
976
+ Number of occupants the device detects, if the device counts occupants.
1003
977
  `,
1004
978
  )
1005
979
  .optional(),
1006
- noise_level_decibels: z
1007
- .number()
1008
- .nullable()
980
+ is_smoking_detected: z
981
+ .boolean()
1009
982
  .describe(
1010
983
  `
1011
984
  ---
1012
985
  property_group_key: sensors
1013
986
  ---
1014
- Noise level in decibels. \`null\` until the first value arrives.
987
+ Indicates whether the device detects smoking, if the device measures it.
1015
988
  `,
1016
989
  )
1017
990
  .optional(),
1018
- ...additional_sensor_measurement_properties.shape,
991
+ })
992
+
993
+ export const named_sensor = z.object({
994
+ sensor_name: z.string().describe(`
995
+ ---
996
+ property_group_key: sensors
997
+ ---
998
+ Stable, hardware-defined name of the sensor, such as a port number.
999
+ `),
1000
+ display_name: z.string().describe(`
1001
+ ---
1002
+ property_group_key: sensors
1003
+ ---
1004
+ Display name of the sensor. Defaults to \`sensor_name\`.
1005
+ `),
1006
+ ...sensor_measurements.shape,
1019
1007
  }).describe(`
1020
1008
  ---
1021
1009
  property_groups:
@@ -1194,7 +1182,6 @@ export const common_device_properties = z.object({
1194
1182
  .optional(),
1195
1183
  noise_level_decibels: z
1196
1184
  .number()
1197
- .nullable()
1198
1185
  .describe(
1199
1186
  `
1200
1187
  ---
@@ -1215,18 +1202,6 @@ export const common_device_properties = z.object({
1215
1202
  `,
1216
1203
  )
1217
1204
  .optional(),
1218
- ...additional_sensor_measurement_properties.shape,
1219
- named_sensors: z
1220
- .array(named_sensor)
1221
- .describe(
1222
- `
1223
- ---
1224
- property_group_key: sensors
1225
- ---
1226
- 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.
1227
- `,
1228
- )
1229
- .optional(),
1230
1205
  })
1231
1206
 
1232
1207
  export const device_and_connected_account_error_options = [
@@ -1280,8 +1255,6 @@ export const device = z
1280
1255
  name: Hardware
1281
1256
  noise_sensors:
1282
1257
  name: Noise Sensors
1283
- sensors:
1284
- name: Sensors
1285
1258
  speakers:
1286
1259
  name: Speakers
1287
1260
  phones:
@@ -1400,6 +1373,18 @@ export const device = z
1400
1373
  ---
1401
1374
  Manufacturer of the device. Represents the hardware brand, which may differ from the provider.
1402
1375
  `),
1376
+ ...sensor_measurements.shape,
1377
+ named_sensors: z
1378
+ .array(named_sensor)
1379
+ .describe(
1380
+ `
1381
+ ---
1382
+ property_group_key: sensors
1383
+ ---
1384
+ 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.
1385
+ `,
1386
+ )
1387
+ .optional(),
1403
1388
  })
1404
1389
  .merge(device_capability_flags).describe(`
1405
1390
  ---
@@ -1415,6 +1400,8 @@ export const device = z
1415
1400
  name: Hardware
1416
1401
  noise_sensors:
1417
1402
  name: Noise Sensors
1403
+ sensors:
1404
+ name: Sensors
1418
1405
  speakers:
1419
1406
  name: Speakers
1420
1407
  phones: