@seamapi/types 1.327.0 → 1.329.0

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

@@ -29,207 +29,229 @@ const code = z
     'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
   )
 
-export const access_code_created_event = access_code_event
-  .extend({
-    event_type: z.literal('access_code.created'),
-  })
-  .describe(
-    'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.',
-  )
+export const access_code_created_event = access_code_event.extend({
+  event_type: z.literal('access_code.created'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.',
-  )
+export const access_code_changed_event = access_code_event.extend({
+  event_type: z.literal('access_code.changed'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.',
-  )
+export const access_code_scheduled_on_device_event = access_code_event.extend({
+  event_type: z.literal('access_code.scheduled_on_device'),
+  code,
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.',
-  )
+export const access_code_set_on_device_event = access_code_event.extend({
+  event_type: z.literal('access_code.set_on_device'),
+  code,
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.',
-  )
+export const access_code_removed_from_device_event = access_code_event.extend({
+  event_type: z.literal('access_code.removed_from_device'),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.',
-  )
+export const access_code_deleted_event = access_code_event.extend({
+  event_type: z.literal('access_code.deleted'),
+  code: code.nullable(),
+}).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of 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({
+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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.',
-  )
+  }).describe(`
+    ---
+    route_path: /access_codes
+    ---
+    A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.',
-    )
+  access_code_event.extend({
+    event_type: z.literal('access_code.unmanaged.converted_to_managed'),
+  }).describe(`
+      ---
+      route_path: /access_codes/unmanaged
+      ---
+      An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.',
-    )
+  access_code_event.extend({
+    event_type: z.literal('access_code.unmanaged.failed_to_convert_to_managed'),
+  }).describe(`
+      ---
+      route_path: /access_codes/unmanaged
+      ---
+      An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.',
-  )
+export const unmanaged_access_code_created_event = access_code_event.extend({
+  event_type: z.literal('access_code.unmanaged.created'),
+}).describe(`
+    ---
+    route_path: /access_codes/unmanaged
+    ---
+    An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.',
-  )
+export const unmanaged_access_code_removed_event = access_code_event.extend({
+  event_type: z.literal('access_code.unmanaged.removed'),
+}).describe(`
+    ---
+    route_path: /access_codes/unmanaged
+    ---
+    An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.
+  `)
 
 export type UnmanagedAccessCodeRemovedEvent = z.infer<
   typeof unmanaged_access_code_removed_event

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

@@ -6,11 +6,14 @@ const acs_access_group_event = common_acs_event.extend({
   acs_access_group_id: z.string().uuid(),
 })
 
-export const acs_access_group_deleted_event = acs_access_group_event
-  .extend({
-    event_type: z.literal('acs_access_group.deleted'),
-  })
-  .describe('An ACS access group was deleted.')
+export const acs_access_group_deleted_event = acs_access_group_event.extend({
+  event_type: z.literal('acs_access_group.deleted'),
+}).describe(`
+  ---
+  route_path: /acs/access_groups
+  ---
+  An ACS access group was deleted.
+`)
 
 export type AcsAccessGroupDeletedEvent = z.infer<
   typeof acs_access_group_deleted_event

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

@@ -6,27 +6,38 @@ 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](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.',
-  )
+export const acs_credential_deleted_event = acs_credential_event.extend({
+  event_type: z.literal('acs_credential.deleted'),
+}).describe(`
+    ---
+    route_path: /acs/credentials
+    ---
+    An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.
+  `)
 
 export type AcsCredentialDeletedEvent = z.infer<
   typeof acs_credential_deleted_event
 >
 
-export const acs_credential_issued = acs_credential_event
+export const acs_credential_issued = acs_credential_event.extend({
+  event_type: z.literal('acs_credential.issued'),
+}).describe(`
+    ---
+    route_path: /acs/credentials
+    ---
+    An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.
+  `)
+
+export const acs_credential_reissued = acs_credential_event
   .extend({
-    event_type: z.literal('acs_credential.issued'),
+    event_type: z.literal('acs_credential.reissued'),
   })
   .describe(
-    'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.',
+    'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was reissued.',
   )
 
 export const acs_credential_events = [
   acs_credential_deleted_event,
   acs_credential_issued,
+  acs_credential_reissued,
 ] as const

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

@@ -11,23 +11,25 @@ const acs_encoder_event = common_acs_event.extend({
     ),
 })
 
-export const acs_encoder_added_event = acs_encoder_event
-  .extend({
-    event_type: z.literal('acs_encoder.added'),
-  })
-  .describe(
-    'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.',
-  )
+export const acs_encoder_added_event = acs_encoder_event.extend({
+  event_type: z.literal('acs_encoder.added'),
+}).describe(`
+    ---
+    route_path: /acs/encoders
+    ---
+    An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.
+  `)
 
 export type AcsEncoderAddedEvent = z.infer<typeof acs_encoder_added_event>
 
-export const acs_encoder_removed_event = acs_encoder_event
-  .extend({
-    event_type: z.literal('acs_encoder.removed'),
-  })
-  .describe(
-    'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.',
-  )
+export const acs_encoder_removed_event = acs_encoder_event.extend({
+  event_type: z.literal('acs_encoder.removed'),
+}).describe(`
+    ---
+    route_path: /acs/encoders
+    ---
+    An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.
+  `)
 
 export type AcsEncoderRemovedEvent = z.infer<typeof acs_encoder_removed_event>
 

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

@@ -4,35 +4,38 @@ import { common_acs_event } from './common.js'
 
 const acs_system_event = common_acs_event.extend({})
 
-export const acs_system_connected_event = acs_system_event
-  .extend({
-    event_type: z.literal('acs_system.connected'),
-  })
-  .describe(
-    'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
-  )
+export const acs_system_connected_event = acs_system_event.extend({
+  event_type: z.literal('acs_system.connected'),
+}).describe(`
+    ---
+    route_path: /acs/systems
+    ---
+    An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
+  `)
 
 export type AcsSystemConnectedEvent = z.infer<typeof acs_system_connected_event>
 
-export const acs_system_disconnected_event = acs_system_event
-  .extend({
-    event_type: z.literal('acs_system.disconnected'),
-  })
-  .describe(
-    'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.',
-  )
+export const acs_system_disconnected_event = acs_system_event.extend({
+  event_type: z.literal('acs_system.disconnected'),
+}).describe(`
+    ---
+    route_path: /acs/systems
+    ---
+    An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
+  `)
 
 export type AcsSystemDisconnectedEvent = z.infer<
   typeof acs_system_disconnected_event
 >
 
-export const acs_system_added_event = acs_system_event
-  .extend({
-    event_type: z.literal('acs_system.added'),
-  })
-  .describe(
-    'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.',
-  )
+export const acs_system_added_event = acs_system_event.extend({
+  event_type: z.literal('acs_system.added'),
+}).describe(`
+    ---
+    route_path: /acs/systems
+    ---
+    An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
+  `)
 
 export type AcsSystemAddedEvent = z.infer<typeof acs_system_added_event>
 

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

@@ -10,13 +10,14 @@ const acs_user_event = common_acs_event
     'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
   )
 
-export const acs_user_deleted_event = acs_user_event
-  .extend({
-    event_type: z.literal('acs_user.deleted'),
-  })
-  .describe(
-    'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
-  )
+export const acs_user_deleted_event = acs_user_event.extend({
+  event_type: z.literal('acs_user.deleted'),
+}).describe(`
+    ---
+    route_path: /acs/users
+    ---
+    An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
+  `)
 
 export type AcsUserDeletedEvent = z.infer<typeof acs_user_deleted_event>
 

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

@@ -13,37 +13,45 @@ const action_attempt_event = common_event.extend({
   status: z.string().describe('Status of the action.'),
 })
 
-export const action_attempt_lock_door_succeeded_event = action_attempt_event
-  .extend({
+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](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
-  )
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
+  `)
 
-export const action_attempt_lock_door_failed_event = action_attempt_event
-  .extend({
+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](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
-  )
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
+  `)
 
-export const action_attempt_unlock_door_succeeded_event = action_attempt_event
-  .extend({
+export const action_attempt_unlock_door_succeeded_event =
+  action_attempt_event.extend({
     event_type: z.literal('action_attempt.unlock_door.succeeded'),
-  })
-  .describe(
-    'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
-  )
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
+  `)
 
-export const action_attempt_unlock_door_failed_event = action_attempt_event
-  .extend({
+export const action_attempt_unlock_door_failed_event =
+  action_attempt_event.extend({
     event_type: z.literal('action_attempt.unlock_door.failed'),
-  })
-  .describe(
-    'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
-  )
+  }).describe(`
+    ---
+    route_path: /action_attempts
+    ---
+    An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
+  `)
 
 export const action_attempt_events = [
   action_attempt_lock_door_succeeded_event,

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

@@ -11,13 +11,14 @@ const client_session_event = common_event.extend({
     ),
 })
 
-export const client_session_deleted_event = client_session_event
-  .extend({
-    event_type: z.literal('client_session.deleted'),
-  })
-  .describe(
-    'A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.',
-  )
+export const client_session_deleted_event = client_session_event.extend({
+  event_type: z.literal('client_session.deleted'),
+}).describe(`
+    ---
+    route_path: /client_sessions
+    ---
+    A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.
+  `)
 
 export type ClientSessionDeletedEvent = z.infer<
   typeof client_session_deleted_event