@seamapi/types 1.416.1 → 1.417.0

package/src/lib/seam/connect/models/action-attempts/unlock-door.ts

@@ -6,30 +6,38 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('UNLOCK_DOOR')
+const action_type = z
+  .literal('UNLOCK_DOOR')
+  .describe('Action attempt to track the status of unlocking a door.')
 
-const error = z.object({
-  type: z.string(),
-  message: z.string(),
-})
+const error = z
+  .object({
+    type: z.string().describe('Type of the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error associated with the action.')
 
-const result = z.object({})
+const result = z.object({}).describe('Result of the action.')
 
 export const unlock_door_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Unlocking door.'),
+    .describe('Unlocking a door is pending.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Unlocking door succeeded.'),
+    .describe('Unlocking a door succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Unlocking door failed.'),
+    .describe('Unlocking a door failed.'),
 ])
 
 export type UnlockDoorActionAttempt = z.infer<typeof unlock_door_action_attempt>

package/src/lib/seam/connect/models/bridges/bridge-client-session.ts

@@ -1,8 +1,15 @@
 import { z } from 'zod'
 
 const common_bridge_client_session_error = z.object({
-  message: z.string(),
-  created_at: z.string().datetime(),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
 })
 
 const error_code_description =
@@ -16,25 +23,29 @@ export const bridge_lan_unreachable = common_bridge_client_session_error
     is_tailscale_proxy_reachable: z
       .boolean()
       .nullable()
-      .describe('Seam cannot reach the tailscale proxy'),
+      .describe('Indicates whether Seam can reach the Tailscale proxy.'),
     is_tailscale_proxy_socks_server_healthy: z
       .boolean()
       .nullable()
-      .describe("Tailscale proxy's SOCKS server is unhealthy"),
+      .describe(
+        "Indicates whether the Tailscale proxy's SOCKS server is healthy.",
+      ),
     can_tailscale_proxy_reach_tailscale_network: z
       .boolean()
       .nullable()
-      .describe('Tailscale proxy cannot reach the Tailscale network'),
+      .describe(
+        'Indicates whether the Tailscale proxy can reach the Tailscale network.',
+      ),
     can_tailscale_proxy_reach_bridge: z
       .boolean()
       .nullable()
-      .describe('Tailscale proxy cannot reach the bridge'),
+      .describe('Indicates whether the Tailscale proxy can reach Seam Bridge.'),
     is_bridge_socks_server_healthy: z
       .boolean()
       .nullable()
-      .describe("Bridge's SOCKS server is unhealthy"),
+      .describe("Indicates whether Seam Bridge's SOCKS server is healthy."),
   })
-  .describe("Seam cannot reach the bridge's LAN")
+  .describe("Indicates that Seam cannot reach Seam Bridge's LAN.")
 
 export const no_communication_from_bridge = common_bridge_client_session_error
   .extend({
@@ -42,14 +53,16 @@ export const no_communication_from_bridge = common_bridge_client_session_error
       .literal('no_communication_from_bridge')
       .describe(error_code_description),
   })
-  .describe('Bridge has stopped communicating with Seam')
+  .describe('Indicates that Seam Bridge has stopped communicating with Seam.')
 
 export const bridge_client_session_error = z
   .discriminatedUnion('error_code', [
     bridge_lan_unreachable,
     no_communication_from_bridge,
   ])
-  .describe('Error associated with the `bridge_client_session`.')
+  .describe(
+    'Indicates an error associated with the Seam Bridge client session.',
+  )
 
 export type BridgeClientSessionError = z.infer<
   typeof bridge_client_session_error
