@seamapi/types 1.423.4 → 1.425.0

package/package.json

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

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

@@ -14,6 +14,7 @@ export {
   acs_credential_pool_external_type,
   acs_credential_provisioning_automation,
   acs_entrance,
+  acs_entrance_capability_flags,
   acs_system,
   acs_system_capability_flags,
   acs_system_external_type,
@@ -65,6 +66,7 @@ export {
   phone_session,
   portal_configuration,
   property_resource,
+  provider_capability,
   reservation_resource,
   resident_resource,
   room_resource,

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -142,6 +142,12 @@ const common_acs_credential = z.object({
     .describe(
       'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
     ),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
+    ),
   acs_credential_pool_id: z.string().uuid().optional(),
   acs_system_id: z
     .string()

package/src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -9,85 +9,108 @@ import {
 } from './metadata/index.js'
 import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js'
 
-export const acs_entrance = z.object({
-  acs_system_id: z
-    .string()
-    .uuid()
-    .describe(
-      'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  acs_entrance_id: z
-    .string()
-    .uuid()
-    .describe(
-      'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  created_at: z
-    .string()
-    .datetime()
-    .describe(
-      'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
-    ),
-  display_name: z
-    .string()
-    .describe(
-      'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  connected_account_id: z
-    .string()
-    .uuid()
-    .describe(
-      'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  errors: z
-    .array(
-      z.object({
-        error_code: z
-          .string()
-          .describe(
-            'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-          ),
-        message: z
-          .string()
-          .describe(
-            'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
-          ),
-      }),
-    )
-    .describe(
-      'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  latch_metadata: acs_entrance_latch_metadata
-    .optional()
-    .describe(
-      'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  visionline_metadata: acs_entrance_visionline_metadata
+export const acs_entrance_capability_flags = z.object({
+  can_unlock_with_mobile_key: z
+    .boolean()
     .optional()
     .describe(
-      'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
     ),
-  salto_ks_metadata: acs_entrance_salto_ks_metadata
+  can_unlock_with_card: z
+    .boolean()
     .optional()
     .describe(
-      'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      'Indicates whether the ACS entrance can be unlocked with card credentials.',
     ),
-  dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata
+  can_unlock_with_code: z
+    .boolean()
     .optional()
     .describe(
-      'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      'Indicates whether the ACS entrance can be unlocked with pin codes.',
     ),
-  assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata
-    .optional()
-    .describe(
-      'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-  salto_space_metadata: acs_entrance_salto_space_metadata
-    .optional()
-    .describe(
-      'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
-    ),
-}).describe(`
+})
+
+export const acs_entrance = z
+  .object({
+    acs_system_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    acs_entrance_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    created_at: z
+      .string()
+      .datetime()
+      .describe(
+        'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
+      ),
+    display_name: z
+      .string()
+      .describe(
+        'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    connected_account_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    errors: z
+      .array(
+        z.object({
+          error_code: z
+            .string()
+            .describe(
+              'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+            ),
+          message: z
+            .string()
+            .describe(
+              'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+            ),
+        }),
+      )
+      .describe(
+        'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    latch_metadata: acs_entrance_latch_metadata
+      .optional()
+      .describe(
+        'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    visionline_metadata: acs_entrance_visionline_metadata
+      .optional()
+      .describe(
+        'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    salto_ks_metadata: acs_entrance_salto_ks_metadata
+      .optional()
+      .describe(
+        'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata
+      .optional()
+      .describe(
+        'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata
+      .optional()
+      .describe(
+        'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+    salto_space_metadata: acs_entrance_salto_space_metadata
+      .optional()
+      .describe(
+        'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
+  })
+  .merge(acs_entrance_capability_flags).describe(`
   ---
   route_path: /acs/entrances
   ---

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -1,6 +1,9 @@
 import { z } from 'zod'
 
-export const acs_system_capability_flags = z.object({})
+export const acs_system_capability_flags = z.object({
+  // Access method type capability flags are not publicly exposed for ACS systems
+  // They are only available for ACS entrances
+})
 
 export const acs_location = z.object({
   time_zone: z

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>