@seamapi/http 2.31.0 → 2.33.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 +6 -6
- 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 +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -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 +6 -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,19 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents an [entrance](https://
|
|
2
|
+
* 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).
|
|
3
3
|
*
|
|
4
4
|
* 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.
|
|
5
5
|
*/
|
|
6
6
|
export type AcsEntrance = {
|
|
7
7
|
/**
|
|
8
|
-
* ID of the [entrance](https://
|
|
8
|
+
* ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
9
9
|
*/
|
|
10
10
|
acs_entrance_id: string;
|
|
11
11
|
/**
|
|
12
|
-
* ID of the [access control system](https://
|
|
12
|
+
* 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).
|
|
13
13
|
*/
|
|
14
14
|
acs_system_id: string;
|
|
15
15
|
/**
|
|
16
|
-
* Akiles-specific metadata associated with the [entrance](https://
|
|
16
|
+
* Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
17
17
|
*/
|
|
18
18
|
akiles_metadata?: {
|
|
19
19
|
/**
|
|
@@ -43,7 +43,7 @@ export type AcsEntrance = {
|
|
|
43
43
|
site_name?: string | undefined;
|
|
44
44
|
} | undefined;
|
|
45
45
|
/**
|
|
46
|
-
* ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://
|
|
46
|
+
* ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
47
47
|
*/
|
|
48
48
|
assa_abloy_vostio_metadata?: {
|
|
49
49
|
/**
|
|
@@ -68,7 +68,7 @@ export type AcsEntrance = {
|
|
|
68
68
|
stand_open?: boolean | undefined;
|
|
69
69
|
} | undefined;
|
|
70
70
|
/**
|
|
71
|
-
* Avigilon Alta-specific metadata associated with the [entrance](https://
|
|
71
|
+
* Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
72
72
|
*/
|
|
73
73
|
avigilon_alta_metadata?: {
|
|
74
74
|
/**
|
|
@@ -101,7 +101,7 @@ export type AcsEntrance = {
|
|
|
101
101
|
zone_name?: string | undefined;
|
|
102
102
|
} | undefined;
|
|
103
103
|
/**
|
|
104
|
-
* Brivo-specific metadata associated with the [entrance](https://
|
|
104
|
+
* Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
105
105
|
*/
|
|
106
106
|
brivo_metadata?: {
|
|
107
107
|
/**
|
|
@@ -138,19 +138,19 @@ export type AcsEntrance = {
|
|
|
138
138
|
*/
|
|
139
139
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
140
140
|
/**
|
|
141
|
-
* ID of the [connected account](https://
|
|
141
|
+
* 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).
|
|
142
142
|
*/
|
|
143
143
|
connected_account_id: string;
|
|
144
144
|
/**
|
|
145
|
-
* Date and time at which the [entrance](https://
|
|
145
|
+
* Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created.
|
|
146
146
|
*/
|
|
147
147
|
created_at: string;
|
|
148
148
|
/**
|
|
149
|
-
* Display name for the [entrance](https://
|
|
149
|
+
* Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
150
150
|
*/
|
|
151
151
|
display_name: string;
|
|
152
152
|
/**
|
|
153
|
-
* dormakaba Ambiance-specific metadata associated with the [entrance](https://
|
|
153
|
+
* dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
154
154
|
*/
|
|
155
155
|
dormakaba_ambiance_metadata?: {
|
|
156
156
|
/**
|
|
@@ -159,7 +159,7 @@ export type AcsEntrance = {
|
|
|
159
159
|
access_point_name?: string | undefined;
|
|
160
160
|
} | undefined;
|
|
161
161
|
/**
|
|
162
|
-
* dormakaba Community-specific metadata associated with the [entrance](https://
|
|
162
|
+
* dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
163
163
|
*/
|
|
164
164
|
dormakaba_community_metadata?: {
|
|
165
165
|
/**
|
|
@@ -168,7 +168,7 @@ export type AcsEntrance = {
|
|
|
168
168
|
access_point_profile?: string | undefined;
|
|
169
169
|
} | undefined;
|
|
170
170
|
/**
|
|
171
|
-
* Errors associated with the [entrance](https://
|
|
171
|
+
* Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
172
172
|
*/
|
|
173
173
|
errors: Array<{
|
|
174
174
|
/**
|
|
@@ -185,7 +185,7 @@ export type AcsEntrance = {
|
|
|
185
185
|
message: string;
|
|
186
186
|
}>;
|
|
187
187
|
/**
|
|
188
|
-
* Hotek-specific metadata associated with the [entrance](https://
|
|
188
|
+
* Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
189
189
|
*/
|
|
190
190
|
hotek_metadata?: {
|
|
191
191
|
/**
|
|
@@ -202,11 +202,11 @@ export type AcsEntrance = {
|
|
|
202
202
|
room_number?: string | undefined;
|
|
203
203
|
} | undefined;
|
|
204
204
|
/**
|
|
205
|
-
* Indicates whether the [entrance](https://
|
|
205
|
+
* Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.
|
|
206
206
|
*/
|
|
207
207
|
is_locked?: boolean | undefined;
|
|
208
208
|
/**
|
|
209
|
-
* Latch-specific metadata associated with the [entrance](https://
|
|
209
|
+
* Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
210
210
|
*/
|
|
211
211
|
latch_metadata?: {
|
|
212
212
|
/**
|
|
@@ -227,7 +227,7 @@ export type AcsEntrance = {
|
|
|
227
227
|
is_connected?: boolean | undefined;
|
|
228
228
|
} | undefined;
|
|
229
229
|
/**
|
|
230
|
-
* Salto KS-specific metadata associated with the [entrance](https://
|
|
230
|
+
* Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
231
231
|
*/
|
|
232
232
|
salto_ks_metadata?: {
|
|
233
233
|
/**
|
|
@@ -264,7 +264,7 @@ export type AcsEntrance = {
|
|
|
264
264
|
privacy_mode?: boolean | undefined;
|
|
265
265
|
} | undefined;
|
|
266
266
|
/**
|
|
267
|
-
* Salto Space-specific metadata associated with the [entrance](https://
|
|
267
|
+
* Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
268
268
|
*/
|
|
269
269
|
salto_space_metadata?: {
|
|
270
270
|
/**
|
|
@@ -297,7 +297,7 @@ export type AcsEntrance = {
|
|
|
297
297
|
*/
|
|
298
298
|
space_ids: Array<string>;
|
|
299
299
|
/**
|
|
300
|
-
* Visionline-specific metadata associated with the [entrance](https://
|
|
300
|
+
* Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
301
301
|
*/
|
|
302
302
|
visionline_metadata?: {
|
|
303
303
|
/**
|
|
@@ -323,7 +323,7 @@ export type AcsEntrance = {
|
|
|
323
323
|
}> | undefined;
|
|
324
324
|
} | undefined;
|
|
325
325
|
/**
|
|
326
|
-
* Warnings associated with the [entrance](https://
|
|
326
|
+
* Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
327
327
|
*/
|
|
328
328
|
warnings: Array<
|
|
329
329
|
/**
|
|
@@ -1,48 +1,48 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents an [access control system](https://
|
|
2
|
+
* Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
3
3
|
*
|
|
4
|
-
* Within an `acs_system`, create [`acs_user`s](https://
|
|
4
|
+
* 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.
|
|
5
5
|
*
|
|
6
|
-
* For details about the resources associated with an access control system, see the [access control systems namespace](https://
|
|
6
|
+
* 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).
|
|
7
7
|
*/
|
|
8
8
|
export type AcsSystem = {
|
|
9
9
|
/**
|
|
10
|
-
* Number of access groups in the [access control system](https://
|
|
10
|
+
* Number of access groups in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
11
11
|
*/
|
|
12
12
|
acs_access_group_count?: number | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* ID of the [access control system](https://
|
|
14
|
+
* ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
15
15
|
*/
|
|
16
16
|
acs_system_id: string;
|
|
17
17
|
/**
|
|
18
|
-
* Number of users in the [access control system](https://
|
|
18
|
+
* Number of users in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
19
19
|
*/
|
|
20
20
|
acs_user_count?: number | undefined;
|
|
21
21
|
/**
|
|
22
|
-
* ID of the connected account associated with the [access control system](https://
|
|
22
|
+
* ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
23
23
|
*/
|
|
24
24
|
connected_account_id: string;
|
|
25
25
|
/**
|
|
26
|
-
* IDs of the [connected accounts](https://
|
|
26
|
+
* 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).
|
|
27
27
|
* @deprecated Use `connected_account_id`.
|
|
28
28
|
*/
|
|
29
29
|
connected_account_ids: Array<string>;
|
|
30
30
|
/**
|
|
31
|
-
* Date and time at which the [access control system](https://
|
|
31
|
+
* Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created.
|
|
32
32
|
*/
|
|
33
33
|
created_at: string;
|
|
34
34
|
/**
|
|
35
|
-
* ID of the default credential manager `acs_system` for this [access control system](https://
|
|
35
|
+
* ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
36
36
|
*/
|
|
37
37
|
default_credential_manager_acs_system_id?: string | null | undefined;
|
|
38
38
|
/**
|
|
39
|
-
* Errors associated with the [access control system](https://
|
|
39
|
+
* Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
40
40
|
*/
|
|
41
41
|
errors: Array<
|
|
42
42
|
/**
|
|
43
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
44
|
-
* This error might also occur if Seam Bridge is connected to the wrong [workspace](https://
|
|
45
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
43
|
+
* 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.
|
|
44
|
+
* This error might also occur if Seam Bridge is connected to the wrong [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
45
|
+
* 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).
|
|
46
46
|
*/
|
|
47
47
|
{
|
|
48
48
|
/**
|
|
@@ -58,8 +58,8 @@ export type AcsSystem = {
|
|
|
58
58
|
*/
|
|
59
59
|
message: string;
|
|
60
60
|
} /**
|
|
61
|
-
* Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
62
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
61
|
+
* 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.
|
|
62
|
+
* 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).
|
|
63
63
|
*/ | {
|
|
64
64
|
/**
|
|
65
65
|
* Date and time at which Seam created the error.
|
|
@@ -70,7 +70,7 @@ export type AcsSystem = {
|
|
|
70
70
|
*/
|
|
71
71
|
error_code: 'bridge_disconnected';
|
|
72
72
|
/**
|
|
73
|
-
* Indicates whether the error is related to the [Seam Bridge](https://
|
|
73
|
+
* Indicates whether the error is related to the [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
74
74
|
*/
|
|
75
75
|
is_bridge_error?: boolean | undefined;
|
|
76
76
|
/**
|
|
@@ -78,9 +78,9 @@ export type AcsSystem = {
|
|
|
78
78
|
*/
|
|
79
79
|
message: string;
|
|
80
80
|
} /**
|
|
81
|
-
* Indicates that [Seam Bridge](https://
|
|
82
|
-
* For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://
|
|
83
|
-
* See also [Troubleshooting Your Access Control System](https://
|
|
81
|
+
* 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).
|
|
82
|
+
* 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).
|
|
83
|
+
* 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).
|
|
84
84
|
*/ | {
|
|
85
85
|
/**
|
|
86
86
|
* Date and time at which Seam created the error.
|
|
@@ -110,7 +110,7 @@ export type AcsSystem = {
|
|
|
110
110
|
*/
|
|
111
111
|
message: string;
|
|
112
112
|
} /**
|
|
113
|
-
* Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://
|
|
113
|
+
* 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.
|
|
114
114
|
*/ | {
|
|
115
115
|
/**
|
|
116
116
|
* Date and time at which Seam created the error.
|
|
@@ -125,7 +125,7 @@ export type AcsSystem = {
|
|
|
125
125
|
*/
|
|
126
126
|
message: string;
|
|
127
127
|
} /**
|
|
128
|
-
* Indicates that the [access control system](https://
|
|
128
|
+
* 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.
|
|
129
129
|
*/ | {
|
|
130
130
|
/**
|
|
131
131
|
* Date and time at which Seam created the error.
|
|
@@ -140,7 +140,7 @@ export type AcsSystem = {
|
|
|
140
140
|
*/
|
|
141
141
|
message: string;
|
|
142
142
|
} /**
|
|
143
|
-
* Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://
|
|
143
|
+
* 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.
|
|
144
144
|
*/ | {
|
|
145
145
|
/**
|
|
146
146
|
* Date and time at which Seam created the error.
|
|
@@ -155,7 +155,7 @@ export type AcsSystem = {
|
|
|
155
155
|
*/
|
|
156
156
|
message: string;
|
|
157
157
|
} /**
|
|
158
|
-
* Indicates that the [access control system](https://
|
|
158
|
+
* 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.
|
|
159
159
|
*/ | {
|
|
160
160
|
/**
|
|
161
161
|
* Date and time at which Seam created the error.
|
|
@@ -186,19 +186,19 @@ export type AcsSystem = {
|
|
|
186
186
|
message: string;
|
|
187
187
|
}>;
|
|
188
188
|
/**
|
|
189
|
-
* Brand-specific terminology for the [access control system](https://
|
|
189
|
+
* Brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type.
|
|
190
190
|
*/
|
|
191
191
|
external_type?: 'pti_site' | 'avigilon_alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'dormakaba_ambiance_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'hotek_site' | 'kisi_organization' | 'akiles_organization' | undefined;
|
|
192
192
|
/**
|
|
193
|
-
* Display name that corresponds to the brand-specific terminology for the [access control system](https://
|
|
193
|
+
* 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.
|
|
194
194
|
*/
|
|
195
195
|
external_type_display_name?: string | undefined;
|
|
196
196
|
/**
|
|
197
|
-
* Alternative text for the [access control system](https://
|
|
197
|
+
* Alternative text for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) image.
|
|
198
198
|
*/
|
|
199
199
|
image_alt_text: string;
|
|
200
200
|
/**
|
|
201
|
-
* URL for the image that represents the [access control system](https://
|
|
201
|
+
* URL for the image that represents the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
202
202
|
*/
|
|
203
203
|
image_url: string;
|
|
204
204
|
/**
|
|
@@ -206,16 +206,16 @@ export type AcsSystem = {
|
|
|
206
206
|
*/
|
|
207
207
|
is_credential_manager: boolean;
|
|
208
208
|
/**
|
|
209
|
-
* Location information for the [access control system](https://
|
|
209
|
+
* Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
210
210
|
*/
|
|
211
211
|
location: {
|
|
212
212
|
/**
|
|
213
|
-
* Time zone in which the [access control system](https://
|
|
213
|
+
* Time zone in which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is located.
|
|
214
214
|
*/
|
|
215
215
|
time_zone: string | null;
|
|
216
216
|
};
|
|
217
217
|
/**
|
|
218
|
-
* Name of the [access control system](https://
|
|
218
|
+
* Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
219
219
|
*/
|
|
220
220
|
name: string;
|
|
221
221
|
/**
|
|
@@ -227,11 +227,11 @@ export type AcsSystem = {
|
|
|
227
227
|
*/
|
|
228
228
|
system_type_display_name?: string | undefined;
|
|
229
229
|
/**
|
|
230
|
-
* Visionline-specific metadata for the [access control system](https://
|
|
230
|
+
* Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
231
231
|
*/
|
|
232
232
|
visionline_metadata?: {
|
|
233
233
|
/**
|
|
234
|
-
* IP address or hostname of the main Visionline server relative to [Seam Bridge](https://
|
|
234
|
+
* 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.
|
|
235
235
|
*/
|
|
236
236
|
lan_address?: string | undefined;
|
|
237
237
|
/**
|
|
@@ -244,7 +244,7 @@ export type AcsSystem = {
|
|
|
244
244
|
system_id?: string | undefined;
|
|
245
245
|
} | undefined;
|
|
246
246
|
/**
|
|
247
|
-
* Warnings associated with the [access control system](https://
|
|
247
|
+
* Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
248
248
|
*/
|
|
249
249
|
warnings: Array<
|
|
250
250
|
/**
|
|
@@ -264,7 +264,7 @@ export type AcsSystem = {
|
|
|
264
264
|
*/
|
|
265
265
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
266
266
|
} /**
|
|
267
|
-
* Indicates the [access control system](https://
|
|
267
|
+
* 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).
|
|
268
268
|
*/ | {
|
|
269
269
|
/**
|
|
270
270
|
* Date and time at which Seam created the warning.
|
|
@@ -298,7 +298,7 @@ export type AcsSystem = {
|
|
|
298
298
|
*/
|
|
299
299
|
warning_code: 'setup_required';
|
|
300
300
|
} /**
|
|
301
|
-
* Indicates that Seam encountered an unexpected error while syncing this [access control system](https://
|
|
301
|
+
* 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).
|
|
302
302
|
*/ | {
|
|
303
303
|
/**
|
|
304
304
|
* Date and time at which Seam created the warning.
|
|
@@ -314,7 +314,7 @@ export type AcsSystem = {
|
|
|
314
314
|
warning_code: 'unknown_issue_with_acs_system';
|
|
315
315
|
}>;
|
|
316
316
|
/**
|
|
317
|
-
* ID of the workspace that contains the [access control system](https://
|
|
317
|
+
* ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
318
318
|
*/
|
|
319
319
|
workspace_id: string;
|
|
320
320
|
};
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents a [user](https://
|
|
2
|
+
* Represents a [user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
3
3
|
*
|
|
4
4
|
* An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
5
5
|
*
|
|
6
|
-
* For details about how to configure users in your access system, see the corresponding [system integration guide](https://
|
|
6
|
+
* For details about how to configure users in your access system, 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 AcsUser = {
|
|
9
9
|
/**
|
|
10
|
-
* `starts_at` and `ends_at` timestamps for the [access system user's](https://
|
|
10
|
+
* `starts_at` and `ends_at` timestamps for the [access system user's](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access.
|
|
11
11
|
*/
|
|
12
12
|
access_schedule?: {
|
|
13
13
|
/**
|
|
@@ -20,23 +20,23 @@ export type AcsUser = {
|
|
|
20
20
|
starts_at: string;
|
|
21
21
|
} | undefined;
|
|
22
22
|
/**
|
|
23
|
-
* ID of the [access system](https://
|
|
23
|
+
* ID of the [access system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
24
24
|
*/
|
|
25
25
|
acs_system_id: string;
|
|
26
26
|
/**
|
|
27
|
-
* ID of the [access system user](https://
|
|
27
|
+
* ID of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
28
28
|
*/
|
|
29
29
|
acs_user_id: string;
|
|
30
30
|
/**
|
|
31
|
-
* The ID of the connected account that is associated with the [access system user](https://
|
|
31
|
+
* The ID of the connected account that is associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
32
32
|
*/
|
|
33
33
|
connected_account_id: string;
|
|
34
34
|
/**
|
|
35
|
-
* Date and time at which the [access system user](https://
|
|
35
|
+
* Date and time at which the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created.
|
|
36
36
|
*/
|
|
37
37
|
created_at: string;
|
|
38
38
|
/**
|
|
39
|
-
* Display name for the [access system user](https://
|
|
39
|
+
* Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
40
40
|
*/
|
|
41
41
|
display_name: string;
|
|
42
42
|
/**
|
|
@@ -44,15 +44,15 @@ export type AcsUser = {
|
|
|
44
44
|
*/
|
|
45
45
|
email?: string | undefined;
|
|
46
46
|
/**
|
|
47
|
-
* Email address of the [access system user](https://
|
|
47
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
48
48
|
*/
|
|
49
49
|
email_address?: string | undefined;
|
|
50
50
|
/**
|
|
51
|
-
* Errors associated with the [access system user](https://
|
|
51
|
+
* Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
52
52
|
*/
|
|
53
53
|
errors: Array<
|
|
54
54
|
/**
|
|
55
|
-
* Indicates that the [access system user](https://
|
|
55
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam.
|
|
56
56
|
*/
|
|
57
57
|
{
|
|
58
58
|
/**
|
|
@@ -65,7 +65,7 @@ export type AcsUser = {
|
|
|
65
65
|
*/
|
|
66
66
|
message: string;
|
|
67
67
|
} /**
|
|
68
|
-
* Indicates that the [access system user](https://
|
|
68
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
|
|
69
69
|
*/ | {
|
|
70
70
|
/**
|
|
71
71
|
* Date and time at which Seam created the error.
|
|
@@ -77,7 +77,7 @@ export type AcsUser = {
|
|
|
77
77
|
*/
|
|
78
78
|
message: string;
|
|
79
79
|
} /**
|
|
80
|
-
* Indicates that the [access system user](https://
|
|
80
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) 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).
|
|
81
81
|
*/ | {
|
|
82
82
|
/**
|
|
83
83
|
* Date and time at which Seam created the error.
|
|
@@ -89,7 +89,7 @@ export type AcsUser = {
|
|
|
89
89
|
*/
|
|
90
90
|
message: string;
|
|
91
91
|
} /**
|
|
92
|
-
* Indicates that the [access system user](https://
|
|
92
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated 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).
|
|
93
93
|
*/ | {
|
|
94
94
|
/**
|
|
95
95
|
* Date and time at which Seam created the error.
|
|
@@ -101,7 +101,7 @@ export type AcsUser = {
|
|
|
101
101
|
*/
|
|
102
102
|
message: string;
|
|
103
103
|
} /**
|
|
104
|
-
* Indicates that the [access system user](https://
|
|
104
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted 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).
|
|
105
105
|
*/ | {
|
|
106
106
|
/**
|
|
107
107
|
* Date and time at which Seam created the error.
|
|
@@ -113,7 +113,7 @@ export type AcsUser = {
|
|
|
113
113
|
*/
|
|
114
114
|
message: string;
|
|
115
115
|
} /**
|
|
116
|
-
* Indicates that the [access system user](https://
|
|
116
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
|
|
117
117
|
*/ | {
|
|
118
118
|
/**
|
|
119
119
|
* Date and time at which Seam created the error.
|
|
@@ -126,15 +126,15 @@ export type AcsUser = {
|
|
|
126
126
|
message: string;
|
|
127
127
|
}>;
|
|
128
128
|
/**
|
|
129
|
-
* Brand-specific terminology for the [access system user](https://
|
|
129
|
+
* Brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type.
|
|
130
130
|
*/
|
|
131
131
|
external_type?: 'pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user' | 'dormakaba_community_user' | 'salto_space_user' | 'avigilon_alta_user' | 'kisi_user' | undefined;
|
|
132
132
|
/**
|
|
133
|
-
* Display name that corresponds to the brand-specific terminology for the [access system user](https://
|
|
133
|
+
* Display name that corresponds to the brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type.
|
|
134
134
|
*/
|
|
135
135
|
external_type_display_name?: string | undefined;
|
|
136
136
|
/**
|
|
137
|
-
* Full name of the [access system user](https://
|
|
137
|
+
* Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
138
138
|
*/
|
|
139
139
|
full_name?: string | undefined;
|
|
140
140
|
/**
|
|
@@ -146,11 +146,11 @@ export type AcsUser = {
|
|
|
146
146
|
*/
|
|
147
147
|
is_managed: true;
|
|
148
148
|
/**
|
|
149
|
-
* Indicates whether the [access system user](https://
|
|
149
|
+
* Indicates whether the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is currently [suspended](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).
|
|
150
150
|
*/
|
|
151
151
|
is_suspended?: boolean | undefined;
|
|
152
152
|
/**
|
|
153
|
-
* Pending mutations associated with the [access system user](https://
|
|
153
|
+
* Pending mutations associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.
|
|
154
154
|
*/
|
|
155
155
|
pending_mutations?: Array<
|
|
156
156
|
/**
|
|
@@ -409,11 +409,11 @@ export type AcsUser = {
|
|
|
409
409
|
};
|
|
410
410
|
}> | undefined;
|
|
411
411
|
/**
|
|
412
|
-
* Phone number of the [access system user](https://
|
|
412
|
+
* Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
413
413
|
*/
|
|
414
414
|
phone_number?: string | undefined;
|
|
415
415
|
/**
|
|
416
|
-
* Salto KS-specific metadata associated with the [access system user](https://
|
|
416
|
+
* Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
417
417
|
*/
|
|
418
418
|
salto_ks_metadata?: {
|
|
419
419
|
/**
|
|
@@ -422,7 +422,7 @@ export type AcsUser = {
|
|
|
422
422
|
is_subscribed?: boolean | undefined;
|
|
423
423
|
} | undefined;
|
|
424
424
|
/**
|
|
425
|
-
* Salto Space-specific metadata associated with the [access system user](https://
|
|
425
|
+
* Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
426
426
|
*/
|
|
427
427
|
salto_space_metadata?: {
|
|
428
428
|
/**
|
|
@@ -435,27 +435,27 @@ export type AcsUser = {
|
|
|
435
435
|
user_id?: string | undefined;
|
|
436
436
|
} | undefined;
|
|
437
437
|
/**
|
|
438
|
-
* Email address of the user identity associated with the [access system user](https://
|
|
438
|
+
* Email address of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
439
439
|
*/
|
|
440
440
|
user_identity_email_address?: string | null | undefined;
|
|
441
441
|
/**
|
|
442
|
-
* Full name of the user identity associated with the [access system user](https://
|
|
442
|
+
* Full name of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
443
443
|
*/
|
|
444
444
|
user_identity_full_name?: string | null | undefined;
|
|
445
445
|
/**
|
|
446
|
-
* ID of the user identity associated with the [access system user](https://
|
|
446
|
+
* ID of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
447
447
|
*/
|
|
448
448
|
user_identity_id?: string | undefined;
|
|
449
449
|
/**
|
|
450
|
-
* Phone number of the user identity associated with the [access system user](https://
|
|
450
|
+
* Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
451
451
|
*/
|
|
452
452
|
user_identity_phone_number?: string | null | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* Warnings associated with the [access system user](https://
|
|
454
|
+
* Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
455
455
|
*/
|
|
456
456
|
warnings: Array<
|
|
457
457
|
/**
|
|
458
|
-
* Indicates that the [access system user](https://
|
|
458
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.
|
|
459
459
|
*/
|
|
460
460
|
{
|
|
461
461
|
/**
|
|
@@ -468,7 +468,7 @@ export type AcsUser = {
|
|
|
468
468
|
message: string;
|
|
469
469
|
warning_code: 'being_deleted';
|
|
470
470
|
} /**
|
|
471
|
-
* Indicates that the [access system user](https://
|
|
471
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
|
|
472
472
|
*/ | {
|
|
473
473
|
/**
|
|
474
474
|
* Date and time at which Seam created the warning.
|
|
@@ -480,7 +480,7 @@ export type AcsUser = {
|
|
|
480
480
|
message: string;
|
|
481
481
|
warning_code: 'salto_ks_user_not_subscribed';
|
|
482
482
|
} /**
|
|
483
|
-
* Indicates that the [access system user](https://
|
|
483
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked.
|
|
484
484
|
*/ | {
|
|
485
485
|
/**
|
|
486
486
|
* Date and time at which Seam created the warning.
|
|
@@ -492,7 +492,7 @@ export type AcsUser = {
|
|
|
492
492
|
message: string;
|
|
493
493
|
warning_code: 'acs_user_inactive';
|
|
494
494
|
} /**
|
|
495
|
-
* An unknown issue occurred while syncing the state of this [access system user](https://
|
|
495
|
+
* An unknown issue occurred while syncing the state of this [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
|
|
496
496
|
*/ | {
|
|
497
497
|
/**
|
|
498
498
|
* Date and time at which Seam created the warning.
|
|
@@ -504,7 +504,7 @@ export type AcsUser = {
|
|
|
504
504
|
message: string;
|
|
505
505
|
warning_code: 'unknown_issue_with_acs_user';
|
|
506
506
|
} /**
|
|
507
|
-
* Indicates that the [access system user](https://
|
|
507
|
+
* Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
|
|
508
508
|
*/ | {
|
|
509
509
|
/**
|
|
510
510
|
* Date and time at which Seam created the warning.
|
|
@@ -517,7 +517,7 @@ export type AcsUser = {
|
|
|
517
517
|
warning_code: 'latch_resident_user';
|
|
518
518
|
}>;
|
|
519
519
|
/**
|
|
520
|
-
* ID of the workspace that contains the [access system user](https://
|
|
520
|
+
* ID of the workspace that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
521
521
|
*/
|
|
522
522
|
workspace_id: string;
|
|
523
523
|
};
|