@seamapi/types 1.802.0 → 1.804.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 +120 -61
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +90 -20
- package/dist/index.cjs +120 -61
- package/dist/index.cjs.map +1 -1
- 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/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/models/partner/customer-portal.d.ts +21 -0
- package/lib/seam/connect/models/partner/customer-portal.js +29 -0
- package/lib/seam/connect/models/partner/customer-portal.js.map +1 -0
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +1 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +32 -0
- package/lib/seam/connect/openapi.js +88 -50
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +36 -19
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -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/models/partner/customer-portal.ts +35 -0
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +92 -50
- package/src/lib/seam/connect/route-types.ts +36 -19
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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: {
|
|
@@ -51570,10 +51570,52 @@ export default {
|
|
|
51570
51570
|
'application/json': {
|
|
51571
51571
|
schema: {
|
|
51572
51572
|
properties: {
|
|
51573
|
+
customer_portal: {
|
|
51574
|
+
description:
|
|
51575
|
+
"Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
|
|
51576
|
+
properties: {
|
|
51577
|
+
created_at: {
|
|
51578
|
+
description:
|
|
51579
|
+
'Date and time at which the customer portal link was created.',
|
|
51580
|
+
format: 'date-time',
|
|
51581
|
+
type: 'string',
|
|
51582
|
+
},
|
|
51583
|
+
customer_key: {
|
|
51584
|
+
description: 'Customer key for the customer portal.',
|
|
51585
|
+
type: 'string',
|
|
51586
|
+
},
|
|
51587
|
+
expires_at: {
|
|
51588
|
+
description:
|
|
51589
|
+
'Date and time at which the customer portal link expires.',
|
|
51590
|
+
format: 'date-time',
|
|
51591
|
+
type: 'string',
|
|
51592
|
+
},
|
|
51593
|
+
url: {
|
|
51594
|
+
description: 'URL for the customer portal.',
|
|
51595
|
+
format: 'uri',
|
|
51596
|
+
type: 'string',
|
|
51597
|
+
},
|
|
51598
|
+
workspace_id: {
|
|
51599
|
+
description:
|
|
51600
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
|
|
51601
|
+
format: 'uuid',
|
|
51602
|
+
type: 'string',
|
|
51603
|
+
},
|
|
51604
|
+
},
|
|
51605
|
+
required: [
|
|
51606
|
+
'url',
|
|
51607
|
+
'customer_key',
|
|
51608
|
+
'expires_at',
|
|
51609
|
+
'workspace_id',
|
|
51610
|
+
'created_at',
|
|
51611
|
+
],
|
|
51612
|
+
type: 'object',
|
|
51613
|
+
'x-route-path': '/customers',
|
|
51614
|
+
},
|
|
51573
51615
|
magic_link: { $ref: '#/components/schemas/magic_link' },
|
|
51574
51616
|
ok: { type: 'boolean' },
|
|
51575
51617
|
},
|
|
51576
|
-
required: ['magic_link', 'ok'],
|
|
51618
|
+
required: ['customer_portal', 'magic_link', 'ok'],
|
|
51577
51619
|
type: 'object',
|
|
51578
51620
|
},
|
|
51579
51621
|
},
|
|
@@ -51592,8 +51634,8 @@ export default {
|
|
|
51592
51634
|
tags: [],
|
|
51593
51635
|
'x-fern-sdk-group-name': ['customers'],
|
|
51594
51636
|
'x-fern-sdk-method-name': 'create_portal',
|
|
51595
|
-
'x-fern-sdk-return-value': '
|
|
51596
|
-
'x-response-key': '
|
|
51637
|
+
'x-fern-sdk-return-value': 'customer_portal',
|
|
51638
|
+
'x-response-key': 'customer_portal',
|
|
51597
51639
|
'x-title': 'Create Customer Portal',
|
|
51598
51640
|
},
|
|
51599
51641
|
},
|
|
@@ -57824,7 +57866,7 @@ export default {
|
|
|
57824
57866
|
'/instant_keys/get': {
|
|
57825
57867
|
get: {
|
|
57826
57868
|
description:
|
|
57827
|
-
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
57869
|
+
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57828
57870
|
operationId: 'instantKeysGetGet',
|
|
57829
57871
|
parameters: [
|
|
57830
57872
|
{
|
|
@@ -57880,7 +57922,7 @@ export default {
|
|
|
57880
57922
|
},
|
|
57881
57923
|
post: {
|
|
57882
57924
|
description:
|
|
57883
|
-
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/
|
|
57925
|
+
'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57884
57926
|
operationId: 'instantKeysGetPost',
|
|
57885
57927
|
requestBody: {
|
|
57886
57928
|
content: {
|
|
@@ -57939,7 +57981,7 @@ export default {
|
|
|
57939
57981
|
'/instant_keys/list': {
|
|
57940
57982
|
get: {
|
|
57941
57983
|
description:
|
|
57942
|
-
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
57984
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57943
57985
|
operationId: 'instantKeysListGet',
|
|
57944
57986
|
parameters: [
|
|
57945
57987
|
{
|
|
@@ -57990,7 +58032,7 @@ export default {
|
|
|
57990
58032
|
},
|
|
57991
58033
|
post: {
|
|
57992
58034
|
description:
|
|
57993
|
-
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/
|
|
58035
|
+
'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
|
|
57994
58036
|
operationId: 'instantKeysListPost',
|
|
57995
58037
|
requestBody: {
|
|
57996
58038
|
content: {
|
|
@@ -78683,7 +78725,7 @@ export default {
|
|
|
78683
78725
|
'/user_identities/delete': {
|
|
78684
78726
|
delete: {
|
|
78685
78727
|
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/
|
|
78728
|
+
'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
78729
|
operationId: 'userIdentitiesDeleteDelete',
|
|
78688
78730
|
parameters: [
|
|
78689
78731
|
{
|
|
@@ -78727,7 +78769,7 @@ export default {
|
|
|
78727
78769
|
},
|
|
78728
78770
|
post: {
|
|
78729
78771
|
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/
|
|
78772
|
+
'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
78773
|
operationId: 'userIdentitiesDeletePost',
|
|
78732
78774
|
requestBody: {
|
|
78733
78775
|
content: {
|
|
@@ -79195,7 +79237,7 @@ export default {
|
|
|
79195
79237
|
'/user_identities/generate_instant_key': {
|
|
79196
79238
|
post: {
|
|
79197
79239
|
description:
|
|
79198
|
-
'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/
|
|
79240
|
+
'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
79241
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
79200
79242
|
requestBody: {
|
|
79201
79243
|
content: {
|