@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
|
@@ -174,7 +174,7 @@ export class SeamHttpAccessCodes {
|
|
|
174
174
|
}
|
|
175
175
|
|
|
176
176
|
/**
|
|
177
|
-
* Creates a new [access code](https://
|
|
177
|
+
* Creates a new [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
|
|
178
178
|
*/
|
|
179
179
|
create(
|
|
180
180
|
parameters: AccessCodesCreateParameters,
|
|
@@ -194,7 +194,7 @@ export class SeamHttpAccessCodes {
|
|
|
194
194
|
}
|
|
195
195
|
|
|
196
196
|
/**
|
|
197
|
-
* Creates new [access codes](https://
|
|
197
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
198
198
|
*
|
|
199
199
|
* Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
|
|
200
200
|
*
|
|
@@ -202,9 +202,9 @@ export class SeamHttpAccessCodes {
|
|
|
202
202
|
*
|
|
203
203
|
* If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
|
|
204
204
|
*
|
|
205
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
205
|
+
* See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
|
|
206
206
|
*
|
|
207
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
207
|
+
* For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
208
208
|
*/
|
|
209
209
|
createMultiple(
|
|
210
210
|
parameters: AccessCodesCreateMultipleParameters,
|
|
@@ -224,7 +224,7 @@ export class SeamHttpAccessCodes {
|
|
|
224
224
|
}
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
|
-
* Deletes an [access code](https://
|
|
227
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
228
228
|
*/
|
|
229
229
|
delete(
|
|
230
230
|
parameters: AccessCodesDeleteParameters,
|
|
@@ -244,7 +244,7 @@ export class SeamHttpAccessCodes {
|
|
|
244
244
|
}
|
|
245
245
|
|
|
246
246
|
/**
|
|
247
|
-
* Generates a code for an [access code](https://
|
|
247
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
248
248
|
*/
|
|
249
249
|
generateCode(
|
|
250
250
|
parameters: AccessCodesGenerateCodeParameters,
|
|
@@ -264,7 +264,7 @@ export class SeamHttpAccessCodes {
|
|
|
264
264
|
}
|
|
265
265
|
|
|
266
266
|
/**
|
|
267
|
-
* Returns a specified [access code](https://
|
|
267
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
268
268
|
*
|
|
269
269
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
270
270
|
*/
|
|
@@ -286,7 +286,7 @@ export class SeamHttpAccessCodes {
|
|
|
286
286
|
}
|
|
287
287
|
|
|
288
288
|
/**
|
|
289
|
-
* Returns a list of all [access codes](https://
|
|
289
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
290
290
|
*
|
|
291
291
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
292
292
|
*/
|
|
@@ -318,7 +318,7 @@ export class SeamHttpAccessCodes {
|
|
|
318
318
|
}
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
|
-
* Retrieves a backup access code for an [access code](https://
|
|
321
|
+
* Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
|
|
322
322
|
*
|
|
323
323
|
* A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
|
|
324
324
|
*
|
|
@@ -368,9 +368,9 @@ export class SeamHttpAccessCodes {
|
|
|
368
368
|
}
|
|
369
369
|
|
|
370
370
|
/**
|
|
371
|
-
* Updates a specified active or upcoming [access code](https://
|
|
371
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
372
372
|
*
|
|
373
|
-
* See also [Modifying Access Codes](https://
|
|
373
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
374
374
|
*/
|
|
375
375
|
update(
|
|
376
376
|
parameters: AccessCodesUpdateParameters,
|
|
@@ -390,11 +390,11 @@ export class SeamHttpAccessCodes {
|
|
|
390
390
|
}
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
|
-
* Updates [access codes](https://
|
|
393
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
394
394
|
*
|
|
395
395
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
396
396
|
*
|
|
397
|
-
* See also [Update Linked Access Codes](https://
|
|
397
|
+
* See also [Update Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
|
|
398
398
|
*/
|
|
399
399
|
updateMultiple(
|
|
400
400
|
parameters: AccessCodesUpdateMultipleParameters,
|
|
@@ -416,7 +416,7 @@ export class SeamHttpAccessCodes {
|
|
|
416
416
|
|
|
417
417
|
export type AccessCodesCreateParameters = {
|
|
418
418
|
/**
|
|
419
|
-
* Indicates whether [external modification](https://
|
|
419
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
420
420
|
*/
|
|
421
421
|
allow_external_modification?: boolean | undefined
|
|
422
422
|
|
|
@@ -426,7 +426,7 @@ export type AccessCodesCreateParameters = {
|
|
|
426
426
|
*/
|
|
427
427
|
code?: string | undefined
|
|
428
428
|
/**
|
|
429
|
-
* Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
429
|
+
* Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
|
|
430
430
|
*/
|
|
431
431
|
common_code_key?: string | undefined
|
|
432
432
|
/**
|
|
@@ -439,19 +439,19 @@ export type AccessCodesCreateParameters = {
|
|
|
439
439
|
*/
|
|
440
440
|
ends_at?: string | undefined
|
|
441
441
|
/**
|
|
442
|
-
* Indicates whether [external modification](https://
|
|
442
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
443
443
|
*/
|
|
444
444
|
is_external_modification_allowed?: boolean | undefined
|
|
445
445
|
/**
|
|
446
|
-
* Indicates whether the access code is an [offline access code](https://
|
|
446
|
+
* Indicates whether the access code is an [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes).
|
|
447
447
|
*/
|
|
448
448
|
is_offline_access_code?: boolean | undefined
|
|
449
449
|
/**
|
|
450
|
-
* Indicates whether the [offline access code](https://
|
|
450
|
+
* Indicates whether the [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
|
|
451
451
|
*/
|
|
452
452
|
is_one_time_use?: boolean | undefined
|
|
453
453
|
/**
|
|
454
|
-
* Maximum rounding adjustment. To create a daily-bound [offline access code](https://
|
|
454
|
+
* Maximum rounding adjustment. To create a daily-bound [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
|
|
455
455
|
*/
|
|
456
456
|
max_time_rounding?: '1hour' | '1day' | '1h' | '1d' | undefined
|
|
457
457
|
/**
|
|
@@ -465,7 +465,7 @@ export type AccessCodesCreateParameters = {
|
|
|
465
465
|
*/
|
|
466
466
|
name?: string | undefined
|
|
467
467
|
/**
|
|
468
|
-
* Indicates whether [native scheduling](https://
|
|
468
|
+
* Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
|
|
469
469
|
*/
|
|
470
470
|
prefer_native_scheduling?: boolean | undefined
|
|
471
471
|
/**
|
|
@@ -477,7 +477,7 @@ export type AccessCodesCreateParameters = {
|
|
|
477
477
|
*/
|
|
478
478
|
starts_at?: string | undefined
|
|
479
479
|
/**
|
|
480
|
-
* Indicates whether to use a [backup access code pool](https://
|
|
480
|
+
* Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
|
|
481
481
|
*/
|
|
482
482
|
use_backup_access_code_pool?: boolean | undefined
|
|
483
483
|
/**
|
|
@@ -500,7 +500,7 @@ export interface AccessCodesCreateOptions {}
|
|
|
500
500
|
|
|
501
501
|
export type AccessCodesCreateMultipleParameters = {
|
|
502
502
|
/**
|
|
503
|
-
* Indicates whether [external modification](https://
|
|
503
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
504
504
|
*/
|
|
505
505
|
allow_external_modification?: boolean | undefined
|
|
506
506
|
|
|
@@ -524,7 +524,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
524
524
|
*/
|
|
525
525
|
ends_at?: string | undefined
|
|
526
526
|
/**
|
|
527
|
-
* Indicates whether [external modification](https://
|
|
527
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
528
528
|
*/
|
|
529
529
|
is_external_modification_allowed?: boolean | undefined
|
|
530
530
|
/**
|
|
@@ -538,7 +538,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
538
538
|
*/
|
|
539
539
|
name?: string | undefined
|
|
540
540
|
/**
|
|
541
|
-
* Indicates whether [native scheduling](https://
|
|
541
|
+
* Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
|
|
542
542
|
*/
|
|
543
543
|
prefer_native_scheduling?: boolean | undefined
|
|
544
544
|
/**
|
|
@@ -550,7 +550,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
550
550
|
*/
|
|
551
551
|
starts_at?: string | undefined
|
|
552
552
|
/**
|
|
553
|
-
* Indicates whether to use a [backup access code pool](https://
|
|
553
|
+
* Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
|
|
554
554
|
*/
|
|
555
555
|
use_backup_access_code_pool?: boolean | undefined
|
|
556
556
|
}
|
|
@@ -764,7 +764,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
764
764
|
access_code_id: string
|
|
765
765
|
|
|
766
766
|
/**
|
|
767
|
-
* Indicates whether [external modification](https://
|
|
767
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
768
768
|
*/
|
|
769
769
|
allow_external_modification?: boolean | undefined
|
|
770
770
|
|
|
@@ -782,7 +782,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
782
782
|
*/
|
|
783
783
|
ends_at?: string | undefined
|
|
784
784
|
/**
|
|
785
|
-
* Indicates whether [external modification](https://
|
|
785
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
786
786
|
*/
|
|
787
787
|
is_external_modification_allowed?: boolean | undefined
|
|
788
788
|
/**
|
|
@@ -804,7 +804,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
804
804
|
*/
|
|
805
805
|
starts_at?: string | undefined
|
|
806
806
|
/**
|
|
807
|
-
* Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://
|
|
807
|
+
* Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
|
|
808
808
|
*/
|
|
809
809
|
type?: 'ongoing' | 'time_bound' | undefined
|
|
810
810
|
}
|
|
@@ -162,7 +162,7 @@ export class SeamHttpAccessCodesSimulate {
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
165
|
+
* Simulates the creation of an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
166
166
|
*/
|
|
167
167
|
createUnmanagedAccessCode(
|
|
168
168
|
parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
|
|
@@ -163,7 +163,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
163
163
|
}
|
|
164
164
|
|
|
165
165
|
/**
|
|
166
|
-
* Converts an [unmanaged access code](https://
|
|
166
|
+
* Converts an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
167
167
|
*
|
|
168
168
|
* An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
|
|
169
169
|
*
|
|
@@ -187,7 +187,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
187
187
|
}
|
|
188
188
|
|
|
189
189
|
/**
|
|
190
|
-
* Deletes an [unmanaged access code](https://
|
|
190
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
191
191
|
*/
|
|
192
192
|
delete(
|
|
193
193
|
parameters: AccessCodesUnmanagedDeleteParameters,
|
|
@@ -207,7 +207,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
207
207
|
}
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
|
-
* Returns a specified [unmanaged access code](https://
|
|
210
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
211
211
|
*
|
|
212
212
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
213
213
|
*/
|
|
@@ -229,7 +229,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
229
229
|
}
|
|
230
230
|
|
|
231
231
|
/**
|
|
232
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
232
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
233
233
|
*/
|
|
234
234
|
list(
|
|
235
235
|
parameters: AccessCodesUnmanagedListParameters,
|
|
@@ -250,7 +250,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
250
250
|
}
|
|
251
251
|
|
|
252
252
|
/**
|
|
253
|
-
* Updates a specified [unmanaged access code](https://
|
|
253
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
254
254
|
*/
|
|
255
255
|
update(
|
|
256
256
|
parameters: AccessCodesUnmanagedUpdateParameters,
|
|
@@ -277,7 +277,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = {
|
|
|
277
277
|
access_code_id: string
|
|
278
278
|
|
|
279
279
|
/**
|
|
280
|
-
* Indicates whether [external modification](https://
|
|
280
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
|
|
281
281
|
*/
|
|
282
282
|
allow_external_modification?: boolean | undefined
|
|
283
283
|
/**
|
|
@@ -285,7 +285,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = {
|
|
|
285
285
|
*/
|
|
286
286
|
force?: boolean | undefined
|
|
287
287
|
/**
|
|
288
|
-
* Indicates whether [external modification](https://
|
|
288
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
|
|
289
289
|
*/
|
|
290
290
|
is_external_modification_allowed?: boolean | undefined
|
|
291
291
|
}
|
|
@@ -395,7 +395,7 @@ export type AccessCodesUnmanagedUpdateParameters = {
|
|
|
395
395
|
access_code_id: string
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
|
-
* Indicates whether [external modification](https://
|
|
398
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
|
|
399
399
|
*/
|
|
400
400
|
allow_external_modification?: boolean | undefined
|
|
401
401
|
/**
|
|
@@ -403,7 +403,7 @@ export type AccessCodesUnmanagedUpdateParameters = {
|
|
|
403
403
|
*/
|
|
404
404
|
force?: boolean | undefined
|
|
405
405
|
/**
|
|
406
|
-
* Indicates whether [external modification](https://
|
|
406
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
|
|
407
407
|
*/
|
|
408
408
|
is_external_modification_allowed?: boolean | undefined
|
|
409
409
|
|
|
@@ -170,7 +170,7 @@ export class SeamHttpAccessGrants {
|
|
|
170
170
|
}
|
|
171
171
|
|
|
172
172
|
/**
|
|
173
|
-
* Creates a new [Access Grant](https://
|
|
173
|
+
* Creates a new [Access Grant](https://www.seam.co/docs/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
|
|
174
174
|
*/
|
|
175
175
|
create(
|
|
176
176
|
parameters: AccessGrantsCreateParameters,
|
|
@@ -328,7 +328,7 @@ export type AccessGrantsCreateParameters = {
|
|
|
328
328
|
*/
|
|
329
329
|
access_grant_key?: string | undefined
|
|
330
330
|
/**
|
|
331
|
-
* Set of IDs of the [entrances](https://
|
|
331
|
+
* Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted.
|
|
332
332
|
*/
|
|
333
333
|
acs_entrance_ids?: Array<string> | undefined
|
|
334
334
|
/**
|
|
@@ -336,7 +336,7 @@ export type AccessGrantsCreateParameters = {
|
|
|
336
336
|
*/
|
|
337
337
|
customization_profile_id?: string | undefined
|
|
338
338
|
/**
|
|
339
|
-
* Set of IDs of the [devices](https://
|
|
339
|
+
* Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted.
|
|
340
340
|
*/
|
|
341
341
|
device_ids?: Array<string> | undefined
|
|
342
342
|
/**
|
|
@@ -221,7 +221,7 @@ export class SeamHttpAccessMethods {
|
|
|
221
221
|
}
|
|
222
222
|
|
|
223
223
|
/**
|
|
224
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
224
|
+
* Encodes an existing access method 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).
|
|
225
225
|
*/
|
|
226
226
|
encode(
|
|
227
227
|
parameters: AccessMethodsEncodeParameters,
|
|
@@ -314,7 +314,7 @@ export class SeamHttpAccessMethods {
|
|
|
314
314
|
}
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
|
-
* Remotely unlocks a specified [entrance](https://
|
|
317
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
|
|
318
318
|
*/
|
|
319
319
|
unlockDoor(
|
|
320
320
|
parameters: AccessMethodsUnlockDoorParameters,
|
|
@@ -164,7 +164,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
164
164
|
}
|
|
165
165
|
|
|
166
166
|
/**
|
|
167
|
-
* Adds a specified [access system user](https://
|
|
167
|
+
* 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).
|
|
168
168
|
*/
|
|
169
169
|
addUser(
|
|
170
170
|
parameters: AcsAccessGroupsAddUserParameters,
|
|
@@ -184,7 +184,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
184
184
|
}
|
|
185
185
|
|
|
186
186
|
/**
|
|
187
|
-
* Deletes a specified [access group](https://
|
|
187
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
188
188
|
*/
|
|
189
189
|
delete(
|
|
190
190
|
parameters: AcsAccessGroupsDeleteParameters,
|
|
@@ -204,7 +204,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
204
204
|
}
|
|
205
205
|
|
|
206
206
|
/**
|
|
207
|
-
* Returns a specified [access group](https://
|
|
207
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
208
208
|
*/
|
|
209
209
|
get(
|
|
210
210
|
parameters: AcsAccessGroupsGetParameters,
|
|
@@ -224,7 +224,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
224
224
|
}
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
|
-
* Returns a list of all [access groups](https://
|
|
227
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
228
228
|
*/
|
|
229
229
|
list(
|
|
230
230
|
parameters?: AcsAccessGroupsListParameters,
|
|
@@ -244,7 +244,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
244
244
|
}
|
|
245
245
|
|
|
246
246
|
/**
|
|
247
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
247
|
+
* 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).
|
|
248
248
|
*/
|
|
249
249
|
listAccessibleEntrances(
|
|
250
250
|
parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
|
|
@@ -264,7 +264,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
264
264
|
}
|
|
265
265
|
|
|
266
266
|
/**
|
|
267
|
-
* Returns a list of all [access system users](https://
|
|
267
|
+
* 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).
|
|
268
268
|
*/
|
|
269
269
|
listUsers(
|
|
270
270
|
parameters: AcsAccessGroupsListUsersParameters,
|
|
@@ -284,7 +284,7 @@ export class SeamHttpAcsAccessGroups {
|
|
|
284
284
|
}
|
|
285
285
|
|
|
286
286
|
/**
|
|
287
|
-
* Removes a specified [access system user](https://
|
|
287
|
+
* 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).
|
|
288
288
|
*/
|
|
289
289
|
removeUser(
|
|
290
290
|
parameters: AcsAccessGroupsRemoveUserParameters,
|
|
@@ -163,7 +163,7 @@ export class SeamHttpAcsCredentials {
|
|
|
163
163
|
}
|
|
164
164
|
|
|
165
165
|
/**
|
|
166
|
-
* Assigns a specified [credential](https://
|
|
166
|
+
* 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).
|
|
167
167
|
*/
|
|
168
168
|
assign(
|
|
169
169
|
parameters: AcsCredentialsAssignParameters,
|
|
@@ -183,7 +183,7 @@ export class SeamHttpAcsCredentials {
|
|
|
183
183
|
}
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
|
-
* Creates a new [credential](https://
|
|
186
|
+
* 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.
|
|
187
187
|
*/
|
|
188
188
|
create(
|
|
189
189
|
parameters: AcsCredentialsCreateParameters,
|
|
@@ -203,7 +203,7 @@ export class SeamHttpAcsCredentials {
|
|
|
203
203
|
}
|
|
204
204
|
|
|
205
205
|
/**
|
|
206
|
-
* Deletes a specified [credential](https://
|
|
206
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
207
207
|
*/
|
|
208
208
|
delete(
|
|
209
209
|
parameters: AcsCredentialsDeleteParameters,
|
|
@@ -223,7 +223,7 @@ export class SeamHttpAcsCredentials {
|
|
|
223
223
|
}
|
|
224
224
|
|
|
225
225
|
/**
|
|
226
|
-
* Returns a specified [credential](https://
|
|
226
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
227
227
|
*/
|
|
228
228
|
get(
|
|
229
229
|
parameters: AcsCredentialsGetParameters,
|
|
@@ -243,7 +243,7 @@ export class SeamHttpAcsCredentials {
|
|
|
243
243
|
}
|
|
244
244
|
|
|
245
245
|
/**
|
|
246
|
-
* Returns a list of all [credentials](https://
|
|
246
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
247
247
|
*/
|
|
248
248
|
list(
|
|
249
249
|
parameters?: AcsCredentialsListParameters,
|
|
@@ -264,7 +264,7 @@ export class SeamHttpAcsCredentials {
|
|
|
264
264
|
}
|
|
265
265
|
|
|
266
266
|
/**
|
|
267
|
-
* Returns a list of all [entrances](https://
|
|
267
|
+
* 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.
|
|
268
268
|
*/
|
|
269
269
|
listAccessibleEntrances(
|
|
270
270
|
parameters: AcsCredentialsListAccessibleEntrancesParameters,
|
|
@@ -284,7 +284,7 @@ export class SeamHttpAcsCredentials {
|
|
|
284
284
|
}
|
|
285
285
|
|
|
286
286
|
/**
|
|
287
|
-
* Unassigns a specified [credential](https://
|
|
287
|
+
* 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).
|
|
288
288
|
*/
|
|
289
289
|
unassign(
|
|
290
290
|
parameters: AcsCredentialsUnassignParameters,
|
|
@@ -304,7 +304,7 @@ export class SeamHttpAcsCredentials {
|
|
|
304
304
|
}
|
|
305
305
|
|
|
306
306
|
/**
|
|
307
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
307
|
+
* 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).
|
|
308
308
|
*/
|
|
309
309
|
update(
|
|
310
310
|
parameters: AcsCredentialsUpdateParameters,
|
|
@@ -364,7 +364,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
364
364
|
*/
|
|
365
365
|
acs_user_id?: string | undefined
|
|
366
366
|
/**
|
|
367
|
-
* Set of IDs of the [entrances](https://
|
|
367
|
+
* 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.
|
|
368
368
|
*/
|
|
369
369
|
allowed_acs_entrance_ids?: Array<string> | undefined
|
|
370
370
|
/**
|
|
@@ -382,7 +382,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
382
382
|
}
|
|
383
383
|
| undefined
|
|
384
384
|
/**
|
|
385
|
-
* 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://
|
|
385
|
+
* 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).
|
|
386
386
|
*/
|
|
387
387
|
code?: string | undefined
|
|
388
388
|
/**
|
|
@@ -394,7 +394,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
394
394
|
*/
|
|
395
395
|
ends_at?: string | Date | Temporal.Instant | undefined
|
|
396
396
|
/**
|
|
397
|
-
* Indicates whether the new credential is a [multi-phone sync credential](https://
|
|
397
|
+
* 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).
|
|
398
398
|
*/
|
|
399
399
|
is_multi_phone_sync_credential?: boolean | undefined
|
|
400
400
|
/**
|
|
@@ -403,7 +403,7 @@ export type AcsCredentialsCreateParameters = {
|
|
|
403
403
|
salto_space_metadata?:
|
|
404
404
|
| {
|
|
405
405
|
/**
|
|
406
|
-
* Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://
|
|
406
|
+
* 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).
|
|
407
407
|
*/
|
|
408
408
|
assign_new_key?: boolean | undefined
|
|
409
409
|
}
|
|
@@ -170,7 +170,7 @@ export class SeamHttpAcsEncoders {
|
|
|
170
170
|
}
|
|
171
171
|
|
|
172
172
|
/**
|
|
173
|
-
* Encodes an existing [credential](https://
|
|
173
|
+
* 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`
|
|
174
174
|
*/
|
|
175
175
|
encodeCredential(
|
|
176
176
|
parameters: AcsEncodersEncodeCredentialParameters,
|
|
@@ -195,7 +195,7 @@ export class SeamHttpAcsEncoders {
|
|
|
195
195
|
}
|
|
196
196
|
|
|
197
197
|
/**
|
|
198
|
-
* Returns a specified [encoder](https://
|
|
198
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
199
199
|
*/
|
|
200
200
|
get(
|
|
201
201
|
parameters: AcsEncodersGetParameters,
|
|
@@ -215,7 +215,7 @@ export class SeamHttpAcsEncoders {
|
|
|
215
215
|
}
|
|
216
216
|
|
|
217
217
|
/**
|
|
218
|
-
* Returns a list of all [encoders](https://
|
|
218
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
219
219
|
*/
|
|
220
220
|
list(
|
|
221
221
|
parameters?: AcsEncodersListParameters,
|
|
@@ -236,7 +236,7 @@ export class SeamHttpAcsEncoders {
|
|
|
236
236
|
}
|
|
237
237
|
|
|
238
238
|
/**
|
|
239
|
-
* Scans an encoded [acs_credential](https://
|
|
239
|
+
* 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).
|
|
240
240
|
*/
|
|
241
241
|
scanCredential(
|
|
242
242
|
parameters: AcsEncodersScanCredentialParameters,
|
|
@@ -261,7 +261,7 @@ export class SeamHttpAcsEncoders {
|
|
|
261
261
|
}
|
|
262
262
|
|
|
263
263
|
/**
|
|
264
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
264
|
+
* 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`.
|
|
265
265
|
*/
|
|
266
266
|
scanToAssignCredential(
|
|
267
267
|
parameters: AcsEncodersScanToAssignCredentialParameters,
|
|
@@ -161,7 +161,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
161
161
|
}
|
|
162
162
|
|
|
163
163
|
/**
|
|
164
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
164
|
+
* 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).
|
|
165
165
|
*/
|
|
166
166
|
nextCredentialEncodeWillFail(
|
|
167
167
|
parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
|
|
@@ -181,7 +181,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
181
181
|
}
|
|
182
182
|
|
|
183
183
|
/**
|
|
184
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
184
|
+
* 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).
|
|
185
185
|
*/
|
|
186
186
|
nextCredentialEncodeWillSucceed(
|
|
187
187
|
parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
|
|
@@ -201,7 +201,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
201
201
|
}
|
|
202
202
|
|
|
203
203
|
/**
|
|
204
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
204
|
+
* 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).
|
|
205
205
|
*/
|
|
206
206
|
nextCredentialScanWillFail(
|
|
207
207
|
parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
|
|
@@ -221,7 +221,7 @@ export class SeamHttpAcsEncodersSimulate {
|
|
|
221
221
|
}
|
|
222
222
|
|
|
223
223
|
/**
|
|
224
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
224
|
+
* 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).
|
|
225
225
|
*/
|
|
226
226
|
nextCredentialScanWillSucceed(
|
|
227
227
|
parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
|