@seamapi/types 1.591.0 → 1.593.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 +134 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +201 -0
- package/dist/index.cjs +134 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +7 -0
- package/lib/seam/connect/models/customer/customer-portal.js +4 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +160 -0
- package/lib/seam/connect/openapi.js +134 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +41 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +139 -0
- package/src/lib/seam/connect/route-types.ts +41 -0
|
@@ -31346,6 +31346,8 @@ export type Routes = {
|
|
|
31346
31346
|
connect?: {
|
|
31347
31347
|
/** Whether to exclude this feature from the portal. */
|
|
31348
31348
|
exclude?: boolean;
|
|
31349
|
+
/** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
|
|
31350
|
+
accepted_providers?: string[] | undefined;
|
|
31349
31351
|
/** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
|
|
31350
31352
|
excluded_providers?: string[] | undefined;
|
|
31351
31353
|
};
|
|
@@ -58644,6 +58646,45 @@ export type Routes = {
|
|
|
58644
58646
|
};
|
|
58645
58647
|
};
|
|
58646
58648
|
};
|
|
58649
|
+
'/seam/customer/v1/spaces/list': {
|
|
58650
|
+
route: '/seam/customer/v1/spaces/list';
|
|
58651
|
+
method: 'GET' | 'POST';
|
|
58652
|
+
queryParams: {};
|
|
58653
|
+
jsonBody: {};
|
|
58654
|
+
commonParams: {
|
|
58655
|
+
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
|
|
58656
|
+
search?: string | undefined;
|
|
58657
|
+
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
58658
|
+
connected_account_id?: string | undefined;
|
|
58659
|
+
/** Filter spaces by space_key. */
|
|
58660
|
+
space_key?: string | undefined;
|
|
58661
|
+
};
|
|
58662
|
+
formData: {};
|
|
58663
|
+
jsonResponse: {
|
|
58664
|
+
spaces: {
|
|
58665
|
+
/** ID of the space. */
|
|
58666
|
+
space_id: string;
|
|
58667
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
58668
|
+
workspace_id: string;
|
|
58669
|
+
/** Unique key for the space within the workspace. */
|
|
58670
|
+
space_key?: string | undefined;
|
|
58671
|
+
/** Name of the space. */
|
|
58672
|
+
name: string;
|
|
58673
|
+
/** Display name for the space. */
|
|
58674
|
+
display_name: string;
|
|
58675
|
+
/** Date and time at which the space was created. */
|
|
58676
|
+
created_at: string;
|
|
58677
|
+
/** Number of devices in the space. */
|
|
58678
|
+
device_count: number;
|
|
58679
|
+
/** Number of entrances in the space. */
|
|
58680
|
+
acs_entrance_count: number;
|
|
58681
|
+
/** */
|
|
58682
|
+
parent_space_id?: string | undefined;
|
|
58683
|
+
/** */
|
|
58684
|
+
parent_space_key?: string | undefined;
|
|
58685
|
+
}[];
|
|
58686
|
+
};
|
|
58687
|
+
};
|
|
58647
58688
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
58648
58689
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
58649
58690
|
method: 'POST';
|
package/package.json
CHANGED
|
@@ -11,6 +11,12 @@ const base_feature = z.object({
|
|
|
11
11
|
})
|
|
12
12
|
|
|
13
13
|
const base_connect_feature = base_feature.extend({
|
|
14
|
+
accepted_providers: z
|
|
15
|
+
.array(z.string())
|
|
16
|
+
.optional()
|
|
17
|
+
.describe(
|
|
18
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
19
|
+
),
|
|
14
20
|
excluded_providers: z
|
|
15
21
|
.array(z.string())
|
|
16
22
|
.optional()
|
|
@@ -40480,6 +40480,12 @@ export default {
|
|
|
40480
40480
|
description:
|
|
40481
40481
|
'Configuration for the connect accounts feature.',
|
|
40482
40482
|
properties: {
|
|
40483
|
+
accepted_providers: {
|
|
40484
|
+
description:
|
|
40485
|
+
'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
|
|
40486
|
+
items: { type: 'string' },
|
|
40487
|
+
type: 'array',
|
|
40488
|
+
},
|
|
40483
40489
|
exclude: {
|
|
40484
40490
|
default: false,
|
|
40485
40491
|
description:
|
|
@@ -52859,6 +52865,139 @@ export default {
|
|
|
52859
52865
|
'x-title': 'Create a Space',
|
|
52860
52866
|
},
|
|
52861
52867
|
},
|
|
52868
|
+
'/seam/customer/v1/spaces/list': {
|
|
52869
|
+
get: {
|
|
52870
|
+
description: 'Returns a list of all spaces.',
|
|
52871
|
+
operationId: 'seamCustomerV1SpacesListGet',
|
|
52872
|
+
parameters: [
|
|
52873
|
+
{
|
|
52874
|
+
in: 'query',
|
|
52875
|
+
name: 'search',
|
|
52876
|
+
schema: {
|
|
52877
|
+
description:
|
|
52878
|
+
'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
|
|
52879
|
+
minLength: 1,
|
|
52880
|
+
type: 'string',
|
|
52881
|
+
},
|
|
52882
|
+
},
|
|
52883
|
+
{
|
|
52884
|
+
in: 'query',
|
|
52885
|
+
name: 'connected_account_id',
|
|
52886
|
+
schema: {
|
|
52887
|
+
description:
|
|
52888
|
+
'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
|
|
52889
|
+
format: 'uuid',
|
|
52890
|
+
type: 'string',
|
|
52891
|
+
'x-draft': 'Needs review.',
|
|
52892
|
+
'x-undocumented': 'Only used internally.',
|
|
52893
|
+
},
|
|
52894
|
+
},
|
|
52895
|
+
{
|
|
52896
|
+
in: 'query',
|
|
52897
|
+
name: 'space_key',
|
|
52898
|
+
schema: {
|
|
52899
|
+
description: 'Filter spaces by space_key.',
|
|
52900
|
+
type: 'string',
|
|
52901
|
+
},
|
|
52902
|
+
},
|
|
52903
|
+
],
|
|
52904
|
+
responses: {
|
|
52905
|
+
200: {
|
|
52906
|
+
content: {
|
|
52907
|
+
'application/json': {
|
|
52908
|
+
schema: {
|
|
52909
|
+
properties: {
|
|
52910
|
+
ok: { type: 'boolean' },
|
|
52911
|
+
spaces: {
|
|
52912
|
+
items: { $ref: '#/components/schemas/space' },
|
|
52913
|
+
type: 'array',
|
|
52914
|
+
},
|
|
52915
|
+
},
|
|
52916
|
+
required: ['spaces', 'ok'],
|
|
52917
|
+
type: 'object',
|
|
52918
|
+
},
|
|
52919
|
+
},
|
|
52920
|
+
},
|
|
52921
|
+
description: 'OK',
|
|
52922
|
+
},
|
|
52923
|
+
400: { description: 'Bad Request' },
|
|
52924
|
+
401: { description: 'Unauthorized' },
|
|
52925
|
+
},
|
|
52926
|
+
security: [{ client_session_with_customer: [] }],
|
|
52927
|
+
summary: '/seam/customer/v1/spaces/list',
|
|
52928
|
+
tags: [],
|
|
52929
|
+
'x-draft': 'Early access.',
|
|
52930
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
|
|
52931
|
+
'x-fern-sdk-method-name': 'list',
|
|
52932
|
+
'x-fern-sdk-return-value': 'spaces',
|
|
52933
|
+
'x-response-key': 'spaces',
|
|
52934
|
+
'x-title': 'List Spaces',
|
|
52935
|
+
},
|
|
52936
|
+
post: {
|
|
52937
|
+
description: 'Returns a list of all spaces.',
|
|
52938
|
+
operationId: 'seamCustomerV1SpacesListPost',
|
|
52939
|
+
requestBody: {
|
|
52940
|
+
content: {
|
|
52941
|
+
'application/json': {
|
|
52942
|
+
schema: {
|
|
52943
|
+
properties: {
|
|
52944
|
+
connected_account_id: {
|
|
52945
|
+
description:
|
|
52946
|
+
'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
|
|
52947
|
+
format: 'uuid',
|
|
52948
|
+
type: 'string',
|
|
52949
|
+
'x-draft': 'Needs review.',
|
|
52950
|
+
'x-undocumented': 'Only used internally.',
|
|
52951
|
+
},
|
|
52952
|
+
search: {
|
|
52953
|
+
description:
|
|
52954
|
+
'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
|
|
52955
|
+
minLength: 1,
|
|
52956
|
+
type: 'string',
|
|
52957
|
+
},
|
|
52958
|
+
space_key: {
|
|
52959
|
+
description: 'Filter spaces by space_key.',
|
|
52960
|
+
type: 'string',
|
|
52961
|
+
},
|
|
52962
|
+
},
|
|
52963
|
+
type: 'object',
|
|
52964
|
+
},
|
|
52965
|
+
},
|
|
52966
|
+
},
|
|
52967
|
+
},
|
|
52968
|
+
responses: {
|
|
52969
|
+
200: {
|
|
52970
|
+
content: {
|
|
52971
|
+
'application/json': {
|
|
52972
|
+
schema: {
|
|
52973
|
+
properties: {
|
|
52974
|
+
ok: { type: 'boolean' },
|
|
52975
|
+
spaces: {
|
|
52976
|
+
items: { $ref: '#/components/schemas/space' },
|
|
52977
|
+
type: 'array',
|
|
52978
|
+
},
|
|
52979
|
+
},
|
|
52980
|
+
required: ['spaces', 'ok'],
|
|
52981
|
+
type: 'object',
|
|
52982
|
+
},
|
|
52983
|
+
},
|
|
52984
|
+
},
|
|
52985
|
+
description: 'OK',
|
|
52986
|
+
},
|
|
52987
|
+
400: { description: 'Bad Request' },
|
|
52988
|
+
401: { description: 'Unauthorized' },
|
|
52989
|
+
},
|
|
52990
|
+
security: [{ client_session_with_customer: [] }],
|
|
52991
|
+
summary: '/seam/customer/v1/spaces/list',
|
|
52992
|
+
tags: [],
|
|
52993
|
+
'x-draft': 'Early access.',
|
|
52994
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
|
|
52995
|
+
'x-fern-sdk-method-name': 'list',
|
|
52996
|
+
'x-fern-sdk-return-value': 'spaces',
|
|
52997
|
+
'x-response-key': 'spaces',
|
|
52998
|
+
'x-title': 'List Spaces',
|
|
52999
|
+
},
|
|
53000
|
+
},
|
|
52862
53001
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
52863
53002
|
post: {
|
|
52864
53003
|
description:
|
|
@@ -36423,6 +36423,8 @@ export type Routes = {
|
|
|
36423
36423
|
connect?: {
|
|
36424
36424
|
/** Whether to exclude this feature from the portal. */
|
|
36425
36425
|
exclude?: boolean
|
|
36426
|
+
/** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
|
|
36427
|
+
accepted_providers?: string[] | undefined
|
|
36426
36428
|
/** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
|
|
36427
36429
|
excluded_providers?: string[] | undefined
|
|
36428
36430
|
}
|
|
@@ -69893,6 +69895,45 @@ export type Routes = {
|
|
|
69893
69895
|
}
|
|
69894
69896
|
}
|
|
69895
69897
|
}
|
|
69898
|
+
'/seam/customer/v1/spaces/list': {
|
|
69899
|
+
route: '/seam/customer/v1/spaces/list'
|
|
69900
|
+
method: 'GET' | 'POST'
|
|
69901
|
+
queryParams: {}
|
|
69902
|
+
jsonBody: {}
|
|
69903
|
+
commonParams: {
|
|
69904
|
+
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
|
|
69905
|
+
search?: string | undefined
|
|
69906
|
+
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
69907
|
+
connected_account_id?: string | undefined
|
|
69908
|
+
/** Filter spaces by space_key. */
|
|
69909
|
+
space_key?: string | undefined
|
|
69910
|
+
}
|
|
69911
|
+
formData: {}
|
|
69912
|
+
jsonResponse: {
|
|
69913
|
+
spaces: {
|
|
69914
|
+
/** ID of the space. */
|
|
69915
|
+
space_id: string
|
|
69916
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
69917
|
+
workspace_id: string
|
|
69918
|
+
/** Unique key for the space within the workspace. */
|
|
69919
|
+
space_key?: string | undefined
|
|
69920
|
+
/** Name of the space. */
|
|
69921
|
+
name: string
|
|
69922
|
+
/** Display name for the space. */
|
|
69923
|
+
display_name: string
|
|
69924
|
+
/** Date and time at which the space was created. */
|
|
69925
|
+
created_at: string
|
|
69926
|
+
/** Number of devices in the space. */
|
|
69927
|
+
device_count: number
|
|
69928
|
+
/** Number of entrances in the space. */
|
|
69929
|
+
acs_entrance_count: number
|
|
69930
|
+
/** */
|
|
69931
|
+
parent_space_id?: string | undefined
|
|
69932
|
+
/** */
|
|
69933
|
+
parent_space_key?: string | undefined
|
|
69934
|
+
}[]
|
|
69935
|
+
}
|
|
69936
|
+
}
|
|
69896
69937
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
69897
69938
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
|
|
69898
69939
|
method: 'POST'
|