@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
|
@@ -1527,6 +1527,27 @@ export default {
|
|
|
1527
1527
|
required: ['message', 'warning_code'],
|
|
1528
1528
|
type: 'object',
|
|
1529
1529
|
},
|
|
1530
|
+
{
|
|
1531
|
+
description: "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.",
|
|
1532
|
+
properties: {
|
|
1533
|
+
created_at: {
|
|
1534
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1535
|
+
format: 'date-time',
|
|
1536
|
+
type: 'string',
|
|
1537
|
+
},
|
|
1538
|
+
message: {
|
|
1539
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1540
|
+
type: 'string',
|
|
1541
|
+
},
|
|
1542
|
+
warning_code: {
|
|
1543
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1544
|
+
enum: ['schlage_access_code_ambiguous_timezone_dst_risk'],
|
|
1545
|
+
type: 'string',
|
|
1546
|
+
},
|
|
1547
|
+
},
|
|
1548
|
+
required: ['message', 'warning_code'],
|
|
1549
|
+
type: 'object',
|
|
1550
|
+
},
|
|
1530
1551
|
{
|
|
1531
1552
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
1532
1553
|
properties: {
|
|
@@ -2668,7 +2689,7 @@ export default {
|
|
|
2668
2689
|
'x-route-path': '/access_methods',
|
|
2669
2690
|
},
|
|
2670
2691
|
acs_access_group: {
|
|
2671
|
-
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/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).',
|
|
2692
|
+
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).',
|
|
2672
2693
|
properties: {
|
|
2673
2694
|
access_group_type: {
|
|
2674
2695
|
deprecated: true,
|
|
@@ -2735,7 +2756,7 @@ export default {
|
|
|
2735
2756
|
discriminator: { propertyName: 'error_code' },
|
|
2736
2757
|
oneOf: [
|
|
2737
2758
|
{
|
|
2738
|
-
description: '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).',
|
|
2759
|
+
description: '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).',
|
|
2739
2760
|
properties: {
|
|
2740
2761
|
created_at: {
|
|
2741
2762
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -4066,7 +4087,7 @@ export default {
|
|
|
4066
4087
|
type: 'object',
|
|
4067
4088
|
},
|
|
4068
4089
|
{
|
|
4069
|
-
description: '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/
|
|
4090
|
+
description: '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).',
|
|
4070
4091
|
properties: {
|
|
4071
4092
|
created_at: {
|
|
4072
4093
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -4129,7 +4150,7 @@ export default {
|
|
|
4129
4150
|
type: 'object',
|
|
4130
4151
|
},
|
|
4131
4152
|
{
|
|
4132
|
-
description: 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/
|
|
4153
|
+
description: '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.',
|
|
4133
4154
|
properties: {
|
|
4134
4155
|
created_at: {
|
|
4135
4156
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -15896,7 +15917,7 @@ export default {
|
|
|
15896
15917
|
type: 'string',
|
|
15897
15918
|
},
|
|
15898
15919
|
acs_entrance_id: {
|
|
15899
|
-
description: 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
|
|
15920
|
+
description: 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15900
15921
|
format: 'uuid',
|
|
15901
15922
|
type: 'string',
|
|
15902
15923
|
},
|
|
@@ -15946,7 +15967,7 @@ export default {
|
|
|
15946
15967
|
type: 'string',
|
|
15947
15968
|
},
|
|
15948
15969
|
acs_entrance_id: {
|
|
15949
|
-
description: 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
|
|
15970
|
+
description: 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
15950
15971
|
format: 'uuid',
|
|
15951
15972
|
type: 'string',
|
|
15952
15973
|
},
|
|
@@ -17126,7 +17147,7 @@ export default {
|
|
|
17126
17147
|
'x-route-path': '/acs/access_groups',
|
|
17127
17148
|
},
|
|
17128
17149
|
{
|
|
17129
|
-
description: 'An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.',
|
|
17150
|
+
description: 'An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.',
|
|
17130
17151
|
properties: {
|
|
17131
17152
|
acs_entrance_id: { format: 'uuid', type: 'string' },
|
|
17132
17153
|
acs_system_id: {
|
|
@@ -17174,7 +17195,7 @@ export default {
|
|
|
17174
17195
|
'x-route-path': '/acs/entrances',
|
|
17175
17196
|
},
|
|
17176
17197
|
{
|
|
17177
|
-
description: 'An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.',
|
|
17198
|
+
description: 'An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.',
|
|
17178
17199
|
properties: {
|
|
17179
17200
|
acs_entrance_id: { format: 'uuid', type: 'string' },
|
|
17180
17201
|
acs_system_id: {
|
|
@@ -17381,7 +17402,7 @@ export default {
|
|
|
17381
17402
|
},
|
|
17382
17403
|
{
|
|
17383
17404
|
deprecated: true,
|
|
17384
|
-
description: '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/
|
|
17405
|
+
description: '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).',
|
|
17385
17406
|
properties: {
|
|
17386
17407
|
connect_webview_id: {
|
|
17387
17408
|
description: 'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event.',
|
|
@@ -18290,10 +18311,10 @@ export default {
|
|
|
18290
18311
|
'x-route-path': '/action_attempts',
|
|
18291
18312
|
},
|
|
18292
18313
|
{
|
|
18293
|
-
description: 'A [Connect Webview](https://docs.seam.co/latest/
|
|
18314
|
+
description: 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.',
|
|
18294
18315
|
properties: {
|
|
18295
18316
|
connect_webview_id: {
|
|
18296
|
-
description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
18317
|
+
description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
18297
18318
|
format: 'uuid',
|
|
18298
18319
|
type: 'string',
|
|
18299
18320
|
},
|
|
@@ -18351,10 +18372,10 @@ export default {
|
|
|
18351
18372
|
'x-route-path': '/connect_webviews',
|
|
18352
18373
|
},
|
|
18353
18374
|
{
|
|
18354
|
-
description: 'A [Connect Webview](https://docs.seam.co/latest/
|
|
18375
|
+
description: 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.',
|
|
18355
18376
|
properties: {
|
|
18356
18377
|
connect_webview_id: {
|
|
18357
|
-
description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/
|
|
18378
|
+
description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
18358
18379
|
format: 'uuid',
|
|
18359
18380
|
type: 'string',
|
|
18360
18381
|
},
|
|
@@ -24623,6 +24644,27 @@ export default {
|
|
|
24623
24644
|
required: ['message', 'warning_code'],
|
|
24624
24645
|
type: 'object',
|
|
24625
24646
|
},
|
|
24647
|
+
{
|
|
24648
|
+
description: "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.",
|
|
24649
|
+
properties: {
|
|
24650
|
+
created_at: {
|
|
24651
|
+
description: 'Date and time at which Seam created the warning.',
|
|
24652
|
+
format: 'date-time',
|
|
24653
|
+
type: 'string',
|
|
24654
|
+
},
|
|
24655
|
+
message: {
|
|
24656
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
24657
|
+
type: 'string',
|
|
24658
|
+
},
|
|
24659
|
+
warning_code: {
|
|
24660
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
24661
|
+
enum: ['schlage_access_code_ambiguous_timezone_dst_risk'],
|
|
24662
|
+
type: 'string',
|
|
24663
|
+
},
|
|
24664
|
+
},
|
|
24665
|
+
required: ['message', 'warning_code'],
|
|
24666
|
+
type: 'object',
|
|
24667
|
+
},
|
|
24626
24668
|
{
|
|
24627
24669
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
24628
24670
|
properties: {
|
|
@@ -24977,7 +25019,7 @@ export default {
|
|
|
24977
25019
|
discriminator: { propertyName: 'error_code' },
|
|
24978
25020
|
oneOf: [
|
|
24979
25021
|
{
|
|
24980
|
-
description: '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).',
|
|
25022
|
+
description: '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).',
|
|
24981
25023
|
properties: {
|
|
24982
25024
|
created_at: {
|
|
24983
25025
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -28268,7 +28310,7 @@ export default {
|
|
|
28268
28310
|
'x-undocumented': 'Only used internally.',
|
|
28269
28311
|
},
|
|
28270
28312
|
use_backup_access_code_pool: {
|
|
28271
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
28313
|
+
description: '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).',
|
|
28272
28314
|
type: 'boolean',
|
|
28273
28315
|
},
|
|
28274
28316
|
use_offline_access_code: {
|
|
@@ -30539,7 +30581,7 @@ export default {
|
|
|
30539
30581
|
type: 'string',
|
|
30540
30582
|
},
|
|
30541
30583
|
use_backup_access_code_pool: {
|
|
30542
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
30584
|
+
description: '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).',
|
|
30543
30585
|
type: 'boolean',
|
|
30544
30586
|
},
|
|
30545
30587
|
use_offline_access_code: {
|
|
@@ -30677,7 +30719,7 @@ export default {
|
|
|
30677
30719
|
type: 'string',
|
|
30678
30720
|
},
|
|
30679
30721
|
use_backup_access_code_pool: {
|
|
30680
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
30722
|
+
description: '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).',
|
|
30681
30723
|
type: 'boolean',
|
|
30682
30724
|
},
|
|
30683
30725
|
use_offline_access_code: {
|
|
@@ -30815,7 +30857,7 @@ export default {
|
|
|
30815
30857
|
type: 'string',
|
|
30816
30858
|
},
|
|
30817
30859
|
use_backup_access_code_pool: {
|
|
30818
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/
|
|
30860
|
+
description: '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).',
|
|
30819
30861
|
type: 'boolean',
|
|
30820
30862
|
},
|
|
30821
30863
|
use_offline_access_code: {
|
|
@@ -37072,7 +37114,7 @@ export default {
|
|
|
37072
37114
|
},
|
|
37073
37115
|
'/acs/access_groups/add_user': {
|
|
37074
37116
|
post: {
|
|
37075
|
-
description: '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).',
|
|
37117
|
+
description: '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).',
|
|
37076
37118
|
operationId: 'acsAccessGroupsAddUserPost',
|
|
37077
37119
|
requestBody: {
|
|
37078
37120
|
content: {
|
|
@@ -37130,7 +37172,7 @@ export default {
|
|
|
37130
37172
|
'x-title': 'Add an ACS User to an Access Group',
|
|
37131
37173
|
},
|
|
37132
37174
|
put: {
|
|
37133
|
-
description: '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).',
|
|
37175
|
+
description: '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).',
|
|
37134
37176
|
operationId: 'acsAccessGroupsAddUserPut',
|
|
37135
37177
|
requestBody: {
|
|
37136
37178
|
content: {
|
|
@@ -37190,7 +37232,7 @@ export default {
|
|
|
37190
37232
|
},
|
|
37191
37233
|
'/acs/access_groups/delete': {
|
|
37192
37234
|
delete: {
|
|
37193
|
-
description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37235
|
+
description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37194
37236
|
operationId: 'acsAccessGroupsDeleteDelete',
|
|
37195
37237
|
parameters: [
|
|
37196
37238
|
{
|
|
@@ -37234,7 +37276,7 @@ export default {
|
|
|
37234
37276
|
'x-title': 'Delete an Access Group',
|
|
37235
37277
|
},
|
|
37236
37278
|
post: {
|
|
37237
|
-
description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37279
|
+
description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37238
37280
|
operationId: 'acsAccessGroupsDeletePost',
|
|
37239
37281
|
requestBody: {
|
|
37240
37282
|
content: {
|
|
@@ -37285,7 +37327,7 @@ export default {
|
|
|
37285
37327
|
},
|
|
37286
37328
|
'/acs/access_groups/get': {
|
|
37287
37329
|
get: {
|
|
37288
|
-
description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37330
|
+
description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37289
37331
|
operationId: 'acsAccessGroupsGetGet',
|
|
37290
37332
|
parameters: [
|
|
37291
37333
|
{
|
|
@@ -37334,7 +37376,7 @@ export default {
|
|
|
37334
37376
|
'x-title': 'Get an Access Group',
|
|
37335
37377
|
},
|
|
37336
37378
|
post: {
|
|
37337
|
-
description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37379
|
+
description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37338
37380
|
operationId: 'acsAccessGroupsGetPost',
|
|
37339
37381
|
requestBody: {
|
|
37340
37382
|
content: {
|
|
@@ -37390,7 +37432,7 @@ export default {
|
|
|
37390
37432
|
},
|
|
37391
37433
|
'/acs/access_groups/list': {
|
|
37392
37434
|
get: {
|
|
37393
|
-
description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37435
|
+
description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37394
37436
|
operationId: 'acsAccessGroupsListGet',
|
|
37395
37437
|
parameters: [
|
|
37396
37438
|
{
|
|
@@ -37466,7 +37508,7 @@ export default {
|
|
|
37466
37508
|
'x-title': 'List Access Groups',
|
|
37467
37509
|
},
|
|
37468
37510
|
post: {
|
|
37469
|
-
description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37511
|
+
description: 'Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37470
37512
|
operationId: 'acsAccessGroupsListPost',
|
|
37471
37513
|
requestBody: {
|
|
37472
37514
|
content: {
|
|
@@ -37537,7 +37579,7 @@ export default {
|
|
|
37537
37579
|
},
|
|
37538
37580
|
'/acs/access_groups/list_accessible_entrances': {
|
|
37539
37581
|
get: {
|
|
37540
|
-
description: '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).',
|
|
37582
|
+
description: '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).',
|
|
37541
37583
|
operationId: 'acsAccessGroupsListAccessibleEntrancesGet',
|
|
37542
37584
|
parameters: [
|
|
37543
37585
|
{
|
|
@@ -37587,7 +37629,7 @@ export default {
|
|
|
37587
37629
|
'x-title': 'List Entrances Accessible to an Access Group',
|
|
37588
37630
|
},
|
|
37589
37631
|
post: {
|
|
37590
|
-
description: '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).',
|
|
37632
|
+
description: '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).',
|
|
37591
37633
|
operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
|
|
37592
37634
|
requestBody: {
|
|
37593
37635
|
content: {
|
|
@@ -37644,7 +37686,7 @@ export default {
|
|
|
37644
37686
|
},
|
|
37645
37687
|
'/acs/access_groups/list_users': {
|
|
37646
37688
|
get: {
|
|
37647
|
-
description: '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).',
|
|
37689
|
+
description: '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).',
|
|
37648
37690
|
operationId: 'acsAccessGroupsListUsersGet',
|
|
37649
37691
|
parameters: [
|
|
37650
37692
|
{
|
|
@@ -37694,7 +37736,7 @@ export default {
|
|
|
37694
37736
|
'x-title': 'List ACS Users in an Access Group',
|
|
37695
37737
|
},
|
|
37696
37738
|
post: {
|
|
37697
|
-
description: '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).',
|
|
37739
|
+
description: '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).',
|
|
37698
37740
|
operationId: 'acsAccessGroupsListUsersPost',
|
|
37699
37741
|
requestBody: {
|
|
37700
37742
|
content: {
|
|
@@ -37751,7 +37793,7 @@ export default {
|
|
|
37751
37793
|
},
|
|
37752
37794
|
'/acs/access_groups/remove_user': {
|
|
37753
37795
|
delete: {
|
|
37754
|
-
description: '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).',
|
|
37796
|
+
description: '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).',
|
|
37755
37797
|
operationId: 'acsAccessGroupsRemoveUserDelete',
|
|
37756
37798
|
parameters: [
|
|
37757
37799
|
{
|
|
@@ -37814,7 +37856,7 @@ export default {
|
|
|
37814
37856
|
'x-title': 'Remove an ACS User from an Access Group',
|
|
37815
37857
|
},
|
|
37816
37858
|
post: {
|
|
37817
|
-
description: '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).',
|
|
37859
|
+
description: '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).',
|
|
37818
37860
|
operationId: 'acsAccessGroupsRemoveUserPost',
|
|
37819
37861
|
requestBody: {
|
|
37820
37862
|
content: {
|
|
@@ -37874,7 +37916,7 @@ export default {
|
|
|
37874
37916
|
},
|
|
37875
37917
|
'/acs/access_groups/unmanaged/get': {
|
|
37876
37918
|
get: {
|
|
37877
|
-
description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37919
|
+
description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37878
37920
|
operationId: 'acsAccessGroupsUnmanagedGetGet',
|
|
37879
37921
|
parameters: [
|
|
37880
37922
|
{
|
|
@@ -37924,7 +37966,7 @@ export default {
|
|
|
37924
37966
|
'x-undocumented': 'No unmanaged access groups are currently implemented.',
|
|
37925
37967
|
},
|
|
37926
37968
|
post: {
|
|
37927
|
-
description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
37969
|
+
description: 'Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37928
37970
|
operationId: 'acsAccessGroupsUnmanagedGetPost',
|
|
37929
37971
|
requestBody: {
|
|
37930
37972
|
content: {
|
|
@@ -37981,7 +38023,7 @@ export default {
|
|
|
37981
38023
|
},
|
|
37982
38024
|
'/acs/access_groups/unmanaged/list': {
|
|
37983
38025
|
get: {
|
|
37984
|
-
description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
38026
|
+
description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
37985
38027
|
operationId: 'acsAccessGroupsUnmanagedListGet',
|
|
37986
38028
|
parameters: [
|
|
37987
38029
|
{
|
|
@@ -38051,7 +38093,7 @@ export default {
|
|
|
38051
38093
|
'x-undocumented': 'No unmanaged access groups are currently implemented.',
|
|
38052
38094
|
},
|
|
38053
38095
|
post: {
|
|
38054
|
-
description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
38096
|
+
description: 'Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).',
|
|
38055
38097
|
operationId: 'acsAccessGroupsUnmanagedListPost',
|
|
38056
38098
|
requestBody: {
|
|
38057
38099
|
content: {
|
|
@@ -41444,7 +41486,7 @@ export default {
|
|
|
41444
41486
|
},
|
|
41445
41487
|
'/acs/users/add_to_access_group': {
|
|
41446
41488
|
post: {
|
|
41447
|
-
description: '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).',
|
|
41489
|
+
description: '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).',
|
|
41448
41490
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
41449
41491
|
requestBody: {
|
|
41450
41492
|
content: {
|
|
@@ -41497,7 +41539,7 @@ export default {
|
|
|
41497
41539
|
'x-title': 'Add an ACS User to an Access Group',
|
|
41498
41540
|
},
|
|
41499
41541
|
put: {
|
|
41500
|
-
description: '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).',
|
|
41542
|
+
description: '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).',
|
|
41501
41543
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
41502
41544
|
requestBody: {
|
|
41503
41545
|
content: {
|
|
@@ -42241,7 +42283,7 @@ export default {
|
|
|
42241
42283
|
},
|
|
42242
42284
|
'/acs/users/remove_from_access_group': {
|
|
42243
42285
|
delete: {
|
|
42244
|
-
description: '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).',
|
|
42286
|
+
description: '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).',
|
|
42245
42287
|
operationId: 'acsUsersRemoveFromAccessGroupDelete',
|
|
42246
42288
|
parameters: [
|
|
42247
42289
|
{
|
|
@@ -42304,7 +42346,7 @@ export default {
|
|
|
42304
42346
|
'x-title': 'Remove an ACS User from an Access Group',
|
|
42305
42347
|
},
|
|
42306
42348
|
post: {
|
|
42307
|
-
description: '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).',
|
|
42349
|
+
description: '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).',
|
|
42308
42350
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
42309
42351
|
requestBody: {
|
|
42310
42352
|
content: {
|
|
@@ -52727,7 +52769,7 @@ export default {
|
|
|
52727
52769
|
},
|
|
52728
52770
|
'/instant_keys/get': {
|
|
52729
52771
|
get: {
|
|
52730
|
-
description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
52772
|
+
description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
52731
52773
|
operationId: 'instantKeysGetGet',
|
|
52732
52774
|
parameters: [
|
|
52733
52775
|
{
|
|
@@ -52782,7 +52824,7 @@ export default {
|
|
|
52782
52824
|
'x-title': 'Get an Instant Key',
|
|
52783
52825
|
},
|
|
52784
52826
|
post: {
|
|
52785
|
-
description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
52827
|
+
description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
52786
52828
|
operationId: 'instantKeysGetPost',
|
|
52787
52829
|
requestBody: {
|
|
52788
52830
|
content: {
|
|
@@ -52840,7 +52882,7 @@ export default {
|
|
|
52840
52882
|
},
|
|
52841
52883
|
'/instant_keys/list': {
|
|
52842
52884
|
get: {
|
|
52843
|
-
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
52885
|
+
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
52844
52886
|
operationId: 'instantKeysListGet',
|
|
52845
52887
|
parameters: [
|
|
52846
52888
|
{
|
|
@@ -52889,7 +52931,7 @@ export default {
|
|
|
52889
52931
|
'x-title': 'List Instant Keys',
|
|
52890
52932
|
},
|
|
52891
52933
|
post: {
|
|
52892
|
-
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
52934
|
+
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
52893
52935
|
operationId: 'instantKeysListPost',
|
|
52894
52936
|
requestBody: {
|
|
52895
52937
|
content: {
|
|
@@ -72700,7 +72742,7 @@ export default {
|
|
|
72700
72742
|
},
|
|
72701
72743
|
'/user_identities/delete': {
|
|
72702
72744
|
delete: {
|
|
72703
|
-
description: '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/
|
|
72745
|
+
description: '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).',
|
|
72704
72746
|
operationId: 'userIdentitiesDeleteDelete',
|
|
72705
72747
|
parameters: [
|
|
72706
72748
|
{
|
|
@@ -72743,7 +72785,7 @@ export default {
|
|
|
72743
72785
|
'x-title': 'Delete a User Identity',
|
|
72744
72786
|
},
|
|
72745
72787
|
post: {
|
|
72746
|
-
description: '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/
|
|
72788
|
+
description: '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).',
|
|
72747
72789
|
operationId: 'userIdentitiesDeletePost',
|
|
72748
72790
|
requestBody: {
|
|
72749
72791
|
content: {
|
|
@@ -73191,7 +73233,7 @@ export default {
|
|
|
73191
73233
|
},
|
|
73192
73234
|
'/user_identities/generate_instant_key': {
|
|
73193
73235
|
post: {
|
|
73194
|
-
description: 'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/
|
|
73236
|
+
description: '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).',
|
|
73195
73237
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
73196
73238
|
requestBody: {
|
|
73197
73239
|
content: {
|