@seamapi/types 1.165.0 → 1.167.0

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

@@ -1123,6 +1123,10 @@ export interface Routes {
                     door_type: string;
                     is_connected: boolean;
                 } | null;
+                errors: Array<{
+                    error_code: string;
+                    message: string;
+                }>;
                 visionline_metadata: {
                     door_name: string;
                     door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
@@ -1168,6 +1172,10 @@ export interface Routes {
                     door_type: string;
                     is_connected: boolean;
                 } | null;
+                errors: Array<{
+                    error_code: string;
+                    message: string;
+                }>;
                 visionline_metadata: {
                     door_name: string;
                     door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
@@ -1483,6 +1491,10 @@ export interface Routes {
                     door_type: string;
                     is_connected: boolean;
                 } | null;
+                errors: Array<{
+                    error_code: string;
+                    message: string;
+                }>;
                 visionline_metadata: {
                     door_name: string;
                     door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
@@ -3390,6 +3402,11 @@ export interface Routes {
                 event_id: string;
                 device_id?: string | undefined;
                 action_attempt_id?: string | undefined;
+                acs_credential_id?: string | undefined;
+                acs_user_id?: string | undefined;
+                acs_system_id?: string | undefined;
+                client_session_id?: string | undefined;
+                enrollment_automation_id?: string | undefined;
                 event_type: string;
                 workspace_id: string;
                 created_at: string;
@@ -3410,8 +3427,8 @@ export interface Routes {
             device_ids?: string[] | undefined;
             access_code_id?: string | undefined;
             access_code_ids?: string[] | undefined;
-            event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted') | undefined;
-            event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted'> | undefined;
+            event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed') | undefined;
+            event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.deleted' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed'> | undefined;
             connected_account_id?: string | undefined;
             limit?: number;
         };
@@ -3421,6 +3438,11 @@ export interface Routes {
                 event_id: string;
                 device_id?: string | undefined;
                 action_attempt_id?: string | undefined;
+                acs_credential_id?: string | undefined;
+                acs_user_id?: string | undefined;
+                acs_system_id?: string | undefined;
+                client_session_id?: string | undefined;
+                enrollment_automation_id?: string | undefined;
                 event_type: string;
                 workspace_id: string;
                 created_at: string;

package/package.json

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

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

@@ -13,6 +13,12 @@ export const acs_entrance = z.object({
   acs_system_id: z.string().uuid(),
   created_at: z.string().datetime(),
   latch_metadata: acs_entrance_latch_metadata.nullable(),
+  errors: z.array(
+    z.object({
+      error_code: z.string(),
+      message: z.string(),
+    }),
+  ),
   visionline_metadata: z
     .object({
       door_name: z.string(),

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

@@ -0,0 +1,36 @@
+import { z } from 'zod'
+
+import { common_event } from './common.js'
+
+const action_attempt_event = common_event.extend({
+  action_attempt_id: z.string().uuid().describe(`
+    ---
+    title: Action Attempt ID
+    ---
+    The ID of the action attempt.
+  `),
+  action_type: z.string().describe(`
+    ---
+    title: Action Type
+    ---
+    The type of action.
+  `),
+  status: z.string().describe(`
+    ---
+    title: Status
+    ---
+    The status of the action.
+  `),
+})
+
+export const action_attempt_lock_door_succeeded_event = action_attempt_event
+  .extend({
+    event_type: z.literal('action_attempt.lock_door.succeeded'),
+  })
+  .describe('A lock door action attempt succeeded.')
+
+export const action_attempt_lock_door_failed_event = action_attempt_event
+  .extend({
+    event_type: z.literal('action_attempt.lock_door.failed'),
+  })
+  .describe('A lock door action attempt failed.')

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

@@ -1,5 +1,6 @@
 export type * from './access-codes.js'
 export type * from './acs/index.js'
+export type * from './action-attempts.js'
 export type * from './client-sessions.js'
 export type * from './connected-accounts.js'
 export type * from './devices.js'

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

@@ -313,6 +313,17 @@ export default {
           acs_system_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
           display_name: { type: 'string' },
+          errors: {
+            items: {
+              properties: {
+                error_code: { type: 'string' },
+                message: { type: 'string' },
+              },
+              required: ['error_code', 'message'],
+              type: 'object',
+            },
+            type: 'array',
+          },
           latch_metadata: {
             nullable: true,
             properties: {
@@ -371,6 +382,7 @@ export default {
           'acs_system_id',
           'created_at',
           'latch_metadata',
+          'errors',
           'visionline_metadata',
         ],
         type: 'object',
@@ -2085,9 +2097,14 @@ export default {
       },
       event: {
         properties: {
+          acs_credential_id: { format: 'uuid', type: 'string' },
+          acs_system_id: { format: 'uuid', type: 'string' },
+          acs_user_id: { format: 'uuid', type: 'string' },
           action_attempt_id: { format: 'uuid', type: 'string' },
+          client_session_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
           device_id: { format: 'uuid', type: 'string' },
+          enrollment_automation_id: { format: 'uuid', type: 'string' },
           event_id: { format: 'uuid', type: 'string' },
           event_type: { type: 'string' },
           occurred_at: { format: 'date-time', type: 'string' },
@@ -7927,6 +7944,8 @@ export default {
                       'acs_credential.deleted',
                       'enrollment_automation.deleted',
                       'client_session.deleted',
+                      'action_attempt.lock_door.succeeded',
+                      'action_attempt.lock_door.failed',
                     ],
                     type: 'string',
                   },
@@ -7986,6 +8005,8 @@ export default {
                         'acs_credential.deleted',
                         'enrollment_automation.deleted',
                         'client_session.deleted',
+                        'action_attempt.lock_door.succeeded',
+                        'action_attempt.lock_door.failed',
                       ],
                       type: 'string',
                     },

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

@@ -1224,6 +1224,10 @@ export interface Routes {
           door_type: string
           is_connected: boolean
         } | null
+        errors: Array<{
+          error_code: string
+          message: string
+        }>
         visionline_metadata: {
           door_name: string
           door_category:
@@ -1276,6 +1280,10 @@ export interface Routes {
           door_type: string
           is_connected: boolean
         } | null
+        errors: Array<{
+          error_code: string
+          message: string
+        }>
         visionline_metadata: {
           door_name: string
           door_category:
@@ -1683,6 +1691,10 @@ export interface Routes {
           door_type: string
           is_connected: boolean
         } | null
+        errors: Array<{
+          error_code: string
+          message: string
+        }>
         visionline_metadata: {
           door_name: string
           door_category:
@@ -4514,6 +4526,11 @@ export interface Routes {
             event_id: string
             device_id?: string | undefined
             action_attempt_id?: string | undefined
+            acs_credential_id?: string | undefined
+            acs_user_id?: string | undefined
+            acs_system_id?: string | undefined
+            client_session_id?: string | undefined
+            enrollment_automation_id?: string | undefined
             event_type: string
             workspace_id: string
             created_at: string
@@ -4590,6 +4607,8 @@ export interface Routes {
             | 'acs_credential.deleted'
             | 'enrollment_automation.deleted'
             | 'client_session.deleted'
+            | 'action_attempt.lock_door.succeeded'
+            | 'action_attempt.lock_door.failed'
           )
         | undefined
       event_types?:
@@ -4647,6 +4666,8 @@ export interface Routes {
             | 'acs_credential.deleted'
             | 'enrollment_automation.deleted'
             | 'client_session.deleted'
+            | 'action_attempt.lock_door.succeeded'
+            | 'action_attempt.lock_door.failed'
           >
         | undefined
       connected_account_id?: string | undefined
@@ -4658,6 +4679,11 @@ export interface Routes {
         event_id: string
         device_id?: string | undefined
         action_attempt_id?: string | undefined
+        acs_credential_id?: string | undefined
+        acs_user_id?: string | undefined
+        acs_system_id?: string | undefined
+        client_session_id?: string | undefined
+        enrollment_automation_id?: string | undefined
         event_type: string
         workspace_id: string
         created_at: string