@seamapi/types 1.592.0 → 1.594.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 +208 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +370 -0
- package/dist/index.cjs +208 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +255 -0
- package/lib/seam/connect/openapi.js +208 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +115 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +217 -0
- package/src/lib/seam/connect/route-types.ts +115 -0
package/dist/connect.cjs
CHANGED
|
@@ -31946,6 +31946,85 @@ var openapi_default = {
|
|
|
31946
31946
|
"x-title": "List Access Grants"
|
|
31947
31947
|
}
|
|
31948
31948
|
},
|
|
31949
|
+
"/access_grants/request_access_methods": {
|
|
31950
|
+
post: {
|
|
31951
|
+
description: "Adds additional requested access methods to an existing Access Grant.",
|
|
31952
|
+
operationId: "accessGrantsRequestAccessMethodsPost",
|
|
31953
|
+
requestBody: {
|
|
31954
|
+
content: {
|
|
31955
|
+
"application/json": {
|
|
31956
|
+
schema: {
|
|
31957
|
+
properties: {
|
|
31958
|
+
access_grant_id: {
|
|
31959
|
+
description: "ID of the Access Grant to add access methods to.",
|
|
31960
|
+
format: "uuid",
|
|
31961
|
+
type: "string"
|
|
31962
|
+
},
|
|
31963
|
+
requested_access_methods: {
|
|
31964
|
+
description: "Array of requested access methods to add to the access grant.",
|
|
31965
|
+
items: {
|
|
31966
|
+
properties: {
|
|
31967
|
+
code: {
|
|
31968
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
31969
|
+
maxLength: 9,
|
|
31970
|
+
minLength: 4,
|
|
31971
|
+
pattern: "^\\d+$",
|
|
31972
|
+
type: "string"
|
|
31973
|
+
},
|
|
31974
|
+
mode: {
|
|
31975
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
31976
|
+
enum: ["code", "card", "mobile_key"],
|
|
31977
|
+
type: "string"
|
|
31978
|
+
}
|
|
31979
|
+
},
|
|
31980
|
+
required: ["mode"],
|
|
31981
|
+
type: "object"
|
|
31982
|
+
},
|
|
31983
|
+
minItems: 1,
|
|
31984
|
+
type: "array"
|
|
31985
|
+
}
|
|
31986
|
+
},
|
|
31987
|
+
required: ["access_grant_id", "requested_access_methods"],
|
|
31988
|
+
type: "object"
|
|
31989
|
+
}
|
|
31990
|
+
}
|
|
31991
|
+
}
|
|
31992
|
+
},
|
|
31993
|
+
responses: {
|
|
31994
|
+
200: {
|
|
31995
|
+
content: {
|
|
31996
|
+
"application/json": {
|
|
31997
|
+
schema: {
|
|
31998
|
+
properties: {
|
|
31999
|
+
access_grant: { $ref: "#/components/schemas/access_grant" },
|
|
32000
|
+
ok: { type: "boolean" }
|
|
32001
|
+
},
|
|
32002
|
+
required: ["access_grant", "ok"],
|
|
32003
|
+
type: "object"
|
|
32004
|
+
}
|
|
32005
|
+
}
|
|
32006
|
+
},
|
|
32007
|
+
description: "OK"
|
|
32008
|
+
},
|
|
32009
|
+
400: { description: "Bad Request" },
|
|
32010
|
+
401: { description: "Unauthorized" }
|
|
32011
|
+
},
|
|
32012
|
+
security: [
|
|
32013
|
+
{ pat_with_workspace: [] },
|
|
32014
|
+
{ console_session_with_workspace: [] },
|
|
32015
|
+
{ api_key: [] },
|
|
32016
|
+
{ client_session_with_customer: [] }
|
|
32017
|
+
],
|
|
32018
|
+
summary: "/access_grants/request_access_methods",
|
|
32019
|
+
tags: [],
|
|
32020
|
+
"x-draft": "Early access.",
|
|
32021
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
32022
|
+
"x-fern-sdk-method-name": "request_access_methods",
|
|
32023
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
32024
|
+
"x-response-key": "access_grant",
|
|
32025
|
+
"x-title": "Add Requested Access Methods to Access Grant"
|
|
32026
|
+
}
|
|
32027
|
+
},
|
|
31949
32028
|
"/access_grants/unmanaged/get": {
|
|
31950
32029
|
get: {
|
|
31951
32030
|
description: "Get an unmanaged Access Grant (where is_managed = false).",
|
|
@@ -54476,6 +54555,135 @@ var openapi_default = {
|
|
|
54476
54555
|
"x-title": "Create a Space"
|
|
54477
54556
|
}
|
|
54478
54557
|
},
|
|
54558
|
+
"/seam/customer/v1/spaces/list": {
|
|
54559
|
+
get: {
|
|
54560
|
+
description: "Returns a list of all spaces.",
|
|
54561
|
+
operationId: "seamCustomerV1SpacesListGet",
|
|
54562
|
+
parameters: [
|
|
54563
|
+
{
|
|
54564
|
+
in: "query",
|
|
54565
|
+
name: "search",
|
|
54566
|
+
schema: {
|
|
54567
|
+
description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
|
|
54568
|
+
minLength: 1,
|
|
54569
|
+
type: "string"
|
|
54570
|
+
}
|
|
54571
|
+
},
|
|
54572
|
+
{
|
|
54573
|
+
in: "query",
|
|
54574
|
+
name: "connected_account_id",
|
|
54575
|
+
schema: {
|
|
54576
|
+
description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
|
|
54577
|
+
format: "uuid",
|
|
54578
|
+
type: "string",
|
|
54579
|
+
"x-draft": "Needs review.",
|
|
54580
|
+
"x-undocumented": "Only used internally."
|
|
54581
|
+
}
|
|
54582
|
+
},
|
|
54583
|
+
{
|
|
54584
|
+
in: "query",
|
|
54585
|
+
name: "space_key",
|
|
54586
|
+
schema: {
|
|
54587
|
+
description: "Filter spaces by space_key.",
|
|
54588
|
+
type: "string"
|
|
54589
|
+
}
|
|
54590
|
+
}
|
|
54591
|
+
],
|
|
54592
|
+
responses: {
|
|
54593
|
+
200: {
|
|
54594
|
+
content: {
|
|
54595
|
+
"application/json": {
|
|
54596
|
+
schema: {
|
|
54597
|
+
properties: {
|
|
54598
|
+
ok: { type: "boolean" },
|
|
54599
|
+
spaces: {
|
|
54600
|
+
items: { $ref: "#/components/schemas/space" },
|
|
54601
|
+
type: "array"
|
|
54602
|
+
}
|
|
54603
|
+
},
|
|
54604
|
+
required: ["spaces", "ok"],
|
|
54605
|
+
type: "object"
|
|
54606
|
+
}
|
|
54607
|
+
}
|
|
54608
|
+
},
|
|
54609
|
+
description: "OK"
|
|
54610
|
+
},
|
|
54611
|
+
400: { description: "Bad Request" },
|
|
54612
|
+
401: { description: "Unauthorized" }
|
|
54613
|
+
},
|
|
54614
|
+
security: [{ client_session_with_customer: [] }],
|
|
54615
|
+
summary: "/seam/customer/v1/spaces/list",
|
|
54616
|
+
tags: [],
|
|
54617
|
+
"x-draft": "Early access.",
|
|
54618
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
|
|
54619
|
+
"x-fern-sdk-method-name": "list",
|
|
54620
|
+
"x-fern-sdk-return-value": "spaces",
|
|
54621
|
+
"x-response-key": "spaces",
|
|
54622
|
+
"x-title": "List Spaces"
|
|
54623
|
+
},
|
|
54624
|
+
post: {
|
|
54625
|
+
description: "Returns a list of all spaces.",
|
|
54626
|
+
operationId: "seamCustomerV1SpacesListPost",
|
|
54627
|
+
requestBody: {
|
|
54628
|
+
content: {
|
|
54629
|
+
"application/json": {
|
|
54630
|
+
schema: {
|
|
54631
|
+
properties: {
|
|
54632
|
+
connected_account_id: {
|
|
54633
|
+
description: "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
|
|
54634
|
+
format: "uuid",
|
|
54635
|
+
type: "string",
|
|
54636
|
+
"x-draft": "Needs review.",
|
|
54637
|
+
"x-undocumented": "Only used internally."
|
|
54638
|
+
},
|
|
54639
|
+
search: {
|
|
54640
|
+
description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
|
|
54641
|
+
minLength: 1,
|
|
54642
|
+
type: "string"
|
|
54643
|
+
},
|
|
54644
|
+
space_key: {
|
|
54645
|
+
description: "Filter spaces by space_key.",
|
|
54646
|
+
type: "string"
|
|
54647
|
+
}
|
|
54648
|
+
},
|
|
54649
|
+
type: "object"
|
|
54650
|
+
}
|
|
54651
|
+
}
|
|
54652
|
+
}
|
|
54653
|
+
},
|
|
54654
|
+
responses: {
|
|
54655
|
+
200: {
|
|
54656
|
+
content: {
|
|
54657
|
+
"application/json": {
|
|
54658
|
+
schema: {
|
|
54659
|
+
properties: {
|
|
54660
|
+
ok: { type: "boolean" },
|
|
54661
|
+
spaces: {
|
|
54662
|
+
items: { $ref: "#/components/schemas/space" },
|
|
54663
|
+
type: "array"
|
|
54664
|
+
}
|
|
54665
|
+
},
|
|
54666
|
+
required: ["spaces", "ok"],
|
|
54667
|
+
type: "object"
|
|
54668
|
+
}
|
|
54669
|
+
}
|
|
54670
|
+
},
|
|
54671
|
+
description: "OK"
|
|
54672
|
+
},
|
|
54673
|
+
400: { description: "Bad Request" },
|
|
54674
|
+
401: { description: "Unauthorized" }
|
|
54675
|
+
},
|
|
54676
|
+
security: [{ client_session_with_customer: [] }],
|
|
54677
|
+
summary: "/seam/customer/v1/spaces/list",
|
|
54678
|
+
tags: [],
|
|
54679
|
+
"x-draft": "Early access.",
|
|
54680
|
+
"x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
|
|
54681
|
+
"x-fern-sdk-method-name": "list",
|
|
54682
|
+
"x-fern-sdk-return-value": "spaces",
|
|
54683
|
+
"x-response-key": "spaces",
|
|
54684
|
+
"x-title": "List Spaces"
|
|
54685
|
+
}
|
|
54686
|
+
},
|
|
54479
54687
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
54480
54688
|
post: {
|
|
54481
54689
|
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.",
|