@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
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
* Represents a [user](https://
|
|
7
|
+
* 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).
|
|
8
8
|
*
|
|
9
9
|
* 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.
|
|
10
10
|
*
|
|
11
|
-
* For details about how to configure users in your access system, see the corresponding [system integration guide](https://
|
|
11
|
+
* 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).
|
|
12
12
|
*/
|
|
13
13
|
export type AcsUser = {
|
|
14
14
|
/**
|
|
15
|
-
* `starts_at` and `ends_at` timestamps for the [access system user's](https://
|
|
15
|
+
* `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.
|
|
16
16
|
*/
|
|
17
17
|
access_schedule?:
|
|
18
18
|
| {
|
|
@@ -27,27 +27,27 @@ export type AcsUser = {
|
|
|
27
27
|
}
|
|
28
28
|
| undefined
|
|
29
29
|
/**
|
|
30
|
-
* ID of the [access system](https://
|
|
30
|
+
* 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).
|
|
31
31
|
*/
|
|
32
32
|
acs_system_id: string
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
* ID of the [access system user](https://
|
|
35
|
+
* ID of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
36
36
|
*/
|
|
37
37
|
acs_user_id: string
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* The ID of the connected account that is associated with the [access system user](https://
|
|
40
|
+
* 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).
|
|
41
41
|
*/
|
|
42
42
|
connected_account_id: string
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* Date and time at which the [access system user](https://
|
|
45
|
+
* Date and time at which the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created.
|
|
46
46
|
*/
|
|
47
47
|
created_at: string
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* Display name for the [access system user](https://
|
|
50
|
+
* Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
51
51
|
*/
|
|
52
52
|
display_name: string
|
|
53
53
|
|
|
@@ -56,15 +56,15 @@ export type AcsUser = {
|
|
|
56
56
|
*/
|
|
57
57
|
email?: string | undefined
|
|
58
58
|
/**
|
|
59
|
-
* Email address of the [access system user](https://
|
|
59
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
60
60
|
*/
|
|
61
61
|
email_address?: string | undefined
|
|
62
62
|
/**
|
|
63
|
-
* Errors associated with the [access system user](https://
|
|
63
|
+
* Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
64
64
|
*/
|
|
65
65
|
errors: Array<
|
|
66
66
|
/**
|
|
67
|
-
* Indicates that the [access system user](https://
|
|
67
|
+
* 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.
|
|
68
68
|
*/
|
|
69
69
|
| {
|
|
70
70
|
/**
|
|
@@ -79,7 +79,7 @@ export type AcsUser = {
|
|
|
79
79
|
*/
|
|
80
80
|
message: string
|
|
81
81
|
} /**
|
|
82
|
-
* Indicates that the [access system user](https://
|
|
82
|
+
* 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.
|
|
83
83
|
*/
|
|
84
84
|
| {
|
|
85
85
|
/**
|
|
@@ -94,7 +94,7 @@ export type AcsUser = {
|
|
|
94
94
|
*/
|
|
95
95
|
message: string
|
|
96
96
|
} /**
|
|
97
|
-
* Indicates that the [access system user](https://
|
|
97
|
+
* 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).
|
|
98
98
|
*/
|
|
99
99
|
| {
|
|
100
100
|
/**
|
|
@@ -109,7 +109,7 @@ export type AcsUser = {
|
|
|
109
109
|
*/
|
|
110
110
|
message: string
|
|
111
111
|
} /**
|
|
112
|
-
* Indicates that the [access system user](https://
|
|
112
|
+
* 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).
|
|
113
113
|
*/
|
|
114
114
|
| {
|
|
115
115
|
/**
|
|
@@ -124,7 +124,7 @@ export type AcsUser = {
|
|
|
124
124
|
*/
|
|
125
125
|
message: string
|
|
126
126
|
} /**
|
|
127
|
-
* Indicates that the [access system user](https://
|
|
127
|
+
* 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).
|
|
128
128
|
*/
|
|
129
129
|
| {
|
|
130
130
|
/**
|
|
@@ -139,7 +139,7 @@ export type AcsUser = {
|
|
|
139
139
|
*/
|
|
140
140
|
message: string
|
|
141
141
|
} /**
|
|
142
|
-
* Indicates that the [access system user](https://
|
|
142
|
+
* 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).
|
|
143
143
|
*/
|
|
144
144
|
| {
|
|
145
145
|
/**
|
|
@@ -157,7 +157,7 @@ export type AcsUser = {
|
|
|
157
157
|
>
|
|
158
158
|
|
|
159
159
|
/**
|
|
160
|
-
* Brand-specific terminology for the [access system user](https://
|
|
160
|
+
* Brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type.
|
|
161
161
|
*/
|
|
162
162
|
external_type?:
|
|
163
163
|
| 'pti_user'
|
|
@@ -171,11 +171,11 @@ export type AcsUser = {
|
|
|
171
171
|
| 'kisi_user'
|
|
172
172
|
| undefined
|
|
173
173
|
/**
|
|
174
|
-
* Display name that corresponds to the brand-specific terminology for the [access system user](https://
|
|
174
|
+
* 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.
|
|
175
175
|
*/
|
|
176
176
|
external_type_display_name?: string | undefined
|
|
177
177
|
/**
|
|
178
|
-
* Full name of the [access system user](https://
|
|
178
|
+
* Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
179
179
|
*/
|
|
180
180
|
full_name?: string | undefined
|
|
181
181
|
/**
|
|
@@ -188,11 +188,11 @@ export type AcsUser = {
|
|
|
188
188
|
is_managed: true
|
|
189
189
|
|
|
190
190
|
/**
|
|
191
|
-
* Indicates whether the [access system user](https://
|
|
191
|
+
* 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).
|
|
192
192
|
*/
|
|
193
193
|
is_suspended?: boolean | undefined
|
|
194
194
|
/**
|
|
195
|
-
* Pending mutations associated with the [access system user](https://
|
|
195
|
+
* 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.
|
|
196
196
|
*/
|
|
197
197
|
pending_mutations?:
|
|
198
198
|
| Array<
|
|
@@ -493,11 +493,11 @@ export type AcsUser = {
|
|
|
493
493
|
>
|
|
494
494
|
| undefined
|
|
495
495
|
/**
|
|
496
|
-
* Phone number of the [access system user](https://
|
|
496
|
+
* 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`).
|
|
497
497
|
*/
|
|
498
498
|
phone_number?: string | undefined
|
|
499
499
|
/**
|
|
500
|
-
* Salto KS-specific metadata associated with the [access system user](https://
|
|
500
|
+
* Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
501
501
|
*/
|
|
502
502
|
salto_ks_metadata?:
|
|
503
503
|
| {
|
|
@@ -508,7 +508,7 @@ export type AcsUser = {
|
|
|
508
508
|
}
|
|
509
509
|
| undefined
|
|
510
510
|
/**
|
|
511
|
-
* Salto Space-specific metadata associated with the [access system user](https://
|
|
511
|
+
* Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
512
512
|
*/
|
|
513
513
|
salto_space_metadata?:
|
|
514
514
|
| {
|
|
@@ -523,27 +523,27 @@ export type AcsUser = {
|
|
|
523
523
|
}
|
|
524
524
|
| undefined
|
|
525
525
|
/**
|
|
526
|
-
* Email address of the user identity associated with the [access system user](https://
|
|
526
|
+
* Email address of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
527
527
|
*/
|
|
528
528
|
user_identity_email_address?: string | null | undefined
|
|
529
529
|
/**
|
|
530
|
-
* Full name of the user identity associated with the [access system user](https://
|
|
530
|
+
* Full name of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
531
531
|
*/
|
|
532
532
|
user_identity_full_name?: string | null | undefined
|
|
533
533
|
/**
|
|
534
|
-
* ID of the user identity associated with the [access system user](https://
|
|
534
|
+
* ID of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
535
535
|
*/
|
|
536
536
|
user_identity_id?: string | undefined
|
|
537
537
|
/**
|
|
538
|
-
* Phone number of the user identity associated with the [access system user](https://
|
|
538
|
+
* 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`).
|
|
539
539
|
*/
|
|
540
540
|
user_identity_phone_number?: string | null | undefined
|
|
541
541
|
/**
|
|
542
|
-
* Warnings associated with the [access system user](https://
|
|
542
|
+
* Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
543
543
|
*/
|
|
544
544
|
warnings: Array<
|
|
545
545
|
/**
|
|
546
|
-
* Indicates that the [access system user](https://
|
|
546
|
+
* 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.
|
|
547
547
|
*/
|
|
548
548
|
| {
|
|
549
549
|
/**
|
|
@@ -558,7 +558,7 @@ export type AcsUser = {
|
|
|
558
558
|
|
|
559
559
|
warning_code: 'being_deleted'
|
|
560
560
|
} /**
|
|
561
|
-
* Indicates that the [access system user](https://
|
|
561
|
+
* 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.
|
|
562
562
|
*/
|
|
563
563
|
| {
|
|
564
564
|
/**
|
|
@@ -573,7 +573,7 @@ export type AcsUser = {
|
|
|
573
573
|
|
|
574
574
|
warning_code: 'salto_ks_user_not_subscribed'
|
|
575
575
|
} /**
|
|
576
|
-
* Indicates that the [access system user](https://
|
|
576
|
+
* 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.
|
|
577
577
|
*/
|
|
578
578
|
| {
|
|
579
579
|
/**
|
|
@@ -588,7 +588,7 @@ export type AcsUser = {
|
|
|
588
588
|
|
|
589
589
|
warning_code: 'acs_user_inactive'
|
|
590
590
|
} /**
|
|
591
|
-
* An unknown issue occurred while syncing the state of this [access system user](https://
|
|
591
|
+
* 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.
|
|
592
592
|
*/
|
|
593
593
|
| {
|
|
594
594
|
/**
|
|
@@ -603,7 +603,7 @@ export type AcsUser = {
|
|
|
603
603
|
|
|
604
604
|
warning_code: 'unknown_issue_with_acs_user'
|
|
605
605
|
} /**
|
|
606
|
-
* Indicates that the [access system user](https://
|
|
606
|
+
* 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.
|
|
607
607
|
*/
|
|
608
608
|
| {
|
|
609
609
|
/**
|
|
@@ -621,7 +621,7 @@ export type AcsUser = {
|
|
|
621
621
|
>
|
|
622
622
|
|
|
623
623
|
/**
|
|
624
|
-
* ID of the workspace that contains the [access system user](https://
|
|
624
|
+
* ID of the workspace that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
625
625
|
*/
|
|
626
626
|
workspace_id: string
|
|
627
627
|
}
|