@seamapi/types 1.874.0 → 1.876.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 +63 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +127 -0
- package/dist/index.cjs +63 -3
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.js +63 -3
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +127 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +67 -3
- package/src/lib/seam/connect/route-types.ts +135 -0
package/dist/connect.cjs
CHANGED
|
@@ -37076,7 +37076,7 @@ var openapi = {
|
|
|
37076
37076
|
paths: {
|
|
37077
37077
|
"/access_codes/create": {
|
|
37078
37078
|
post: {
|
|
37079
|
-
description: "Creates a new [access code](https://docs.seam.co/latest/
|
|
37079
|
+
description: "Creates a new [access code](https://docs.seam.co/latest/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.",
|
|
37080
37080
|
operationId: "accessCodesCreatePost",
|
|
37081
37081
|
requestBody: {
|
|
37082
37082
|
content: {
|
|
@@ -39885,7 +39885,7 @@ var openapi = {
|
|
|
39885
39885
|
},
|
|
39886
39886
|
"/access_grants/create": {
|
|
39887
39887
|
post: {
|
|
39888
|
-
description: "Creates a new Access Grant.",
|
|
39888
|
+
description: "Creates a new [Access Grant](https://docs.seam.co/latest/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.",
|
|
39889
39889
|
operationId: "accessGrantsCreatePost",
|
|
39890
39890
|
requestBody: {
|
|
39891
39891
|
content: {
|
|
@@ -43774,6 +43774,66 @@ var openapi = {
|
|
|
43774
43774
|
"x-title": "Update an Access Grant"
|
|
43775
43775
|
}
|
|
43776
43776
|
},
|
|
43777
|
+
"/access_methods/assign_card": {
|
|
43778
|
+
post: {
|
|
43779
|
+
description: "Assigns an existing card credential to a card-mode access method, identified by `card_number`.",
|
|
43780
|
+
operationId: "accessMethodsAssignCardPost",
|
|
43781
|
+
requestBody: {
|
|
43782
|
+
content: {
|
|
43783
|
+
"application/json": {
|
|
43784
|
+
schema: {
|
|
43785
|
+
properties: {
|
|
43786
|
+
access_method_id: {
|
|
43787
|
+
description: "ID of the card-mode `access_method` to assign the card to.",
|
|
43788
|
+
format: "uuid",
|
|
43789
|
+
type: "string"
|
|
43790
|
+
},
|
|
43791
|
+
card_number: {
|
|
43792
|
+
description: "Card number of the card credential to assign.",
|
|
43793
|
+
type: "string"
|
|
43794
|
+
}
|
|
43795
|
+
},
|
|
43796
|
+
required: ["access_method_id", "card_number"],
|
|
43797
|
+
type: "object"
|
|
43798
|
+
}
|
|
43799
|
+
}
|
|
43800
|
+
}
|
|
43801
|
+
},
|
|
43802
|
+
responses: {
|
|
43803
|
+
200: {
|
|
43804
|
+
content: {
|
|
43805
|
+
"application/json": {
|
|
43806
|
+
schema: {
|
|
43807
|
+
properties: {
|
|
43808
|
+
access_method: {
|
|
43809
|
+
$ref: "#/components/schemas/access_method"
|
|
43810
|
+
},
|
|
43811
|
+
ok: { type: "boolean" }
|
|
43812
|
+
},
|
|
43813
|
+
required: ["access_method", "ok"],
|
|
43814
|
+
type: "object"
|
|
43815
|
+
}
|
|
43816
|
+
}
|
|
43817
|
+
},
|
|
43818
|
+
description: "OK"
|
|
43819
|
+
},
|
|
43820
|
+
400: { description: "Bad Request" },
|
|
43821
|
+
401: { description: "Unauthorized" }
|
|
43822
|
+
},
|
|
43823
|
+
security: [
|
|
43824
|
+
{ pat_with_workspace: [] },
|
|
43825
|
+
{ console_session_with_workspace: [] },
|
|
43826
|
+
{ api_key: [] }
|
|
43827
|
+
],
|
|
43828
|
+
summary: "/access_methods/assign_card",
|
|
43829
|
+
tags: [],
|
|
43830
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
43831
|
+
"x-fern-sdk-method-name": "assign_card",
|
|
43832
|
+
"x-fern-sdk-return-value": "access_method",
|
|
43833
|
+
"x-response-key": "access_method",
|
|
43834
|
+
"x-title": "Assign a Card to an Access Method"
|
|
43835
|
+
}
|
|
43836
|
+
},
|
|
43777
43837
|
"/access_methods/delete": {
|
|
43778
43838
|
delete: {
|
|
43779
43839
|
description: "Deletes an access method.",
|
|
@@ -47507,7 +47567,7 @@ var openapi = {
|
|
|
47507
47567
|
},
|
|
47508
47568
|
"/acs/credentials/create": {
|
|
47509
47569
|
post: {
|
|
47510
|
-
description: "Creates a new [credential](https://docs.seam.co/latest/
|
|
47570
|
+
description: "Creates a new [credential](https://docs.seam.co/latest/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/latest/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.",
|
|
47511
47571
|
operationId: "acsCredentialsCreatePost",
|
|
47512
47572
|
requestBody: {
|
|
47513
47573
|
content: {
|