@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.
Files changed (40) hide show
  1. package/dist/connect.cjs +120 -61
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +90 -20
  4. package/dist/index.cjs +120 -61
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  7. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-system.js +2 -2
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/events/access-grants.js +1 -1
  11. package/lib/seam/connect/models/events/access-grants.js.map +1 -1
  12. package/lib/seam/connect/models/events/acs/entrances.js +2 -2
  13. package/lib/seam/connect/models/events/connect-webviews.js +3 -3
  14. package/lib/seam/connect/models/events/connected-accounts.js +1 -1
  15. package/lib/seam/connect/models/partner/customer-portal.d.ts +21 -0
  16. package/lib/seam/connect/models/partner/customer-portal.js +29 -0
  17. package/lib/seam/connect/models/partner/customer-portal.js.map +1 -0
  18. package/lib/seam/connect/models/partner/index.d.ts +1 -0
  19. package/lib/seam/connect/models/partner/index.js +1 -0
  20. package/lib/seam/connect/models/partner/index.js.map +1 -1
  21. package/lib/seam/connect/openapi.d.ts +32 -0
  22. package/lib/seam/connect/openapi.js +88 -50
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +36 -19
  25. package/lib/seam/connect/schemas.d.ts +1 -1
  26. package/lib/seam/connect/schemas.js +1 -1
  27. package/lib/seam/connect/schemas.js.map +1 -1
  28. package/package.json +1 -1
  29. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  30. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
  31. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  32. package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
  33. package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
  34. package/src/lib/seam/connect/models/events/connect-webviews.ts +3 -3
  35. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
  36. package/src/lib/seam/connect/models/partner/customer-portal.ts +35 -0
  37. package/src/lib/seam/connect/models/partner/index.ts +1 -0
  38. package/src/lib/seam/connect/openapi.ts +92 -50
  39. package/src/lib/seam/connect/route-types.ts +36 -19
  40. package/src/lib/seam/connect/schemas.ts +1 -0
@@ -2689,7 +2689,7 @@ export default {
2689
2689
  'x-route-path': '/access_methods',
2690
2690
  },
