@seamapi/http 2.31.0 → 2.32.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/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +5 -5
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +12 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +9 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +5 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a smart lock [access code](https://
|
|
2
|
+
* Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
3
3
|
*
|
|
4
4
|
* An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
5
5
|
*
|
|
6
|
-
* Seam supports programming two types of access codes: [ongoing](https://
|
|
6
|
+
* Seam supports programming two types of access codes: [ongoing](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
7
7
|
*
|
|
8
|
-
* In addition, for certain devices, Seam also supports [offline access codes](https://
|
|
8
|
+
* In addition, for certain devices, Seam also supports [offline access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
9
9
|
*
|
|
10
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
10
|
+
* 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 and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
11
11
|
*/
|
|
12
12
|
export type AccessCode = {
|
|
13
13
|
/**
|
|
@@ -76,7 +76,7 @@ export type AccessCode = {
|
|
|
76
76
|
*/
|
|
77
77
|
ends_at?: string | null | undefined;
|
|
78
78
|
/**
|
|
79
|
-
* Errors associated with the [access code](https://
|
|
79
|
+
* Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
80
80
|
*/
|
|
81
81
|
errors: Array<
|
|
82
82
|
/**
|
|
@@ -309,7 +309,7 @@ export type AccessCode = {
|
|
|
309
309
|
/**
|
|
310
310
|
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
311
311
|
*/
|
|
312
|
-
error_code: '
|
|
312
|
+
error_code: 'failed_to_remove';
|
|
313
313
|
/**
|
|
314
314
|
* Indicates that this is an access code error.
|
|
315
315
|
*/
|
|
@@ -330,7 +330,7 @@ export type AccessCode = {
|
|
|
330
330
|
*/
|
|
331
331
|
error_code: 'account_disconnected';
|
|
332
332
|
/**
|
|
333
|
-
* Indicates that the error is a [connected account](https://
|
|
333
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
334
334
|
*/
|
|
335
335
|
is_connected_account_error: true;
|
|
336
336
|
/**
|
|
@@ -353,7 +353,7 @@ export type AccessCode = {
|
|
|
353
353
|
*/
|
|
354
354
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
355
355
|
/**
|
|
356
|
-
* Indicates that the error is a [connected account](https://
|
|
356
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
357
357
|
*/
|
|
358
358
|
is_connected_account_error: true;
|
|
359
359
|
/**
|
|
@@ -376,7 +376,7 @@ export type AccessCode = {
|
|
|
376
376
|
*/
|
|
377
377
|
error_code: 'insufficient_permissions';
|
|
378
378
|
/**
|
|
379
|
-
* Indicates that the error is a [connected account](https://
|
|
379
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
380
380
|
*/
|
|
381
381
|
is_connected_account_error: true;
|
|
382
382
|
/**
|
|
@@ -399,7 +399,7 @@ export type AccessCode = {
|
|
|
399
399
|
*/
|
|
400
400
|
error_code: 'dormakaba_sites_disconnected';
|
|
401
401
|
/**
|
|
402
|
-
* Indicates that the error is a [connected account](https://
|
|
402
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
403
403
|
*/
|
|
404
404
|
is_connected_account_error: true;
|
|
405
405
|
/**
|
|
@@ -487,7 +487,7 @@ export type AccessCode = {
|
|
|
487
487
|
*/
|
|
488
488
|
message: string;
|
|
489
489
|
} /**
|
|
490
|
-
* Indicates that the [backup access code pool](https://
|
|
490
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
491
491
|
*/ | {
|
|
492
492
|
/**
|
|
493
493
|
* Date and time at which Seam created the error.
|
|
@@ -582,7 +582,7 @@ export type AccessCode = {
|
|
|
582
582
|
*/
|
|
583
583
|
message: string;
|
|
584
584
|
} /**
|
|
585
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
585
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
586
586
|
*/ | {
|
|
587
587
|
/**
|
|
588
588
|
* Date and time at which Seam created the error.
|
|
@@ -593,7 +593,7 @@ export type AccessCode = {
|
|
|
593
593
|
*/
|
|
594
594
|
error_code: 'bridge_disconnected';
|
|
595
595
|
/**
|
|
596
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
596
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
597
597
|
*/
|
|
598
598
|
is_bridge_error?: boolean | undefined;
|
|
599
599
|
/**
|
|
@@ -812,7 +812,7 @@ export type AccessCode = {
|
|
|
812
812
|
*/
|
|
813
813
|
starts_at?: string | null | undefined;
|
|
814
814
|
/**
|
|
815
|
-
* Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://
|
|
815
|
+
* Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
|
|
816
816
|
* @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.
|
|
817
817
|
*/
|
|
818
818
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
@@ -821,7 +821,7 @@ export type AccessCode = {
|
|
|
821
821
|
*/
|
|
822
822
|
type: 'time_bound' | 'ongoing';
|
|
823
823
|
/**
|
|
824
|
-
* Warnings associated with the [access code](https://
|
|
824
|
+
* Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
825
825
|
*/
|
|
826
826
|
warnings: Array<
|
|
827
827
|
/**
|
|
@@ -39,7 +39,7 @@ export type AccessGrant = {
|
|
|
39
39
|
*/
|
|
40
40
|
ends_at: string | null;
|
|
41
41
|
/**
|
|
42
|
-
* Errors associated with the [access grant](https://
|
|
42
|
+
* Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
43
43
|
*/
|
|
44
44
|
errors: Array<
|
|
45
45
|
/**
|
|
@@ -209,11 +209,11 @@ export type AccessGrant = {
|
|
|
209
209
|
*/
|
|
210
210
|
user_identity_id: string;
|
|
211
211
|
/**
|
|
212
|
-
* Warnings associated with the [access grant](https://
|
|
212
|
+
* Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
213
213
|
*/
|
|
214
214
|
warnings: Array<
|
|
215
215
|
/**
|
|
216
|
-
* Indicates that the [access grant](https://
|
|
216
|
+
* Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.
|
|
217
217
|
*/
|
|
218
218
|
{
|
|
219
219
|
/**
|
|
@@ -276,7 +276,7 @@ export type AccessGrant = {
|
|
|
276
276
|
*/
|
|
277
277
|
warning_code: 'overprovisioned_access';
|
|
278
278
|
} /**
|
|
279
|
-
* Indicates that the access times for this [access grant](https://
|
|
279
|
+
* Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.
|
|
280
280
|
*/ | {
|
|
281
281
|
/**
|
|
282
282
|
* IDs of the access methods being updated.
|
|
@@ -31,11 +31,11 @@ export type AccessMethod = {
|
|
|
31
31
|
*/
|
|
32
32
|
display_status: string;
|
|
33
33
|
/**
|
|
34
|
-
* Errors associated with the [access method](https://
|
|
34
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
35
35
|
*/
|
|
36
36
|
errors: Array<
|
|
37
37
|
/**
|
|
38
|
-
* Indicates that Seam was unable to issue this [access method](https://
|
|
38
|
+
* Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
|
|
39
39
|
*/
|
|
40
40
|
{
|
|
41
41
|
/**
|
|
@@ -84,7 +84,7 @@ export type AccessMethod = {
|
|
|
84
84
|
*/
|
|
85
85
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
86
86
|
/**
|
|
87
|
-
* Pending mutations for the [access method](https://
|
|
87
|
+
* Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
|
|
88
88
|
*/
|
|
89
89
|
pending_mutations: Array<
|
|
90
90
|
/**
|
|
@@ -197,11 +197,11 @@ export type AccessMethod = {
|
|
|
197
197
|
};
|
|
198
198
|
}>;
|
|
199
199
|
/**
|
|
200
|
-
* Warnings associated with the [access method](https://
|
|
200
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
201
201
|
*/
|
|
202
202
|
warnings: Array<
|
|
203
203
|
/**
|
|
204
|
-
* Indicates that the [access method](https://
|
|
204
|
+
* Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.
|
|
205
205
|
*/
|
|
206
206
|
{
|
|
207
207
|
/**
|
|
@@ -217,7 +217,7 @@ export type AccessMethod = {
|
|
|
217
217
|
*/
|
|
218
218
|
warning_code: 'being_deleted';
|
|
219
219
|
} /**
|
|
220
|
-
* Indicates that the access times for this [access method](https://
|
|
220
|
+
* Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated.
|
|
221
221
|
*/ | {
|
|
222
222
|
/**
|
|
223
223
|
* Date and time at which Seam created the warning.
|
|
@@ -251,7 +251,7 @@ export type AccessMethod = {
|
|
|
251
251
|
*/
|
|
252
252
|
warning_code: 'pulled_backup_access_code';
|
|
253
253
|
} /**
|
|
254
|
-
* Indicates that Seam has not yet issued this [access method](https://
|
|
254
|
+
* Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
255
255
|
*/ | {
|
|
256
256
|
/**
|
|
257
257
|
* Date and time at which Seam created the warning.
|
|
@@ -266,7 +266,7 @@ export type AccessMethod = {
|
|
|
266
266
|
*/
|
|
267
267
|
warning_code: 'delay_in_issuing';
|
|
268
268
|
} /**
|
|
269
|
-
* Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://
|
|
269
|
+
* Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.
|
|
270
270
|
*/ | {
|
|
271
271
|
/**
|
|
272
272
|
* Date and time at which Seam created the warning.
|
|
@@ -281,7 +281,7 @@ export type AccessMethod = {
|
|
|
281
281
|
*/
|
|
282
282
|
warning_code: 'user_identity_missing_email_address';
|
|
283
283
|
} /**
|
|
284
|
-
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://
|
|
284
|
+
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.
|
|
285
285
|
*/ | {
|
|
286
286
|
/**
|
|
287
287
|
* Date and time at which Seam created the warning.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
3
3
|
*
|
|
4
|
-
* Some access control systems use [access group](https://
|
|
4
|
+
* Some access control systems use [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
5
5
|
*
|
|
6
|
-
* To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://
|
|
6
|
+
* To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
7
7
|
*/
|
|
8
8
|
export type AcsAccessGroup = {
|
|
9
9
|
/**
|
|
@@ -52,7 +52,7 @@ export type AcsAccessGroup = {
|
|
|
52
52
|
*/
|
|
53
53
|
errors: Array<
|
|
54
54
|
/**
|
|
55
|
-
* Indicates that the [access group](https://
|
|
55
|
+
* Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
56
56
|
*/
|
|
57
57
|
{
|
|
58
58
|
/**
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Means by which an [access control system user](https://
|
|
2
|
+
* 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).
|
|
3
3
|
*
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
8
|
+
* 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.
|
|
9
9
|
*/
|
|
10
10
|
export type AcsCredential = {
|
|
11
11
|
/**
|
|
12
|
-
* Access method for the [credential](https://
|
|
12
|
+
* 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`.
|
|
13
13
|
*/
|
|
14
14
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
15
15
|
/**
|
|
16
|
-
* ID of the [credential](https://
|
|
16
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
17
17
|
*/
|
|
18
18
|
acs_credential_id: string;
|
|
19
19
|
/**
|
|
@@ -21,15 +21,15 @@ export type AcsCredential = {
|
|
|
21
21
|
*/
|
|
22
22
|
acs_credential_pool_id?: string | undefined;
|
|
23
23
|
/**
|
|
24
|
-
* ID of the [access control system](https://
|
|
24
|
+
* 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).
|
|
25
25
|
*/
|
|
26
26
|
acs_system_id: string;
|
|
27
27
|
/**
|
|
28
|
-
* ID of the [ACS user](https://
|
|
28
|
+
* 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.
|
|
29
29
|
*/
|
|
30
30
|
acs_user_id?: string | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* Akiles-specific metadata for the [credential](https://
|
|
32
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
33
33
|
*/
|
|
34
34
|
akiles_metadata?: {
|
|
35
35
|
/**
|
|
@@ -38,7 +38,7 @@ export type AcsCredential = {
|
|
|
38
38
|
member_pin_id?: string | undefined;
|
|
39
39
|
} | undefined;
|
|
40
40
|
/**
|
|
41
|
-
* Vostio-specific metadata for the [credential](https://
|
|
41
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
42
42
|
*/
|
|
43
43
|
assa_abloy_vostio_metadata?: {
|
|
44
44
|
/**
|
|
@@ -67,31 +67,31 @@ export type AcsCredential = {
|
|
|
67
67
|
override_guest_acs_entrance_ids?: Array<string> | undefined;
|
|
68
68
|
} | undefined;
|
|
69
69
|
/**
|
|
70
|
-
* Number of the card associated with the [credential](https://
|
|
70
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
71
71
|
*/
|
|
72
72
|
card_number?: string | null | undefined;
|
|
73
73
|
/**
|
|
74
|
-
* Access (PIN) code for the [credential](https://
|
|
74
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
75
75
|
*/
|
|
76
76
|
code?: string | null | undefined;
|
|
77
77
|
/**
|
|
78
|
-
* ID of the [connected account](https://
|
|
78
|
+
* 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.
|
|
79
79
|
*/
|
|
80
80
|
connected_account_id: string;
|
|
81
81
|
/**
|
|
82
|
-
* Date and time at which the [credential](https://
|
|
82
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
83
83
|
*/
|
|
84
84
|
created_at: string;
|
|
85
85
|
/**
|
|
86
|
-
* Display name that corresponds to the [credential](https://
|
|
86
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
87
87
|
*/
|
|
88
88
|
display_name: string;
|
|
89
89
|
/**
|
|
90
|
-
* Date and time at which the [credential](https://
|
|
90
|
+
* 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`.
|
|
91
91
|
*/
|
|
92
92
|
ends_at?: string | undefined;
|
|
93
93
|
/**
|
|
94
|
-
* Errors associated with the [credential](https://
|
|
94
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
95
95
|
*/
|
|
96
96
|
errors: Array<{
|
|
97
97
|
/**
|
|
@@ -102,19 +102,19 @@ export type AcsCredential = {
|
|
|
102
102
|
message: string;
|
|
103
103
|
}>;
|
|
104
104
|
/**
|
|
105
|
-
* Brand-specific terminology for the [credential](https://
|
|
105
|
+
* 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`.
|
|
106
106
|
*/
|
|
107
107
|
external_type?: 'pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential' | undefined;
|
|
108
108
|
/**
|
|
109
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
109
|
+
* 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.
|
|
110
110
|
*/
|
|
111
111
|
external_type_display_name?: string | undefined;
|
|
112
112
|
/**
|
|
113
|
-
* Indicates whether the [credential](https://
|
|
113
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
114
114
|
*/
|
|
115
115
|
is_issued?: boolean | undefined;
|
|
116
116
|
/**
|
|
117
|
-
* Indicates whether the latest state of the [credential](https://
|
|
117
|
+
* 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.
|
|
118
118
|
*/
|
|
119
119
|
is_latest_desired_state_synced_with_provider?: boolean | null | undefined;
|
|
120
120
|
/**
|
|
@@ -122,35 +122,35 @@ export type AcsCredential = {
|
|
|
122
122
|
*/
|
|
123
123
|
is_managed: true;
|
|
124
124
|
/**
|
|
125
|
-
* Indicates whether the [credential](https://
|
|
125
|
+
* 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).
|
|
126
126
|
*/
|
|
127
127
|
is_multi_phone_sync_credential?: boolean | undefined;
|
|
128
128
|
/**
|
|
129
|
-
* Indicates whether the [credential](https://
|
|
129
|
+
* 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.
|
|
130
130
|
*/
|
|
131
131
|
is_one_time_use?: boolean | undefined;
|
|
132
132
|
/**
|
|
133
|
-
* Date and time at which the [credential](https://
|
|
133
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
134
134
|
*/
|
|
135
135
|
issued_at?: string | null | undefined;
|
|
136
136
|
/**
|
|
137
|
-
* Date and time at which the state of the [credential](https://
|
|
137
|
+
* 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.
|
|
138
138
|
*/
|
|
139
139
|
latest_desired_state_synced_with_provider_at?: string | null | undefined;
|
|
140
140
|
/**
|
|
141
|
-
* ID of the parent [credential](https://
|
|
141
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
142
142
|
*/
|
|
143
143
|
parent_acs_credential_id?: string | undefined;
|
|
144
144
|
/**
|
|
145
|
-
* Date and time at which the [credential](https://
|
|
145
|
+
* 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.
|
|
146
146
|
*/
|
|
147
147
|
starts_at?: string | undefined;
|
|
148
148
|
/**
|
|
149
|
-
* ID of the [user identity](https://
|
|
149
|
+
* 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.
|
|
150
150
|
*/
|
|
151
151
|
user_identity_id?: string | undefined;
|
|
152
152
|
/**
|
|
153
|
-
* Visionline-specific metadata for the [credential](https://
|
|
153
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
154
154
|
*/
|
|
155
155
|
visionline_metadata?: {
|
|
156
156
|
/**
|
|
@@ -187,11 +187,11 @@ export type AcsCredential = {
|
|
|
187
187
|
joiner_acs_credential_ids?: Array<string> | undefined;
|
|
188
188
|
} | undefined;
|
|
189
189
|
/**
|
|
190
|
-
* Warnings associated with the [credential](https://
|
|
190
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
191
191
|
*/
|
|
192
192
|
warnings: Array<
|
|
193
193
|
/**
|
|
194
|
-
* Indicates that the [credential](https://
|
|
194
|
+
* Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued.
|
|
195
195
|
*/
|
|
196
196
|
{
|
|
197
197
|
/**
|
|
@@ -207,7 +207,7 @@ export type AcsCredential = {
|
|
|
207
207
|
*/
|
|
208
208
|
warning_code: 'waiting_to_be_issued';
|
|
209
209
|
} /**
|
|
210
|
-
* Indicates that the schedule of one of the [credential](https://
|
|
210
|
+
* 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.
|
|
211
211
|
*/ | {
|
|
212
212
|
/**
|
|
213
213
|
* Date and time at which Seam created the warning.
|
|
@@ -222,7 +222,7 @@ export type AcsCredential = {
|
|
|
222
222
|
*/
|
|
223
223
|
warning_code: 'schedule_externally_modified';
|
|
224
224
|
} /**
|
|
225
|
-
* Indicates that the schedule of the [credential](https://
|
|
225
|
+
* 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.
|
|
226
226
|
*/ | {
|
|
227
227
|
/**
|
|
228
228
|
* Date and time at which Seam created the warning.
|
|
@@ -237,7 +237,7 @@ export type AcsCredential = {
|
|
|
237
237
|
*/
|
|
238
238
|
warning_code: 'schedule_modified';
|
|
239
239
|
} /**
|
|
240
|
-
* Indicates that the [credential](https://
|
|
240
|
+
* Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted.
|
|
241
241
|
*/ | {
|
|
242
242
|
/**
|
|
243
243
|
* Date and time at which Seam created the warning.
|
|
@@ -252,7 +252,7 @@ export type AcsCredential = {
|
|
|
252
252
|
*/
|
|
253
253
|
warning_code: 'being_deleted';
|
|
254
254
|
} /**
|
|
255
|
-
* An unknown issue occurred while syncing the state of the [credential](https://
|
|
255
|
+
* 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.
|
|
256
256
|
*/ | {
|
|
257
257
|
/**
|
|
258
258
|
* Date and time at which Seam created the warning.
|
|
@@ -267,7 +267,7 @@ export type AcsCredential = {
|
|
|
267
267
|
*/
|
|
268
268
|
warning_code: 'unknown_issue_with_acs_credential';
|
|
269
269
|
} /**
|
|
270
|
-
* Access permissions for the [credential](https://
|
|
270
|
+
* 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.
|
|
271
271
|
*/ | {
|
|
272
272
|
/**
|
|
273
273
|
* Date and time at which Seam created the warning.
|
|
@@ -306,7 +306,7 @@ export type AcsCredential = {
|
|
|
306
306
|
warning_code: 'requested_code_unavailable';
|
|
307
307
|
}>;
|
|
308
308
|
/**
|
|
309
|
-
* ID of the workspace that contains the [credential](https://
|
|
309
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
310
310
|
*/
|
|
311
311
|
workspace_id: string;
|
|
312
312
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a hardware device that encodes [credential](https://
|
|
2
|
+
* 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).
|
|
3
3
|
*
|
|
4
4
|
* 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:
|
|
5
5
|
*
|
|
@@ -10,33 +10,33 @@
|
|
|
10
10
|
*
|
|
11
11
|
* 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.
|
|
12
12
|
*
|
|
13
|
-
* See [Working with Card Encoders and Scanners](https://
|
|
13
|
+
* See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
14
14
|
*
|
|
15
|
-
* To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://
|
|
15
|
+
* 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).
|
|
16
16
|
*/
|
|
17
17
|
export type AcsEncoder = {
|
|
18
18
|
/**
|
|
19
|
-
* ID of the [encoder](https://
|
|
19
|
+
* ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
20
20
|
*/
|
|
21
21
|
acs_encoder_id: string;
|
|
22
22
|
/**
|
|
23
|
-
* ID of the [access control system](https://
|
|
23
|
+
* 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).
|
|
24
24
|
*/
|
|
25
25
|
acs_system_id: string;
|
|
26
26
|
/**
|
|
27
|
-
* ID of the connected account that contains the [encoder](https://
|
|
27
|
+
* 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).
|
|
28
28
|
*/
|
|
29
29
|
connected_account_id: string;
|
|
30
30
|
/**
|
|
31
|
-
* Date and time at which the [encoder](https://
|
|
31
|
+
* 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.
|
|
32
32
|
*/
|
|
33
33
|
created_at: string;
|
|
34
34
|
/**
|
|
35
|
-
* Display name for the [encoder](https://
|
|
35
|
+
* Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
36
36
|
*/
|
|
37
37
|
display_name: string;
|
|
38
38
|
/**
|
|
39
|
-
* Errors associated with the [encoder](https://
|
|
39
|
+
* Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
40
40
|
*/
|
|
41
41
|
errors: Array<{
|
|
42
42
|
/**
|
|
@@ -53,7 +53,7 @@ export type AcsEncoder = {
|
|
|
53
53
|
message: string;
|
|
54
54
|
}>;
|
|
55
55
|
/**
|
|
56
|
-
* ID of the workspace that contains the [encoder](https://
|
|
56
|
+
* ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
57
57
|
*/
|
|
58
58
|
workspace_id: string;
|
|
59
59
|
};
|