@seamapi/types 1.805.0 → 1.807.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 +7 -25
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +5 -23
- package/dist/index.cjs +7 -25
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -18
- package/lib/seam/connect/openapi.js +4 -22
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +5 -5
- package/package.json +2 -2
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +4 -22
- package/src/lib/seam/connect/route-types.ts +5 -5
|
@@ -18080,7 +18080,7 @@ export type Routes = {
|
|
|
18080
18080
|
|
|
18081
18081
|
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
18082
18082
|
|
|
18083
|
-
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
18083
|
+
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
18084
18084
|
acs_access_group: {
|
|
18085
18085
|
/** ID of the access group. */
|
|
18086
18086
|
acs_access_group_id: string;
|
|
@@ -19428,7 +19428,7 @@ export type Routes = {
|
|
|
19428
19428
|
acs_system_id?: string | undefined;
|
|
19429
19429
|
/** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
19430
19430
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
19431
|
-
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
19431
|
+
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides). */
|
|
19432
19432
|
code?: string | undefined;
|
|
19433
19433
|
/** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
19434
19434
|
is_multi_phone_sync_credential?: boolean;
|
|
@@ -22236,7 +22236,7 @@ export type Routes = {
|
|
|
22236
22236
|
|
|
22237
22237
|
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
22238
22238
|
|
|
22239
|
-
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
22239
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
22240
22240
|
acs_encoder: {
|
|
22241
22241
|
/** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
|
|
22242
22242
|
acs_encoder_id: string;
|
|
@@ -26061,7 +26061,7 @@ export type Routes = {
|
|
|
26061
26061
|
|
|
26062
26062
|
An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
26063
26063
|
|
|
26064
|
-
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
26064
|
+
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
26065
26065
|
acs_user: {
|
|
26066
26066
|
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
26067
26067
|
acs_user_id: string;
|
|
@@ -26336,7 +26336,7 @@ export type Routes = {
|
|
|
26336
26336
|
|
|
26337
26337
|
An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
26338
26338
|
|
|
26339
|
-
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
26339
|
+
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
26340
26340
|
acs_user: {
|
|
26341
26341
|
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
26342
26342
|
acs_user_id: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/types",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.807.0",
|
|
4
4
|
"description": "TypeScript types for the Seam API.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
"zod": "^3.24.0"
|
|
92
92
|
},
|
|
93
93
|
"devDependencies": {
|
|
94
|
-
"@seamapi/blueprint": "^0.
|
|
94
|
+
"@seamapi/blueprint": "^0.55.0",
|
|
95
95
|
"@swc/core": "^1.11.29",
|
|
96
96
|
"@types/node": "^24.10.9",
|
|
97
97
|
"concurrently": "^9.2.0",
|
|
@@ -178,7 +178,7 @@ export const acs_access_group = common_acs_access_group.extend({
|
|
|
178
178
|
|
|
179
179
|
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
180
180
|
|
|
181
|
-
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
181
|
+
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
|
|
182
182
|
`)
|
|
183
183
|
export const unmanaged_acs_access_group = common_acs_access_group.extend({
|
|
184
184
|
is_managed: z.literal(false),
|
|
@@ -91,7 +91,7 @@ export const acs_encoder = z.object({
|
|
|
91
91
|
|
|
92
92
|
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
93
93
|
|
|
94
|
-
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
94
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
|
|
95
95
|
`)
|
|
96
96
|
|
|
97
97
|
export type AcsEncoder = z.infer<typeof acs_encoder>
|
|
@@ -332,7 +332,7 @@ export const acs_user = common_acs_user.merge(
|
|
|
332
332
|
|
|
333
333
|
An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
334
334
|
|
|
335
|
-
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
335
|
+
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
|
|
336
336
|
`)
|
|
337
337
|
|
|
338
338
|
export const unmanaged_acs_user = common_acs_user.merge(
|
|
@@ -3066,7 +3066,7 @@ export default {
|
|
|
3066
3066
|
},
|
|
3067
3067
|
acs_access_group: {
|
|
3068
3068
|
description:
|
|
3069
|
-
'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
3069
|
+
'Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).',
|
|
3070
3070
|
properties: {
|
|
3071
3071
|
access_group_type: {
|
|
3072
3072
|
deprecated: true,
|
|
@@ -4104,7 +4104,7 @@ export default {
|
|
|
4104
4104
|
},
|
|
4105
4105
|
acs_encoder: {
|
|
4106
4106
|
description:
|
|
4107
|
-
'Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
4107
|
+
'Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).',
|
|
4108
4108
|
properties: {
|
|
4109
4109
|
acs_encoder_id: {
|
|
4110
4110
|
description:
|
|
@@ -4971,7 +4971,7 @@ export default {
|
|
|
4971
4971
|
},
|
|
4972
4972
|
acs_user: {
|
|
4973
4973
|
description:
|
|
4974
|
-
'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
4974
|
+
'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).',
|
|
4975
4975
|
properties: {
|
|
4976
4976
|
access_schedule: {
|
|
4977
4977
|
description:
|
|
@@ -34820,7 +34820,6 @@ export default {
|
|
|
34820
34820
|
],
|
|
34821
34821
|
summary: '/access_grants/create',
|
|
34822
34822
|
tags: [],
|
|
34823
|
-
'x-draft': 'Early access.',
|
|
34824
34823
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
34825
34824
|
'x-fern-sdk-method-name': 'create',
|
|
34826
34825
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -34868,7 +34867,6 @@ export default {
|
|
|
34868
34867
|
],
|
|
34869
34868
|
summary: '/access_grants/delete',
|
|
34870
34869
|
tags: [],
|
|
34871
|
-
'x-draft': 'Early access.',
|
|
34872
34870
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
34873
34871
|
'x-fern-sdk-method-name': 'delete',
|
|
34874
34872
|
'x-response-key': null,
|
|
@@ -34918,7 +34916,6 @@ export default {
|
|
|
34918
34916
|
],
|
|
34919
34917
|
summary: '/access_grants/delete',
|
|
34920
34918
|
tags: [],
|
|
34921
|
-
'x-draft': 'Early access.',
|
|
34922
34919
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
34923
34920
|
'x-fern-sdk-method-name': 'delete',
|
|
34924
34921
|
'x-response-key': null,
|
|
@@ -34956,7 +34953,6 @@ export default {
|
|
|
34956
34953
|
],
|
|
34957
34954
|
summary: '/access_grants/get',
|
|
34958
34955
|
tags: [],
|
|
34959
|
-
'x-draft': 'Early access.',
|
|
34960
34956
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
34961
34957
|
'x-fern-sdk-method-name': 'get',
|
|
34962
34958
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -35024,7 +35020,6 @@ export default {
|
|
|
35024
35020
|
],
|
|
35025
35021
|
summary: '/access_grants/get',
|
|
35026
35022
|
tags: [],
|
|
35027
|
-
'x-draft': 'Early access.',
|
|
35028
35023
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35029
35024
|
'x-fern-sdk-method-name': 'get',
|
|
35030
35025
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -35177,7 +35172,6 @@ export default {
|
|
|
35177
35172
|
'acs_access_groups',
|
|
35178
35173
|
'access_methods',
|
|
35179
35174
|
],
|
|
35180
|
-
'x-draft': 'Early access.',
|
|
35181
35175
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35182
35176
|
'x-fern-sdk-method-name': 'get_related',
|
|
35183
35177
|
'x-fern-sdk-return-value': 'batch',
|
|
@@ -35321,7 +35315,6 @@ export default {
|
|
|
35321
35315
|
'acs_access_groups',
|
|
35322
35316
|
'access_methods',
|
|
35323
35317
|
],
|
|
35324
|
-
'x-draft': 'Early access.',
|
|
35325
35318
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35326
35319
|
'x-fern-sdk-method-name': 'get_related',
|
|
35327
35320
|
'x-fern-sdk-return-value': 'batch',
|
|
@@ -35483,7 +35476,6 @@ export default {
|
|
|
35483
35476
|
],
|
|
35484
35477
|
summary: '/access_grants/list',
|
|
35485
35478
|
tags: [],
|
|
35486
|
-
'x-draft': 'Early access.',
|
|
35487
35479
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35488
35480
|
'x-fern-sdk-method-name': 'list',
|
|
35489
35481
|
'x-fern-sdk-return-value': 'access_grants',
|
|
@@ -35604,7 +35596,6 @@ export default {
|
|
|
35604
35596
|
],
|
|
35605
35597
|
summary: '/access_grants/list',
|
|
35606
35598
|
tags: [],
|
|
35607
|
-
'x-draft': 'Early access.',
|
|
35608
35599
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35609
35600
|
'x-fern-sdk-method-name': 'list',
|
|
35610
35601
|
'x-fern-sdk-return-value': 'access_grants',
|
|
@@ -35694,7 +35685,6 @@ export default {
|
|
|
35694
35685
|
],
|
|
35695
35686
|
summary: '/access_grants/request_access_methods',
|
|
35696
35687
|
tags: [],
|
|
35697
|
-
'x-draft': 'Early access.',
|
|
35698
35688
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35699
35689
|
'x-fern-sdk-method-name': 'request_access_methods',
|
|
35700
35690
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -36348,7 +36338,6 @@ export default {
|
|
|
36348
36338
|
],
|
|
36349
36339
|
summary: '/access_grants/unmanaged/get',
|
|
36350
36340
|
tags: [],
|
|
36351
|
-
'x-draft': 'Early access.',
|
|
36352
36341
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
36353
36342
|
'x-fern-sdk-method-name': 'get',
|
|
36354
36343
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -37005,7 +36994,6 @@ export default {
|
|
|
37005
36994
|
],
|
|
37006
36995
|
summary: '/access_grants/unmanaged/get',
|
|
37007
36996
|
tags: [],
|
|
37008
|
-
'x-draft': 'Early access.',
|
|
37009
36997
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
37010
36998
|
'x-fern-sdk-method-name': 'get',
|
|
37011
36999
|
'x-fern-sdk-return-value': 'access_grant',
|
|
@@ -37714,7 +37702,6 @@ export default {
|
|
|
37714
37702
|
],
|
|
37715
37703
|
summary: '/access_grants/unmanaged/list',
|
|
37716
37704
|
tags: [],
|
|
37717
|
-
'x-draft': 'Early access.',
|
|
37718
37705
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
37719
37706
|
'x-fern-sdk-method-name': 'list',
|
|
37720
37707
|
'x-fern-sdk-return-value': 'access_grants',
|
|
@@ -38407,7 +38394,6 @@ export default {
|
|
|
38407
38394
|
],
|
|
38408
38395
|
summary: '/access_grants/unmanaged/list',
|
|
38409
38396
|
tags: [],
|
|
38410
|
-
'x-draft': 'Early access.',
|
|
38411
38397
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
38412
38398
|
'x-fern-sdk-method-name': 'list',
|
|
38413
38399
|
'x-fern-sdk-return-value': 'access_grants',
|
|
@@ -38472,7 +38458,6 @@ export default {
|
|
|
38472
38458
|
],
|
|
38473
38459
|
summary: '/access_grants/unmanaged/update',
|
|
38474
38460
|
tags: [],
|
|
38475
|
-
'x-draft': 'Early access.',
|
|
38476
38461
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
38477
38462
|
'x-fern-sdk-method-name': 'update',
|
|
38478
38463
|
'x-response-key': null,
|
|
@@ -38534,7 +38519,6 @@ export default {
|
|
|
38534
38519
|
],
|
|
38535
38520
|
summary: '/access_grants/unmanaged/update',
|
|
38536
38521
|
tags: [],
|
|
38537
|
-
'x-draft': 'Early access.',
|
|
38538
38522
|
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
38539
38523
|
'x-fern-sdk-method-name': 'update',
|
|
38540
38524
|
'x-response-key': null,
|
|
@@ -38604,7 +38588,6 @@ export default {
|
|
|
38604
38588
|
],
|
|
38605
38589
|
summary: '/access_grants/update',
|
|
38606
38590
|
tags: [],
|
|
38607
|
-
'x-draft': 'Early access.',
|
|
38608
38591
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
38609
38592
|
'x-fern-sdk-method-name': 'update',
|
|
38610
38593
|
'x-response-key': null,
|
|
@@ -38672,7 +38655,6 @@ export default {
|
|
|
38672
38655
|
],
|
|
38673
38656
|
summary: '/access_grants/update',
|
|
38674
38657
|
tags: [],
|
|
38675
|
-
'x-draft': 'Early access.',
|
|
38676
38658
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
38677
38659
|
'x-fern-sdk-method-name': 'update',
|
|
38678
38660
|
'x-response-key': null,
|
|
@@ -42773,7 +42755,7 @@ export default {
|
|
|
42773
42755
|
},
|
|
42774
42756
|
code: {
|
|
42775
42757
|
description:
|
|
42776
|
-
'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
42758
|
+
'Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides).',
|
|
42777
42759
|
pattern: '^\\d+$',
|
|
42778
42760
|
type: 'string',
|
|
42779
42761
|
},
|
|
@@ -20851,7 +20851,7 @@ export type Routes = {
|
|
|
20851
20851
|
|
|
20852
20852
|
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
20853
20853
|
|
|
20854
|
-
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
20854
|
+
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
20855
20855
|
acs_access_group: {
|
|
20856
20856
|
/** ID of the access group. */
|
|
20857
20857
|
acs_access_group_id: string
|
|
@@ -22406,7 +22406,7 @@ export type Routes = {
|
|
|
22406
22406
|
acs_system_id?: string | undefined
|
|
22407
22407
|
/** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
22408
22408
|
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
22409
|
-
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
22409
|
+
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides). */
|
|
22410
22410
|
code?: string | undefined
|
|
22411
22411
|
/** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
22412
22412
|
is_multi_phone_sync_credential?: boolean
|
|
@@ -25708,7 +25708,7 @@ export type Routes = {
|
|
|
25708
25708
|
|
|
25709
25709
|
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
25710
25710
|
|
|
25711
|
-
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
25711
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
25712
25712
|
acs_encoder: {
|
|
25713
25713
|
/** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
|
|
25714
25714
|
acs_encoder_id: string
|
|
@@ -30210,7 +30210,7 @@ export type Routes = {
|
|
|
30210
30210
|
|
|
30211
30211
|
An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
30212
30212
|
|
|
30213
|
-
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
30213
|
+
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
30214
30214
|
acs_user: {
|
|
30215
30215
|
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
30216
30216
|
acs_user_id: string
|
|
@@ -30522,7 +30522,7 @@ export type Routes = {
|
|
|
30522
30522
|
|
|
30523
30523
|
An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
30524
30524
|
|
|
30525
|
-
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides
|
|
30525
|
+
For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
|
|
30526
30526
|
acs_user: {
|
|
30527
30527
|
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
30528
30528
|
acs_user_id: string
|