@seamapi/types 1.914.0 → 1.916.0

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -118,15 +118,11 @@ const common_acs_access_group = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.',
-    ),
+    .describe('ID of the workspace that contains the access group.'),
   connected_account_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.',
-    ),
+    .describe('ID of the connected account that contains the access group.'),
   name: z.string().describe('Name of the access group.'),
   access_group_type: acs_access_group_external_type.describe(`
     ---

package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts

@@ -38,9 +38,7 @@ export const enrollment_automation = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation.',
-    ),
+    .describe('ID of the workspace that contains the enrollment automation.'),
 }).describe(`
   ---
   route_path: /user_identities/enrollment_automations

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -240,7 +240,7 @@ const common_acs_credential = z.object({
     .string()
     .uuid()
     .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
+      'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
     ),
   starts_at: z
     .string()

package/src/lib/seam/connect/models/acs/acs-encoder.ts

@@ -50,13 +50,13 @@ export const acs_encoder = z.object({
     .string()
     .uuid()
     .describe(
-      'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
+      'ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
     ),
   workspace_id: z
     .string()
     .uuid()
     .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
+      'ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
     ),
   errors: z
     .array(acs_encoder_error)

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -316,7 +316,7 @@ export const acs_system = z
       .string()
       .uuid()
       .describe(
-        'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+        'ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
       ),
     connected_account_ids: z.array(z.string().uuid()).describe(`
       ---
@@ -328,7 +328,7 @@ export const acs_system = z
       .string()
       .uuid()
       .describe(
-        'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+        'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
       ),
     image_url: z
       .string()

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -226,7 +226,7 @@ const common_acs_user = z
       .string()
       .uuid()
       .describe(
-        'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).',
+        'ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).',
       ),
     created_at: z
       .string()
@@ -311,7 +311,7 @@ const common_acs_user = z
         The last time an internal sync job completed for this access system user.
       `),
     connected_account_id: z.string().uuid().describe(`
-      The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
     `),
     salto_space_metadata: acs_user_salto_space_metadata
       .optional()

package/src/lib/seam/connect/models/bridges/bridge-connected-system.ts

@@ -33,9 +33,7 @@ export const bridge_connected_system = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired.',
-    ),
+    .describe('ID of the workspace with which Seam Bridge is paired.'),
   workspace_display_name: z
     .string()
     .describe(

package/src/lib/seam/connect/models/bridges/bridge.ts

@@ -5,9 +5,7 @@ export const bridge = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.',
-    ),
+    .describe('ID of the workspace that contains Seam Bridge.'),
   created_at: z
     .string()
     .datetime()

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

@@ -1,18 +1,11 @@
 import { z } from 'zod'
 
 export const client_session = z.object({
-  client_session_id: z
-    .string()
-    .uuid()
-    .describe(
-      'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
-    ),
+  client_session_id: z.string().uuid().describe('ID of the client session.'),
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
-    ),
+    .describe('ID of the workspace associated with the client session.'),
   created_at: z
     .string()
     .datetime()

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

@@ -14,9 +14,7 @@ export const connect_webview = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview.',
-    ),
+    .describe('ID of the workspace that contains the Connect Webview.'),
   created_at: z
     .string()
     .datetime()
@@ -26,7 +24,7 @@ export const connect_webview = z.object({
     .uuid()
     .nullable()
     .describe(
-      'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview.',
+      'ID of the connected account associated with the Connect Webview.',
     ),
   url: z
     .string()

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

@@ -7,9 +7,7 @@ export const customer = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer.',
-    ),
+    .describe('ID of the workspace associated with the customer.'),
   created_at: z
     .string()
     .datetime()

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

@@ -25,7 +25,7 @@ export const phone = z.object({
     .describe(`Display name of the phone. Defaults to \`nickname\` (if it is set) or \`properties.appearance.name\`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
   `),
   workspace_id: basePhoneDeviceSchema.shape.workspace_id
-    .describe(`ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone.
+    .describe(`ID of the workspace that contains the phone.
   `),
   created_at: basePhoneDeviceSchema.shape.created_at
     .describe(`Date and time at which the phone was created.

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

@@ -17,7 +17,7 @@ const access_code_event = common_event.extend({
     .string()
     .uuid()
     .describe(
-      'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
+      'ID of the connected account associated with the affected access code.',
     ),
   device_custom_metadata: custom_metadata
     .optional()
@@ -102,12 +102,16 @@ export type AccessCodeChangedEvent = z.infer<typeof access_code_changed_event>
 
 export const access_code_name_changed_event = access_code_event.extend({
   event_type: z.literal('access_code.name_changed'),
-  from: z.object({
-    name: z.string().nullable().describe('Previous name of the access code.'),
-  }),
-  to: z.object({
-    name: z.string().nullable().describe('New name of the access code.'),
-  }),
+  from: z
+    .object({
+      name: z.string().nullable().describe('Previous name of the access code.'),
+    })
+    .describe('Previous access code name configuration.'),
+  to: z
+    .object({
+      name: z.string().nullable().describe('New name of the access code.'),
+    })
+    .describe('New access code name configuration.'),
   description: z
     .string()
     .describe('Human-readable description of the change and its source.'),
@@ -124,12 +128,16 @@ export type AccessCodeNameChangedEvent = z.infer<
 
 export const access_code_code_changed_event = access_code_event.extend({
   event_type: z.literal('access_code.code_changed'),
-  from: z.object({
-    code: z.string().nullable().describe('Previous pin code.'),
-  }),
-  to: z.object({
-    code: z.string().nullable().describe('New pin code.'),
-  }),
+  from: z
+    .object({
+      code: z.string().nullable().describe('Previous pin code.'),
+    })
+    .describe('Previous pin code configuration.'),
+  to: z
+    .object({
+      code: z.string().nullable().describe('New pin code.'),
+    })
+    .describe('New pin code configuration.'),
   description: z
     .string()
     .describe('Human-readable description of the change and its source.'),
@@ -146,14 +154,18 @@ export type AccessCodeCodeChangedEvent = z.infer<
 
 export const access_code_time_frame_changed_event = access_code_event.extend({
   event_type: z.literal('access_code.time_frame_changed'),
-  from: z.object({
-    starts_at: z.string().nullable().describe('Previous start time.'),
-    ends_at: z.string().nullable().describe('Previous end time.'),
-  }),
-  to: z.object({
-    starts_at: z.string().nullable().describe('New start time.'),
-    ends_at: z.string().nullable().describe('New end time.'),
-  }),
+  from: z
+    .object({
+      starts_at: z.string().nullable().describe('Previous start time.'),
+      ends_at: z.string().nullable().describe('Previous end time.'),
+    })
+    .describe('Previous time frame configuration.'),
+  to: z
+    .object({
+      starts_at: z.string().nullable().describe('New start time.'),
+      ends_at: z.string().nullable().describe('New end time.'),
+    })
+    .describe('New time frame configuration.'),
   description: z
     .string()
     .describe('Human-readable description of the change and its source.'),

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

@@ -32,7 +32,7 @@ export const action_attempt_lock_door_succeeded_event =
     ---
     route_path: /action_attempts
     ---
-    A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
+    A lock door action attempt succeeded.
   `)
 
 export const action_attempt_lock_door_failed_event =
@@ -42,7 +42,7 @@ export const action_attempt_lock_door_failed_event =
     ---
     route_path: /action_attempts
     ---
-    A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
+    A lock door action attempt failed.
   `)
 
 export const action_attempt_unlock_door_succeeded_event =
@@ -52,7 +52,7 @@ export const action_attempt_unlock_door_succeeded_event =
     ---
     route_path: /action_attempts
     ---
-    An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
+    An unlock door action attempt succeeded.
   `)
 
 export const action_attempt_unlock_door_failed_event =
@@ -62,7 +62,7 @@ export const action_attempt_unlock_door_failed_event =
     ---
     route_path: /action_attempts
     ---
-    An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
+    An unlock door action attempt failed.
   `)
 
 export const action_attempt_simulate_keypad_code_entry_succeeded_event =
@@ -74,7 +74,7 @@ export const action_attempt_simulate_keypad_code_entry_succeeded_event =
     ---
     route_path: /action_attempts
     ---
-    A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
+    A simulate keypad code entry action attempt succeeded.
   `)
 
 export const action_attempt_simulate_keypad_code_entry_failed_event =
@@ -84,7 +84,7 @@ export const action_attempt_simulate_keypad_code_entry_failed_event =
     ---
     route_path: /action_attempts
     ---
-    A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
+    A simulate keypad code entry action attempt failed.
   `)
 
 export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
@@ -96,7 +96,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event =
     ---
     route_path: /action_attempts
     ---
-    A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.
+    A simulate manual lock via keypad action attempt succeeded.
   `)
 
 export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
@@ -108,7 +108,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_failed_event =
     ---
     route_path: /action_attempts
     ---
-    A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.
+    A simulate manual lock via keypad action attempt failed.
   `)
 
 export const action_attempt_events = [

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

@@ -15,7 +15,7 @@ export const client_session_deleted_event = client_session_event.extend({
     ---
     route_path: /client_sessions
     ---
-    A [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was deleted.
+    A client session was deleted.
   `)
 
 export type ClientSessionDeletedEvent = z.infer<

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

@@ -5,9 +5,7 @@ export const common_event = z.object({
   workspace_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
-    ),
+    .describe('ID of the workspace associated with the event.'),
   created_at: z
     .string()
     .datetime()

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

@@ -7,17 +7,13 @@ const connect_webview_event = common_event.extend({
   connect_webview_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).',
-    ),
+    .describe('ID of the affected Connect Webview.'),
 })
 
 const connected_account_id = z
   .string()
   .uuid()
-  .describe(
-    'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.',
-  )
+  .describe('ID of the connected account associated with the event.')
 
 const connected_account_custom_metadata = custom_metadata
   .optional()
@@ -40,7 +36,7 @@ export const connect_webview_login_succeeded_event =
     ---
     route_path: /connect_webviews
     ---
-    A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login succeeded.
+    A Connect Webview login succeeded.
   `)
 
 export type ConnectWebviewLoginSucceededEvent = z.infer<
@@ -53,7 +49,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({
     ---
     route_path: /connect_webviews
     ---
-    A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login failed.
+    A Connect Webview login failed.
   `)
 
 export type ConnectWebviewLoginFailedEvent = z.infer<

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

@@ -11,9 +11,7 @@ const connected_account_event = common_event.extend({
   connected_account_id: z
     .string()
     .uuid()
-    .describe(
-      'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).',
-    ),
+    .describe('ID of the affected connected account.'),
   connected_account_custom_metadata: custom_metadata
     .optional()
     .describe(
@@ -24,9 +22,7 @@ const connected_account_event = common_event.extend({
 const connect_webview_id = z
   .string()
   .uuid()
-  .describe(
-    'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.',
-  )
+  .describe('ID of the Connect Webview associated with the event.')
 
 const connected_account_event_issue_properties = {
   connected_account_errors: z
@@ -52,7 +48,7 @@ export const connected_account_connected_event = connected_account_event.extend(
   ---
   route_path: /connected_accounts
   ---
-  A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.
+  A connected account was connected for the first time or was reconnected after being disconnected.
 `)
 
 export type ConnectedAccountConnectedEvent = z.infer<
@@ -66,7 +62,7 @@ export const connected_account_created_event = connected_account_event.extend({
   ---
   route_path: /connected_accounts
   ---
-  A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was created.
+  A connected account was created.
 `)
 
 export type ConnectedAccountCreatedEvent = z.infer<
@@ -82,7 +78,7 @@ export const connected_account_successful_login_event =
     deprecated: Use \`connect_webview.login_succeeded\`.
     route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+    A connected account had a successful login using a Connect Webview.
   `)
 
 /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */
@@ -98,7 +94,7 @@ export const connected_account_disconnected_event = connected_account_event
     ---
     route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was disconnected.
+    A connected account was disconnected.
   `)
 
 export type ConnectedAccountDisconnectedEvent = z.infer<
@@ -112,7 +108,7 @@ export const connected_account_completed_first_sync_event =
     ---
     route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.
+    A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.
   `)
 
 export type ConnectedAccountCompletedFirstSyncEvent = z.infer<
@@ -135,7 +131,7 @@ export const connected_account_deleted_event = connected_account_event.extend({
   ---
   route_path: /connected_accounts
   ---
-  A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was deleted.
+  A connected account was deleted.
 `)
 
 export type ConnectedAccountDeletedEvent = z.infer<
@@ -151,7 +147,7 @@ export const connected_account_completed_first_sync_after_reconnection_event =
     ---
     route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
+    A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
   `)
 
 export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer<
@@ -167,7 +163,7 @@ export const connected_account_reauthorization_requested_event =
     ---
     route_path: /connected_accounts
     ---
-    A [connected account](https://docs.seam.co/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
+    A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
   `)
 
 export type ConnectedAccountReauthorizationRequestedEvent = z.infer<