@seamapi/types 1.289.0 → 1.290.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 +70 -38
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +212 -164
- package/lib/seam/connect/models/acs/acs-system.d.ts +20 -0
- package/lib/seam/connect/models/acs/acs-system.js +7 -0
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +18 -18
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -4
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/{encode-card.d.ts → encode-credential.d.ts} +11 -11
- package/lib/seam/connect/models/action-attempts/{encode-card.js → encode-credential.js} +6 -6
- package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/{scan-card.d.ts → scan-credential.d.ts} +11 -11
- package/lib/seam/connect/models/action-attempts/{scan-card.js → scan-credential.js} +7 -7
- package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +17 -2
- package/lib/seam/connect/openapi.js +53 -25
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +164 -144
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-system.ts +8 -0
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -4
- package/src/lib/seam/connect/models/action-attempts/{encode-card.ts → encode-credential.ts} +8 -6
- package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts} +9 -7
- package/src/lib/seam/connect/openapi.ts +58 -25
- package/src/lib/seam/connect/route-types.ts +164 -144
- package/lib/seam/connect/models/action-attempts/encode-card.js.map +0 -1
- package/lib/seam/connect/models/action-attempts/scan-card.js.map +0 -1
package/dist/connect.cjs
CHANGED
|
@@ -1346,6 +1346,9 @@ var acs_system_capability_flags = zod.z.object({
|
|
|
1346
1346
|
"Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
|
|
1347
1347
|
)
|
|
1348
1348
|
});
|
|
1349
|
+
var location = zod.z.object({
|
|
1350
|
+
time_zone: zod.z.string().nullable().describe("Time zone in which the `acs_system` is located.")
|
|
1351
|
+
});
|
|
1349
1352
|
var acs_system_external_type = zod.z.enum([
|
|
1350
1353
|
"pti_site",
|
|
1351
1354
|
"alta_org",
|
|
@@ -1462,6 +1465,7 @@ var acs_system = zod.z.object({
|
|
|
1462
1465
|
deprecated: Use \`external_type_display_name\`.
|
|
1463
1466
|
---
|
|
1464
1467
|
`),
|
|
1468
|
+
location,
|
|
1465
1469
|
name: zod.z.string().describe("Name of the `acs_system`."),
|
|
1466
1470
|
created_at: zod.z.string().datetime().describe("Date and time at which the `acs_system` was created."),
|
|
1467
1471
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -1804,7 +1808,7 @@ var deprecated_action_attempts = [
|
|
|
1804
1808
|
...delete_noise_threshold_action_attempt.options,
|
|
1805
1809
|
...update_noise_threshold_action_attempt.options
|
|
1806
1810
|
];
|
|
1807
|
-
var action_type2 = zod.z.literal("
|
|
1811
|
+
var action_type2 = zod.z.literal("ENCODE_CREDENTIAL");
|
|
1808
1812
|
var no_card_on_encoder_error = zod.z.object({
|
|
1809
1813
|
type: zod.z.literal("no_card_on_encoder"),
|
|
1810
1814
|
message: zod.z.string()
|
|
@@ -1819,15 +1823,15 @@ var error3 = zod.z.union([
|
|
|
1819
1823
|
incompatible_card_format_error
|
|
1820
1824
|
]);
|
|
1821
1825
|
var result3 = acs_credential.or(unmanaged_acs_credential);
|
|
1822
|
-
var
|
|
1826
|
+
var encode_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
1823
1827
|
common_pending_action_attempt.extend({
|
|
1824
1828
|
action_type: action_type2
|
|
1825
|
-
}).describe("Encoding
|
|
1829
|
+
}).describe("Encoding credential data from physical encoder."),
|
|
1826
1830
|
common_succeeded_action_attempt.extend({
|
|
1827
1831
|
action_type: action_type2,
|
|
1828
1832
|
result: result3
|
|
1829
|
-
}).describe("Encoding
|
|
1830
|
-
common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding
|
|
1833
|
+
}).describe("Encoding credential data from physical encoder succeeded."),
|
|
1834
|
+
common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding credential data from physical encoder failed.")
|
|
1831
1835
|
]);
|
|
1832
1836
|
var action_type3 = zod.z.literal("LOCK_DOOR");
|
|
1833
1837
|
var error4 = zod.z.object({
|
|
@@ -1867,7 +1871,7 @@ var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
|
|
|
1867
1871
|
}).describe("Resetting sandbox workspace failed.")
|
|
1868
1872
|
]
|
|
1869
1873
|
);
|
|
1870
|
-
var action_type5 = zod.z.literal("
|
|
1874
|
+
var action_type5 = zod.z.literal("SCAN_CREDENTIAL");
|
|
1871
1875
|
var no_card_on_encoder_error2 = zod.z.object({
|
|
1872
1876
|
type: zod.z.literal("no_card_on_encoder"),
|
|
1873
1877
|
message: zod.z.string()
|
|
@@ -1883,20 +1887,20 @@ var warning = zod.z.object({
|
|
|
1883
1887
|
var acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential);
|
|
1884
1888
|
var result6 = zod.z.object({
|
|
1885
1889
|
acs_credential_on_encoder: acs_credential_on_encoder.describe(
|
|
1886
|
-
"Snapshot of
|
|
1890
|
+
"Snapshot of credential data read from physical encoder."
|
|
1887
1891
|
),
|
|
1888
1892
|
acs_credential_on_seam: acs_credential_on_seam.nullable().describe("Matching acs_credential currently encoded on this card."),
|
|
1889
1893
|
warnings: zod.z.array(warning)
|
|
1890
1894
|
});
|
|
1891
|
-
var
|
|
1895
|
+
var scan_credential_action_attempt = zod.z.discriminatedUnion("status", [
|
|
1892
1896
|
common_pending_action_attempt.extend({
|
|
1893
1897
|
action_type: action_type5
|
|
1894
|
-
}).describe("Reading
|
|
1898
|
+
}).describe("Reading credential data from physical encoder."),
|
|
1895
1899
|
common_succeeded_action_attempt.extend({
|
|
1896
1900
|
action_type: action_type5,
|
|
1897
1901
|
result: result6
|
|
1898
|
-
}).describe("Reading
|
|
1899
|
-
common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading
|
|
1902
|
+
}).describe("Reading credential data from physical encoder succeeded."),
|
|
1903
|
+
common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Reading credential data from physical encoder failed.")
|
|
1900
1904
|
]);
|
|
1901
1905
|
var action_type6 = zod.z.literal("SET_COOL");
|
|
1902
1906
|
var error7 = zod.z.object({
|
|
@@ -2002,8 +2006,8 @@ var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
|
|
|
2002
2006
|
var action_attempt = zod.z.union([
|
|
2003
2007
|
...lock_door_action_attempt.options,
|
|
2004
2008
|
...unlock_door_action_attempt.options,
|
|
2005
|
-
...
|
|
2006
|
-
...
|
|
2009
|
+
...scan_credential_action_attempt.options,
|
|
2010
|
+
...encode_credential_action_attempt.options,
|
|
2007
2011
|
...reset_sandbox_workspace_action_attempt.options,
|
|
2008
2012
|
...set_cool_action_attempt.options,
|
|
2009
2013
|
...set_heat_action_attempt.options,
|
|
@@ -3472,6 +3476,17 @@ var openapi_default = {
|
|
|
3472
3476
|
description: "Indicates if the `acs_system` is a credential manager.",
|
|
3473
3477
|
type: "boolean"
|
|
3474
3478
|
},
|
|
3479
|
+
location: {
|
|
3480
|
+
properties: {
|
|
3481
|
+
time_zone: {
|
|
3482
|
+
description: "Time zone in which the `acs_system` is located.",
|
|
3483
|
+
nullable: true,
|
|
3484
|
+
type: "string"
|
|
3485
|
+
}
|
|
3486
|
+
},
|
|
3487
|
+
required: ["time_zone"],
|
|
3488
|
+
type: "object"
|
|
3489
|
+
},
|
|
3475
3490
|
name: { description: "Name of the `acs_system`.", type: "string" },
|
|
3476
3491
|
system_type: {
|
|
3477
3492
|
deprecated: true,
|
|
@@ -3549,6 +3564,7 @@ var openapi_default = {
|
|
|
3549
3564
|
required: [
|
|
3550
3565
|
"acs_system_id",
|
|
3551
3566
|
"is_credential_manager",
|
|
3567
|
+
"location",
|
|
3552
3568
|
"name",
|
|
3553
3569
|
"created_at",
|
|
3554
3570
|
"workspace_id",
|
|
@@ -3982,7 +3998,7 @@ var openapi_default = {
|
|
|
3982
3998
|
type: "object"
|
|
3983
3999
|
},
|
|
3984
4000
|
{
|
|
3985
|
-
description: "Reading
|
|
4001
|
+
description: "Reading credential data from physical encoder.",
|
|
3986
4002
|
properties: {
|
|
3987
4003
|
action_attempt_id: {
|
|
3988
4004
|
description: "The ID of the action attempt.",
|
|
@@ -3990,7 +4006,7 @@ var openapi_default = {
|
|
|
3990
4006
|
type: "string",
|
|
3991
4007
|
"x-title": "Action Attempt ID"
|
|
3992
4008
|
},
|
|
3993
|
-
action_type: { enum: ["
|
|
4009
|
+
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
3994
4010
|
error: { nullable: true },
|
|
3995
4011
|
result: { nullable: true },
|
|
3996
4012
|
status: { enum: ["pending"], type: "string" }
|
|
@@ -4005,7 +4021,7 @@ var openapi_default = {
|
|
|
4005
4021
|
type: "object"
|
|
4006
4022
|
},
|
|
4007
4023
|
{
|
|
4008
|
-
description: "Reading
|
|
4024
|
+
description: "Reading credential data from physical encoder succeeded.",
|
|
4009
4025
|
properties: {
|
|
4010
4026
|
action_attempt_id: {
|
|
4011
4027
|
description: "The ID of the action attempt.",
|
|
@@ -4013,12 +4029,12 @@ var openapi_default = {
|
|
|
4013
4029
|
type: "string",
|
|
4014
4030
|
"x-title": "Action Attempt ID"
|
|
4015
4031
|
},
|
|
4016
|
-
action_type: { enum: ["
|
|
4032
|
+
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
4017
4033
|
error: { nullable: true },
|
|
4018
4034
|
result: {
|
|
4019
4035
|
properties: {
|
|
4020
4036
|
acs_credential_on_encoder: {
|
|
4021
|
-
description: "Snapshot of
|
|
4037
|
+
description: "Snapshot of credential data read from physical encoder.",
|
|
4022
4038
|
properties: {
|
|
4023
4039
|
card_number: {
|
|
4024
4040
|
description: "A number or string that physically identifies this card.",
|
|
@@ -4452,7 +4468,7 @@ var openapi_default = {
|
|
|
4452
4468
|
type: "object"
|
|
4453
4469
|
},
|
|
4454
4470
|
{
|
|
4455
|
-
description: "Reading
|
|
4471
|
+
description: "Reading credential data from physical encoder failed.",
|
|
4456
4472
|
properties: {
|
|
4457
4473
|
action_attempt_id: {
|
|
4458
4474
|
description: "The ID of the action attempt.",
|
|
@@ -4460,7 +4476,7 @@ var openapi_default = {
|
|
|
4460
4476
|
type: "string",
|
|
4461
4477
|
"x-title": "Action Attempt ID"
|
|
4462
4478
|
},
|
|
4463
|
-
action_type: { enum: ["
|
|
4479
|
+
action_type: { enum: ["SCAN_CREDENTIAL"], type: "string" },
|
|
4464
4480
|
error: {
|
|
4465
4481
|
oneOf: [
|
|
4466
4482
|
{
|
|
@@ -4505,7 +4521,7 @@ var openapi_default = {
|
|
|
4505
4521
|
type: "object"
|
|
4506
4522
|
},
|
|
4507
4523
|
{
|
|
4508
|
-
description: "Encoding
|
|
4524
|
+
description: "Encoding credential data from physical encoder.",
|
|
4509
4525
|
properties: {
|
|
4510
4526
|
action_attempt_id: {
|
|
4511
4527
|
description: "The ID of the action attempt.",
|
|
@@ -4513,7 +4529,7 @@ var openapi_default = {
|
|
|
4513
4529
|
type: "string",
|
|
4514
4530
|
"x-title": "Action Attempt ID"
|
|
4515
4531
|
},
|
|
4516
|
-
action_type: { enum: ["
|
|
4532
|
+
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
4517
4533
|
error: { nullable: true },
|
|
4518
4534
|
result: { nullable: true },
|
|
4519
4535
|
status: { enum: ["pending"], type: "string" }
|
|
@@ -4528,7 +4544,7 @@ var openapi_default = {
|
|
|
4528
4544
|
type: "object"
|
|
4529
4545
|
},
|
|
4530
4546
|
{
|
|
4531
|
-
description: "Encoding
|
|
4547
|
+
description: "Encoding credential data from physical encoder succeeded.",
|
|
4532
4548
|
properties: {
|
|
4533
4549
|
action_attempt_id: {
|
|
4534
4550
|
description: "The ID of the action attempt.",
|
|
@@ -4536,7 +4552,7 @@ var openapi_default = {
|
|
|
4536
4552
|
type: "string",
|
|
4537
4553
|
"x-title": "Action Attempt ID"
|
|
4538
4554
|
},
|
|
4539
|
-
action_type: { enum: ["
|
|
4555
|
+
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
4540
4556
|
error: { nullable: true },
|
|
4541
4557
|
result: {
|
|
4542
4558
|
description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
@@ -4873,7 +4889,7 @@ var openapi_default = {
|
|
|
4873
4889
|
type: "object"
|
|
4874
4890
|
},
|
|
4875
4891
|
{
|
|
4876
|
-
description: "Encoding
|
|
4892
|
+
description: "Encoding credential data from physical encoder failed.",
|
|
4877
4893
|
properties: {
|
|
4878
4894
|
action_attempt_id: {
|
|
4879
4895
|
description: "The ID of the action attempt.",
|
|
@@ -4881,7 +4897,7 @@ var openapi_default = {
|
|
|
4881
4897
|
type: "string",
|
|
4882
4898
|
"x-title": "Action Attempt ID"
|
|
4883
4899
|
},
|
|
4884
|
-
action_type: { enum: ["
|
|
4900
|
+
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
4885
4901
|
error: {
|
|
4886
4902
|
oneOf: [
|
|
4887
4903
|
{
|
|
@@ -11593,16 +11609,24 @@ var openapi_default = {
|
|
|
11593
11609
|
"x-title": "Update a Credential"
|
|
11594
11610
|
}
|
|
11595
11611
|
},
|
|
11596
|
-
"/acs/encoders/
|
|
11612
|
+
"/acs/encoders/encode_credential": {
|
|
11597
11613
|
post: {
|
|
11598
|
-
operationId: "
|
|
11614
|
+
operationId: "acsEncodersEncodeCredentialPost",
|
|
11599
11615
|
requestBody: {
|
|
11600
11616
|
content: {
|
|
11601
11617
|
"application/json": {
|
|
11602
11618
|
schema: {
|
|
11603
11619
|
properties: {
|
|
11604
|
-
acs_credential_id: {
|
|
11605
|
-
|
|
11620
|
+
acs_credential_id: {
|
|
11621
|
+
description: "ID of the acs_credential to encode on a physical card.",
|
|
11622
|
+
format: "uuid",
|
|
11623
|
+
type: "string"
|
|
11624
|
+
},
|
|
11625
|
+
device_id: {
|
|
11626
|
+
description: "ID of the encoder to use for the encoding.",
|
|
11627
|
+
format: "uuid",
|
|
11628
|
+
type: "string"
|
|
11629
|
+
}
|
|
11606
11630
|
},
|
|
11607
11631
|
required: ["device_id", "acs_credential_id"],
|
|
11608
11632
|
type: "object"
|
|
@@ -11636,10 +11660,10 @@ var openapi_default = {
|
|
|
11636
11660
|
{ console_session: [] },
|
|
11637
11661
|
{ api_key: [] }
|
|
11638
11662
|
],
|
|
11639
|
-
summary: "/acs/encoders/
|
|
11663
|
+
summary: "/acs/encoders/encode_credential",
|
|
11640
11664
|
tags: ["/acs"],
|
|
11641
11665
|
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
11642
|
-
"x-fern-sdk-method-name": "
|
|
11666
|
+
"x-fern-sdk-method-name": "encode_credential",
|
|
11643
11667
|
"x-fern-sdk-return-value": "action_attempt",
|
|
11644
11668
|
"x-response-key": "action_attempt",
|
|
11645
11669
|
"x-undocumented": "Encoding a card is currently unimplemented."
|
|
@@ -11731,16 +11755,24 @@ var openapi_default = {
|
|
|
11731
11755
|
"x-undocumented": "Encoders are in alpha."
|
|
11732
11756
|
}
|
|
11733
11757
|
},
|
|
11734
|
-
"/acs/encoders/
|
|
11758
|
+
"/acs/encoders/scan_credential": {
|
|
11735
11759
|
post: {
|
|
11736
|
-
operationId: "
|
|
11760
|
+
operationId: "acsEncodersScanCredentialPost",
|
|
11737
11761
|
requestBody: {
|
|
11738
11762
|
content: {
|
|
11739
11763
|
"application/json": {
|
|
11740
11764
|
schema: {
|
|
11741
11765
|
properties: {
|
|
11742
|
-
acs_system_id: {
|
|
11743
|
-
|
|
11766
|
+
acs_system_id: {
|
|
11767
|
+
description: "ID of the acs_system the encoder belongs to.",
|
|
11768
|
+
format: "uuid",
|
|
11769
|
+
type: "string"
|
|
11770
|
+
},
|
|
11771
|
+
device_id: {
|
|
11772
|
+
description: "ID of the encoder to use for the scan.",
|
|
11773
|
+
format: "uuid",
|
|
11774
|
+
type: "string"
|
|
11775
|
+
}
|
|
11744
11776
|
},
|
|
11745
11777
|
required: ["acs_system_id", "device_id"],
|
|
11746
11778
|
type: "object"
|
|
@@ -11774,10 +11806,10 @@ var openapi_default = {
|
|
|
11774
11806
|
{ console_session: [] },
|
|
11775
11807
|
{ api_key: [] }
|
|
11776
11808
|
],
|
|
11777
|
-
summary: "/acs/encoders/
|
|
11809
|
+
summary: "/acs/encoders/scan_credential",
|
|
11778
11810
|
tags: ["/acs"],
|
|
11779
11811
|
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
11780
|
-
"x-fern-sdk-method-name": "
|
|
11812
|
+
"x-fern-sdk-method-name": "scan_credential",
|
|
11781
11813
|
"x-fern-sdk-return-value": "action_attempt",
|
|
11782
11814
|
"x-response-key": "action_attempt",
|
|
11783
11815
|
"x-undocumented": "Reading a card is currently unimplemented."
|