@seamapi/types 1.403.0 → 1.404.1

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

@@ -15722,8 +15722,12 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access system user for whom you want to list accessible entrances. */
-            acs_user_id: string;
+            /** ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id. */
+            acs_user_id?: string | undefined;
+            /** ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id. */
+            user_identity_id?: string | undefined;
+            /** ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id. */
+            acs_system_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -15797,8 +15801,10 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            /** ID of the access system user that you want to remove from an access group. */
-            acs_user_id: string;
+            /** ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. */
+            acs_user_id?: string | undefined;
+            /** ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. */
+            user_identity_id?: string | undefined;
             /** ID of the access group from which you want to remove an access system user. */
             acs_access_group_id: string;
         };
@@ -18790,12 +18796,18 @@ export interface Routes {
           
           To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
             connect_webview: {
+                /** ID of the Connect Webview. */
                 connect_webview_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
                 workspace_id: string;
+                /** Date and time at which the Connect Webview was created. */
                 created_at: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
                 connected_account_id: string | null;
+                /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
                 url: string;
                 device_selection_mode: 'none' | 'single' | 'multiple';
+                /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 accepted_providers: string[];
                 /**
                  * @deprecated Unused. Will be removed. */
@@ -18803,15 +18815,25 @@ export interface Routes {
                 /**
                  * @deprecated Unused. Will be removed. */
                 any_device_allowed: boolean;
+                /** Indicates whether any provider is allowed. */
                 any_provider_allowed: boolean;
+                /** Indicates whether the user logged in successfully using the Connect Webview. */
                 login_successful: boolean;
+                /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
                 status: 'pending' | 'failed' | 'authorized';
+                /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
                 custom_redirect_url: string | null;
+                /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
                 custom_redirect_failure_url: string | null;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
+                /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
                 automatically_manage_new_devices: boolean;
+                /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
                 wait_for_device_creation: boolean;
+                /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
                 authorized_at: string | null;
+                /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 selected_provider: string | null;
             };
         };
@@ -18851,12 +18873,18 @@ export interface Routes {
           
           To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
             connect_webview: {
+                /** ID of the Connect Webview. */
                 connect_webview_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
                 workspace_id: string;
+                /** Date and time at which the Connect Webview was created. */
                 created_at: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
                 connected_account_id: string | null;
+                /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
                 url: string;
                 device_selection_mode: 'none' | 'single' | 'multiple';
+                /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 accepted_providers: string[];
                 /**
                  * @deprecated Unused. Will be removed. */
@@ -18864,15 +18892,25 @@ export interface Routes {
                 /**
                  * @deprecated Unused. Will be removed. */
                 any_device_allowed: boolean;
+                /** Indicates whether any provider is allowed. */
                 any_provider_allowed: boolean;
+                /** Indicates whether the user logged in successfully using the Connect Webview. */
                 login_successful: boolean;
+                /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
                 status: 'pending' | 'failed' | 'authorized';
+                /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
                 custom_redirect_url: string | null;
+                /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
                 custom_redirect_failure_url: string | null;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
+                /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
                 automatically_manage_new_devices: boolean;
+                /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
                 wait_for_device_creation: boolean;
+                /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
                 authorized_at: string | null;
+                /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 selected_provider: string | null;
             };
         };
@@ -18893,12 +18931,18 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             connect_webviews: Array<{
+                /** ID of the Connect Webview. */
                 connect_webview_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. */
                 workspace_id: string;
+                /** Date and time at which the Connect Webview was created. */
                 created_at: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. */
                 connected_account_id: string | null;
+                /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */
                 url: string;
                 device_selection_mode: 'none' | 'single' | 'multiple';
+                /** List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 accepted_providers: string[];
                 /**
                  * @deprecated Unused. Will be removed. */
@@ -18906,15 +18950,25 @@ export interface Routes {
                 /**
                  * @deprecated Unused. Will be removed. */
                 any_device_allowed: boolean;
+                /** Indicates whether any provider is allowed. */
                 any_provider_allowed: boolean;
+                /** Indicates whether the user logged in successfully using the Connect Webview. */
                 login_successful: boolean;
+                /** Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview. */
                 status: 'pending' | 'failed' | 'authorized';
+                /** URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs. */
                 custom_redirect_url: string | null;
+                /** URL to which the Connect Webview should redirect when an unexpected error occurs. */
                 custom_redirect_failure_url: string | null;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
+                /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
                 automatically_manage_new_devices: boolean;
+                /** Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */
                 wait_for_device_creation: boolean;
+                /** Date and time at which the user authorized (through the Connect Webview) the management of their devices. */
                 authorized_at: string | null;
+                /** Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */
                 selected_provider: string | null;
             }>;
         };
@@ -19028,6 +19082,7 @@ export interface Routes {
                         }>;
                     };
                 }>;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             };