@@ -67,25 +80,71 @@ export type BridgeClientSessionErrorMap = z.infer<
 >
 
 export const bridge_client_session = z.object({
-  created_at: z.string().datetime(),
-  bridge_client_session_id: z.string().uuid(),
-  bridge_client_session_token: z.string(),
-  pairing_code: z.string().length(6),
-  pairing_code_expires_at: z.string().datetime(),
-  tailscale_hostname: z.string(),
-  tailscale_auth_key: z.string().nullable(),
-  bridge_client_name: z.string(),
-  bridge_client_time_zone: z.string(),
-  bridge_client_machine_identifier_key: z.string(),
-  errors: z.array(bridge_client_session_error),
-  telemetry_token: z.string().nullable(),
-  telemetry_token_expires_at: z.string().datetime().nullable(),
-  telemetry_url: z.string().nullable(),
+  created_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the Seam Bridge client session was created.',
+    ),
+  bridge_client_session_id: z
+    .string()
+    .uuid()
+    .describe('ID of the Seam Bridge client session.'),
+  bridge_client_session_token: z
+    .string()
+    .describe(
+      'Client session token associated with the Seam Bridge client session.',
+    ),
+  pairing_code: z
+    .string()
+    .length(6)
+    .describe(
+      'Pairing code for Seam Bridge. Use this code to pair Seam Bridge with your workspace.',
+    ),
+  pairing_code_expires_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the pairing code expires.'),
+  tailscale_hostname: z
+    .string()
+    .describe('Tailscale hostname for Seam Bridge.'),
+  tailscale_auth_key: z
+    .string()
+    .nullable()
+    .describe('Tailscale authorization key for Seam Bridge.'),
+  bridge_client_name: z.string().describe('Name of the Seam Bridge client.'),
+  bridge_client_time_zone: z
+    .string()
+    .describe('Time zone for the Seam Bridge client.'),
+  bridge_client_machine_identifier_key: z
+    .string()
+    .describe(
+      'Identifier key of the client machine for the Seam Bridge client.',
+    ),
+  errors: z
+    .array(bridge_client_session_error)
+    .describe('Errors associated with the Seam Bridge client session.'),
+  telemetry_token: z
+    .string()
+    .nullable()
+    .describe('Telemetry token for the Seam Bridge client session.'),
+  telemetry_token_expires_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe(
+      'Date and time at which the telemetry token for the Seam Bridge client session expires.',
+    ),
+  telemetry_url: z
+    .string()
+    .nullable()
+    .describe('Telemetry URL for the Seam Bridge client session.'),
 }).describe(`
   ---
   route_path: /seam/bridge/v1/bridge_client_sessions
-  undocumented: Seam Bridge Client only.
+  undocumented: Seam Bridge client only.
   ---
+  Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
 `)
 
 export type BridgeClientSession = z.infer<typeof bridge_client_session>

package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts

@@ -1,19 +1,52 @@
 import { z } from 'zod'
 
 export const bridge_connected_system = z.object({
-  bridge_id: z.string().uuid(),
-  bridge_created_at: z.string().datetime(),
-  connected_account_id: z.string().uuid(),
-  connected_account_created_at: z.string().datetime(),
-  acs_system_id: z.string().uuid(),
-  acs_system_display_name: z.string(),
-  workspace_id: z.string().uuid(),
-  workspace_display_name: z.string(),
+  bridge_id: z
+    .string()
+    .uuid()
+    .describe('ID of Seam Bridge connected to the access system.'),
+  bridge_created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam Bridge was created.'),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .describe('ID of the connected account associated with Seam Bridge.'),
+  connected_account_created_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the connected account associated with Seam Bridge was created.',
+    ),
+  acs_system_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.',
+    ),
+  acs_system_display_name: z
+    .string()
+    .describe(
+      'Display name for the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.',
+    ),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.',
+    ),
+  workspace_display_name: z
+    .string()
+    .describe(
+      'Display name for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.',
+    ),
 }).describe(`
   ---
   route_path: /seam/bridge/v1/bridge_connected_systems
-  undocumented: Seam Bridge Client only.
+  undocumented: Seam Bridge client only.
   ---
+  Represents an access system connected to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).
 `)
 
 export type BridgeConnectedSystem = z.infer<typeof bridge_connected_system>

package/src/lib/seam/connect/models/bridges/bridge.ts

@@ -1,13 +1,22 @@
 import { z } from 'zod'
 
 export const bridge = z.object({
-  bridge_id: z.string().uuid(),
-  workspace_id: z.string().uuid(),
-  created_at: z.string().datetime(),
+  bridge_id: z.string().uuid().describe('ID of Seam Bridge.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains Seam Bridge.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam Bridge was created.'),
 }).describe(`
 ---
 undocumented: Unreleased.
 route_path: /bridges
 ---
+Represents [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).
 `)
 export type Bridge = z.infer<typeof bridge>

package/src/lib/seam/connect/models/client-sessions/client-session.ts

