@seamapi/types 1.930.0 → 1.932.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 +47 -33
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +225 -187
- package/dist/index.cjs +47 -33
- package/dist/index.cjs.map +1 -1
- 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/devices.d.ts +12 -0
- package/lib/seam/connect/models/events/devices.js +6 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +6 -0
- package/lib/seam/connect/openapi.js +33 -25
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +219 -187
- package/package.json +1 -1
- 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/devices.ts +6 -0
- package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +35 -25
- package/src/lib/seam/connect/route-types.ts +219 -187
package/dist/connect.cjs
CHANGED
|
@@ -653,7 +653,7 @@ var bridge_disconnected = common_connected_account_error.extend({
|
|
|
653
653
|
---
|
|
654
654
|
resource_type: connected_account
|
|
655
655
|
---
|
|
656
|
-
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
|
|
656
|
+
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).
|
|
657
657
|
`);
|
|
658
658
|
var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
|
|
659
659
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
|
|
@@ -3736,7 +3736,7 @@ var common_acs_credential = zod.z.object({
|
|
|
3736
3736
|
"ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs."
|
|
3737
3737
|
),
|
|
3738
3738
|
connected_account_id: zod.z.string().uuid().describe(
|
|
3739
|
-
"ID of the [connected account](https://docs.seam.co/
|
|
3739
|
+
"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."
|
|
3740
3740
|
),
|
|
3741
3741
|
acs_credential_pool_id: zod.z.string().uuid().optional().describe("ID of the credential pool to which the credential belongs."),
|
|
3742
3742
|
acs_system_id: zod.z.string().uuid().describe(
|
|
@@ -3921,7 +3921,7 @@ zod.z.object({
|
|
|
3921
3921
|
});
|
|
3922
3922
|
var acs_encoder = zod.z.object({
|
|
3923
3923
|
acs_encoder_id: zod.z.string().uuid().describe(
|
|
3924
|
-
"ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners."
|
|
3924
|
+
"ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
3925
3925
|
),
|
|
3926
3926
|
acs_system_id: zod.z.string().uuid().describe(
|
|
3927
3927
|
"ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners)."
|
|
@@ -4144,7 +4144,7 @@ var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
|
4144
4144
|
---
|
|
4145
4145
|
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.
|
|
4146
4146
|
This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
|
|
4147
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4147
|
+
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).
|
|
4148
4148
|
`);
|
|
4149
4149
|
var bridge_disconnected2 = common_acs_system_error.extend({
|
|
4150
4150
|
error_code: zod.z.literal("bridge_disconnected").describe(error_code_description7),
|
|
@@ -4156,7 +4156,7 @@ var bridge_disconnected2 = common_acs_system_error.extend({
|
|
|
4156
4156
|
resource_type: acs_system
|
|
4157
4157
|
---
|
|
4158
4158
|
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.
|
|
4159
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4159
|
+
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).
|
|
4160
4160
|
`);
|
|
4161
4161
|
var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
4162
4162
|
error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description7)
|
|
@@ -4166,7 +4166,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
|
4166
4166
|
---
|
|
4167
4167
|
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).
|
|
4168
4168
|
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).
|
|
4169
|
-
See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system
|
|
4169
|
+
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).
|
|
4170
4170
|
`);
|
|
4171
4171
|
var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
|
|
4172
4172
|
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description7)
|
|
@@ -4354,7 +4354,7 @@ var acs_system = zod.z.object({
|
|
|
4354
4354
|
---
|
|
4355
4355
|
Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).
|
|
4356
4356
|
|
|
4357
|
-
Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/api/acs/users
|
|
4357
|
+
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.
|
|
4358
4358
|
|
|
4359
4359
|
For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).
|
|
4360
4360
|
`);
|
|
@@ -6655,6 +6655,9 @@ var noise_sensor_noise_threshold_triggered_event = device_event.extend(
|
|
|
6655
6655
|
var lock_locked_event = device_event.extend({
|
|
6656
6656
|
event_type: zod.z.literal("lock.locked"),
|
|
6657
6657
|
access_code_id: zod.z.string().uuid().optional().describe("ID of the access code that was used to lock the device."),
|
|
6658
|
+
code: zod.z.string().optional().describe(`
|
|
6659
|
+
Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
|
|
6660
|
+
`),
|
|
6658
6661
|
access_code_is_managed: zod.z.boolean().optional().describe(
|
|
6659
6662
|
"Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set."
|
|
6660
6663
|
),
|
|
@@ -6681,6 +6684,9 @@ var lock_unlocked_event = device_event.extend({
|
|
|
6681
6684
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
6682
6685
|
"ID of the access code that was used to unlock the affected device."
|
|
6683
6686
|
),
|
|
6687
|
+
code: zod.z.string().optional().describe(`
|
|
6688
|
+
Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
|
|
6689
|
+
`),
|
|
6684
6690
|
access_code_is_managed: zod.z.boolean().optional().describe(
|
|
6685
6691
|
"Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set."
|
|
6686
6692
|
),
|
|
@@ -6934,7 +6940,7 @@ var enrollment_automation_deleted_event = enrollment_automation_event.extend({
|
|
|
6934
6940
|
---
|
|
6935
6941
|
route_path: /user_identities/enrollment_automations
|
|
6936
6942
|
---
|
|
6937
|
-
An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system
|
|
6943
|
+
An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) was deleted.
|
|
6938
6944
|
`);
|
|
6939
6945
|
var enrollment_automation_events = [
|
|
6940
6946
|
enrollment_automation_deleted_event
|
|
@@ -8470,7 +8476,7 @@ var openapi = {
|
|
|
8470
8476
|
"x-variant-group-key": "locks"
|
|
8471
8477
|
},
|
|
8472
8478
|
{
|
|
8473
|
-
description: "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
|
|
8479
|
+
description: "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).",
|
|
8474
8480
|
properties: {
|
|
8475
8481
|
created_at: {
|
|
8476
8482
|
description: "Date and time at which Seam created the error.",
|
|
@@ -10608,7 +10614,7 @@ var openapi = {
|
|
|
10608
10614
|
type: "string"
|
|
10609
10615
|
},
|
|
10610
10616
|
connected_account_id: {
|
|
10611
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
10617
|
+
description: "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.",
|
|
10612
10618
|
format: "uuid",
|
|
10613
10619
|
type: "string"
|
|
10614
10620
|
},
|
|
@@ -10961,7 +10967,7 @@ var openapi = {
|
|
|
10961
10967
|
description: "Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).",
|
|
10962
10968
|
properties: {
|
|
10963
10969
|
acs_encoder_id: {
|
|
10964
|
-
description: "ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners.",
|
|
10970
|
+
description: "ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).",
|
|
10965
10971
|
format: "uuid",
|
|
10966
10972
|
type: "string"
|
|
10967
10973
|
},
|
|
@@ -11492,7 +11498,7 @@ var openapi = {
|
|
|
11492
11498
|
"x-route-path": "/acs/entrances"
|
|
11493
11499
|
},
|
|
11494
11500
|
acs_system: {
|
|
11495
|
-
description: "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
|
|
11501
|
+
description: "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).",
|
|
11496
11502
|
properties: {
|
|
11497
11503
|
acs_access_group_count: {
|
|
11498
11504
|
description: "Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).",
|
|
@@ -11539,7 +11545,7 @@ var openapi = {
|
|
|
11539
11545
|
discriminator: { propertyName: "error_code" },
|
|
11540
11546
|
oneOf: [
|
|
11541
11547
|
{
|
|
11542
|
-
description: "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
|
|
11548
|
+
description: "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).",
|
|
11543
11549
|
properties: {
|
|
11544
11550
|
created_at: {
|
|
11545
11551
|
description: "Date and time at which Seam created the error.",
|
|
@@ -11561,7 +11567,7 @@ var openapi = {
|
|
|
11561
11567
|
"x-resource-type": "acs_system"
|
|
11562
11568
|
},
|
|
11563
11569
|
{
|
|
11564
|
-
description: "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
|
|
11570
|
+
description: "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).",
|
|
11565
11571
|
properties: {
|
|
11566
11572
|
created_at: {
|
|
11567
11573
|
description: "Date and time at which Seam created the error.",
|
|
@@ -11587,7 +11593,7 @@ var openapi = {
|
|
|
11587
11593
|
"x-resource-type": "acs_system"
|
|
11588
11594
|
},
|
|
11589
11595
|
{
|
|
11590
|
-
description: "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
|
|
11596
|
+
description: "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).",
|
|
11591
11597
|
properties: {
|
|
11592
11598
|
created_at: {
|
|
11593
11599
|
description: "Date and time at which Seam created the error.",
|
|
@@ -13159,7 +13165,7 @@ var openapi = {
|
|
|
13159
13165
|
type: "string"
|
|
13160
13166
|
},
|
|
13161
13167
|
connected_account_id: {
|
|
13162
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
13168
|
+
description: "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.",
|
|
13163
13169
|
format: "uuid",
|
|
13164
13170
|
type: "string"
|
|
13165
13171
|
},
|
|
@@ -13556,7 +13562,7 @@ var openapi = {
|
|
|
13556
13562
|
type: "string"
|
|
13557
13563
|
},
|
|
13558
13564
|
connected_account_id: {
|
|
13559
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
13565
|
+
description: "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.",
|
|
13560
13566
|
format: "uuid",
|
|
13561
13567
|
type: "string"
|
|
13562
13568
|
},
|
|
@@ -14175,7 +14181,7 @@ var openapi = {
|
|
|
14175
14181
|
type: "string"
|
|
14176
14182
|
},
|
|
14177
14183
|
connected_account_id: {
|
|
14178
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
14184
|
+
description: "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.",
|
|
14179
14185
|
format: "uuid",
|
|
14180
14186
|
type: "string"
|
|
14181
14187
|
},
|
|
@@ -14570,7 +14576,7 @@ var openapi = {
|
|
|
14570
14576
|
type: "string"
|
|
14571
14577
|
},
|
|
14572
14578
|
connected_account_id: {
|
|
14573
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
14579
|
+
description: "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.",
|
|
14574
14580
|
format: "uuid",
|
|
14575
14581
|
type: "string"
|
|
14576
14582
|
},
|
|
@@ -15216,7 +15222,7 @@ var openapi = {
|
|
|
15216
15222
|
type: "string"
|
|
15217
15223
|
},
|
|
15218
15224
|
connected_account_id: {
|
|
15219
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
15225
|
+
description: "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.",
|
|
15220
15226
|
format: "uuid",
|
|
15221
15227
|
type: "string"
|
|
15222
15228
|
},
|
|
@@ -18326,7 +18332,7 @@ var openapi = {
|
|
|
18326
18332
|
"x-resource-type": "connected_account"
|
|
18327
18333
|
},
|
|
18328
18334
|
{
|
|
18329
|
-
description: "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
|
|
18335
|
+
description: "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).",
|
|
18330
18336
|
properties: {
|
|
18331
18337
|
created_at: {
|
|
18332
18338
|
description: "Date and time at which Seam created the error.",
|
|
@@ -19615,7 +19621,7 @@ var openapi = {
|
|
|
19615
19621
|
"x-variant-group-key": "locks"
|
|
19616
19622
|
},
|
|
19617
19623
|
{
|
|
19618
|
-
description: "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
|
|
19624
|
+
description: "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).",
|
|
19619
19625
|
properties: {
|
|
19620
19626
|
created_at: {
|
|
19621
19627
|
description: "Date and time at which Seam created the error.",
|
|
@@ -30302,6 +30308,10 @@ var openapi = {
|
|
|
30302
30308
|
format: "uuid",
|
|
30303
30309
|
type: "string"
|
|
30304
30310
|
},
|
|
30311
|
+
code: {
|
|
30312
|
+
description: "\n Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ",
|
|
30313
|
+
type: "string"
|
|
30314
|
+
},
|
|
30305
30315
|
connected_account_custom_metadata: {
|
|
30306
30316
|
additionalProperties: {
|
|
30307
30317
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -30410,6 +30420,10 @@ var openapi = {
|
|
|
30410
30420
|
format: "uuid",
|
|
30411
30421
|
type: "string"
|
|
30412
30422
|
},
|
|
30423
|
+
code: {
|
|
30424
|
+
description: "\n Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.\n ",
|
|
30425
|
+
type: "string"
|
|
30426
|
+
},
|
|
30413
30427
|
connected_account_custom_metadata: {
|
|
30414
30428
|
additionalProperties: {
|
|
30415
30429
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
@@ -31386,7 +31400,7 @@ var openapi = {
|
|
|
31386
31400
|
"x-route-path": "/devices"
|
|
31387
31401
|
},
|
|
31388
31402
|
{
|
|
31389
|
-
description: "An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system
|
|
31403
|
+
description: "An [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) was deleted.",
|
|
31390
31404
|
properties: {
|
|
31391
31405
|
created_at: {
|
|
31392
31406
|
description: "Date and time at which the event was created.",
|
|
@@ -32580,7 +32594,7 @@ var openapi = {
|
|
|
32580
32594
|
type: "string"
|
|
32581
32595
|
},
|
|
32582
32596
|
connected_account_id: {
|
|
32583
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
32597
|
+
description: "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.",
|
|
32584
32598
|
format: "uuid",
|
|
32585
32599
|
type: "string"
|
|
32586
32600
|
},
|
|
@@ -34394,7 +34408,7 @@ var openapi = {
|
|
|
34394
34408
|
"x-variant-group-key": "locks"
|
|
34395
34409
|
},
|
|
34396
34410
|
{
|
|
34397
|
-
description: "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
|
|
34411
|
+
description: "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).",
|
|
34398
34412
|
properties: {
|
|
34399
34413
|
created_at: {
|
|
34400
34414
|
description: "Date and time at which Seam created the error.",
|
|
@@ -35336,7 +35350,7 @@ var openapi = {
|
|
|
35336
35350
|
type: "string"
|
|
35337
35351
|
},
|
|
35338
35352
|
connected_account_id: {
|
|
35339
|
-
description: "ID of the [connected account](https://docs.seam.co/
|
|
35353
|
+
description: "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.",
|
|
35340
35354
|
format: "uuid",
|
|
35341
35355
|
type: "string"
|
|
35342
35356
|
},
|
|
@@ -37118,7 +37132,7 @@ var openapi = {
|
|
|
37118
37132
|
"x-variant-group-key": "locks"
|
|
37119
37133
|
},
|
|
37120
37134
|
{
|
|
37121
|
-
description: "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
|
|
37135
|
+
description: "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).",
|
|
37122
37136
|
properties: {
|
|
37123
37137
|
created_at: {
|
|
37124
37138
|
description: "Date and time at which Seam created the error.",
|
|
@@ -38382,7 +38396,7 @@ var openapi = {
|
|
|
38382
38396
|
"x-undocumented": "Only used internally."
|
|
38383
38397
|
},
|
|
38384
38398
|
use_backup_access_code_pool: {
|
|
38385
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
38399
|
+
description: "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).",
|
|
38386
38400
|
type: "boolean"
|
|
38387
38401
|
},
|
|
38388
38402
|
use_offline_access_code: {
|
|
@@ -38497,7 +38511,7 @@ var openapi = {
|
|
|
38497
38511
|
type: "string"
|
|
38498
38512
|
},
|
|
38499
38513
|
use_backup_access_code_pool: {
|
|
38500
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
38514
|
+
description: "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).",
|
|
38501
38515
|
type: "boolean"
|
|
38502
38516
|
}
|
|
38503
38517
|
},
|
|
@@ -38604,7 +38618,7 @@ var openapi = {
|
|
|
38604
38618
|
type: "string"
|
|
38605
38619
|
},
|
|
38606
38620
|
use_backup_access_code_pool: {
|
|
38607
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
38621
|
+
description: "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).",
|
|
38608
38622
|
type: "boolean"
|
|
38609
38623
|
}
|
|
38610
38624
|
},
|
|
@@ -40668,7 +40682,7 @@ var openapi = {
|
|
|
40668
40682
|
type: "string"
|
|
40669
40683
|
},
|
|
40670
40684
|
use_backup_access_code_pool: {
|
|
40671
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
40685
|
+
description: "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).",
|
|
40672
40686
|
type: "boolean"
|
|
40673
40687
|
},
|
|
40674
40688
|
use_offline_access_code: {
|
|
@@ -40805,7 +40819,7 @@ var openapi = {
|
|
|
40805
40819
|
type: "string"
|
|
40806
40820
|
},
|
|
40807
40821
|
use_backup_access_code_pool: {
|
|
40808
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
40822
|
+
description: "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).",
|
|
40809
40823
|
type: "boolean"
|
|
40810
40824
|
},
|
|
40811
40825
|
use_offline_access_code: {
|
|
@@ -40942,7 +40956,7 @@ var openapi = {
|
|
|
40942
40956
|
type: "string"
|
|
40943
40957
|
},
|
|
40944
40958
|
use_backup_access_code_pool: {
|
|
40945
|
-
description: "Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes
|
|
40959
|
+
description: "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).",
|
|
40946
40960
|
type: "boolean"
|
|
40947
40961
|
},
|
|
40948
40962
|
use_offline_access_code: {
|