@seamapi/types 1.409.1 → 1.410.1

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

@@ -19051,6 +19051,8 @@ export interface Routes {
             automatically_manage_new_devices?: boolean;
             /** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
             wait_for_device_creation?: boolean;
+            /** 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. */
+            accepted_capabilities?: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'> | undefined;
         };
         commonParams: {};
         formData: {};
@@ -19080,6 +19082,8 @@ export interface Routes {
                 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[];
+                /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
                 /**
                  * @deprecated Unused. Will be removed. */
                 accepted_devices: string[];
@@ -19157,6 +19161,8 @@ export interface Routes {
                 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[];
+                /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
                 /**
                  * @deprecated Unused. Will be removed. */
                 accepted_devices: string[];
@@ -19216,6 +19222,8 @@ export interface Routes {
                 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[];
+                /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+                accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
                 /**
                  * @deprecated Unused. Will be removed. */
                 accepted_devices: string[];
@@ -55181,7 +55189,7 @@ export interface Routes {
             heating_set_point_fahrenheit?: number | undefined;
             /** Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
              * @deprecated Use 'thermostat_schedule.is_override_allowed' */
-            manual_override_allowed: boolean;
+            manual_override_allowed?: boolean | undefined;
         };
         commonParams: {};
         formData: {};

package/package.json

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

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

@@ -8,6 +8,20 @@ export const connect_webview_device_selection_mode = z.enum([
   'multiple',
 ])
 
+export const connect_webview_accepted_capabilities = 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 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.'),
   workspace_id: z
@@ -42,6 +56,12 @@ export const connect_webview = z.object({
       '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_capabilities: z
+    .array(connect_webview_accepted_capabilities)
+    .describe(
+      'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.',
+    ),
+
   accepted_devices: z.array(z.string()).describe(
     `
       ---

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import type { ConnectWebviewAcceptedCapabilities } from '../connect-webviews/index.js'
 import { device_capability_flags } from './device.js'
 
 export const DEVICE_PROVIDERS = {
@@ -145,3 +146,15 @@ export const device_provider = z
   `)
 
 export type DeviceProvider = z.infer<typeof device_provider>
+
+export const PROVIDER_CATEGORY_CAPABILITY_MAP: Record<
+  ProviderCategory,
+  ConnectWebviewAcceptedCapabilities[]
+> = {
+  stable: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
+  consumer_smartlocks: ['lock'],
+  thermostats: ['thermostat'],
+  noise_sensors: ['noise_sensor'],
+  access_control_systems: ['access_control'],
+  internal_beta: ['lock', 'thermostat', 'noise_sensor', 'access_control'],
+}

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

@@ -7186,6 +7186,17 @@ export default {
         description:
           'Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo 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.',
         properties: {
+          accepted_capabilities: {
+            description:
+              'List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview.',
+            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',
+          },
           accepted_devices: {
             deprecated: true,
             items: { type: 'string' },
@@ -7308,6 +7319,7 @@ export default {
           'url',
           'device_selection_mode',
           'accepted_providers',
+          'accepted_capabilities',
           'accepted_devices',
           'any_device_allowed',
           'any_provider_allowed',
@@ -28645,6 +28657,22 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  accepted_capabilities: {
+                    description:
+                      '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:
+                        '\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',
+                  },
                   accepted_providers: {
                     description:
                       'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
@@ -37407,11 +37435,7 @@ export default {
                     type: 'string',
                   },
                 },
-                required: [
-                  'device_id',
-                  'climate_preset_key',
-                  'manual_override_allowed',
-                ],
+                required: ['device_id', 'climate_preset_key'],
                 type: 'object',
               },
             },
@@ -37517,11 +37541,7 @@ export default {
                     type: 'string',
                   },
                 },
-                required: [
-                  'device_id',
-                  'climate_preset_key',
-                  'manual_override_allowed',
-                ],
+                required: ['device_id', 'climate_preset_key'],
                 type: 'object',
               },
             },

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

@@ -22096,6 +22096,10 @@ export interface Routes {
       automatically_manage_new_devices?: boolean
       /** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
       wait_for_device_creation?: boolean
+      /** 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. */
+      accepted_capabilities?:
+        | Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>
+        | undefined
     }
     commonParams: {}
     formData: {}
@@ -22125,6 +22129,10 @@ export interface Routes {
         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[]
+        /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
         /**
          * @deprecated Unused. Will be removed. */
         accepted_devices: string[]
@@ -22202,6 +22210,10 @@ export interface Routes {
         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[]
+        /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
         /**
          * @deprecated Unused. Will be removed. */
         accepted_devices: string[]
@@ -22261,6 +22273,10 @@ export interface Routes {
         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[]
+        /** List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. */
+        accepted_capabilities: Array<
+          'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
+        >
         /**
          * @deprecated Unused. Will be removed. */
         accepted_devices: string[]
@@ -64936,7 +64952,7 @@ export interface Routes {
       heating_set_point_fahrenheit?: number | undefined
       /** Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
        * @deprecated Use 'thermostat_schedule.is_override_allowed' */
-      manual_override_allowed: boolean
+      manual_override_allowed?: boolean | undefined
     }
     commonParams: {}
     formData: {}