@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
@@ -27,7 +27,7 @@ export type Routes = {
27
27
  common_code_key?: string | undefined;
28
28
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
29
29
  prefer_native_scheduling?: boolean | undefined;
30
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
30
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
31
31
  use_backup_access_code_pool?: boolean | undefined;
32
32
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
33
33
  allow_external_modification?: boolean | undefined;
@@ -9519,7 +9519,7 @@ export type Routes = {
9519
9519
  attempt_for_offline_device?: boolean;
9520
9520
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
9521
9521
  prefer_native_scheduling?: boolean | undefined;
9522
- /** 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). */
9522
+ /** 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). */
9523
9523
  use_backup_access_code_pool?: boolean | undefined;
9524
9524
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
9525
9525
  allow_external_modification?: boolean | undefined;
@@ -18078,7 +18078,7 @@ export type Routes = {
18078
18078
  jsonResponse: {
18079
18079
  /** 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.
18080
18080
 
18081
- Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
18081
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
18082
18082
 
18083
18083
  To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
18084
18084
  acs_access_group: {
@@ -31863,6 +31863,23 @@ export type Routes = {
31863
31863
 
31864
31864
  With 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.
31865
31865
 
31866
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
31867
+ customer_portal: {
31868
+ /** URL for the customer portal. */
31869
+ url: string;
31870
+ /** Customer key for the customer portal. */
31871
+ customer_key: string;
31872
+ /** Date and time at which the customer portal link expires. */
31873
+ expires_at: string;
31874
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. */
31875
+ workspace_id: string;
31876
+ /** Date and time at which the customer portal link was created. */
31877
+ created_at: string;
31878
+ };
31879
+ /** 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.
31880
+
31881
+ With 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.
31882
+
31866
31883
  Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
31867
31884
  magic_link: {
31868
31885
  /** URL for the magic link. */
@@ -36874,7 +36891,7 @@ export type Routes = {
36874
36891
  /** ID of the affected Access Grant. */
36875
36892
  access_grant_id: string;
36876
36893
  event_type: 'access_grant.access_granted_to_door';
36877
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
36894
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
36878
36895
  acs_entrance_id: string;
36879
36896
  } | {
36880
36897
  /** ID of the event. */
@@ -36888,7 +36905,7 @@ export type Routes = {
36888
36905
  /** ID of the affected Access Grant. */
36889
36906
  access_grant_id: string;
36890
36907
  event_type: 'access_grant.access_to_door_lost';
36891
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
36908
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
36892
36909
  acs_entrance_id: string;
36893
36910
  } | {
36894
36911
  /** ID of the event. */
@@ -37633,7 +37650,7 @@ export type Routes = {
37633
37650
  created_at: string;
37634
37651
  /** Date and time at which the event occurred. */
37635
37652
  occurred_at: string;
37636
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
37653
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
37637
37654
  connect_webview_id: string;
37638
37655
  event_type: 'connect_webview.login_succeeded';
37639
37656
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -37653,7 +37670,7 @@ export type Routes = {
37653
37670
  created_at: string;
37654
37671
  /** Date and time at which the event occurred. */
37655
37672
  occurred_at: string;
37656
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
37673
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
37657
37674
  connect_webview_id: string;
37658
37675
  event_type: 'connect_webview.login_failed';
37659
37676
  } | {
@@ -39702,7 +39719,7 @@ export type Routes = {
39702
39719
  /** ID of the affected Access Grant. */
39703
39720
  access_grant_id: string;
39704
39721
  event_type: 'access_grant.access_granted_to_door';
39705
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
39722
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
39706
39723
  acs_entrance_id: string;
39707
39724
  } | {
39708
39725
  /** ID of the event. */
@@ -39716,7 +39733,7 @@ export type Routes = {
39716
39733
  /** ID of the affected Access Grant. */
39717
39734
  access_grant_id: string;
39718
39735
  event_type: 'access_grant.access_to_door_lost';
39719
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
39736
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
39720
39737
  acs_entrance_id: string;
39721
39738
  } | {
39722
39739
  /** ID of the event. */
@@ -40461,7 +40478,7 @@ export type Routes = {
40461
40478
  created_at: string;
40462
40479
  /** Date and time at which the event occurred. */
40463
40480
  occurred_at: string;
40464
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
40481
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
40465
40482
  connect_webview_id: string;
40466
40483
  event_type: 'connect_webview.login_succeeded';
40467
40484
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -40481,7 +40498,7 @@ export type Routes = {
40481
40498
  created_at: string;
40482
40499
  /** Date and time at which the event occurred. */
40483
40500
  occurred_at: string;
40484
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
40501
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
40485
40502
  connect_webview_id: string;
40486
40503
  event_type: 'connect_webview.login_failed';
40487
40504
  } | {
@@ -64774,7 +64791,7 @@ export type Routes = {
64774
64791
  /** ID of the affected Access Grant. */
64775
64792
  access_grant_id: string;
64776
64793
  event_type: 'access_grant.access_granted_to_door';
64777
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
64794
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
64778
64795
  acs_entrance_id: string;
64779
64796
  } | {
64780
64797
  /** ID of the event. */
@@ -64788,7 +64805,7 @@ export type Routes = {
64788
64805
  /** ID of the affected Access Grant. */
64789
64806
  access_grant_id: string;
64790
64807
  event_type: 'access_grant.access_to_door_lost';
64791
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
64808
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
64792
64809
  acs_entrance_id: string;
64793
64810
  } | {
64794
64811
  /** ID of the event. */
@@ -65533,7 +65550,7 @@ export type Routes = {
65533
65550
  created_at: string;
65534
65551
  /** Date and time at which the event occurred. */
65535
65552
  occurred_at: string;
65536
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
65553
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
65537
65554
  connect_webview_id: string;
65538
65555
  event_type: 'connect_webview.login_succeeded';
65539
65556
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -65553,7 +65570,7 @@ export type Routes = {
65553
65570
  created_at: string;
65554
65571
  /** Date and time at which the event occurred. */
65555
65572
  occurred_at: string;
65556
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
65573
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
65557
65574
  connect_webview_id: string;
65558
65575
  event_type: 'connect_webview.login_failed';
65559
65576
  } | {
@@ -97039,7 +97056,7 @@ export type Routes = {
97039
97056
  /** ID of the affected Access Grant. */
97040
97057
  access_grant_id: string;
97041
97058
  event_type: 'access_grant.access_granted_to_door';
97042
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
97059
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
97043
97060
  acs_entrance_id: string;
97044
97061
  } | {
97045
97062
  /** ID of the event. */
@@ -97053,7 +97070,7 @@ export type Routes = {
97053
97070
  /** ID of the affected Access Grant. */
97054
97071
  access_grant_id: string;
97055
97072
  event_type: 'access_grant.access_to_door_lost';
97056
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
97073
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
97057
97074
  acs_entrance_id: string;
97058
97075
  } | {
97059
97076
  /** ID of the event. */
@@ -97798,7 +97815,7 @@ export type Routes = {
97798
97815
  created_at: string;
97799
97816
  /** Date and time at which the event occurred. */
97800
97817
  occurred_at: string;
97801
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
97818
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
97802
97819
  connect_webview_id: string;
97803
97820
  event_type: 'connect_webview.login_succeeded';
97804
97821
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -97818,7 +97835,7 @@ export type Routes = {
97818
97835
  created_at: string;
97819
97836
  /** Date and time at which the event occurred. */
97820
97837
  occurred_at: string;
97821
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
97838
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
97822
97839
  connect_webview_id: string;
97823
97840
  event_type: 'connect_webview.login_failed';
97824
97841
  } | {
@@ -1 +1 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customer_portal, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
@@ -1,2 +1,2 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customer_portal, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
2
2
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.802.0",
3
+ "version": "1.804.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -39,6 +39,7 @@ export {
39
39
  custom_metadata_input,
40
40
  customer,
41
41
  customer_data,
42
+ customer_portal,
42
43
  customer_portal_theme,
43
44
  device_capability_flags,
44
45
  device_metadata,
@@ -41,7 +41,7 @@ const acs_access_groups_failed_to_create_on_acs_system =
41
41
  .describe(error_code_description),
42
42
  })
43
43
  .describe(
44
- `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).`,
44
+ `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).`,
45
45
  )
46
46
 
47
47
  const acs_access_group_errors = z
@@ -176,7 +176,7 @@ export const acs_access_group = common_acs_access_group.extend({
176
176
  ---
177
177
  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.
178
178
 
179
- Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
179
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
180
180
 
181
181
  To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
182
182
  `)
@@ -75,7 +75,7 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
75
75
  })
76
76
  .describe(`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).
77
77
  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).
78
- 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).`)
78
+ 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).`)
79
79
 
80
80
  const salto_ks_subscription_limit_exceeded = common_acs_system_error
81
81
  .extend({
@@ -104,7 +104,7 @@ const account_disconnected = common_acs_system_error
104
104
  .describe(error_code_description),
105
105
  })
106
106
  .describe(
107
- '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.',
107
+ '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.',
108
108
  )
109
109
 
110
110
  const salto_ks_certification_expired = common_acs_system_error
@@ -45,7 +45,7 @@ const acs_entrance_id = z
45
45
  .string()
46
46
  .uuid()
47
47
  .describe(
48
- 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
48
+ 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
49
49
  )
50
50
 
51
51
  export const access_grant_access_granted_to_door_event =
@@ -14,7 +14,7 @@ export const acs_entrance_added_event = acs_entrance_event.extend({
14
14
  ---
15
15
  route_path: /acs/entrances
16
16
  ---
17
- An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
17
+ An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.
18
18
  `)
19
19
 
20
20
  export const acs_entrance_removed_event = acs_entrance_event.extend({
@@ -23,7 +23,7 @@ export const acs_entrance_removed_event = acs_entrance_event.extend({
23
23
  ---
24
24
  route_path: /acs/entrances
25
25
  ---
26
- An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
26
+ An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.
27
27
  `)
28
28
 
29
29
  export type AcsUserDeletedEvent = z.infer<typeof acs_entrance_removed_event>
@@ -8,7 +8,7 @@ const connect_webview_event = common_event.extend({
8
8
  .string()
9
9
  .uuid()
10
10
  .describe(
11
- 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
11
+ 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
12
12
  ),
13
13
  })
14
14
 
@@ -40,7 +40,7 @@ export const connect_webview_login_succeeded_event =
40
40
  ---
41
41
  route_path: /connect_webviews
42
42
  ---
43
- A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.
43
+ A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.
44
44
  `)
45
45
 
46
46
  export type ConnectWebviewLoginSucceededEvent = z.infer<
@@ -53,7 +53,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({
53
53
  ---
54
54
  route_path: /connect_webviews
55
55
  ---
56
- A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.
56
+ A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.
57
57
  `)
58
58
 
59
59
  export type ConnectWebviewLoginFailedEvent = z.infer<
@@ -82,7 +82,7 @@ export const connected_account_successful_login_event =
82
82
  deprecated: Use \`connect_webview.login_succeeded\`.
83
83
  route_path: /connected_accounts
84
84
  ---
85
- 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).
85
+ 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).
86
86
  `)
87
87
 
88
88
  /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */
@@ -0,0 +1,35 @@
1
+ import { z } from 'zod'
2
+
3
+ export const customer_portal = z
4
+ .object({
5
+ url: z.string().url().describe('URL for the customer portal.'),
6
+ customer_key: z.string().describe('Customer key for the customer portal.'),
7
+ expires_at: z
8
+ .string()
9
+ .datetime()
10
+ .describe('Date and time at which the customer portal link expires.'),
11
+ workspace_id: z
12
+ .string()
13
+ .uuid()
14
+ .describe(
15
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
16
+ ),
17
+ created_at: z
18
+ .string()
19
+ .datetime()
20
+ .describe('Date and time at which the customer portal link was created.'),
21
+ })
22
+ .describe(
23
+ `
24
+ ---
25
+ route_path: /customers
26
+ ---
27
+ 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.
28
+
29
+ With 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.
30
+
31
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
32
+ `,
33
+ )
34
+
35
+ export type CustomerPortal = z.infer<typeof customer_portal>
@@ -1 +1,2 @@
1
+ export * from './customer-portal.js'
1
2
  export * from './magic-link.js'