@seamapi/types 1.163.0 → 1.164.0

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

@@ -3410,8 +3410,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' | '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' | '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') | 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;
             connected_account_id?: string | undefined;
             limit?: number;
         };

package/lib/seam/connect/schemas.d.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/schemas.js

@@ -1,2 +1,2 @@
-export { connect_webview, custom_metadata } from './models/index.js';
+export { connect_webview, custom_metadata, seam_event } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA"}

package/package.json

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

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

@@ -1 +1,6 @@
-export type { ConnectWebview, CustomMetadata } from './models/index.js'
+export type {
+  ConnectWebview,
+  CustomMetadata,
+  SeamEvent,
+  SeamEventType,
+} from './models/index.js'

package/src/lib/seam/connect/models/events/access-codes.ts

@@ -0,0 +1,233 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const access_code_event = common_event.extend({
+  access_code_id: z.string().uuid().describe(`
+    ---
+    title: Access Code ID
+    ---
+    The ID of the access code.
+  `),
+  device_id: z.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    The ID of the device.
+  `),
+  connected_account_id: z.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    The ID of the connected account.
+  `),
+})
+
+const code = z.string().describe(`
+  ---
+  title: Access Code
+  ---
+  The code of the access code.
+`)
+
+export const access_code_created_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.created'),
+  })
+  .describe('An access code was created.')
+
+export type AccessCodeCreatedEvent = z.infer<typeof access_code_created_event>
+
+export const access_code_changed_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.changed'),
+  })
+  .describe('An access code was changed.')
+
+export type AccessCodeChangedEvent = z.infer<typeof access_code_changed_event>
+
+export const access_code_scheduled_on_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.scheduled_on_device'),
+    code,
+  })
+  .describe('An access code was natively scheduled on a device.')
+
+export type AccessCodeScheduledOnDeviceEvent = z.infer<
+  typeof access_code_scheduled_on_device_event
+>
+
+export const access_code_set_on_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.set_on_device'),
+    code,
+  })
+  .describe('An access code was set on a device.')
+
+export type AccessCodeSetOnDeviceEvent = z.infer<
+  typeof access_code_set_on_device_event
+>
+
+export const access_code_removed_from_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.removed_from_device'),
+  })
+  .describe('An access code was removed from a device.')
+
+export type AccessCodeRemovedFromDeviceEvent = z.infer<
+  typeof access_code_removed_from_device_event
+>
+
+export const access_code_delay_in_setting_on_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.delay_in_setting_on_device'),
+  })
+  .describe(
+    'There was an unusually long delay in setting an access code on a device.',
+  )
+
+export type AccessCodeDelayInSettingOnDeviceEvent = z.infer<
+  typeof access_code_delay_in_setting_on_device_event
+>
+
+export const access_code_failed_to_set_on_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.failed_to_set_on_device'),
+  })
+  .describe('An access code failed to be set on a device.')
+
+export type AccessCodeFailedToSetOnDeviceEvent = z.infer<
+  typeof access_code_failed_to_set_on_device_event
+>
+
+export const access_code_deleted_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.deleted'),
+    code: code.nullable(),
+  })
+  .describe('An access code was deleted.')
+
+export type AccessCodeDeletedEvent = z.infer<typeof access_code_deleted_event>
+
+export const access_code_delay_in_removing_from_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.delay_in_removing_from_device'),
+  })
+  .describe(
+    'There was an unusually long delay in removing an access code from a device.',
+  )
+
+export type AccessCodeDelayInRemovingFromDeviceEvent = z.infer<
+  typeof access_code_delay_in_removing_from_device_event
+>
+
+export const access_code_failed_to_remove_from_device_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.failed_to_remove_from_device'),
+  })
+  .describe('An access code failed to be removed from a device.')
+
+export type AccessCodeFailedToRemoveFromDeviceEvent = z.infer<
+  typeof access_code_failed_to_remove_from_device_event
+>
+
+export const access_code_modified_external_to_seam_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.modified_external_to_seam'),
+  })
+  .describe('An access code was modified external to Seam.')
+
+export type AccessCodeModifiedExternalToSeamEvent = z.infer<
+  typeof access_code_modified_external_to_seam_event
+>
+
+export const access_code_deleted_external_to_seam_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.deleted_external_to_seam'),
+  })
+  .describe('An access code was deleted external to Seam.')
+
+export type AccessCodeDeletedExternalToSeamEvent = z.infer<
+  typeof access_code_deleted_external_to_seam_event
+>
+
+export const access_code_backup_access_code_pulled_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.backup_access_code_pulled'),
+    backup_access_code_id: z.string(),
+  })
+  .describe(
+    'A backup access code was pulled from the backup access code pool and set on a device.',
+  )
+
+export type AccessCodeBackupAccessCodePulledEvent = z.infer<
+  typeof access_code_backup_access_code_pulled_event
+>
+
+export const unmanaged_access_code_converted_to_managed_event =
+  access_code_event
+    .extend({
+      event_type: z.literal('access_code.unmanaged.converted_to_managed'),
+    })
+    .describe(
+      'An unmanaged access code was successfully converted to a managed access code.',
+    )
+
+export type UnmanagedAccessCodeConvertedToManagedEvent = z.infer<
+  typeof unmanaged_access_code_converted_to_managed_event
+>
+
+export const unmanaged_access_code_failed_to_convert_to_managed_event =
+  access_code_event
+    .extend({
+      event_type: z.literal(
+        'access_code.unmanaged.failed_to_convert_to_managed',
+      ),
+    })
+    .describe(
+      'An unmanaged access code failed to be converted to a managed access code.',
+    )
+
+export type UnmanagedAccessCodeFailedToConvertToManagedEvent = z.infer<
+  typeof unmanaged_access_code_failed_to_convert_to_managed_event
+>
+
+export const unmanaged_access_code_created_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.unmanaged.created'),
+  })
+  .describe('An unmanaged access code was created on a device.')
+
+export type UnmanagedAccessCodeCreatedEvent = z.infer<
+  typeof unmanaged_access_code_created_event
+>
+
+export const unmanaged_access_code_removed_event = access_code_event
+  .extend({
+    event_type: z.literal('access_code.unmanaged.removed'),
+  })
+  .describe('An unmanaged access code was removed from a device.')
+
+export type UnmanagedAccessCodeRemovedEvent = z.infer<
+  typeof unmanaged_access_code_removed_event
+>
+
+export const access_code_events = [
+  access_code_created_event,
+  access_code_changed_event,
+  access_code_scheduled_on_device_event,
+  access_code_set_on_device_event,
+  access_code_removed_from_device_event,
+  access_code_delay_in_setting_on_device_event,
+  access_code_failed_to_set_on_device_event,
+  access_code_deleted_event,
+  access_code_delay_in_removing_from_device_event,
+  access_code_failed_to_remove_from_device_event,
+  access_code_modified_external_to_seam_event,
+  access_code_deleted_external_to_seam_event,
+  access_code_backup_access_code_pulled_event,
+  unmanaged_access_code_converted_to_managed_event,
+  unmanaged_access_code_failed_to_convert_to_managed_event,
+  unmanaged_access_code_created_event,
+  unmanaged_access_code_removed_event,
+] as const

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

