@seamapi/types 1.827.0 → 1.829.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 +147 -5
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +371 -30
- package/dist/index.cjs +147 -5
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +18 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +43 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.d.ts +7 -7
- package/lib/seam/connect/models/acs/acs-system.js +1 -1
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/metadata/avigilon-alta.d.ts +27 -0
- package/lib/seam/connect/models/acs/metadata/avigilon-alta.js +17 -0
- package/lib/seam/connect/models/acs/metadata/avigilon-alta.js.map +1 -0
- package/lib/seam/connect/models/batch.d.ts +83 -10
- package/lib/seam/connect/models/events/access-grants.d.ts +6 -0
- package/lib/seam/connect/models/events/access-grants.js +4 -0
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +3 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +176 -0
- package/lib/seam/connect/openapi.js +124 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +231 -14
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +6 -0
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/models/acs/acs-system.ts +1 -1
- package/src/lib/seam/connect/models/acs/metadata/avigilon-alta.ts +21 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +140 -2
- package/src/lib/seam/connect/route-types.ts +253 -14
package/dist/index.cjs
CHANGED
|
@@ -2722,7 +2722,10 @@ var common_access_grant_error = zod.z.object({
|
|
|
2722
2722
|
});
|
|
2723
2723
|
var error_code_description4 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
2724
2724
|
var cannot_create_requested_access_methods_error = common_access_grant_error.extend({
|
|
2725
|
-
error_code: zod.z.literal("cannot_create_requested_access_methods").describe(error_code_description4)
|
|
2725
|
+
error_code: zod.z.literal("cannot_create_requested_access_methods").describe(error_code_description4),
|
|
2726
|
+
missing_device_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
|
|
2727
|
+
"IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure."
|
|
2728
|
+
)
|
|
2726
2729
|
});
|
|
2727
2730
|
var common_access_grant_warning = zod.z.object({
|
|
2728
2731
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
@@ -3670,6 +3673,17 @@ var acs_encoder = zod.z.object({
|
|
|
3670
3673
|
|
|
3671
3674
|
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
|
|
3672
3675
|
`);
|
|
3676
|
+
var acs_entrance_avigilon_alta_metadata = zod.z.object({
|
|
3677
|
+
entry_name: zod.z.string().describe("Entry name for an Avigilon Alta system."),
|
|
3678
|
+
org_name: zod.z.string().describe("Organization name for an Avigilon Alta system."),
|
|
3679
|
+
zone_id: zod.z.number().describe("Zone ID for an Avigilon Alta system."),
|
|
3680
|
+
zone_name: zod.z.string().describe("Zone name for an Avigilon Alta system."),
|
|
3681
|
+
site_id: zod.z.number().describe("Site ID for an Avigilon Alta system."),
|
|
3682
|
+
site_name: zod.z.string().describe("Site name for an Avigilon Alta system."),
|
|
3683
|
+
entry_relays_total_count: zod.z.number().describe("Total count of entry relays for an Avigilon Alta system.")
|
|
3684
|
+
}).describe("Avigilon Alta-specific metadata associated with the entrance.");
|
|
3685
|
+
|
|
3686
|
+
// src/lib/seam/connect/models/acs/acs-entrance.ts
|
|
3673
3687
|
var acs_entrance_capability_flags = zod.z.object({
|
|
3674
3688
|
can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
|
|
3675
3689
|
"Indicates whether the ACS entrance can be unlocked with mobile key credentials."
|
|
@@ -3742,6 +3756,9 @@ var acs_entrance = zod.z.object({
|
|
|
3742
3756
|
),
|
|
3743
3757
|
brivo_metadata: acs_entrance_brivo_metadata.optional().describe(
|
|
3744
3758
|
"Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3759
|
+
),
|
|
3760
|
+
avigilon_alta_metadata: acs_entrance_avigilon_alta_metadata.optional().describe(
|
|
3761
|
+
"Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
3745
3762
|
)
|
|
3746
3763
|
}).merge(acs_entrance_capability_flags).describe(`
|
|
3747
3764
|
---
|
|
@@ -3762,7 +3779,7 @@ var acs_location = zod.z.object({
|
|
|
3762
3779
|
});
|
|
3763
3780
|
var acs_system_external_type = zod.z.enum([
|
|
3764
3781
|
"pti_site",
|
|
3765
|
-
"
|
|
3782
|
+
"avigilon_alta_org",
|
|
3766
3783
|
"salto_ks_site",
|
|
3767
3784
|
"salto_space_system",
|
|
3768
3785
|
"brivo_account",
|
|
@@ -5322,7 +5339,10 @@ var access_grant_could_not_create_requested_access_methods_event = access_grant_
|
|
|
5322
5339
|
event_type: zod.z.literal(
|
|
5323
5340
|
"access_grant.could_not_create_requested_access_methods"
|
|
5324
5341
|
),
|
|
5325
|
-
error_message: zod.z.string().describe("Description of why the access methods could not be created.")
|
|
5342
|
+
error_message: zod.z.string().describe("Description of why the access methods could not be created."),
|
|
5343
|
+
missing_device_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
|
|
5344
|
+
"IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant."
|
|
5345
|
+
)
|
|
5326
5346
|
}).describe(`
|
|
5327
5347
|
---
|
|
5328
5348
|
route_path: /access_grants
|
|
@@ -8818,6 +8838,11 @@ var openapi = {
|
|
|
8818
8838
|
message: {
|
|
8819
8839
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
8820
8840
|
type: "string"
|
|
8841
|
+
},
|
|
8842
|
+
missing_device_ids: {
|
|
8843
|
+
description: "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.",
|
|
8844
|
+
items: { format: "uuid", type: "string" },
|
|
8845
|
+
type: "array"
|
|
8821
8846
|
}
|
|
8822
8847
|
},
|
|
8823
8848
|
required: ["created_at", "message", "error_code"],
|
|
@@ -10684,6 +10709,52 @@ var openapi = {
|
|
|
10684
10709
|
required: ["door_type", "door_name"],
|
|
10685
10710
|
type: "object"
|
|
10686
10711
|
},
|
|
10712
|
+
avigilon_alta_metadata: {
|
|
10713
|
+
description: "Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
10714
|
+
properties: {
|
|
10715
|
+
entry_name: {
|
|
10716
|
+
description: "Entry name for an Avigilon Alta system.",
|
|
10717
|
+
type: "string"
|
|
10718
|
+
},
|
|
10719
|
+
entry_relays_total_count: {
|
|
10720
|
+
description: "Total count of entry relays for an Avigilon Alta system.",
|
|
10721
|
+
format: "float",
|
|
10722
|
+
type: "number"
|
|
10723
|
+
},
|
|
10724
|
+
org_name: {
|
|
10725
|
+
description: "Organization name for an Avigilon Alta system.",
|
|
10726
|
+
type: "string"
|
|
10727
|
+
},
|
|
10728
|
+
site_id: {
|
|
10729
|
+
description: "Site ID for an Avigilon Alta system.",
|
|
10730
|
+
format: "float",
|
|
10731
|
+
type: "number"
|
|
10732
|
+
},
|
|
10733
|
+
site_name: {
|
|
10734
|
+
description: "Site name for an Avigilon Alta system.",
|
|
10735
|
+
type: "string"
|
|
10736
|
+
},
|
|
10737
|
+
zone_id: {
|
|
10738
|
+
description: "Zone ID for an Avigilon Alta system.",
|
|
10739
|
+
format: "float",
|
|
10740
|
+
type: "number"
|
|
10741
|
+
},
|
|
10742
|
+
zone_name: {
|
|
10743
|
+
description: "Zone name for an Avigilon Alta system.",
|
|
10744
|
+
type: "string"
|
|
10745
|
+
}
|
|
10746
|
+
},
|
|
10747
|
+
required: [
|
|
10748
|
+
"entry_name",
|
|
10749
|
+
"org_name",
|
|
10750
|
+
"zone_id",
|
|
10751
|
+
"zone_name",
|
|
10752
|
+
"site_id",
|
|
10753
|
+
"site_name",
|
|
10754
|
+
"entry_relays_total_count"
|
|
10755
|
+
],
|
|
10756
|
+
type: "object"
|
|
10757
|
+
},
|
|
10687
10758
|
brivo_metadata: {
|
|
10688
10759
|
description: "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
10689
10760
|
properties: {
|
|
@@ -11155,7 +11226,7 @@ var openapi = {
|
|
|
11155
11226
|
description: "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.",
|
|
11156
11227
|
enum: [
|
|
11157
11228
|
"pti_site",
|
|
11158
|
-
"
|
|
11229
|
+
"avigilon_alta_org",
|
|
11159
11230
|
"salto_ks_site",
|
|
11160
11231
|
"salto_space_system",
|
|
11161
11232
|
"brivo_account",
|
|
@@ -11207,7 +11278,7 @@ var openapi = {
|
|
|
11207
11278
|
deprecated: true,
|
|
11208
11279
|
enum: [
|
|
11209
11280
|
"pti_site",
|
|
11210
|
-
"
|
|
11281
|
+
"avigilon_alta_org",
|
|
11211
11282
|
"salto_ks_site",
|
|
11212
11283
|
"salto_space_system",
|
|
11213
11284
|
"brivo_account",
|
|
@@ -23104,6 +23175,11 @@ var openapi = {
|
|
|
23104
23175
|
],
|
|
23105
23176
|
type: "string"
|
|
23106
23177
|
},
|
|
23178
|
+
missing_device_ids: {
|
|
23179
|
+
description: "IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant.",
|
|
23180
|
+
items: { format: "uuid", type: "string" },
|
|
23181
|
+
type: "array"
|
|
23182
|
+
},
|
|
23107
23183
|
occurred_at: {
|
|
23108
23184
|
description: "Date and time at which the event occurred.",
|
|
23109
23185
|
format: "date-time",
|
|
@@ -29286,6 +29362,52 @@ var openapi = {
|
|
|
29286
29362
|
required: ["door_type", "door_name"],
|
|
29287
29363
|
type: "object"
|
|
29288
29364
|
},
|
|
29365
|
+
avigilon_alta_metadata: {
|
|
29366
|
+
description: "Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
29367
|
+
properties: {
|
|
29368
|
+
entry_name: {
|
|
29369
|
+
description: "Entry name for an Avigilon Alta system.",
|
|
29370
|
+
type: "string"
|
|
29371
|
+
},
|
|
29372
|
+
entry_relays_total_count: {
|
|
29373
|
+
description: "Total count of entry relays for an Avigilon Alta system.",
|
|
29374
|
+
format: "float",
|
|
29375
|
+
type: "number"
|
|
29376
|
+
},
|
|
29377
|
+
org_name: {
|
|
29378
|
+
description: "Organization name for an Avigilon Alta system.",
|
|
29379
|
+
type: "string"
|
|
29380
|
+
},
|
|
29381
|
+
site_id: {
|
|
29382
|
+
description: "Site ID for an Avigilon Alta system.",
|
|
29383
|
+
format: "float",
|
|
29384
|
+
type: "number"
|
|
29385
|
+
},
|
|
29386
|
+
site_name: {
|
|
29387
|
+
description: "Site name for an Avigilon Alta system.",
|
|
29388
|
+
type: "string"
|
|
29389
|
+
},
|
|
29390
|
+
zone_id: {
|
|
29391
|
+
description: "Zone ID for an Avigilon Alta system.",
|
|
29392
|
+
format: "float",
|
|
29393
|
+
type: "number"
|
|
29394
|
+
},
|
|
29395
|
+
zone_name: {
|
|
29396
|
+
description: "Zone name for an Avigilon Alta system.",
|
|
29397
|
+
type: "string"
|
|
29398
|
+
}
|
|
29399
|
+
},
|
|
29400
|
+
required: [
|
|
29401
|
+
"entry_name",
|
|
29402
|
+
"org_name",
|
|
29403
|
+
"zone_id",
|
|
29404
|
+
"zone_name",
|
|
29405
|
+
"site_id",
|
|
29406
|
+
"site_name",
|
|
29407
|
+
"entry_relays_total_count"
|
|
29408
|
+
],
|
|
29409
|
+
type: "object"
|
|
29410
|
+
},
|
|
29289
29411
|
brivo_metadata: {
|
|
29290
29412
|
description: "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
29291
29413
|
properties: {
|
|
@@ -39239,6 +39361,11 @@ var openapi = {
|
|
|
39239
39361
|
message: {
|
|
39240
39362
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
39241
39363
|
type: "string"
|
|
39364
|
+
},
|
|
39365
|
+
missing_device_ids: {
|
|
39366
|
+
description: "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.",
|
|
39367
|
+
items: { format: "uuid", type: "string" },
|
|
39368
|
+
type: "array"
|
|
39242
39369
|
}
|
|
39243
39370
|
},
|
|
39244
39371
|
required: [
|
|
@@ -39861,6 +39988,11 @@ var openapi = {
|
|
|
39861
39988
|
message: {
|
|
39862
39989
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
39863
39990
|
type: "string"
|
|
39991
|
+
},
|
|
39992
|
+
missing_device_ids: {
|
|
39993
|
+
description: "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.",
|
|
39994
|
+
items: { format: "uuid", type: "string" },
|
|
39995
|
+
type: "array"
|
|
39864
39996
|
}
|
|
39865
39997
|
},
|
|
39866
39998
|
required: [
|
|
@@ -40525,6 +40657,11 @@ var openapi = {
|
|
|
40525
40657
|
message: {
|
|
40526
40658
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
40527
40659
|
type: "string"
|
|
40660
|
+
},
|
|
40661
|
+
missing_device_ids: {
|
|
40662
|
+
description: "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.",
|
|
40663
|
+
items: { format: "uuid", type: "string" },
|
|
40664
|
+
type: "array"
|
|
40528
40665
|
}
|
|
40529
40666
|
},
|
|
40530
40667
|
required: [
|
|
@@ -41177,6 +41314,11 @@ var openapi = {
|
|
|
41177
41314
|
message: {
|
|
41178
41315
|
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
41179
41316
|
type: "string"
|
|
41317
|
+
},
|
|
41318
|
+
missing_device_ids: {
|
|
41319
|
+
description: "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.",
|
|
41320
|
+
items: { format: "uuid", type: "string" },
|
|
41321
|
+
type: "array"
|
|
41180
41322
|
}
|
|
41181
41323
|
},
|
|
41182
41324
|
required: [
|