@seamapi/types 1.724.0 → 1.725.0

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

@@ -9,6 +9,20 @@ const action_attempt_event = common_event.extend({
     .describe('ID of the affected action attempt.'),
   action_type: z.string().describe('Type of the action.'),
   status: z.string().describe('Status of the action.'),
+  device_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the device associated with the action attempt, if applicable.',
+    ),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the connected account associated with the action attempt, if applicable.',
+    ),
 })
 
 export const action_attempt_lock_door_succeeded_event =
@@ -51,9 +65,59 @@ export const action_attempt_unlock_door_failed_event =
     An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
   `)
 
+export const action_attempt_simulate_keypad_code_entry_succeeded_event =
+  action_attempt_event.extend({
+    event_type: z.literal(
+      'action_attempt.simulate_keypad_code_entry.succeeded',
+    ),
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A simulate keypad code entry [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
+  `)
+
+export const action_attempt_simulate_keypad_code_entry_failed_event =
+  action_attempt_event.extend({
+    event_type: z.literal('action_attempt.simulate_keypad_code_entry.failed'),
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A simulate keypad code entry [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
+  `)
+
+export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
+  action_attempt_event.extend({
+    event_type: z.literal(
+      'action_attempt.simulate_manual_lock_via_keypad.succeeded',
+    ),
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A simulate manual lock via keypad [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
+  `)
+
+export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
+  action_attempt_event.extend({
+    event_type: z.literal(
+      'action_attempt.simulate_manual_lock_via_keypad.failed',
+    ),
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A simulate manual lock via keypad [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
+  `)
+
 export const action_attempt_events = [
   action_attempt_lock_door_succeeded_event,
   action_attempt_lock_door_failed_event,
   action_attempt_unlock_door_succeeded_event,
   action_attempt_unlock_door_failed_event,
+  action_attempt_simulate_keypad_code_entry_succeeded_event,
+  action_attempt_simulate_keypad_code_entry_failed_event,
+  action_attempt_simulate_manual_lock_via_keypad_succeeded_event,
+  action_attempt_simulate_manual_lock_via_keypad_failed_event,
 ]

package/src/lib/seam/connect/models/events/common.ts

@@ -17,3 +17,34 @@ export const common_event = z.object({
     .datetime()
     .describe('Date and time at which the event occurred.'),
 })
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+const warning_code_description =
+  'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
+
+export const common_event_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+  error_code: z.string().describe(error_code_description),
+})
+
+export const common_event_warning = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the warning.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+    ),
+  warning_code: z.string().describe(warning_code_description),
+})

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

@@ -1,8 +1,11 @@
 import { z } from 'zod'
 
-import { connected_account_error } from '../connected-accounts/index.js'
 import { custom_metadata } from '../custom-metadata.js'
-import { common_event } from './common.js'
+import {
+  common_event,
+  common_event_error,
+  common_event_warning,
+} from './common.js'
 
 const connected_account_event = common_event.extend({
   connected_account_id: z
@@ -25,6 +28,15 @@ const connect_webview_id = z
     'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event.',
   )
 
+const connected_account_event_issue_properties = {
+  connected_account_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the connected account.'),
+  connected_account_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the connected account.'),
+}
+
 export const connected_account_connected_event = connected_account_event.extend(
   {
     event_type: z.literal('connected_account.connected'),
@@ -78,13 +90,11 @@ export type ConnectedAccountSuccessfulLoginEvent = z.infer<
   typeof connected_account_successful_login_event
 >
 
-export const connected_account_disconnected_event =
-  connected_account_event.extend({
+export const connected_account_disconnected_event = connected_account_event
+  .extend({
     event_type: z.literal('connected_account.disconnected'),
-    connected_account_errors: z
-      .array(connected_account_error)
-      .describe('Errors associated with the connected account.'),
-  }).describe(`
+  })
+  .extend(connected_account_event_issue_properties).describe(`
     ---
     route_path: /connected_accounts
     ---
@@ -149,9 +159,11 @@ export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
 >
 
 export const connected_account_reauthorization_requested_event =
-  connected_account_event.extend({
-    event_type: z.literal('connected_account.reauthorization_requested'),
-  }).describe(`
+  connected_account_event
+    .extend({
+      event_type: z.literal('connected_account.reauthorization_requested'),
+    })
+    .extend(connected_account_event_issue_properties).describe(`
     ---
     route_path: /connected_accounts
     ---

package/src/lib/seam/connect/models/events/devices.ts

@@ -2,7 +2,11 @@ import { z } from 'zod'
 
 import { custom_metadata } from '../custom-metadata.js'
 import { climate_setting } from '../thermostats/climate-preset.js'
-import { common_event } from './common.js'
+import {
+  common_event,
+  common_event_error,
+  common_event_warning,
+} from './common.js'
 
 const device_event = common_event.extend({
   device_id: z.string().uuid().describe('ID of the affected device.'),
@@ -12,6 +16,10 @@ const device_event = common_event.extend({
     .describe(
       'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
     ),
+  customer_key: z
+    .string()
+    .optional()
+    .describe('The customer key associated with the device, if any.'),
   device_custom_metadata: custom_metadata
     .optional()
     .describe(
@@ -42,6 +50,21 @@ const disconnection_error_code = z
   .enum(['account_disconnected', 'hub_disconnected', 'device_disconnected'])
   .describe('Error code associated with the disconnection event, if any.')
 
+const device_event_issue_properties = {
+  connected_account_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the connected account.'),
+  connected_account_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the connected account.'),
+  device_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the device.'),
+  device_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the device.'),
+}
+
 export const lock_method = z
   .enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
   .describe(
@@ -110,10 +133,12 @@ export type UnmanagedDeviceConnectedEvent = z.infer<
   typeof unmanaged_device_connected_event
 >
 
-export const device_disconnected_event = device_event.extend({
-  event_type: z.literal('device.disconnected'),
-  error_code: disconnection_error_code,
-}).describe(`
+export const device_disconnected_event = device_event
+  .extend({
+    event_type: z.literal('device.disconnected'),
+    error_code: disconnection_error_code,
+  })
+  .extend(device_event_issue_properties).describe(`
   ---
   route_path: /devices
   ---
@@ -122,10 +147,12 @@ export const device_disconnected_event = device_event.extend({
 
 export type DeviceDisconnectedEvent = z.infer<typeof device_disconnected_event>
 
-export const unmanaged_device_disconnected_event = device_event.extend({
-  event_type: z.literal('device.unmanaged.disconnected'),
-  error_code: disconnection_error_code,
-}).describe(`
+export const unmanaged_device_disconnected_event = device_event
+  .extend({
+    event_type: z.literal('device.unmanaged.disconnected'),
+    error_code: disconnection_error_code,
+  })
+  .extend(device_event_issue_properties).describe(`
   ---
   route_path: /devices/unmanaged
   ---
@@ -250,9 +277,11 @@ export type DeviceSaltoPrivacyModeDeactivatedEvent = z.infer<
   typeof device_salto_privacy_mode_deactivated_event
 >
 
-export const device_connection_became_flaky_event = device_event.extend({
-  event_type: z.literal('device.connection_became_flaky'),
-}).describe(`
+export const device_connection_became_flaky_event = device_event
+  .extend({
+    event_type: z.literal('device.connection_became_flaky'),
+  })
+  .extend(device_event_issue_properties).describe(`
   ---
   route_path: /devices
   ---
@@ -276,9 +305,11 @@ export type DeviceConnectionStabilizedEvent = z.infer<
   typeof device_connection_stabilized_event
 >
 
-export const device_error_subscription_required_event = device_event.extend({
-  event_type: z.literal('device.error.subscription_required'),
-}).describe(`
+export const device_error_subscription_required_event = device_event
+  .extend({
+    event_type: z.literal('device.error.subscription_required'),
+  })
+  .extend(device_event_issue_properties).describe(`
   ---
   route_path: /devices
   ---
@@ -316,9 +347,11 @@ export type DeviceAccessoryKeypadConnectedEvent = z.infer<
   typeof device_accessory_keypad_connected_event
 >
 
-export const device_accessory_keypad_disconnected_event = device_event.extend({
-  event_type: z.literal('device.accessory_keypad_disconnected'),
-}).describe(`
+export const device_accessory_keypad_disconnected_event = device_event
+  .extend({
+    event_type: z.literal('device.accessory_keypad_disconnected'),
+  })
+  .extend(device_event_issue_properties).describe(`
   ---
   route_path: /devices
   ---