@seamapi/types 1.326.0 → 1.328.0

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/index.ts

@@ -1,3 +1,4 @@
+import { acs_access_group_events } from './access_groups.js'
 import { acs_credential_events } from './credentials.js'
 import { acs_encoder_events } from './encoders.js'
 import { acs_system_events } from './systems.js'
@@ -8,4 +9,5 @@ export const acs_events = [
   ...acs_credential_events,
   ...acs_user_events,
   ...acs_encoder_events,
+  ...acs_access_group_events,
 ] as const

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

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

@@ -18,26 +18,29 @@ const connected_account_id = z
     'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
   )
 
-export const connect_webview_login_succeeded_event = connect_webview_event
-  .extend({
+export const connect_webview_login_succeeded_event =
+  connect_webview_event.extend({
     event_type: z.literal('connect_webview.login_succeeded'),
     connected_account_id,
-  })
-  .describe(
-    'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.',
-  )
+  }).describe(`
+    ---
+    route_path: /connect_webviews
+    ---
+    A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.
+  `)
 
 export type ConnectWebviewLoginSucceededEvent = z.infer<
   typeof connect_webview_login_succeeded_event
 >
 
-export const connect_webview_login_failed_event = connect_webview_event
-  .extend({
-    event_type: z.literal('connect_webview.login_failed'),
-  })
-  .describe(
-    'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.',
-  )
+export const connect_webview_login_failed_event = connect_webview_event.extend({
+  event_type: z.literal('connect_webview.login_failed'),
+}).describe(`
+    ---
+    route_path: /connect_webviews
+    ---
+    A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.
+  `)
 
 export type ConnectWebviewLoginFailedEvent = z.infer<
   typeof connect_webview_login_failed_event

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

@@ -18,27 +18,31 @@ const connect_webview_id = z
     'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
   )
 
-export const connected_account_connected_event = connected_account_event
-  .extend({
+export const connected_account_connected_event = connected_account_event.extend(
+  {
     event_type: z.literal('connected_account.connected'),
     connect_webview_id,
-  })
-  .describe(
-    'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.',
-  )
+  },
+).describe(`
+  ---
+  route_path: /connected_accounts
+  ---
+  A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or 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](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.',
-  )
+export const connected_account_created_event = connected_account_event.extend({
+  event_type: z.literal('connected_account.created'),
+  connect_webview_id,
+}).describe(`
+  ---
+  route_path: /connected_accounts
+  ---
+  A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.
+`)
 
 export type ConnectedAccountCreatedEvent = z.infer<
   typeof connected_account_created_event
@@ -51,61 +55,68 @@ export const connected_account_successful_login_event =
   }).describe(`
     ---
     deprecated: Use \`connect_webview.login_succeeded\`.
+    route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).`)
+    A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).
+  `)
 
 /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */
 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'),
-  })
-  .describe(
-    'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.',
-  )
+  }).describe(`
+    ---
+    route_path: /connected_accounts
+    ---
+    A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) 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](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.',
-    )
+  connected_account_event.extend({
+    event_type: z.literal('connected_account.completed_first_sync'),
+  }).describe(`
+    ---
+    route_path: /connected_accounts
+    ---
+    A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems 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](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.',
-  )
+export const connected_account_deleted_event = connected_account_event.extend({
+  event_type: z.literal('connected_account.deleted'),
+}).describe(`
+  ---
+  route_path: /connected_accounts
+  ---
+  A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) 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](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.',
-    )
+  connected_account_event.extend({
+    event_type: z.literal(
+      'connected_account.completed_first_sync_after_reconnection',
+    ),
+  }).describe(`
+    ---
+    route_path: /connected_accounts
+    ---
+    A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
+  `)
 
 export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
   typeof connected_account_completed_first_sync_after_reconnection_event