@seamapi/types 1.162.0 → 1.164.0

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

@@ -0,0 +1,349 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const device_event = common_event.extend({
+  device_id: z.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    ID of the device.
+  `),
+  connected_account_id: z.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `),
+})
+
+const battery_level = z.number().min(0).max(1).describe(`
+  ---
+  title: Battery Level
+  ---
+  Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.
+`)
+
+const device_battery_status = z.enum(['critical', 'low', 'good', 'full'])
+  .describe(`
+  ---
+  title: Battery Status
+  ---
+  Enum representing the battery status calculated from numeric battery_level value, one of 'critical' | 'low' | 'good' | 'full'
+`)
+
+const disconnection_error_code = z.enum([
+  'account_disconnected',
+  'hub_disconnected',
+  'device_disconnected',
+]).describe(`
+  ---
+  title: Event Error Code
+  ---
+  The error code associated with the event, if any.
+`)
+
+export const lock_method = z.enum(['keycode', 'manual', 'unknown', 'seamapi'])
+  .describe(`
+  ---
+  title: Lock Lock/Unlock Method
+  ---
+  Method by which a lock device was locked or unlocked. When the method is \`keycode\`, the \`access_code_id\` will reference the Seam access code which was used, if reported by the device.
+`)
+export type LockMethod = z.infer<typeof lock_method>
+
+export const device_connected_event = device_event
+  .extend({
+    event_type: z.literal('device.connected'),
+  })
+  .describe('A new device was connected to Seam.')
+
+export type DeviceConnectedEvent = z.infer<typeof device_connected_event>
+
+export const device_converted_to_unmanaged_event = device_event
+  .extend({
+    event_type: z.literal('device.converted_to_unmanaged'),
+  })
+  .describe(
+    'An unmanaged device was successfully converted to a managed device.',
+  )
+
+export type DeviceConvertedToUnmanagedEvent = z.infer<
+  typeof device_converted_to_unmanaged_event
+>
+
+export const unmanaged_device_converted_to_managed_event = device_event
+  .extend({
+    event_type: z.literal('device.unmanaged.converted_to_managed'),
+  })
+  .describe(
+    'A managed device was successfully converted to an unmanaged device.',
+  )
+
+export type UnmanagedDeviceConvertedToManagedEvent = z.infer<
+  typeof unmanaged_device_converted_to_managed_event
+>
+
+export const unmanaged_device_connected_event = device_event
+  .extend({
+    event_type: z.literal('device.unmanaged.connected'),
+  })
+  .describe('An unmanaged device was connected to Seam')
+
+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('A device was disconnected')
+
+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('An unmanaged device was disconnected')
+
+export type UnmanagedDeviceDisconnectedEvent = z.infer<
+  typeof unmanaged_device_disconnected_event
+>
+
+export const device_tampered_event = device_event
+  .extend({
+    event_type: z.literal('device.tampered'),
+  })
+  .describe(
+    'A device detected that it was tampered with, e.g., opened or moved.',
+  )
+
+export type DeviceTamperedEvent = z.infer<typeof device_tampered_event>
+
+export const device_low_battery_event = device_event
+  .extend({
+    event_type: z.literal('device.low_battery'),
+    battery_level,
+  })
+  .describe('A device battery level dropped below the low threshold.')
+
+export type DeviceLowBatteryEvent = z.infer<typeof device_low_battery_event>
+
+export const device_battery_status_changed_event = device_event
+  .extend({
+    event_type: z.literal('device.battery_status_changed'),
+    battery_status: device_battery_status,
+    battery_level,
+  })
+  .describe(
+    'A device battery status changed since the last battery status changed event.',
+  )
+
+export type DeviceBatteryStatusChangedEvent = z.infer<
+  typeof device_battery_status_changed_event
+>
+
+export const device_removed_event = device_event
+  .extend({
+    event_type: z.literal('device.removed'),
+  })
+  .describe('A device was removed externally from the connected account.')
+
+export type DeviceRemovedEvent = z.infer<typeof device_removed_event>
+
+export const device_deleted_event = device_event
+  .extend({
+    event_type: z.literal('device.deleted'),
+  })
+  .describe('A device was deleted.')
+
+export type DeviceDeletedEvent = z.infer<typeof device_deleted_event>
+
+export const device_third_party_integration_detected_event = device_event
+  .extend({
+    event_type: z.literal('device.third_party_integration_detected'),
+  })
+  .describe(
+    'Seam detected a device is using a third party integration that will interfere with Seam device management.',
+  )
+
+export type DeviceThirdPartyIntegrationDetectedEvent = z.infer<
+  typeof device_third_party_integration_detected_event
+>
+
+export const device_third_party_integration_no_longer_detected_event =
+  device_event
+    .extend({
+      event_type: z.literal(
+        'device.third_party_integration_no_longer_detected',
+      ),
+    })
+    .describe(
+      'Seam detected a device is no longer using a third party integration that was interfering with Seam device management.',
+    )
+
+export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer<
+  typeof device_third_party_integration_no_longer_detected_event
+>
+
+export const device_salto_privacy_mode_activated_event = device_event
+  .extend({
+    event_type: z.literal('device.salto.privacy_mode_activated'),
+  })
+  .describe('A Salto device activated privacy mode.')
+
+export type DeviceSaltoPrivacyModeActivatedEvent = z.infer<
+  typeof device_salto_privacy_mode_activated_event
+>
+
+export const device_salto_privacy_mode_deactivated_event = device_event
+  .extend({
+    event_type: z.literal('device.salto.privacy_mode_deactivated'),
+  })
+  .describe('A Salto device deactivated privacy mode.')
+
+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('Seam detected a flaky device connection.')
+
+export type DeviceConnectionBecameFlakyEvent = z.infer<
+  typeof device_connection_became_flaky_event
+>
+
+export const device_connection_stabilized_event = device_event
+  .extend({
+    event_type: z.literal('device.connection_stabilized'),
+  })
+  .describe('Seam detected a previously flaky device connection stabilized.')
+
+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(
+    'A third party subscription is required to use all device features.',
+  )
+
+export type DeviceErrorSubscriptionRequiredEvent = z.infer<
+  typeof device_error_subscription_required_event
+>
+
+export const device_error_subscription_required_resolved_event = device_event
+  .extend({
+    event_type: z.literal('device.error.subscription_required.resolved'),
+  })
+  .describe(
+    'A third party subscription is active or no longer-required to use all device features.',
+  )
+
+export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer<
+  typeof device_error_subscription_required_resolved_event
+>
+
+export const device_accessory_keypad_connected_event = device_event
+  .extend({
+    event_type: z.literal('device.accessory_keypad_connected'),
+  })
+  .describe('A accessory keypad was connected to a device.')
+
+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('A accessory keypad was disconnected to a device.')
+
+export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<
+  typeof device_accessory_keypad_disconnected_event
+>
+
+export const noise_sensor_noise_threshold_triggered_event = device_event
+  .extend({
+    event_type: z.literal('noise_sensor.noise_threshold_triggered'),
+    // TODO: import from ../devices
+    noiseaware_metadata: z.record(z.unknown()).optional().describe(`
+      ---
+      title: Noiseaware Metadata
+      ---
+      Metadata from the Noiseaware API.
+    `),
+    minut_metadata: z.record(z.unknown()).optional().describe(`
+      ---
+      title: Minut Metadata
+      ---
+      Metadata from the Minut API.
+    `),
+  })
+  .describe(
+    'Extended periods of noise or noise exceeding a threshold was detected.',
+  )
+
+export type NoiseSensorNoiseThresholdTriggeredEvent = z.infer<
+  typeof noise_sensor_noise_threshold_triggered_event
+>
+
+export const lock_locked_event = device_event
+  .extend({
+    event_type: z.literal('lock.locked'),
+    access_code_id: z.string().uuid().optional(),
+    action_attempt_id: z.string().uuid().optional(),
+    method: lock_method,
+  })
+  .describe('A lock was locked.')
+
+export type LockLockedEvent = z.infer<typeof lock_locked_event>
+
+export const lock_unlocked_event = device_event
+  .extend({
+    event_type: z.literal('lock.unlocked'),
+    access_code_id: z.string().uuid().optional(),
+    action_attempt_id: z.string().uuid().optional(),
+    method: lock_method,
+  })
+  .describe('A lock was unlocked.')
+
+export type LockUnlockedEvent = z.infer<typeof lock_unlocked_event>
+
+export const device_events = [
+  device_connected_event,
+  device_converted_to_unmanaged_event,
+  unmanaged_device_converted_to_managed_event,
+  unmanaged_device_connected_event,
+  device_disconnected_event,
+  unmanaged_device_disconnected_event,
+  device_tampered_event,
+  device_low_battery_event,
+  device_battery_status_changed_event,
+  device_removed_event,
+  device_deleted_event,
+  device_third_party_integration_detected_event,
+  device_third_party_integration_no_longer_detected_event,
+  device_salto_privacy_mode_activated_event,
+  device_salto_privacy_mode_deactivated_event,
+  device_connection_became_flaky_event,
+  device_connection_stabilized_event,
+  device_error_subscription_required_event,
+  device_error_subscription_required_resolved_event,
+  device_accessory_keypad_connected_event,
+  device_accessory_keypad_disconnected_event,
+  noise_sensor_noise_threshold_triggered_event,
+  lock_locked_event,
+  lock_unlocked_event,
+] as const