@@ -0,0 +1,18 @@
+import * as z from 'zod'
+
+import { common_event } from '../common.js'
+
+export const common_acs_event = common_event.extend({
+  connected_account_id: z.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `),
+  acs_system_id: z.string().uuid().describe(`
+    ---
+    title: ACS System ID
+    ---
+    ID of the ACS system.
+  `),
+})

package/src/lib/seam/connect/models/events/acs/credentials.ts

@@ -0,0 +1,19 @@
+import * as z from 'zod'
+
+import { common_acs_event } from './common.js'
+
+const acs_credential_event = common_acs_event.extend({
+  acs_credential_id: z.string().uuid(),
+})
+
+export const acs_credential_deleted_event = acs_credential_event
+  .extend({
+    event_type: z.literal('acs_credential.deleted'),
+  })
+  .describe('An ACS credential was deleted.')
+
+export type AcsCredentialDeletedEvent = z.infer<
+  typeof acs_credential_deleted_event
+>
+
+export const acs_credential_events = [acs_credential_deleted_event] as const

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

@@ -0,0 +1,7 @@
+import { acs_credential_events } from './credentials.js'
+import { acs_user_events } from './users.js'
+
+export const acs_events = [
+  ...acs_credential_events,
+  ...acs_user_events,
+] as const

package/src/lib/seam/connect/models/events/acs/users.ts

@@ -0,0 +1,17 @@
+import * as z from 'zod'
+
+import { common_acs_event } from './common.js'
+
+const acs_user_event = common_acs_event.extend({
+  acs_user_id: z.string().uuid(),
+})
+
+export const acs_user_deleted_event = acs_user_event
+  .extend({
+    event_type: z.literal('acs_user.deleted'),
+  })
+  .describe('An ACS user was deleted.')
+
+export type AcsUserDeletedEvent = z.infer<typeof acs_user_deleted_event>
+
+export const acs_user_events = [acs_user_deleted_event] as const

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

@@ -0,0 +1,24 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const client_session_event = common_event.extend({
+  client_session_id: z.string().uuid().describe(`
+    ---
+    title: Client Session ID
+    ---
+    ID of the client session.
+  `),
+})
+
+export const client_session_deleted_event = client_session_event
+  .extend({
+    event_type: z.literal('client_session.deleted'),
+  })
+  .describe('A client session was deleted.')
+
+export type ClientSessionDeletedEvent = z.infer<
+  typeof client_session_deleted_event
+>
+
+export const client_session_events = [client_session_deleted_event] as const

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

@@ -0,0 +1,22 @@
+import * as z from 'zod'
+
+export const common_event = z.object({
+  workspace_id: z.string().uuid().describe(`
+    ---
+    title: Workspace ID
+    ---
+    The ID of the workspace.
+  `),
+  created_at: z.string().datetime().describe(`
+    ---
+    title: Created At
+    ---
+    The time when the event was created.
+  `),
+  occurred_at: z.string().datetime().describe(`
+    ---
+    title: Occurred At
+    ---
+    The time when the event occurred.
+  `),
+})

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

@@ -0,0 +1,112 @@
+import * as z from 'zod'
+
+import { common_event } from './common.js'
+
+const connected_account_event = common_event.extend({
+  connected_account_id: z.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `),
+})
+
+const connect_webview_id = z.string().uuid().describe(`
+  ---
+  title: Connect Webview ID
+  ---
+  ID of the connect webview.
+`)
+
+export const connected_account_connected_event = connected_account_event
+  .extend({
+    event_type: z.literal('connected_account.connected'),
+    connect_webview_id,
+  })
+  .describe(
+    'A connected account was connected for the first time, was reconnected after being disconnected.',
+  )
+
+export type ConnectedAccountConnectedEvent = z.infer<
+  typeof connected_account_connected_event
+>
+
+export const connected_account_created_event = connected_account_event
+  .extend({
+    event_type: z.literal('connected_account.created'),
+    connect_webview_id,
+  })
+  .describe('A connected account was created.')
+
+export type ConnectedAccountCreatedEvent = z.infer<
+  typeof connected_account_created_event
+>
+
+export const connected_account_successful_login_event = connected_account_event
+  .extend({
+    event_type: z.literal('connected_account.successful_login'),
+    connect_webview_id,
+  })
+  .describe('A connected account had a successful connect webview login.')
+
+export type ConnectedAccountSuccessfulLoginEvent = z.infer<
+  typeof connected_account_successful_login_event
+>
+
+export const connected_account_disconnected_event = connected_account_event
+  .extend({
+    event_type: z.literal('connected_account.disconnected'),
+  })
+  .describe('A connected account was disconnected.')
+
+export type ConnectedAccountDisconnectedEvent = z.infer<
+  typeof connected_account_disconnected_event
+>
+
+export const connected_account_completed_first_sync_event =
+  connected_account_event
+    .extend({
+      event_type: z.literal('connected_account.completed_first_sync'),
+    })
+    .describe(
+      'A connected account completed the first sync with Seam and devices are now available.',
+    )
+
+export type ConnectedAccountCompletedFirstSyncEvent = z.infer<
+  typeof connected_account_completed_first_sync_event
+>
+
+export const connected_account_deleted_event = connected_account_event
+  .extend({
+    event_type: z.literal('connected_account.deleted'),
+  })
+  .describe('A connected account was deleted.')
+
+export type ConnectedAccountDeletedEvent = z.infer<
+  typeof connected_account_deleted_event
+>
+
+export const connected_account_completed_first_sync_after_reconnection_event =
+  connected_account_event
+    .extend({
+      event_type: z.literal(
+        'connected_account.completed_first_sync_after_reconnection',
+      ),
+    })
+    .describe(
+      'A connected account completed the first sync after reconnection with Seam and devices are now available.',
+    )
+
+export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
+  typeof connected_account_completed_first_sync_after_reconnection_event
+>
+
+export const connected_account_events = [
+  connected_account_connected_event,
+  connected_account_created_event,
+  connected_account_successful_login_event,
+  connected_account_disconnected_event,
+  connected_account_completed_first_sync_event,
+  connected_account_deleted_event,
+  connected_account_completed_first_sync_after_reconnection_event,
+] as const