@seamapi/types 1.802.0 → 1.804.0

package/src/lib/seam/connect/route-types.ts

@@ -27,7 +27,7 @@ export type Routes = {
       common_code_key?: string | undefined
       /** 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`. */
       prefer_native_scheduling?: boolean | undefined
-      /** 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). */
+      /** 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). */
       use_backup_access_code_pool?: boolean | undefined
       /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
       allow_external_modification?: boolean | undefined
@@ -10751,7 +10751,7 @@ export type Routes = {
       attempt_for_offline_device?: boolean
       /** 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`. */
       prefer_native_scheduling?: boolean | undefined
-      /** 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). */
+      /** 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). */
       use_backup_access_code_pool?: boolean | undefined
       /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
       allow_external_modification?: boolean | undefined
@@ -20849,7 +20849,7 @@ export type Routes = {
     jsonResponse: {
       /** 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.
     
-    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.
+    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.
     
     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). */
       acs_access_group: {
@@ -36891,6 +36891,23 @@ export type Routes = {
     
     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.
     
+    Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
+      customer_portal: {
+        /** URL for the customer portal. */
+        url: string
+        /** Customer key for the customer portal. */
+        customer_key: string
+        /** Date and time at which the customer portal link expires. */
+        expires_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. */
+        workspace_id: string
+        /** Date and time at which the customer portal link was created. */
+        created_at: string
+      }
+      /** 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.
+    
+    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.
+    
     Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
       magic_link: {
         /** URL for the magic link. */
@@ -44184,7 +44201,7 @@ export type Routes = {
                 /** ID of the affected Access Grant. */
                 access_grant_id: string
                 event_type: 'access_grant.access_granted_to_door'
-                /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+                /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 acs_entrance_id: string
               }
             | {
@@ -44199,7 +44216,7 @@ export type Routes = {
                 /** ID of the affected Access Grant. */
                 access_grant_id: string
                 event_type: 'access_grant.access_to_door_lost'
-                /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+                /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 acs_entrance_id: string
               }
             | {
@@ -45000,7 +45017,7 @@ export type Routes = {
                 created_at: string
                 /** Date and time at which the event occurred. */
                 occurred_at: string
-                /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+                /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
                 connect_webview_id: string
                 event_type: 'connect_webview.login_succeeded'
                 /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -45023,7 +45040,7 @@ export type Routes = {
                 created_at: string
                 /** Date and time at which the event occurred. */
                 occurred_at: string
-                /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+                /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
                 connect_webview_id: string
                 event_type: 'connect_webview.login_failed'
               }
@@ -47586,7 +47603,7 @@ export type Routes = {
             /** ID of the affected Access Grant. */
             access_grant_id: string
             event_type: 'access_grant.access_granted_to_door'
-            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
             acs_entrance_id: string
           }
         | {
@@ -47601,7 +47618,7 @@ export type Routes = {
             /** ID of the affected Access Grant. */
             access_grant_id: string
             event_type: 'access_grant.access_to_door_lost'
-            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
             acs_entrance_id: string
           }
         | {
@@ -48402,7 +48419,7 @@ export type Routes = {
             created_at: string
             /** Date and time at which the event occurred. */
             occurred_at: string
-            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
             connect_webview_id: string
             event_type: 'connect_webview.login_succeeded'
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -48425,7 +48442,7 @@ export type Routes = {
             created_at: string
             /** Date and time at which the event occurred. */
             occurred_at: string
-            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
             connect_webview_id: string
             event_type: 'connect_webview.login_failed'
           }
@@ -77515,7 +77532,7 @@ export type Routes = {
             /** ID of the affected Access Grant. */
             access_grant_id: string
             event_type: 'access_grant.access_granted_to_door'
-            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
             acs_entrance_id: string
           }
         | {
@@ -77530,7 +77547,7 @@ export type Routes = {
             /** ID of the affected Access Grant. */
             access_grant_id: string
             event_type: 'access_grant.access_to_door_lost'
-            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+            /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
             acs_entrance_id: string
           }
         | {
@@ -78331,7 +78348,7 @@ export type Routes = {
             created_at: string
             /** Date and time at which the event occurred. */
             occurred_at: string
-            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
             connect_webview_id: string
             event_type: 'connect_webview.login_succeeded'
             /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -78354,7 +78371,7 @@ export type Routes = {
             created_at: string
             /** Date and time at which the event occurred. */
             occurred_at: string
-            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+            /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
             connect_webview_id: string
             event_type: 'connect_webview.login_failed'
           }
@@ -115633,7 +115650,7 @@ export type Routes = {
                   /** ID of the affected Access Grant. */
                   access_grant_id: string
                   event_type: 'access_grant.access_granted_to_door'
-                  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+                  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                   acs_entrance_id: string
                 }
               | {
@@ -115648,7 +115665,7 @@ export type Routes = {
                   /** ID of the affected Access Grant. */
                   access_grant_id: string
                   event_type: 'access_grant.access_to_door_lost'
-                  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
+                  /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                   acs_entrance_id: string
                 }
               | {
@@ -116449,7 +116466,7 @@ export type Routes = {
                   created_at: string
                   /** Date and time at which the event occurred. */
                   occurred_at: string
-                  /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+                  /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
                   connect_webview_id: string
                   event_type: 'connect_webview.login_succeeded'
                   /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -116472,7 +116489,7 @@ export type Routes = {
                   created_at: string
                   /** Date and time at which the event occurred. */
                   occurred_at: string
-                  /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
+                  /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
                   connect_webview_id: string
                   event_type: 'connect_webview.login_failed'
                 }

package/src/lib/seam/connect/schemas.ts

@@ -17,6 +17,7 @@ export {
   connect_webview,
   connected_account,
   custom_metadata,
+  customer_portal,
   customization_profile,
   device,
   device_provider,