@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
|
@@ -29821,7 +29821,7 @@ const openapi = {
|
|
|
29821
29821
|
paths: {
|
|
29822
29822
|
'/access_codes/create': {
|
|
29823
29823
|
post: {
|
|
29824
|
-
description: 'Creates a new [access code](https://docs.seam.co/latest/
|
|
29824
|
+
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.',
|
|
29825
29825
|
operationId: 'accessCodesCreatePost',
|
|
29826
29826
|
requestBody: {
|
|
29827
29827
|
content: {
|
|
@@ -32630,7 +32630,7 @@ const openapi = {
|
|
|
32630
32630
|
},
|
|
32631
32631
|
'/access_grants/create': {
|
|
32632
32632
|
post: {
|
|
32633
|
-
description: 'Creates a new Access Grant.',
|
|
32633
|
+
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.',
|
|
32634
32634
|
operationId: 'accessGrantsCreatePost',
|
|
32635
32635
|
requestBody: {
|
|
32636
32636
|
content: {
|
|
@@ -36519,6 +36519,66 @@ const openapi = {
|
|
|
36519
36519
|
'x-title': 'Update an Access Grant',
|
|
36520
36520
|
},
|
|
36521
36521
|
},
|
|
36522
|
+
'/access_methods/assign_card': {
|
|
36523
|
+
post: {
|
|
36524
|
+
description: 'Assigns an existing card credential to a card-mode access method, identified by `card_number`.',
|
|
36525
|
+
operationId: 'accessMethodsAssignCardPost',
|
|
36526
|
+
requestBody: {
|
|
36527
|
+
content: {
|
|
36528
|
+
'application/json': {
|
|
36529
|
+
schema: {
|
|
36530
|
+
properties: {
|
|
36531
|
+
access_method_id: {
|
|
36532
|
+
description: 'ID of the card-mode `access_method` to assign the card to.',
|
|
36533
|
+
format: 'uuid',
|
|
36534
|
+
type: 'string',
|
|
36535
|
+
},
|
|
36536
|
+
card_number: {
|
|
36537
|
+
description: 'Card number of the card credential to assign.',
|
|
36538
|
+
type: 'string',
|
|
36539
|
+
},
|
|
36540
|
+
},
|
|
36541
|
+
required: ['access_method_id', 'card_number'],
|
|
36542
|
+
type: 'object',
|
|
36543
|
+
},
|
|
36544
|
+
},
|
|
36545
|
+
},
|
|
36546
|
+
},
|
|
36547
|
+
responses: {
|
|
36548
|
+
200: {
|
|
36549
|
+
content: {
|
|
36550
|
+
'application/json': {
|
|
36551
|
+
schema: {
|
|
36552
|
+
properties: {
|
|
36553
|
+
access_method: {
|
|
36554
|
+
$ref: '#/components/schemas/access_method',
|
|
36555
|
+
},
|
|
36556
|
+
ok: { type: 'boolean' },
|
|
36557
|
+
},
|
|
36558
|
+
required: ['access_method', 'ok'],
|
|
36559
|
+
type: 'object',
|
|
36560
|
+
},
|
|
36561
|
+
},
|
|
36562
|
+
},
|
|
36563
|
+
description: 'OK',
|
|
36564
|
+
},
|
|
36565
|
+
400: { description: 'Bad Request' },
|
|
36566
|
+
401: { description: 'Unauthorized' },
|
|
36567
|
+
},
|
|
36568
|
+
security: [
|
|
36569
|
+
{ pat_with_workspace: [] },
|
|
36570
|
+
{ console_session_with_workspace: [] },
|
|
36571
|
+
{ api_key: [] },
|
|
36572
|
+
],
|
|
36573
|
+
summary: '/access_methods/assign_card',
|
|
36574
|
+
tags: [],
|
|
36575
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
36576
|
+
'x-fern-sdk-method-name': 'assign_card',
|
|
36577
|
+
'x-fern-sdk-return-value': 'access_method',
|
|
36578
|
+
'x-response-key': 'access_method',
|
|
36579
|
+
'x-title': 'Assign a Card to an Access Method',
|
|
36580
|
+
},
|
|
36581
|
+
},
|
|
36522
36582
|
'/access_methods/delete': {
|
|
36523
36583
|
delete: {
|
|
36524
36584
|
description: 'Deletes an access method.',
|
|
@@ -40252,7 +40312,7 @@ const openapi = {
|
|
|
40252
40312
|
},
|
|
40253
40313
|
'/acs/credentials/create': {
|
|
40254
40314
|
post: {
|
|
40255
|
-
description: 'Creates a new [credential](https://docs.seam.co/latest/
|
|
40315
|
+
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.',
|
|
40256
40316
|
operationId: 'acsCredentialsCreatePost',
|
|
40257
40317
|
requestBody: {
|
|
40258
40318
|
content: {
|