@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
|
@@ -10083,6 +10083,10 @@ export type Routes = {
|
|
|
10083
10083
|
device_count: number;
|
|
10084
10084
|
/** Number of entrances in the space. */
|
|
10085
10085
|
acs_entrance_count: number;
|
|
10086
|
+
/** */
|
|
10087
|
+
parent_space_id?: string | undefined;
|
|
10088
|
+
/** */
|
|
10089
|
+
parent_space_key?: string | undefined;
|
|
10086
10090
|
}[] | undefined;
|
|
10087
10091
|
devices?: {
|
|
10088
10092
|
/** ID of the device. */
|
|
@@ -13394,6 +13398,10 @@ export type Routes = {
|
|
|
13394
13398
|
device_count: number;
|
|
13395
13399
|
/** Number of entrances in the space. */
|
|
13396
13400
|
acs_entrance_count: number;
|
|
13401
|
+
/** */
|
|
13402
|
+
parent_space_id?: string | undefined;
|
|
13403
|
+
/** */
|
|
13404
|
+
parent_space_key?: string | undefined;
|
|
13397
13405
|
}[] | undefined;
|
|
13398
13406
|
devices?: {
|
|
13399
13407
|
/** ID of the device. */
|
|
@@ -58590,6 +58598,52 @@ export type Routes = {
|
|
|
58590
58598
|
formData: {};
|
|
58591
58599
|
jsonResponse: {};
|
|
58592
58600
|
};
|
|
58601
|
+
'/seam/customer/v1/spaces/create': {
|
|
58602
|
+
route: '/seam/customer/v1/spaces/create';
|
|
58603
|
+
method: 'POST';
|
|
58604
|
+
queryParams: {};
|
|
58605
|
+
jsonBody: {
|
|
58606
|
+
/** Name of the space that you want to create. */
|
|
58607
|
+
name: string;
|
|
58608
|
+
/** Unique key for the space within the workspace. */
|
|
58609
|
+
space_key?: string | undefined;
|
|
58610
|
+
/** IDs of the devices that you want to add to the new space. */
|
|
58611
|
+
device_ids?: string[] | undefined;
|
|
58612
|
+
/** IDs of the entrances that you want to add to the new space. */
|
|
58613
|
+
acs_entrance_ids?: string[] | undefined;
|
|
58614
|
+
/** Space key of the parent space for this space. */
|
|
58615
|
+
parent_space_key?: string | undefined;
|
|
58616
|
+
/** Name of the parent space for this space. */
|
|
58617
|
+
parent_space_name?: string | undefined;
|
|
58618
|
+
};
|
|
58619
|
+
commonParams: {};
|
|
58620
|
+
formData: {};
|
|
58621
|
+
jsonResponse: {
|
|
58622
|
+
/** 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. */
|
|
58623
|
+
space: {
|
|
58624
|
+
/** ID of the space. */
|
|
58625
|
+
space_id: string;
|
|
58626
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
58627
|
+
workspace_id: string;
|
|
58628
|
+
/** Unique key for the space within the workspace. */
|
|
58629
|
+
space_key?: string | undefined;
|
|
58630
|
+
/** Name of the space. */
|
|
58631
|
+
name: string;
|
|
58632
|
+
/** Display name for the space. */
|
|
58633
|
+
display_name: string;
|
|
58634
|
+
/** Date and time at which the space was created. */
|
|
58635
|
+
created_at: string;
|
|
58636
|
+
/** Number of devices in the space. */
|
|
58637
|
+
device_count: number;
|
|
58638
|
+
/** Number of entrances in the space. */
|
|
58639
|
+
acs_entrance_count: number;
|
|
58640
|
+
/** */
|
|
58641
|
+
parent_space_id?: string | undefined;
|
|
58642
|
+
/** */
|
|
58643
|
+
parent_space_key?: string | undefined;
|
|
58644
|
+
};
|
|
58645
|
+
};
|
|
58646
|
+
};
|
|
58593
58647
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
58594
58648
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
58595
58649
|
method: 'POST';
|
|
@@ -59263,6 +59317,10 @@ export type Routes = {
|
|
|
59263
59317
|
device_count: number;
|
|
59264
59318
|
/** Number of entrances in the space. */
|
|
59265
59319
|
acs_entrance_count: number;
|
|
59320
|
+
/** */
|
|
59321
|
+
parent_space_id?: string | undefined;
|
|
59322
|
+
/** */
|
|
59323
|
+
parent_space_key?: string | undefined;
|
|
59266
59324
|
};
|
|
59267
59325
|
};
|
|
59268
59326
|
};
|
|
@@ -59310,6 +59368,10 @@ export type Routes = {
|
|
|
59310
59368
|
device_count: number;
|
|
59311
59369
|
/** Number of entrances in the space. */
|
|
59312
59370
|
acs_entrance_count: number;
|
|
59371
|
+
/** */
|
|
59372
|
+
parent_space_id?: string | undefined;
|
|
59373
|
+
/** */
|
|
59374
|
+
parent_space_key?: string | undefined;
|
|
59313
59375
|
};
|
|
59314
59376
|
};
|
|
59315
59377
|
};
|
|
@@ -59348,6 +59410,10 @@ export type Routes = {
|
|
|
59348
59410
|
device_count: number;
|
|
59349
59411
|
/** Number of entrances in the space. */
|
|
59350
59412
|
acs_entrance_count: number;
|
|
59413
|
+
/** */
|
|
59414
|
+
parent_space_id?: string | undefined;
|
|
59415
|
+
/** */
|
|
59416
|
+
parent_space_key?: string | undefined;
|
|
59351
59417
|
}[] | undefined;
|
|
59352
59418
|
devices?: {
|
|
59353
59419
|
/** ID of the device. */
|
|
@@ -60955,6 +61021,10 @@ export type Routes = {
|
|
|
60955
61021
|
device_count: number;
|
|
60956
61022
|
/** Number of entrances in the space. */
|
|
60957
61023
|
acs_entrance_count: number;
|
|
61024
|
+
/** */
|
|
61025
|
+
parent_space_id?: string | undefined;
|
|
61026
|
+
/** */
|
|
61027
|
+
parent_space_key?: string | undefined;
|
|
60958
61028
|
}[];
|
|
60959
61029
|
};
|
|
60960
61030
|
};
|
|
@@ -61025,6 +61095,10 @@ export type Routes = {
|
|
|
61025
61095
|
device_count: number;
|
|
61026
61096
|
/** Number of entrances in the space. */
|
|
61027
61097
|
acs_entrance_count: number;
|
|
61098
|
+
/** */
|
|
61099
|
+
parent_space_id?: string | undefined;
|
|
61100
|
+
/** */
|
|
61101
|
+
parent_space_key?: string | undefined;
|
|
61028
61102
|
};
|
|
61029
61103
|
};
|
|
61030
61104
|
};
|
|
@@ -80392,6 +80466,10 @@ export type Routes = {
|
|
|
80392
80466
|
device_count: number;
|
|
80393
80467
|
/** Number of entrances in the space. */
|
|
80394
80468
|
acs_entrance_count: number;
|
|
80469
|
+
/** */
|
|
80470
|
+
parent_space_id?: string | undefined;
|
|
80471
|
+
/** */
|
|
80472
|
+
parent_space_key?: string | undefined;
|
|
80395
80473
|
}[] | undefined;
|
|
80396
80474
|
devices?: {
|
|
80397
80475
|
/** ID of the device. */
|
package/package.json
CHANGED
|
@@ -20,6 +20,16 @@ export const space = z.object({
|
|
|
20
20
|
.describe('Date and time at which the space was created.'),
|
|
21
21
|
device_count: z.number().describe('Number of devices in the space.'),
|
|
22
22
|
acs_entrance_count: z.number().describe('Number of entrances in the space.'),
|
|
23
|
+
parent_space_id: z.string().uuid().optional().describe(`
|
|
24
|
+
---
|
|
25
|
+
undocumented: Only used internally.
|
|
26
|
+
---
|
|
27
|
+
`),
|
|
28
|
+
parent_space_key: z.string().optional().describe(`
|
|
29
|
+
---
|
|
30
|
+
undocumented: Only used internally.
|
|
31
|
+
---
|
|
32
|
+
`),
|
|
23
33
|
}).describe(`
|
|
24
34
|
---
|
|
25
35
|
draft: Early access.
|
|
@@ -20775,6 +20775,15 @@ export default {
|
|
|
20775
20775
|
type: 'string',
|
|
20776
20776
|
},
|
|
20777
20777
|
name: { description: 'Name of the space.', type: 'string' },
|
|
20778
|
+
parent_space_id: {
|
|
20779
|
+
format: 'uuid',
|
|
20780
|
+
type: 'string',
|
|
20781
|
+
'x-undocumented': 'Only used internally.',
|
|
20782
|
+
},
|
|
20783
|
+
parent_space_key: {
|
|
20784
|
+
type: 'string',
|
|
20785
|
+
'x-undocumented': 'Only used internally.',
|
|
20786
|
+
},
|
|
20778
20787
|
space_id: {
|
|
20779
20788
|
description: 'ID of the space.',
|
|
20780
20789
|
format: 'uuid',
|
|
@@ -52680,6 +52689,82 @@ export default {
|
|
|
52680
52689
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
52681
52690
|
},
|
|
52682
52691
|
},
|
|
52692
|
+
'/seam/customer/v1/spaces/create': {
|
|
52693
|
+
post: {
|
|
52694
|
+
description: 'Creates a new space with optional parent space support.',
|
|
52695
|
+
operationId: 'seamCustomerV1SpacesCreatePost',
|
|
52696
|
+
requestBody: {
|
|
52697
|
+
content: {
|
|
52698
|
+
'application/json': {
|
|
52699
|
+
schema: {
|
|
52700
|
+
properties: {
|
|
52701
|
+
acs_entrance_ids: {
|
|
52702
|
+
description:
|
|
52703
|
+
'IDs of the entrances that you want to add to the new space.',
|
|
52704
|
+
items: { format: 'uuid', type: 'string' },
|
|
52705
|
+
type: 'array',
|
|
52706
|
+
},
|
|
52707
|
+
device_ids: {
|
|
52708
|
+
description:
|
|
52709
|
+
'IDs of the devices that you want to add to the new space.',
|
|
52710
|
+
items: { format: 'uuid', type: 'string' },
|
|
52711
|
+
type: 'array',
|
|
52712
|
+
},
|
|
52713
|
+
name: {
|
|
52714
|
+
description: 'Name of the space that you want to create.',
|
|
52715
|
+
type: 'string',
|
|
52716
|
+
},
|
|
52717
|
+
parent_space_key: {
|
|
52718
|
+
description:
|
|
52719
|
+
'Space key of the parent space for this space.',
|
|
52720
|
+
type: 'string',
|
|
52721
|
+
},
|
|
52722
|
+
parent_space_name: {
|
|
52723
|
+
description: 'Name of the parent space for this space.',
|
|
52724
|
+
type: 'string',
|
|
52725
|
+
},
|
|
52726
|
+
space_key: {
|
|
52727
|
+
description:
|
|
52728
|
+
'Unique key for the space within the workspace.',
|
|
52729
|
+
type: 'string',
|
|
52730
|
+
},
|
|
52731
|
+
},
|
|
52732
|
+
required: ['name'],
|
|
52733
|
+
type: 'object',
|
|
52734
|
+
},
|
|
52735
|
+
},
|
|
52736
|
+
},
|
|
52737
|
+
},
|
|
52738
|
+
responses: {
|
|
52739
|
+
200: {
|
|
52740
|
+
content: {
|
|
52741
|
+
'application/json': {
|
|
52742
|
+
schema: {
|
|
52743
|
+
properties: {
|
|
52744
|
+
ok: { type: 'boolean' },
|
|
52745
|
+
space: { $ref: '#/components/schemas/space' },
|
|
52746
|
+
},
|
|
52747
|
+
required: ['space', 'ok'],
|
|
52748
|
+
type: 'object',
|
|
52749
|
+
},
|
|
52750
|
+
},
|
|
52751
|
+
},
|
|
52752
|
+
description: 'OK',
|
|
52753
|
+
},
|
|
52754
|
+
400: { description: 'Bad Request' },
|
|
52755
|
+
401: { description: 'Unauthorized' },
|
|
52756
|
+
},
|
|
52757
|
+
security: [{ client_session_with_customer: [] }],
|
|
52758
|
+
summary: '/seam/customer/v1/spaces/create',
|
|
52759
|
+
tags: [],
|
|
52760
|
+
'x-draft': 'Early access.',
|
|
52761
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
|
|
52762
|
+
'x-fern-sdk-method-name': 'create',
|
|
52763
|
+
'x-fern-sdk-return-value': 'space',
|
|
52764
|
+
'x-response-key': 'space',
|
|
52765
|
+
'x-title': 'Create a Space',
|
|
52766
|
+
},
|
|
52767
|
+
},
|
|
52683
52768
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
52684
52769
|
post: {
|
|
52685
52770
|
description:
|
|
@@ -11353,6 +11353,10 @@ export type Routes = {
|
|
|
11353
11353
|
device_count: number
|
|
11354
11354
|
/** Number of entrances in the space. */
|
|
11355
11355
|
acs_entrance_count: number
|
|
11356
|
+
/** */
|
|
11357
|
+
parent_space_id?: string | undefined
|
|
11358
|
+
/** */
|
|
11359
|
+
parent_space_key?: string | undefined
|
|
11356
11360
|
}[]
|
|
11357
11361
|
| undefined
|
|
11358
11362
|
devices?:
|
|
@@ -15339,6 +15343,10 @@ export type Routes = {
|
|
|
15339
15343
|
device_count: number
|
|
15340
15344
|
/** Number of entrances in the space. */
|
|
15341
15345
|
acs_entrance_count: number
|
|
15346
|
+
/** */
|
|
15347
|
+
parent_space_id?: string | undefined
|
|
15348
|
+
/** */
|
|
15349
|
+
parent_space_key?: string | undefined
|
|
15342
15350
|
}[]
|
|
15343
15351
|
| undefined
|
|
15344
15352
|
devices?:
|
|
@@ -69839,6 +69847,52 @@ export type Routes = {
|
|
|
69839
69847
|
formData: {}
|
|
69840
69848
|
jsonResponse: {}
|
|
69841
69849
|
}
|
|
69850
|
+
'/seam/customer/v1/spaces/create': {
|
|
69851
|
+
route: '/seam/customer/v1/spaces/create'
|
|
69852
|
+
method: 'POST'
|
|
69853
|
+
queryParams: {}
|
|
69854
|
+
jsonBody: {
|
|
69855
|
+
/** Name of the space that you want to create. */
|
|
69856
|
+
name: string
|
|
69857
|
+
/** Unique key for the space within the workspace. */
|
|
69858
|
+
space_key?: string | undefined
|
|
69859
|
+
/** IDs of the devices that you want to add to the new space. */
|
|
69860
|
+
device_ids?: string[] | undefined
|
|
69861
|
+
/** IDs of the entrances that you want to add to the new space. */
|
|
69862
|
+
acs_entrance_ids?: string[] | undefined
|
|
69863
|
+
/** Space key of the parent space for this space. */
|
|
69864
|
+
parent_space_key?: string | undefined
|
|
69865
|
+
/** Name of the parent space for this space. */
|
|
69866
|
+
parent_space_name?: string | undefined
|
|
69867
|
+
}
|
|
69868
|
+
commonParams: {}
|
|
69869
|
+
formData: {}
|
|
69870
|
+
jsonResponse: {
|
|
69871
|
+
/** 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. */
|
|
69872
|
+
space: {
|
|
69873
|
+
/** ID of the space. */
|
|
69874
|
+
space_id: string
|
|
69875
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
69876
|
+
workspace_id: string
|
|
69877
|
+
/** Unique key for the space within the workspace. */
|
|
69878
|
+
space_key?: string | undefined
|
|
69879
|
+
/** Name of the space. */
|
|
69880
|
+
name: string
|
|
69881
|
+
/** Display name for the space. */
|
|
69882
|
+
display_name: string
|
|
69883
|
+
/** Date and time at which the space was created. */
|
|
69884
|
+
created_at: string
|
|
69885
|
+
/** Number of devices in the space. */
|
|
69886
|
+
device_count: number
|
|
69887
|
+
/** Number of entrances in the space. */
|
|
69888
|
+
acs_entrance_count: number
|
|
69889
|
+
/** */
|
|
69890
|
+
parent_space_id?: string | undefined
|
|
69891
|
+
/** */
|
|
69892
|
+
parent_space_key?: string | undefined
|
|
69893
|
+
}
|
|
69894
|
+
}
|
|
69895
|
+
}
|
|
69842
69896
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
69843
69897
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
|
|
69844
69898
|
method: 'POST'
|
|
@@ -70603,6 +70657,10 @@ export type Routes = {
|
|
|
70603
70657
|
device_count: number
|
|
70604
70658
|
/** Number of entrances in the space. */
|
|
70605
70659
|
acs_entrance_count: number
|
|
70660
|
+
/** */
|
|
70661
|
+
parent_space_id?: string | undefined
|
|
70662
|
+
/** */
|
|
70663
|
+
parent_space_key?: string | undefined
|
|
70606
70664
|
}
|
|
70607
70665
|
}
|
|
70608
70666
|
}
|
|
@@ -70652,6 +70710,10 @@ export type Routes = {
|
|
|
70652
70710
|
device_count: number
|
|
70653
70711
|
/** Number of entrances in the space. */
|
|
70654
70712
|
acs_entrance_count: number
|
|
70713
|
+
/** */
|
|
70714
|
+
parent_space_id?: string | undefined
|
|
70715
|
+
/** */
|
|
70716
|
+
parent_space_key?: string | undefined
|
|
70655
70717
|
}
|
|
70656
70718
|
}
|
|
70657
70719
|
}
|
|
@@ -70707,6 +70769,10 @@ export type Routes = {
|
|
|
70707
70769
|
device_count: number
|
|
70708
70770
|
/** Number of entrances in the space. */
|
|
70709
70771
|
acs_entrance_count: number
|
|
70772
|
+
/** */
|
|
70773
|
+
parent_space_id?: string | undefined
|
|
70774
|
+
/** */
|
|
70775
|
+
parent_space_key?: string | undefined
|
|
70710
70776
|
}[]
|
|
70711
70777
|
| undefined
|
|
70712
70778
|
devices?:
|
|
@@ -72751,6 +72817,10 @@ export type Routes = {
|
|
|
72751
72817
|
device_count: number
|
|
72752
72818
|
/** Number of entrances in the space. */
|
|
72753
72819
|
acs_entrance_count: number
|
|
72820
|
+
/** */
|
|
72821
|
+
parent_space_id?: string | undefined
|
|
72822
|
+
/** */
|
|
72823
|
+
parent_space_key?: string | undefined
|
|
72754
72824
|
}[]
|
|
72755
72825
|
}
|
|
72756
72826
|
}
|
|
@@ -72821,6 +72891,10 @@ export type Routes = {
|
|
|
72821
72891
|
device_count: number
|
|
72822
72892
|
/** Number of entrances in the space. */
|
|
72823
72893
|
acs_entrance_count: number
|
|
72894
|
+
/** */
|
|
72895
|
+
parent_space_id?: string | undefined
|
|
72896
|
+
/** */
|
|
72897
|
+
parent_space_key?: string | undefined
|
|
72824
72898
|
}
|
|
72825
72899
|
}
|
|
72826
72900
|
}
|
|
@@ -95653,6 +95727,10 @@ export type Routes = {
|
|
|
95653
95727
|
device_count: number
|
|
95654
95728
|
/** Number of entrances in the space. */
|
|
95655
95729
|
acs_entrance_count: number
|
|
95730
|
+
/** */
|
|
95731
|
+
parent_space_id?: string | undefined
|
|
95732
|
+
/** */
|
|
95733
|
+
parent_space_key?: string | undefined
|
|
95656
95734
|
}[]
|
|
95657
95735
|
| undefined
|
|
95658
95736
|
devices?:
|