@seamapi/types 1.369.0 → 1.369.2

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.
Files changed (31) hide show
  1. package/dist/connect.cjs +51 -15
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +58 -11
  4. package/lib/seam/connect/models/acs/acs-access-group.js +4 -1
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.js +5 -1
  7. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-encoder.js +14 -1
  9. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-entrance.js +2 -0
  11. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-system.js +4 -0
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-users/acs-user.js +6 -0
  15. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  16. package/lib/seam/connect/models/pagination.js +1 -0
  17. package/lib/seam/connect/models/pagination.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +6 -0
  19. package/lib/seam/connect/openapi.js +14 -8
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +52 -11
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-access-group.ts +4 -1
  24. package/src/lib/seam/connect/models/acs/acs-credential.ts +5 -1
  25. package/src/lib/seam/connect/models/acs/acs-encoder.ts +14 -1
  26. package/src/lib/seam/connect/models/acs/acs-entrance.ts +2 -0
  27. package/src/lib/seam/connect/models/acs/acs-system.ts +4 -0
  28. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +6 -0
  29. package/src/lib/seam/connect/models/pagination.ts +1 -0
  30. package/src/lib/seam/connect/openapi.ts +14 -8
  31. package/src/lib/seam/connect/route-types.ts +52 -11
@@ -7051,7 +7051,10 @@ export interface Routes {
7051
7051
  formData: {};
7052
7052
  jsonResponse: {
7053
7053
  /** 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.
7054
- The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
7054
+
7055
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/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.
7056
+
7057
+ 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/overview#access-control-systems). */
7055
7058
  acs_access_group: {
7056
7059
  /** ID of the access group. */
7057
7060
  acs_access_group_id: string;
@@ -7538,7 +7541,11 @@ export interface Routes {
7538
7541
  commonParams: {};
7539
7542
  formData: {};
7540
7543
  jsonResponse: {
7541
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
7544
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
7545
+
7546
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
7547
+
7548
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
7542
7549
  acs_credential: {
7543
7550
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
7544
7551
  acs_credential_id: string;
@@ -7703,7 +7710,11 @@ export interface Routes {
7703
7710
  };
7704
7711
  formData: {};
7705
7712
  jsonResponse: {
7706
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
7713
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
7714
+
7715
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
7716
+
7717
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
7707
7718
  acs_credential: {
7708
7719
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
7709
7720
  acs_credential_id: string;
@@ -7837,7 +7848,11 @@ export interface Routes {
7837
7848
  };
7838
7849
  formData: {};
7839
7850
  jsonResponse: {
7840
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
7851
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
7852
+
7853
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
7854
+
7855
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
7841
7856
  acs_credential: {
7842
7857
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
7843
7858
  acs_credential_id: string;
@@ -7975,7 +7990,11 @@ export interface Routes {
7975
7990
  };
7976
7991
  formData: {};
7977
7992
  jsonResponse: {
7978
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
7993
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
7994
+
7995
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
7996
+
7997
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
7979
7998
  acs_credential: {
7980
7999
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
7981
8000
  acs_credential_id: string;
@@ -8321,7 +8340,11 @@ export interface Routes {
8321
8340
  commonParams: {};
8322
8341
  formData: {};
8323
8342
  jsonResponse: {
8324
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
8343
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
8344
+
8345
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
8346
+
8347
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
8325
8348
  acs_credential: {
8326
8349
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
8327
8350
  acs_credential_id: string;
@@ -8713,7 +8736,11 @@ export interface Routes {
8713
8736
  commonParams: {};
8714
8737
  formData: {};
8715
8738
  jsonResponse: {
8716
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
8739
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
8740
+
8741
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
8742
+
8743
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
8717
8744
  acs_credential: {
8718
8745
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
8719
8746
  acs_credential_id: string;
@@ -10891,7 +10918,9 @@ export interface Routes {
10891
10918
  };
10892
10919
  formData: {};
10893
10920
  jsonResponse: {
10894
- /** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
10921
+ /** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
10922
+
10923
+ In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */
10895
10924
  acs_entrance: {
10896
10925
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
10897
10926
  acs_system_id: string;
@@ -11179,7 +11208,11 @@ export interface Routes {
11179
11208
  };
11180
11209
  formData: {};
11181
11210
  jsonResponse: {
11182
- /** Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11211
+ /** Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
11212
+
11213
+ Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.
11214
+
11215
+ For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs). */
11183
11216
  acs_system: {
11184
11217
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11185
11218
  default_credential_manager_acs_system_id?: (string | null) | undefined;
@@ -11599,7 +11632,11 @@ export interface Routes {
11599
11632
  commonParams: {};
11600
11633
  formData: {};
11601
11634
  jsonResponse: {
11602
- /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11635
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
11636
+
11637
+ An `acs_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.
11638
+
11639
+ For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
11603
11640
  acs_user: {
11604
11641
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
11605
11642
  acs_user_id: string;
@@ -11773,7 +11810,11 @@ export interface Routes {
11773
11810
  };
11774
11811
  formData: {};
11775
11812
  jsonResponse: {
11776
- /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11813
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
11814
+
11815
+ An `acs_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.
11816
+
11817
+ For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
11777
11818
  acs_user: {
11778
11819
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
11779
11820
  acs_user_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.369.0",
3
+ "version": "1.369.2",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -104,7 +104,10 @@ export const acs_access_group = common_acs_access_group.extend({
104
104
  route_path: /acs/access_groups
105
105
  ---
106
106
  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.
107
- The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
107
+
108
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/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.
109
+
110
+ 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/overview#access-control-systems).
108
111
  `)
109
112
  export const unmanaged_acs_access_group = common_acs_access_group.extend({
110
113
  is_managed: z.literal(false),
@@ -289,7 +289,11 @@ export const acs_credential = common_acs_credential.merge(
289
289
  ---
290
290
  route_path: /acs/credentials
291
291
  ---
292
- Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
292
+ Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
293
+
294
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
295
+
296
+ For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
293
297
  `)
294
298
 
295
299
  export const unmanaged_acs_credential = common_acs_credential.merge(
@@ -72,7 +72,20 @@ export const acs_encoder = z.object({
72
72
  ---
73
73
  route_path: /acs/encoders
74
74
  ---
75
- 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). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
75
+ 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).
76
+
77
+ Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
78
+
79
+ 1. Credential creation
80
+ Configure the access parameters for the credential.
81
+ 2. Card encoding
82
+ Write the credential data onto the card using a compatible card encoder.
83
+
84
+ Separately, 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.
85
+
86
+ See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
87
+
88
+ 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/overview#access-control-systems).
76
89
  `)
77
90
 
78
91
  export type AcsEncoder = z.infer<typeof acs_encoder>
@@ -86,6 +86,8 @@ export const acs_entrance = z.object({
86
86
  route_path: /acs/entrances
87
87
  ---
88
88
  Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
89
+
90
+ In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the \`acs_entrance\` resources in your workspace or get these details for a specific \`acs_entrance\`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
89
91
  `)
90
92
 
91
93
  export type AcsEntrance = z.infer<typeof acs_entrance>
@@ -339,6 +339,10 @@ export const acs_system = z
339
339
  route_path: /acs/systems
340
340
  ---
341
341
  Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
342
+
343
+ Within an \`acs_system\`, create [\`acs_user\`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [\`acs_credential\`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the \`acs_user\`s.
344
+
345
+ For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).
342
346
  `)
343
347
 
344
348
  export type AcsSystem = z.output<typeof acs_system>
@@ -193,6 +193,8 @@ export type AcsUserUnappliedModificationMap = z.infer<
193
193
  const user_fields = z.object({
194
194
  full_name: z
195
195
  .string()
196
+ .trim()
197
+ .min(1)
196
198
  .optional()
197
199
  .describe(
198
200
  'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
@@ -342,6 +344,10 @@ export const acs_user = common_acs_user.merge(
342
344
  route_path: /acs/users
343
345
  ---
344
346
  Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
347
+
348
+ An \`acs_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.
349
+
350
+ For details about how to configure \`acs_user\`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
345
351
  `)
346
352
 
347
353
  export const unmanaged_acs_user = common_acs_user.merge(
@@ -4,6 +4,7 @@ export const pagination = z
4
4
  .object({
5
5
  next_page_cursor: z
6
6
  .string()
7
+ .base64()
7
8
  .nullable()
8
9
  .describe(
9
10
  'Opaque value that can be used to select the next page of results via the `page_cursor` parameter.',
@@ -1045,7 +1045,7 @@ export default {
1045
1045
  },
1046
1046
  acs_access_group: {
1047
1047
  description:
1048
- '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.\nThe `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1048
+ '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/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/overview#access-control-systems).',
1049
1049
  properties: {
1050
1050
  access_group_type: {
1051
1051
  deprecated: true,
@@ -1156,7 +1156,7 @@ export default {
1156
1156
  },
1157
1157
  acs_credential: {
1158
1158
  description:
1159
- 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
1159
+ 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
1160
1160
  properties: {
1161
1161
  access_method: {
1162
1162
  description:
@@ -1559,7 +1559,7 @@ export default {
1559
1559
  },
1560
1560
  acs_encoder: {
1561
1561
  description:
1562
- '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). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1562
+ '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/overview#access-control-systems).',
1563
1563
  properties: {
1564
1564
  acs_encoder_id: {
1565
1565
  description:
@@ -1633,7 +1633,7 @@ export default {
1633
1633
  },
1634
1634
  acs_entrance: {
1635
1635
  description:
1636
- 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1636
+ 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.',
1637
1637
  properties: {
1638
1638
  acs_entrance_id: {
1639
1639
  description:
@@ -1800,7 +1800,7 @@ export default {
1800
1800
  },
1801
1801
  acs_system: {
1802
1802
  description:
1803
- 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1803
+ 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).',
1804
1804
  properties: {
1805
1805
  acs_system_id: {
1806
1806
  description:
@@ -2214,7 +2214,7 @@ export default {
2214
2214
  },
2215
2215
  acs_user: {
2216
2216
  description:
2217
- 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
2217
+ 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn `acs_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 `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).',
2218
2218
  properties: {
2219
2219
  access_schedule: {
2220
2220
  description:
@@ -2421,6 +2421,7 @@ export default {
2421
2421
  full_name: {
2422
2422
  description:
2423
2423
  'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2424
+ minLength: 1,
2424
2425
  type: 'string',
2425
2426
  },
2426
2427
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -3089,7 +3090,7 @@ export default {
3089
3090
  oneOf: [
3090
3091
  {
3091
3092
  description:
3092
- 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
3093
+ 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
3093
3094
  properties: {
3094
3095
  access_method: {
3095
3096
  description:
@@ -4054,7 +4055,7 @@ export default {
4054
4055
  oneOf: [
4055
4056
  {
4056
4057
  description:
4057
- 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
4058
+ 'Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
4058
4059
  properties: {
4059
4060
  access_method: {
4060
4061
  description:
@@ -14948,6 +14949,7 @@ export default {
14948
14949
  full_name: {
14949
14950
  description:
14950
14951
  'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
14952
+ minLength: 1,
14951
14953
  type: 'string',
14952
14954
  },
14953
14955
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -21028,6 +21030,7 @@ export default {
21028
21030
  full_name: {
21029
21031
  description:
21030
21032
  'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21033
+ minLength: 1,
21031
21034
  type: 'string',
21032
21035
  },
21033
21036
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -21111,6 +21114,7 @@ export default {
21111
21114
  full_name: {
21112
21115
  description:
21113
21116
  'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21117
+ minLength: 1,
21114
21118
  type: 'string',
21115
21119
  },
21116
21120
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -22892,6 +22896,7 @@ export default {
22892
22896
  'x-fern-sdk-group-name': ['devices', 'simulate'],
22893
22897
  'x-fern-sdk-method-name': 'access_code_lock',
22894
22898
  'x-response-key': null,
22899
+ 'x-undocumented': 'Unreleased.',
22895
22900
  },
22896
22901
  },
22897
22902
  '/devices/simulate/access_code_unlock': {
@@ -22937,6 +22942,7 @@ export default {
22937
22942
  'x-fern-sdk-group-name': ['devices', 'simulate'],
22938
22943
  'x-fern-sdk-method-name': 'access_code_unlock',
22939
22944
  'x-response-key': null,
22945
+ 'x-undocumented': 'Unreleased.',
22940
22946
  },
22941
22947
  },
22942
22948
  '/devices/simulate/connect': {
@@ -8191,7 +8191,10 @@ export interface Routes {
8191
8191
  formData: {}
8192
8192
  jsonResponse: {
8193
8193
  /** 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.
8194
- The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
8194
+
8195
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/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.
8196
+
8197
+ 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/overview#access-control-systems). */
8195
8198
  acs_access_group: {
8196
8199
  /** ID of the access group. */
8197
8200
  acs_access_group_id: string
@@ -8782,7 +8785,11 @@ export interface Routes {
8782
8785
  commonParams: {}
8783
8786
  formData: {}
8784
8787
  jsonResponse: {
8785
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
8788
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
8789
+
8790
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
8791
+
8792
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
8786
8793
  acs_credential: {
8787
8794
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
8788
8795
  acs_credential_id: string
@@ -8980,7 +8987,11 @@ export interface Routes {
8980
8987
  }
8981
8988
  formData: {}
8982
8989
  jsonResponse: {
8983
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
8990
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
8991
+
8992
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
8993
+
8994
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
8984
8995
  acs_credential: {
8985
8996
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
8986
8997
  acs_credential_id: string
@@ -9139,7 +9150,11 @@ export interface Routes {
9139
9150
  }
9140
9151
  formData: {}
9141
9152
  jsonResponse: {
9142
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
9153
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
9154
+
9155
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
9156
+
9157
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
9143
9158
  acs_credential: {
9144
9159
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
9145
9160
  acs_credential_id: string
@@ -9302,7 +9317,11 @@ export interface Routes {
9302
9317
  }
9303
9318
  formData: {}
9304
9319
  jsonResponse: {
9305
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
9320
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
9321
+
9322
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
9323
+
9324
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
9306
9325
  acs_credential: {
9307
9326
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
9308
9327
  acs_credential_id: string
@@ -9726,7 +9745,11 @@ export interface Routes {
9726
9745
  commonParams: {}
9727
9746
  formData: {}
9728
9747
  jsonResponse: {
9729
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
9748
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
9749
+
9750
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
9751
+
9752
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
9730
9753
  acs_credential: {
9731
9754
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
9732
9755
  acs_credential_id: string
@@ -10197,7 +10220,11 @@ export interface Routes {
10197
10220
  commonParams: {}
10198
10221
  formData: {}
10199
10222
  jsonResponse: {
10200
- /** Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. */
10223
+ /** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
10224
+
10225
+ An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
10226
+
10227
+ For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
10201
10228
  acs_credential: {
10202
10229
  /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
10203
10230
  acs_credential_id: string
@@ -12748,7 +12775,9 @@ export interface Routes {
12748
12775
  }
12749
12776
  formData: {}
12750
12777
  jsonResponse: {
12751
- /** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
12778
+ /** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
12779
+
12780
+ In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */
12752
12781
  acs_entrance: {
12753
12782
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12754
12783
  acs_system_id: string
@@ -13107,7 +13136,11 @@ export interface Routes {
13107
13136
  }
13108
13137
  formData: {}
13109
13138
  jsonResponse: {
13110
- /** Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13139
+ /** Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
13140
+
13141
+ Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.
13142
+
13143
+ For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs). */
13111
13144
  acs_system: {
13112
13145
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13113
13146
  default_credential_manager_acs_system_id?: (string | null) | undefined
@@ -13661,7 +13694,11 @@ export interface Routes {
13661
13694
  commonParams: {}
13662
13695
  formData: {}
13663
13696
  jsonResponse: {
13664
- /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13697
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
13698
+
13699
+ An `acs_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.
13700
+
13701
+ For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
13665
13702
  acs_user: {
13666
13703
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
13667
13704
  acs_user_id: string
@@ -13868,7 +13905,11 @@ export interface Routes {
13868
13905
  }
13869
13906
  formData: {}
13870
13907
  jsonResponse: {
13871
- /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13908
+ /** Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
13909
+
13910
+ An `acs_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.
13911
+
13912
+ For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
13872
13913
  acs_user: {
13873
13914
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
13874
13915
  acs_user_id: string