@seamapi/types 1.424.0 → 1.425.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 +197 -10
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +582 -6
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-credential.js +4 -0
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +25 -2
- package/lib/seam/connect/models/acs/acs-entrance.js +18 -2
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +4 -1
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +24 -0
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +10 -0
- package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +14 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +66 -4
- package/lib/seam/connect/openapi.d.ts +254 -4
- package/lib/seam/connect/openapi.js +178 -8
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +286 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/acs/acs-credential.ts +6 -0
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +93 -70
- package/src/lib/seam/connect/models/acs/acs-system.ts +4 -1
- package/src/lib/seam/connect/openapi.ts +203 -8
- package/src/lib/seam/connect/route-types.ts +286 -0
package/package.json
CHANGED
|
@@ -142,6 +142,12 @@ const common_acs_credential = z.object({
|
|
|
142
142
|
.describe(
|
|
143
143
|
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
144
144
|
),
|
|
145
|
+
connected_account_id: z
|
|
146
|
+
.string()
|
|
147
|
+
.uuid()
|
|
148
|
+
.describe(
|
|
149
|
+
'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
150
|
+
),
|
|
145
151
|
acs_credential_pool_id: z.string().uuid().optional(),
|
|
146
152
|
acs_system_id: z
|
|
147
153
|
.string()
|
|
@@ -9,85 +9,108 @@ import {
|
|
|
9
9
|
} from './metadata/index.js'
|
|
10
10
|
import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js'
|
|
11
11
|
|
|
12
|
-
export const
|
|
13
|
-
|
|
14
|
-
.
|
|
15
|
-
.uuid()
|
|
16
|
-
.describe(
|
|
17
|
-
'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
18
|
-
),
|
|
19
|
-
acs_entrance_id: z
|
|
20
|
-
.string()
|
|
21
|
-
.uuid()
|
|
22
|
-
.describe(
|
|
23
|
-
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
24
|
-
),
|
|
25
|
-
created_at: z
|
|
26
|
-
.string()
|
|
27
|
-
.datetime()
|
|
28
|
-
.describe(
|
|
29
|
-
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
30
|
-
),
|
|
31
|
-
display_name: z
|
|
32
|
-
.string()
|
|
33
|
-
.describe(
|
|
34
|
-
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
35
|
-
),
|
|
36
|
-
connected_account_id: z
|
|
37
|
-
.string()
|
|
38
|
-
.uuid()
|
|
39
|
-
.describe(
|
|
40
|
-
'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
41
|
-
),
|
|
42
|
-
errors: z
|
|
43
|
-
.array(
|
|
44
|
-
z.object({
|
|
45
|
-
error_code: z
|
|
46
|
-
.string()
|
|
47
|
-
.describe(
|
|
48
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
49
|
-
),
|
|
50
|
-
message: z
|
|
51
|
-
.string()
|
|
52
|
-
.describe(
|
|
53
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
54
|
-
),
|
|
55
|
-
}),
|
|
56
|
-
)
|
|
57
|
-
.describe(
|
|
58
|
-
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
59
|
-
),
|
|
60
|
-
latch_metadata: acs_entrance_latch_metadata
|
|
61
|
-
.optional()
|
|
62
|
-
.describe(
|
|
63
|
-
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
64
|
-
),
|
|
65
|
-
visionline_metadata: acs_entrance_visionline_metadata
|
|
12
|
+
export const acs_entrance_capability_flags = z.object({
|
|
13
|
+
can_unlock_with_mobile_key: z
|
|
14
|
+
.boolean()
|
|
66
15
|
.optional()
|
|
67
16
|
.describe(
|
|
68
|
-
'
|
|
17
|
+
'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
|
|
69
18
|
),
|
|
70
|
-
|
|
19
|
+
can_unlock_with_card: z
|
|
20
|
+
.boolean()
|
|
71
21
|
.optional()
|
|
72
22
|
.describe(
|
|
73
|
-
'
|
|
23
|
+
'Indicates whether the ACS entrance can be unlocked with card credentials.',
|
|
74
24
|
),
|
|
75
|
-
|
|
25
|
+
can_unlock_with_code: z
|
|
26
|
+
.boolean()
|
|
76
27
|
.optional()
|
|
77
28
|
.describe(
|
|
78
|
-
'
|
|
29
|
+
'Indicates whether the ACS entrance can be unlocked with pin codes.',
|
|
79
30
|
),
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
31
|
+
})
|
|
32
|
+
|
|
33
|
+
export const acs_entrance = z
|
|
34
|
+
.object({
|
|
35
|
+
acs_system_id: z
|
|
36
|
+
.string()
|
|
37
|
+
.uuid()
|
|
38
|
+
.describe(
|
|
39
|
+
'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
40
|
+
),
|
|
41
|
+
acs_entrance_id: z
|
|
42
|
+
.string()
|
|
43
|
+
.uuid()
|
|
44
|
+
.describe(
|
|
45
|
+
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
46
|
+
),
|
|
47
|
+
created_at: z
|
|
48
|
+
.string()
|
|
49
|
+
.datetime()
|
|
50
|
+
.describe(
|
|
51
|
+
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
52
|
+
),
|
|
53
|
+
display_name: z
|
|
54
|
+
.string()
|
|
55
|
+
.describe(
|
|
56
|
+
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
57
|
+
),
|
|
58
|
+
connected_account_id: z
|
|
59
|
+
.string()
|
|
60
|
+
.uuid()
|
|
61
|
+
.describe(
|
|
62
|
+
'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
63
|
+
),
|
|
64
|
+
errors: z
|
|
65
|
+
.array(
|
|
66
|
+
z.object({
|
|
67
|
+
error_code: z
|
|
68
|
+
.string()
|
|
69
|
+
.describe(
|
|
70
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
71
|
+
),
|
|
72
|
+
message: z
|
|
73
|
+
.string()
|
|
74
|
+
.describe(
|
|
75
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
76
|
+
),
|
|
77
|
+
}),
|
|
78
|
+
)
|
|
79
|
+
.describe(
|
|
80
|
+
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
81
|
+
),
|
|
82
|
+
latch_metadata: acs_entrance_latch_metadata
|
|
83
|
+
.optional()
|
|
84
|
+
.describe(
|
|
85
|
+
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
86
|
+
),
|
|
87
|
+
visionline_metadata: acs_entrance_visionline_metadata
|
|
88
|
+
.optional()
|
|
89
|
+
.describe(
|
|
90
|
+
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
91
|
+
),
|
|
92
|
+
salto_ks_metadata: acs_entrance_salto_ks_metadata
|
|
93
|
+
.optional()
|
|
94
|
+
.describe(
|
|
95
|
+
'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
96
|
+
),
|
|
97
|
+
dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata
|
|
98
|
+
.optional()
|
|
99
|
+
.describe(
|
|
100
|
+
'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
101
|
+
),
|
|
102
|
+
assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata
|
|
103
|
+
.optional()
|
|
104
|
+
.describe(
|
|
105
|
+
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
106
|
+
),
|
|
107
|
+
salto_space_metadata: acs_entrance_salto_space_metadata
|
|
108
|
+
.optional()
|
|
109
|
+
.describe(
|
|
110
|
+
'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
111
|
+
),
|
|
112
|
+
})
|
|
113
|
+
.merge(acs_entrance_capability_flags).describe(`
|
|
91
114
|
---
|
|
92
115
|
route_path: /acs/entrances
|
|
93
116
|
---
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { z } from 'zod'
|
|
2
2
|
|
|
3
|
-
export const acs_system_capability_flags = z.object({
|
|
3
|
+
export const acs_system_capability_flags = z.object({
|
|
4
|
+
// Access method type capability flags are not publicly exposed for ACS systems
|
|
5
|
+
// They are only available for ACS entrances
|
|
6
|
+
})
|
|
4
7
|
|
|
5
8
|
export const acs_location = z.object({
|
|
6
9
|
time_zone: z
|