@seamapi/http 2.30.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 +103 -86
- 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 +105 -85
- 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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a hardware device that encodes [credential](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*
|
|
9
9
|
* 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:
|
|
10
10
|
*
|
|
@@ -15,38 +15,38 @@
|
|
|
15
15
|
*
|
|
16
16
|
* 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.
|
|
17
17
|
*
|
|
18
|
-
* See [Working with Card Encoders and Scanners](https://
|
|
18
|
+
* See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
19
19
|
*
|
|
20
|
-
* To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://
|
|
20
|
+
* 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).
|
|
21
21
|
*/
|
|
22
22
|
export type AcsEncoder = {
|
|
23
23
|
/**
|
|
24
|
-
* ID of the [encoder](https://
|
|
24
|
+
* ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
25
25
|
*/
|
|
26
26
|
acs_encoder_id: string
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* ID of the [access control system](https://
|
|
29
|
+
* 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).
|
|
30
30
|
*/
|
|
31
31
|
acs_system_id: string
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
* ID of the connected account that contains the [encoder](https://
|
|
34
|
+
* 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).
|
|
35
35
|
*/
|
|
36
36
|
connected_account_id: string
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
* Date and time at which the [encoder](https://
|
|
39
|
+
* 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.
|
|
40
40
|
*/
|
|
41
41
|
created_at: string
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
|
-
* Display name for the [encoder](https://
|
|
44
|
+
* Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
45
45
|
*/
|
|
46
46
|
display_name: string
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* Errors associated with the [encoder](https://
|
|
49
|
+
* Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
50
50
|
*/
|
|
51
51
|
errors: Array<{
|
|
52
52
|
/**
|
|
@@ -66,7 +66,7 @@ export type AcsEncoder = {
|
|
|
66
66
|
}>
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
* ID of the workspace that contains the [encoder](https://
|
|
69
|
+
* ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
70
70
|
*/
|
|
71
71
|
workspace_id: string
|
|
72
72
|
}
|
|
@@ -4,23 +4,23 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents an [entrance](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*
|
|
9
9
|
* 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.
|
|
10
10
|
*/
|
|
11
11
|
export type AcsEntrance = {
|
|
12
12
|
/**
|
|
13
|
-
* ID of the [entrance](https://
|
|
13
|
+
* ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
14
14
|
*/
|
|
15
15
|
acs_entrance_id: string
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* ID of the [access control system](https://
|
|
18
|
+
* 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).
|
|
19
19
|
*/
|
|
20
20
|
acs_system_id: string
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* Akiles-specific metadata associated with the [entrance](https://
|
|
23
|
+
* Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
24
24
|
*/
|
|
25
25
|
akiles_metadata?:
|
|
26
26
|
| {
|
|
@@ -54,7 +54,7 @@ export type AcsEntrance = {
|
|
|
54
54
|
}
|
|
55
55
|
| undefined
|
|
56
56
|
/**
|
|
57
|
-
* ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://
|
|
57
|
+
* ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
58
58
|
*/
|
|
59
59
|
assa_abloy_vostio_metadata?:
|
|
60
60
|
| {
|
|
@@ -82,7 +82,7 @@ export type AcsEntrance = {
|
|
|
82
82
|
}
|
|
83
83
|
| undefined
|
|
84
84
|
/**
|
|
85
|
-
* Avigilon Alta-specific metadata associated with the [entrance](https://
|
|
85
|
+
* Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
86
86
|
*/
|
|
87
87
|
avigilon_alta_metadata?:
|
|
88
88
|
| {
|
|
@@ -117,7 +117,7 @@ export type AcsEntrance = {
|
|
|
117
117
|
}
|
|
118
118
|
| undefined
|
|
119
119
|
/**
|
|
120
|
-
* Brivo-specific metadata associated with the [entrance](https://
|
|
120
|
+
* Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
121
121
|
*/
|
|
122
122
|
brivo_metadata?:
|
|
123
123
|
| {
|
|
@@ -156,22 +156,22 @@ export type AcsEntrance = {
|
|
|
156
156
|
*/
|
|
157
157
|
can_unlock_with_mobile_key?: boolean | undefined
|
|
158
158
|
/**
|
|
159
|
-
* ID of the [connected account](https://
|
|
159
|
+
* 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).
|
|
160
160
|
*/
|
|
161
161
|
connected_account_id: string
|
|
162
162
|
|
|
163
163
|
/**
|
|
164
|
-
* Date and time at which the [entrance](https://
|
|
164
|
+
* Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created.
|
|
165
165
|
*/
|
|
166
166
|
created_at: string
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
|
-
* Display name for the [entrance](https://
|
|
169
|
+
* Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
170
170
|
*/
|
|
171
171
|
display_name: string
|
|
172
172
|
|
|
173
173
|
/**
|
|
174
|
-
* dormakaba Ambiance-specific metadata associated with the [entrance](https://
|
|
174
|
+
* dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
175
175
|
*/
|
|
176
176
|
dormakaba_ambiance_metadata?:
|
|
177
177
|
| {
|
|
@@ -182,7 +182,7 @@ export type AcsEntrance = {
|
|
|
182
182
|
}
|
|
183
183
|
| undefined
|
|
184
184
|
/**
|
|
185
|
-
* dormakaba Community-specific metadata associated with the [entrance](https://
|
|
185
|
+
* dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
186
186
|
*/
|
|
187
187
|
dormakaba_community_metadata?:
|
|
188
188
|
| {
|
|
@@ -193,7 +193,7 @@ export type AcsEntrance = {
|
|
|
193
193
|
}
|
|
194
194
|
| undefined
|
|
195
195
|
/**
|
|
196
|
-
* Errors associated with the [entrance](https://
|
|
196
|
+
* Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
197
197
|
*/
|
|
198
198
|
errors: Array<{
|
|
199
199
|
/**
|
|
@@ -213,7 +213,7 @@ export type AcsEntrance = {
|
|
|
213
213
|
}>
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
|
-
* Hotek-specific metadata associated with the [entrance](https://
|
|
216
|
+
* Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
217
217
|
*/
|
|
218
218
|
hotek_metadata?:
|
|
219
219
|
| {
|
|
@@ -232,11 +232,11 @@ export type AcsEntrance = {
|
|
|
232
232
|
}
|
|
233
233
|
| undefined
|
|
234
234
|
/**
|
|
235
|
-
* Indicates whether the [entrance](https://
|
|
235
|
+
* Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.
|
|
236
236
|
*/
|
|
237
237
|
is_locked?: boolean | undefined
|
|
238
238
|
/**
|
|
239
|
-
* Latch-specific metadata associated with the [entrance](https://
|
|
239
|
+
* Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
240
240
|
*/
|
|
241
241
|
latch_metadata?:
|
|
242
242
|
| {
|
|
@@ -259,7 +259,7 @@ export type AcsEntrance = {
|
|
|
259
259
|
}
|
|
260
260
|
| undefined
|
|
261
261
|
/**
|
|
262
|
-
* Salto KS-specific metadata associated with the [entrance](https://
|
|
262
|
+
* Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
263
263
|
*/
|
|
264
264
|
salto_ks_metadata?:
|
|
265
265
|
| {
|
|
@@ -298,7 +298,7 @@ export type AcsEntrance = {
|
|
|
298
298
|
}
|
|
299
299
|
| undefined
|
|
300
300
|
/**
|
|
301
|
-
* Salto Space-specific metadata associated with the [entrance](https://
|
|
301
|
+
* Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
302
302
|
*/
|
|
303
303
|
salto_space_metadata?:
|
|
304
304
|
| {
|
|
@@ -334,7 +334,7 @@ export type AcsEntrance = {
|
|
|
334
334
|
space_ids: Array<string>
|
|
335
335
|
|
|
336
336
|
/**
|
|
337
|
-
* Visionline-specific metadata associated with the [entrance](https://
|
|
337
|
+
* Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
338
338
|
*/
|
|
339
339
|
visionline_metadata?:
|
|
340
340
|
| {
|
|
@@ -371,7 +371,7 @@ export type AcsEntrance = {
|
|
|
371
371
|
}
|
|
372
372
|
| undefined
|
|
373
373
|
/**
|
|
374
|
-
* Warnings associated with the [entrance](https://
|
|
374
|
+
* Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
375
375
|
*/
|
|
376
376
|
warnings: Array<
|
|
377
377
|
/**
|
|
@@ -4,54 +4,54 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents an [access control system](https://
|
|
7
|
+
* Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
8
8
|
*
|
|
9
|
-
* Within an `acs_system`, create [`acs_user`s](https://
|
|
9
|
+
* Within an `acs_system`, create [`acs_user`s](https://www.seam.co/docs/api/acs/users/object) and [`acs_credential`s](https://www.seam.co/docs/api/acs/credentials/object) to grant access to the `acs_user`s.
|
|
10
10
|
*
|
|
11
|
-
* For details about the resources associated with an access control system, see the [access control systems namespace](https://
|
|
11
|
+
* For details about the resources associated with an access control system, see the [access control systems namespace](https://www.seam.co/docs/api/acs/object).
|
|
12
12
|
*/
|
|
13
13
|
export type AcsSystem = {
|
|
14
14
|
/**
|
|
15
|
-
* Number of access groups in the [access control system](https://
|
|
15
|
+
* Number of access groups in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
16
16
|
*/
|
|
17
17
|
acs_access_group_count?: number | undefined
|
|
18
18
|
/**
|
|
19
|
-
* ID of the [access control system](https://
|
|
19
|
+
* ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
20
20
|
*/
|
|
21
21
|
acs_system_id: string
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* Number of users in the [access control system](https://
|
|
24
|
+
* Number of users in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
25
25
|
*/
|
|
26
26
|
acs_user_count?: number | undefined
|
|
27
27
|
/**
|
|
28
|
-
* ID of the connected account associated with the [access control system](https://
|
|
28
|
+
* ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
29
29
|
*/
|
|
30
30
|
connected_account_id: string
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
* IDs of the [connected accounts](https://
|
|
33
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
34
34
|
* @deprecated Use `connected_account_id`.
|
|
35
35
|
*/
|
|
36
36
|
connected_account_ids: Array<string>
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
* Date and time at which the [access control system](https://
|
|
39
|
+
* Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created.
|
|
40
40
|
*/
|
|
41
41
|
created_at: string
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
|
-
* ID of the default credential manager `acs_system` for this [access control system](https://
|
|
44
|
+
* ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
45
45
|
*/
|
|
46
46
|
default_credential_manager_acs_system_id?: string | null | undefined
|
|
47
47
|
/**
|
|
48
|
-
* Errors associated with the [access control system](https://
|
|
48
|
+
* Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
49
49
|
*/
|
|
50
50
|
errors: Array<
|
|
51
51
|
/**
|
|
52
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
53
|
-
* This error might also occur if Seam Bridge is connected to the wrong [workspace](https://
|
|
54
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
52
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
53
|
+
* This error might also occur if Seam Bridge is connected to the wrong [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
54
|
+
* 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).
|
|
55
55
|
*/
|
|
56
56
|
| {
|
|
57
57
|
/**
|
|
@@ -69,8 +69,8 @@ export type AcsSystem = {
|
|
|
69
69
|
*/
|
|
70
70
|
message: string
|
|
71
71
|
} /**
|
|
72
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
73
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
72
|
+
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
73
|
+
* 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).
|
|
74
74
|
*/
|
|
75
75
|
| {
|
|
76
76
|
/**
|
|
@@ -84,7 +84,7 @@ export type AcsSystem = {
|
|
|
84
84
|
error_code: 'bridge_disconnected'
|
|
85
85
|
|
|
86
86
|
/**
|
|
87
|
-
* Indicates whether the error is related to the [Seam Bridge](https://
|
|
87
|
+
* Indicates whether the error is related to the [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
88
88
|
*/
|
|
89
89
|
is_bridge_error?: boolean | undefined
|
|
90
90
|
/**
|
|
@@ -92,9 +92,9 @@ export type AcsSystem = {
|
|
|
92
92
|
*/
|
|
93
93
|
message: string
|
|
94
94
|
} /**
|
|
95
|
-
* Indicates that [Seam Bridge](https://
|
|
96
|
-
* For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://
|
|
97
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
95
|
+
* Indicates that [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://www.seam.co/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
96
|
+
* For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
97
|
+
* 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-visionline_instance_unreachable).
|
|
98
98
|
*/
|
|
99
99
|
| {
|
|
100
100
|
/**
|
|
@@ -130,7 +130,7 @@ export type AcsSystem = {
|
|
|
130
130
|
*/
|
|
131
131
|
message: string
|
|
132
132
|
} /**
|
|
133
|
-
* Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://
|
|
133
|
+
* Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
|
|
134
134
|
*/
|
|
135
135
|
| {
|
|
136
136
|
/**
|
|
@@ -148,7 +148,7 @@ export type AcsSystem = {
|
|
|
148
148
|
*/
|
|
149
149
|
message: string
|
|
150
150
|
} /**
|
|
151
|
-
* Indicates that the [access control system](https://
|
|
151
|
+
* Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.
|
|
152
152
|
*/
|
|
153
153
|
| {
|
|
154
154
|
/**
|
|
@@ -166,7 +166,7 @@ export type AcsSystem = {
|
|
|
166
166
|
*/
|
|
167
167
|
message: string
|
|
168
168
|
} /**
|
|
169
|
-
* Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://
|
|
169
|
+
* Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) to restore access.
|
|
170
170
|
*/
|
|
171
171
|
| {
|
|
172
172
|
/**
|
|
@@ -184,7 +184,7 @@ export type AcsSystem = {
|
|
|
184
184
|
*/
|
|
185
185
|
message: string
|
|
186
186
|
} /**
|
|
187
|
-
* Indicates that the [access control system](https://
|
|
187
|
+
* Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
|
|
188
188
|
*/
|
|
189
189
|
| {
|
|
190
190
|
/**
|
|
@@ -223,7 +223,7 @@ export type AcsSystem = {
|
|
|
223
223
|
>
|
|
224
224
|
|
|
225
225
|
/**
|
|
226
|
-
* Brand-specific terminology for the [access control system](https://
|
|
226
|
+
* Brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type.
|
|
227
227
|
*/
|
|
228
228
|
external_type?:
|
|
229
229
|
| 'pti_site'
|
|
@@ -245,16 +245,16 @@ export type AcsSystem = {
|
|
|
245
245
|
| 'akiles_organization'
|
|
246
246
|
| undefined
|
|
247
247
|
/**
|
|
248
|
-
* Display name that corresponds to the brand-specific terminology for the [access control system](https://
|
|
248
|
+
* Display name that corresponds to the brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type.
|
|
249
249
|
*/
|
|
250
250
|
external_type_display_name?: string | undefined
|
|
251
251
|
/**
|
|
252
|
-
* Alternative text for the [access control system](https://
|
|
252
|
+
* Alternative text for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) image.
|
|
253
253
|
*/
|
|
254
254
|
image_alt_text: string
|
|
255
255
|
|
|
256
256
|
/**
|
|
257
|
-
* URL for the image that represents the [access control system](https://
|
|
257
|
+
* URL for the image that represents the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
258
258
|
*/
|
|
259
259
|
image_url: string
|
|
260
260
|
|
|
@@ -264,17 +264,17 @@ export type AcsSystem = {
|
|
|
264
264
|
is_credential_manager: boolean
|
|
265
265
|
|
|
266
266
|
/**
|
|
267
|
-
* Location information for the [access control system](https://
|
|
267
|
+
* Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
268
268
|
*/
|
|
269
269
|
location: {
|
|
270
270
|
/**
|
|
271
|
-
* Time zone in which the [access control system](https://
|
|
271
|
+
* Time zone in which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is located.
|
|
272
272
|
*/
|
|
273
273
|
time_zone: string | null
|
|
274
274
|
}
|
|
275
275
|
|
|
276
276
|
/**
|
|
277
|
-
* Name of the [access control system](https://
|
|
277
|
+
* Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
278
278
|
*/
|
|
279
279
|
name: string
|
|
280
280
|
|
|
@@ -305,12 +305,12 @@ export type AcsSystem = {
|
|
|
305
305
|
*/
|
|
306
306
|
system_type_display_name?: string | undefined
|
|
307
307
|
/**
|
|
308
|
-
* Visionline-specific metadata for the [access control system](https://
|
|
308
|
+
* Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
309
309
|
*/
|
|
310
310
|
visionline_metadata?:
|
|
311
311
|
| {
|
|
312
312
|
/**
|
|
313
|
-
* IP address or hostname of the main Visionline server relative to [Seam Bridge](https://
|
|
313
|
+
* IP address or hostname of the main Visionline server relative to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) on the local network.
|
|
314
314
|
*/
|
|
315
315
|
lan_address?: string | undefined
|
|
316
316
|
/**
|
|
@@ -324,7 +324,7 @@ export type AcsSystem = {
|
|
|
324
324
|
}
|
|
325
325
|
| undefined
|
|
326
326
|
/**
|
|
327
|
-
* Warnings associated with the [access control system](https://
|
|
327
|
+
* Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
328
328
|
*/
|
|
329
329
|
warnings: Array<
|
|
330
330
|
/**
|
|
@@ -346,7 +346,7 @@ export type AcsSystem = {
|
|
|
346
346
|
*/
|
|
347
347
|
warning_code: 'salto_ks_subscription_limit_almost_reached'
|
|
348
348
|
} /**
|
|
349
|
-
* Indicates the [access control system](https://
|
|
349
|
+
* Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
350
350
|
*/
|
|
351
351
|
| {
|
|
352
352
|
/**
|
|
@@ -386,7 +386,7 @@ export type AcsSystem = {
|
|
|
386
386
|
*/
|
|
387
387
|
warning_code: 'setup_required'
|
|
388
388
|
} /**
|
|
389
|
-
* Indicates that Seam encountered an unexpected error while syncing this [access control system](https://
|
|
389
|
+
* Indicates that Seam encountered an unexpected error while syncing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co).
|
|
390
390
|
*/
|
|
391
391
|
| {
|
|
392
392
|
/**
|
|
@@ -407,7 +407,7 @@ export type AcsSystem = {
|
|
|
407
407
|
>
|
|
408
408
|
|
|
409
409
|
/**
|
|
410
|
-
* ID of the workspace that contains the [access control system](https://
|
|
410
|
+
* ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
411
411
|
*/
|
|
412
412
|
workspace_id: string
|
|
413
413
|
}
|