2691
2691
  acs_access_group: {
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/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).',
2693
2693
  properties: {
2694
2694
  access_group_type: {
2695
2695
  deprecated: true,
@@ -2756,7 +2756,7 @@ export default {
2756
2756
  discriminator: { propertyName: 'error_code' },
2757
2757
  oneOf: [
2758
2758
  {
2759
- 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).',
2760
2760
  properties: {
2761
2761
  created_at: {
2762
2762
  description: 'Date and time at which Seam created the error.',
@@ -4087,7 +4087,7 @@ export default {
4087
4087
  type: 'object',
4088
4088
  },
4089
4089
  {
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/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
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).',
4091
4091
  properties: {
4092
4092
  created_at: {
4093
4093
  description: 'Date and time at which Seam created the error.',
@@ -4150,7 +4150,7 @@ export default {
4150
4150
  type: 'object',
4151
4151
  },
4152
4152
  {
4153
- description: 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.',
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.',
4154
4154
  properties: {
4155
4155
  created_at: {
4156
4156
  description: 'Date and time at which Seam created the error.',
@@ -15917,7 +15917,7 @@ export default {
15917
15917
  type: 'string',
15918
15918
  },
15919
15919
  acs_entrance_id: {
15920
- 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).',
15921
15921
  format: 'uuid',
15922
15922
  type: 'string',
15923
15923
  },
@@ -15967,7 +15967,7 @@ export default {
15967
15967
  type: 'string',
15968
15968
  },
15969
15969
  acs_entrance_id: {
15970
- 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).',
15971
15971
  format: 'uuid',
15972
15972
  type: 'string',
15973
15973
  },
@@ -17147,7 +17147,7 @@ export default {
17147
17147
  'x-route-path': '/acs/access_groups',
17148
17148
  },
17149
17149
  {
17150
- 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.',
17151
17151
  properties: {
17152
17152
  acs_entrance_id: { format: 'uuid', type: 'string' },
17153
17153
  acs_system_id: {
@@ -17195,7 +17195,7 @@ export default {
17195
17195
  'x-route-path': '/acs/entrances',
17196
17196
  },
17197
17197
  {
17198
- 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.',
17199
17199
  properties: {
17200
17200
  acs_entrance_id: { format: 'uuid', type: 'string' },
17201
17201
  acs_system_id: {
@@ -17402,7 +17402,7 @@ export default {
17402
17402
  },
17403
17403
  {
17404
17404
  deprecated: true,
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/ui-components/connect-webviews).',
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).',
17406
17406
  properties: {
17407
17407
  connect_webview_id: {
17408
17408
  description: 'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event.',
@@ -18311,10 +18311,10 @@ export default {
18311
18311
  'x-route-path': '/action_attempts',
18312
18312
  },
18313
18313
  {
18314
- description: 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.',
18314
+ description: 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.',
18315
18315
  properties: {
18316
18316
  connect_webview_id: {
18317
- description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
18317
+ description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
18318
18318
  format: 'uuid',
18319
18319
  type: 'string',
18320
18320
  },
@@ -18372,10 +18372,10 @@ export default {
18372
18372
  'x-route-path': '/connect_webviews',
18373
18373
  },
18374
18374
  {
18375
- description: 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.',
18375
+ description: 'A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.',
18376
18376
  properties: {
18377
18377
  connect_webview_id: {
18378
- description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
18378
+ description: 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
18379
18379
  format: 'uuid',
18380
18380
  type: 'string',
18381
18381
  },
@@ -25019,7 +25019,7 @@ export default {
25019
25019
  discriminator: { propertyName: 'error_code' },
25020
25020
  oneOf: [
25021
25021
  {
25022
- 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).',
25023
25023
  properties: {
25024
25024
  created_at: {
25025
25025
  description: 'Date and time at which Seam created the error.',
@@ -28310,7 +28310,7 @@ export default {
28310
28310
  'x-undocumented': 'Only used internally.',
28311
28311
  },
28312
28312
  use_backup_access_code_pool: {
28313
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
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).',
28314
28314
  type: 'boolean',
28315
28315
  },
28316
28316
  use_offline_access_code: {
@@ -30581,7 +30581,7 @@ export default {
30581
30581
  type: 'string',
30582
30582
  },
30583
30583
  use_backup_access_code_pool: {
30584
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
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).',
30585
30585
  type: 'boolean',
30586
30586
  },
30587
30587
  use_offline_access_code: {
@@ -30719,7 +30719,7 @@ export default {
30719
30719
  type: 'string',
30720
30720
  },
30721
30721
  use_backup_access_code_pool: {
30722
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
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).',
30723
30723
  type: 'boolean',
30724
30724
  },
30725
30725
  use_offline_access_code: {
@@ -30857,7 +30857,7 @@ export default {
30857
30857
  type: 'string',
30858
30858
  },
30859
30859
  use_backup_access_code_pool: {
30860
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
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).',
30861
30861
  type: 'boolean',
30862
30862
  },
30863
30863
  use_offline_access_code: {
@@ -37114,7 +37114,7 @@ export default {
37114
37114
  },
37115
37115
  '/acs/access_groups/add_user': {
37116
37116
  post: {
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/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).',
37118
37118
  operationId: 'acsAccessGroupsAddUserPost',
37119
37119
  requestBody: {
37120
37120
  content: {
@@ -37172,7 +37172,7 @@ export default {
37172
37172
  'x-title': 'Add an ACS User to an Access Group',
37173
37173
  },
37174
37174
  put: {
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/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).',
37176
37176
  operationId: 'acsAccessGroupsAddUserPut',
37177
37177
  requestBody: {
37178
37178
  content: {
@@ -37232,7 +37232,7 @@ export default {
37232
37232
  },
37233
37233
  '/acs/access_groups/delete': {
37234
37234
  delete: {
37235
- 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).',
37236
37236
  operationId: 'acsAccessGroupsDeleteDelete',
37237
37237
  parameters: [
37238
37238
  {
@@ -37276,7 +37276,7 @@ export default {
37276
37276
  'x-title': 'Delete an Access Group',
37277
37277
  },
37278
37278
  post: {
37279
- 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).',
37280
37280
  operationId: 'acsAccessGroupsDeletePost',
37281
37281
  requestBody: {
37282
37282
  content: {
@@ -37327,7 +37327,7 @@ export default {
37327
37327
  },
37328
37328
  '/acs/access_groups/get': {
37329
37329
  get: {
37330
- 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).',
37331
37331
  operationId: 'acsAccessGroupsGetGet',
37332
37332
  parameters: [
37333
37333
  {
@@ -37376,7 +37376,7 @@ export default {
37376
37376
  'x-title': 'Get an Access Group',
37377
37377
  },
37378
37378
  post: {
37379
- 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).',
37380
37380
  operationId: 'acsAccessGroupsGetPost',
37381
37381
  requestBody: {
37382
37382
  content: {
@@ -37432,7 +37432,7 @@ export default {
37432
37432
  },
37433
37433
  '/acs/access_groups/list': {
37434
37434
  get: {
37435
- 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).',
37436
37436
  operationId: 'acsAccessGroupsListGet',
37437
37437
  parameters: [
37438
37438
  {
@@ -37508,7 +37508,7 @@ export default {
37508
37508
  'x-title': 'List Access Groups',
37509
37509
  },
37510
37510
  post: {
37511
- 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).',
37512
37512
  operationId: 'acsAccessGroupsListPost',
37513
37513
  requestBody: {
37514
37514
  content: {
@@ -37579,7 +37579,7 @@ export default {
37579
37579
  },
37580
37580
  '/acs/access_groups/list_accessible_entrances': {
37581
37581
  get: {
37582
- 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).',
37583
37583
  operationId: 'acsAccessGroupsListAccessibleEntrancesGet',
37584
37584
  parameters: [
37585
37585
  {
@@ -37629,7 +37629,7 @@ export default {
37629
37629
  'x-title': 'List Entrances Accessible to an Access Group',
37630
37630
  },
37631
37631
  post: {
37632
- 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).',
37633
37633
  operationId: 'acsAccessGroupsListAccessibleEntrancesPost',
37634
37634
  requestBody: {
37635
37635
  content: {
@@ -37686,7 +37686,7 @@ export default {
37686
37686
  },
37687
37687
  '/acs/access_groups/list_users': {
37688
37688
  get: {
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/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).',
37690
37690
  operationId: 'acsAccessGroupsListUsersGet',
37691
37691
  parameters: [
37692
37692
  {
@@ -37736,7 +37736,7 @@ export default {
37736
37736
  'x-title': 'List ACS Users in an Access Group',
37737
37737
  },
37738
37738
  post: {
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/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).',
37740
37740
  operationId: 'acsAccessGroupsListUsersPost',
37741
37741
  requestBody: {
37742
37742
  content: {
@@ -37793,7 +37793,7 @@ export default {
37793
37793
  },
37794
37794
  '/acs/access_groups/remove_user': {
37795
37795
  delete: {
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/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).',
37797
37797
  operationId: 'acsAccessGroupsRemoveUserDelete',
37798
37798
  parameters: [
37799
37799
  {
@@ -37856,7 +37856,7 @@ export default {
37856
37856
  'x-title': 'Remove an ACS User from an Access Group',
37857
37857
  },
37858
37858
  post: {
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/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).',
37860
37860
  operationId: 'acsAccessGroupsRemoveUserPost',
37861
37861
  requestBody: {
37862
37862
  content: {
@@ -37916,7 +37916,7 @@ export default {
37916
37916
  },
37917
37917
  '/acs/access_groups/unmanaged/get': {
37918
37918
  get: {
37919
- 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).',
37920
37920
  operationId: 'acsAccessGroupsUnmanagedGetGet',
37921
37921
  parameters: [
37922
37922
  {
@@ -37966,7 +37966,7 @@ export default {
37966
37966
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
37967
37967
  },
37968
37968
  post: {
37969
- 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).',
37970
37970
  operationId: 'acsAccessGroupsUnmanagedGetPost',
37971
37971
  requestBody: {
37972
37972
  content: {
@@ -38023,7 +38023,7 @@ export default {
38023
38023
  },
38024
38024
  '/acs/access_groups/unmanaged/list': {
38025
38025
  get: {
38026
- 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).',
38027
38027
  operationId: 'acsAccessGroupsUnmanagedListGet',
38028
38028
  parameters: [
38029
38029
  {
@@ -38093,7 +38093,7 @@ export default {
38093
38093
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
38094
38094
  },
38095
38095
  post: {
38096
- 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).',
38097
38097
  operationId: 'acsAccessGroupsUnmanagedListPost',
38098
38098
  requestBody: {
38099
38099
  content: {
@@ -41486,7 +41486,7 @@ export default {
41486
41486
  },
41487
41487
  '/acs/users/add_to_access_group': {
41488
41488
  post: {
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/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).',
41490
41490
  operationId: 'acsUsersAddToAccessGroupPost',
41491
41491
  requestBody: {
41492
41492
  content: {
@@ -41539,7 +41539,7 @@ export default {
41539
41539
  'x-title': 'Add an ACS User to an Access Group',
41540
41540
  },
41541
41541
  put: {
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/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).',
41543
41543
  operationId: 'acsUsersAddToAccessGroupPut',
41544
41544
  requestBody: {
41545
41545
  content: {
@@ -42283,7 +42283,7 @@ export default {
42283
42283
  },
42284
42284
  '/acs/users/remove_from_access_group': {
42285
42285
  delete: {
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/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).',
42287
42287
  operationId: 'acsUsersRemoveFromAccessGroupDelete',
42288
42288
  parameters: [
42289
42289
  {
@@ -42346,7 +42346,7 @@ export default {
42346
42346
  'x-title': 'Remove an ACS User from an Access Group',
42347
42347
  },
42348
42348
  post: {
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/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).',
42350
42350
  operationId: 'acsUsersRemoveFromAccessGroupPost',
42351
42351
  requestBody: {
42352
42352
  content: {
@@ -46793,10 +46793,48 @@ export default {
46793
46793
  'application/json': {
46794
46794
  schema: {
46795
46795
  properties: {
46796
+ customer_portal: {
46797
+ description: "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.",
46798
+ properties: {
46799
+ created_at: {
46800
+ description: 'Date and time at which the customer portal link was created.',
46801
+ format: 'date-time',
46802
+ type: 'string',
46803
+ },
46804
+ customer_key: {
46805
+ description: 'Customer key for the customer portal.',
46806
+ type: 'string',
46807
+ },
46808
+ expires_at: {
46809
+ description: 'Date and time at which the customer portal link expires.',
46810
+ format: 'date-time',
46811
+ type: 'string',
46812
+ },
46813
+ url: {
46814
+ description: 'URL for the customer portal.',
46815
+ format: 'uri',
46816
+ type: 'string',
46817
+ },
46818
+ workspace_id: {
46819
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
46820
+ format: 'uuid',
46821
+ type: 'string',
46822
+ },
46823
+ },
46824
+ required: [
46825
+ 'url',
46826
+ 'customer_key',
46827
+ 'expires_at',
46828
+ 'workspace_id',
46829
+ 'created_at',
46830
+ ],
46831
+ type: 'object',
46832
+ 'x-route-path': '/customers',
46833
+ },
46796
46834
  magic_link: { $ref: '#/components/schemas/magic_link' },
46797
46835
  ok: { type: 'boolean' },
46798
46836
  },
46799
- required: ['magic_link', 'ok'],
46837
+ required: ['customer_portal', 'magic_link', 'ok'],
46800
46838
  type: 'object',
46801
46839
  },
46802
46840
  },
@@ -46815,8 +46853,8 @@ export default {
46815
46853
  tags: [],
46816
46854
  'x-fern-sdk-group-name': ['customers'],
46817
46855
  'x-fern-sdk-method-name': 'create_portal',
46818
- 'x-fern-sdk-return-value': 'magic_link',
46819
- 'x-response-key': 'magic_link',
46856
+ 'x-fern-sdk-return-value': 'customer_portal',
46857
+ 'x-response-key': 'customer_portal',
46820
46858
  'x-title': 'Create Customer Portal',
46821
46859
  },
46822
46860
  },
@@ -52769,7 +52807,7 @@ export default {
52769
52807
  },
52770
52808
  '/instant_keys/get': {
52771
52809
  get: {
52772
- description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
52810
+ description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
52773
52811
  operationId: 'instantKeysGetGet',
52774
52812
  parameters: [
52775
52813
  {
@@ -52824,7 +52862,7 @@ export default {
52824
52862
  'x-title': 'Get an Instant Key',
52825
52863
  },
52826
52864
  post: {
52827
- description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
52865
+ description: 'Gets an [instant key](https://docs.seam.co/latest/capability-guides/instant-keys).',
52828
52866
  operationId: 'instantKeysGetPost',
52829
52867
  requestBody: {
52830
52868
  content: {
@@ -52882,7 +52920,7 @@ export default {
52882
52920
  },
52883
52921
  '/instant_keys/list': {
52884
52922
  get: {
52885
- description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
52923
+ description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
52886
52924
  operationId: 'instantKeysListGet',
52887
52925
  parameters: [
52888
52926
  {
@@ -52931,7 +52969,7 @@ export default {
52931
52969
  'x-title': 'List Instant Keys',
52932
52970
  },
52933
52971
  post: {
52934
- description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
52972
+ description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/instant-keys).',
52935
52973
  operationId: 'instantKeysListPost',
52936
52974
  requestBody: {
52937
52975
  content: {
@@ -72742,7 +72780,7 @@ export default {
72742
72780
  },
72743
72781
  '/user_identities/delete': {
72744
72782
  delete: {
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/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
72783
+ 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).',
72746
72784
  operationId: 'userIdentitiesDeleteDelete',
72747
72785
  parameters: [
72748
72786
  {
@@ -72785,7 +72823,7 @@ export default {
72785
72823
  'x-title': 'Delete a User Identity',
72786
72824
  },
72787
72825
  post: {
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/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
72826
+ 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).',
72789
72827
  operationId: 'userIdentitiesDeletePost',
72790
72828
  requestBody: {
72791
72829
  content: {
@@ -73233,7 +73271,7 @@ export default {
73233
73271
  },
73234
73272
  '/user_identities/generate_instant_key': {
73235
73273
  post: {
73236
- description: 'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
73274
+ 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).',
73237
73275
  operationId: 'userIdentitiesGenerateInstantKeyPost',
73238
73276
  requestBody: {
73239
73277
  content: {