Skip to content

feat: Sync with Seam API via 35d319141875c589c46fc2f218a90f6cc14ea102 #2797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seambot merged 1 commit into from
May 5, 2026
Merged

feat: Sync with Seam API via 35d319141875c589c46fc2f218a90f6cc14ea102 #2797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions src/lib/seam/connect/models/events/devices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const device_event_issue_properties = {
export const lock_method = z
.enum(['keycode', 'manual', 'automatic', 'unknown', 'remote'])
.describe(
'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. The `remote` method indicates any remote (un)lock action, including Bluetooth, mobile app, or Seam API. For Seam-initiated remote (un)locks, look up the `action_attempt_id`.',
'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.',
)
export type LockMethod = z.infer<typeof lock_method>

Expand Down Expand Up @@ -420,13 +420,18 @@ export const lock_locked_event = device_event.extend({
.string()
.uuid()
.optional()
.describe('ID of the action attempt associated with the lock action.'),
.describe(
'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).',
),
method: lock_method.describe(
'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
'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.',
),
is_bluetooth_action: z.boolean().optional().describe(`
is_via_bluetooth: z.boolean().optional().describe(`
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.
`),
is_via_nfc: z.boolean().optional().describe(`
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.
`),
}).describe(`
---
route_path: /locks
Expand Down Expand Up @@ -455,9 +460,11 @@ export const lock_unlocked_event = device_event.extend({
.string()
.uuid()
.optional()
.describe('ID of the action attempt associated with the unlock action.'),
.describe(
'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).',
),
method: lock_method.describe(
'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
'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.',
),
user_identity_id: z.string().uuid().optional().describe(`
undocumented: Unreleased.
Expand All @@ -484,9 +491,12 @@ export const lock_unlocked_event = device_event.extend({
.uuid()
.optional()
.describe('ID of the affected device.'),
is_bluetooth_action: z.boolean().optional().describe(`
is_via_bluetooth: z.boolean().optional().describe(`
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.
`),
is_via_nfc: z.boolean().optional().describe(`
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.
`),
}).describe(`
---
route_path: /locks
Expand Down
22 changes: 16 additions & 6 deletions src/lib/seam/connect/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22947,7 +22947,7 @@ export default {
},
action_attempt_id: {
description:
'ID of the action attempt associated with the lock action.',
'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).',
format: 'uuid',
type: 'string',
},
Expand Down Expand Up @@ -22994,14 +22994,19 @@ export default {
type: 'string',
},
event_type: { enum: ['lock.locked'], type: 'string' },
is_bluetooth_action: {
is_via_bluetooth: {
description:
"\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 ",
type: 'boolean',
},
is_via_nfc: {
description:
'\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 ',
type: 'boolean',
},
method: {
description:
'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
'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.',
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
type: 'string',
},
Expand Down Expand Up @@ -23065,7 +23070,7 @@ export default {
},
action_attempt_id: {
description:
'ID of the action attempt associated with the unlock action.',
'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).',
format: 'uuid',
type: 'string',
},
Expand Down Expand Up @@ -23112,14 +23117,19 @@ export default {
type: 'string',
},
event_type: { enum: ['lock.unlocked'], type: 'string' },
is_bluetooth_action: {
is_via_bluetooth: {
description:
"\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 ",
type: 'boolean',
},
is_via_nfc: {
description:
'\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 ',
type: 'boolean',
},
method: {
description:
'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
'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.',
enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
type: 'string',
},
Expand Down
Loading
Loading