@seamapi/types 1.430.0 → 1.432.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 +142 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +519 -166
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +2 -2
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.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 +7 -2
- package/lib/seam/connect/models/acs/acs-credential.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 +12 -0
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +57 -4
- package/lib/seam/connect/models/user-identities/user-identity.js +27 -3
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +69 -12
- package/lib/seam/connect/openapi.js +118 -55
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +401 -151
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +9 -2
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +37 -3
- package/src/lib/seam/connect/openapi.ts +130 -55
- package/src/lib/seam/connect/route-types.ts +401 -151
package/package.json
CHANGED
|
@@ -29,7 +29,7 @@ export const enrollment_automation = z.object({
|
|
|
29
29
|
.string()
|
|
30
30
|
.uuid()
|
|
31
31
|
.describe(
|
|
32
|
-
'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
32
|
+
'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
33
33
|
),
|
|
34
34
|
created_at: z
|
|
35
35
|
.string()
|
|
@@ -46,7 +46,7 @@ export const enrollment_automation = z.object({
|
|
|
46
46
|
route_path: /user_identities/enrollment_automations
|
|
47
47
|
deprecated: Will be removed. Instead, link the \`user_identity\` to the \`acs_user\` in the access system in which you want to issue credentials.
|
|
48
48
|
---
|
|
49
|
-
Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
49
|
+
Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).
|
|
50
50
|
`)
|
|
51
51
|
|
|
52
52
|
export type EnrollmentAutomation = z.output<typeof enrollment_automation>
|
|
@@ -142,6 +142,13 @@ 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
|
+
user_identity_id: z
|
|
146
|
+
.string()
|
|
147
|
+
.uuid()
|
|
148
|
+
.optional()
|
|
149
|
+
.describe(
|
|
150
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
151
|
+
),
|
|
145
152
|
connected_account_id: z
|
|
146
153
|
.string()
|
|
147
154
|
.uuid()
|
|
@@ -259,7 +266,7 @@ const common_acs_credential = z.object({
|
|
|
259
266
|
.boolean()
|
|
260
267
|
.optional()
|
|
261
268
|
.describe(
|
|
262
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
269
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
263
270
|
),
|
|
264
271
|
is_latest_desired_state_synced_with_provider: z
|
|
265
272
|
.boolean()
|
|
@@ -398,7 +405,7 @@ export const acs_credential_on_encoder = z.object({
|
|
|
398
405
|
.string()
|
|
399
406
|
.optional()
|
|
400
407
|
.describe(
|
|
401
|
-
'
|
|
408
|
+
'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
402
409
|
),
|
|
403
410
|
|
|
404
411
|
number_of_issued_cards: z
|
|
@@ -36,7 +36,37 @@ const user_identity_being_deleted = common_user_identity_warning
|
|
|
36
36
|
})
|
|
37
37
|
.describe('Indicates that the user identity is currently being deleted.')
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
const user_identity_issue_with_acs_user = common_user_identity_error
|
|
40
|
+
.extend({
|
|
41
|
+
error_code: z
|
|
42
|
+
.literal('issue_with_acs_user')
|
|
43
|
+
.describe(
|
|
44
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
45
|
+
),
|
|
46
|
+
acs_user_id: z
|
|
47
|
+
.string()
|
|
48
|
+
.uuid()
|
|
49
|
+
.describe('ID of the access system user that has an issue.'),
|
|
50
|
+
acs_system_id: z
|
|
51
|
+
.string()
|
|
52
|
+
.uuid()
|
|
53
|
+
.describe(
|
|
54
|
+
'ID of the access system that the user identity is associated with.',
|
|
55
|
+
),
|
|
56
|
+
})
|
|
57
|
+
.describe(
|
|
58
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
59
|
+
)
|
|
60
|
+
|
|
61
|
+
export const user_identity_error_map = z.object({
|
|
62
|
+
issue_with_acs_user: z
|
|
63
|
+
.record(z.string().uuid(), user_identity_issue_with_acs_user)
|
|
64
|
+
.optional()
|
|
65
|
+
.nullable()
|
|
66
|
+
.describe(
|
|
67
|
+
'Map of access system user IDs to issues with the access system user. The key is the access system user ID, and the value is the issue with the access system user.',
|
|
68
|
+
),
|
|
69
|
+
})
|
|
40
70
|
|
|
41
71
|
export type UserIdentityErrorMap = z.infer<typeof user_identity_error_map>
|
|
42
72
|
|
|
@@ -52,6 +82,10 @@ export const user_identity_warning_map = z.object({
|
|
|
52
82
|
|
|
53
83
|
export type UserIdentityWarningMap = z.infer<typeof user_identity_warning_map>
|
|
54
84
|
|
|
85
|
+
const user_identity_errors = z
|
|
86
|
+
.discriminatedUnion('error_code', [user_identity_issue_with_acs_user])
|
|
87
|
+
.describe('Errors associated with the user identity.')
|
|
88
|
+
|
|
55
89
|
export const user_identity = z.object({
|
|
56
90
|
user_identity_id: z.string().uuid().describe('ID of the user identity.'),
|
|
57
91
|
user_identity_key: z
|
|
@@ -82,9 +116,9 @@ export const user_identity = z.object({
|
|
|
82
116
|
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
83
117
|
),
|
|
84
118
|
errors: z
|
|
85
|
-
.array(
|
|
119
|
+
.array(user_identity_errors)
|
|
86
120
|
.describe(
|
|
87
|
-
'Array of errors associated with the user identity. Each error object within the array contains
|
|
121
|
+
'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
88
122
|
),
|
|
89
123
|
warnings: z
|
|
90
124
|
.array(user_identity_warnings)
|