@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
|
@@ -83,7 +83,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Adds a specified [access system user](https://
|
|
86
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
87
87
|
*/
|
|
88
88
|
addUser(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Deletes a specified [access group](https://
|
|
102
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
103
103
|
*/
|
|
104
104
|
delete(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -115,7 +115,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Returns a specified [access group](https://
|
|
118
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
119
119
|
*/
|
|
120
120
|
get(parameters, options = {}) {
|
|
121
121
|
return new SeamHttpRequest(this, {
|
|
@@ -131,7 +131,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Returns a list of all [access groups](https://
|
|
134
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
135
135
|
*/
|
|
136
136
|
list(parameters, options = {}) {
|
|
137
137
|
return new SeamHttpRequest(this, {
|
|
@@ -147,7 +147,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
147
147
|
});
|
|
148
148
|
}
|
|
149
149
|
/**
|
|
150
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
150
|
+
* Returns a list of all accessible entrances for a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
151
151
|
*/
|
|
152
152
|
listAccessibleEntrances(parameters, options = {}) {
|
|
153
153
|
return new SeamHttpRequest(this, {
|
|
@@ -163,7 +163,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
163
163
|
});
|
|
164
164
|
}
|
|
165
165
|
/**
|
|
166
|
-
* Returns a list of all [access system users](https://
|
|
166
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
167
167
|
*/
|
|
168
168
|
listUsers(parameters, options = {}) {
|
|
169
169
|
return new SeamHttpRequest(this, {
|
|
@@ -179,7 +179,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
179
179
|
});
|
|
180
180
|
}
|
|
181
181
|
/**
|
|
182
|
-
* Removes a specified [access system user](https://
|
|
182
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
183
183
|
*/
|
|
184
184
|
removeUser(parameters, options = {}) {
|
|
185
185
|
return new SeamHttpRequest(this, {
|
|
@@ -17,35 +17,35 @@ export declare class SeamHttpAcsCredentials {
|
|
|
17
17
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
18
18
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
19
19
|
/**
|
|
20
|
-
* Assigns a specified [credential](https://
|
|
20
|
+
* Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
21
21
|
*/
|
|
22
22
|
assign(parameters: AcsCredentialsAssignParameters, options?: AcsCredentialsAssignOptions): AcsCredentialsAssignRequest;
|
|
23
23
|
/**
|
|
24
|
-
* Creates a new [credential](https://
|
|
24
|
+
* Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
|
|
25
25
|
*/
|
|
26
26
|
create(parameters: AcsCredentialsCreateParameters, options?: AcsCredentialsCreateOptions): AcsCredentialsCreateRequest;
|
|
27
27
|
/**
|
|
28
|
-
* Deletes a specified [credential](https://
|
|
28
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
29
29
|
*/
|
|
30
30
|
delete(parameters: AcsCredentialsDeleteParameters, options?: AcsCredentialsDeleteOptions): AcsCredentialsDeleteRequest;
|
|
31
31
|
/**
|
|
32
|
-
* Returns a specified [credential](https://
|
|
32
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
33
33
|
*/
|
|
34
34
|
get(parameters: AcsCredentialsGetParameters, options?: AcsCredentialsGetOptions): AcsCredentialsGetRequest;
|
|
35
35
|
/**
|
|
36
|
-
* Returns a list of all [credentials](https://
|
|
36
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
37
37
|
*/
|
|
38
38
|
list(parameters?: AcsCredentialsListParameters, options?: AcsCredentialsListOptions): AcsCredentialsListRequest;
|
|
39
39
|
/**
|
|
40
|
-
* Returns a list of all [entrances](https://
|
|
40
|
+
* Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access.
|
|
41
41
|
*/
|
|
42
42
|
listAccessibleEntrances(parameters: AcsCredentialsListAccessibleEntrancesParameters, options?: AcsCredentialsListAccessibleEntrancesOptions): AcsCredentialsListAccessibleEntrancesRequest;
|
|
43
43
|
/**
|
|
44
|
-
* Unassigns a specified [credential](https://
|
|
44
|
+
* Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
45
45
|
*/
|
|
46
46
|
unassign(parameters: AcsCredentialsUnassignParameters, options?: AcsCredentialsUnassignOptions): AcsCredentialsUnassignRequest;
|
|
47
47
|
/**
|
|
48
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
48
|
+
* Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
49
49
|
*/
|
|
50
50
|
update(parameters: AcsCredentialsUpdateParameters, options?: AcsCredentialsUpdateOptions): AcsCredentialsUpdateRequest;
|
|
51
51
|
}
|
|
@@ -84,7 +84,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
84
84
|
*/
|
|
85
85
|
acs_user_id?: string | undefined;
|
|
86
86
|
/**
|
|
87
|
-
* Set of IDs of the [entrances](https://
|
|
87
|
+
* Set of IDs of the [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
|
|
88
88
|
*/
|
|
89
89
|
allowed_acs_entrance_ids?: Array<string> | undefined;
|
|
90
90
|
/**
|
|
@@ -97,7 +97,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
97
97
|
override_guest_acs_entrance_ids?: Array<string> | undefined;
|
|
98
98
|
} | undefined;
|
|
99
99
|
/**
|
|
100
|
-
* Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://
|
|
100
|
+
* Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://www.seam.co/docs/device-and-system-integration-guides).
|
|
101
101
|
*/
|
|
102
102
|
code?: string | undefined;
|
|
103
103
|
/**
|
|
@@ -109,7 +109,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
109
109
|
*/
|
|
110
110
|
ends_at?: string | Date | Temporal.Instant | undefined;
|
|
111
111
|
/**
|
|
112
|
-
* Indicates whether the new credential is a [multi-phone sync credential](https://
|
|
112
|
+
* Indicates whether the new credential is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
|
|
113
113
|
*/
|
|
114
114
|
is_multi_phone_sync_credential?: boolean | undefined;
|
|
115
115
|
/**
|
|
@@ -117,7 +117,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
117
117
|
*/
|
|
118
118
|
salto_space_metadata?: {
|
|
119
119
|
/**
|
|
120
|
-
* Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://
|
|
120
|
+
* Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://www.seam.co/docs/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).
|
|
121
121
|
*/
|
|
122
122
|
assign_new_key?: boolean | undefined;
|
|
123
123
|
} | undefined;
|
|
@@ -83,7 +83,7 @@ export class SeamHttpAcsCredentials {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Assigns a specified [credential](https://
|
|
86
|
+
* Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
87
87
|
*/
|
|
88
88
|
assign(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpAcsCredentials {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Creates a new [credential](https://
|
|
102
|
+
* Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
|
|
103
103
|
*/
|
|
104
104
|
create(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -115,7 +115,7 @@ export class SeamHttpAcsCredentials {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Deletes a specified [credential](https://
|
|
118
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
119
119
|
*/
|
|
120
120
|
delete(parameters, options = {}) {
|
|
121
121
|
return new SeamHttpRequest(this, {
|
|
@@ -131,7 +131,7 @@ export class SeamHttpAcsCredentials {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Returns a specified [credential](https://
|
|
134
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
135
135
|
*/
|
|
136
136
|
get(parameters, options = {}) {
|
|
137
137
|
return new SeamHttpRequest(this, {
|
|
@@ -147,7 +147,7 @@ export class SeamHttpAcsCredentials {
|
|
|
147
147
|
});
|
|
148
148
|
}
|
|
149
149
|
/**
|
|
150
|
-
* Returns a list of all [credentials](https://
|
|
150
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
151
151
|
*/
|
|
152
152
|
list(parameters, options = {}) {
|
|
153
153
|
return new SeamHttpRequest(this, {
|
|
@@ -164,7 +164,7 @@ export class SeamHttpAcsCredentials {
|
|
|
164
164
|
});
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
|
-
* Returns a list of all [entrances](https://
|
|
167
|
+
* Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access.
|
|
168
168
|
*/
|
|
169
169
|
listAccessibleEntrances(parameters, options = {}) {
|
|
170
170
|
return new SeamHttpRequest(this, {
|
|
@@ -180,7 +180,7 @@ export class SeamHttpAcsCredentials {
|
|
|
180
180
|
});
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* Unassigns a specified [credential](https://
|
|
183
|
+
* Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
184
184
|
*/
|
|
185
185
|
unassign(parameters, options = {}) {
|
|
186
186
|
return new SeamHttpRequest(this, {
|
|
@@ -196,7 +196,7 @@ export class SeamHttpAcsCredentials {
|
|
|
196
196
|
});
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
199
|
+
* Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
200
200
|
*/
|
|
201
201
|
update(parameters, options = {}) {
|
|
202
202
|
return new SeamHttpRequest(this, {
|
|
@@ -19,23 +19,23 @@ export declare class SeamHttpAcsEncoders {
|
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
get simulate(): SeamHttpAcsEncodersSimulate;
|
|
21
21
|
/**
|
|
22
|
-
* Encodes an existing [credential](https://
|
|
22
|
+
* Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
|
|
23
23
|
*/
|
|
24
24
|
encodeCredential(parameters: AcsEncodersEncodeCredentialParameters, options?: AcsEncodersEncodeCredentialOptions): AcsEncodersEncodeCredentialRequest;
|
|
25
25
|
/**
|
|
26
|
-
* Returns a specified [encoder](https://
|
|
26
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
27
27
|
*/
|
|
28
28
|
get(parameters: AcsEncodersGetParameters, options?: AcsEncodersGetOptions): AcsEncodersGetRequest;
|
|
29
29
|
/**
|
|
30
|
-
* Returns a list of all [encoders](https://
|
|
30
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
31
31
|
*/
|
|
32
32
|
list(parameters?: AcsEncodersListParameters, options?: AcsEncodersListOptions): AcsEncodersListRequest;
|
|
33
33
|
/**
|
|
34
|
-
* Scans an encoded [acs_credential](https://
|
|
34
|
+
* Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
35
35
|
*/
|
|
36
36
|
scanCredential(parameters: AcsEncodersScanCredentialParameters, options?: AcsEncodersScanCredentialOptions): AcsEncodersScanCredentialRequest;
|
|
37
37
|
/**
|
|
38
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
38
|
+
* Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
|
|
39
39
|
*/
|
|
40
40
|
scanToAssignCredential(parameters: AcsEncodersScanToAssignCredentialParameters, options?: AcsEncodersScanToAssignCredentialOptions): AcsEncodersScanToAssignCredentialRequest;
|
|
41
41
|
}
|
|
@@ -88,7 +88,7 @@ export class SeamHttpAcsEncoders {
|
|
|
88
88
|
return SeamHttpAcsEncodersSimulate.fromClient(this.client, this.defaults);
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
|
-
* Encodes an existing [credential](https://
|
|
91
|
+
* Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
|
|
92
92
|
*/
|
|
93
93
|
encodeCredential(parameters, options = {}) {
|
|
94
94
|
return new SeamHttpRequest(this, {
|
|
@@ -108,7 +108,7 @@ export class SeamHttpAcsEncoders {
|
|
|
108
108
|
});
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
111
|
-
* Returns a specified [encoder](https://
|
|
111
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
112
112
|
*/
|
|
113
113
|
get(parameters, options = {}) {
|
|
114
114
|
return new SeamHttpRequest(this, {
|
|
@@ -124,7 +124,7 @@ export class SeamHttpAcsEncoders {
|
|
|
124
124
|
});
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* Returns a list of all [encoders](https://
|
|
127
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
128
128
|
*/
|
|
129
129
|
list(parameters, options = {}) {
|
|
130
130
|
return new SeamHttpRequest(this, {
|
|
@@ -141,7 +141,7 @@ export class SeamHttpAcsEncoders {
|
|
|
141
141
|
});
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* Scans an encoded [acs_credential](https://
|
|
144
|
+
* Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
145
145
|
*/
|
|
146
146
|
scanCredential(parameters, options = {}) {
|
|
147
147
|
return new SeamHttpRequest(this, {
|
|
@@ -161,7 +161,7 @@ export class SeamHttpAcsEncoders {
|
|
|
161
161
|
});
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
164
|
+
* Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
|
|
165
165
|
*/
|
|
166
166
|
scanToAssignCredential(parameters, options = {}) {
|
|
167
167
|
return new SeamHttpRequest(this, {
|
|
@@ -15,19 +15,19 @@ export declare class SeamHttpAcsEncodersSimulate {
|
|
|
15
15
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
16
16
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
17
17
|
/**
|
|
18
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
18
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
19
19
|
*/
|
|
20
20
|
nextCredentialEncodeWillFail(parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions): AcsEncodersSimulateNextCredentialEncodeWillFailRequest;
|
|
21
21
|
/**
|
|
22
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
22
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
23
23
|
*/
|
|
24
24
|
nextCredentialEncodeWillSucceed(parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions): AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest;
|
|
25
25
|
/**
|
|
26
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
26
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
27
27
|
*/
|
|
28
28
|
nextCredentialScanWillFail(parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, options?: AcsEncodersSimulateNextCredentialScanWillFailOptions): AcsEncodersSimulateNextCredentialScanWillFailRequest;
|
|
29
29
|
/**
|
|
30
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
30
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
31
31
|
*/
|
|
32
32
|
nextCredentialScanWillSucceed(parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions): AcsEncodersSimulateNextCredentialScanWillSucceedRequest;
|
|
33
33
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
86
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
87
87
|
*/
|
|
88
88
|
nextCredentialEncodeWillFail(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
102
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
103
103
|
*/
|
|
104
104
|
nextCredentialEncodeWillSucceed(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -115,7 +115,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
118
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
119
119
|
*/
|
|
120
120
|
nextCredentialScanWillFail(parameters, options = {}) {
|
|
121
121
|
return new SeamHttpRequest(this, {
|
|
@@ -131,7 +131,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
134
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
135
135
|
*/
|
|
136
136
|
nextCredentialScanWillSucceed(parameters, options = {}) {
|
|
137
137
|
return new SeamHttpRequest(this, {
|
|
@@ -18,23 +18,23 @@ export declare class SeamHttpAcsEntrances {
|
|
|
18
18
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
/**
|
|
21
|
-
* Returns a specified [access system entrance](https://
|
|
21
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
22
22
|
*/
|
|
23
23
|
get(parameters: AcsEntrancesGetParameters, options?: AcsEntrancesGetOptions): AcsEntrancesGetRequest;
|
|
24
24
|
/**
|
|
25
|
-
* Grants a specified [access system user](https://
|
|
25
|
+
* Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
26
26
|
*/
|
|
27
27
|
grantAccess(parameters: AcsEntrancesGrantAccessParameters, options?: AcsEntrancesGrantAccessOptions): AcsEntrancesGrantAccessRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Returns a list of all [access system entrances](https://
|
|
29
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
30
30
|
*/
|
|
31
31
|
list(parameters?: AcsEntrancesListParameters, options?: AcsEntrancesListOptions): AcsEntrancesListRequest;
|
|
32
32
|
/**
|
|
33
|
-
* Returns a list of all [credentials](https://
|
|
33
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
34
34
|
*/
|
|
35
35
|
listCredentialsWithAccess(parameters: AcsEntrancesListCredentialsWithAccessParameters, options?: AcsEntrancesListCredentialsWithAccessOptions): AcsEntrancesListCredentialsWithAccessRequest;
|
|
36
36
|
/**
|
|
37
|
-
* Remotely unlocks a specified [entrance](https://
|
|
37
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
|
|
38
38
|
*/
|
|
39
39
|
unlock(parameters: AcsEntrancesUnlockParameters, options?: AcsEntrancesUnlockOptions): AcsEntrancesUnlockRequest;
|
|
40
40
|
}
|
|
@@ -84,7 +84,7 @@ export class SeamHttpAcsEntrances {
|
|
|
84
84
|
await clientSessions.get();
|
|
85
85
|
}
|
|
86
86
|
/**
|
|
87
|
-
* Returns a specified [access system entrance](https://
|
|
87
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
88
88
|
*/
|
|
89
89
|
get(parameters, options = {}) {
|
|
90
90
|
return new SeamHttpRequest(this, {
|
|
@@ -100,7 +100,7 @@ export class SeamHttpAcsEntrances {
|
|
|
100
100
|
});
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
|
-
* Grants a specified [access system user](https://
|
|
103
|
+
* Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
104
104
|
*/
|
|
105
105
|
grantAccess(parameters, options = {}) {
|
|
106
106
|
return new SeamHttpRequest(this, {
|
|
@@ -116,7 +116,7 @@ export class SeamHttpAcsEntrances {
|
|
|
116
116
|
});
|
|
117
117
|
}
|
|
118
118
|
/**
|
|
119
|
-
* Returns a list of all [access system entrances](https://
|
|
119
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
120
120
|
*/
|
|
121
121
|
list(parameters, options = {}) {
|
|
122
122
|
return new SeamHttpRequest(this, {
|
|
@@ -133,7 +133,7 @@ export class SeamHttpAcsEntrances {
|
|
|
133
133
|
});
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* Returns a list of all [credentials](https://
|
|
136
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
137
137
|
*/
|
|
138
138
|
listCredentialsWithAccess(parameters, options = {}) {
|
|
139
139
|
return new SeamHttpRequest(this, {
|
|
@@ -149,7 +149,7 @@ export class SeamHttpAcsEntrances {
|
|
|
149
149
|
});
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* Remotely unlocks a specified [entrance](https://
|
|
152
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
|
|
153
153
|
*/
|
|
154
154
|
unlock(parameters, options = {}) {
|
|
155
155
|
return new SeamHttpRequest(this, {
|
|
@@ -16,17 +16,17 @@ export declare class SeamHttpAcsSystems {
|
|
|
16
16
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
|
-
* Returns a specified [access system](https://
|
|
19
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
20
20
|
*/
|
|
21
21
|
get(parameters: AcsSystemsGetParameters, options?: AcsSystemsGetOptions): AcsSystemsGetRequest;
|
|
22
22
|
/**
|
|
23
|
-
* Returns a list of all [access systems](https://
|
|
23
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
24
24
|
*
|
|
25
25
|
* To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
|
|
26
26
|
*/
|
|
27
27
|
list(parameters?: AcsSystemsListParameters, options?: AcsSystemsListOptions): AcsSystemsListRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
29
|
+
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
30
30
|
*
|
|
31
31
|
* Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
|
|
32
32
|
*/
|
|
@@ -83,7 +83,7 @@ export class SeamHttpAcsSystems {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Returns a specified [access system](https://
|
|
86
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
87
87
|
*/
|
|
88
88
|
get(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpAcsSystems {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Returns a list of all [access systems](https://
|
|
102
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
103
103
|
*
|
|
104
104
|
* To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
|
|
105
105
|
*/
|
|
@@ -117,7 +117,7 @@ export class SeamHttpAcsSystems {
|
|
|
117
117
|
});
|
|
118
118
|
}
|
|
119
119
|
/**
|
|
120
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
120
|
+
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
121
121
|
*
|
|
122
122
|
* Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
|
|
123
123
|
*/
|
|
@@ -18,47 +18,47 @@ export declare class SeamHttpAcsUsers {
|
|
|
18
18
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
/**
|
|
21
|
-
* Adds a specified [access system user](https://
|
|
21
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
22
22
|
*/
|
|
23
23
|
addToAccessGroup(parameters: AcsUsersAddToAccessGroupParameters, options?: AcsUsersAddToAccessGroupOptions): AcsUsersAddToAccessGroupRequest;
|
|
24
24
|
/**
|
|
25
|
-
* Creates a new [access system user](https://
|
|
25
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
26
26
|
*/
|
|
27
27
|
create(parameters: AcsUsersCreateParameters, options?: AcsUsersCreateOptions): AcsUsersCreateRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Deletes a specified [access system user](https://
|
|
29
|
+
* Deletes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
30
30
|
*/
|
|
31
31
|
delete(parameters: AcsUsersDeleteParameters, options?: AcsUsersDeleteOptions): AcsUsersDeleteRequest;
|
|
32
32
|
/**
|
|
33
|
-
* Returns a specified [access system user](https://
|
|
33
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
34
34
|
*/
|
|
35
35
|
get(parameters: AcsUsersGetParameters, options?: AcsUsersGetOptions): AcsUsersGetRequest;
|
|
36
36
|
/**
|
|
37
|
-
* Returns a list of all [access system users](https://
|
|
37
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
38
38
|
*/
|
|
39
39
|
list(parameters?: AcsUsersListParameters, options?: AcsUsersListOptions): AcsUsersListRequest;
|
|
40
40
|
/**
|
|
41
|
-
* Lists the [entrances](https://
|
|
41
|
+
* Lists the [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) has access.
|
|
42
42
|
*/
|
|
43
43
|
listAccessibleEntrances(parameters: AcsUsersListAccessibleEntrancesParameters, options?: AcsUsersListAccessibleEntrancesOptions): AcsUsersListAccessibleEntrancesRequest;
|
|
44
44
|
/**
|
|
45
|
-
* Removes a specified [access system user](https://
|
|
45
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
46
46
|
*/
|
|
47
47
|
removeFromAccessGroup(parameters: AcsUsersRemoveFromAccessGroupParameters, options?: AcsUsersRemoveFromAccessGroupOptions): AcsUsersRemoveFromAccessGroupRequest;
|
|
48
48
|
/**
|
|
49
|
-
* Revokes access to all [entrances](https://
|
|
49
|
+
* Revokes access to all [entrances](https://www.seam.co/docs/api/acs/entrances/object) for a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
50
50
|
*/
|
|
51
51
|
revokeAccessToAllEntrances(parameters: AcsUsersRevokeAccessToAllEntrancesParameters, options?: AcsUsersRevokeAccessToAllEntrancesOptions): AcsUsersRevokeAccessToAllEntrancesRequest;
|
|
52
52
|
/**
|
|
53
|
-
* [Suspends](https://
|
|
53
|
+
* [Suspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://www.seam.co/docs/api/acs/users/unsuspend) them.
|
|
54
54
|
*/
|
|
55
55
|
suspend(parameters: AcsUsersSuspendParameters, options?: AcsUsersSuspendOptions): AcsUsersSuspendRequest;
|
|
56
56
|
/**
|
|
57
|
-
* [Unsuspends](https://
|
|
57
|
+
* [Unsuspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). While [suspending an access system user](https://www.seam.co/docs/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
|
|
58
58
|
*/
|
|
59
59
|
unsuspend(parameters: AcsUsersUnsuspendParameters, options?: AcsUsersUnsuspendOptions): AcsUsersUnsuspendRequest;
|
|
60
60
|
/**
|
|
61
|
-
* Updates the properties of a specified [access system user](https://
|
|
61
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
62
62
|
*/
|
|
63
63
|
update(parameters: AcsUsersUpdateParameters, options?: AcsUsersUpdateOptions): AcsUsersUpdateRequest;
|
|
64
64
|
}
|
|
@@ -106,7 +106,7 @@ export type AcsUsersCreateParameters = {
|
|
|
106
106
|
*/
|
|
107
107
|
email?: string | undefined;
|
|
108
108
|
/**
|
|
109
|
-
* Email address of the [access system user](https://
|
|
109
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
110
110
|
*/
|
|
111
111
|
email_address?: string | undefined;
|
|
112
112
|
/**
|
|
@@ -114,7 +114,7 @@ export type AcsUsersCreateParameters = {
|
|
|
114
114
|
*/
|
|
115
115
|
full_name: string;
|
|
116
116
|
/**
|
|
117
|
-
* Phone number of the [access system user](https://
|
|
117
|
+
* 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`).
|
|
118
118
|
*/
|
|
119
119
|
phone_number?: string | undefined;
|
|
120
120
|
/**
|
|
@@ -352,11 +352,11 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<{
|
|
|
352
352
|
*/
|
|
353
353
|
email?: string | undefined;
|
|
354
354
|
/**
|
|
355
|
-
* Email address of the [access system user](https://
|
|
355
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
356
356
|
*/
|
|
357
357
|
email_address?: string | undefined;
|
|
358
358
|
/**
|
|
359
|
-
* Full name of the [access system user](https://
|
|
359
|
+
* Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
360
360
|
*/
|
|
361
361
|
full_name?: string | undefined;
|
|
362
362
|
/**
|
|
@@ -364,7 +364,7 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<{
|
|
|
364
364
|
*/
|
|
365
365
|
hid_acs_system_id?: string | undefined;
|
|
366
366
|
/**
|
|
367
|
-
* Phone number of the [access system user](https://
|
|
367
|
+
* 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`).
|
|
368
368
|
*/
|
|
369
369
|
phone_number?: string | undefined;
|
|
370
370
|
/**
|