@seamapi/types 1.589.0 → 1.590.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 +92 -1
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +191 -0
- package/dist/index.cjs +92 -1
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +50 -0
- package/lib/seam/connect/models/spaces/space.d.ts +6 -0
- package/lib/seam/connect/models/spaces/space.js +10 -0
- package/lib/seam/connect/models/spaces/space.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +97 -0
- package/lib/seam/connect/openapi.js +81 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +78 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/spaces/space.ts +10 -0
- package/src/lib/seam/connect/openapi.ts +85 -0
- package/src/lib/seam/connect/route-types.ts +78 -0
package/dist/connect.d.cts
CHANGED
|
@@ -10373,6 +10373,8 @@ declare const batch: z.ZodObject<{
|
|
|
10373
10373
|
created_at: z.ZodString;
|
|
10374
10374
|
device_count: z.ZodNumber;
|
|
10375
10375
|
acs_entrance_count: z.ZodNumber;
|
|
10376
|
+
parent_space_id: z.ZodOptional<z.ZodString>;
|
|
10377
|
+
parent_space_key: z.ZodOptional<z.ZodString>;
|
|
10376
10378
|
}, "strip", z.ZodTypeAny, {
|
|
10377
10379
|
name: string;
|
|
10378
10380
|
display_name: string;
|
|
@@ -10382,6 +10384,8 @@ declare const batch: z.ZodObject<{
|
|
|
10382
10384
|
space_id: string;
|
|
10383
10385
|
acs_entrance_count: number;
|
|
10384
10386
|
space_key?: string | undefined;
|
|
10387
|
+
parent_space_id?: string | undefined;
|
|
10388
|
+
parent_space_key?: string | undefined;
|
|
10385
10389
|
}, {
|
|
10386
10390
|
name: string;
|
|
10387
10391
|
display_name: string;
|
|
@@ -10391,6 +10395,8 @@ declare const batch: z.ZodObject<{
|
|
|
10391
10395
|
space_id: string;
|
|
10392
10396
|
acs_entrance_count: number;
|
|
10393
10397
|
space_key?: string | undefined;
|
|
10398
|
+
parent_space_id?: string | undefined;
|
|
10399
|
+
parent_space_key?: string | undefined;
|
|
10394
10400
|
}>, "many">>;
|
|
10395
10401
|
devices: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
10396
10402
|
device_id: z.ZodString;
|
|
@@ -30889,6 +30895,8 @@ declare const batch: z.ZodObject<{
|
|
|
30889
30895
|
space_id: string;
|
|
30890
30896
|
acs_entrance_count: number;
|
|
30891
30897
|
space_key?: string | undefined;
|
|
30898
|
+
parent_space_id?: string | undefined;
|
|
30899
|
+
parent_space_key?: string | undefined;
|
|
30892
30900
|
}[] | undefined;
|
|
30893
30901
|
devices?: {
|
|
30894
30902
|
display_name: string;
|
|
@@ -34786,6 +34794,8 @@ declare const batch: z.ZodObject<{
|
|
|
34786
34794
|
space_id: string;
|
|
34787
34795
|
acs_entrance_count: number;
|
|
34788
34796
|
space_key?: string | undefined;
|
|
34797
|
+
parent_space_id?: string | undefined;
|
|
34798
|
+
parent_space_key?: string | undefined;
|
|
34789
34799
|
}[] | undefined;
|
|
34790
34800
|
devices?: {
|
|
34791
34801
|
display_name: string;
|
|
@@ -50852,6 +50862,8 @@ declare const space: z.ZodObject<{
|
|
|
50852
50862
|
created_at: z.ZodString;
|
|
50853
50863
|
device_count: z.ZodNumber;
|
|
50854
50864
|
acs_entrance_count: z.ZodNumber;
|
|
50865
|
+
parent_space_id: z.ZodOptional<z.ZodString>;
|
|
50866
|
+
parent_space_key: z.ZodOptional<z.ZodString>;
|
|
50855
50867
|
}, "strip", z.ZodTypeAny, {
|
|
50856
50868
|
name: string;
|
|
50857
50869
|
display_name: string;
|
|
@@ -50861,6 +50873,8 @@ declare const space: z.ZodObject<{
|
|
|
50861
50873
|
space_id: string;
|
|
50862
50874
|
acs_entrance_count: number;
|
|
50863
50875
|
space_key?: string | undefined;
|
|
50876
|
+
parent_space_id?: string | undefined;
|
|
50877
|
+
parent_space_key?: string | undefined;
|
|
50864
50878
|
}, {
|
|
50865
50879
|
name: string;
|
|
50866
50880
|
display_name: string;
|
|
@@ -50870,6 +50884,8 @@ declare const space: z.ZodObject<{
|
|
|
50870
50884
|
space_id: string;
|
|
50871
50885
|
acs_entrance_count: number;
|
|
50872
50886
|
space_key?: string | undefined;
|
|
50887
|
+
parent_space_id?: string | undefined;
|
|
50888
|
+
parent_space_key?: string | undefined;
|
|
50873
50889
|
}>;
|
|
50874
50890
|
type Space = z.infer<typeof space>;
|
|
50875
50891
|
|
|
@@ -63469,6 +63485,15 @@ declare const _default: {
|
|
|
63469
63485
|
description: string;
|
|
63470
63486
|
type: string;
|
|
63471
63487
|
};
|
|
63488
|
+
parent_space_id: {
|
|
63489
|
+
format: string;
|
|
63490
|
+
type: string;
|
|
63491
|
+
'x-undocumented': string;
|
|
63492
|
+
};
|
|
63493
|
+
parent_space_key: {
|
|
63494
|
+
type: string;
|
|
63495
|
+
'x-undocumented': string;
|
|
63496
|
+
};
|
|
63472
63497
|
space_id: {
|
|
63473
63498
|
description: string;
|
|
63474
63499
|
format: string;
|
|
@@ -94687,6 +94712,94 @@ declare const _default: {
|
|
|
94687
94712
|
'x-undocumented': string;
|
|
94688
94713
|
};
|
|
94689
94714
|
};
|
|
94715
|
+
'/seam/customer/v1/spaces/create': {
|
|
94716
|
+
post: {
|
|
94717
|
+
description: string;
|
|
94718
|
+
operationId: string;
|
|
94719
|
+
requestBody: {
|
|
94720
|
+
content: {
|
|
94721
|
+
'application/json': {
|
|
94722
|
+
schema: {
|
|
94723
|
+
properties: {
|
|
94724
|
+
acs_entrance_ids: {
|
|
94725
|
+
description: string;
|
|
94726
|
+
items: {
|
|
94727
|
+
format: string;
|
|
94728
|
+
type: string;
|
|
94729
|
+
};
|
|
94730
|
+
type: string;
|
|
94731
|
+
};
|
|
94732
|
+
device_ids: {
|
|
94733
|
+
description: string;
|
|
94734
|
+
items: {
|
|
94735
|
+
format: string;
|
|
94736
|
+
type: string;
|
|
94737
|
+
};
|
|
94738
|
+
type: string;
|
|
94739
|
+
};
|
|
94740
|
+
name: {
|
|
94741
|
+
description: string;
|
|
94742
|
+
type: string;
|
|
94743
|
+
};
|
|
94744
|
+
parent_space_key: {
|
|
94745
|
+
description: string;
|
|
94746
|
+
type: string;
|
|
94747
|
+
};
|
|
94748
|
+
parent_space_name: {
|
|
94749
|
+
description: string;
|
|
94750
|
+
type: string;
|
|
94751
|
+
};
|
|
94752
|
+
space_key: {
|
|
94753
|
+
description: string;
|
|
94754
|
+
type: string;
|
|
94755
|
+
};
|
|
94756
|
+
};
|
|
94757
|
+
required: string[];
|
|
94758
|
+
type: string;
|
|
94759
|
+
};
|
|
94760
|
+
};
|
|
94761
|
+
};
|
|
94762
|
+
};
|
|
94763
|
+
responses: {
|
|
94764
|
+
200: {
|
|
94765
|
+
content: {
|
|
94766
|
+
'application/json': {
|
|
94767
|
+
schema: {
|
|
94768
|
+
properties: {
|
|
94769
|
+
ok: {
|
|
94770
|
+
type: string;
|
|
94771
|
+
};
|
|
94772
|
+
space: {
|
|
94773
|
+
$ref: string;
|
|
94774
|
+
};
|
|
94775
|
+
};
|
|
94776
|
+
required: string[];
|
|
94777
|
+
type: string;
|
|
94778
|
+
};
|
|
94779
|
+
};
|
|
94780
|
+
};
|
|
94781
|
+
description: string;
|
|
94782
|
+
};
|
|
94783
|
+
400: {
|
|
94784
|
+
description: string;
|
|
94785
|
+
};
|
|
94786
|
+
401: {
|
|
94787
|
+
description: string;
|
|
94788
|
+
};
|
|
94789
|
+
};
|
|
94790
|
+
security: {
|
|
94791
|
+
client_session_with_customer: never[];
|
|
94792
|
+
}[];
|
|
94793
|
+
summary: string;
|
|
94794
|
+
tags: never[];
|
|
94795
|
+
'x-draft': string;
|
|
94796
|
+
'x-fern-sdk-group-name': string[];
|
|
94797
|
+
'x-fern-sdk-method-name': string;
|
|
94798
|
+
'x-fern-sdk-return-value': string;
|
|
94799
|
+
'x-response-key': string;
|
|
94800
|
+
'x-title': string;
|
|
94801
|
+
};
|
|
94802
|
+
};
|
|
94690
94803
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
94691
94804
|
post: {
|
|
94692
94805
|
description: string;
|
|
@@ -116889,6 +117002,10 @@ type Routes = {
|
|
|
116889
117002
|
device_count: number;
|
|
116890
117003
|
/** Number of entrances in the space. */
|
|
116891
117004
|
acs_entrance_count: number;
|
|
117005
|
+
/** */
|
|
117006
|
+
parent_space_id?: string | undefined;
|
|
117007
|
+
/** */
|
|
117008
|
+
parent_space_key?: string | undefined;
|
|
116892
117009
|
}[] | undefined;
|
|
116893
117010
|
devices?: {
|
|
116894
117011
|
/** ID of the device. */
|
|
@@ -120200,6 +120317,10 @@ type Routes = {
|
|
|
120200
120317
|
device_count: number;
|
|
120201
120318
|
/** Number of entrances in the space. */
|
|
120202
120319
|
acs_entrance_count: number;
|
|
120320
|
+
/** */
|
|
120321
|
+
parent_space_id?: string | undefined;
|
|
120322
|
+
/** */
|
|
120323
|
+
parent_space_key?: string | undefined;
|
|
120203
120324
|
}[] | undefined;
|
|
120204
120325
|
devices?: {
|
|
120205
120326
|
/** ID of the device. */
|
|
@@ -165396,6 +165517,52 @@ type Routes = {
|
|
|
165396
165517
|
formData: {};
|
|
165397
165518
|
jsonResponse: {};
|
|
165398
165519
|
};
|
|
165520
|
+
'/seam/customer/v1/spaces/create': {
|
|
165521
|
+
route: '/seam/customer/v1/spaces/create';
|
|
165522
|
+
method: 'POST';
|
|
165523
|
+
queryParams: {};
|
|
165524
|
+
jsonBody: {
|
|
165525
|
+
/** Name of the space that you want to create. */
|
|
165526
|
+
name: string;
|
|
165527
|
+
/** Unique key for the space within the workspace. */
|
|
165528
|
+
space_key?: string | undefined;
|
|
165529
|
+
/** IDs of the devices that you want to add to the new space. */
|
|
165530
|
+
device_ids?: string[] | undefined;
|
|
165531
|
+
/** IDs of the entrances that you want to add to the new space. */
|
|
165532
|
+
acs_entrance_ids?: string[] | undefined;
|
|
165533
|
+
/** Space key of the parent space for this space. */
|
|
165534
|
+
parent_space_key?: string | undefined;
|
|
165535
|
+
/** Name of the parent space for this space. */
|
|
165536
|
+
parent_space_name?: string | undefined;
|
|
165537
|
+
};
|
|
165538
|
+
commonParams: {};
|
|
165539
|
+
formData: {};
|
|
165540
|
+
jsonResponse: {
|
|
165541
|
+
/** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
|
|
165542
|
+
space: {
|
|
165543
|
+
/** ID of the space. */
|
|
165544
|
+
space_id: string;
|
|
165545
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
165546
|
+
workspace_id: string;
|
|
165547
|
+
/** Unique key for the space within the workspace. */
|
|
165548
|
+
space_key?: string | undefined;
|
|
165549
|
+
/** Name of the space. */
|
|
165550
|
+
name: string;
|
|
165551
|
+
/** Display name for the space. */
|
|
165552
|
+
display_name: string;
|
|
165553
|
+
/** Date and time at which the space was created. */
|
|
165554
|
+
created_at: string;
|
|
165555
|
+
/** Number of devices in the space. */
|
|
165556
|
+
device_count: number;
|
|
165557
|
+
/** Number of entrances in the space. */
|
|
165558
|
+
acs_entrance_count: number;
|
|
165559
|
+
/** */
|
|
165560
|
+
parent_space_id?: string | undefined;
|
|
165561
|
+
/** */
|
|
165562
|
+
parent_space_key?: string | undefined;
|
|
165563
|
+
};
|
|
165564
|
+
};
|
|
165565
|
+
};
|
|
165399
165566
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
165400
165567
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
165401
165568
|
method: 'POST';
|
|
@@ -166069,6 +166236,10 @@ type Routes = {
|
|
|
166069
166236
|
device_count: number;
|
|
166070
166237
|
/** Number of entrances in the space. */
|
|
166071
166238
|
acs_entrance_count: number;
|
|
166239
|
+
/** */
|
|
166240
|
+
parent_space_id?: string | undefined;
|
|
166241
|
+
/** */
|
|
166242
|
+
parent_space_key?: string | undefined;
|
|
166072
166243
|
};
|
|
166073
166244
|
};
|
|
166074
166245
|
};
|
|
@@ -166116,6 +166287,10 @@ type Routes = {
|
|
|
166116
166287
|
device_count: number;
|
|
166117
166288
|
/** Number of entrances in the space. */
|
|
166118
166289
|
acs_entrance_count: number;
|
|
166290
|
+
/** */
|
|
166291
|
+
parent_space_id?: string | undefined;
|
|
166292
|
+
/** */
|
|
166293
|
+
parent_space_key?: string | undefined;
|
|
166119
166294
|
};
|
|
166120
166295
|
};
|
|
166121
166296
|
};
|
|
@@ -166154,6 +166329,10 @@ type Routes = {
|
|
|
166154
166329
|
device_count: number;
|
|
166155
166330
|
/** Number of entrances in the space. */
|
|
166156
166331
|
acs_entrance_count: number;
|
|
166332
|
+
/** */
|
|
166333
|
+
parent_space_id?: string | undefined;
|
|
166334
|
+
/** */
|
|
166335
|
+
parent_space_key?: string | undefined;
|
|
166157
166336
|
}[] | undefined;
|
|
166158
166337
|
devices?: {
|
|
166159
166338
|
/** ID of the device. */
|
|
@@ -167761,6 +167940,10 @@ type Routes = {
|
|
|
167761
167940
|
device_count: number;
|
|
167762
167941
|
/** Number of entrances in the space. */
|
|
167763
167942
|
acs_entrance_count: number;
|
|
167943
|
+
/** */
|
|
167944
|
+
parent_space_id?: string | undefined;
|
|
167945
|
+
/** */
|
|
167946
|
+
parent_space_key?: string | undefined;
|
|
167764
167947
|
}[];
|
|
167765
167948
|
};
|
|
167766
167949
|
};
|
|
@@ -167831,6 +168014,10 @@ type Routes = {
|
|
|
167831
168014
|
device_count: number;
|
|
167832
168015
|
/** Number of entrances in the space. */
|
|
167833
168016
|
acs_entrance_count: number;
|
|
168017
|
+
/** */
|
|
168018
|
+
parent_space_id?: string | undefined;
|
|
168019
|
+
/** */
|
|
168020
|
+
parent_space_key?: string | undefined;
|
|
167834
168021
|
};
|
|
167835
168022
|
};
|
|
167836
168023
|
};
|
|
@@ -187198,6 +187385,10 @@ type Routes = {
|
|
|
187198
187385
|
device_count: number;
|
|
187199
187386
|
/** Number of entrances in the space. */
|
|
187200
187387
|
acs_entrance_count: number;
|
|
187388
|
+
/** */
|
|
187389
|
+
parent_space_id?: string | undefined;
|
|
187390
|
+
/** */
|
|
187391
|
+
parent_space_key?: string | undefined;
|
|
187201
187392
|
}[] | undefined;
|
|
187202
187393
|
devices?: {
|
|
187203
187394
|
/** ID of the device. */
|
package/dist/index.cjs
CHANGED
|
@@ -5347,7 +5347,17 @@ var space = zod.z.object({
|
|
|
5347
5347
|
display_name: zod.z.string().describe("Display name for the space."),
|
|
5348
5348
|
created_at: zod.z.string().datetime().describe("Date and time at which the space was created."),
|
|
5349
5349
|
device_count: zod.z.number().describe("Number of devices in the space."),
|
|
5350
|
-
acs_entrance_count: zod.z.number().describe("Number of entrances in the space.")
|
|
5350
|
+
acs_entrance_count: zod.z.number().describe("Number of entrances in the space."),
|
|
5351
|
+
parent_space_id: zod.z.string().uuid().optional().describe(`
|
|
5352
|
+
---
|
|
5353
|
+
undocumented: Only used internally.
|
|
5354
|
+
---
|
|
5355
|
+
`),
|
|
5356
|
+
parent_space_key: zod.z.string().optional().describe(`
|
|
5357
|
+
---
|
|
5358
|
+
undocumented: Only used internally.
|
|
5359
|
+
---
|
|
5360
|
+
`)
|
|
5351
5361
|
}).describe(`
|
|
5352
5362
|
---
|
|
5353
5363
|
draft: Early access.
|
|
@@ -24415,6 +24425,15 @@ var openapi_default = {
|
|
|
24415
24425
|
type: "string"
|
|
24416
24426
|
},
|
|
24417
24427
|
name: { description: "Name of the space.", type: "string" },
|
|
24428
|
+
parent_space_id: {
|
|
24429
|
+
format: "uuid",
|
|
24430
|
+
type: "string",
|
|
24431
|
+
"x-undocumented": "Only used internally."
|
|
24432
|
+
},
|
|
24433
|
+
parent_space_key: {
|
|
24434
|
+
type: "string",
|
|
24435
|
+
"x-undocumented": "Only used internally."
|
|
24436
|
+
},
|
|
24418
24437
|
space_id: {
|
|
24419
24438
|
description: "ID of the space.",
|
|
24420
24439
|
format: "uuid",
|
|
@@ -54293,6 +54312,78 @@ var openapi_default = {
|
|
|
54293
54312
|
"x-undocumented": "Internal endpoint for customer portals."
|
|
54294
54313
|
}
|
|
54295
54314
|
},
|
|
54315
|
+
"/seam/customer/v1/spaces/create": {
|
|
54316
|
+
post: {
|
|
54317
|
+
description: "Creates a new space with optional parent space support.",
|
|
54318
|
+
operationId: "seamCustomerV1SpacesCreatePost",
|
|
54319
|
+
requestBody: {
|
|
54320
|
+
content: {
|
|
54321
|
+
"application/json": {
|
|
54322
|
+
schema: {
|
|
54323
|
+
properties: {
|
|
54324
|
+
acs_entrance_ids: {
|
|
54325
|
+
description: "IDs of the entrances that you want to add to the new space.",
|
|
54326
|
+
items: { format: "uuid", type: "string" },
|
|
54327
|
+
type: "array"
|
|
54328
|
+
},
|
|
54329
|
+
device_ids: {
|
|
54330
|
+
description: "IDs of the devices that you want to add to the new space.",
|
|
54331
|
+
items: { format: "uuid", type: "string" },
|
|
54332
|
+
type: "array"
|
|
54333
|
+
},
|
|
54334
|
+
name: {
|
|
54335
|
+
description: "Name of the space that you want to create.",
|
|
54336
|
+
type: "string"
|
|
54337
|
+
},
|
|
54338
|
+
parent_space_key: {
|
|
54339
|
+
description: "Space key of the parent space for this space.",
|
|
54340
|
+
type: "string"
|
|
54341
|
+
},
|
|
54342
|
+
parent_space_name: {
|
|
54343
|
+
description: "Name of the parent space for this space.",
|
|
54344
|
+
type: "string"
|
|
54345
|
+
},
|
|
54346
|
+
space_key: {
|
|
54347
|
+
description: "Unique key for the space within the workspace.",
|
|
54348
|
+
type: "string"
|
|
54349
|
+
}
|
|
54350
|
+
},
|
|
54351
|
+
required: ["name"],
|
|
54352
|
+
type: "object"
|
|
54353
|
+
}
|
|
54354
|
+
}
|
|
54355
|
+
}
|
|
54356
|
+
},
|
|
54357
|
+
responses: {
|
|
54358
|
+
200: {
|
|
54359
|
+
content: {
|
|
54360
|
+
"application/json": {
|
|
54361
|
+
schema: {
|
|
54362
|
+
properties: {
|
|
54363
|
+
ok: { type: "boolean" },
|
|
54364
|
+
space: { $ref: "#/components/schemas/space" }
|
|
54365
|
+
},
|
|
54366
|
+
required: ["space", "ok"],
|
|
54367
|
+
type: "object"
|
|
54368
|
+
}
|
|
54369
|
+
}
|
|
54370
|
+
},
|
|
54371
|
+
description: "OK"
|
|
54372
|
+
},
|
|
54373
|
+
400: { description: "Bad Request" },
|
|
54374
|
+
401: { description: "Unauthorized" }
|
|
54375
|
+
},
|
|
54376
|
+
security: [{ client_session_with_customer: [] }],
|
|
54377
|
+
summary: "/seam/customer/v1/spaces/create",
|
|
54378
|
+
tags: [],
|
|
54379
|
+
"x-draft": "Early access.",
|
|
54380
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
|
|
54381
|
+
"x-fern-sdk-method-name": "create",
|
|
54382
|
+
"x-fern-sdk-return-value": "space",
|
|
54383
|
+
"x-response-key": "space",
|
|
54384
|
+
"x-title": "Create a Space"
|
|
54385
|
+
}
|
|
54386
|
+
},
|
|
54296
54387
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
54297
54388
|
post: {
|
|
54298
54389
|
description: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",
|