@seamapi/types 1.802.0 → 1.804.0

package/dist/connect.d.cts

@@ -62938,6 +62938,26 @@ declare const pagination: z.ZodObject<{
 }>;
 type Pagination = z.infer<typeof pagination>;
 
+declare const customer_portal: z.ZodObject<{
+    url: z.ZodString;
+    customer_key: z.ZodString;
+    expires_at: z.ZodString;
+    workspace_id: z.ZodString;
+    created_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+    expires_at: string;
+    url: string;
+}, {
+    workspace_id: string;
+    created_at: string;
+    customer_key: string;
+    expires_at: string;
+    url: string;
+}>;
+
 declare const magic_link: z.ZodObject<{
     url: z.ZodString;
     customer_key: z.ZodString;
@@ -63402,6 +63422,7 @@ declare const schemas_common_succeeded_action_attempt: typeof common_succeeded_a
 declare const schemas_connect_webview: typeof connect_webview;
 declare const schemas_connected_account: typeof connected_account;
 declare const schemas_custom_metadata: typeof custom_metadata;
+declare const schemas_customer_portal: typeof customer_portal;
 declare const schemas_customization_profile: typeof customization_profile;
 declare const schemas_device: typeof device;
 declare const schemas_device_provider: typeof device_provider;
@@ -63423,7 +63444,7 @@ declare const schemas_user_identity: typeof user_identity;
 declare const schemas_webhook: typeof webhook;
 declare const schemas_workspace: typeof workspace;
 declare namespace schemas {
-  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
+  export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_batch as batch, schemas_bridge as bridge, schemas_bridge_client_session as bridge_client_session, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_customer_portal as customer_portal, schemas_customization_profile as customization_profile, schemas_device as device, schemas_device_provider as device_provider, schemas_instant_key as instant_key, schemas_magic_link as magic_link, schemas_noise_threshold as noise_threshold, schemas_pagination as pagination, schemas_seam_event as seam_event, schemas_staff_member_resource as staff_member_resource, schemas_thermostat_daily_program as thermostat_daily_program, schemas_thermostat_schedule as thermostat_schedule, schemas_thermostat_weekly_program as thermostat_weekly_program, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
 }
 
 declare const _default: {
@@ -104367,6 +104388,38 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        customer_portal: {
+                                            description: string;
+                                            properties: {
+                                                created_at: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                customer_key: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                expires_at: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                url: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                workspace_id: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-route-path': string;
+                                        };
                                         magic_link: {
                                             $ref: string;
                                         };
@@ -137607,7 +137660,7 @@ 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;
@@ -147099,7 +147152,7 @@ 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;
@@ -155658,7 +155711,7 @@ 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: {
@@ -169443,6 +169496,23 @@ 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. */
@@ -174454,7 +174524,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -174468,7 +174538,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -175213,7 +175283,7 @@ 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. */
@@ -175233,7 +175303,7 @@ 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';
             } | {
@@ -177282,7 +177352,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -177296,7 +177366,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -178041,7 +178111,7 @@ 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. */
@@ -178061,7 +178131,7 @@ 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';
             } | {
@@ -202354,7 +202424,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -202368,7 +202438,7 @@ 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;
             } | {
                 /** ID of the event. */
@@ -203113,7 +203183,7 @@ 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. */
@@ -203133,7 +203203,7 @@ 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';
             } | {
@@ -234619,7 +234689,7 @@ 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;
                 } | {
                     /** ID of the event. */
@@ -234633,7 +234703,7 @@ 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;
                 } | {
                     /** ID of the event. */
@@ -235378,7 +235448,7 @@ 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. */
@@ -235398,7 +235468,7 @@ 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';
                 } | {