@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 CHANGED
@@ -3216,7 +3216,7 @@ var acs_access_group = common_acs_access_group.extend({
3216
3216
 
3217
3217
  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.
3218
3218
 
3219
- 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).
3219
+ 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).
3220
3220
  `);
3221
3221
  var unmanaged_acs_access_group = common_acs_access_group.extend({
3222
3222
  is_managed: zod.z.literal(false)
@@ -3633,7 +3633,7 @@ var acs_encoder = zod.z.object({
3633
3633
 
3634
3634
  See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
3635
3635
 
3636
- 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).
3636
+ 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).
3637
3637
  `);
3638
3638
  var acs_entrance_capability_flags = zod.z.object({
3639
3639
  can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
@@ -4255,7 +4255,7 @@ var acs_user = common_acs_user.merge(
4255
4255
 
4256
4256
  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.
4257
4257
 
4258
- 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/overview#access-control-systems).
4258
+ 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).
4259
4259
  `);
4260
4260
  var unmanaged_acs_user = common_acs_user.merge(
4261
4261
  zod.z.object({
@@ -9533,7 +9533,7 @@ var openapi_default = {
9533
9533
  "x-route-path": "/access_methods"
9534
9534
  },
9535
9535
  acs_access_group: {
9536
- description: "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/overview#access-control-systems).",
9536
+ description: "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).",
9537
9537
  properties: {
9538
9538
  access_group_type: {
9539
9539
  deprecated: true,
@@ -10461,7 +10461,7 @@ var openapi_default = {
10461
10461
  "x-undocumented": "Deprecated. Will be removed."
10462
10462
  },
10463
10463
  acs_encoder: {
10464
- description: "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).",
10464
+ description: "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).",
10465
10465
  properties: {
10466
10466
  acs_encoder_id: {
10467
10467
  description: "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.",
@@ -11218,7 +11218,7 @@ var openapi_default = {
11218
11218
  "x-route-path": "/acs/systems"
11219
11219
  },
11220
11220
  acs_user: {
11221
- description: "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/overview#access-control-systems).",
11221
+ description: "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).",
11222
11222
  properties: {
11223
11223
  access_schedule: {
11224
11224
  description: "`starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
@@ -38118,7 +38118,6 @@ var openapi_default = {
38118
38118
  ],
38119
38119
  summary: "/access_grants/create",
38120
38120
  tags: [],
38121
- "x-draft": "Early access.",
38122
38121
  "x-fern-sdk-group-name": ["access_grants"],
38123
38122
  "x-fern-sdk-method-name": "create",
38124
38123
  "x-fern-sdk-return-value": "access_grant",
@@ -38166,7 +38165,6 @@ var openapi_default = {
38166
38165
  ],
38167
38166
  summary: "/access_grants/delete",
38168
38167
  tags: [],
38169
- "x-draft": "Early access.",
38170
38168
  "x-fern-sdk-group-name": ["access_grants"],
38171
38169
  "x-fern-sdk-method-name": "delete",
38172
38170
  "x-response-key": null,
@@ -38216,7 +38214,6 @@ var openapi_default = {
38216
38214
  ],
38217
38215
  summary: "/access_grants/delete",
38218
38216
  tags: [],
38219
- "x-draft": "Early access.",
38220
38217
  "x-fern-sdk-group-name": ["access_grants"],
38221
38218
  "x-fern-sdk-method-name": "delete",
38222
38219
  "x-response-key": null,
@@ -38254,7 +38251,6 @@ var openapi_default = {
38254
38251
  ],
38255
38252
  summary: "/access_grants/get",
38256
38253
  tags: [],
38257
- "x-draft": "Early access.",
38258
38254
  "x-fern-sdk-group-name": ["access_grants"],
38259
38255
  "x-fern-sdk-method-name": "get",
38260
38256
  "x-fern-sdk-return-value": "access_grant",
@@ -38322,7 +38318,6 @@ var openapi_default = {
38322
38318
  ],
38323
38319
  summary: "/access_grants/get",
38324
38320
  tags: [],
38325
- "x-draft": "Early access.",
38326
38321
  "x-fern-sdk-group-name": ["access_grants"],
38327
38322
  "x-fern-sdk-method-name": "get",
38328
38323
  "x-fern-sdk-return-value": "access_grant",
@@ -38472,7 +38467,6 @@ var openapi_default = {
38472
38467
  "acs_access_groups",
38473
38468
  "access_methods"
38474
38469
  ],
38475
- "x-draft": "Early access.",
38476
38470
  "x-fern-sdk-group-name": ["access_grants"],
38477
38471
  "x-fern-sdk-method-name": "get_related",
38478
38472
  "x-fern-sdk-return-value": "batch",
@@ -38613,7 +38607,6 @@ var openapi_default = {
38613
38607
  "acs_access_groups",
38614
38608
  "access_methods"
38615
38609
  ],
38616
- "x-draft": "Early access.",
38617
38610
  "x-fern-sdk-group-name": ["access_grants"],
38618
38611
  "x-fern-sdk-method-name": "get_related",
38619
38612
  "x-fern-sdk-return-value": "batch",
@@ -38766,7 +38759,6 @@ var openapi_default = {
38766
38759
  ],
38767
38760
  summary: "/access_grants/list",
38768
38761
  tags: [],
38769
- "x-draft": "Early access.",
38770
38762
  "x-fern-sdk-group-name": ["access_grants"],
38771
38763
  "x-fern-sdk-method-name": "list",
38772
38764
  "x-fern-sdk-return-value": "access_grants",
@@ -38878,7 +38870,6 @@ var openapi_default = {
38878
38870
  ],
38879
38871
  summary: "/access_grants/list",
38880
38872
  tags: [],
38881
- "x-draft": "Early access.",
38882
38873
  "x-fern-sdk-group-name": ["access_grants"],
38883
38874
  "x-fern-sdk-method-name": "list",
38884
38875
  "x-fern-sdk-return-value": "access_grants",
@@ -38962,7 +38953,6 @@ var openapi_default = {
38962
38953
  ],
38963
38954
  summary: "/access_grants/request_access_methods",
38964
38955
  tags: [],
38965
- "x-draft": "Early access.",
38966
38956
  "x-fern-sdk-group-name": ["access_grants"],
38967
38957
  "x-fern-sdk-method-name": "request_access_methods",
38968
38958
  "x-fern-sdk-return-value": "access_grant",
@@ -39541,7 +39531,6 @@ var openapi_default = {
39541
39531
  ],
39542
39532
  summary: "/access_grants/unmanaged/get",
39543
39533
  tags: [],
39544
- "x-draft": "Early access.",
39545
39534
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
39546
39535
  "x-fern-sdk-method-name": "get",
39547
39536
  "x-fern-sdk-return-value": "access_grant",
@@ -40123,7 +40112,6 @@ var openapi_default = {
40123
40112
  ],
40124
40113
  summary: "/access_grants/unmanaged/get",
40125
40114
  tags: [],
40126
- "x-draft": "Early access.",
40127
40115
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
40128
40116
  "x-fern-sdk-method-name": "get",
40129
40117
  "x-fern-sdk-return-value": "access_grant",
@@ -40750,7 +40738,6 @@ var openapi_default = {
40750
40738
  ],
40751
40739
  summary: "/access_grants/unmanaged/list",
40752
40740
  tags: [],
40753
- "x-draft": "Early access.",
40754
40741
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
40755
40742
  "x-fern-sdk-method-name": "list",
40756
40743
  "x-fern-sdk-return-value": "access_grants",
@@ -41360,7 +41347,6 @@ var openapi_default = {
41360
41347
  ],
41361
41348
  summary: "/access_grants/unmanaged/list",
41362
41349
  tags: [],
41363
- "x-draft": "Early access.",
41364
41350
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
41365
41351
  "x-fern-sdk-method-name": "list",
41366
41352
  "x-fern-sdk-return-value": "access_grants",
@@ -41422,7 +41408,6 @@ var openapi_default = {
41422
41408
  ],
41423
41409
  summary: "/access_grants/unmanaged/update",
41424
41410
  tags: [],
41425
- "x-draft": "Early access.",
41426
41411
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
41427
41412
  "x-fern-sdk-method-name": "update",
41428
41413
  "x-response-key": null,
@@ -41481,7 +41466,6 @@ var openapi_default = {
41481
41466
  ],
41482
41467
  summary: "/access_grants/unmanaged/update",
41483
41468
  tags: [],
41484
- "x-draft": "Early access.",
41485
41469
  "x-fern-sdk-group-name": ["access_grants", "unmanaged"],
41486
41470
  "x-fern-sdk-method-name": "update",
41487
41471
  "x-response-key": null,
@@ -41549,7 +41533,6 @@ var openapi_default = {
41549
41533
  ],
41550
41534
  summary: "/access_grants/update",
41551
41535
  tags: [],
41552
- "x-draft": "Early access.",
41553
41536
  "x-fern-sdk-group-name": ["access_grants"],
41554
41537
  "x-fern-sdk-method-name": "update",
41555
41538
  "x-response-key": null,
@@ -41615,7 +41598,6 @@ var openapi_default = {
41615
41598
  ],
41616
41599
  summary: "/access_grants/update",
41617
41600
  tags: [],
41618
- "x-draft": "Early access.",
41619
41601
  "x-fern-sdk-group-name": ["access_grants"],
41620
41602
  "x-fern-sdk-method-name": "update",
41621
41603
  "x-response-key": null,
@@ -45409,7 +45391,7 @@ var openapi_default = {
45409
45391
  type: "object"
45410
45392
  },
45411
45393
  code: {
45412
- description: "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/overview).",
45394
+ description: "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).",
45413
45395
  pattern: "^\\d+$",
45414
45396
  type: "string"
45415
45397
  },