@seamapi/types 1.477.0 → 1.479.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 +87 -8
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +271 -4
- package/dist/index.cjs +87 -8
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +236 -0
- package/lib/seam/connect/models/batch.js +3 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customization_profiles/customization_profile.d.ts +4 -1
- package/lib/seam/connect/models/customization_profiles/customization_profile.js +2 -1
- package/lib/seam/connect/models/customization_profiles/customization_profile.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +57 -0
- package/lib/seam/connect/openapi.js +34 -5
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +92 -3
- package/package.json +1 -1
- package/src/lib/seam/connect/models/batch.ts +3 -0
- package/src/lib/seam/connect/models/customization_profiles/customization_profile.ts +2 -1
- package/src/lib/seam/connect/openapi.ts +34 -5
- package/src/lib/seam/connect/route-types.ts +96 -3
package/dist/index.cjs
CHANGED
|
@@ -2268,6 +2268,53 @@ var unmanaged_access_code = access_code.pick({
|
|
|
2268
2268
|
|
|
2269
2269
|
- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
|
|
2270
2270
|
`);
|
|
2271
|
+
var requested_access_method = zod.z.object({
|
|
2272
|
+
display_name: zod.z.string().describe("Display name of the access method."),
|
|
2273
|
+
mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
|
|
2274
|
+
"Access method mode. Supported values: `code`, `card`, `mobile_key`."
|
|
2275
|
+
),
|
|
2276
|
+
created_at: zod.z.string().datetime().describe(
|
|
2277
|
+
"Date and time at which the requested access method was added to the Access Grant."
|
|
2278
|
+
),
|
|
2279
|
+
created_access_method_ids: zod.z.array(zod.z.string().uuid()).describe(
|
|
2280
|
+
"IDs of the access methods created for the requested access method."
|
|
2281
|
+
)
|
|
2282
|
+
});
|
|
2283
|
+
|
|
2284
|
+
// src/lib/seam/connect/models/access-grants/access-grant.ts
|
|
2285
|
+
var access_grant = zod.z.object({
|
|
2286
|
+
workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the Access Grant."),
|
|
2287
|
+
access_grant_id: zod.z.string().uuid().describe("ID of the Access Grant."),
|
|
2288
|
+
access_grant_key: zod.z.string().optional().describe("Unique key for the access grant within the workspace."),
|
|
2289
|
+
user_identity_id: zod.z.string().uuid().describe("ID of user identity to which the Access Grant gives access."),
|
|
2290
|
+
location_ids: zod.z.array(zod.z.string().uuid()).describe(`
|
|
2291
|
+
---
|
|
2292
|
+
deprecated: Use \`space_ids\`.
|
|
2293
|
+
---
|
|
2294
|
+
`),
|
|
2295
|
+
space_ids: zod.z.array(zod.z.string().uuid()).describe("IDs of the spaces to which the Access Grant gives access."),
|
|
2296
|
+
requested_access_methods: zod.z.array(requested_access_method).describe("Access methods that the user requested for the Access Grant."),
|
|
2297
|
+
access_method_ids: zod.z.array(zod.z.string().uuid()).describe("IDs of the access methods created for the Access Grant."),
|
|
2298
|
+
client_session_token: zod.z.string().optional().describe(
|
|
2299
|
+
"Client Session Token. Only returned if the Access Grant has a mobile_key access method."
|
|
2300
|
+
),
|
|
2301
|
+
name: zod.z.string().nullable().describe(
|
|
2302
|
+
"Name of the Access Grant. If not provided, the display name will be computed."
|
|
2303
|
+
),
|
|
2304
|
+
display_name: zod.z.string().describe("Display name of the Access Grant."),
|
|
2305
|
+
instant_key_url: zod.z.string().url().optional().describe(
|
|
2306
|
+
"Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. "
|
|
2307
|
+
),
|
|
2308
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the Access Grant was created."),
|
|
2309
|
+
starts_at: zod.z.string().datetime().describe("Date and time at which the Access Grant starts."),
|
|
2310
|
+
ends_at: zod.z.string().datetime().nullable().describe("Date and time at which the Access Grant ends.")
|
|
2311
|
+
}).describe(`
|
|
2312
|
+
---
|
|
2313
|
+
draft: Early access.
|
|
2314
|
+
route_path: /access_grants
|
|
2315
|
+
---
|
|
2316
|
+
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.
|
|
2317
|
+
`);
|
|
2271
2318
|
var access_method = zod.z.object({
|
|
2272
2319
|
workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
|
|
2273
2320
|
access_method_id: zod.z.string().uuid().describe("ID of the access method."),
|
|
@@ -4161,7 +4208,8 @@ zod.z.object({
|
|
|
4161
4208
|
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
4162
4209
|
unmanaged_devices: unmanaged_device.array().optional(),
|
|
4163
4210
|
connect_webviews: connect_webview.array().optional(),
|
|
4164
|
-
access_methods: access_method.array().optional()
|
|
4211
|
+
access_methods: access_method.array().optional(),
|
|
4212
|
+
access_grants: access_grant.array().optional()
|
|
4165
4213
|
}).describe("A batch of workspace resources.");
|
|
4166
4214
|
var batch = zod.z.object({
|
|
4167
4215
|
batch_type: zod.z.enum([
|
|
@@ -4185,7 +4233,8 @@ var batch = zod.z.object({
|
|
|
4185
4233
|
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
4186
4234
|
unmanaged_devices: unmanaged_device.array().optional(),
|
|
4187
4235
|
connect_webviews: connect_webview.array().optional(),
|
|
4188
|
-
access_methods: access_method.array().optional()
|
|
4236
|
+
access_methods: access_method.array().optional(),
|
|
4237
|
+
access_grants: access_grant.array().optional()
|
|
4189
4238
|
}).describe("A batch of workspace resources.");
|
|
4190
4239
|
var bridge = zod.z.object({
|
|
4191
4240
|
bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
|
|
@@ -4265,8 +4314,9 @@ var bridge_client_session = zod.z.object({
|
|
|
4265
4314
|
Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
|
|
4266
4315
|
`);
|
|
4267
4316
|
var customization_profile = zod.z.object({
|
|
4268
|
-
customization_profile_id: zod.z.string().uuid(),
|
|
4269
4317
|
workspace_id: zod.z.string().uuid(),
|
|
4318
|
+
name: zod.z.string().nullable(),
|
|
4319
|
+
customization_profile_id: zod.z.string().uuid(),
|
|
4270
4320
|
created_at: zod.z.string().datetime(),
|
|
4271
4321
|
logo_url: zod.z.string().url().optional(),
|
|
4272
4322
|
primary_color: zod.z.string().optional(),
|
|
@@ -31729,6 +31779,10 @@ var openapi_default = {
|
|
|
31729
31779
|
batch: {
|
|
31730
31780
|
description: "A batch of workspace resources.",
|
|
31731
31781
|
properties: {
|
|
31782
|
+
access_grants: {
|
|
31783
|
+
items: { $ref: "#/components/schemas/access_grant" },
|
|
31784
|
+
type: "array"
|
|
31785
|
+
},
|
|
31732
31786
|
access_methods: {
|
|
31733
31787
|
items: { $ref: "#/components/schemas/access_method" },
|
|
31734
31788
|
type: "array"
|
|
@@ -31890,6 +31944,10 @@ var openapi_default = {
|
|
|
31890
31944
|
batch: {
|
|
31891
31945
|
description: "A batch of workspace resources.",
|
|
31892
31946
|
properties: {
|
|
31947
|
+
access_grants: {
|
|
31948
|
+
items: { $ref: "#/components/schemas/access_grant" },
|
|
31949
|
+
type: "array"
|
|
31950
|
+
},
|
|
31893
31951
|
access_methods: {
|
|
31894
31952
|
items: { $ref: "#/components/schemas/access_method" },
|
|
31895
31953
|
type: "array"
|
|
@@ -57256,6 +57314,7 @@ var openapi_default = {
|
|
|
57256
57314
|
"application/json": {
|
|
57257
57315
|
schema: {
|
|
57258
57316
|
properties: {
|
|
57317
|
+
name: { default: null, nullable: true, type: "string" },
|
|
57259
57318
|
primary_color: { type: "string" },
|
|
57260
57319
|
secondary_color: { type: "string" }
|
|
57261
57320
|
},
|
|
@@ -57280,13 +57339,15 @@ var openapi_default = {
|
|
|
57280
57339
|
type: "string"
|
|
57281
57340
|
},
|
|
57282
57341
|
logo_url: { format: "uri", type: "string" },
|
|
57342
|
+
name: { nullable: true, type: "string" },
|
|
57283
57343
|
primary_color: { type: "string" },
|
|
57284
57344
|
secondary_color: { type: "string" },
|
|
57285
57345
|
workspace_id: { format: "uuid", type: "string" }
|
|
57286
57346
|
},
|
|
57287
57347
|
required: [
|
|
57288
|
-
"customization_profile_id",
|
|
57289
57348
|
"workspace_id",
|
|
57349
|
+
"name",
|
|
57350
|
+
"customization_profile_id",
|
|
57290
57351
|
"created_at"
|
|
57291
57352
|
],
|
|
57292
57353
|
type: "object",
|
|
@@ -57344,13 +57405,15 @@ var openapi_default = {
|
|
|
57344
57405
|
type: "string"
|
|
57345
57406
|
},
|
|
57346
57407
|
logo_url: { format: "uri", type: "string" },
|
|
57408
|
+
name: { nullable: true, type: "string" },
|
|
57347
57409
|
primary_color: { type: "string" },
|
|
57348
57410
|
secondary_color: { type: "string" },
|
|
57349
57411
|
workspace_id: { format: "uuid", type: "string" }
|
|
57350
57412
|
},
|
|
57351
57413
|
required: [
|
|
57352
|
-
"customization_profile_id",
|
|
57353
57414
|
"workspace_id",
|
|
57415
|
+
"name",
|
|
57416
|
+
"customization_profile_id",
|
|
57354
57417
|
"created_at"
|
|
57355
57418
|
],
|
|
57356
57419
|
type: "object",
|
|
@@ -57411,13 +57474,15 @@ var openapi_default = {
|
|
|
57411
57474
|
type: "string"
|
|
57412
57475
|
},
|
|
57413
57476
|
logo_url: { format: "uri", type: "string" },
|
|
57477
|
+
name: { nullable: true, type: "string" },
|
|
57414
57478
|
primary_color: { type: "string" },
|
|
57415
57479
|
secondary_color: { type: "string" },
|
|
57416
57480
|
workspace_id: { format: "uuid", type: "string" }
|
|
57417
57481
|
},
|
|
57418
57482
|
required: [
|
|
57419
|
-
"customization_profile_id",
|
|
57420
57483
|
"workspace_id",
|
|
57484
|
+
"name",
|
|
57485
|
+
"customization_profile_id",
|
|
57421
57486
|
"created_at"
|
|
57422
57487
|
],
|
|
57423
57488
|
type: "object",
|
|
@@ -57468,13 +57533,15 @@ var openapi_default = {
|
|
|
57468
57533
|
type: "string"
|
|
57469
57534
|
},
|
|
57470
57535
|
logo_url: { format: "uri", type: "string" },
|
|
57536
|
+
name: { nullable: true, type: "string" },
|
|
57471
57537
|
primary_color: { type: "string" },
|
|
57472
57538
|
secondary_color: { type: "string" },
|
|
57473
57539
|
workspace_id: { format: "uuid", type: "string" }
|
|
57474
57540
|
},
|
|
57475
57541
|
required: [
|
|
57476
|
-
"customization_profile_id",
|
|
57477
57542
|
"workspace_id",
|
|
57543
|
+
"name",
|
|
57544
|
+
"customization_profile_id",
|
|
57478
57545
|
"created_at"
|
|
57479
57546
|
],
|
|
57480
57547
|
type: "object",
|
|
@@ -57525,13 +57592,15 @@ var openapi_default = {
|
|
|
57525
57592
|
type: "string"
|
|
57526
57593
|
},
|
|
57527
57594
|
logo_url: { format: "uri", type: "string" },
|
|
57595
|
+
name: { nullable: true, type: "string" },
|
|
57528
57596
|
primary_color: { type: "string" },
|
|
57529
57597
|
secondary_color: { type: "string" },
|
|
57530
57598
|
workspace_id: { format: "uuid", type: "string" }
|
|
57531
57599
|
},
|
|
57532
57600
|
required: [
|
|
57533
|
-
"customization_profile_id",
|
|
57534
57601
|
"workspace_id",
|
|
57602
|
+
"name",
|
|
57603
|
+
"customization_profile_id",
|
|
57535
57604
|
"created_at"
|
|
57536
57605
|
],
|
|
57537
57606
|
type: "object",
|
|
@@ -57574,6 +57643,7 @@ var openapi_default = {
|
|
|
57574
57643
|
schema: {
|
|
57575
57644
|
properties: {
|
|
57576
57645
|
customization_profile_id: { format: "uuid", type: "string" },
|
|
57646
|
+
name: { nullable: true, type: "string" },
|
|
57577
57647
|
primary_color: { type: "string" },
|
|
57578
57648
|
secondary_color: { type: "string" }
|
|
57579
57649
|
},
|
|
@@ -57617,6 +57687,7 @@ var openapi_default = {
|
|
|
57617
57687
|
schema: {
|
|
57618
57688
|
properties: {
|
|
57619
57689
|
customization_profile_id: { format: "uuid", type: "string" },
|
|
57690
|
+
name: { nullable: true, type: "string" },
|
|
57620
57691
|
primary_color: { type: "string" },
|
|
57621
57692
|
secondary_color: { type: "string" }
|
|
57622
57693
|
},
|
|
@@ -57703,6 +57774,10 @@ var openapi_default = {
|
|
|
57703
57774
|
batch: {
|
|
57704
57775
|
description: "A batch of workspace resources.",
|
|
57705
57776
|
properties: {
|
|
57777
|
+
access_grants: {
|
|
57778
|
+
items: { $ref: "#/components/schemas/access_grant" },
|
|
57779
|
+
type: "array"
|
|
57780
|
+
},
|
|
57706
57781
|
access_methods: {
|
|
57707
57782
|
items: { $ref: "#/components/schemas/access_method" },
|
|
57708
57783
|
type: "array"
|
|
@@ -57841,6 +57916,10 @@ var openapi_default = {
|
|
|
57841
57916
|
batch: {
|
|
57842
57917
|
description: "A batch of workspace resources.",
|
|
57843
57918
|
properties: {
|
|
57919
|
+
access_grants: {
|
|
57920
|
+
items: { $ref: "#/components/schemas/access_grant" },
|
|
57921
|
+
type: "array"
|
|
57922
|
+
},
|
|
57844
57923
|
access_methods: {
|
|
57845
57924
|
items: { $ref: "#/components/schemas/access_method" },
|
|
57846
57925
|
type: "array"
|