@@ -1,20 +1,76 @@
 import { z } from 'zod'
 
 export const client_session = z.object({
-  client_session_id: z.string().uuid(),
-  workspace_id: z.string().uuid(),
-  created_at: z.string().datetime(),
-  expires_at: z.string().datetime(),
-  token: z.string(),
-  user_identifier_key: z.string().nullable(),
-  device_count: z.number(),
-  customer_id: z.string().uuid().optional(),
-  connected_account_ids: z.array(z.string().uuid()),
-  connect_webview_ids: z.array(z.string().uuid()),
-  user_identity_ids: z
+  client_session_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created.',
+    ),
+  expires_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires.',
+    ),
+  token: z
+    .string()
+    .describe(
+      'Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  user_identifier_key: z
+    .string()
+    .nullable()
+    .describe(
+      'Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  device_count: z
+    .number()
+    .describe(
+      'Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  customer_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  connected_account_ids: z
     .array(z.string().uuid())
-    .describe('deprecated: Use `user_identity_id`.'),
-  user_identity_id: z.string().uuid().optional(),
+    .describe(
+      'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  connect_webview_ids: z
+    .array(z.string().uuid())
+    .describe(
+      'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
+    ),
+  user_identity_ids: z.array(z.string().uuid()).describe(`
+    ---
+    deprecated: Use \`user_identity_id\` instead.
+    ---
+    IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
+  `),
+  user_identity_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.',
+    ),
 }).describe(`
   ---
   route_path: /client_sessions

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

@@ -6,18 +6,18 @@ export const connect_webview_device_selection_mode = z.enum([
   'none',
   'single',
   '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.
+  ---
+  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
 >
@@ -59,7 +59,7 @@ export const connect_webview = z.object({
   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.',
+      '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_devices: z.array(z.string()).describe(

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

@@ -21,7 +21,9 @@ const common_connected_account_error = z.object({
   is_bridge_error: z
     .boolean()
     .optional()
-    .describe('Indicates whether the error is related to Seam Bridge.'),
+    .describe(
+      'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
+    ),
 })
 
 const error_code_description =
@@ -48,7 +50,7 @@ export const account_disconnected = common_connected_account_error
       .literal('account_disconnected')
       .describe(error_code_description),
   })
-  .describe('Account is disconnected.')
+  .describe('Indicates that the account is disconnected.')
 
 export const invalid_credentials = common_connected_account_error
   .extend({
@@ -56,7 +58,7 @@ export const invalid_credentials = common_connected_account_error
       .literal('invalid_credentials')
       .describe(error_code_description),
   })
-  .describe('Credentials provided were invalid.')
+  .describe('Indicates that the credentials provided were invalid.')
 
 export const bridge_disconnected = common_connected_account_error
   .extend({
@@ -65,7 +67,7 @@ export const bridge_disconnected = common_connected_account_error
       .describe(error_code_description),
   })
   .describe(
-    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
+    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
   )
 
 export const salto_ks_subscription_limit_exceeded =
@@ -153,7 +155,7 @@ export const unknown_issue_with_connected_account =
         .describe(warning_code_description),
     })
     .describe(
-      'An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.',
+      'Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.',
     )
 
 const scheduled_maintenance_window = common_connected_account_warning
@@ -162,7 +164,9 @@ const scheduled_maintenance_window = common_connected_account_warning
       .literal('scheduled_maintenance_window')
       .describe(warning_code_description),
   })
-  .describe('Scheduled downtime planned for the connected account.')
+  .describe(
+    'Indicates that scheduled downtime is planned for the connected account.',
+  )
 
 const salto_ks_subscription_limit_almost_reached =
   common_connected_account_warning
@@ -245,7 +249,7 @@ export const connected_account = z.object({
     .string()
     .uuid()
     .optional()
-    .describe('Unique identifier for the connected account.'),
+    .describe('ID of the connected account.'),
   created_at: z
     .string()
     .datetime()
@@ -300,7 +304,7 @@ export const connected_account = z.object({
   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.',
+      '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 management by the Seam API.',
     ),
   customer_key: z
     .string()

package/src/lib/seam/connect/models/custom-metadata.ts

@@ -9,7 +9,7 @@ export const custom_metadata_input = z
     message: 'Custom metadata is limited to a maximum of 50 keys',
   })
   .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.',
+    '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

package/src/lib/seam/connect/models/devices/capability-properties/lock.ts

@@ -9,7 +9,8 @@ export const lock_capability_properties = z.object({
           `),
   keypad_battery: z
     .object({
-      level: z.number().describe(`Keypad battery charge level.
+      level: z.number().describe(`
+          Keypad battery charge level.
           `),
     })
     .optional().describe(`