@@ -19131,6 +19186,7 @@ export interface Routes {
                         }>;
                     };
                 }>;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             }>;
@@ -19241,6 +19297,7 @@ export interface Routes {
                         }>;
                     };
                 }>;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             };
@@ -20012,6 +20069,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -20807,6 +20865,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -25046,6 +25105,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -25800,6 +25860,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -26595,6 +26656,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -27348,6 +27410,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -32641,6 +32704,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -33394,6 +33458,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -41859,6 +41924,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -44902,6 +44968,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -45655,6 +45722,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -51947,6 +52015,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
@@ -52702,6 +52771,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
+                /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
                 custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.403.0",
+  "version": "1.404.1",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts

@@ -9,15 +9,38 @@ export const connect_webview_device_selection_mode = z.enum([
 ])
 
 export const connect_webview = z.object({
-  connect_webview_id: z.string().uuid(),
-  workspace_id: z.string().uuid(),
-  created_at: z.string().datetime(),
-  connected_account_id: z.string().uuid().nullable(),
-  url: z.string().url(),
+  connect_webview_id: z.string().uuid().describe('ID of the Connect Webview.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the Connect Webview was created.'),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .nullable()
+    .describe(
+      'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.',
+    ),
+  url: z
+    .string()
+    .url()
+    .describe(
+      'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
+    ),
   device_selection_mode: connect_webview_device_selection_mode,
 
   // TODO: Use enum value.
-  accepted_providers: z.array(z.string()),
+  accepted_providers: z
+    .array(z.string())
+    .describe(
+      'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
+    ),
 
   accepted_devices: z.array(z.string()).describe(
     `
@@ -36,16 +59,57 @@ export const connect_webview = z.object({
       `,
   ),
 
-  any_provider_allowed: z.boolean(),
-  login_successful: z.boolean(),
-  status: z.enum(['pending', 'failed', 'authorized']),
-  custom_redirect_url: z.string().url().nullable(),
-  custom_redirect_failure_url: z.string().url().nullable(),
+  any_provider_allowed: z
+    .boolean()
+    .describe('Indicates whether any provider is allowed.'),
+  login_successful: z
+    .boolean()
+    .describe(
+      'Indicates whether the user logged in successfully using the Connect Webview.',
+    ),
+  status: z
+    .enum(['pending', 'failed', 'authorized'])
+    .describe(
+      'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.',
+    ),
+  custom_redirect_url: z
+    .string()
+    .url()
+    .nullable()
+    .describe(
+      'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.',
+    ),
+  custom_redirect_failure_url: z
+    .string()
+    .url()
+    .nullable()
+    .describe(
+      'URL to which the Connect Webview should redirect when an unexpected error occurs.',
+    ),
   custom_metadata,
-  automatically_manage_new_devices: z.boolean(),
-  wait_for_device_creation: z.boolean(),
-  authorized_at: z.string().datetime().nullable(),
-  selected_provider: z.string().nullable(),
+  automatically_manage_new_devices: z
+    .boolean()
+    .describe(
+      'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
+    ),
+  wait_for_device_creation: z
+    .boolean()
+    .describe(
+      'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
+    ),
+  authorized_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe(
+      'Date and time at which the user authorized (through the Connect Webview) the management of their devices.',
+    ),
+  selected_provider: z
+    .string()
+    .nullable()
+    .describe(
+      'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
+    ),
 }).describe(`
   ---
   route_path: /connect_webviews

package/src/lib/seam/connect/models/custom-metadata.ts

@@ -8,11 +8,15 @@ export const custom_metadata_input = z
   .refine((val) => Object.keys(val).length <= 50, {
     message: 'Custom metadata is limited to a maximum of 50 keys',
   })
+  .describe(
+    'Set of up to 50 key:value pairs, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.  Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
+  )
 
-export const custom_metadata = z.record(
-  z.string(),
-  z.union([z.string(), z.boolean()]),
-)
+export const custom_metadata = z
+  .record(z.string(), z.union([z.string(), z.boolean()]))
+  .describe(
+    'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
+  )
 
 export type CustomMetadata = z.output<typeof custom_metadata>
 

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

@@ -7173,39 +7173,70 @@ export default {
             'x-deprecated': 'Unused. Will be removed.',
             'x-undocumented': 'Unused. Will be removed.',
           },
-          accepted_providers: { items: { type: 'string' }, type: 'array' },
+          accepted_providers: {
+            description:
+              'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
+            items: { type: 'string' },
+            type: 'array',
+          },
           any_device_allowed: {
             deprecated: true,
             type: 'boolean',
             'x-deprecated': 'Unused. Will be removed.',
             'x-undocumented': 'Unused. Will be removed.',
           },
-          any_provider_allowed: { type: 'boolean' },
+          any_provider_allowed: {
+            description: 'Indicates whether any provider is allowed.',
+            type: 'boolean',
+          },
           authorized_at: {
+            description:
+              'Date and time at which the user authorized (through the Connect Webview) the management of their devices.',
             format: 'date-time',
             nullable: true,
             type: 'string',
           },
-          automatically_manage_new_devices: { type: 'boolean' },
-          connect_webview_id: { format: 'uuid', type: 'string' },
+          automatically_manage_new_devices: {
+            description:
+              'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
+            type: 'boolean',
+          },
+          connect_webview_id: {
+            description: 'ID of the Connect Webview.',
+            format: 'uuid',
+            type: 'string',
+          },
           connected_account_id: {
+            description:
+              'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.',
             format: 'uuid',
             nullable: true,
             type: 'string',
           },
-          created_at: { format: 'date-time', type: 'string' },
+          created_at: {
+            description:
+              'Date and time at which the Connect Webview was created.',
+            format: 'date-time',
+            type: 'string',
+          },
           custom_metadata: {
             additionalProperties: {
               oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
+            description:
+              'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
             type: 'object',
           },
           custom_redirect_failure_url: {
+            description:
+              'URL to which the Connect Webview should redirect when an unexpected error occurs.',
             format: 'uri',
             nullable: true,
             type: 'string',
           },
           custom_redirect_url: {
+            description:
+              'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.',
             format: 'uri',
             nullable: true,
             type: 'string',
@@ -7214,12 +7245,40 @@ export default {
             enum: ['none', 'single', 'multiple'],
             type: 'string',
           },
-          login_successful: { type: 'boolean' },
-          selected_provider: { nullable: true, type: 'string' },
-          status: { enum: ['pending', 'failed', 'authorized'], type: 'string' },
-          url: { format: 'uri', type: 'string' },
-          wait_for_device_creation: { type: 'boolean' },
-          workspace_id: { format: 'uuid', type: 'string' },
+          login_successful: {
+            description:
+              'Indicates whether the user logged in successfully using the Connect Webview.',
+            type: 'boolean',
+          },
+          selected_provider: {
+            description:
+              'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
+            nullable: true,
+            type: 'string',
+          },
+          status: {
+            description:
+              'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.',
+            enum: ['pending', 'failed', 'authorized'],
+            type: 'string',
+          },
+          url: {
+            description:
+              'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
+            format: 'uri',
+            type: 'string',
+          },
+          wait_for_device_creation: {
+            description:
+              'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
+            type: 'boolean',
+          },
+          workspace_id: {
+            description:
+              'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.',
+            format: 'uuid',
+            type: 'string',
+          },
         },
         required: [
           'connect_webview_id',
@@ -7258,6 +7317,8 @@ export default {
             additionalProperties: {
               oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
+            description:
+              'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
             type: 'object',
           },
           errors: {
@@ -7567,6 +7628,8 @@ export default {
             additionalProperties: {
               oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
+            description:
+              'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
             type: 'object',
           },
           device_id: {
@@ -24880,14 +24943,25 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description:
+                      'ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   acs_user_id: {
                     description:
-                      'ID of the access system user for whom you want to list accessible entrances.',
+                      'ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  user_identity_id: {
+                    description:
+                      'ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.',
                     format: 'uuid',
                     type: 'string',
                   },
                 },
-                required: ['acs_user_id'],
                 type: 'object',
               },
             },
@@ -24948,12 +25022,18 @@ export default {
                   },
                   acs_user_id: {
                     description:
-                      'ID of the access system user that you want to remove from an access group.',
+                      'ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  user_identity_id: {
+                    description:
+                      'ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
                     format: 'uuid',
                     type: 'string',
                   },
                 },
-                required: ['acs_user_id', 'acs_access_group_id'],
+                required: ['acs_access_group_id'],
                 type: 'object',
               },
             },