@seamapi/types 1.820.0 → 1.822.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/dist/connect.cjs +32 -13
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +188 -87
- package/dist/index.cjs +32 -13
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +20 -10
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/events/devices.d.ts +24 -12
- package/lib/seam/connect/models/events/devices.js +13 -7
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +12 -6
- package/lib/seam/connect/openapi.d.ts +100 -47
- package/lib/seam/connect/openapi.js +14 -6
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +56 -24
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/events/devices.ts +17 -7
- package/src/lib/seam/connect/openapi.ts +16 -6
- package/src/lib/seam/connect/route-types.ts +56 -24
|
@@ -38600,14 +38600,18 @@ export type Routes = {
|
|
|
38600
38600
|
access_code_id?: string | undefined;
|
|
38601
38601
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
38602
38602
|
access_code_is_managed?: boolean | undefined;
|
|
38603
|
-
/** ID of the action attempt
|
|
38603
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
38604
38604
|
action_attempt_id?: string | undefined;
|
|
38605
|
-
/** Method by which the
|
|
38605
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
38606
38606
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
38607
38607
|
/**
|
|
38608
38608
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38609
38609
|
*/
|
|
38610
|
-
|
|
38610
|
+
is_via_bluetooth?: boolean | undefined;
|
|
38611
|
+
/**
|
|
38612
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38613
|
+
*/
|
|
38614
|
+
is_via_nfc?: boolean | undefined;
|
|
38611
38615
|
} | {
|
|
38612
38616
|
/** ID of the event. */
|
|
38613
38617
|
event_id: string;
|
|
@@ -38636,9 +38640,9 @@ export type Routes = {
|
|
|
38636
38640
|
access_code_id?: string | undefined;
|
|
38637
38641
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
38638
38642
|
access_code_is_managed?: boolean | undefined;
|
|
38639
|
-
/** ID of the action attempt
|
|
38643
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
38640
38644
|
action_attempt_id?: string | undefined;
|
|
38641
|
-
/** Method by which the
|
|
38645
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
38642
38646
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
38643
38647
|
/**
|
|
38644
38648
|
undocumented: Unreleased.
|
|
@@ -38667,7 +38671,11 @@ export type Routes = {
|
|
|
38667
38671
|
/**
|
|
38668
38672
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38669
38673
|
*/
|
|
38670
|
-
|
|
38674
|
+
is_via_bluetooth?: boolean | undefined;
|
|
38675
|
+
/**
|
|
38676
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
38677
|
+
*/
|
|
38678
|
+
is_via_nfc?: boolean | undefined;
|
|
38671
38679
|
} | {
|
|
38672
38680
|
/** ID of the event. */
|
|
38673
38681
|
event_id: string;
|
|
@@ -41436,14 +41444,18 @@ export type Routes = {
|
|
|
41436
41444
|
access_code_id?: string | undefined;
|
|
41437
41445
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
41438
41446
|
access_code_is_managed?: boolean | undefined;
|
|
41439
|
-
/** ID of the action attempt
|
|
41447
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
41440
41448
|
action_attempt_id?: string | undefined;
|
|
41441
|
-
/** Method by which the
|
|
41449
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
41442
41450
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
41443
41451
|
/**
|
|
41444
41452
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41445
41453
|
*/
|
|
41446
|
-
|
|
41454
|
+
is_via_bluetooth?: boolean | undefined;
|
|
41455
|
+
/**
|
|
41456
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41457
|
+
*/
|
|
41458
|
+
is_via_nfc?: boolean | undefined;
|
|
41447
41459
|
} | {
|
|
41448
41460
|
/** ID of the event. */
|
|
41449
41461
|
event_id: string;
|
|
@@ -41472,9 +41484,9 @@ export type Routes = {
|
|
|
41472
41484
|
access_code_id?: string | undefined;
|
|
41473
41485
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
41474
41486
|
access_code_is_managed?: boolean | undefined;
|
|
41475
|
-
/** ID of the action attempt
|
|
41487
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
41476
41488
|
action_attempt_id?: string | undefined;
|
|
41477
|
-
/** Method by which the
|
|
41489
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
41478
41490
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
41479
41491
|
/**
|
|
41480
41492
|
undocumented: Unreleased.
|
|
@@ -41503,7 +41515,11 @@ export type Routes = {
|
|
|
41503
41515
|
/**
|
|
41504
41516
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41505
41517
|
*/
|
|
41506
|
-
|
|
41518
|
+
is_via_bluetooth?: boolean | undefined;
|
|
41519
|
+
/**
|
|
41520
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
41521
|
+
*/
|
|
41522
|
+
is_via_nfc?: boolean | undefined;
|
|
41507
41523
|
} | {
|
|
41508
41524
|
/** ID of the event. */
|
|
41509
41525
|
event_id: string;
|
|
@@ -66476,14 +66492,18 @@ export type Routes = {
|
|
|
66476
66492
|
access_code_id?: string | undefined;
|
|
66477
66493
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
66478
66494
|
access_code_is_managed?: boolean | undefined;
|
|
66479
|
-
/** ID of the action attempt
|
|
66495
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
66480
66496
|
action_attempt_id?: string | undefined;
|
|
66481
|
-
/** Method by which the
|
|
66497
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
66482
66498
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
66483
66499
|
/**
|
|
66484
66500
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66485
66501
|
*/
|
|
66486
|
-
|
|
66502
|
+
is_via_bluetooth?: boolean | undefined;
|
|
66503
|
+
/**
|
|
66504
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66505
|
+
*/
|
|
66506
|
+
is_via_nfc?: boolean | undefined;
|
|
66487
66507
|
} | {
|
|
66488
66508
|
/** ID of the event. */
|
|
66489
66509
|
event_id: string;
|
|
@@ -66512,9 +66532,9 @@ export type Routes = {
|
|
|
66512
66532
|
access_code_id?: string | undefined;
|
|
66513
66533
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
66514
66534
|
access_code_is_managed?: boolean | undefined;
|
|
66515
|
-
/** ID of the action attempt
|
|
66535
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
66516
66536
|
action_attempt_id?: string | undefined;
|
|
66517
|
-
/** Method by which the
|
|
66537
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
66518
66538
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
66519
66539
|
/**
|
|
66520
66540
|
undocumented: Unreleased.
|
|
@@ -66543,7 +66563,11 @@ export type Routes = {
|
|
|
66543
66563
|
/**
|
|
66544
66564
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66545
66565
|
*/
|
|
66546
|
-
|
|
66566
|
+
is_via_bluetooth?: boolean | undefined;
|
|
66567
|
+
/**
|
|
66568
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
66569
|
+
*/
|
|
66570
|
+
is_via_nfc?: boolean | undefined;
|
|
66547
66571
|
} | {
|
|
66548
66572
|
/** ID of the event. */
|
|
66549
66573
|
event_id: string;
|
|
@@ -98958,14 +98982,18 @@ export type Routes = {
|
|
|
98958
98982
|
access_code_id?: string | undefined;
|
|
98959
98983
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
98960
98984
|
access_code_is_managed?: boolean | undefined;
|
|
98961
|
-
/** ID of the action attempt
|
|
98985
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
98962
98986
|
action_attempt_id?: string | undefined;
|
|
98963
|
-
/** Method by which the
|
|
98987
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
98964
98988
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
98965
98989
|
/**
|
|
98966
98990
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
98967
98991
|
*/
|
|
98968
|
-
|
|
98992
|
+
is_via_bluetooth?: boolean | undefined;
|
|
98993
|
+
/**
|
|
98994
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
98995
|
+
*/
|
|
98996
|
+
is_via_nfc?: boolean | undefined;
|
|
98969
98997
|
} | {
|
|
98970
98998
|
/** ID of the event. */
|
|
98971
98999
|
event_id: string;
|
|
@@ -98994,9 +99022,9 @@ export type Routes = {
|
|
|
98994
99022
|
access_code_id?: string | undefined;
|
|
98995
99023
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
98996
99024
|
access_code_is_managed?: boolean | undefined;
|
|
98997
|
-
/** ID of the action attempt
|
|
99025
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
98998
99026
|
action_attempt_id?: string | undefined;
|
|
98999
|
-
/** Method by which the
|
|
99027
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
99000
99028
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
|
|
99001
99029
|
/**
|
|
99002
99030
|
undocumented: Unreleased.
|
|
@@ -99025,7 +99053,11 @@ export type Routes = {
|
|
|
99025
99053
|
/**
|
|
99026
99054
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
99027
99055
|
*/
|
|
99028
|
-
|
|
99056
|
+
is_via_bluetooth?: boolean | undefined;
|
|
99057
|
+
/**
|
|
99058
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
99059
|
+
*/
|
|
99060
|
+
is_via_nfc?: boolean | undefined;
|
|
99029
99061
|
} | {
|
|
99030
99062
|
/** ID of the event. */
|
|
99031
99063
|
event_id: string;
|
package/package.json
CHANGED
|
@@ -125,6 +125,7 @@ export const PROVIDER_CATEGORY_MAP = {
|
|
|
125
125
|
thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo'],
|
|
126
126
|
noise_sensors: ['minut', 'noiseaware'],
|
|
127
127
|
access_control_systems: [
|
|
128
|
+
'brivo',
|
|
128
129
|
'visionline',
|
|
129
130
|
'assa_abloy_credential_service',
|
|
130
131
|
'latch',
|
|
@@ -68,7 +68,7 @@ const device_event_issue_properties = {
|
|
|
68
68
|
export const lock_method = z
|
|
69
69
|
.enum(['keycode', 'manual', 'automatic', 'unknown', 'remote'])
|
|
70
70
|
.describe(
|
|
71
|
-
'Method by which the affected lock device was locked or unlocked.
|
|
71
|
+
'Method by which the affected lock device was locked or unlocked. `keycode`: locked or unlocked using an access code (see `access_code_id`). `manual`: a direct physical action, such as turning a thumbturn or pressing a button. `remote`: a remote action initiated via an app, Bluetooth, or the Seam API (see `action_attempt_id` for Seam-initiated actions; see `is_via_bluetooth` or `is_via_nfc` for the specific transport). `automatic`: triggered automatically without user interaction, for example by an auto-relock timer. `unknown`: the method could not be determined from the provider event.',
|
|
72
72
|
)
|
|
73
73
|
export type LockMethod = z.infer<typeof lock_method>
|
|
74
74
|
|
|
@@ -420,13 +420,18 @@ export const lock_locked_event = device_event.extend({
|
|
|
420
420
|
.string()
|
|
421
421
|
.uuid()
|
|
422
422
|
.optional()
|
|
423
|
-
.describe(
|
|
423
|
+
.describe(
|
|
424
|
+
'ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt).',
|
|
425
|
+
),
|
|
424
426
|
method: lock_method.describe(
|
|
425
|
-
'Method by which the
|
|
427
|
+
'Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined.',
|
|
426
428
|
),
|
|
427
|
-
|
|
429
|
+
is_via_bluetooth: z.boolean().optional().describe(`
|
|
428
430
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
429
431
|
`),
|
|
432
|
+
is_via_nfc: z.boolean().optional().describe(`
|
|
433
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
434
|
+
`),
|
|
430
435
|
}).describe(`
|
|
431
436
|
---
|
|
432
437
|
route_path: /locks
|
|
@@ -455,9 +460,11 @@ export const lock_unlocked_event = device_event.extend({
|
|
|
455
460
|
.string()
|
|
456
461
|
.uuid()
|
|
457
462
|
.optional()
|
|
458
|
-
.describe(
|
|
463
|
+
.describe(
|
|
464
|
+
'ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt).',
|
|
465
|
+
),
|
|
459
466
|
method: lock_method.describe(
|
|
460
|
-
'Method by which the
|
|
467
|
+
'Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined.',
|
|
461
468
|
),
|
|
462
469
|
user_identity_id: z.string().uuid().optional().describe(`
|
|
463
470
|
undocumented: Unreleased.
|
|
@@ -484,9 +491,12 @@ export const lock_unlocked_event = device_event.extend({
|
|
|
484
491
|
.uuid()
|
|
485
492
|
.optional()
|
|
486
493
|
.describe('ID of the affected device.'),
|
|
487
|
-
|
|
494
|
+
is_via_bluetooth: z.boolean().optional().describe(`
|
|
488
495
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
489
496
|
`),
|
|
497
|
+
is_via_nfc: z.boolean().optional().describe(`
|
|
498
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
499
|
+
`),
|
|
490
500
|
}).describe(`
|
|
491
501
|
---
|
|
492
502
|
route_path: /locks
|
|
@@ -22947,7 +22947,7 @@ export default {
|
|
|
22947
22947
|
},
|
|
22948
22948
|
action_attempt_id: {
|
|
22949
22949
|
description:
|
|
22950
|
-
'ID of the action attempt
|
|
22950
|
+
'ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt).',
|
|
22951
22951
|
format: 'uuid',
|
|
22952
22952
|
type: 'string',
|
|
22953
22953
|
},
|
|
@@ -22994,14 +22994,19 @@ export default {
|
|
|
22994
22994
|
type: 'string',
|
|
22995
22995
|
},
|
|
22996
22996
|
event_type: { enum: ['lock.locked'], type: 'string' },
|
|
22997
|
-
|
|
22997
|
+
is_via_bluetooth: {
|
|
22998
22998
|
description:
|
|
22999
22999
|
"\n Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
|
|
23000
23000
|
type: 'boolean',
|
|
23001
23001
|
},
|
|
23002
|
+
is_via_nfc: {
|
|
23003
|
+
description:
|
|
23004
|
+
'\n Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.\n ',
|
|
23005
|
+
type: 'boolean',
|
|
23006
|
+
},
|
|
23002
23007
|
method: {
|
|
23003
23008
|
description:
|
|
23004
|
-
'Method by which the
|
|
23009
|
+
'Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined.',
|
|
23005
23010
|
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
|
|
23006
23011
|
type: 'string',
|
|
23007
23012
|
},
|
|
@@ -23065,7 +23070,7 @@ export default {
|
|
|
23065
23070
|
},
|
|
23066
23071
|
action_attempt_id: {
|
|
23067
23072
|
description:
|
|
23068
|
-
'ID of the action attempt
|
|
23073
|
+
'ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt).',
|
|
23069
23074
|
format: 'uuid',
|
|
23070
23075
|
type: 'string',
|
|
23071
23076
|
},
|
|
@@ -23112,14 +23117,19 @@ export default {
|
|
|
23112
23117
|
type: 'string',
|
|
23113
23118
|
},
|
|
23114
23119
|
event_type: { enum: ['lock.unlocked'], type: 'string' },
|
|
23115
|
-
|
|
23120
|
+
is_via_bluetooth: {
|
|
23116
23121
|
description:
|
|
23117
23122
|
"\n Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
|
|
23118
23123
|
type: 'boolean',
|
|
23119
23124
|
},
|
|
23125
|
+
is_via_nfc: {
|
|
23126
|
+
description:
|
|
23127
|
+
'\n Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.\n ',
|
|
23128
|
+
type: 'boolean',
|
|
23129
|
+
},
|
|
23120
23130
|
method: {
|
|
23121
23131
|
description:
|
|
23122
|
-
'Method by which the
|
|
23132
|
+
'Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined.',
|
|
23123
23133
|
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
|
|
23124
23134
|
type: 'string',
|
|
23125
23135
|
},
|
|
@@ -46087,9 +46087,9 @@ export type Routes = {
|
|
|
46087
46087
|
access_code_id?: string | undefined
|
|
46088
46088
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
46089
46089
|
access_code_is_managed?: boolean | undefined
|
|
46090
|
-
/** ID of the action attempt
|
|
46090
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
46091
46091
|
action_attempt_id?: string | undefined
|
|
46092
|
-
/** Method by which the
|
|
46092
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
46093
46093
|
method:
|
|
46094
46094
|
| 'keycode'
|
|
46095
46095
|
| 'manual'
|
|
@@ -46099,7 +46099,11 @@ export type Routes = {
|
|
|
46099
46099
|
/**
|
|
46100
46100
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46101
46101
|
*/
|
|
46102
|
-
|
|
46102
|
+
is_via_bluetooth?: boolean | undefined
|
|
46103
|
+
/**
|
|
46104
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46105
|
+
*/
|
|
46106
|
+
is_via_nfc?: boolean | undefined
|
|
46103
46107
|
}
|
|
46104
46108
|
| {
|
|
46105
46109
|
/** ID of the event. */
|
|
@@ -46133,9 +46137,9 @@ export type Routes = {
|
|
|
46133
46137
|
access_code_id?: string | undefined
|
|
46134
46138
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
46135
46139
|
access_code_is_managed?: boolean | undefined
|
|
46136
|
-
/** ID of the action attempt
|
|
46140
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
46137
46141
|
action_attempt_id?: string | undefined
|
|
46138
|
-
/** Method by which the
|
|
46142
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
46139
46143
|
method:
|
|
46140
46144
|
| 'keycode'
|
|
46141
46145
|
| 'manual'
|
|
@@ -46169,7 +46173,11 @@ export type Routes = {
|
|
|
46169
46173
|
/**
|
|
46170
46174
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46171
46175
|
*/
|
|
46172
|
-
|
|
46176
|
+
is_via_bluetooth?: boolean | undefined
|
|
46177
|
+
/**
|
|
46178
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
46179
|
+
*/
|
|
46180
|
+
is_via_nfc?: boolean | undefined
|
|
46173
46181
|
}
|
|
46174
46182
|
| {
|
|
46175
46183
|
/** ID of the event. */
|
|
@@ -49497,14 +49505,18 @@ export type Routes = {
|
|
|
49497
49505
|
access_code_id?: string | undefined
|
|
49498
49506
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
49499
49507
|
access_code_is_managed?: boolean | undefined
|
|
49500
|
-
/** ID of the action attempt
|
|
49508
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
49501
49509
|
action_attempt_id?: string | undefined
|
|
49502
|
-
/** Method by which the
|
|
49510
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
49503
49511
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
49504
49512
|
/**
|
|
49505
49513
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49506
49514
|
*/
|
|
49507
|
-
|
|
49515
|
+
is_via_bluetooth?: boolean | undefined
|
|
49516
|
+
/**
|
|
49517
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49518
|
+
*/
|
|
49519
|
+
is_via_nfc?: boolean | undefined
|
|
49508
49520
|
}
|
|
49509
49521
|
| {
|
|
49510
49522
|
/** ID of the event. */
|
|
@@ -49538,9 +49550,9 @@ export type Routes = {
|
|
|
49538
49550
|
access_code_id?: string | undefined
|
|
49539
49551
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
49540
49552
|
access_code_is_managed?: boolean | undefined
|
|
49541
|
-
/** ID of the action attempt
|
|
49553
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
49542
49554
|
action_attempt_id?: string | undefined
|
|
49543
|
-
/** Method by which the
|
|
49555
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
49544
49556
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
49545
49557
|
/**
|
|
49546
49558
|
undocumented: Unreleased.
|
|
@@ -49569,7 +49581,11 @@ export type Routes = {
|
|
|
49569
49581
|
/**
|
|
49570
49582
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49571
49583
|
*/
|
|
49572
|
-
|
|
49584
|
+
is_via_bluetooth?: boolean | undefined
|
|
49585
|
+
/**
|
|
49586
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
49587
|
+
*/
|
|
49588
|
+
is_via_nfc?: boolean | undefined
|
|
49573
49589
|
}
|
|
49574
49590
|
| {
|
|
49575
49591
|
/** ID of the event. */
|
|
@@ -79358,14 +79374,18 @@ export type Routes = {
|
|
|
79358
79374
|
access_code_id?: string | undefined
|
|
79359
79375
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
79360
79376
|
access_code_is_managed?: boolean | undefined
|
|
79361
|
-
/** ID of the action attempt
|
|
79377
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
79362
79378
|
action_attempt_id?: string | undefined
|
|
79363
|
-
/** Method by which the
|
|
79379
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
79364
79380
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
79365
79381
|
/**
|
|
79366
79382
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79367
79383
|
*/
|
|
79368
|
-
|
|
79384
|
+
is_via_bluetooth?: boolean | undefined
|
|
79385
|
+
/**
|
|
79386
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79387
|
+
*/
|
|
79388
|
+
is_via_nfc?: boolean | undefined
|
|
79369
79389
|
}
|
|
79370
79390
|
| {
|
|
79371
79391
|
/** ID of the event. */
|
|
@@ -79399,9 +79419,9 @@ export type Routes = {
|
|
|
79399
79419
|
access_code_id?: string | undefined
|
|
79400
79420
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
79401
79421
|
access_code_is_managed?: boolean | undefined
|
|
79402
|
-
/** ID of the action attempt
|
|
79422
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
79403
79423
|
action_attempt_id?: string | undefined
|
|
79404
|
-
/** Method by which the
|
|
79424
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
79405
79425
|
method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
|
|
79406
79426
|
/**
|
|
79407
79427
|
undocumented: Unreleased.
|
|
@@ -79430,7 +79450,11 @@ export type Routes = {
|
|
|
79430
79450
|
/**
|
|
79431
79451
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79432
79452
|
*/
|
|
79433
|
-
|
|
79453
|
+
is_via_bluetooth?: boolean | undefined
|
|
79454
|
+
/**
|
|
79455
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
79456
|
+
*/
|
|
79457
|
+
is_via_nfc?: boolean | undefined
|
|
79434
79458
|
}
|
|
79435
79459
|
| {
|
|
79436
79460
|
/** ID of the event. */
|
|
@@ -117691,9 +117715,9 @@ export type Routes = {
|
|
|
117691
117715
|
access_code_id?: string | undefined
|
|
117692
117716
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
117693
117717
|
access_code_is_managed?: boolean | undefined
|
|
117694
|
-
/** ID of the action attempt
|
|
117718
|
+
/** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
|
|
117695
117719
|
action_attempt_id?: string | undefined
|
|
117696
|
-
/** Method by which the
|
|
117720
|
+
/** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
|
|
117697
117721
|
method:
|
|
117698
117722
|
| 'keycode'
|
|
117699
117723
|
| 'manual'
|
|
@@ -117703,7 +117727,11 @@ export type Routes = {
|
|
|
117703
117727
|
/**
|
|
117704
117728
|
Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117705
117729
|
*/
|
|
117706
|
-
|
|
117730
|
+
is_via_bluetooth?: boolean | undefined
|
|
117731
|
+
/**
|
|
117732
|
+
Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117733
|
+
*/
|
|
117734
|
+
is_via_nfc?: boolean | undefined
|
|
117707
117735
|
}
|
|
117708
117736
|
| {
|
|
117709
117737
|
/** ID of the event. */
|
|
@@ -117737,9 +117765,9 @@ export type Routes = {
|
|
|
117737
117765
|
access_code_id?: string | undefined
|
|
117738
117766
|
/** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
|
|
117739
117767
|
access_code_is_managed?: boolean | undefined
|
|
117740
|
-
/** ID of the action attempt
|
|
117768
|
+
/** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
|
|
117741
117769
|
action_attempt_id?: string | undefined
|
|
117742
|
-
/** Method by which the
|
|
117770
|
+
/** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
|
|
117743
117771
|
method:
|
|
117744
117772
|
| 'keycode'
|
|
117745
117773
|
| 'manual'
|
|
@@ -117773,7 +117801,11 @@ export type Routes = {
|
|
|
117773
117801
|
/**
|
|
117774
117802
|
Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117775
117803
|
*/
|
|
117776
|
-
|
|
117804
|
+
is_via_bluetooth?: boolean | undefined
|
|
117805
|
+
/**
|
|
117806
|
+
Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
|
|
117807
|
+
*/
|
|
117808
|
+
is_via_nfc?: boolean | undefined
|
|
117777
117809
|
}
|
|
117778
117810
|
| {
|
|
117779
117811
|
/** ID of the event. */
|