@seamapi/types 1.423.3 → 1.424.0

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

@@ -21854,7 +21854,6 @@ export interface Routes {
                 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[];
@@ -21934,7 +21933,6 @@ export interface Routes {
                 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[];
@@ -21998,7 +21996,6 @@ export interface Routes {
                 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[];
@@ -22196,6 +22193,8 @@ export interface Routes {
                 automatically_manage_new_devices: boolean;
                 /** Your unique key for the customer associated with this connected account. */
                 customer_key?: string | undefined;
+                /** List of capabilities that were accepted during the account connection process. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
             };
         };
     };
@@ -22342,6 +22341,8 @@ export interface Routes {
                 automatically_manage_new_devices: boolean;
                 /** Your unique key for the customer associated with this connected account. */
                 customer_key?: string | undefined;
+                /** List of capabilities that were accepted during the account connection process. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
             }>;
             /** Information about the current page of results. */
             pagination: {
@@ -22507,6 +22508,8 @@ export interface Routes {
                 automatically_manage_new_devices: boolean;
                 /** Your unique key for the customer associated with this connected account. */
                 customer_key?: string | undefined;
+                /** List of capabilities that were accepted during the account connection process. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
             };
         };
     };

package/package.json

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

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

@@ -65,6 +65,7 @@ export {
   phone_session,
   portal_configuration,
   property_resource,
+  provider_capability,
   reservation_resource,
   resident_resource,
   room_resource,

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

@@ -1,26 +1,13 @@
 import { z } from 'zod'
 
 import { custom_metadata } from '../custom-metadata.js'
+import { provider_capability } from '../provider-capability.js'
 
 export const connect_webview_device_selection_mode = z.enum([
   'none',
   'single',
   'multiple',
-]).describe(`
-  ---
-  undocumented: Not implemented.
-  ---
-`)
-
-export const connect_webview_accepted_capabilities = z
-  .enum(['lock', 'thermostat', 'noise_sensor', 'access_control'])
-  .describe(
-    'High-level device capabilities that the Connect Webview can accept.',
-  )
-
-export type ConnectWebviewAcceptedCapabilities = z.infer<
-  typeof connect_webview_accepted_capabilities
->
+])
 
 export const connect_webview = z.object({
   connect_webview_id: z.string().uuid().describe('ID of the Connect Webview.'),
@@ -57,7 +44,7 @@ export const connect_webview = z.object({
     ),
 
   accepted_capabilities: z
-    .array(connect_webview_accepted_capabilities)
+    .array(provider_capability)
     .describe(
       '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`.',
     ),

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod'
 
 import { custom_metadata } from '../custom-metadata.js'
+import { provider_capability } from '../provider-capability.js'
 
 const common_connected_account_error = z.object({
   created_at: z
@@ -312,6 +313,11 @@ export const connected_account = z.object({
     .describe(
       'Your unique key for the customer associated with this connected account.',
     ),
+  accepted_capabilities: z
+    .array(provider_capability)
+    .describe(
+      'List of capabilities that were accepted during the account connection process.',
+    ),
 }).describe(`
   ---
   route_path: /connected_accounts

package/src/lib/seam/connect/models/devices/device-provider.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-import type { ConnectWebviewAcceptedCapabilities } from '../connect-webviews/index.js'
+import type { ProviderCapability } from '../provider-capability.js'
 import { device_capability_flags } from './device.js'
 
 export const DEVICE_PROVIDERS = {
@@ -149,7 +149,7 @@ export type DeviceProvider = z.infer<typeof device_provider>
 
 export const PROVIDER_CATEGORY_CAPABILITY_MAP: Record<
   ProviderCategory,
-  ConnectWebviewAcceptedCapabilities[]
+  ProviderCapability[]
 > = {
   stable: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
   consumer_smartlocks: ['lock'],

package/src/lib/seam/connect/models/index.ts

@@ -21,6 +21,7 @@ export * from './pagination.js'
 export * from './partner/index.js'
 export * from './phone-number.js'
 export * from './phones/index.js'
+export * from './provider-capability.js'
 export * from './spaces/index.js'
 export * from './thermostats/index.js'
 export * from './user-identities/index.js'

package/src/lib/seam/connect/models/provider-capability.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod'
+
+export const provider_capability = z.enum([
+  'lock',
+  'thermostat',
+  'noise_sensor',
+  'access_control',
+]).describe(`
+  High-level device capabilities that can be restricted in connect webviews.
+  These represent the main device categories that customers can opt into.
+`)
+
+export type ProviderCapability = z.infer<typeof provider_capability>

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

@@ -8714,7 +8714,7 @@ export default {
               '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`.',
             items: {
               description:
-                'High-level device capabilities that the Connect Webview can accept.',
+                '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
               enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
               type: 'string',
             },
@@ -8798,7 +8798,6 @@ export default {
           device_selection_mode: {
             enum: ['none', 'single', 'multiple'],
             type: 'string',
-            'x-undocumented': 'Not implemented.',
           },
           login_successful: {
             description:
@@ -8864,6 +8863,17 @@ export default {
         description:
           'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.',
         properties: {
+          accepted_capabilities: {
+            description:
+              'List of capabilities that were accepted during the account connection process.',
+            items: {
+              description:
+                '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
+              enum: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
+              type: 'string',
+            },
+            type: 'array',
+          },
           account_type: {
             description: 'Type of connected account.',
             type: 'string',
@@ -9279,6 +9289,7 @@ export default {
           'warnings',
           'custom_metadata',
           'automatically_manage_new_devices',
+          'accepted_capabilities',
         ],
         type: 'object',
         'x-route-path': '/connected_accounts',
@@ -34789,7 +34800,7 @@ export default {
                       'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.',
                     items: {
                       description:
-                        'High-level device capabilities that the Connect Webview can accept.',
+                        '\n  High-level device capabilities that can be restricted in connect webviews.\n  These represent the main device categories that customers can opt into.\n',
                       enum: [
                         'lock',
                         'thermostat',

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

@@ -24910,7 +24910,6 @@ export interface Routes {
         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[]
@@ -24992,7 +24991,6 @@ export interface Routes {
         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[]
@@ -25058,7 +25056,6 @@ export interface Routes {
         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[]
@@ -25271,6 +25268,10 @@ export interface Routes {
         automatically_manage_new_devices: boolean
         /** Your unique key for the customer associated with this connected account. */
         customer_key?: string | undefined
+        /** List of capabilities that were accepted during the account connection process. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
       }
     }
   }
@@ -25428,6 +25429,10 @@ export interface Routes {
         automatically_manage_new_devices: boolean
         /** Your unique key for the customer associated with this connected account. */
         customer_key?: string | undefined
+        /** List of capabilities that were accepted during the account connection process. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
       }>
       /** Information about the current page of results. */
       pagination: {
@@ -25604,6 +25609,10 @@ export interface Routes {
         automatically_manage_new_devices: boolean
         /** Your unique key for the customer associated with this connected account. */
         customer_key?: string | undefined
+        /** List of capabilities that were accepted during the account connection process. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
       }
     }
   }