package/src/lib/seam/connect/models/events/enrollment-automations.ts

@@ -0,0 +1,26 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const enrollment_automation_event = common_event.extend({
+  enrollment_automation_id: z.string().uuid().describe(`
+    ---
+    title: Enrollment Automation ID
+    ---
+    ID of the enrollment automation.
+  `),
+})
+
+export const enrollment_automation_deleted_event = enrollment_automation_event
+  .extend({
+    event_type: z.literal('enrollment_automation.deleted'),
+  })
+  .describe('An enrollment automation was deleted.')
+
+export type EnrollmentAutomationDeletedEvent = z.infer<
+  typeof enrollment_automation_deleted_event
+>
+
+export const enrollment_automation_events = [
+  enrollment_automation_deleted_event,
+] as const

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

@@ -0,0 +1,8 @@
+export type * from './access-codes.js'
+export type * from './acs/index.js'
+export type * from './client-sessions.js'
+export type * from './connected-accounts.js'
+export type * from './devices.js'
+export type * from './enrollment-automations.js'
+export type * from './phones.js'
+export * from './seam-event.js'

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

@@ -0,0 +1,22 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const phone_event = common_event.extend({
+  device_id: z.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    ID of the device.
+  `),
+})
+
+export const phone_deactivated_event = phone_event
+  .extend({
+    event_type: z.literal('phone.deactivated'),
+  })
+  .describe('A phone device was deactivated.')
+
+export type PhoneDeactivatedEvent = z.infer<typeof phone_deactivated_event>
+
+export const phone_events = [phone_deactivated_event] as const

package/src/lib/seam/connect/models/events/seam-event.ts

@@ -0,0 +1,23 @@
+import * as z from 'zod'
+
+import { access_code_events } from './access-codes.js'
+import { acs_events } from './acs/index.js'
+import { client_session_events } from './client-sessions.js'
+import { connected_account_events } from './connected-accounts.js'
+import { device_events } from './devices.js'
+import { enrollment_automation_events } from './enrollment-automations.js'
+import { phone_events } from './phones.js'
+
+export const seam_event = z.discriminatedUnion('event_type', [
+  ...access_code_events,
+  ...acs_events,
+  ...client_session_events,
+  ...connected_account_events,
+  ...device_events,
+  ...enrollment_automation_events,
+  ...phone_events,
+])
+
+export type SeamEvent = z.infer<typeof seam_event>
+
+export type SeamEventType = SeamEvent['event_type']

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

@@ -4,6 +4,7 @@ export * from './capability-properties/index.js'
 export * from './connect-webviews/index.js'
 export * from './custom-metadata.js'
 export * from './devices/index.js'
+export * from './events/index.js'
 export * from './network.js'
 export * from './phone-number.js'
 export * from './user-identity.js'

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

@@ -224,6 +224,7 @@ export default {
           starts_at: { type: 'string' },
           visionline_metadata: {
             properties: {
+              card_function_type: { enum: ['guest', 'staff'], type: 'string' },
               common_acs_entrance_ids: {
                 items: { format: 'uuid', type: 'string' },
                 type: 'array',
@@ -237,6 +238,7 @@ export default {
                 type: 'array',
               },
             },
+            required: ['card_function_type'],
             type: 'object',
           },
           warnings: {
@@ -4367,11 +4369,21 @@ export default {
                         enum: ['TLCode', 'rfid48'],
                         type: 'string',
                       },
-                      is_override_key: { type: 'boolean' },
+                      card_function_type: {
+                        default: 'guest',
+                        enum: ['guest', 'staff'],
+                        type: 'string',
+                      },
+                      is_override_key: {
+                        description:
+                          '\n          ---\n          deprecated: use override.\n          ---\n        ',
+                        type: 'boolean',
+                      },
                       joiner_acs_credential_ids: {
                         items: { format: 'uuid', type: 'string' },
                         type: 'array',
                       },
+                      override: { type: 'boolean' },
                     },
                     type: 'object',
                   },
@@ -7881,6 +7893,8 @@ export default {
                       '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',
@@ -7938,6 +7952,8 @@ export default {
                         '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',

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

@@ -883,6 +883,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -909,7 +910,14 @@ export interface Routes {
               | string
               | undefined
             card_format?: ('TLCode' | 'rfid48') | undefined
+            card_function_type?: 'guest' | 'staff'
+            /**
+                  ---
+                  deprecated: use override.
+                  ---
+                 */
             is_override_key?: boolean | undefined
+            override?: boolean | undefined
             joiner_acs_credential_ids?: string[] | undefined
           }
         | undefined
@@ -951,6 +959,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -1013,6 +1022,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -1078,6 +1088,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -1130,6 +1141,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -1182,6 +1194,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -1325,6 +1338,7 @@ export interface Routes {
         is_multi_phone_sync_credential?: boolean | undefined
         visionline_metadata?:
           | {
+              card_function_type: 'guest' | 'staff'
               joiner_acs_credential_ids?: string[] | undefined
               guest_acs_entrance_ids?: string[] | undefined
               common_acs_entrance_ids?: string[] | undefined
@@ -4542,6 +4556,8 @@ export interface Routes {
             | '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'
@@ -4597,6 +4613,8 @@ export interface Routes {
             | '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'

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

@@ -1 +1 @@
-export { connect_webview, custom_metadata } from './models/index.js'
+export { connect_webview, custom_metadata, seam_event } from './models/index.js'

package/lib/seam/connect/models/events/access_code_events.d.ts

@@ -1,70 +0,0 @@
-import { z } from 'zod';
-export declare const access_code_event_map: {
-    access_code_created: z.ZodObject<{
-        event_type: z.ZodLiteral<"access_code.created">;
-        device_id: z.ZodString;
-        workspace_id: z.ZodString;
-        access_code_id: z.ZodString;
-        connected_account_id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        access_code_id: string;
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "access_code.created";
-    }, {
-        access_code_id: string;
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "access_code.created";
-    }>;
-    access_code_changed: z.ZodObject<{
-        event_type: z.ZodLiteral<"access_code.changed">;
-        device_id: z.ZodString;
-        workspace_id: z.ZodString;
-        access_code_id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        access_code_id: string;
-        device_id: string;
-        workspace_id: string;
-        event_type: "access_code.changed";
-    }, {
-        access_code_id: string;
-        device_id: string;
-        workspace_id: string;
-        event_type: "access_code.changed";
-    }>;
-    access_code_scheduled_on_device: z.ZodObject<{
-        event_type: z.ZodLiteral<"access_code.scheduled_on_device">;
-        device_id: z.ZodString;
-        connected_account_id: z.ZodString;
-        workspace_id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "access_code.scheduled_on_device";
-    }, {
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "access_code.scheduled_on_device";
-    }>;
-    backup_access_code_pulled: z.ZodObject<{
-        event_type: z.ZodLiteral<"backup_access_code.pulled">;
-        device_id: z.ZodString;
-        workspace_id: z.ZodString;
-        connected_account_id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "backup_access_code.pulled";
-    }, {
-        device_id: string;
-        workspace_id: string;
-        connected_account_id: string;
-        event_type: "backup_access_code.pulled";
-    }>;
-};

package/lib/seam/connect/models/events/access_code_events.js

@@ -1,33 +0,0 @@
-import { z } from 'zod';
-const access_code_created = z.object({
-    event_type: z.literal('access_code.created'),
-    device_id: z.string().uuid(),
-    workspace_id: z.string().uuid(),
-    access_code_id: z.string().uuid(),
-    connected_account_id: z.string().uuid(),
-});
-const access_code_changed = z.object({
-    event_type: z.literal('access_code.changed'),
-    device_id: z.string().uuid(),
-    workspace_id: z.string().uuid(),
-    access_code_id: z.string().uuid(),
-});
-const access_code_scheduled_on_device = z.object({
-    event_type: z.literal('access_code.scheduled_on_device'),
-    device_id: z.string().uuid(),
-    connected_account_id: z.string().uuid(),
-    workspace_id: z.string().uuid(),
-});
-const backup_access_code_pulled = z.object({
-    event_type: z.literal('backup_access_code.pulled'),
-    device_id: z.string().uuid(),
-    workspace_id: z.string().uuid(),
-    connected_account_id: z.string().uuid(),
-});
-export const access_code_event_map = {
-    access_code_created,
-    access_code_changed,
-    access_code_scheduled_on_device,
-    backup_access_code_pulled,
-};
-//# sourceMappingURL=access_code_events.js.map