@seamapi/types 1.801.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.
- package/dist/connect.cjs +107 -58
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +209 -19
- package/dist/index.cjs +107 -58
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +58 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +9 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +21 -0
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +2 -2
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +58 -0
- package/lib/seam/connect/models/events/access-grants.js +1 -1
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/acs/entrances.js +2 -2
- package/lib/seam/connect/models/events/connect-webviews.js +3 -3
- package/lib/seam/connect/models/events/connected-accounts.js +1 -1
- package/lib/seam/connect/openapi.js +89 -47
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +96 -19
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +14 -0
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
- package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
- package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
- package/src/lib/seam/connect/models/events/connect-webviews.ts +3 -3
- package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
- package/src/lib/seam/connect/openapi.ts +97 -47
- package/src/lib/seam/connect/route-types.ts +107 -19
|
@@ -1753,6 +1753,31 @@ export default {
|
|
|
1753
1753
|
required: ['message', 'warning_code'],
|
|
1754
1754
|
type: 'object',
|
|
1755
1755
|
},
|
|
1756
|
+
{
|
|
1757
|
+
description:
|
|
1758
|
+
"The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
1759
|
+
properties: {
|
|
1760
|
+
created_at: {
|
|
1761
|
+
description:
|
|
1762
|
+
'Date and time at which Seam created the warning.',
|
|
1763
|
+
format: 'date-time',
|
|
1764
|
+
type: 'string',
|
|
1765
|
+
},
|
|
1766
|
+
message: {
|
|
1767
|
+
description:
|
|
1768
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1769
|
+
type: 'string',
|
|
1770
|
+
},
|
|
1771
|
+
warning_code: {
|
|
1772
|
+
description:
|
|
1773
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1774
|
+
enum: ['schlage_access_code_ambiguous_timezone_dst_risk'],
|
|
1775
|
+
type: 'string',
|
|
1776
|
+
},
|
|
1777
|
+
},
|
|
1778
|
+
required: ['message', 'warning_code'],
|
|
1779
|
+
type: 'object',
|
|
1780
|
+
},
|
|
1756
1781
|
{
|
|
1757
1782
|
description:
|
|
1758
1783
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
@@ -3041,7 +3066,7 @@ export default {
|
|
|
3041
3066
|
},
|
|
3042
3067
|
acs_access_group: {
|
|
3043
3068
|
description:
|
|
3044
|
-
'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).',
|
|
3045
3070
|
properties: {
|
|
3046
3071
|
access_group_type: {
|
|
3047
3072
|
deprecated: true,
|
|
@@ -3114,7 +3139,7 @@ export default {
|
|
|
3114
3139
|
oneOf: [
|
|
3115
3140
|
{
|
|
3116
3141
|
description:
|
|
3117
|
-
'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).',
|
|
3118
3143
|
properties: {
|
|
3119
3144
|
created_at: {
|
|
3120
3145
|
description:
|
|
@@ -4618,7 +4643,7 @@ export default {
|
|
|
4618
4643
|
},
|
|
4619
4644
|
{
|
|
4620
4645
|
description:
|
|
4621
|
-
'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/
|
|
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).',
|
|
4622
4647
|
properties: {
|
|
4623
4648
|
created_at: {
|
|
4624
4649
|
description:
|
|
@@ -4693,7 +4718,7 @@ export default {
|
|
|
4693
4718
|
},
|
|
4694
4719
|
{
|
|
4695
4720
|
description:
|
|
4696
|
-
'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
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.',
|
|
4697
4722
|
properties: {
|
|
4698
4723
|
created_at: {
|
|
4699
4724
|
description:
|
|
@@ -17835,7 +17860,7 @@ export default {
|
|
|
17835
17860
|
},
|
|
17836
17861
|
acs_entrance_id: {
|
|
17837
17862
|
description:
|
|
17838
|
-
'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).',
|
|
17839
17864
|
format: 'uuid',
|
|
17840
17865
|
type: 'string',
|
|
17841
17866
|
},
|
|
@@ -17888,7 +17913,7 @@ export default {
|
|
|
17888
17913
|
},
|
|
17889
17914
|
acs_entrance_id: {
|
|
17890
17915
|
description:
|
|
17891
|
-
'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).',
|
|
17892
17917
|
format: 'uuid',
|
|
17893
17918
|
type: 'string',
|
|
17894
17919
|
},
|
|
@@ -19134,7 +19159,7 @@ export default {
|
|
|
19134
19159
|
},
|
|
19135
19160
|
{
|
|
19136
19161
|
description:
|
|
19137
|
-
'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.',
|
|
19138
19163
|
properties: {
|
|
19139
19164
|
acs_entrance_id: { format: 'uuid', type: 'string' },
|
|
19140
19165
|
acs_system_id: {
|
|
@@ -19184,7 +19209,7 @@ export default {
|
|
|
19184
19209
|
},
|
|
19185
19210
|
{
|
|
19186
19211
|
description:
|
|
19187
|
-
'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.',
|
|
19188
19213
|
properties: {
|
|
19189
19214
|
acs_entrance_id: { format: 'uuid', type: 'string' },
|
|
19190
19215
|
acs_system_id: {
|
|
@@ -19406,7 +19431,7 @@ export default {
|
|
|
19406
19431
|
{
|
|
19407
19432
|
deprecated: true,
|
|
19408
19433
|
description:
|
|
19409
|
-
'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/
|
|
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).',
|
|
19410
19435
|
properties: {
|
|
19411
19436
|
connect_webview_id: {
|
|
19412
19437
|
description:
|
|
@@ -20385,11 +20410,11 @@ export default {
|
|
|
20385
20410
|
},
|
|
20386
20411
|
{
|
|
20387
20412
|
description:
|
|
20388
|
-
'A [Connect Webview](https://docs.seam.co/latest/
|
|
20413
|
+
'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.',
|
|
20389
20414
|
properties: {
|
|
20390
20415
|
connect_webview_id: {
|
|
20391
20416
|
description:
|
|
20392
|
-
'ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
20417
|
+
'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
20393
20418
|
format: 'uuid',
|
|
20394
20419
|
type: 'string',
|
|
20395
20420
|
},
|
|
@@ -20452,11 +20477,11 @@ export default {
|
|
|
20452
20477
|
},
|
|
20453
20478
|
{
|
|
20454
20479
|
description:
|
|
20455
|
-
'A [Connect Webview](https://docs.seam.co/latest/
|
|
20480
|
+
'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.',
|
|
20456
20481
|
properties: {
|
|
20457
20482
|
connect_webview_id: {
|
|
20458
20483
|
description:
|
|
20459
|
-
'ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
20484
|
+
'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
20460
20485
|
format: 'uuid',
|
|
20461
20486
|
type: 'string',
|
|
20462
20487
|
},
|
|
@@ -27457,6 +27482,31 @@ export default {
|
|
|
27457
27482
|
required: ['message', 'warning_code'],
|
|
27458
27483
|
type: 'object',
|
|
27459
27484
|
},
|
|
27485
|
+
{
|
|
27486
|
+
description:
|
|
27487
|
+
"The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
|
|
27488
|
+
properties: {
|
|
27489
|
+
created_at: {
|
|
27490
|
+
description:
|
|
27491
|
+
'Date and time at which Seam created the warning.',
|
|
27492
|
+
format: 'date-time',
|
|
27493
|
+
type: 'string',
|
|
27494
|
+
},
|
|
27495
|
+
message: {
|
|
27496
|
+
description:
|
|
27497
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
27498
|
+
type: 'string',
|
|
27499
|
+
},
|
|
27500
|
+
warning_code: {
|
|
27501
|
+
description:
|
|
27502
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
27503
|
+
enum: ['schlage_access_code_ambiguous_timezone_dst_risk'],
|
|
27504
|
+
type: 'string',
|
|
27505
|
+
},
|
|
27506
|
+
},
|
|
27507
|
+
required: ['message', 'warning_code'],
|
|
27508
|
+
type: 'object',
|
|
27509
|
+
},
|
|
27460
27510
|
{
|
|
27461
27511
|
description:
|
|
27462
27512
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
@@ -27861,7 +27911,7 @@ export default {
|
|
|
27861
27911
|
oneOf: [
|
|
27862
27912
|
{
|
|
27863
27913
|
description:
|
|
27864
|
-
'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).',
|
|
27865
27915
|
properties: {
|
|
27866
27916
|
created_at: {
|
|
27867
27917
|
description:
|
|
@@ -31585,7 +31635,7 @@ export default {
|
|
|
31585
31635
|
},
|
|
31586
31636
|
use_backup_access_code_pool: {
|
|
31587
31637
|
description:
|
|
31588
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
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).',
|
|
31589
31639
|
type: 'boolean',
|
|
31590
31640
|
},
|
|
31591
31641
|
use_offline_access_code: {
|
|
@@ -34012,7 +34062,7 @@ export default {
|
|
|
34012
34062
|
},
|
|
34013
34063
|
use_backup_access_code_pool: {
|
|
34014
34064
|
description:
|
|
34015
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
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).',
|
|
34016
34066
|
type: 'boolean',
|
|
34017
34067
|
},
|
|
34018
34068
|
use_offline_access_code: {
|
|
@@ -34166,7 +34216,7 @@ export default {
|
|
|
34166
34216
|
},
|
|
34167
34217
|
use_backup_access_code_pool: {
|
|
34168
34218
|
description:
|
|
34169
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
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).',
|
|
34170
34220
|
type: 'boolean',
|
|
34171
34221
|
},
|
|
34172
34222
|
use_offline_access_code: {
|
|
@@ -34320,7 +34370,7 @@ export default {
|
|
|
34320
34370
|
},
|
|
34321
34371
|
use_backup_access_code_pool: {
|
|
34322
34372
|
description:
|
|
34323
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
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).',
|
|
34324
34374
|
type: 'boolean',
|
|
34325
34375
|
},
|
|
34326
34376
|
use_offline_access_code: {
|
|
@@ -41189,7 +41239,7 @@ export default {
|
|
|
41189
41239
|
'/acs/access_groups/add_user': {
|
|
41190
41240
|
post: {
|
|
41191
41241
|
description:
|
|
41192
|
-
'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).',
|
|
41193
41243
|
operationId: 'acsAccessGroupsAddUserPost',
|
|
41194
41244
|
requestBody: {
|
|
41195
41245
|
content: {
|
|
@@ -41251,7 +41301,7 @@ export default {
|
|
|
41251
41301
|
},
|
|
41252
41302
|
put: {
|
|
41253
41303
|
description:
|
|
41254
|
-
'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).',
|
|
41255
41305
|
operationId: 'acsAccessGroupsAddUserPut',
|
|
41256
41306
|
requestBody: {
|
|
41257
41307
|
content: {
|
|
@@ -41315,7 +41365,7 @@ export default {
|
|
|
41315
41365
|
'/acs/access_groups/delete': {
|
|
41316
41366
|
delete: {
|
|
41317
41367
|
description:
|
|
41318
|
-
'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).',
|
|
41319
41369
|
operationId: 'acsAccessGroupsDeleteDelete',
|
|
41320
41370
|
parameters: [
|
|
41321
41371
|
{
|
|
@@ -41360,7 +41410,7 @@ export default {
|
|
|
41360
41410
|
},
|
|
41361
41411
|
post: {
|
|
41362
41412
|
description:
|
|
41363
|
-
'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).',
|
|
41364
41414
|
operationId: 'acsAccessGroupsDeletePost',
|
|
41365
41415
|
requestBody: {
|
|
41366
41416
|
content: {
|
|
@@ -41413,7 +41463,7 @@ export default {
|
|
|
41413
41463
|
'/acs/access_groups/get': {
|
|
41414
41464
|
get: {
|
|
41415
41465
|
description:
|
|
41416
|
-
'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).',
|
|
41417
41467
|
operationId: 'acsAccessGroupsGetGet',
|
|
41418
41468
|
parameters: [
|
|
41419
41469
|
{
|
|
@@ -41463,7 +41513,7 @@ export default {
|
|
|
41463
41513
|
},
|
|
41464
41514
|
post: {
|
|
41465
41515
|
description:
|
|
41466
|
-
'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).',
|
|
41467
41517
|
operationId: 'acsAccessGroupsGetPost',
|
|
41468
41518
|
requestBody: {
|
|
41469
41519
|
content: {
|
|
@@ -41520,7 +41570,7 @@ export default {
|
|
|
41520
41570
|
'/acs/access_groups/list': {
|
|
41521
41571
|
get: {
|
|
41522
41572
|
description:
|
|
41523
|
-
'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).',
|
|
41524
41574
|
operationId: 'acsAccessGroupsListGet',
|
|
41525
41575
|
parameters: [
|
|
41526
41576
|
{
|
|
@@ -41601,7 +41651,7 @@ export default {
|
|
|
41601
41651
|
},
|
|
41602
41652
|
post: {
|
|
41603
41653
|
description:
|
|
41604
|
-
'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).',
|
|
41605
41655
|
operationId: 'acsAccessGroupsListPost',
|
|
41606
41656
|
requestBody: {
|
|
41607
41657
|
content: {
|
|
@@ -41677,7 +41727,7 @@ export default {
|
|
|
41677
41727
|
'/acs/access_groups/list_accessible_entrances': {
|
|
41678
41728
|
get: {
|
|
41679
41729
|
description:
|
|
41680
|
-
'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).',
|
|
41681
41731
|
operationId: 'acsAccessGroupsListAccessibleEntrancesGet',
|
|
41682
41732
|
parameters: [
|
|
41683
41733
|
{
|
|
@@ -41729,7 +41779,7 @@ export default {
|
|
|
41729
41779
|
},
|
|
41730
41780
|
post: {
|
|
41731
41781
|
description:
|
|
41732
|
-
'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).',
|
|
41733
41783
|
operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
|
|
41734
41784
|
requestBody: {
|
|
41735
41785
|
content: {
|
|
@@ -41788,7 +41838,7 @@ export default {
|
|
|
41788
41838
|
'/acs/access_groups/list_users': {
|
|
41789
41839
|
get: {
|
|
41790
41840
|
description:
|
|
41791
|
-
'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).',
|
|
41792
41842
|
operationId: 'acsAccessGroupsListUsersGet',
|
|
41793
41843
|
parameters: [
|
|
41794
41844
|
{
|
|
@@ -41840,7 +41890,7 @@ export default {
|
|
|
41840
41890
|
},
|
|
41841
41891
|
post: {
|
|
41842
41892
|
description:
|
|
41843
|
-
'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).',
|
|
41844
41894
|
operationId: 'acsAccessGroupsListUsersPost',
|
|
41845
41895
|
requestBody: {
|
|
41846
41896
|
content: {
|
|
@@ -41899,7 +41949,7 @@ export default {
|
|
|
41899
41949
|
'/acs/access_groups/remove_user': {
|
|
41900
41950
|
delete: {
|
|
41901
41951
|
description:
|
|
41902
|
-
'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).',
|
|
41903
41953
|
operationId: 'acsAccessGroupsRemoveUserDelete',
|
|
41904
41954
|
parameters: [
|
|
41905
41955
|
{
|
|
@@ -41966,7 +42016,7 @@ export default {
|
|
|
41966
42016
|
},
|
|
41967
42017
|
post: {
|
|
41968
42018
|
description:
|
|
41969
|
-
'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).',
|
|
41970
42020
|
operationId: 'acsAccessGroupsRemoveUserPost',
|
|
41971
42021
|
requestBody: {
|
|
41972
42022
|
content: {
|
|
@@ -42030,7 +42080,7 @@ export default {
|
|
|
42030
42080
|
'/acs/access_groups/unmanaged/get': {
|
|
42031
42081
|
get: {
|
|
42032
42082
|
description:
|
|
42033
|
-
'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).',
|
|
42034
42084
|
operationId: 'acsAccessGroupsUnmanagedGetGet',
|
|
42035
42085
|
parameters: [
|
|
42036
42086
|
{
|
|
@@ -42083,7 +42133,7 @@ export default {
|
|
|
42083
42133
|
},
|
|
42084
42134
|
post: {
|
|
42085
42135
|
description:
|
|
42086
|
-
'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).',
|
|
42087
42137
|
operationId: 'acsAccessGroupsUnmanagedGetPost',
|
|
42088
42138
|
requestBody: {
|
|
42089
42139
|
content: {
|
|
@@ -42143,7 +42193,7 @@ export default {
|
|
|
42143
42193
|
'/acs/access_groups/unmanaged/list': {
|
|
42144
42194
|
get: {
|
|
42145
42195
|
description:
|
|
42146
|
-
'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).',
|
|
42147
42197
|
operationId: 'acsAccessGroupsUnmanagedListGet',
|
|
42148
42198
|
parameters: [
|
|
42149
42199
|
{
|
|
@@ -42218,7 +42268,7 @@ export default {
|
|
|
42218
42268
|
},
|
|
42219
42269
|
post: {
|
|
42220
42270
|
description:
|
|
42221
|
-
'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).',
|
|
42222
42272
|
operationId: 'acsAccessGroupsUnmanagedListPost',
|
|
42223
42273
|
requestBody: {
|
|
42224
42274
|
content: {
|
|
@@ -45790,7 +45840,7 @@ export default {
|
|
|
45790
45840
|
'/acs/users/add_to_access_group': {
|
|
45791
45841
|
post: {
|
|
45792
45842
|
description:
|
|
45793
|
-
'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).',
|
|
45794
45844
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
45795
45845
|
requestBody: {
|
|
45796
45846
|
content: {
|
|
@@ -45846,7 +45896,7 @@ export default {
|
|
|
45846
45896
|
},
|
|
45847
45897
|
put: {
|
|
45848
45898
|
description:
|
|
45849
|
-
'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).',
|
|
45850
45900
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
45851
45901
|
requestBody: {
|
|
45852
45902
|
content: {
|
|
@@ -46643,7 +46693,7 @@ export default {
|
|
|
46643
46693
|
'/acs/users/remove_from_access_group': {
|
|
46644
46694
|
delete: {
|
|
46645
46695
|
description:
|
|
46646
|
-
'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).',
|
|
46647
46697
|
operationId: 'acsUsersRemoveFromAccessGroupDelete',
|
|
46648
46698
|
parameters: [
|
|
46649
46699
|
{
|
|
@@ -46710,7 +46760,7 @@ export default {
|
|
|
46710
46760
|
},
|
|
46711
46761
|
post: {
|
|
46712
46762
|
description:
|
|
46713
|
-
'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).',
|
|
46714
46764
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
46715
46765
|
requestBody: {
|
|
46716
46766
|
content: {
|
|
@@ -57774,7 +57824,7 @@ export default {
|
|
|
57774
57824
|
'/instant_keys/get': {
|
|
57775
57825
|
get: {
|
|
57776
57826
|
description:
|
|
57777
|
-
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
57827
|
+
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57778
57828
|
operationId: 'instantKeysGetGet',
|
|
57779
57829
|
parameters: [
|
|
57780
57830
|
{
|
|
@@ -57830,7 +57880,7 @@ export default {
|
|
|
57830
57880
|
},
|
|
57831
57881
|
post: {
|
|
57832
57882
|
description:
|
|
57833
|
-
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
57883
|
+
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57834
57884
|
operationId: 'instantKeysGetPost',
|
|
57835
57885
|
requestBody: {
|
|
57836
57886
|
content: {
|
|
@@ -57889,7 +57939,7 @@ export default {
|
|
|
57889
57939
|
'/instant_keys/list': {
|
|
57890
57940
|
get: {
|
|
57891
57941
|
description:
|
|
57892
|
-
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
57942
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57893
57943
|
operationId: 'instantKeysListGet',
|
|
57894
57944
|
parameters: [
|
|
57895
57945
|
{
|
|
@@ -57940,7 +57990,7 @@ export default {
|
|
|
57940
57990
|
},
|
|
57941
57991
|
post: {
|
|
57942
57992
|
description:
|
|
57943
|
-
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
57993
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57944
57994
|
operationId: 'instantKeysListPost',
|
|
57945
57995
|
requestBody: {
|
|
57946
57996
|
content: {
|
|
@@ -78633,7 +78683,7 @@ export default {
|
|
|
78633
78683
|
'/user_identities/delete': {
|
|
78634
78684
|
delete: {
|
|
78635
78685
|
description:
|
|
78636
|
-
'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/
|
|
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).',
|
|
78637
78687
|
operationId: 'userIdentitiesDeleteDelete',
|
|
78638
78688
|
parameters: [
|
|
78639
78689
|
{
|
|
@@ -78677,7 +78727,7 @@ export default {
|
|
|
78677
78727
|
},
|
|
78678
78728
|
post: {
|
|
78679
78729
|
description:
|
|
78680
|
-
'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/
|
|
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).',
|
|
78681
78731
|
operationId: 'userIdentitiesDeletePost',
|
|
78682
78732
|
requestBody: {
|
|
78683
78733
|
content: {
|
|
@@ -79145,7 +79195,7 @@ export default {
|
|
|
79145
79195
|
'/user_identities/generate_instant_key': {
|
|
79146
79196
|
post: {
|
|
79147
79197
|
description:
|
|
79148
|
-
'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/
|
|
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).',
|
|
79149
79199
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
79150
79200
|
requestBody: {
|
|
79151
79201
|
content: {
|