@seamapi/types 1.929.0 → 1.931.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/dist/connect.cjs +42 -42
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +211 -211
- package/dist/index.cjs +42 -42
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +16 -16
- package/lib/seam/connect/models/access-codes/managed-access-code.js +5 -5
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -5
- package/lib/seam/connect/models/acs/acs-credential.js +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +4 -4
- package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -1
- package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
- package/lib/seam/connect/openapi.js +29 -29
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +198 -198
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +5 -5
- package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-system.ts +4 -4
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -1
- package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +29 -29
- package/src/lib/seam/connect/route-types.ts +198 -198
package/package.json
CHANGED
|
@@ -268,14 +268,14 @@ const code_modified_external_to_seam_warning = common_access_code_warning
|
|
|
268
268
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
269
269
|
)
|
|
270
270
|
|
|
271
|
-
const
|
|
271
|
+
const code_rotates_periodically = common_access_code_warning
|
|
272
272
|
.extend({
|
|
273
273
|
warning_code: z
|
|
274
|
-
.literal('
|
|
274
|
+
.literal('code_rotates_periodically')
|
|
275
275
|
.describe(warning_code_description),
|
|
276
276
|
})
|
|
277
277
|
.describe(
|
|
278
|
-
|
|
278
|
+
"The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.",
|
|
279
279
|
)
|
|
280
280
|
|
|
281
281
|
const schlage_access_code_ambiguous_timezone_dst_risk =
|
|
@@ -349,7 +349,7 @@ const being_deleted = common_access_code_warning
|
|
|
349
349
|
|
|
350
350
|
const access_code_warning = z
|
|
351
351
|
.discriminatedUnion('warning_code', [
|
|
352
|
-
|
|
352
|
+
code_rotates_periodically,
|
|
353
353
|
schlage_access_code_ambiguous_timezone_dst_risk,
|
|
354
354
|
code_modified_external_to_seam_warning,
|
|
355
355
|
delay_in_setting_on_device,
|
|
@@ -367,7 +367,7 @@ const access_code_warning = z
|
|
|
367
367
|
export type AccessCodeWarning = z.infer<typeof access_code_warning>
|
|
368
368
|
|
|
369
369
|
const _access_code_warning_map = z.object({
|
|
370
|
-
|
|
370
|
+
code_rotates_periodically: code_rotates_periodically.optional().nullable(),
|
|
371
371
|
schlage_access_code_ambiguous_timezone_dst_risk:
|
|
372
372
|
schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(),
|
|
373
373
|
code_modified_external_to_seam_warning: code_modified_external_to_seam_warning
|
|
@@ -160,7 +160,7 @@ const common_acs_credential = z.object({
|
|
|
160
160
|
.string()
|
|
161
161
|
.uuid()
|
|
162
162
|
.describe(
|
|
163
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
163
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
164
164
|
),
|
|
165
165
|
acs_credential_pool_id: z
|
|
166
166
|
.string()
|
|
@@ -40,7 +40,7 @@ export const acs_encoder = z.object({
|
|
|
40
40
|
.string()
|
|
41
41
|
.uuid()
|
|
42
42
|
.describe(
|
|
43
|
-
'ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners.',
|
|
43
|
+
'ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
44
44
|
),
|
|
45
45
|
acs_system_id: z
|
|
46
46
|
.string()
|
|
@@ -62,7 +62,7 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
|
|
|
62
62
|
---
|
|
63
63
|
Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
64
64
|
This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
|
|
65
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
65
|
+
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
66
66
|
`)
|
|
67
67
|
|
|
68
68
|
const bridge_disconnected = common_acs_system_error.extend({
|
|
@@ -78,7 +78,7 @@ const bridge_disconnected = common_acs_system_error.extend({
|
|
|
78
78
|
resource_type: acs_system
|
|
79
79
|
---
|
|
80
80
|
Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
81
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
81
|
+
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
82
82
|
`)
|
|
83
83
|
|
|
84
84
|
const visionline_instance_unreachable = common_acs_system_error.extend({
|
|
@@ -91,7 +91,7 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
91
91
|
---
|
|
92
92
|
Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
93
93
|
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).
|
|
94
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
94
|
+
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable).
|
|
95
95
|
`)
|
|
96
96
|
|
|
97
97
|
const salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
|
|
@@ -394,7 +394,7 @@ export const acs_system = z
|
|
|
394
394
|
---
|
|
395
395
|
Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).
|
|
396
396
|
|
|
397
|
-
Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/api/acs/users
|
|
397
|
+
Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/api/acs/users/object) and [\`acs_credential\`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the \`acs_user\`s.
|
|
398
398
|
|
|
399
399
|
For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).
|
|
400
400
|
`)
|
|
@@ -62,7 +62,7 @@ export const bridge_disconnected = common_connected_account_error.extend({
|
|
|
62
62
|
---
|
|
63
63
|
resource_type: connected_account
|
|
64
64
|
---
|
|
65
|
-
Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
65
|
+
Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
66
66
|
`)
|
|
67
67
|
|
|
68
68
|
export const salto_ks_subscription_limit_exceeded =
|
|
@@ -16,7 +16,7 @@ export const enrollment_automation_deleted_event =
|
|
|
16
16
|
---
|
|
17
17
|
route_path: /user_identities/enrollment_automations
|
|
18
18
|
---
|
|
19
|
-
An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system
|
|
19
|
+
An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) was deleted.
|
|
20
20
|
`)
|
|
21
21
|
|
|
22
22
|
export type EnrollmentAutomationDeletedEvent = z.infer<
|
|
@@ -1084,7 +1084,7 @@ const openapi: OpenAPISpec = {
|
|
|
1084
1084
|
},
|
|
1085
1085
|
{
|
|
1086
1086
|
description:
|
|
1087
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
1087
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
1088
1088
|
properties: {
|
|
1089
1089
|
created_at: {
|
|
1090
1090
|
description:
|
|
@@ -1482,7 +1482,7 @@ const openapi: OpenAPISpec = {
|
|
|
1482
1482
|
oneOf: [
|
|
1483
1483
|
{
|
|
1484
1484
|
description:
|
|
1485
|
-
|
|
1485
|
+
"The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.",
|
|
1486
1486
|
properties: {
|
|
1487
1487
|
created_at: {
|
|
1488
1488
|
description:
|
|
@@ -1498,7 +1498,7 @@ const openapi: OpenAPISpec = {
|
|
|
1498
1498
|
warning_code: {
|
|
1499
1499
|
description:
|
|
1500
1500
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1501
|
-
enum: ['
|
|
1501
|
+
enum: ['code_rotates_periodically'],
|
|
1502
1502
|
type: 'string',
|
|
1503
1503
|
},
|
|
1504
1504
|
},
|
|
@@ -3474,7 +3474,7 @@ const openapi: OpenAPISpec = {
|
|
|
3474
3474
|
},
|
|
3475
3475
|
connected_account_id: {
|
|
3476
3476
|
description:
|
|
3477
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
3477
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
3478
3478
|
format: 'uuid',
|
|
3479
3479
|
type: 'string',
|
|
3480
3480
|
},
|
|
@@ -3878,7 +3878,7 @@ const openapi: OpenAPISpec = {
|
|
|
3878
3878
|
properties: {
|
|
3879
3879
|
acs_encoder_id: {
|
|
3880
3880
|
description:
|
|
3881
|
-
'ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners.',
|
|
3881
|
+
'ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
|
|
3882
3882
|
format: 'uuid',
|
|
3883
3883
|
type: 'string',
|
|
3884
3884
|
},
|
|
@@ -4482,7 +4482,7 @@ const openapi: OpenAPISpec = {
|
|
|
4482
4482
|
},
|
|
4483
4483
|
acs_system: {
|
|
4484
4484
|
description:
|
|
4485
|
-
'Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users
|
|
4485
|
+
'Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).',
|
|
4486
4486
|
properties: {
|
|
4487
4487
|
acs_access_group_count: {
|
|
4488
4488
|
description:
|
|
@@ -4539,7 +4539,7 @@ const openapi: OpenAPISpec = {
|
|
|
4539
4539
|
oneOf: [
|
|
4540
4540
|
{
|
|
4541
4541
|
description:
|
|
4542
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nThis error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4542
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nThis error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
4543
4543
|
properties: {
|
|
4544
4544
|
created_at: {
|
|
4545
4545
|
description:
|
|
@@ -4565,7 +4565,7 @@ const openapi: OpenAPISpec = {
|
|
|
4565
4565
|
},
|
|
4566
4566
|
{
|
|
4567
4567
|
description:
|
|
4568
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4568
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
4569
4569
|
properties: {
|
|
4570
4570
|
created_at: {
|
|
4571
4571
|
description:
|
|
@@ -4596,7 +4596,7 @@ const openapi: OpenAPISpec = {
|
|
|
4596
4596
|
},
|
|
4597
4597
|
{
|
|
4598
4598
|
description:
|
|
4599
|
-
'Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\nFor example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4599
|
+
'Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\nFor example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable).',
|
|
4600
4600
|
properties: {
|
|
4601
4601
|
created_at: {
|
|
4602
4602
|
description:
|
|
@@ -6374,7 +6374,7 @@ const openapi: OpenAPISpec = {
|
|
|
6374
6374
|
},
|
|
6375
6375
|
connected_account_id: {
|
|
6376
6376
|
description:
|
|
6377
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
6377
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
6378
6378
|
format: 'uuid',
|
|
6379
6379
|
type: 'string',
|
|
6380
6380
|
},
|
|
@@ -6839,7 +6839,7 @@ const openapi: OpenAPISpec = {
|
|
|
6839
6839
|
},
|
|
6840
6840
|
connected_account_id: {
|
|
6841
6841
|
description:
|
|
6842
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
6842
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
6843
6843
|
format: 'uuid',
|
|
6844
6844
|
type: 'string',
|
|
6845
6845
|
},
|
|
@@ -7555,7 +7555,7 @@ const openapi: OpenAPISpec = {
|
|
|
7555
7555
|
},
|
|
7556
7556
|
connected_account_id: {
|
|
7557
7557
|
description:
|
|
7558
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
7558
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
7559
7559
|
format: 'uuid',
|
|
7560
7560
|
type: 'string',
|
|
7561
7561
|
},
|
|
@@ -8017,7 +8017,7 @@ const openapi: OpenAPISpec = {
|
|
|
8017
8017
|
},
|
|
8018
8018
|
connected_account_id: {
|
|
8019
8019
|
description:
|
|
8020
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
8020
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
8021
8021
|
format: 'uuid',
|
|
8022
8022
|
type: 'string',
|
|
8023
8023
|
},
|
|
@@ -8767,7 +8767,7 @@ const openapi: OpenAPISpec = {
|
|
|
8767
8767
|
},
|
|
8768
8768
|
connected_account_id: {
|
|
8769
8769
|
description:
|
|
8770
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
8770
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
8771
8771
|
format: 'uuid',
|
|
8772
8772
|
type: 'string',
|
|
8773
8773
|
},
|
|
@@ -12180,7 +12180,7 @@ const openapi: OpenAPISpec = {
|
|
|
12180
12180
|
},
|
|
12181
12181
|
{
|
|
12182
12182
|
description:
|
|
12183
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
12183
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
12184
12184
|
properties: {
|
|
12185
12185
|
created_at: {
|
|
12186
12186
|
description:
|
|
@@ -13649,7 +13649,7 @@ const openapi: OpenAPISpec = {
|
|
|
13649
13649
|
},
|
|
13650
13650
|
{
|
|
13651
13651
|
description:
|
|
13652
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
13652
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
13653
13653
|
properties: {
|
|
13654
13654
|
created_at: {
|
|
13655
13655
|
description:
|
|
@@ -26527,7 +26527,7 @@ const openapi: OpenAPISpec = {
|
|
|
26527
26527
|
},
|
|
26528
26528
|
{
|
|
26529
26529
|
description:
|
|
26530
|
-
'An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system
|
|
26530
|
+
'An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) was deleted.',
|
|
26531
26531
|
properties: {
|
|
26532
26532
|
created_at: {
|
|
26533
26533
|
description: 'Date and time at which the event was created.',
|
|
@@ -27849,7 +27849,7 @@ const openapi: OpenAPISpec = {
|
|
|
27849
27849
|
},
|
|
27850
27850
|
connected_account_id: {
|
|
27851
27851
|
description:
|
|
27852
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
27852
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
27853
27853
|
format: 'uuid',
|
|
27854
27854
|
type: 'string',
|
|
27855
27855
|
},
|
|
@@ -29918,7 +29918,7 @@ const openapi: OpenAPISpec = {
|
|
|
29918
29918
|
},
|
|
29919
29919
|
{
|
|
29920
29920
|
description:
|
|
29921
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
29921
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
29922
29922
|
properties: {
|
|
29923
29923
|
created_at: {
|
|
29924
29924
|
description:
|
|
@@ -30005,7 +30005,7 @@ const openapi: OpenAPISpec = {
|
|
|
30005
30005
|
oneOf: [
|
|
30006
30006
|
{
|
|
30007
30007
|
description:
|
|
30008
|
-
|
|
30008
|
+
"The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.",
|
|
30009
30009
|
properties: {
|
|
30010
30010
|
created_at: {
|
|
30011
30011
|
description:
|
|
@@ -30021,7 +30021,7 @@ const openapi: OpenAPISpec = {
|
|
|
30021
30021
|
warning_code: {
|
|
30022
30022
|
description:
|
|
30023
30023
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
30024
|
-
enum: ['
|
|
30024
|
+
enum: ['code_rotates_periodically'],
|
|
30025
30025
|
type: 'string',
|
|
30026
30026
|
},
|
|
30027
30027
|
},
|
|
@@ -30971,7 +30971,7 @@ const openapi: OpenAPISpec = {
|
|
|
30971
30971
|
},
|
|
30972
30972
|
connected_account_id: {
|
|
30973
30973
|
description:
|
|
30974
|
-
'ID of the [connected account](https://docs.seam.co/
|
|
30974
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
|
|
30975
30975
|
format: 'uuid',
|
|
30976
30976
|
type: 'string',
|
|
30977
30977
|
},
|
|
@@ -32990,7 +32990,7 @@ const openapi: OpenAPISpec = {
|
|
|
32990
32990
|
},
|
|
32991
32991
|
{
|
|
32992
32992
|
description:
|
|
32993
|
-
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
32993
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
32994
32994
|
properties: {
|
|
32995
32995
|
created_at: {
|
|
32996
32996
|
description:
|
|
@@ -34434,7 +34434,7 @@ const openapi: OpenAPISpec = {
|
|
|
34434
34434
|
},
|
|
34435
34435
|
use_backup_access_code_pool: {
|
|
34436
34436
|
description:
|
|
34437
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
34437
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
34438
34438
|
type: 'boolean',
|
|
34439
34439
|
},
|
|
34440
34440
|
use_offline_access_code: {
|
|
@@ -34560,7 +34560,7 @@ const openapi: OpenAPISpec = {
|
|
|
34560
34560
|
},
|
|
34561
34561
|
use_backup_access_code_pool: {
|
|
34562
34562
|
description:
|
|
34563
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
34563
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
34564
34564
|
type: 'boolean',
|
|
34565
34565
|
},
|
|
34566
34566
|
},
|
|
@@ -34678,7 +34678,7 @@ const openapi: OpenAPISpec = {
|
|
|
34678
34678
|
},
|
|
34679
34679
|
use_backup_access_code_pool: {
|
|
34680
34680
|
description:
|
|
34681
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
34681
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
34682
34682
|
type: 'boolean',
|
|
34683
34683
|
},
|
|
34684
34684
|
},
|
|
@@ -36878,7 +36878,7 @@ const openapi: OpenAPISpec = {
|
|
|
36878
36878
|
},
|
|
36879
36879
|
use_backup_access_code_pool: {
|
|
36880
36880
|
description:
|
|
36881
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
36881
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
36882
36882
|
type: 'boolean',
|
|
36883
36883
|
},
|
|
36884
36884
|
use_offline_access_code: {
|
|
@@ -37031,7 +37031,7 @@ const openapi: OpenAPISpec = {
|
|
|
37031
37031
|
},
|
|
37032
37032
|
use_backup_access_code_pool: {
|
|
37033
37033
|
description:
|
|
37034
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
37034
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
37035
37035
|
type: 'boolean',
|
|
37036
37036
|
},
|
|
37037
37037
|
use_offline_access_code: {
|
|
@@ -37184,7 +37184,7 @@ const openapi: OpenAPISpec = {
|
|
|
37184
37184
|
},
|
|
37185
37185
|
use_backup_access_code_pool: {
|
|
37186
37186
|
description:
|
|
37187
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
37187
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/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://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
37188
37188
|
type: 'boolean',
|
|
37189
37189
|
},
|
|
37190
37190
|
use_offline_access_code: {
|