@seamapi/types 1.1078.0 → 1.1079.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/lib/seam/connect/models/access-codes/managed-access-code.js +9 -9
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +2 -2
- package/lib/seam/connect/models/access-grants/access-grant.js +5 -5
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.js +11 -11
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +3 -3
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +3 -3
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +54 -54
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +11 -11
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +21 -21
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +39 -39
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +38 -38
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.js +1 -1
- package/lib/seam/connect/models/bridges/bridge-connected-system.js +4 -4
- 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/client-sessions/client-session.js +12 -12
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +5 -5
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +4 -4
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/custom-metadata.js +2 -2
- package/lib/seam/connect/models/custom-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/capabilities-supported.js +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +2 -2
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/thermostat.js +21 -21
- package/lib/seam/connect/models/devices/device.js +8 -8
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +1 -1
- package/lib/seam/connect/models/events/access-codes.js +26 -26
- package/lib/seam/connect/models/events/access-grants.js +1 -1
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/acs/credentials.js +4 -4
- package/lib/seam/connect/models/events/acs/encoders.js +2 -2
- package/lib/seam/connect/models/events/acs/entrances.js +2 -2
- package/lib/seam/connect/models/events/acs/systems.js +3 -3
- package/lib/seam/connect/models/events/acs/users.js +2 -2
- package/lib/seam/connect/models/events/devices.js +17 -17
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js +2 -2
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
- package/lib/seam/connect/models/thermostats/climate-preset.js +13 -13
- package/lib/seam/connect/models/thermostats/climate-preset.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 +11 -11
- 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/webhooks/webhook.js +4 -4
- package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +12 -12
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.js +1066 -1064
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8171 -8171
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -9
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +2 -2
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -5
- package/src/lib/seam/connect/models/access-grants/access-method.ts +11 -11
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +3 -3
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +3 -3
- package/src/lib/seam/connect/models/acs/acs-credential.ts +54 -54
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +11 -11
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +21 -21
- package/src/lib/seam/connect/models/acs/acs-system.ts +39 -39
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +38 -38
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +1 -1
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +1 -1
- package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +4 -4
- package/src/lib/seam/connect/models/bridges/bridge.ts +1 -1
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +12 -12
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +5 -5
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +4 -4
- package/src/lib/seam/connect/models/custom-metadata.ts +2 -2
- package/src/lib/seam/connect/models/devices/capabilities-supported.ts +1 -1
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +2 -2
- package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +21 -21
- package/src/lib/seam/connect/models/devices/device.ts +8 -8
- package/src/lib/seam/connect/models/devices/phone.ts +1 -1
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +26 -26
- package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
- package/src/lib/seam/connect/models/events/acs/credentials.ts +4 -4
- package/src/lib/seam/connect/models/events/acs/encoders.ts +2 -2
- package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
- package/src/lib/seam/connect/models/events/acs/systems.ts +3 -3
- package/src/lib/seam/connect/models/events/acs/users.ts +2 -2
- package/src/lib/seam/connect/models/events/devices.ts +17 -17
- package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
- package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +2 -2
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +13 -13
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +1 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +11 -11
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
- package/src/lib/seam/connect/models/webhooks/webhook.ts +4 -4
- package/src/lib/seam/connect/models/workspaces/workspace.ts +12 -12
- package/src/lib/seam/connect/openapi.ts +1066 -1064
- package/src/lib/seam/connect/route-types.ts +8171 -8168
|
@@ -56,7 +56,7 @@ const waiting_to_be_issued = common_acs_credential_warning
|
|
|
56
56
|
.describe(warning_code_description),
|
|
57
57
|
})
|
|
58
58
|
.describe(
|
|
59
|
-
'Indicates that the [credential](https://
|
|
59
|
+
'Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued.',
|
|
60
60
|
)
|
|
61
61
|
|
|
62
62
|
const schedule_externally_modified = common_acs_credential_warning
|
|
@@ -66,7 +66,7 @@ const schedule_externally_modified = common_acs_credential_warning
|
|
|
66
66
|
.describe(warning_code_description),
|
|
67
67
|
})
|
|
68
68
|
.describe(
|
|
69
|
-
"Indicates that the schedule of one of the [credential](https://
|
|
69
|
+
"Indicates that the schedule of one of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials)'s children was modified externally.",
|
|
70
70
|
)
|
|
71
71
|
|
|
72
72
|
const schedule_modified = common_acs_credential_warning
|
|
@@ -76,7 +76,7 @@ const schedule_modified = common_acs_credential_warning
|
|
|
76
76
|
.describe(warning_code_description),
|
|
77
77
|
})
|
|
78
78
|
.describe(
|
|
79
|
-
'Indicates that the schedule of the [credential](https://
|
|
79
|
+
'Indicates that the schedule of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
|
|
80
80
|
)
|
|
81
81
|
|
|
82
82
|
const being_deleted = common_acs_credential_warning
|
|
@@ -84,7 +84,7 @@ const being_deleted = common_acs_credential_warning
|
|
|
84
84
|
warning_code: z.literal('being_deleted').describe(warning_code_description),
|
|
85
85
|
})
|
|
86
86
|
.describe(
|
|
87
|
-
'Indicates that the [credential](https://
|
|
87
|
+
'Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted.',
|
|
88
88
|
)
|
|
89
89
|
|
|
90
90
|
export const unknown_issue_with_acs_credential = common_acs_credential_warning
|
|
@@ -94,7 +94,7 @@ export const unknown_issue_with_acs_credential = common_acs_credential_warning
|
|
|
94
94
|
.describe(warning_code_description),
|
|
95
95
|
})
|
|
96
96
|
.describe(
|
|
97
|
-
'An unknown issue occurred while syncing the state of the [credential](https://
|
|
97
|
+
'An unknown issue occurred while syncing the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
|
|
98
98
|
)
|
|
99
99
|
|
|
100
100
|
const needs_to_be_reissued = common_acs_credential_warning
|
|
@@ -104,7 +104,7 @@ const needs_to_be_reissued = common_acs_credential_warning
|
|
|
104
104
|
.describe(warning_code_description),
|
|
105
105
|
})
|
|
106
106
|
.describe(
|
|
107
|
-
'Access permissions for the [credential](https://
|
|
107
|
+
'Access permissions for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
|
|
108
108
|
)
|
|
109
109
|
|
|
110
110
|
const requested_code_unavailable = common_acs_credential_warning
|
|
@@ -132,7 +132,7 @@ const acs_credential_warning = z
|
|
|
132
132
|
requested_code_unavailable,
|
|
133
133
|
])
|
|
134
134
|
.describe(
|
|
135
|
-
'Warning associated with the [credential](https://
|
|
135
|
+
'Warning associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
136
136
|
)
|
|
137
137
|
|
|
138
138
|
const _acs_credential_warning_map = z.object({
|
|
@@ -158,27 +158,27 @@ const common_acs_credential = z.object({
|
|
|
158
158
|
.string()
|
|
159
159
|
.uuid()
|
|
160
160
|
.describe(
|
|
161
|
-
'ID of the [credential](https://
|
|
161
|
+
'ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
162
162
|
),
|
|
163
163
|
acs_user_id: z
|
|
164
164
|
.string()
|
|
165
165
|
.uuid()
|
|
166
166
|
.optional()
|
|
167
167
|
.describe(
|
|
168
|
-
'ID of the [ACS user](https://
|
|
168
|
+
'ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
169
169
|
),
|
|
170
170
|
user_identity_id: z
|
|
171
171
|
.string()
|
|
172
172
|
.uuid()
|
|
173
173
|
.optional()
|
|
174
174
|
.describe(
|
|
175
|
-
'ID of the [user identity](https://
|
|
175
|
+
'ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
176
176
|
),
|
|
177
177
|
connected_account_id: z
|
|
178
178
|
.string()
|
|
179
179
|
.uuid()
|
|
180
180
|
.describe(
|
|
181
|
-
'ID of the [connected account](https://
|
|
181
|
+
'ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
182
182
|
),
|
|
183
183
|
acs_credential_pool_id: z
|
|
184
184
|
.string()
|
|
@@ -189,87 +189,87 @@ const common_acs_credential = z.object({
|
|
|
189
189
|
.string()
|
|
190
190
|
.uuid()
|
|
191
191
|
.describe(
|
|
192
|
-
'ID of the [access control system](https://
|
|
192
|
+
'ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
193
193
|
),
|
|
194
194
|
parent_acs_credential_id: z
|
|
195
195
|
.string()
|
|
196
196
|
.uuid()
|
|
197
197
|
.optional()
|
|
198
198
|
.describe(
|
|
199
|
-
'ID of the parent [credential](https://
|
|
199
|
+
'ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
200
200
|
),
|
|
201
201
|
display_name: z
|
|
202
202
|
.string()
|
|
203
203
|
.min(1)
|
|
204
204
|
.describe(
|
|
205
|
-
'Display name that corresponds to the [credential](https://
|
|
205
|
+
'Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.',
|
|
206
206
|
),
|
|
207
207
|
code: z
|
|
208
208
|
.string()
|
|
209
209
|
.optional()
|
|
210
210
|
.nullable()
|
|
211
211
|
.describe(
|
|
212
|
-
'Access (PIN) code for the [credential](https://
|
|
212
|
+
'Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
213
213
|
),
|
|
214
214
|
is_one_time_use: z
|
|
215
215
|
.boolean()
|
|
216
216
|
.optional()
|
|
217
217
|
.describe(
|
|
218
|
-
'Indicates whether the [credential](https://
|
|
218
|
+
'Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
|
|
219
219
|
),
|
|
220
220
|
card_number: z
|
|
221
221
|
.string()
|
|
222
222
|
.optional()
|
|
223
223
|
.nullable()
|
|
224
224
|
.describe(
|
|
225
|
-
'Number of the card associated with the [credential](https://
|
|
225
|
+
'Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
226
226
|
),
|
|
227
227
|
is_issued: z
|
|
228
228
|
.boolean()
|
|
229
229
|
.optional()
|
|
230
230
|
.describe(
|
|
231
|
-
'Indicates whether the [credential](https://
|
|
231
|
+
'Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.',
|
|
232
232
|
),
|
|
233
233
|
issued_at: datetime
|
|
234
234
|
.optional()
|
|
235
235
|
.nullable()
|
|
236
236
|
.describe(
|
|
237
|
-
'Date and time at which the [credential](https://
|
|
237
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.',
|
|
238
238
|
),
|
|
239
239
|
access_method: acs_credential_access_method_type.describe(
|
|
240
|
-
'Access method for the [credential](https://
|
|
240
|
+
'Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.',
|
|
241
241
|
),
|
|
242
242
|
external_type: acs_credential_external_type
|
|
243
243
|
.optional()
|
|
244
244
|
.describe(
|
|
245
|
-
'Brand-specific terminology for the [credential](https://
|
|
245
|
+
'Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
246
246
|
),
|
|
247
247
|
external_type_display_name: z
|
|
248
248
|
.string()
|
|
249
249
|
.optional()
|
|
250
250
|
.describe(
|
|
251
|
-
'Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
251
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.',
|
|
252
252
|
),
|
|
253
253
|
created_at: datetime.describe(
|
|
254
|
-
'Date and time at which the [credential](https://
|
|
254
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.',
|
|
255
255
|
),
|
|
256
256
|
workspace_id: z
|
|
257
257
|
.string()
|
|
258
258
|
.uuid()
|
|
259
259
|
.describe(
|
|
260
|
-
'ID of the workspace that contains the [credential](https://
|
|
260
|
+
'ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
261
261
|
),
|
|
262
262
|
starts_at: z
|
|
263
263
|
.string()
|
|
264
264
|
.optional()
|
|
265
265
|
.describe(
|
|
266
|
-
'Date and time at which the [credential](https://
|
|
266
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
267
267
|
),
|
|
268
268
|
ends_at: z
|
|
269
269
|
.string()
|
|
270
270
|
.optional()
|
|
271
271
|
.describe(
|
|
272
|
-
'Date and time at which the [credential](https://
|
|
272
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
273
273
|
),
|
|
274
274
|
errors: z
|
|
275
275
|
.array(
|
|
@@ -282,46 +282,46 @@ const common_acs_credential = z.object({
|
|
|
282
282
|
}),
|
|
283
283
|
)
|
|
284
284
|
.describe(
|
|
285
|
-
'Errors associated with the [credential](https://
|
|
285
|
+
'Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
286
286
|
),
|
|
287
287
|
warnings: z
|
|
288
288
|
.array(acs_credential_warning)
|
|
289
289
|
.describe(
|
|
290
|
-
'Warnings associated with the [credential](https://
|
|
290
|
+
'Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
291
291
|
),
|
|
292
292
|
is_multi_phone_sync_credential: z
|
|
293
293
|
.boolean()
|
|
294
294
|
.optional()
|
|
295
295
|
.describe(
|
|
296
|
-
'Indicates whether the [credential](https://
|
|
296
|
+
'Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
297
297
|
),
|
|
298
298
|
is_latest_desired_state_synced_with_provider: z
|
|
299
299
|
.boolean()
|
|
300
300
|
.nullable()
|
|
301
301
|
.optional()
|
|
302
302
|
.describe(
|
|
303
|
-
'Indicates whether the latest state of the [credential](https://
|
|
303
|
+
'Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.',
|
|
304
304
|
),
|
|
305
305
|
latest_desired_state_synced_with_provider_at: datetime
|
|
306
306
|
.nullable()
|
|
307
307
|
.optional()
|
|
308
308
|
.describe(
|
|
309
|
-
'Date and time at which the state of the [credential](https://
|
|
309
|
+
'Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
|
|
310
310
|
),
|
|
311
311
|
visionline_metadata: acs_credential_visionline_metadata
|
|
312
312
|
.optional()
|
|
313
313
|
.describe(
|
|
314
|
-
'Visionline-specific metadata for the [credential](https://
|
|
314
|
+
'Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
315
315
|
),
|
|
316
316
|
assa_abloy_vostio_metadata: acs_credential_vostio_metadata
|
|
317
317
|
.optional()
|
|
318
318
|
.describe(
|
|
319
|
-
'Vostio-specific metadata for the [credential](https://
|
|
319
|
+
'Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
320
320
|
),
|
|
321
321
|
akiles_metadata: acs_credential_akiles_metadata
|
|
322
322
|
.optional()
|
|
323
323
|
.describe(
|
|
324
|
-
'Akiles-specific metadata for the [credential](https://
|
|
324
|
+
'Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
325
325
|
),
|
|
326
326
|
})
|
|
327
327
|
|
|
@@ -335,13 +335,13 @@ export const acs_credential = common_acs_credential.merge(
|
|
|
335
335
|
---
|
|
336
336
|
route_path: /acs/credentials
|
|
337
337
|
---
|
|
338
|
-
Means by which an [access control system user](https://
|
|
338
|
+
Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
339
339
|
|
|
340
340
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
341
341
|
|
|
342
342
|
For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
343
343
|
|
|
344
|
-
For granting a person access to a space, [Access Grants](https://
|
|
344
|
+
For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
|
|
345
345
|
`)
|
|
346
346
|
|
|
347
347
|
export const unmanaged_acs_credential = common_acs_credential.merge(
|
|
@@ -353,14 +353,14 @@ export const unmanaged_acs_credential = common_acs_credential.merge(
|
|
|
353
353
|
route_path: /acs/credentials/unmanaged
|
|
354
354
|
undocumented: Unreleased.
|
|
355
355
|
---
|
|
356
|
-
Means by which an [ACS user](https://
|
|
356
|
+
Means by which an [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
|
|
357
357
|
`)
|
|
358
358
|
|
|
359
359
|
export const acs_credential_on_encoder = z.object({
|
|
360
360
|
created_at: datetime
|
|
361
361
|
.nullable()
|
|
362
362
|
.describe(
|
|
363
|
-
'Date and time at which the [credential](https://
|
|
363
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.',
|
|
364
364
|
),
|
|
365
365
|
|
|
366
366
|
is_issued: z
|
|
@@ -373,19 +373,19 @@ export const acs_credential_on_encoder = z.object({
|
|
|
373
373
|
starts_at: datetime
|
|
374
374
|
.nullable()
|
|
375
375
|
.describe(
|
|
376
|
-
'Date and time at which the [credential](https://
|
|
376
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable.',
|
|
377
377
|
),
|
|
378
378
|
ends_at: datetime
|
|
379
379
|
.nullable()
|
|
380
380
|
.describe(
|
|
381
|
-
'Date and time at which the [credential](https://
|
|
381
|
+
'Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable.',
|
|
382
382
|
),
|
|
383
383
|
|
|
384
384
|
card_number: z
|
|
385
385
|
.string()
|
|
386
386
|
.nullable()
|
|
387
387
|
.describe(
|
|
388
|
-
'A number or string that physically identifies the card associated with the [credential](https://
|
|
388
|
+
'A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
389
389
|
),
|
|
390
390
|
|
|
391
391
|
visionline_metadata: z
|
|
@@ -394,83 +394,83 @@ export const acs_credential_on_encoder = z.object({
|
|
|
394
394
|
.string()
|
|
395
395
|
.optional()
|
|
396
396
|
.describe(
|
|
397
|
-
'Card ID for the Visionline card associated with the [credential](https://
|
|
397
|
+
'Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
398
398
|
),
|
|
399
399
|
// TODO card_function_type: z.enum(["guest", "staff"]), // computed, looks at door ops, and checks is guest op is present.
|
|
400
400
|
cancelled: z
|
|
401
401
|
.boolean()
|
|
402
402
|
.optional()
|
|
403
403
|
.describe(
|
|
404
|
-
'Indicates whether the card associated with the [credential](https://
|
|
404
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled.',
|
|
405
405
|
),
|
|
406
406
|
discarded: z
|
|
407
407
|
.boolean()
|
|
408
408
|
.optional()
|
|
409
409
|
.describe(
|
|
410
|
-
'Indicates whether the card associated with the [credential](https://
|
|
410
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded.',
|
|
411
411
|
),
|
|
412
412
|
expired: z
|
|
413
413
|
.boolean()
|
|
414
414
|
.optional()
|
|
415
415
|
.describe(
|
|
416
|
-
'Indicates whether the card associated with the [credential](https://
|
|
416
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired.',
|
|
417
417
|
),
|
|
418
418
|
overwritten: z
|
|
419
419
|
.boolean()
|
|
420
420
|
.optional()
|
|
421
421
|
.describe(
|
|
422
|
-
'Indicates whether the card associated with the [credential](https://
|
|
422
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten.',
|
|
423
423
|
),
|
|
424
424
|
overridden: z
|
|
425
425
|
.boolean()
|
|
426
426
|
.optional()
|
|
427
427
|
.describe(
|
|
428
|
-
'Indicates whether the card associated with the [credential](https://
|
|
428
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden.',
|
|
429
429
|
),
|
|
430
430
|
pending_auto_update: z
|
|
431
431
|
.boolean()
|
|
432
432
|
.optional()
|
|
433
433
|
.describe(
|
|
434
|
-
'Indicates whether the card associated with the [credential](https://
|
|
434
|
+
'Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update.',
|
|
435
435
|
),
|
|
436
436
|
|
|
437
437
|
card_format: z
|
|
438
438
|
.enum(['TLCode', 'rfid48'])
|
|
439
439
|
.optional()
|
|
440
440
|
.describe(
|
|
441
|
-
'Format of the card associated with the [credential](https://
|
|
441
|
+
'Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
442
442
|
),
|
|
443
443
|
card_holder: z
|
|
444
444
|
.string()
|
|
445
445
|
.optional()
|
|
446
446
|
.describe(
|
|
447
|
-
'Holder of the card associated with the [credential](https://
|
|
447
|
+
'Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
448
448
|
),
|
|
449
449
|
|
|
450
450
|
number_of_issued_cards: z
|
|
451
451
|
.number()
|
|
452
452
|
.optional()
|
|
453
453
|
.describe(
|
|
454
|
-
'Number of issued cards associated with the [credential](https://
|
|
454
|
+
'Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
455
455
|
),
|
|
456
456
|
|
|
457
457
|
guest_acs_entrance_ids: z
|
|
458
458
|
.array(z.string().uuid())
|
|
459
459
|
.optional()
|
|
460
460
|
.describe(
|
|
461
|
-
'IDs of the guest [entrances](https://
|
|
461
|
+
'IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
462
462
|
),
|
|
463
463
|
common_acs_entrance_ids: z
|
|
464
464
|
.array(z.string().uuid())
|
|
465
465
|
.optional()
|
|
466
466
|
.describe(
|
|
467
|
-
'IDs of the common [entrances](https://
|
|
467
|
+
'IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
468
468
|
),
|
|
469
469
|
})
|
|
470
470
|
.partial()
|
|
471
471
|
.optional()
|
|
472
472
|
.describe(
|
|
473
|
-
'Visionline-specific metadata for the [credential](https://
|
|
473
|
+
'Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).',
|
|
474
474
|
),
|
|
475
475
|
})
|
|
476
476
|
|
|
@@ -24,7 +24,7 @@ const acs_encoder_error = acs_encoder_removed.describe(`
|
|
|
24
24
|
---
|
|
25
25
|
resource_type: acs_encoder
|
|
26
26
|
---
|
|
27
|
-
Error associated with the [encoder](https://
|
|
27
|
+
Error associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
28
28
|
`)
|
|
29
29
|
|
|
30
30
|
const _acs_encoder_error_map = z.object({
|
|
@@ -38,44 +38,44 @@ export const acs_encoder = z.object({
|
|
|
38
38
|
.string()
|
|
39
39
|
.uuid()
|
|
40
40
|
.describe(
|
|
41
|
-
'ID of the [encoder](https://
|
|
41
|
+
'ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
42
42
|
),
|
|
43
43
|
acs_system_id: z
|
|
44
44
|
.string()
|
|
45
45
|
.uuid()
|
|
46
46
|
.describe(
|
|
47
|
-
'ID of the [access control system](https://
|
|
47
|
+
'ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
48
48
|
),
|
|
49
49
|
connected_account_id: z
|
|
50
50
|
.string()
|
|
51
51
|
.uuid()
|
|
52
52
|
.describe(
|
|
53
|
-
'ID of the connected account that contains the [encoder](https://
|
|
53
|
+
'ID of the connected account that contains the [encoder](https://www.seam.co/docs/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 workspace that contains the [encoder](https://
|
|
59
|
+
'ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
60
60
|
),
|
|
61
61
|
errors: z
|
|
62
62
|
.array(acs_encoder_error)
|
|
63
63
|
.describe(
|
|
64
|
-
'Errors associated with the [encoder](https://
|
|
64
|
+
'Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
65
65
|
),
|
|
66
66
|
created_at: datetime.describe(
|
|
67
|
-
'Date and time at which the [encoder](https://
|
|
67
|
+
'Date and time at which the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.',
|
|
68
68
|
),
|
|
69
69
|
display_name: z
|
|
70
70
|
.string()
|
|
71
71
|
.describe(
|
|
72
|
-
'Display name for the [encoder](https://
|
|
72
|
+
'Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
73
73
|
),
|
|
74
74
|
}).describe(`
|
|
75
75
|
---
|
|
76
76
|
route_path: /acs/encoders
|
|
77
77
|
---
|
|
78
|
-
Represents a hardware device that encodes [credential](https://
|
|
78
|
+
Represents a hardware device that encodes [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
79
79
|
|
|
80
80
|
Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
|
|
81
81
|
|
|
@@ -86,9 +86,9 @@ export const acs_encoder = z.object({
|
|
|
86
86
|
|
|
87
87
|
Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
|
|
88
88
|
|
|
89
|
-
See [Working with Card Encoders and Scanners](https://
|
|
89
|
+
See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
90
90
|
|
|
91
|
-
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://
|
|
91
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
92
92
|
`)
|
|
93
93
|
|
|
94
94
|
export type AcsEncoder = z.infer<typeof acs_encoder>
|
|
@@ -88,7 +88,7 @@ const acs_entrance_warning = z
|
|
|
88
88
|
privacy_mode,
|
|
89
89
|
])
|
|
90
90
|
.describe(
|
|
91
|
-
'Warning associated with the [entrance](https://
|
|
91
|
+
'Warning associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
92
92
|
)
|
|
93
93
|
|
|
94
94
|
const _acs_entrance_warning_map = z.object({
|
|
@@ -141,30 +141,30 @@ export const acs_entrance = z
|
|
|
141
141
|
.string()
|
|
142
142
|
.uuid()
|
|
143
143
|
.describe(
|
|
144
|
-
'ID of the [access control system](https://
|
|
144
|
+
'ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
145
145
|
),
|
|
146
146
|
acs_entrance_id: z
|
|
147
147
|
.string()
|
|
148
148
|
.uuid()
|
|
149
149
|
.describe(
|
|
150
|
-
'ID of the [entrance](https://
|
|
150
|
+
'ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
151
151
|
),
|
|
152
152
|
space_ids: z
|
|
153
153
|
.array(z.string().uuid())
|
|
154
154
|
.describe('IDs of the spaces that the entrance is in.'),
|
|
155
155
|
created_at: datetime.describe(
|
|
156
|
-
'Date and time at which the [entrance](https://
|
|
156
|
+
'Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created.',
|
|
157
157
|
),
|
|
158
158
|
display_name: z
|
|
159
159
|
.string()
|
|
160
160
|
.describe(
|
|
161
|
-
'Display name for the [entrance](https://
|
|
161
|
+
'Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
162
162
|
),
|
|
163
163
|
connected_account_id: z
|
|
164
164
|
.string()
|
|
165
165
|
.uuid()
|
|
166
166
|
.describe(
|
|
167
|
-
'ID of the [connected account](https://
|
|
167
|
+
'ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
168
168
|
),
|
|
169
169
|
errors: z
|
|
170
170
|
.array(
|
|
@@ -185,80 +185,80 @@ export const acs_entrance = z
|
|
|
185
185
|
}),
|
|
186
186
|
)
|
|
187
187
|
.describe(
|
|
188
|
-
'Errors associated with the [entrance](https://
|
|
188
|
+
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
189
189
|
),
|
|
190
190
|
warnings: z
|
|
191
191
|
.array(acs_entrance_warning)
|
|
192
192
|
.describe(
|
|
193
|
-
'Warnings associated with the [entrance](https://
|
|
193
|
+
'Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
194
194
|
),
|
|
195
195
|
latch_metadata: acs_entrance_latch_metadata
|
|
196
196
|
.optional()
|
|
197
197
|
.describe(
|
|
198
|
-
'Latch-specific metadata associated with the [entrance](https://
|
|
198
|
+
'Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
199
199
|
),
|
|
200
200
|
hotek_metadata: acs_entrance_hotek_metadata
|
|
201
201
|
.optional()
|
|
202
202
|
.describe(
|
|
203
|
-
'Hotek-specific metadata associated with the [entrance](https://
|
|
203
|
+
'Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
204
204
|
),
|
|
205
205
|
visionline_metadata: acs_entrance_visionline_metadata
|
|
206
206
|
.optional()
|
|
207
207
|
.describe(
|
|
208
|
-
'Visionline-specific metadata associated with the [entrance](https://
|
|
208
|
+
'Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
209
209
|
),
|
|
210
210
|
salto_ks_metadata: acs_entrance_salto_ks_metadata
|
|
211
211
|
.optional()
|
|
212
212
|
.describe(
|
|
213
|
-
'Salto KS-specific metadata associated with the [entrance](https://
|
|
213
|
+
'Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
214
214
|
),
|
|
215
215
|
dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata
|
|
216
216
|
.optional()
|
|
217
217
|
.describe(
|
|
218
|
-
'dormakaba Community-specific metadata associated with the [entrance](https://
|
|
218
|
+
'dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
219
219
|
),
|
|
220
220
|
assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata
|
|
221
221
|
.optional()
|
|
222
222
|
.describe(
|
|
223
|
-
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://
|
|
223
|
+
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
224
224
|
),
|
|
225
225
|
salto_space_metadata: acs_entrance_salto_space_metadata
|
|
226
226
|
.optional()
|
|
227
227
|
.describe(
|
|
228
|
-
'Salto Space-specific metadata associated with the [entrance](https://
|
|
228
|
+
'Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
229
229
|
),
|
|
230
230
|
dormakaba_ambiance_metadata: acs_entrance_dormakaba_ambiance_metadata
|
|
231
231
|
.optional()
|
|
232
232
|
.describe(
|
|
233
|
-
'dormakaba Ambiance-specific metadata associated with the [entrance](https://
|
|
233
|
+
'dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
234
234
|
),
|
|
235
235
|
brivo_metadata: acs_entrance_brivo_metadata
|
|
236
236
|
.optional()
|
|
237
237
|
.describe(
|
|
238
|
-
'Brivo-specific metadata associated with the [entrance](https://
|
|
238
|
+
'Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
239
239
|
),
|
|
240
240
|
avigilon_alta_metadata: acs_entrance_avigilon_alta_metadata
|
|
241
241
|
.optional()
|
|
242
242
|
.describe(
|
|
243
|
-
'Avigilon Alta-specific metadata associated with the [entrance](https://
|
|
243
|
+
'Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
244
244
|
),
|
|
245
245
|
akiles_metadata: acs_entrance_akiles_metadata
|
|
246
246
|
.optional()
|
|
247
247
|
.describe(
|
|
248
|
-
'Akiles-specific metadata associated with the [entrance](https://
|
|
248
|
+
'Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
249
249
|
),
|
|
250
250
|
is_locked: z
|
|
251
251
|
.boolean()
|
|
252
252
|
.optional()
|
|
253
253
|
.describe(
|
|
254
|
-
'Indicates whether the [entrance](https://
|
|
254
|
+
'Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.',
|
|
255
255
|
),
|
|
256
256
|
})
|
|
257
257
|
.merge(acs_entrance_capability_flags).describe(`
|
|
258
258
|
---
|
|
259
259
|
route_path: /acs/entrances
|
|
260
260
|
---
|
|
261
|
-
Represents an [entrance](https://
|
|
261
|
+
Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
262
262
|
|
|
263
263
|
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the \`acs_entrance\` resources in your workspace or get these details for a specific \`acs_entrance\`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
|
|
264
264
|
`)
|