@seamapi/types 1.462.0 → 1.463.0

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

@@ -13249,6 +13249,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -13282,6 +13283,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -13473,7 +13475,7 @@ export interface Routes {
       /** ID of the Access Grant to update. */
       access_grant_id: string
       /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-      starts_at?: (string | null) | undefined
+      starts_at?: string | undefined
       /** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
       ends_at?: (string | null) | undefined
     }
@@ -16762,6 +16764,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -16795,6 +16798,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -19474,6 +19478,55 @@ export interface Routes {
               can_unlock_with_code?: boolean | undefined
             }>
           | undefined
+        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[]
+              /** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
+              accepted_capabilities: Array<
+                'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+              >
+              /**
+               * @deprecated Unused. Will be removed. */
+              accepted_devices: string[]
+              /**
+               * @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
+              /** The customer key associated with this webview, if any. */
+              customer_key?: string | undefined
+            }>
+          | undefined
       }
     }
   }
@@ -25667,6 +25720,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -25700,6 +25754,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -25843,6 +25898,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -25876,6 +25932,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -26019,6 +26076,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -26052,6 +26110,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -31058,6 +31117,7 @@ export interface Routes {
             | 'sensi'
             | 'kwikset2'
             | 'keynest'
+            | 'dormakaba_ambiance'
             | 'yale_access'
             | 'hid_cm'
             | 'google_nest'
@@ -35725,6 +35785,7 @@ export interface Routes {
           | 'sensi'
           | 'kwikset2'
           | 'keynest'
+          | 'dormakaba_ambiance'
         display_name: string
         image_url: string
         provider_categories: Array<
@@ -64068,6 +64129,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -64101,6 +64163,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -86557,6 +86620,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -86590,6 +86654,7 @@ export interface Routes {
               | 'assa_abloy_credential_service'
               | 'latch_building'
               | 'dormakaba_community_site'
+              | 'dormakaba_ambiance_site'
               | 'legic_connect_credential_service'
               | 'assa_abloy_vostio'
               | 'assa_abloy_vostio_credential_service'
@@ -88960,6 +89025,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -88993,6 +89059,7 @@ export interface Routes {
                     | 'assa_abloy_credential_service'
                     | 'latch_building'
                     | 'dormakaba_community_site'
+                    | 'dormakaba_ambiance_site'
                     | 'legic_connect_credential_service'
                     | 'assa_abloy_vostio'
                     | 'assa_abloy_vostio_credential_service'
@@ -91672,6 +91739,55 @@ export interface Routes {
               can_unlock_with_code?: boolean | undefined
             }>
           | undefined
+        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[]
+              /** High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`. */
+              accepted_capabilities: Array<
+                'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+              >
+              /**
+               * @deprecated Unused. Will be removed. */
+              accepted_devices: string[]
+              /**
+               * @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
+              /** The customer key associated with this webview, if any. */
+              customer_key?: string | undefined
+            }>
+          | undefined
       }
     }
   }