@seamapi/types 1.554.0 → 1.555.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 +123 -17
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +259 -0
- package/dist/index.cjs +123 -17
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +54 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +24 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +54 -0
- package/lib/seam/connect/models/access-grants/access-method.js +24 -0
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +10 -10
- package/lib/seam/connect/models/batch.d.ts +136 -0
- package/lib/seam/connect/openapi.d.ts +62 -0
- package/lib/seam/connect/openapi.js +64 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +81 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
- package/src/lib/seam/connect/models/access-grants/access-method.ts +40 -0
- package/src/lib/seam/connect/openapi.ts +76 -0
- package/src/lib/seam/connect/route-types.ts +81 -0
package/dist/connect.cjs
CHANGED
|
@@ -2310,6 +2310,24 @@ var requested_access_method = zod.z.object({
|
|
|
2310
2310
|
});
|
|
2311
2311
|
|
|
2312
2312
|
// src/lib/seam/connect/models/access-grants/access-grant.ts
|
|
2313
|
+
var common_access_grant_warning = zod.z.object({
|
|
2314
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
2315
|
+
message: zod.z.string().describe(
|
|
2316
|
+
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
2317
|
+
)
|
|
2318
|
+
});
|
|
2319
|
+
var warning_code_description4 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
2320
|
+
var being_deleted = common_access_grant_warning.extend({
|
|
2321
|
+
warning_code: zod.z.literal("being_deleted").describe(warning_code_description4)
|
|
2322
|
+
}).describe(
|
|
2323
|
+
"Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted."
|
|
2324
|
+
);
|
|
2325
|
+
var access_grant_warning = zod.z.discriminatedUnion("warning_code", [being_deleted]).describe(
|
|
2326
|
+
"Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)."
|
|
2327
|
+
);
|
|
2328
|
+
zod.z.object({
|
|
2329
|
+
being_deleted: being_deleted.optional().nullable()
|
|
2330
|
+
});
|
|
2313
2331
|
var access_grant = zod.z.object({
|
|
2314
2332
|
workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the Access Grant."),
|
|
2315
2333
|
access_grant_id: zod.z.string().uuid().describe("ID of the Access Grant."),
|
|
@@ -2336,6 +2354,9 @@ var access_grant = zod.z.object({
|
|
|
2336
2354
|
created_at: zod.z.string().datetime().describe("Date and time at which the Access Grant was created."),
|
|
2337
2355
|
starts_at: zod.z.string().datetime().describe("Date and time at which the Access Grant starts."),
|
|
2338
2356
|
ends_at: zod.z.string().datetime().nullable().describe("Date and time at which the Access Grant ends."),
|
|
2357
|
+
warnings: zod.z.array(access_grant_warning).describe(
|
|
2358
|
+
"Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants)."
|
|
2359
|
+
),
|
|
2339
2360
|
customization_profile_id: zod.z.string().uuid().optional().describe(
|
|
2340
2361
|
"ID of the customization profile associated with the Access Grant."
|
|
2341
2362
|
)
|
|
@@ -2346,6 +2367,24 @@ var access_grant = zod.z.object({
|
|
|
2346
2367
|
---
|
|
2347
2368
|
Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
|
|
2348
2369
|
`);
|
|
2370
|
+
var common_access_method_warning = zod.z.object({
|
|
2371
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
2372
|
+
message: zod.z.string().describe(
|
|
2373
|
+
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
2374
|
+
)
|
|
2375
|
+
});
|
|
2376
|
+
var warning_code_description5 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
2377
|
+
var being_deleted2 = common_access_method_warning.extend({
|
|
2378
|
+
warning_code: zod.z.literal("being_deleted").describe(warning_code_description5)
|
|
2379
|
+
}).describe(
|
|
2380
|
+
"Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted."
|
|
2381
|
+
);
|
|
2382
|
+
var access_method_warning = zod.z.discriminatedUnion("warning_code", [being_deleted2]).describe(
|
|
2383
|
+
"Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)."
|
|
2384
|
+
);
|
|
2385
|
+
zod.z.object({
|
|
2386
|
+
being_deleted: being_deleted2.optional().nullable()
|
|
2387
|
+
});
|
|
2349
2388
|
var access_method = zod.z.object({
|
|
2350
2389
|
workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
|
|
2351
2390
|
access_method_id: zod.z.string().uuid().describe("ID of the access method."),
|
|
@@ -2362,6 +2401,9 @@ var access_method = zod.z.object({
|
|
|
2362
2401
|
"Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method."
|
|
2363
2402
|
),
|
|
2364
2403
|
code: zod.z.string().nullable().optional().describe("The actual PIN code for code access methods."),
|
|
2404
|
+
warnings: zod.z.array(access_method_warning).describe(
|
|
2405
|
+
"Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods)."
|
|
2406
|
+
),
|
|
2365
2407
|
customization_profile_id: zod.z.string().uuid().optional().describe(
|
|
2366
2408
|
"ID of the customization profile associated with the access method."
|
|
2367
2409
|
)
|
|
@@ -2387,9 +2429,9 @@ var common_acs_access_group_warning = zod.z.object({
|
|
|
2387
2429
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
2388
2430
|
)
|
|
2389
2431
|
});
|
|
2390
|
-
var
|
|
2432
|
+
var warning_code_description6 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
2391
2433
|
var unknown_issue_with_acs_access_group = common_acs_access_group_warning.extend({
|
|
2392
|
-
warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(
|
|
2434
|
+
warning_code: zod.z.literal("unknown_issue_with_acs_access_group").describe(warning_code_description6)
|
|
2393
2435
|
}).describe(
|
|
2394
2436
|
"An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group."
|
|
2395
2437
|
);
|
|
@@ -2562,34 +2604,34 @@ var common_acs_credential_warning = zod.z.object({
|
|
|
2562
2604
|
"Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
|
|
2563
2605
|
)
|
|
2564
2606
|
});
|
|
2565
|
-
var
|
|
2607
|
+
var warning_code_description7 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
2566
2608
|
var waiting_to_be_issued = common_acs_credential_warning.extend({
|
|
2567
|
-
warning_code: zod.z.literal("waiting_to_be_issued").describe(
|
|
2609
|
+
warning_code: zod.z.literal("waiting_to_be_issued").describe(warning_code_description7)
|
|
2568
2610
|
}).describe(
|
|
2569
2611
|
"Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued."
|
|
2570
2612
|
);
|
|
2571
2613
|
var schedule_externally_modified = common_acs_credential_warning.extend({
|
|
2572
|
-
warning_code: zod.z.literal("schedule_externally_modified").describe(
|
|
2614
|
+
warning_code: zod.z.literal("schedule_externally_modified").describe(warning_code_description7)
|
|
2573
2615
|
}).describe(
|
|
2574
2616
|
"Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally."
|
|
2575
2617
|
);
|
|
2576
2618
|
var schedule_modified = common_acs_credential_warning.extend({
|
|
2577
|
-
warning_code: zod.z.literal("schedule_modified").describe(
|
|
2619
|
+
warning_code: zod.z.literal("schedule_modified").describe(warning_code_description7)
|
|
2578
2620
|
}).describe(
|
|
2579
2621
|
"Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past."
|
|
2580
2622
|
);
|
|
2581
|
-
var
|
|
2582
|
-
warning_code: zod.z.literal("being_deleted").describe(
|
|
2623
|
+
var being_deleted3 = common_acs_credential_warning.extend({
|
|
2624
|
+
warning_code: zod.z.literal("being_deleted").describe(warning_code_description7)
|
|
2583
2625
|
}).describe(
|
|
2584
2626
|
"Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted."
|
|
2585
2627
|
);
|
|
2586
2628
|
var unknown_issue_with_acs_credential = common_acs_credential_warning.extend({
|
|
2587
|
-
warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(
|
|
2629
|
+
warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(warning_code_description7)
|
|
2588
2630
|
}).describe(
|
|
2589
2631
|
"An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential."
|
|
2590
2632
|
);
|
|
2591
2633
|
var needs_to_be_reissued = common_acs_credential_warning.extend({
|
|
2592
|
-
warning_code: zod.z.literal("needs_to_be_reissued").describe(
|
|
2634
|
+
warning_code: zod.z.literal("needs_to_be_reissued").describe(warning_code_description7)
|
|
2593
2635
|
}).describe(
|
|
2594
2636
|
"Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential."
|
|
2595
2637
|
);
|
|
@@ -2597,7 +2639,7 @@ var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
|
|
|
2597
2639
|
waiting_to_be_issued,
|
|
2598
2640
|
schedule_externally_modified,
|
|
2599
2641
|
schedule_modified,
|
|
2600
|
-
|
|
2642
|
+
being_deleted3,
|
|
2601
2643
|
unknown_issue_with_acs_credential,
|
|
2602
2644
|
needs_to_be_reissued
|
|
2603
2645
|
]).describe(
|
|
@@ -2607,7 +2649,7 @@ zod.z.object({
|
|
|
2607
2649
|
waiting_to_be_issued: waiting_to_be_issued.optional().nullable(),
|
|
2608
2650
|
schedule_externally_modified: schedule_externally_modified.optional().nullable(),
|
|
2609
2651
|
schedule_modified: schedule_modified.optional().nullable(),
|
|
2610
|
-
being_deleted:
|
|
2652
|
+
being_deleted: being_deleted3.optional().nullable(),
|
|
2611
2653
|
unknown_issue_with_acs_credential: unknown_issue_with_acs_credential.optional().nullable(),
|
|
2612
2654
|
needs_to_be_reissued: needs_to_be_reissued.optional().nullable()
|
|
2613
2655
|
});
|
|
@@ -2956,7 +2998,7 @@ var common_acs_system_error = zod.z.object({
|
|
|
2956
2998
|
)
|
|
2957
2999
|
});
|
|
2958
3000
|
var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
2959
|
-
var
|
|
3001
|
+
var warning_code_description8 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
|
|
2960
3002
|
var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
2961
3003
|
error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description5)
|
|
2962
3004
|
}).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
@@ -3019,12 +3061,12 @@ var common_acs_system_warning = zod.z.object({
|
|
|
3019
3061
|
)
|
|
3020
3062
|
});
|
|
3021
3063
|
var salto_ks_subscription_limit_almost_reached3 = common_acs_system_warning.extend({
|
|
3022
|
-
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
|
|
3064
|
+
warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description8)
|
|
3023
3065
|
}).describe(
|
|
3024
3066
|
"Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue."
|
|
3025
3067
|
);
|
|
3026
3068
|
var time_zone_does_not_match_location = common_acs_system_warning.extend({
|
|
3027
|
-
warning_code: zod.z.literal("time_zone_does_not_match_location").describe(
|
|
3069
|
+
warning_code: zod.z.literal("time_zone_does_not_match_location").describe(warning_code_description8),
|
|
3028
3070
|
misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
|
|
3029
3071
|
`
|
|
3030
3072
|
---
|
|
@@ -7327,6 +7369,37 @@ var openapi_default = {
|
|
|
7327
7369
|
format: "uuid",
|
|
7328
7370
|
type: "string"
|
|
7329
7371
|
},
|
|
7372
|
+
warnings: {
|
|
7373
|
+
description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
7374
|
+
items: {
|
|
7375
|
+
description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
7376
|
+
discriminator: { propertyName: "warning_code" },
|
|
7377
|
+
oneOf: [
|
|
7378
|
+
{
|
|
7379
|
+
description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
|
|
7380
|
+
properties: {
|
|
7381
|
+
created_at: {
|
|
7382
|
+
description: "Date and time at which Seam created the warning.",
|
|
7383
|
+
format: "date-time",
|
|
7384
|
+
type: "string"
|
|
7385
|
+
},
|
|
7386
|
+
message: {
|
|
7387
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
7388
|
+
type: "string"
|
|
7389
|
+
},
|
|
7390
|
+
warning_code: {
|
|
7391
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
7392
|
+
enum: ["being_deleted"],
|
|
7393
|
+
type: "string"
|
|
7394
|
+
}
|
|
7395
|
+
},
|
|
7396
|
+
required: ["created_at", "message", "warning_code"],
|
|
7397
|
+
type: "object"
|
|
7398
|
+
}
|
|
7399
|
+
]
|
|
7400
|
+
},
|
|
7401
|
+
type: "array"
|
|
7402
|
+
},
|
|
7330
7403
|
workspace_id: {
|
|
7331
7404
|
description: "ID of the Seam workspace associated with the Access Grant.",
|
|
7332
7405
|
format: "uuid",
|
|
@@ -7345,7 +7418,8 @@ var openapi_default = {
|
|
|
7345
7418
|
"display_name",
|
|
7346
7419
|
"created_at",
|
|
7347
7420
|
"starts_at",
|
|
7348
|
-
"ends_at"
|
|
7421
|
+
"ends_at",
|
|
7422
|
+
"warnings"
|
|
7349
7423
|
],
|
|
7350
7424
|
type: "object",
|
|
7351
7425
|
"x-draft": "Early access.",
|
|
@@ -7406,6 +7480,37 @@ var openapi_default = {
|
|
|
7406
7480
|
enum: ["code", "card", "mobile_key"],
|
|
7407
7481
|
type: "string"
|
|
7408
7482
|
},
|
|
7483
|
+
warnings: {
|
|
7484
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
7485
|
+
items: {
|
|
7486
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
7487
|
+
discriminator: { propertyName: "warning_code" },
|
|
7488
|
+
oneOf: [
|
|
7489
|
+
{
|
|
7490
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
7491
|
+
properties: {
|
|
7492
|
+
created_at: {
|
|
7493
|
+
description: "Date and time at which Seam created the warning.",
|
|
7494
|
+
format: "date-time",
|
|
7495
|
+
type: "string"
|
|
7496
|
+
},
|
|
7497
|
+
message: {
|
|
7498
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
7499
|
+
type: "string"
|
|
7500
|
+
},
|
|
7501
|
+
warning_code: {
|
|
7502
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
7503
|
+
enum: ["being_deleted"],
|
|
7504
|
+
type: "string"
|
|
7505
|
+
}
|
|
7506
|
+
},
|
|
7507
|
+
required: ["created_at", "message", "warning_code"],
|
|
7508
|
+
type: "object"
|
|
7509
|
+
}
|
|
7510
|
+
]
|
|
7511
|
+
},
|
|
7512
|
+
type: "array"
|
|
7513
|
+
},
|
|
7409
7514
|
workspace_id: {
|
|
7410
7515
|
description: "ID of the Seam workspace associated with the access method.",
|
|
7411
7516
|
format: "uuid",
|
|
@@ -7419,7 +7524,8 @@ var openapi_default = {
|
|
|
7419
7524
|
"mode",
|
|
7420
7525
|
"created_at",
|
|
7421
7526
|
"issued_at",
|
|
7422
|
-
"is_issued"
|
|
7527
|
+
"is_issued",
|
|
7528
|
+
"warnings"
|
|
7423
7529
|
],
|
|
7424
7530
|
type: "object",
|
|
7425
7531
|
"x-draft": "Early access.",
|