@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
package/dist/connect.d.cts
CHANGED
|
@@ -82648,6 +82648,13 @@ declare const _default: {
|
|
|
82648
82648
|
default: {};
|
|
82649
82649
|
description: string;
|
|
82650
82650
|
properties: {
|
|
82651
|
+
accepted_providers: {
|
|
82652
|
+
description: string;
|
|
82653
|
+
items: {
|
|
82654
|
+
type: string;
|
|
82655
|
+
};
|
|
82656
|
+
type: string;
|
|
82657
|
+
};
|
|
82651
82658
|
exclude: {
|
|
82652
82659
|
default: boolean;
|
|
82653
82660
|
description: string;
|
|
@@ -94899,6 +94906,159 @@ declare const _default: {
|
|
|
94899
94906
|
'x-title': string;
|
|
94900
94907
|
};
|
|
94901
94908
|
};
|
|
94909
|
+
'/seam/customer/v1/spaces/list': {
|
|
94910
|
+
get: {
|
|
94911
|
+
description: string;
|
|
94912
|
+
operationId: string;
|
|
94913
|
+
parameters: ({
|
|
94914
|
+
in: string;
|
|
94915
|
+
name: string;
|
|
94916
|
+
schema: {
|
|
94917
|
+
description: string;
|
|
94918
|
+
minLength: number;
|
|
94919
|
+
type: string;
|
|
94920
|
+
format?: never;
|
|
94921
|
+
'x-draft'?: never;
|
|
94922
|
+
'x-undocumented'?: never;
|
|
94923
|
+
};
|
|
94924
|
+
} | {
|
|
94925
|
+
in: string;
|
|
94926
|
+
name: string;
|
|
94927
|
+
schema: {
|
|
94928
|
+
description: string;
|
|
94929
|
+
format: string;
|
|
94930
|
+
type: string;
|
|
94931
|
+
'x-draft': string;
|
|
94932
|
+
'x-undocumented': string;
|
|
94933
|
+
minLength?: never;
|
|
94934
|
+
};
|
|
94935
|
+
} | {
|
|
94936
|
+
in: string;
|
|
94937
|
+
name: string;
|
|
94938
|
+
schema: {
|
|
94939
|
+
description: string;
|
|
94940
|
+
type: string;
|
|
94941
|
+
minLength?: never;
|
|
94942
|
+
format?: never;
|
|
94943
|
+
'x-draft'?: never;
|
|
94944
|
+
'x-undocumented'?: never;
|
|
94945
|
+
};
|
|
94946
|
+
})[];
|
|
94947
|
+
responses: {
|
|
94948
|
+
200: {
|
|
94949
|
+
content: {
|
|
94950
|
+
'application/json': {
|
|
94951
|
+
schema: {
|
|
94952
|
+
properties: {
|
|
94953
|
+
ok: {
|
|
94954
|
+
type: string;
|
|
94955
|
+
};
|
|
94956
|
+
spaces: {
|
|
94957
|
+
items: {
|
|
94958
|
+
$ref: string;
|
|
94959
|
+
};
|
|
94960
|
+
type: string;
|
|
94961
|
+
};
|
|
94962
|
+
};
|
|
94963
|
+
required: string[];
|
|
94964
|
+
type: string;
|
|
94965
|
+
};
|
|
94966
|
+
};
|
|
94967
|
+
};
|
|
94968
|
+
description: string;
|
|
94969
|
+
};
|
|
94970
|
+
400: {
|
|
94971
|
+
description: string;
|
|
94972
|
+
};
|
|
94973
|
+
401: {
|
|
94974
|
+
description: string;
|
|
94975
|
+
};
|
|
94976
|
+
};
|
|
94977
|
+
security: {
|
|
94978
|
+
client_session_with_customer: never[];
|
|
94979
|
+
}[];
|
|
94980
|
+
summary: string;
|
|
94981
|
+
tags: never[];
|
|
94982
|
+
'x-draft': string;
|
|
94983
|
+
'x-fern-sdk-group-name': string[];
|
|
94984
|
+
'x-fern-sdk-method-name': string;
|
|
94985
|
+
'x-fern-sdk-return-value': string;
|
|
94986
|
+
'x-response-key': string;
|
|
94987
|
+
'x-title': string;
|
|
94988
|
+
};
|
|
94989
|
+
post: {
|
|
94990
|
+
description: string;
|
|
94991
|
+
operationId: string;
|
|
94992
|
+
requestBody: {
|
|
94993
|
+
content: {
|
|
94994
|
+
'application/json': {
|
|
94995
|
+
schema: {
|
|
94996
|
+
properties: {
|
|
94997
|
+
connected_account_id: {
|
|
94998
|
+
description: string;
|
|
94999
|
+
format: string;
|
|
95000
|
+
type: string;
|
|
95001
|
+
'x-draft': string;
|
|
95002
|
+
'x-undocumented': string;
|
|
95003
|
+
};
|
|
95004
|
+
search: {
|
|
95005
|
+
description: string;
|
|
95006
|
+
minLength: number;
|
|
95007
|
+
type: string;
|
|
95008
|
+
};
|
|
95009
|
+
space_key: {
|
|
95010
|
+
description: string;
|
|
95011
|
+
type: string;
|
|
95012
|
+
};
|
|
95013
|
+
};
|
|
95014
|
+
type: string;
|
|
95015
|
+
};
|
|
95016
|
+
};
|
|
95017
|
+
};
|
|
95018
|
+
};
|
|
95019
|
+
responses: {
|
|
95020
|
+
200: {
|
|
95021
|
+
content: {
|
|
95022
|
+
'application/json': {
|
|
95023
|
+
schema: {
|
|
95024
|
+
properties: {
|
|
95025
|
+
ok: {
|
|
95026
|
+
type: string;
|
|
95027
|
+
};
|
|
95028
|
+
spaces: {
|
|
95029
|
+
items: {
|
|
95030
|
+
$ref: string;
|
|
95031
|
+
};
|
|
95032
|
+
type: string;
|
|
95033
|
+
};
|
|
95034
|
+
};
|
|
95035
|
+
required: string[];
|
|
95036
|
+
type: string;
|
|
95037
|
+
};
|
|
95038
|
+
};
|
|
95039
|
+
};
|
|
95040
|
+
description: string;
|
|
95041
|
+
};
|
|
95042
|
+
400: {
|
|
95043
|
+
description: string;
|
|
95044
|
+
};
|
|
95045
|
+
401: {
|
|
95046
|
+
description: string;
|
|
95047
|
+
};
|
|
95048
|
+
};
|
|
95049
|
+
security: {
|
|
95050
|
+
client_session_with_customer: never[];
|
|
95051
|
+
}[];
|
|
95052
|
+
summary: string;
|
|
95053
|
+
tags: never[];
|
|
95054
|
+
'x-draft': string;
|
|
95055
|
+
'x-fern-sdk-group-name': string[];
|
|
95056
|
+
'x-fern-sdk-method-name': string;
|
|
95057
|
+
'x-fern-sdk-return-value': string;
|
|
95058
|
+
'x-response-key': string;
|
|
95059
|
+
'x-title': string;
|
|
95060
|
+
};
|
|
95061
|
+
};
|
|
94902
95062
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
94903
95063
|
post: {
|
|
94904
95064
|
description: string;
|
|
@@ -138364,6 +138524,8 @@ type Routes = {
|
|
|
138364
138524
|
connect?: {
|
|
138365
138525
|
/** Whether to exclude this feature from the portal. */
|
|
138366
138526
|
exclude?: boolean;
|
|
138527
|
+
/** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
|
|
138528
|
+
accepted_providers?: string[] | undefined;
|
|
138367
138529
|
/** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
|
|
138368
138530
|
excluded_providers?: string[] | undefined;
|
|
138369
138531
|
};
|
|
@@ -165662,6 +165824,45 @@ type Routes = {
|
|
|
165662
165824
|
};
|
|
165663
165825
|
};
|
|
165664
165826
|
};
|
|
165827
|
+
'/seam/customer/v1/spaces/list': {
|
|
165828
|
+
route: '/seam/customer/v1/spaces/list';
|
|
165829
|
+
method: 'GET' | 'POST';
|
|
165830
|
+
queryParams: {};
|
|
165831
|
+
jsonBody: {};
|
|
165832
|
+
commonParams: {
|
|
165833
|
+
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
|
|
165834
|
+
search?: string | undefined;
|
|
165835
|
+
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
165836
|
+
connected_account_id?: string | undefined;
|
|
165837
|
+
/** Filter spaces by space_key. */
|
|
165838
|
+
space_key?: string | undefined;
|
|
165839
|
+
};
|
|
165840
|
+
formData: {};
|
|
165841
|
+
jsonResponse: {
|
|
165842
|
+
spaces: {
|
|
165843
|
+
/** ID of the space. */
|
|
165844
|
+
space_id: string;
|
|
165845
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
165846
|
+
workspace_id: string;
|
|
165847
|
+
/** Unique key for the space within the workspace. */
|
|
165848
|
+
space_key?: string | undefined;
|
|
165849
|
+
/** Name of the space. */
|
|
165850
|
+
name: string;
|
|
165851
|
+
/** Display name for the space. */
|
|
165852
|
+
display_name: string;
|
|
165853
|
+
/** Date and time at which the space was created. */
|
|
165854
|
+
created_at: string;
|
|
165855
|
+
/** Number of devices in the space. */
|
|
165856
|
+
device_count: number;
|
|
165857
|
+
/** Number of entrances in the space. */
|
|
165858
|
+
acs_entrance_count: number;
|
|
165859
|
+
/** */
|
|
165860
|
+
parent_space_id?: string | undefined;
|
|
165861
|
+
/** */
|
|
165862
|
+
parent_space_key?: string | undefined;
|
|
165863
|
+
}[];
|
|
165864
|
+
};
|
|
165865
|
+
};
|
|
165665
165866
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
165666
165867
|
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
165667
165868
|
method: 'POST';
|
package/dist/index.cjs
CHANGED
|
@@ -42650,6 +42650,11 @@ var openapi_default = {
|
|
|
42650
42650
|
default: {},
|
|
42651
42651
|
description: "Configuration for the connect accounts feature.",
|
|
42652
42652
|
properties: {
|
|
42653
|
+
accepted_providers: {
|
|
42654
|
+
description: "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.",
|
|
42655
|
+
items: { type: "string" },
|
|
42656
|
+
type: "array"
|
|
42657
|
+
},
|
|
42653
42658
|
exclude: {
|
|
42654
42659
|
default: false,
|
|
42655
42660
|
description: "Whether to exclude this feature from the portal.",
|
|
@@ -54471,6 +54476,135 @@ var openapi_default = {
|
|
|
54471
54476
|
"x-title": "Create a Space"
|
|
54472
54477
|
}
|
|
54473
54478
|
},
|
|
54479
|
+
"/seam/customer/v1/spaces/list": {
|
|
54480
|
+
get: {
|
|
54481
|
+
description: "Returns a list of all spaces.",
|
|
54482
|
+
operationId: "seamCustomerV1SpacesListGet",
|
|
54483
|
+
parameters: [
|
|
54484
|
+
{
|
|
54485
|
+
in: "query",
|
|
54486
|
+
name: "search",
|
|
54487
|
+
schema: {
|
|
54488
|
+
description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
|
|
54489
|
+
minLength: 1,
|
|
54490
|
+
type: "string"
|
|
54491
|
+
}
|
|
54492
|
+
},
|
|
54493
|
+
{
|
|
54494
|
+
in: "query",
|
|
54495
|
+
name: "connected_account_id",
|
|
54496
|
+
schema: {
|
|
54497
|
+
description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
|
|
54498
|
+
format: "uuid",
|
|
54499
|
+
type: "string",
|
|
54500
|
+
"x-draft": "Needs review.",
|
|
54501
|
+
"x-undocumented": "Only used internally."
|
|
54502
|
+
}
|
|
54503
|
+
},
|
|
54504
|
+
{
|
|
54505
|
+
in: "query",
|
|
54506
|
+
name: "space_key",
|
|
54507
|
+
schema: {
|
|
54508
|
+
description: "Filter spaces by space_key.",
|
|
54509
|
+
type: "string"
|
|
54510
|
+
}
|
|
54511
|
+
}
|
|
54512
|
+
],
|
|
54513
|
+
responses: {
|
|
54514
|
+
200: {
|
|
54515
|
+
content: {
|
|
54516
|
+
"application/json": {
|
|
54517
|
+
schema: {
|
|
54518
|
+
properties: {
|
|
54519
|
+
ok: { type: "boolean" },
|
|
54520
|
+
spaces: {
|
|
54521
|
+
items: { $ref: "#/components/schemas/space" },
|
|
54522
|
+
type: "array"
|
|
54523
|
+
}
|
|
54524
|
+
},
|
|
54525
|
+
required: ["spaces", "ok"],
|
|
54526
|
+
type: "object"
|
|
54527
|
+
}
|
|
54528
|
+
}
|
|
54529
|
+
},
|
|
54530
|
+
description: "OK"
|
|
54531
|
+
},
|
|
54532
|
+
400: { description: "Bad Request" },
|
|
54533
|
+
401: { description: "Unauthorized" }
|
|
54534
|
+
},
|
|
54535
|
+
security: [{ client_session_with_customer: [] }],
|
|
54536
|
+
summary: "/seam/customer/v1/spaces/list",
|
|
54537
|
+
tags: [],
|
|
54538
|
+
"x-draft": "Early access.",
|
|
54539
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
|
|
54540
|
+
"x-fern-sdk-method-name": "list",
|
|
54541
|
+
"x-fern-sdk-return-value": "spaces",
|
|
54542
|
+
"x-response-key": "spaces",
|
|
54543
|
+
"x-title": "List Spaces"
|
|
54544
|
+
},
|
|
54545
|
+
post: {
|
|
54546
|
+
description: "Returns a list of all spaces.",
|
|
54547
|
+
operationId: "seamCustomerV1SpacesListPost",
|
|
54548
|
+
requestBody: {
|
|
54549
|
+
content: {
|
|
54550
|
+
"application/json": {
|
|
54551
|
+
schema: {
|
|
54552
|
+
properties: {
|
|
54553
|
+
connected_account_id: {
|
|
54554
|
+
description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
|
|
54555
|
+
format: "uuid",
|
|
54556
|
+
type: "string",
|
|
54557
|
+
"x-draft": "Needs review.",
|
|
54558
|
+
"x-undocumented": "Only used internally."
|
|
54559
|
+
},
|
|
54560
|
+
search: {
|
|
54561
|
+
description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
|
|
54562
|
+
minLength: 1,
|
|
54563
|
+
type: "string"
|
|
54564
|
+
},
|
|
54565
|
+
space_key: {
|
|
54566
|
+
description: "Filter spaces by space_key.",
|
|
54567
|
+
type: "string"
|
|
54568
|
+
}
|
|
54569
|
+
},
|
|
54570
|
+
type: "object"
|
|
54571
|
+
}
|
|
54572
|
+
}
|
|
54573
|
+
}
|
|
54574
|
+
},
|
|
54575
|
+
responses: {
|
|
54576
|
+
200: {
|
|
54577
|
+
content: {
|
|
54578
|
+
"application/json": {
|
|
54579
|
+
schema: {
|
|
54580
|
+
properties: {
|
|
54581
|
+
ok: { type: "boolean" },
|
|
54582
|
+
spaces: {
|
|
54583
|
+
items: { $ref: "#/components/schemas/space" },
|
|
54584
|
+
type: "array"
|
|
54585
|
+
}
|
|
54586
|
+
},
|
|
54587
|
+
required: ["spaces", "ok"],
|
|
54588
|
+
type: "object"
|
|
54589
|
+
}
|
|
54590
|
+
}
|
|
54591
|
+
},
|
|
54592
|
+
description: "OK"
|
|
54593
|
+
},
|
|
54594
|
+
400: { description: "Bad Request" },
|
|
54595
|
+
401: { description: "Unauthorized" }
|
|
54596
|
+
},
|
|
54597
|
+
security: [{ client_session_with_customer: [] }],
|
|
54598
|
+
summary: "/seam/customer/v1/spaces/list",
|
|
54599
|
+
tags: [],
|
|
54600
|
+
"x-draft": "Early access.",
|
|
54601
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
|
|
54602
|
+
"x-fern-sdk-method-name": "list",
|
|
54603
|
+
"x-fern-sdk-return-value": "spaces",
|
|
54604
|
+
"x-response-key": "spaces",
|
|
54605
|
+
"x-title": "List Spaces"
|
|
54606
|
+
}
|
|
54607
|
+
},
|
|
54474
54608
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
54475
54609
|
post: {
|
|
54476
54610
|
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.",
|