@seamapi/types 1.915.0 → 1.916.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 +335 -380
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1056 -1056
- package/dist/index.cjs +335 -380
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +1 -1
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +2 -2
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +2 -2
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -2
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge.js +1 -1
- package/lib/seam/connect/models/bridges/bridge.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +2 -5
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +2 -2
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/customer/customer.js +1 -1
- package/lib/seam/connect/models/customer/customer.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +1 -1
- package/lib/seam/connect/models/events/access-codes.js +1 -1
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/action-attempts.js +8 -8
- package/lib/seam/connect/models/events/client-sessions.js +1 -1
- package/lib/seam/connect/models/events/common.js +1 -1
- package/lib/seam/connect/models/events/common.js.map +1 -1
- package/lib/seam/connect/models/events/connect-webviews.js +4 -4
- package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
- package/lib/seam/connect/models/events/connected-accounts.js +10 -10
- package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
- package/lib/seam/connect/models/events/devices.js +20 -20
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.js +1 -1
- package/lib/seam/connect/models/instant-keys/instant-key.js +2 -2
- package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
- package/lib/seam/connect/models/partner/customer-portal.js +1 -1
- package/lib/seam/connect/models/partner/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.js +1 -1
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
- package/lib/seam/connect/models/spaces/space.js +1 -1
- package/lib/seam/connect/models/spaces/space.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/models/webhooks/webhook.js +1 -3
- package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +2 -5
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.js +264 -267
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1056 -1056
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -6
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +1 -3
- package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -2
- package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +1 -3
- package/src/lib/seam/connect/models/bridges/bridge.ts +1 -3
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +2 -9
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +2 -4
- package/src/lib/seam/connect/models/customer/customer.ts +1 -3
- package/src/lib/seam/connect/models/devices/phone.ts +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +1 -1
- package/src/lib/seam/connect/models/events/action-attempts.ts +8 -8
- package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
- package/src/lib/seam/connect/models/events/common.ts +1 -3
- package/src/lib/seam/connect/models/events/connect-webviews.ts +4 -8
- package/src/lib/seam/connect/models/events/connected-accounts.ts +10 -14
- package/src/lib/seam/connect/models/events/devices.ts +20 -22
- package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +2 -6
- package/src/lib/seam/connect/models/partner/customer-portal.ts +1 -3
- package/src/lib/seam/connect/models/partner/magic-link.ts +1 -3
- package/src/lib/seam/connect/models/spaces/space.ts +1 -3
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +1 -3
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -3
- package/src/lib/seam/connect/models/webhooks/webhook.ts +1 -5
- package/src/lib/seam/connect/models/workspaces/workspace.ts +2 -7
- package/src/lib/seam/connect/openapi.ts +264 -411
- package/src/lib/seam/connect/route-types.ts +1056 -1056
package/package.json
CHANGED
|
@@ -118,15 +118,11 @@ const common_acs_access_group = z.object({
|
|
|
118
118
|
workspace_id: z
|
|
119
119
|
.string()
|
|
120
120
|
.uuid()
|
|
121
|
-
.describe(
|
|
122
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.',
|
|
123
|
-
),
|
|
121
|
+
.describe('ID of the workspace that contains the access group.'),
|
|
124
122
|
connected_account_id: z
|
|
125
123
|
.string()
|
|
126
124
|
.uuid()
|
|
127
|
-
.describe(
|
|
128
|
-
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.',
|
|
129
|
-
),
|
|
125
|
+
.describe('ID of the connected account that contains the access group.'),
|
|
130
126
|
name: z.string().describe('Name of the access group.'),
|
|
131
127
|
access_group_type: acs_access_group_external_type.describe(`
|
|
132
128
|
---
|
|
@@ -38,9 +38,7 @@ export const enrollment_automation = z.object({
|
|
|
38
38
|
workspace_id: z
|
|
39
39
|
.string()
|
|
40
40
|
.uuid()
|
|
41
|
-
.describe(
|
|
42
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation.',
|
|
43
|
-
),
|
|
41
|
+
.describe('ID of the workspace that contains the enrollment automation.'),
|
|
44
42
|
}).describe(`
|
|
45
43
|
---
|
|
46
44
|
route_path: /user_identities/enrollment_automations
|
|
@@ -240,7 +240,7 @@ const common_acs_credential = z.object({
|
|
|
240
240
|
.string()
|
|
241
241
|
.uuid()
|
|
242
242
|
.describe(
|
|
243
|
-
'ID of the
|
|
243
|
+
'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
|
|
244
244
|
),
|
|
245
245
|
starts_at: z
|
|
246
246
|
.string()
|
|
@@ -50,13 +50,13 @@ export const acs_encoder = z.object({
|
|
|
50
50
|
.string()
|
|
51
51
|
.uuid()
|
|
52
52
|
.describe(
|
|
53
|
-
'ID of the
|
|
53
|
+
'ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
54
54
|
),
|
|
55
55
|
workspace_id: z
|
|
56
56
|
.string()
|
|
57
57
|
.uuid()
|
|
58
58
|
.describe(
|
|
59
|
-
'ID of the
|
|
59
|
+
'ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
60
60
|
),
|
|
61
61
|
errors: z
|
|
62
62
|
.array(acs_encoder_error)
|
|
@@ -316,7 +316,7 @@ export const acs_system = z
|
|
|
316
316
|
.string()
|
|
317
317
|
.uuid()
|
|
318
318
|
.describe(
|
|
319
|
-
'ID of the
|
|
319
|
+
'ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
320
320
|
),
|
|
321
321
|
connected_account_ids: z.array(z.string().uuid()).describe(`
|
|
322
322
|
---
|
|
@@ -328,7 +328,7 @@ export const acs_system = z
|
|
|
328
328
|
.string()
|
|
329
329
|
.uuid()
|
|
330
330
|
.describe(
|
|
331
|
-
'ID of the
|
|
331
|
+
'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
|
|
332
332
|
),
|
|
333
333
|
image_url: z
|
|
334
334
|
.string()
|
|
@@ -226,7 +226,7 @@ const common_acs_user = z
|
|
|
226
226
|
.string()
|
|
227
227
|
.uuid()
|
|
228
228
|
.describe(
|
|
229
|
-
'ID of the
|
|
229
|
+
'ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).',
|
|
230
230
|
),
|
|
231
231
|
created_at: z
|
|
232
232
|
.string()
|
|
@@ -311,7 +311,7 @@ const common_acs_user = z
|
|
|
311
311
|
The last time an internal sync job completed for this access system user.
|
|
312
312
|
`),
|
|
313
313
|
connected_account_id: z.string().uuid().describe(`
|
|
314
|
-
The ID of the
|
|
314
|
+
The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
|
|
315
315
|
`),
|
|
316
316
|
salto_space_metadata: acs_user_salto_space_metadata
|
|
317
317
|
.optional()
|
|
@@ -33,9 +33,7 @@ export const bridge_connected_system = z.object({
|
|
|
33
33
|
workspace_id: z
|
|
34
34
|
.string()
|
|
35
35
|
.uuid()
|
|
36
|
-
.describe(
|
|
37
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired.',
|
|
38
|
-
),
|
|
36
|
+
.describe('ID of the workspace with which Seam Bridge is paired.'),
|
|
39
37
|
workspace_display_name: z
|
|
40
38
|
.string()
|
|
41
39
|
.describe(
|
|
@@ -5,9 +5,7 @@ export const bridge = z.object({
|
|
|
5
5
|
workspace_id: z
|
|
6
6
|
.string()
|
|
7
7
|
.uuid()
|
|
8
|
-
.describe(
|
|
9
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.',
|
|
10
|
-
),
|
|
8
|
+
.describe('ID of the workspace that contains Seam Bridge.'),
|
|
11
9
|
created_at: z
|
|
12
10
|
.string()
|
|
13
11
|
.datetime()
|
|
@@ -1,18 +1,11 @@
|
|
|
1
1
|
import { z } from 'zod'
|
|
2
2
|
|
|
3
3
|
export const client_session = z.object({
|
|
4
|
-
client_session_id: z
|
|
5
|
-
.string()
|
|
6
|
-
.uuid()
|
|
7
|
-
.describe(
|
|
8
|
-
'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
|
|
9
|
-
),
|
|
4
|
+
client_session_id: z.string().uuid().describe('ID of the client session.'),
|
|
10
5
|
workspace_id: z
|
|
11
6
|
.string()
|
|
12
7
|
.uuid()
|
|
13
|
-
.describe(
|
|
14
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
|
|
15
|
-
),
|
|
8
|
+
.describe('ID of the workspace associated with the client session.'),
|
|
16
9
|
created_at: z
|
|
17
10
|
.string()
|
|
18
11
|
.datetime()
|
|
@@ -14,9 +14,7 @@ export const connect_webview = z.object({
|
|
|
14
14
|
workspace_id: z
|
|
15
15
|
.string()
|
|
16
16
|
.uuid()
|
|
17
|
-
.describe(
|
|
18
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview.',
|
|
19
|
-
),
|
|
17
|
+
.describe('ID of the workspace that contains the Connect Webview.'),
|
|
20
18
|
created_at: z
|
|
21
19
|
.string()
|
|
22
20
|
.datetime()
|
|
@@ -26,7 +24,7 @@ export const connect_webview = z.object({
|
|
|
26
24
|
.uuid()
|
|
27
25
|
.nullable()
|
|
28
26
|
.describe(
|
|
29
|
-
'ID of the
|
|
27
|
+
'ID of the connected account associated with the Connect Webview.',
|
|
30
28
|
),
|
|
31
29
|
url: z
|
|
32
30
|
.string()
|
|
@@ -7,9 +7,7 @@ export const customer = z.object({
|
|
|
7
7
|
workspace_id: z
|
|
8
8
|
.string()
|
|
9
9
|
.uuid()
|
|
10
|
-
.describe(
|
|
11
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer.',
|
|
12
|
-
),
|
|
10
|
+
.describe('ID of the workspace associated with the customer.'),
|
|
13
11
|
created_at: z
|
|
14
12
|
.string()
|
|
15
13
|
.datetime()
|
|
@@ -25,7 +25,7 @@ export const phone = z.object({
|
|
|
25
25
|
.describe(`Display name of the phone. Defaults to \`nickname\` (if it is set) or \`properties.appearance.name\`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
|
|
26
26
|
`),
|
|
27
27
|
workspace_id: basePhoneDeviceSchema.shape.workspace_id
|
|
28
|
-
.describe(`ID of the
|
|
28
|
+
.describe(`ID of the workspace that contains the phone.
|
|
29
29
|
`),
|
|
30
30
|
created_at: basePhoneDeviceSchema.shape.created_at
|
|
31
31
|
.describe(`Date and time at which the phone was created.
|
|
@@ -17,7 +17,7 @@ const access_code_event = common_event.extend({
|
|
|
17
17
|
.string()
|
|
18
18
|
.uuid()
|
|
19
19
|
.describe(
|
|
20
|
-
'ID of the
|
|
20
|
+
'ID of the connected account associated with the affected access code.',
|
|
21
21
|
),
|
|
22
22
|
device_custom_metadata: custom_metadata
|
|
23
23
|
.optional()
|
|
@@ -32,7 +32,7 @@ export const action_attempt_lock_door_succeeded_event =
|
|
|
32
32
|
---
|
|
33
33
|
route_path: /action_attempts
|
|
34
34
|
---
|
|
35
|
-
A lock door
|
|
35
|
+
A lock door action attempt succeeded.
|
|
36
36
|
`)
|
|
37
37
|
|
|
38
38
|
export const action_attempt_lock_door_failed_event =
|
|
@@ -42,7 +42,7 @@ export const action_attempt_lock_door_failed_event =
|
|
|
42
42
|
---
|
|
43
43
|
route_path: /action_attempts
|
|
44
44
|
---
|
|
45
|
-
A lock door
|
|
45
|
+
A lock door action attempt failed.
|
|
46
46
|
`)
|
|
47
47
|
|
|
48
48
|
export const action_attempt_unlock_door_succeeded_event =
|
|
@@ -52,7 +52,7 @@ export const action_attempt_unlock_door_succeeded_event =
|
|
|
52
52
|
---
|
|
53
53
|
route_path: /action_attempts
|
|
54
54
|
---
|
|
55
|
-
An unlock door
|
|
55
|
+
An unlock door action attempt succeeded.
|
|
56
56
|
`)
|
|
57
57
|
|
|
58
58
|
export const action_attempt_unlock_door_failed_event =
|
|
@@ -62,7 +62,7 @@ export const action_attempt_unlock_door_failed_event =
|
|
|
62
62
|
---
|
|
63
63
|
route_path: /action_attempts
|
|
64
64
|
---
|
|
65
|
-
An unlock door
|
|
65
|
+
An unlock door action attempt failed.
|
|
66
66
|
`)
|
|
67
67
|
|
|
68
68
|
export const action_attempt_simulate_keypad_code_entry_succeeded_event =
|
|
@@ -74,7 +74,7 @@ export const action_attempt_simulate_keypad_code_entry_succeeded_event =
|
|
|
74
74
|
---
|
|
75
75
|
route_path: /action_attempts
|
|
76
76
|
---
|
|
77
|
-
A simulate keypad code entry
|
|
77
|
+
A simulate keypad code entry action attempt succeeded.
|
|
78
78
|
`)
|
|
79
79
|
|
|
80
80
|
export const action_attempt_simulate_keypad_code_entry_failed_event =
|
|
@@ -84,7 +84,7 @@ export const action_attempt_simulate_keypad_code_entry_failed_event =
|
|
|
84
84
|
---
|
|
85
85
|
route_path: /action_attempts
|
|
86
86
|
---
|
|
87
|
-
A simulate keypad code entry
|
|
87
|
+
A simulate keypad code entry action attempt failed.
|
|
88
88
|
`)
|
|
89
89
|
|
|
90
90
|
export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
|
|
@@ -96,7 +96,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
|
|
|
96
96
|
---
|
|
97
97
|
route_path: /action_attempts
|
|
98
98
|
---
|
|
99
|
-
A simulate manual lock via keypad
|
|
99
|
+
A simulate manual lock via keypad action attempt succeeded.
|
|
100
100
|
`)
|
|
101
101
|
|
|
102
102
|
export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
|
|
@@ -108,7 +108,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
|
|
|
108
108
|
---
|
|
109
109
|
route_path: /action_attempts
|
|
110
110
|
---
|
|
111
|
-
A simulate manual lock via keypad
|
|
111
|
+
A simulate manual lock via keypad action attempt failed.
|
|
112
112
|
`)
|
|
113
113
|
|
|
114
114
|
export const action_attempt_events = [
|
|
@@ -15,7 +15,7 @@ export const client_session_deleted_event = client_session_event.extend({
|
|
|
15
15
|
---
|
|
16
16
|
route_path: /client_sessions
|
|
17
17
|
---
|
|
18
|
-
A
|
|
18
|
+
A client session was deleted.
|
|
19
19
|
`)
|
|
20
20
|
|
|
21
21
|
export type ClientSessionDeletedEvent = z.infer<
|
|
@@ -5,9 +5,7 @@ export const common_event = z.object({
|
|
|
5
5
|
workspace_id: z
|
|
6
6
|
.string()
|
|
7
7
|
.uuid()
|
|
8
|
-
.describe(
|
|
9
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
10
|
-
),
|
|
8
|
+
.describe('ID of the workspace associated with the event.'),
|
|
11
9
|
created_at: z
|
|
12
10
|
.string()
|
|
13
11
|
.datetime()
|
|
@@ -7,17 +7,13 @@ const connect_webview_event = common_event.extend({
|
|
|
7
7
|
connect_webview_id: z
|
|
8
8
|
.string()
|
|
9
9
|
.uuid()
|
|
10
|
-
.describe(
|
|
11
|
-
'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).',
|
|
12
|
-
),
|
|
10
|
+
.describe('ID of the affected Connect Webview.'),
|
|
13
11
|
})
|
|
14
12
|
|
|
15
13
|
const connected_account_id = z
|
|
16
14
|
.string()
|
|
17
15
|
.uuid()
|
|
18
|
-
.describe(
|
|
19
|
-
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.',
|
|
20
|
-
)
|
|
16
|
+
.describe('ID of the connected account associated with the event.')
|
|
21
17
|
|
|
22
18
|
const connected_account_custom_metadata = custom_metadata
|
|
23
19
|
.optional()
|
|
@@ -40,7 +36,7 @@ export const connect_webview_login_succeeded_event =
|
|
|
40
36
|
---
|
|
41
37
|
route_path: /connect_webviews
|
|
42
38
|
---
|
|
43
|
-
A
|
|
39
|
+
A Connect Webview login succeeded.
|
|
44
40
|
`)
|
|
45
41
|
|
|
46
42
|
export type ConnectWebviewLoginSucceededEvent = z.infer<
|
|
@@ -53,7 +49,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({
|
|
|
53
49
|
---
|
|
54
50
|
route_path: /connect_webviews
|
|
55
51
|
---
|
|
56
|
-
A
|
|
52
|
+
A Connect Webview login failed.
|
|
57
53
|
`)
|
|
58
54
|
|
|
59
55
|
export type ConnectWebviewLoginFailedEvent = z.infer<
|
|
@@ -11,9 +11,7 @@ const connected_account_event = common_event.extend({
|
|
|
11
11
|
connected_account_id: z
|
|
12
12
|
.string()
|
|
13
13
|
.uuid()
|
|
14
|
-
.describe(
|
|
15
|
-
'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).',
|
|
16
|
-
),
|
|
14
|
+
.describe('ID of the affected connected account.'),
|
|
17
15
|
connected_account_custom_metadata: custom_metadata
|
|
18
16
|
.optional()
|
|
19
17
|
.describe(
|
|
@@ -24,9 +22,7 @@ const connected_account_event = common_event.extend({
|
|
|
24
22
|
const connect_webview_id = z
|
|
25
23
|
.string()
|
|
26
24
|
.uuid()
|
|
27
|
-
.describe(
|
|
28
|
-
'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.',
|
|
29
|
-
)
|
|
25
|
+
.describe('ID of the Connect Webview associated with the event.')
|
|
30
26
|
|
|
31
27
|
const connected_account_event_issue_properties = {
|
|
32
28
|
connected_account_errors: z
|
|
@@ -52,7 +48,7 @@ export const connected_account_connected_event = connected_account_event.extend(
|
|
|
52
48
|
---
|
|
53
49
|
route_path: /connected_accounts
|
|
54
50
|
---
|
|
55
|
-
A
|
|
51
|
+
A connected account was connected for the first time or was reconnected after being disconnected.
|
|
56
52
|
`)
|
|
57
53
|
|
|
58
54
|
export type ConnectedAccountConnectedEvent = z.infer<
|
|
@@ -66,7 +62,7 @@ export const connected_account_created_event = connected_account_event.extend({
|
|
|
66
62
|
---
|
|
67
63
|
route_path: /connected_accounts
|
|
68
64
|
---
|
|
69
|
-
A
|
|
65
|
+
A connected account was created.
|
|
70
66
|
`)
|
|
71
67
|
|
|
72
68
|
export type ConnectedAccountCreatedEvent = z.infer<
|
|
@@ -82,7 +78,7 @@ export const connected_account_successful_login_event =
|
|
|
82
78
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
83
79
|
route_path: /connected_accounts
|
|
84
80
|
---
|
|
85
|
-
A
|
|
81
|
+
A connected account had a successful login using a Connect Webview.
|
|
86
82
|
`)
|
|
87
83
|
|
|
88
84
|
/** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */
|
|
@@ -98,7 +94,7 @@ export const connected_account_disconnected_event = connected_account_event
|
|
|
98
94
|
---
|
|
99
95
|
route_path: /connected_accounts
|
|
100
96
|
---
|
|
101
|
-
A
|
|
97
|
+
A connected account was disconnected.
|
|
102
98
|
`)
|
|
103
99
|
|
|
104
100
|
export type ConnectedAccountDisconnectedEvent = z.infer<
|
|
@@ -112,7 +108,7 @@ export const connected_account_completed_first_sync_event =
|
|
|
112
108
|
---
|
|
113
109
|
route_path: /connected_accounts
|
|
114
110
|
---
|
|
115
|
-
A
|
|
111
|
+
A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
|
|
116
112
|
`)
|
|
117
113
|
|
|
118
114
|
export type ConnectedAccountCompletedFirstSyncEvent = z.infer<
|
|
@@ -135,7 +131,7 @@ export const connected_account_deleted_event = connected_account_event.extend({
|
|
|
135
131
|
---
|
|
136
132
|
route_path: /connected_accounts
|
|
137
133
|
---
|
|
138
|
-
A
|
|
134
|
+
A connected account was deleted.
|
|
139
135
|
`)
|
|
140
136
|
|
|
141
137
|
export type ConnectedAccountDeletedEvent = z.infer<
|
|
@@ -151,7 +147,7 @@ export const connected_account_completed_first_sync_after_reconnection_event =
|
|
|
151
147
|
---
|
|
152
148
|
route_path: /connected_accounts
|
|
153
149
|
---
|
|
154
|
-
A
|
|
150
|
+
A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
|
|
155
151
|
`)
|
|
156
152
|
|
|
157
153
|
export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
|
|
@@ -167,7 +163,7 @@ export const connected_account_reauthorization_requested_event =
|
|
|
167
163
|
---
|
|
168
164
|
route_path: /connected_accounts
|
|
169
165
|
---
|
|
170
|
-
A
|
|
166
|
+
A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
|
|
171
167
|
`)
|
|
172
168
|
|
|
173
169
|
export type ConnectedAccountReauthorizationRequestedEvent = z.infer<
|
|
@@ -13,9 +13,7 @@ const device_event = common_event.extend({
|
|
|
13
13
|
connected_account_id: z
|
|
14
14
|
.string()
|
|
15
15
|
.uuid()
|
|
16
|
-
.describe(
|
|
17
|
-
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.',
|
|
18
|
-
),
|
|
16
|
+
.describe('ID of the connected account associated with the event.'),
|
|
19
17
|
customer_key: z
|
|
20
18
|
.string()
|
|
21
19
|
.optional()
|
|
@@ -78,7 +76,7 @@ export const device_connected_event = device_event.extend({
|
|
|
78
76
|
---
|
|
79
77
|
route_path: /devices
|
|
80
78
|
---
|
|
81
|
-
The status of a
|
|
79
|
+
The status of a device changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices.
|
|
82
80
|
`)
|
|
83
81
|
|
|
84
82
|
export type DeviceConnectedEvent = z.infer<typeof device_connected_event>
|
|
@@ -89,7 +87,7 @@ export const device_added_event = device_event.extend({
|
|
|
89
87
|
---
|
|
90
88
|
route_path: /devices
|
|
91
89
|
---
|
|
92
|
-
A
|
|
90
|
+
A device was added to Seam or was re-added to Seam after having been removed.
|
|
93
91
|
`)
|
|
94
92
|
|
|
95
93
|
export type DeviceAddedEvent = z.infer<typeof device_added_event>
|
|
@@ -142,7 +140,7 @@ export const device_disconnected_event = device_event
|
|
|
142
140
|
---
|
|
143
141
|
route_path: /devices
|
|
144
142
|
---
|
|
145
|
-
The status of a
|
|
143
|
+
The status of a device changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
|
|
146
144
|
`)
|
|
147
145
|
|
|
148
146
|
export type DeviceDisconnectedEvent = z.infer<typeof device_disconnected_event>
|
|
@@ -169,7 +167,7 @@ export const device_tampered_event = device_event.extend({
|
|
|
169
167
|
---
|
|
170
168
|
route_path: /devices
|
|
171
169
|
---
|
|
172
|
-
A
|
|
170
|
+
A device detected that it was tampered with, for example, opened or moved.
|
|
173
171
|
`)
|
|
174
172
|
|
|
175
173
|
export type DeviceTamperedEvent = z.infer<typeof device_tampered_event>
|
|
@@ -181,7 +179,7 @@ export const device_low_battery_event = device_event.extend({
|
|
|
181
179
|
---
|
|
182
180
|
route_path: /devices
|
|
183
181
|
---
|
|
184
|
-
A
|
|
182
|
+
A device battery level dropped below the low threshold.
|
|
185
183
|
`)
|
|
186
184
|
|
|
187
185
|
export type DeviceLowBatteryEvent = z.infer<typeof device_low_battery_event>
|
|
@@ -194,7 +192,7 @@ export const device_battery_status_changed_event = device_event.extend({
|
|
|
194
192
|
---
|
|
195
193
|
route_path: /devices
|
|
196
194
|
---
|
|
197
|
-
A
|
|
195
|
+
A device battery status changed since the last \`battery_status_changed\` event.
|
|
198
196
|
`)
|
|
199
197
|
|
|
200
198
|
export type DeviceBatteryStatusChangedEvent = z.infer<
|
|
@@ -207,7 +205,7 @@ export const device_removed_event = device_event.extend({
|
|
|
207
205
|
---
|
|
208
206
|
route_path: /devices
|
|
209
207
|
---
|
|
210
|
-
A
|
|
208
|
+
A device was removed externally from the connected account.
|
|
211
209
|
`)
|
|
212
210
|
|
|
213
211
|
export type DeviceRemovedEvent = z.infer<typeof device_removed_event>
|
|
@@ -225,7 +223,7 @@ export const device_deleted_event = device_event.extend({
|
|
|
225
223
|
---
|
|
226
224
|
route_path: /devices
|
|
227
225
|
---
|
|
228
|
-
A
|
|
226
|
+
A device was deleted.
|
|
229
227
|
`)
|
|
230
228
|
|
|
231
229
|
export type DeviceDeletedEvent = z.infer<typeof device_deleted_event>
|
|
@@ -237,7 +235,7 @@ export const device_third_party_integration_detected_event =
|
|
|
237
235
|
---
|
|
238
236
|
route_path: /devices
|
|
239
237
|
---
|
|
240
|
-
Seam detected that a
|
|
238
|
+
Seam detected that a device is using a third-party integration that will interfere with Seam device management.
|
|
241
239
|
`)
|
|
242
240
|
|
|
243
241
|
export type DeviceThirdPartyIntegrationDetectedEvent = z.infer<
|
|
@@ -251,7 +249,7 @@ export const device_third_party_integration_no_longer_detected_event =
|
|
|
251
249
|
---
|
|
252
250
|
route_path: /devices
|
|
253
251
|
---
|
|
254
|
-
Seam detected that a
|
|
252
|
+
Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.
|
|
255
253
|
`)
|
|
256
254
|
|
|
257
255
|
export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer<
|
|
@@ -292,7 +290,7 @@ export const device_connection_became_flaky_event = device_event
|
|
|
292
290
|
---
|
|
293
291
|
route_path: /devices
|
|
294
292
|
---
|
|
295
|
-
Seam detected a flaky
|
|
293
|
+
Seam detected a flaky device connection.
|
|
296
294
|
`)
|
|
297
295
|
|
|
298
296
|
export type DeviceConnectionBecameFlakyEvent = z.infer<
|
|
@@ -305,7 +303,7 @@ export const device_connection_stabilized_event = device_event.extend({
|
|
|
305
303
|
---
|
|
306
304
|
route_path: /devices
|
|
307
305
|
---
|
|
308
|
-
Seam detected that a previously-flaky
|
|
306
|
+
Seam detected that a previously-flaky device connection stabilized.
|
|
309
307
|
`)
|
|
310
308
|
|
|
311
309
|
export type DeviceConnectionStabilizedEvent = z.infer<
|
|
@@ -320,7 +318,7 @@ export const device_error_subscription_required_event = device_event
|
|
|
320
318
|
---
|
|
321
319
|
route_path: /devices
|
|
322
320
|
---
|
|
323
|
-
A third-party subscription is required to use all
|
|
321
|
+
A third-party subscription is required to use all device features.
|
|
324
322
|
`)
|
|
325
323
|
|
|
326
324
|
export type DeviceErrorSubscriptionRequiredEvent = z.infer<
|
|
@@ -334,7 +332,7 @@ export const device_error_subscription_required_resolved_event =
|
|
|
334
332
|
---
|
|
335
333
|
route_path: /devices
|
|
336
334
|
---
|
|
337
|
-
A third-party subscription is active or no longer required to use all
|
|
335
|
+
A third-party subscription is active or no longer required to use all device features.
|
|
338
336
|
`)
|
|
339
337
|
|
|
340
338
|
export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer<
|
|
@@ -347,7 +345,7 @@ export const device_accessory_keypad_connected_event = device_event.extend({
|
|
|
347
345
|
---
|
|
348
346
|
route_path: /devices
|
|
349
347
|
---
|
|
350
|
-
An accessory keypad was connected to a
|
|
348
|
+
An accessory keypad was connected to a device.
|
|
351
349
|
`)
|
|
352
350
|
|
|
353
351
|
export type DeviceAccessoryKeypadConnectedEvent = z.infer<
|
|
@@ -362,7 +360,7 @@ export const device_accessory_keypad_disconnected_event = device_event
|
|
|
362
360
|
---
|
|
363
361
|
route_path: /devices
|
|
364
362
|
---
|
|
365
|
-
An accessory keypad was disconnected from a
|
|
363
|
+
An accessory keypad was disconnected from a device.
|
|
366
364
|
`)
|
|
367
365
|
|
|
368
366
|
export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<
|
|
@@ -724,7 +722,7 @@ export const device_name_changed_event = device_event.extend({
|
|
|
724
722
|
---
|
|
725
723
|
route_path: /devices
|
|
726
724
|
---
|
|
727
|
-
The name of a
|
|
725
|
+
The name of a device was changed.
|
|
728
726
|
`)
|
|
729
727
|
|
|
730
728
|
export type DeviceNameChangedEvent = z.infer<typeof device_name_changed_event>
|
|
@@ -752,7 +750,7 @@ export const camera_activated_event = device_event.extend({
|
|
|
752
750
|
---
|
|
753
751
|
route_path: /devices
|
|
754
752
|
---
|
|
755
|
-
A
|
|
753
|
+
A camera was activated, for example, by motion detection.
|
|
756
754
|
`)
|
|
757
755
|
|
|
758
756
|
export type CameraActivatedEvent = z.infer<typeof camera_activated_event>
|
|
@@ -777,7 +775,7 @@ export const device_doorbell_rang_event = device_event.extend({
|
|
|
777
775
|
---
|
|
778
776
|
route_path: /devices
|
|
779
777
|
---
|
|
780
|
-
A doorbell button was pressed on a
|
|
778
|
+
A doorbell button was pressed on a device.
|
|
781
779
|
`)
|
|
782
780
|
|
|
783
781
|
export type DeviceDoorbellRangEvent = z.infer<typeof device_doorbell_rang_event>
|
|
@@ -32,7 +32,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
|
|
|
32
32
|
---
|
|
33
33
|
Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
|
|
34
34
|
|
|
35
|
-
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate
|
|
35
|
+
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
|
|
36
36
|
`)
|
|
37
37
|
|
|
38
38
|
export type SeamEvent = z.infer<typeof seam_event>
|
|
@@ -5,9 +5,7 @@ export const instant_key = z.object({
|
|
|
5
5
|
workspace_id: z
|
|
6
6
|
.string()
|
|
7
7
|
.uuid()
|
|
8
|
-
.describe(
|
|
9
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key.',
|
|
10
|
-
),
|
|
8
|
+
.describe('ID of the workspace that contains the Instant Key.'),
|
|
11
9
|
created_at: z
|
|
12
10
|
.string()
|
|
13
11
|
.datetime()
|
|
@@ -21,9 +19,7 @@ export const instant_key = z.object({
|
|
|
21
19
|
client_session_id: z
|
|
22
20
|
.string()
|
|
23
21
|
.uuid()
|
|
24
|
-
.describe(
|
|
25
|
-
'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key.',
|
|
26
|
-
),
|
|
22
|
+
.describe('ID of the client session associated with the Instant Key.'),
|
|
27
23
|
user_identity_id: z
|
|
28
24
|
.string()
|
|
29
25
|
.uuid()
|
|
@@ -11,9 +11,7 @@ export const customer_portal = z
|
|
|
11
11
|
workspace_id: z
|
|
12
12
|
.string()
|
|
13
13
|
.uuid()
|
|
14
|
-
.describe(
|
|
15
|
-
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal.',
|
|
16
|
-
),
|
|
14
|
+
.describe('ID of the workspace associated with the customer portal.'),
|
|
17
15
|
created_at: z
|
|
18
16
|
.string()
|
|
19
17
|
.datetime()
|