@seamapi/types 1.1212.0 → 1.1214.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/device-metadata.d.ts +14 -14
- package/lib/seam/connect/models/devices/device-metadata.js +7 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +20 -14
- package/lib/seam/connect/models/devices/device.js +14 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +16 -14
- package/lib/seam/connect/models/instant-keys/instant-key.js +1 -1
- package/lib/seam/connect/openapi.js +13 -1
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +326 -254
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-metadata.ts +7 -0
- package/src/lib/seam/connect/models/devices/device.ts +14 -0
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +15 -1
- package/src/lib/seam/connect/route-types.ts +1680 -1010
package/package.json
CHANGED
|
@@ -413,6 +413,7 @@ export const device_metadata = z
|
|
|
413
413
|
),
|
|
414
414
|
})
|
|
415
415
|
.partial()
|
|
416
|
+
.optional()
|
|
416
417
|
.describe(`Latest temperature reading for a Minut device.`),
|
|
417
418
|
sound: z
|
|
418
419
|
.object({
|
|
@@ -428,6 +429,7 @@ export const device_metadata = z
|
|
|
428
429
|
),
|
|
429
430
|
})
|
|
430
431
|
.partial()
|
|
432
|
+
.optional()
|
|
431
433
|
.describe(`Latest sound reading for a Minut device.`),
|
|
432
434
|
humidity: z
|
|
433
435
|
.object({
|
|
@@ -445,6 +447,7 @@ export const device_metadata = z
|
|
|
445
447
|
),
|
|
446
448
|
})
|
|
447
449
|
.partial()
|
|
450
|
+
.optional()
|
|
448
451
|
.describe(`Latest humidity reading for a Minut device.`),
|
|
449
452
|
pressure: z
|
|
450
453
|
.object({
|
|
@@ -462,6 +465,7 @@ export const device_metadata = z
|
|
|
462
465
|
),
|
|
463
466
|
})
|
|
464
467
|
.partial()
|
|
468
|
+
.optional()
|
|
465
469
|
.describe(`Latest pressure reading for a Minut device.`),
|
|
466
470
|
accelerometer_z: z
|
|
467
471
|
.object({
|
|
@@ -479,14 +483,17 @@ export const device_metadata = z
|
|
|
479
483
|
),
|
|
480
484
|
})
|
|
481
485
|
.partial()
|
|
486
|
+
.optional()
|
|
482
487
|
.describe(
|
|
483
488
|
`Latest accelerometer Z-axis reading for a Minut device.`,
|
|
484
489
|
),
|
|
485
490
|
})
|
|
486
491
|
.partial()
|
|
492
|
+
.optional()
|
|
487
493
|
.describe(`Latest sensor values for a Minut device.`),
|
|
488
494
|
})
|
|
489
495
|
.partial()
|
|
496
|
+
.optional()
|
|
490
497
|
.describe(`Metadata for a Minut device.`),
|
|
491
498
|
four_suites_metadata: z
|
|
492
499
|
.object({
|
|
@@ -1294,6 +1294,20 @@ export const device = z
|
|
|
1294
1294
|
---
|
|
1295
1295
|
Indicates whether the lock is locked.
|
|
1296
1296
|
`),
|
|
1297
|
+
is_detached_from_mounting_plate: z.boolean().optional().describe(`
|
|
1298
|
+
---
|
|
1299
|
+
undocumented: Unreleased.
|
|
1300
|
+
property_group_key: hardware
|
|
1301
|
+
---
|
|
1302
|
+
Indicates whether the device was last reported as detached from its mounting plate. Omitted when Seam has no accepted observation, including when the device does not support mounting plate detection, reports an unknown status, or is offline. This is the last accepted provider observation, not a guarantee of current hardware state; check \`is_online\` before acting on it.
|
|
1303
|
+
`),
|
|
1304
|
+
is_casing_tampered_with: z.boolean().optional().describe(`
|
|
1305
|
+
---
|
|
1306
|
+
undocumented: Unreleased.
|
|
1307
|
+
property_group_key: hardware
|
|
1308
|
+
---
|
|
1309
|
+
Indicates whether the device was last reported as having its casing opened or tampered with. Omitted when Seam has no accepted observation, including when the device does not support casing tamper detection. This is independent of \`is_detached_from_mounting_plate\`.
|
|
1310
|
+
`),
|
|
1297
1311
|
properties: common_device_properties
|
|
1298
1312
|
.and(phone_specific_properties.partial())
|
|
1299
1313
|
.and(device_metadata)
|
|
@@ -66,7 +66,7 @@ export const instant_key = z.object({
|
|
|
66
66
|
---
|
|
67
67
|
Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
|
|
68
68
|
|
|
69
|
-
There’s no
|
|
69
|
+
There’s no account to create. Your user just taps a link and gets a lightweight, native-feeling experience. On iOS, the key opens in an App Clip, so there’s no app to install. On Android, Google has discontinued Google Play Instant, so the first time your user opens an Instant Key they must install the Seam Instant Key app from the Google Play Store. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
|
|
70
70
|
`)
|
|
71
71
|
|
|
72
72
|
export type InstantKey = z.infer<typeof instant_key>
|
|
@@ -16838,6 +16838,20 @@ const openapi: OpenAPISpec = {
|
|
|
16838
16838
|
type: 'number',
|
|
16839
16839
|
'x-property-group-key': 'sensors',
|
|
16840
16840
|
},
|
|
16841
|
+
is_casing_tampered_with: {
|
|
16842
|
+
description:
|
|
16843
|
+
'Indicates whether the device was last reported as having its casing opened or tampered with. Omitted when Seam has no accepted observation, including when the device does not support casing tamper detection. This is independent of `is_detached_from_mounting_plate`.',
|
|
16844
|
+
type: 'boolean',
|
|
16845
|
+
'x-property-group-key': 'hardware',
|
|
16846
|
+
'x-undocumented': 'Unreleased.',
|
|
16847
|
+
},
|
|
16848
|
+
is_detached_from_mounting_plate: {
|
|
16849
|
+
description:
|
|
16850
|
+
'Indicates whether the device was last reported as detached from its mounting plate. Omitted when Seam has no accepted observation, including when the device does not support mounting plate detection, reports an unknown status, or is offline. This is the last accepted provider observation, not a guarantee of current hardware state; check `is_online` before acting on it.',
|
|
16851
|
+
type: 'boolean',
|
|
16852
|
+
'x-property-group-key': 'hardware',
|
|
16853
|
+
'x-undocumented': 'Unreleased.',
|
|
16854
|
+
},
|
|
16841
16855
|
is_door_locked: {
|
|
16842
16856
|
description: 'Indicates whether the lock is locked.',
|
|
16843
16857
|
type: 'boolean',
|
|
@@ -33428,7 +33442,7 @@ const openapi: OpenAPISpec = {
|
|
|
33428
33442
|
},
|
|
33429
33443
|
instant_key: {
|
|
33430
33444
|
description:
|
|
33431
|
-
'Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.\n\nThere’s no
|
|
33445
|
+
'Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.\n\nThere’s no account to create. Your user just taps a link and gets a lightweight, native-feeling experience. On iOS, the key opens in an App Clip, so there’s no app to install. On Android, Google has discontinued Google Play Instant, so the first time your user opens an Instant Key they must install the Seam Instant Key app from the Google Play Store. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.',
|
|
33432
33446
|
properties: {
|
|
33433
33447
|
client_session_id: {
|
|
33434
33448
|
description:
|