@seamapi/types 1.802.0 → 1.803.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.
@@ -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/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).',
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/overview#access-control-systems).',
3070
3070
  properties: {
3071
3071
  access_group_type: {
3072
3072
  deprecated: true,
@@ -3139,7 +3139,7 @@ export default {
3139
3139
  oneOf: [
3140
3140
  {
3141
3141
  description:
3142
- 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
3142
+ 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
3143
3143
  properties: {
3144
3144
  created_at: {
3145
3145
  description:
@@ -4643,7 +4643,7 @@ export default {
4643
4643
  },
4644
4644
  {
4645
4645
  description:
4646
- 'Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
4646
+ 'Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
4647
4647
  properties: {
4648
4648
  created_at: {
4649
4649
  description:
@@ -4718,7 +4718,7 @@ export default {
4718
4718
  },
4719
4719
  {
4720
4720
  description:
4721
- 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.',
4721
+ 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to restore access.',
4722
4722
  properties: {
4723
4723
  created_at: {
4724
4724
  description:
@@ -17860,7 +17860,7 @@ export default {
17860
17860
  },
17861
17861
  acs_entrance_id: {
17862
17862
  description:
17863
- 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
17863
+ 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
17864
17864
  format: 'uuid',
17865
17865
  type: 'string',
17866
17866
  },
@@ -17913,7 +17913,7 @@ export default {
17913
17913
  },
17914
17914
  acs_entrance_id: {
17915
17915
  description:
17916
- 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
17916
+ 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
17917
17917
  format: 'uuid',
17918
17918
  type: 'string',
17919
17919
  },
@@ -19159,7 +19159,7 @@ export default {
19159
19159
  },
19160
19160
  {
19161
19161
  description:
19162
- 'An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.',
19162
+ 'An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.',
19163
19163
  properties: {
19164
19164
  acs_entrance_id: { format: 'uuid', type: 'string' },
19165
19165
  acs_system_id: {
@@ -19209,7 +19209,7 @@ export default {
19209
19209
  },
19210
19210
  {
19211
19211
  description:
19212
- 'An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.',
19212
+ 'An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.',
19213
19213
  properties: {
19214
19214
  acs_entrance_id: { format: 'uuid', type: 'string' },
19215
19215
  acs_system_id: {
@@ -19431,7 +19431,7 @@ export default {
19431
19431
  {
19432
19432
  deprecated: true,
19433
19433
  description:
19434
- 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
19434
+ 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
19435
19435
  properties: {
19436
19436
  connect_webview_id: {
19437
19437
  description:
@@ -20410,11 +20410,11 @@ export default {
20410
20410
  },
20411
20411
  {
20412
20412
  description:
20413
- 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.',
20413
+ 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.',
20414
20414
  properties: {
20415
20415
  connect_webview_id: {
20416
20416
  description:
20417
- 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
20417
+ 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
20418
20418
  format: 'uuid',
20419
20419
  type: 'string',
20420
20420
  },
@@ -20477,11 +20477,11 @@ export default {
20477
20477
  },
20478
20478
  {
20479
20479
  description:
20480
- 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.',
20480
+ 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.',
20481
20481
  properties: {
20482
20482
  connect_webview_id: {
20483
20483
  description:
20484
- 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
20484
+ 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
20485
20485
  format: 'uuid',
20486
20486
  type: 'string',
20487
20487
  },
@@ -27911,7 +27911,7 @@ export default {
27911
27911
  oneOf: [
27912
27912
  {
27913
27913
  description:
27914
- 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
27914
+ 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
27915
27915
  properties: {
27916
27916
  created_at: {
27917
27917
  description:
@@ -31635,7 +31635,7 @@ export default {
31635
31635
  },
31636
31636
  use_backup_access_code_pool: {
31637
31637
  description:
31638
- 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
31638
+ 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
31639
31639
  type: 'boolean',
31640
31640
  },
31641
31641
  use_offline_access_code: {
@@ -34062,7 +34062,7 @@ export default {
34062
34062
  },
34063
34063
  use_backup_access_code_pool: {
34064
34064
  description:
34065
- 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34065
+ 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34066
34066
  type: 'boolean',
34067
34067
  },
34068
34068
  use_offline_access_code: {
@@ -34216,7 +34216,7 @@ export default {
34216
34216
  },
34217
34217
  use_backup_access_code_pool: {
34218
34218
  description:
34219
- 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34219
+ 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34220
34220
  type: 'boolean',
34221
34221
  },
34222
34222
  use_offline_access_code: {
@@ -34370,7 +34370,7 @@ export default {
34370
34370
  },
34371
34371
  use_backup_access_code_pool: {
34372
34372
  description:
34373
- 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34373
+ 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
34374
34374
  type: 'boolean',
34375
34375
  },
34376
34376
  use_offline_access_code: {
@@ -41239,7 +41239,7 @@ export default {
41239
41239
  '/acs/access_groups/add_user': {
41240
41240
  post: {
41241
41241
  description:
41242
- 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41242
+ 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41243
41243
  operationId: 'acsAccessGroupsAddUserPost',
41244
41244
  requestBody: {
41245
41245
  content: {
@@ -41301,7 +41301,7 @@ export default {
41301
41301
  },
41302
41302
  put: {
41303
41303
  description:
41304
- 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41304
+ 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41305
41305
  operationId: 'acsAccessGroupsAddUserPut',
41306
41306
  requestBody: {
41307
41307
  content: {
@@ -41365,7 +41365,7 @@ export default {
41365
41365
  '/acs/access_groups/delete': {
41366
41366
  delete: {
41367
41367
  description:
41368
- 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41368
+ 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41369
41369
  operationId: 'acsAccessGroupsDeleteDelete',
41370
41370
  parameters: [
41371
41371
  {
@@ -41410,7 +41410,7 @@ export default {
41410
41410
  },
41411
41411
  post: {
41412
41412
  description:
41413
- 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41413
+ 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41414
41414
  operationId: 'acsAccessGroupsDeletePost',
41415
41415
  requestBody: {
41416
41416
  content: {
@@ -41463,7 +41463,7 @@ export default {
41463
41463
  '/acs/access_groups/get': {
41464
41464
  get: {
41465
41465
  description:
41466
- 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41466
+ 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41467
41467
  operationId: 'acsAccessGroupsGetGet',
41468
41468
  parameters: [
41469
41469
  {
@@ -41513,7 +41513,7 @@ export default {
41513
41513
  },
41514
41514
  post: {
41515
41515
  description:
41516
- 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41516
+ 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41517
41517
  operationId: 'acsAccessGroupsGetPost',
41518
41518
  requestBody: {
41519
41519
  content: {
@@ -41570,7 +41570,7 @@ export default {
41570
41570
  '/acs/access_groups/list': {
41571
41571
  get: {
41572
41572
  description:
41573
- 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41573
+ 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41574
41574
  operationId: 'acsAccessGroupsListGet',
41575
41575
  parameters: [
41576
41576
  {
@@ -41651,7 +41651,7 @@ export default {
41651
41651
  },
41652
41652
  post: {
41653
41653
  description:
41654
- 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41654
+ 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41655
41655
  operationId: 'acsAccessGroupsListPost',
41656
41656
  requestBody: {
41657
41657
  content: {
@@ -41727,7 +41727,7 @@ export default {
41727
41727
  '/acs/access_groups/list_accessible_entrances': {
41728
41728
  get: {
41729
41729
  description:
41730
- 'Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41730
+ 'Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41731
41731
  operationId: 'acsAccessGroupsListAccessibleEntrancesGet',
41732
41732
  parameters: [
41733
41733
  {
@@ -41779,7 +41779,7 @@ export default {
41779
41779
  },
41780
41780
  post: {
41781
41781
  description:
41782
- 'Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41782
+ 'Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41783
41783
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
41784
41784
  requestBody: {
41785
41785
  content: {
@@ -41838,7 +41838,7 @@ export default {
41838
41838
  '/acs/access_groups/list_users': {
41839
41839
  get: {
41840
41840
  description:
41841
- 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41841
+ 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41842
41842
  operationId: 'acsAccessGroupsListUsersGet',
41843
41843
  parameters: [
41844
41844
  {
@@ -41890,7 +41890,7 @@ export default {
41890
41890
  },
41891
41891
  post: {
41892
41892
  description:
41893
- 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41893
+ 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41894
41894
  operationId: 'acsAccessGroupsListUsersPost',
41895
41895
  requestBody: {
41896
41896
  content: {
@@ -41949,7 +41949,7 @@ export default {
41949
41949
  '/acs/access_groups/remove_user': {
41950
41950
  delete: {
41951
41951
  description:
41952
- 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
41952
+ 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
41953
41953
  operationId: 'acsAccessGroupsRemoveUserDelete',
41954
41954
  parameters: [
41955
41955
  {
@@ -42016,7 +42016,7 @@ export default {
42016
42016
  },
42017
42017
  post: {
42018
42018
  description:
42019
- 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
42019
+ 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
42020
42020
  operationId: 'acsAccessGroupsRemoveUserPost',
42021
42021
  requestBody: {
42022
42022
  content: {
@@ -42080,7 +42080,7 @@ export default {
42080
42080
  '/acs/access_groups/unmanaged/get': {
42081
42081
  get: {
42082
42082
  description:
42083
- 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
42083
+ 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
42084
42084
  operationId: 'acsAccessGroupsUnmanagedGetGet',
42085
42085
  parameters: [
42086
42086
  {
@@ -42133,7 +42133,7 @@ export default {
42133
42133
  },
42134
42134
  post: {
42135
42135
  description:
42136
- 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
42136
+ 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
42137
42137
  operationId: 'acsAccessGroupsUnmanagedGetPost',
42138
42138
  requestBody: {
42139
42139
  content: {
@@ -42193,7 +42193,7 @@ export default {
42193
42193
  '/acs/access_groups/unmanaged/list': {
42194
42194
  get: {
42195
42195
  description:
42196
- 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
42196
+ 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
42197
42197
  operationId: 'acsAccessGroupsUnmanagedListGet',
42198
42198
  parameters: [
42199
42199
  {
@@ -42268,7 +42268,7 @@ export default {
42268
42268
  },
42269
42269
  post: {
42270
42270
  description:
42271
- 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
42271
+ 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
42272
42272
  operationId: 'acsAccessGroupsUnmanagedListPost',
42273
42273
  requestBody: {
42274
42274
  content: {
@@ -45840,7 +45840,7 @@ export default {
45840
45840
  '/acs/users/add_to_access_group': {
45841
45841
  post: {
45842
45842
  description:
45843
- 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
45843
+ 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
45844
45844
  operationId: 'acsUsersAddToAccessGroupPost',
45845
45845
  requestBody: {
45846
45846
  content: {
@@ -45896,7 +45896,7 @@ export default {
45896
45896
  },
45897
45897
  put: {
45898
45898
  description:
45899
- 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
45899
+ 'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
45900
45900
  operationId: 'acsUsersAddToAccessGroupPut',
45901
45901
  requestBody: {
45902
45902
  content: {
@@ -46693,7 +46693,7 @@ export default {
46693
46693
  '/acs/users/remove_from_access_group': {
46694
46694
  delete: {
46695
46695
  description:
46696
- 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
46696
+ 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
46697
46697
  operationId: 'acsUsersRemoveFromAccessGroupDelete',
46698
46698
  parameters: [
46699
46699
  {
@@ -46760,7 +46760,7 @@ export default {
46760
46760
  },
46761
46761
  post: {
46762
46762
  description:
46763
- 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
46763
+ 'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
46764
46764
  operationId: 'acsUsersRemoveFromAccessGroupPost',
46765
46765
  requestBody: {
46766
46766
  content: {
@@ -57824,7 +57824,7 @@ export default {
57824
57824
  '/instant_keys/get': {
57825
57825
  get: {
57826
57826
  description:
57827
- 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
57827
+ 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
57828
57828
  operationId: 'instantKeysGetGet',
57829
57829
  parameters: [
57830
57830
  {
@@ -57880,7 +57880,7 @@ export default {
57880
57880
  },
57881
57881
  post: {
57882
57882
  description:
57883
- 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
57883
+ 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
57884
57884
  operationId: 'instantKeysGetPost',
57885
57885
  requestBody: {
57886
57886
  content: {
@@ -57939,7 +57939,7 @@ export default {
57939
57939
  '/instant_keys/list': {
57940
57940
  get: {
57941
57941
  description:
57942
- 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
57942
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
57943
57943
  operationId: 'instantKeysListGet',
57944
57944
  parameters: [
57945
57945
  {
@@ -57990,7 +57990,7 @@ export default {
57990
57990
  },
57991
57991
  post: {
57992
57992
  description:
57993
- 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
57993
+ 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
57994
57994
  operationId: 'instantKeysListPost',
57995
57995
  requestBody: {
57996
57996
  content: {
@@ -78683,7 +78683,7 @@ export default {
78683
78683
  '/user_identities/delete': {
78684
78684
  delete: {
78685
78685
  description:
78686
- 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
78686
+ 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
78687
78687
  operationId: 'userIdentitiesDeleteDelete',
78688
78688
  parameters: [
78689
78689
  {
@@ -78727,7 +78727,7 @@ export default {
78727
78727
  },
78728
78728
  post: {
78729
78729
  description:
78730
- 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
78730
+ 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/acs/credentials), [acs users](https://docs.seam.co/latest/api/acs/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
78731
78731
  operationId: 'userIdentitiesDeletePost',
78732
78732
  requestBody: {
78733
78733
  content: {
@@ -79195,7 +79195,7 @@ export default {
79195
79195
  '/user_identities/generate_instant_key': {
79196
79196
  post: {
79197
79197
  description:
79198
- 'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
79198
+ 'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
79199
79199
  operationId: 'userIdentitiesGenerateInstantKeyPost',
79200
79200
  requestBody: {
79201
79201
  content: {
@@ -27,7 +27,7 @@ export type Routes = {
27
27
  common_code_key?: string | undefined
28
28
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
29
29
  prefer_native_scheduling?: boolean | undefined
30
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
30
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
31
31
  use_backup_access_code_pool?: boolean | undefined
32
32
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
33
33
  allow_external_modification?: boolean | undefined
@@ -10751,7 +10751,7 @@ export type Routes = {
10751
10751
  attempt_for_offline_device?: boolean
10752
10752
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
10753
10753
  prefer_native_scheduling?: boolean | undefined
10754
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
10754
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
10755
10755
  use_backup_access_code_pool?: boolean | undefined
10756
10756
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
10757
10757
  allow_external_modification?: boolean | undefined
@@ -20849,7 +20849,7 @@ export type Routes = {
20849
20849
  jsonResponse: {
20850
20850
  /** 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.
20851
20851
 
20852
- 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.
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
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/overview#access-control-systems). */
20855
20855
  acs_access_group: {
@@ -44184,7 +44184,7 @@ export type Routes = {
44184
44184
  /** ID of the affected Access Grant. */
44185
44185
  access_grant_id: string
44186
44186
  event_type: 'access_grant.access_granted_to_door'
44187
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
44187
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
44188
44188
  acs_entrance_id: string
44189
44189
  }
44190
44190
  | {
@@ -44199,7 +44199,7 @@ export type Routes = {
44199
44199
  /** ID of the affected Access Grant. */
44200
44200
  access_grant_id: string
44201
44201
  event_type: 'access_grant.access_to_door_lost'
44202
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
44202
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
44203
44203
  acs_entrance_id: string
44204
44204
  }
44205
44205
  | {
@@ -45000,7 +45000,7 @@ export type Routes = {
45000
45000
  created_at: string
45001
45001
  /** Date and time at which the event occurred. */
45002
45002
  occurred_at: string
45003
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
45003
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
45004
45004
  connect_webview_id: string
45005
45005
  event_type: 'connect_webview.login_succeeded'
45006
45006
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -45023,7 +45023,7 @@ export type Routes = {
45023
45023
  created_at: string
45024
45024
  /** Date and time at which the event occurred. */
45025
45025
  occurred_at: string
45026
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
45026
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
45027
45027
  connect_webview_id: string
45028
45028
  event_type: 'connect_webview.login_failed'
45029
45029
  }
@@ -47586,7 +47586,7 @@ export type Routes = {
47586
47586
  /** ID of the affected Access Grant. */
47587
47587
  access_grant_id: string
47588
47588
  event_type: 'access_grant.access_granted_to_door'
47589
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
47589
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
47590
47590
  acs_entrance_id: string
47591
47591
  }
47592
47592
  | {
@@ -47601,7 +47601,7 @@ export type Routes = {
47601
47601
  /** ID of the affected Access Grant. */
47602
47602
  access_grant_id: string
47603
47603
  event_type: 'access_grant.access_to_door_lost'
47604
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
47604
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
47605
47605
  acs_entrance_id: string
47606
47606
  }
47607
47607
  | {
@@ -48402,7 +48402,7 @@ export type Routes = {
48402
48402
  created_at: string
48403
48403
  /** Date and time at which the event occurred. */
48404
48404
  occurred_at: string
48405
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
48405
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
48406
48406
  connect_webview_id: string
48407
48407
  event_type: 'connect_webview.login_succeeded'
48408
48408
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -48425,7 +48425,7 @@ export type Routes = {
48425
48425
  created_at: string
48426
48426
  /** Date and time at which the event occurred. */
48427
48427
  occurred_at: string
48428
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
48428
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
48429
48429
  connect_webview_id: string
48430
48430
  event_type: 'connect_webview.login_failed'
48431
48431
  }
@@ -77515,7 +77515,7 @@ export type Routes = {
77515
77515
  /** ID of the affected Access Grant. */
77516
77516
  access_grant_id: string
77517
77517
  event_type: 'access_grant.access_granted_to_door'
77518
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
77518
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
77519
77519
  acs_entrance_id: string
77520
77520
  }
77521
77521
  | {
@@ -77530,7 +77530,7 @@ export type Routes = {
77530
77530
  /** ID of the affected Access Grant. */
77531
77531
  access_grant_id: string
77532
77532
  event_type: 'access_grant.access_to_door_lost'
77533
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
77533
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
77534
77534
  acs_entrance_id: string
77535
77535
  }
77536
77536
  | {
@@ -78331,7 +78331,7 @@ export type Routes = {
78331
78331
  created_at: string
78332
78332
  /** Date and time at which the event occurred. */
78333
78333
  occurred_at: string
78334
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
78334
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
78335
78335
  connect_webview_id: string
78336
78336
  event_type: 'connect_webview.login_succeeded'
78337
78337
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -78354,7 +78354,7 @@ export type Routes = {
78354
78354
  created_at: string
78355
78355
  /** Date and time at which the event occurred. */
78356
78356
  occurred_at: string
78357
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
78357
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
78358
78358
  connect_webview_id: string
78359
78359
  event_type: 'connect_webview.login_failed'
78360
78360
  }
@@ -115633,7 +115633,7 @@ export type Routes = {
115633
115633
  /** ID of the affected Access Grant. */
115634
115634
  access_grant_id: string
115635
115635
  event_type: 'access_grant.access_granted_to_door'
115636
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
115636
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
115637
115637
  acs_entrance_id: string
115638
115638
  }
115639
115639
  | {
@@ -115648,7 +115648,7 @@ export type Routes = {
115648
115648
  /** ID of the affected Access Grant. */
115649
115649
  access_grant_id: string
115650
115650
  event_type: 'access_grant.access_to_door_lost'
115651
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
115651
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
115652
115652
  acs_entrance_id: string
115653
115653
  }
115654
115654
  | {
@@ -116449,7 +116449,7 @@ export type Routes = {
116449
116449
  created_at: string
116450
116450
  /** Date and time at which the event occurred. */
116451
116451
  occurred_at: string
116452
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
116452
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
116453
116453
  connect_webview_id: string
116454
116454
  event_type: 'connect_webview.login_succeeded'
116455
116455
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -116472,7 +116472,7 @@ export type Routes = {
116472
116472
  created_at: string
116473
116473
  /** Date and time at which the event occurred. */
116474
116474
  occurred_at: string
116475
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
116475
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
116476
116476
  connect_webview_id: string
116477
116477
  event_type: 'connect_webview.login_failed'
116478
116478
  }