@seamapi/types 1.403.0 → 1.404.1

package/dist/connect.d.cts

@@ -24288,6 +24288,7 @@ declare const _default: {
                         'x-undocumented': string;
                     };
                     accepted_providers: {
+                        description: string;
                         items: {
                             type: string;
                         };
@@ -24300,26 +24301,32 @@ declare const _default: {
                         'x-undocumented': string;
                     };
                     any_provider_allowed: {
+                        description: string;
                         type: string;
                     };
                     authorized_at: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     automatically_manage_new_devices: {
+                        description: string;
                         type: string;
                     };
                     connect_webview_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     connected_account_id: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
@@ -24329,14 +24336,17 @@ declare const _default: {
                                 type: string;
                             }[];
                         };
+                        description: string;
                         type: string;
                     };
                     custom_redirect_failure_url: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     custom_redirect_url: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
@@ -24346,24 +24356,30 @@ declare const _default: {
                         type: string;
                     };
                     login_successful: {
+                        description: string;
                         type: string;
                     };
                     selected_provider: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     status: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
                     url: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     wait_for_device_creation: {
+                        description: string;
                         type: string;
                     };
                     workspace_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
@@ -24398,6 +24414,7 @@ declare const _default: {
                                 type: string;
                             }[];
                         };
+                        description: string;
                         type: string;
                     };
                     errors: {
@@ -24652,6 +24669,7 @@ declare const _default: {
                                 type: string;
                             }[];
                         };
+                        description: string;
                         type: string;
                     };
                     device_id: {
@@ -38228,13 +38246,22 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    acs_system_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
                                     acs_user_id: {
                                         description: string;
                                         format: string;
                                         type: string;
                                     };
+                                    user_identity_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
                                 };
-                                required: string[];
                                 type: string;
                             };
                         };
@@ -38319,6 +38346,11 @@ declare const _default: {
                                         format: string;
                                         type: string;
                                     };
+                                    user_identity_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
                                 };
                                 required: string[];
                                 type: string;
@@ -68982,8 +69014,12 @@ 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: {
@@ -69057,8 +69093,10 @@ 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;
         };
@@ -72050,12 +72088,18 @@ 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. */
@@ -72063,15 +72107,25 @@ 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;
             };
         };
@@ -72111,12 +72165,18 @@ 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. */
@@ -72124,15 +72184,25 @@ 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;
             };
         };
@@ -72153,12 +72223,18 @@ 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. */
@@ -72166,15 +72242,25 @@ 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;
             }>;
         };
@@ -72288,6 +72374,7 @@ 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;
             };
@@ -72391,6 +72478,7 @@ 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;
             }>;
@@ -72501,6 +72589,7 @@ 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;
             };
@@ -73272,6 +73361,7 @@ 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;
@@ -74067,6 +74157,7 @@ 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;
@@ -78306,6 +78397,7 @@ 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;
@@ -79060,6 +79152,7 @@ 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;
@@ -79855,6 +79948,7 @@ 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;
@@ -80608,6 +80702,7 @@ 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;
@@ -85901,6 +85996,7 @@ 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;
@@ -86654,6 +86750,7 @@ 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;
@@ -95119,6 +95216,7 @@ 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;
@@ -98162,6 +98260,7 @@ 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;
@@ -98915,6 +99014,7 @@ 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;
@@ -105207,6 +105307,7 @@ 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;
@@ -105962,6 +106063,7 @@ 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/lib/seam/connect/models/connect-webviews/connect-webview.js

@@ -6,14 +6,29 @@ export const connect_webview_device_selection_mode = z.enum([
     'multiple',
 ]);
 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(`
       ---
       undocumented: Unused. Will be removed.
@@ -26,16 +41,41 @@ export const connect_webview = z.object({
       deprecated: Unused. Will be removed.
       ---
       `),
-    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/lib/seam/connect/models/connect-webviews/connect-webview.js.map

@@ -1 +1 @@
-{"version":3,"file":"connect-webview.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/connect-webviews/connect-webview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAEvD,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM;IACN,QAAQ;IACR,UAAU;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,qBAAqB,EAAE,qCAAqC;IAE5D,wBAAwB;IACxB,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAEvC,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAC5C;;;;;OAKG,CACJ;IACD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CACtC;;;;;OAKG,CACJ;IAED,oBAAoB,EAAE,CAAC,CAAC,OAAO,EAAE;IACjC,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;IACnD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChD,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxD,eAAe;IACf,gCAAgC,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7C,wBAAwB,EAAE,CAAC,CAAC,OAAO,EAAE;IACrC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC/C,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;CAeX,CAAC,CAAA"}
+{"version":3,"file":"connect-webview.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/connect-webviews/connect-webview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAEvD,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM;IACN,QAAQ;IACR,UAAU;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC5E,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,gHAAgH,CACjH;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,kIAAkI,CACnI;IACH,GAAG,EAAE,CAAC;SACH,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,CACP,gGAAgG,CACjG;IACH,qBAAqB,EAAE,qCAAqC;IAE5D,wBAAwB;IACxB,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,qLAAqL,CACtL;IAEH,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAC5C;;;;;OAKG,CACJ;IACD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CACtC;;;;;OAKG,CACJ;IAED,oBAAoB,EAAE,CAAC;SACpB,OAAO,EAAE;SACT,QAAQ,CAAC,4CAA4C,CAAC;IACzD,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,CACP,8EAA8E,CAC/E;IACH,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;SACzC,QAAQ,CACP,0KAA0K,CAC3K;IACH,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,wPAAwP,CACzP;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,mFAAmF,CACpF;IACH,eAAe;IACf,gCAAgC,EAAE,CAAC;SAChC,OAAO,EAAE;SACT,QAAQ,CACP,oRAAoR,CACrR;IACH,wBAAwB,EAAE,CAAC;SACxB,OAAO,EAAE;SACT,QAAQ,CACP,6PAA6P,CAC9P;IACH,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;IACH,iBAAiB,EAAE,CAAC;SACjB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yNAAyN,CAC1N;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;CAeX,CAAC,CAAA"}

package/lib/seam/connect/models/custom-metadata.js

@@ -3,6 +3,9 @@ export const custom_metadata_input = z
     .record(z.string().max(40), z.union([z.string().max(500), z.boolean(), z.null()]))
     .refine((val) => Object.keys(val).length <= 50, {
     message: 'Custom metadata is limited to a maximum of 50 keys',
-});
-export const custom_metadata = z.record(z.string(), z.union([z.string(), z.boolean()]));
+})
+    .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()]))
+    .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.');
 //# sourceMappingURL=custom-metadata.js.map

package/lib/seam/connect/models/custom-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"custom-metadata.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/custom-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CACL,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAClB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CACtD;KACA,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE;IAC9C,OAAO,EAAE,oDAAoD;CAC9D,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CACrC,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CACnC,CAAA"}
+{"version":3,"file":"custom-metadata.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/models/custom-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CACL,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAClB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CACtD;KACA,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE;IAC9C,OAAO,EAAE,oDAAoD;CAC9D,CAAC;KACD,QAAQ,CACP,2oBAA2oB,CAC5oB,CAAA;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;KACtD,QAAQ,CACP,+gBAA+gB,CAChhB,CAAA"}