@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
|
@@ -84,7 +84,7 @@ export class SeamHttpWorkspaces {
|
|
|
84
84
|
await clientSessions.get();
|
|
85
85
|
}
|
|
86
86
|
/**
|
|
87
|
-
* Creates a new [workspace](https://
|
|
87
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
88
88
|
*/
|
|
89
89
|
create(parameters, options = {}) {
|
|
90
90
|
return new SeamHttpRequest(this, {
|
|
@@ -100,7 +100,7 @@ export class SeamHttpWorkspaces {
|
|
|
100
100
|
});
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
|
-
* Returns the [workspace](https://
|
|
103
|
+
* Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
104
104
|
*/
|
|
105
105
|
get(parameters, options = {}) {
|
|
106
106
|
return new SeamHttpRequest(this, {
|
|
@@ -116,7 +116,7 @@ export class SeamHttpWorkspaces {
|
|
|
116
116
|
});
|
|
117
117
|
}
|
|
118
118
|
/**
|
|
119
|
-
* Returns a list of [workspaces](https://
|
|
119
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
120
120
|
*/
|
|
121
121
|
list(parameters, options = {}) {
|
|
122
122
|
return new SeamHttpRequest(this, {
|
|
@@ -132,7 +132,7 @@ export class SeamHttpWorkspaces {
|
|
|
132
132
|
});
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* Resets the [sandbox workspace](https://
|
|
135
|
+
* Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
|
|
136
136
|
*/
|
|
137
137
|
resetSandbox(parameters, options = {}) {
|
|
138
138
|
return new SeamHttpRequest(this, {
|
|
@@ -152,7 +152,7 @@ export class SeamHttpWorkspaces {
|
|
|
152
152
|
});
|
|
153
153
|
}
|
|
154
154
|
/**
|
|
155
|
-
* Updates the [workspace](https://
|
|
155
|
+
* Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
156
156
|
*/
|
|
157
157
|
update(parameters, options = {}) {
|
|
158
158
|
return new SeamHttpRequest(this, {
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.32.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.32.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"@seamapi/blueprint": "^1.10.0",
|
|
89
89
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
90
90
|
"@seamapi/smith": "^1.1.0",
|
|
91
|
-
"@seamapi/types": "1.
|
|
91
|
+
"@seamapi/types": "1.1078.1",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a smart lock [access code](https://
|
|
7
|
+
* Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
8
8
|
*
|
|
9
9
|
* 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.
|
|
10
10
|
*
|
|
11
|
-
* Seam supports programming two types of access codes: [ongoing](https://
|
|
11
|
+
* 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.
|
|
12
12
|
*
|
|
13
|
-
* In addition, for certain devices, Seam also supports [offline access codes](https://
|
|
13
|
+
* 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.
|
|
14
14
|
*
|
|
15
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
15
|
+
* 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.
|
|
16
16
|
*/
|
|
17
17
|
export type AccessCode = {
|
|
18
18
|
/**
|
|
@@ -88,7 +88,7 @@ export type AccessCode = {
|
|
|
88
88
|
*/
|
|
89
89
|
ends_at?: string | null | undefined
|
|
90
90
|
/**
|
|
91
|
-
* Errors associated with the [access code](https://
|
|
91
|
+
* Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
92
92
|
*/
|
|
93
93
|
errors: Array<
|
|
94
94
|
/**
|
|
@@ -356,7 +356,7 @@ export type AccessCode = {
|
|
|
356
356
|
/**
|
|
357
357
|
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
358
358
|
*/
|
|
359
|
-
error_code: '
|
|
359
|
+
error_code: 'failed_to_remove'
|
|
360
360
|
|
|
361
361
|
/**
|
|
362
362
|
* Indicates that this is an access code error.
|
|
@@ -382,7 +382,7 @@ export type AccessCode = {
|
|
|
382
382
|
error_code: 'account_disconnected'
|
|
383
383
|
|
|
384
384
|
/**
|
|
385
|
-
* Indicates that the error is a [connected account](https://
|
|
385
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
386
386
|
*/
|
|
387
387
|
is_connected_account_error: true
|
|
388
388
|
|
|
@@ -410,7 +410,7 @@ export type AccessCode = {
|
|
|
410
410
|
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
411
411
|
|
|
412
412
|
/**
|
|
413
|
-
* Indicates that the error is a [connected account](https://
|
|
413
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
414
414
|
*/
|
|
415
415
|
is_connected_account_error: true
|
|
416
416
|
|
|
@@ -438,7 +438,7 @@ export type AccessCode = {
|
|
|
438
438
|
error_code: 'insufficient_permissions'
|
|
439
439
|
|
|
440
440
|
/**
|
|
441
|
-
* Indicates that the error is a [connected account](https://
|
|
441
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
442
442
|
*/
|
|
443
443
|
is_connected_account_error: true
|
|
444
444
|
|
|
@@ -466,7 +466,7 @@ export type AccessCode = {
|
|
|
466
466
|
error_code: 'dormakaba_sites_disconnected'
|
|
467
467
|
|
|
468
468
|
/**
|
|
469
|
-
* Indicates that the error is a [connected account](https://
|
|
469
|
+
* Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
470
470
|
*/
|
|
471
471
|
is_connected_account_error: true
|
|
472
472
|
|
|
@@ -572,7 +572,7 @@ export type AccessCode = {
|
|
|
572
572
|
*/
|
|
573
573
|
message: string
|
|
574
574
|
} /**
|
|
575
|
-
* Indicates that the [backup access code pool](https://
|
|
575
|
+
* Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
576
576
|
*/
|
|
577
577
|
| {
|
|
578
578
|
/**
|
|
@@ -687,7 +687,7 @@ export type AccessCode = {
|
|
|
687
687
|
*/
|
|
688
688
|
message: string
|
|
689
689
|
} /**
|
|
690
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
690
|
+
* 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).
|
|
691
691
|
*/
|
|
692
692
|
| {
|
|
693
693
|
/**
|
|
@@ -701,7 +701,7 @@ export type AccessCode = {
|
|
|
701
701
|
error_code: 'bridge_disconnected'
|
|
702
702
|
|
|
703
703
|
/**
|
|
704
|
-
* Indicates whether the error is related to [Seam Bridge](https://
|
|
704
|
+
* Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
705
705
|
*/
|
|
706
706
|
is_bridge_error?: boolean | undefined
|
|
707
707
|
/**
|
|
@@ -953,7 +953,7 @@ export type AccessCode = {
|
|
|
953
953
|
*/
|
|
954
954
|
starts_at?: string | null | undefined
|
|
955
955
|
/**
|
|
956
|
-
* 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://
|
|
956
|
+
* 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).
|
|
957
957
|
* @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`.
|
|
958
958
|
*/
|
|
959
959
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
@@ -964,7 +964,7 @@ export type AccessCode = {
|
|
|
964
964
|
type: 'time_bound' | 'ongoing'
|
|
965
965
|
|
|
966
966
|
/**
|
|
967
|
-
* Warnings associated with the [access code](https://
|
|
967
|
+
* Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
968
968
|
*/
|
|
969
969
|
warnings: Array<
|
|
970
970
|
/**
|
|
@@ -49,7 +49,7 @@ export type AccessGrant = {
|
|
|
49
49
|
*/
|
|
50
50
|
ends_at: string | null
|
|
51
51
|
/**
|
|
52
|
-
* Errors associated with the [access grant](https://
|
|
52
|
+
* Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
53
53
|
*/
|
|
54
54
|
errors: Array<
|
|
55
55
|
/**
|
|
@@ -244,11 +244,11 @@ export type AccessGrant = {
|
|
|
244
244
|
user_identity_id: string
|
|
245
245
|
|
|
246
246
|
/**
|
|
247
|
-
* Warnings associated with the [access grant](https://
|
|
247
|
+
* Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
|
|
248
248
|
*/
|
|
249
249
|
warnings: Array<
|
|
250
250
|
/**
|
|
251
|
-
* Indicates that the [access grant](https://
|
|
251
|
+
* Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.
|
|
252
252
|
*/
|
|
253
253
|
| {
|
|
254
254
|
/**
|
|
@@ -323,7 +323,7 @@ export type AccessGrant = {
|
|
|
323
323
|
*/
|
|
324
324
|
warning_code: 'overprovisioned_access'
|
|
325
325
|
} /**
|
|
326
|
-
* Indicates that the access times for this [access grant](https://
|
|
326
|
+
* Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.
|
|
327
327
|
*/
|
|
328
328
|
| {
|
|
329
329
|
/**
|
|
@@ -40,11 +40,11 @@ export type AccessMethod = {
|
|
|
40
40
|
display_status: string
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
|
-
* Errors associated with the [access method](https://
|
|
43
|
+
* Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
44
44
|
*/
|
|
45
45
|
errors: Array<
|
|
46
46
|
/**
|
|
47
|
-
* Indicates that Seam was unable to issue this [access method](https://
|
|
47
|
+
* 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.
|
|
48
48
|
*/
|
|
49
49
|
{
|
|
50
50
|
/**
|
|
@@ -99,7 +99,7 @@ export type AccessMethod = {
|
|
|
99
99
|
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
100
100
|
|
|
101
101
|
/**
|
|
102
|
-
* Pending mutations for the [access method](https://
|
|
102
|
+
* 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.
|
|
103
103
|
*/
|
|
104
104
|
pending_mutations: Array<
|
|
105
105
|
/**
|
|
@@ -228,11 +228,11 @@ export type AccessMethod = {
|
|
|
228
228
|
>
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
|
-
* Warnings associated with the [access method](https://
|
|
231
|
+
* Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
|
|
232
232
|
*/
|
|
233
233
|
warnings: Array<
|
|
234
234
|
/**
|
|
235
|
-
* Indicates that the [access method](https://
|
|
235
|
+
* Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.
|
|
236
236
|
*/
|
|
237
237
|
| {
|
|
238
238
|
/**
|
|
@@ -250,7 +250,7 @@ export type AccessMethod = {
|
|
|
250
250
|
*/
|
|
251
251
|
warning_code: 'being_deleted'
|
|
252
252
|
} /**
|
|
253
|
-
* Indicates that the access times for this [access method](https://
|
|
253
|
+
* 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.
|
|
254
254
|
*/
|
|
255
255
|
| {
|
|
256
256
|
/**
|
|
@@ -290,7 +290,7 @@ export type AccessMethod = {
|
|
|
290
290
|
*/
|
|
291
291
|
warning_code: 'pulled_backup_access_code'
|
|
292
292
|
} /**
|
|
293
|
-
* Indicates that Seam has not yet issued this [access method](https://
|
|
293
|
+
* 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.
|
|
294
294
|
*/
|
|
295
295
|
| {
|
|
296
296
|
/**
|
|
@@ -308,7 +308,7 @@ export type AccessMethod = {
|
|
|
308
308
|
*/
|
|
309
309
|
warning_code: 'delay_in_issuing'
|
|
310
310
|
} /**
|
|
311
|
-
* 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://
|
|
311
|
+
* 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.
|
|
312
312
|
*/
|
|
313
313
|
| {
|
|
314
314
|
/**
|
|
@@ -326,7 +326,7 @@ export type AccessMethod = {
|
|
|
326
326
|
*/
|
|
327
327
|
warning_code: 'user_identity_missing_email_address'
|
|
328
328
|
} /**
|
|
329
|
-
* Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://
|
|
329
|
+
* 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.
|
|
330
330
|
*/
|
|
331
331
|
| {
|
|
332
332
|
/**
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
/**
|
|
7
7
|
* 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.
|
|
8
8
|
*
|
|
9
|
-
* Some access control systems use [access group](https://
|
|
9
|
+
* 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.
|
|
10
10
|
*
|
|
11
|
-
* To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://
|
|
11
|
+
* 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).
|
|
12
12
|
*/
|
|
13
13
|
export type AcsAccessGroup = {
|
|
14
14
|
/**
|
|
@@ -76,7 +76,7 @@ export type AcsAccessGroup = {
|
|
|
76
76
|
*/
|
|
77
77
|
errors: Array<
|
|
78
78
|
/**
|
|
79
|
-
* Indicates that the [access group](https://
|
|
79
|
+
* 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).
|
|
80
80
|
*/
|
|
81
81
|
{
|
|
82
82
|
/**
|
|
@@ -4,22 +4,22 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Means by which an [access control system user](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*
|
|
9
9
|
* 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.
|
|
10
10
|
*
|
|
11
11
|
* 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.
|
|
12
12
|
*
|
|
13
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
13
|
+
* 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.
|
|
14
14
|
*/
|
|
15
15
|
export type AcsCredential = {
|
|
16
16
|
/**
|
|
17
|
-
* Access method for the [credential](https://
|
|
17
|
+
* 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`.
|
|
18
18
|
*/
|
|
19
19
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
* ID of the [credential](https://
|
|
22
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
23
23
|
*/
|
|
24
24
|
acs_credential_id: string
|
|
25
25
|
|
|
@@ -28,16 +28,16 @@ export type AcsCredential = {
|
|
|
28
28
|
*/
|
|
29
29
|
acs_credential_pool_id?: string | undefined
|
|
30
30
|
/**
|
|
31
|
-
* ID of the [access control system](https://
|
|
31
|
+
* 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).
|
|
32
32
|
*/
|
|
33
33
|
acs_system_id: string
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* ID of the [ACS user](https://
|
|
36
|
+
* 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.
|
|
37
37
|
*/
|
|
38
38
|
acs_user_id?: string | undefined
|
|
39
39
|
/**
|
|
40
|
-
* Akiles-specific metadata for the [credential](https://
|
|
40
|
+
* Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
41
41
|
*/
|
|
42
42
|
akiles_metadata?:
|
|
43
43
|
| {
|
|
@@ -48,7 +48,7 @@ export type AcsCredential = {
|
|
|
48
48
|
}
|
|
49
49
|
| undefined
|
|
50
50
|
/**
|
|
51
|
-
* Vostio-specific metadata for the [credential](https://
|
|
51
|
+
* Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
52
52
|
*/
|
|
53
53
|
assa_abloy_vostio_metadata?:
|
|
54
54
|
| {
|
|
@@ -79,34 +79,34 @@ export type AcsCredential = {
|
|
|
79
79
|
}
|
|
80
80
|
| undefined
|
|
81
81
|
/**
|
|
82
|
-
* Number of the card associated with the [credential](https://
|
|
82
|
+
* Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
83
83
|
*/
|
|
84
84
|
card_number?: string | null | undefined
|
|
85
85
|
/**
|
|
86
|
-
* Access (PIN) code for the [credential](https://
|
|
86
|
+
* Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
87
87
|
*/
|
|
88
88
|
code?: string | null | undefined
|
|
89
89
|
/**
|
|
90
|
-
* ID of the [connected account](https://
|
|
90
|
+
* 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.
|
|
91
91
|
*/
|
|
92
92
|
connected_account_id: string
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
|
-
* Date and time at which the [credential](https://
|
|
95
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
|
|
96
96
|
*/
|
|
97
97
|
created_at: string
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
|
-
* Display name that corresponds to the [credential](https://
|
|
100
|
+
* Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
|
|
101
101
|
*/
|
|
102
102
|
display_name: string
|
|
103
103
|
|
|
104
104
|
/**
|
|
105
|
-
* Date and time at which the [credential](https://
|
|
105
|
+
* 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`.
|
|
106
106
|
*/
|
|
107
107
|
ends_at?: string | undefined
|
|
108
108
|
/**
|
|
109
|
-
* Errors associated with the [credential](https://
|
|
109
|
+
* Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
110
110
|
*/
|
|
111
111
|
errors: Array<{
|
|
112
112
|
/**
|
|
@@ -120,7 +120,7 @@ export type AcsCredential = {
|
|
|
120
120
|
}>
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* Brand-specific terminology for the [credential](https://
|
|
123
|
+
* 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`.
|
|
124
124
|
*/
|
|
125
125
|
external_type?:
|
|
126
126
|
| 'pti_card'
|
|
@@ -139,15 +139,15 @@ export type AcsCredential = {
|
|
|
139
139
|
| 'akiles_credential'
|
|
140
140
|
| undefined
|
|
141
141
|
/**
|
|
142
|
-
* Display name that corresponds to the brand-specific terminology for the [credential](https://
|
|
142
|
+
* 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.
|
|
143
143
|
*/
|
|
144
144
|
external_type_display_name?: string | undefined
|
|
145
145
|
/**
|
|
146
|
-
* Indicates whether the [credential](https://
|
|
146
|
+
* Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
|
|
147
147
|
*/
|
|
148
148
|
is_issued?: boolean | undefined
|
|
149
149
|
/**
|
|
150
|
-
* Indicates whether the latest state of the [credential](https://
|
|
150
|
+
* 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.
|
|
151
151
|
*/
|
|
152
152
|
is_latest_desired_state_synced_with_provider?: boolean | null | undefined
|
|
153
153
|
/**
|
|
@@ -156,35 +156,35 @@ export type AcsCredential = {
|
|
|
156
156
|
is_managed: true
|
|
157
157
|
|
|
158
158
|
/**
|
|
159
|
-
* Indicates whether the [credential](https://
|
|
159
|
+
* 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).
|
|
160
160
|
*/
|
|
161
161
|
is_multi_phone_sync_credential?: boolean | undefined
|
|
162
162
|
/**
|
|
163
|
-
* Indicates whether the [credential](https://
|
|
163
|
+
* 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.
|
|
164
164
|
*/
|
|
165
165
|
is_one_time_use?: boolean | undefined
|
|
166
166
|
/**
|
|
167
|
-
* Date and time at which the [credential](https://
|
|
167
|
+
* Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
|
|
168
168
|
*/
|
|
169
169
|
issued_at?: string | null | undefined
|
|
170
170
|
/**
|
|
171
|
-
* Date and time at which the state of the [credential](https://
|
|
171
|
+
* 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.
|
|
172
172
|
*/
|
|
173
173
|
latest_desired_state_synced_with_provider_at?: string | null | undefined
|
|
174
174
|
/**
|
|
175
|
-
* ID of the parent [credential](https://
|
|
175
|
+
* ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
176
176
|
*/
|
|
177
177
|
parent_acs_credential_id?: string | undefined
|
|
178
178
|
/**
|
|
179
|
-
* Date and time at which the [credential](https://
|
|
179
|
+
* 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.
|
|
180
180
|
*/
|
|
181
181
|
starts_at?: string | undefined
|
|
182
182
|
/**
|
|
183
|
-
* ID of the [user identity](https://
|
|
183
|
+
* 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.
|
|
184
184
|
*/
|
|
185
185
|
user_identity_id?: string | undefined
|
|
186
186
|
/**
|
|
187
|
-
* Visionline-specific metadata for the [credential](https://
|
|
187
|
+
* Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
188
188
|
*/
|
|
189
189
|
visionline_metadata?:
|
|
190
190
|
| {
|
|
@@ -223,11 +223,11 @@ export type AcsCredential = {
|
|
|
223
223
|
}
|
|
224
224
|
| undefined
|
|
225
225
|
/**
|
|
226
|
-
* Warnings associated with the [credential](https://
|
|
226
|
+
* Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
227
227
|
*/
|
|
228
228
|
warnings: Array<
|
|
229
229
|
/**
|
|
230
|
-
* Indicates that the [credential](https://
|
|
230
|
+
* Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued.
|
|
231
231
|
*/
|
|
232
232
|
| {
|
|
233
233
|
/**
|
|
@@ -245,7 +245,7 @@ export type AcsCredential = {
|
|
|
245
245
|
*/
|
|
246
246
|
warning_code: 'waiting_to_be_issued'
|
|
247
247
|
} /**
|
|
248
|
-
* Indicates that the schedule of one of the [credential](https://
|
|
248
|
+
* 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.
|
|
249
249
|
*/
|
|
250
250
|
| {
|
|
251
251
|
/**
|
|
@@ -263,7 +263,7 @@ export type AcsCredential = {
|
|
|
263
263
|
*/
|
|
264
264
|
warning_code: 'schedule_externally_modified'
|
|
265
265
|
} /**
|
|
266
|
-
* Indicates that the schedule of the [credential](https://
|
|
266
|
+
* 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.
|
|
267
267
|
*/
|
|
268
268
|
| {
|
|
269
269
|
/**
|
|
@@ -281,7 +281,7 @@ export type AcsCredential = {
|
|
|
281
281
|
*/
|
|
282
282
|
warning_code: 'schedule_modified'
|
|
283
283
|
} /**
|
|
284
|
-
* Indicates that the [credential](https://
|
|
284
|
+
* Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted.
|
|
285
285
|
*/
|
|
286
286
|
| {
|
|
287
287
|
/**
|
|
@@ -299,7 +299,7 @@ export type AcsCredential = {
|
|
|
299
299
|
*/
|
|
300
300
|
warning_code: 'being_deleted'
|
|
301
301
|
} /**
|
|
302
|
-
* An unknown issue occurred while syncing the state of the [credential](https://
|
|
302
|
+
* 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.
|
|
303
303
|
*/
|
|
304
304
|
| {
|
|
305
305
|
/**
|
|
@@ -317,7 +317,7 @@ export type AcsCredential = {
|
|
|
317
317
|
*/
|
|
318
318
|
warning_code: 'unknown_issue_with_acs_credential'
|
|
319
319
|
} /**
|
|
320
|
-
* Access permissions for the [credential](https://
|
|
320
|
+
* 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.
|
|
321
321
|
*/
|
|
322
322
|
| {
|
|
323
323
|
/**
|
|
@@ -366,7 +366,7 @@ export type AcsCredential = {
|
|
|
366
366
|
>
|
|
367
367
|
|
|
368
368
|
/**
|
|
369
|
-
* ID of the workspace that contains the [credential](https://
|
|
369
|
+
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
370
370
|
*/
|
|
371
371
|
workspace_id: string
|
|
372
372
|
}
|