@seamapi/types 1.416.1 → 1.417.0

package/src/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.ts

@@ -1,26 +1,73 @@
 import { z } from 'zod'
 
-export const acs_entrance_assa_abloy_vostio_metadata = z.object({
-  door_type: z.enum(['CommonDoor', 'EntranceDoor', 'GuestDoor', 'Elevator']),
-  door_name: z.string(),
-  door_number: z.number().optional(),
-  stand_open: z.boolean().optional(),
-  pms_id: z.string().optional(),
-})
+export const acs_entrance_assa_abloy_vostio_metadata = z
+  .object({
+    door_type: z
+      .enum(['CommonDoor', 'EntranceDoor', 'GuestDoor', 'Elevator'])
+      .describe('Type of the door in the Vostio access system.'),
+    door_name: z
+      .string()
+      .describe('Name of the door in the Vostio access system.'),
+    door_number: z
+      .number()
+      .optional()
+      .describe('Number of the door in the Vostio access system.'),
+    stand_open: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.',
+      ),
+    pms_id: z
+      .string()
+      .optional()
+      .describe('PMS ID of the door in the Vostio access system.'),
+  })
+  .describe('ASSA ABLOY Vostio-specific metadata associated with the entrance.')
 
 export type AcsEntranceAssaAbloyVostioMetadata = z.infer<
   typeof acs_entrance_assa_abloy_vostio_metadata
 >
 
-export const acs_credential_vostio_metadata = z.object({
-  // auto_join does not exist in the Vostio API and is an abstraction made by Seam
-  auto_join: z.boolean().optional(),
-  override_guest_acs_entrance_ids: z.string().array().optional(),
-  key_id: z.string().optional(),
-  key_issuing_request_id: z.string().optional(),
-  door_names: z.string().array().optional(),
-  endpoint_id: z.string().optional(),
-})
+export const acs_credential_vostio_metadata = z
+  .object({
+    // auto_join does not exist in the Vostio API and is an abstraction made by Seam
+    auto_join: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.',
+      ),
+    override_guest_acs_entrance_ids: z
+      .string()
+      .array()
+      .optional()
+      .describe(
+        'IDs of the guest entrances to override in the Vostio access system.',
+      ),
+    key_id: z
+      .string()
+      .optional()
+      .describe('Key ID in the Vostio access system.'),
+    key_issuing_request_id: z
+      .string()
+      .optional()
+      .describe('Key issuing request ID in the Vostio access system.'),
+    door_names: z
+      .string()
+      .array()
+      .optional()
+      .describe(
+        'Names of the doors to which to grant access in the Vostio access system.',
+      ),
+    endpoint_id: z
+      .string()
+      .optional()
+      .describe('Endpoint ID in the Vostio access system.'),
+  })
+  .describe(
+    'ASSA ABLOY Vostio-specific metadata associated with the credential.',
+  )
 
 export type AcsCredentialVostioMetadata = z.infer<
   typeof acs_credential_vostio_metadata

package/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts

@@ -1,8 +1,16 @@
 import { z } from 'zod'
 
-export const acs_entrance_dormakaba_community_metadata = z.object({
-  access_point_name: z.string(),
-})
+export const acs_entrance_dormakaba_community_metadata = z
+  .object({
+    access_point_name: z
+      .string()
+      .describe(
+        'Name of the access point in the dormakaba Community access system.',
+      ),
+  })
+  .describe(
+    'dormakaba Community-specific metadata associated with the entrance.',
+  )
 
 export type AcsEntranceDormakabaCommunityMetadata = z.infer<
   typeof acs_entrance_dormakaba_community_metadata

package/src/lib/seam/connect/models/acs/metadata/latch.ts

@@ -1,11 +1,21 @@
 import { z } from 'zod'
 
-export const acs_entrance_latch_metadata = z.object({
-  accessibility_type: z.string(),
-  door_name: z.string(),
-  door_type: z.string(),
-  is_connected: z.boolean(),
-})
+export const acs_entrance_latch_metadata = z
+  .object({
+    accessibility_type: z
+      .string()
+      .describe('Accessibility type in the Latch access system.'),
+    door_name: z
+      .string()
+      .describe('Name of the door in the Latch access system.'),
+    door_type: z
+      .string()
+      .describe('Type of the door in the Latch access system.'),
+    is_connected: z
+      .boolean()
+      .describe('Indicates whether the entrance is connected.'),
+  })
+  .describe('Latch-specific metadata associated with the entrance.')
 
 export type AcsEntranceLatchMetadata = z.infer<
   typeof acs_entrance_latch_metadata

package/src/lib/seam/connect/models/acs/metadata/salto-space.ts

@@ -1,10 +1,19 @@
 import { z } from 'zod'
 
-export const acs_entrance_salto_space_metadata = z.object({
-  door_name: z.string(),
-  ext_door_id: z.string(),
-  door_description: z.string().optional(),
-})
+export const acs_entrance_salto_space_metadata = z
+  .object({
+    door_name: z
+      .string()
+      .describe('Name of the door in the Salto Space access system.'),
+    ext_door_id: z
+      .string()
+      .describe('External door ID in the Salto Space access system.'),
+    door_description: z
+      .string()
+      .optional()
+      .describe('Description of the door in the Salto Space access system.'),
+  })
+  .describe('Salto Space-specific metadata associated with the entrance.')
 
 export type AcsEntranceSaltoSpaceMetadata = z.infer<
   typeof acs_entrance_salto_space_metadata

package/src/lib/seam/connect/models/acs/metadata/salto.ts

@@ -1,15 +1,37 @@
 import { z } from 'zod'
 
-export const acs_entrance_salto_ks_metadata = z.object({
-  door_name: z.string(),
-  locked_state: z.string(),
-  lock_type: z.string(),
-  online: z.boolean().optional(),
-  battery_level: z.string(),
-  left_open_alarm: z.boolean().optional(),
-  intrusion_alarm: z.boolean().optional(),
-  privacy_mode: z.boolean().optional(),
-})
+export const acs_entrance_salto_ks_metadata = z
+  .object({
+    door_name: z
+      .string()
+      .describe('Name of the door in the Salto KS access system.'),
+    locked_state: z
+      .string()
+      .describe('Locked state of the door in the Salto KS access system.'),
+    lock_type: z
+      .string()
+      .describe('Type of the lock in the Salto KS access system.'),
+    online: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether the door access device is online.'),
+    battery_level: z
+      .string()
+      .describe('Battery level of the door access device.'),
+    left_open_alarm: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether the door is left open.'),
+    intrusion_alarm: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether an intrusion alarm is active on the door.'),
+    privacy_mode: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether privacy mode is enabled for the lock.'),
+  })
+  .describe('Salto KS-specific metadata associated with the entrance.')
 
 export type AcsEntranceSaltoKSMetadata = z.infer<
   typeof acs_entrance_salto_ks_metadata

package/src/lib/seam/connect/models/acs/metadata/visionline.ts

@@ -1,34 +1,66 @@
 import { z } from 'zod'
 
-export const acs_entrance_visionline_metadata = z.object({
-  door_name: z.string(),
-  door_category: z.enum([
-    'entrance',
-    'guest',
-    'elevator reader',
-    'common',
-    'common (PMS)',
-  ]),
-  profiles: z
-    .array(
-      z.object({
-        visionline_door_profile_id: z.string(),
-        visionline_door_profile_type: z.enum(['BLE', 'commonDoor', 'touch']),
-      }),
-    )
-    .optional(),
-})
+export const acs_entrance_visionline_metadata = z
+  .object({
+    door_name: z
+      .string()
+      .describe('Name of the door in the Visionline access system.'),
+    door_category: z
+      .enum(['entrance', 'guest', 'elevator reader', 'common', 'common (PMS)'])
+      .describe('Category of the door in the Visionline access system.'),
+    profiles: z
+      .array(
+        z.object({
+          visionline_door_profile_id: z
+            .string()
+            .describe('Door profile ID in the Visionline access system.'),
+          visionline_door_profile_type: z
+            .enum(['BLE', 'commonDoor', 'touch'])
+            .describe('Door profile type in the Visionline access system.'),
+        }),
+      )
+      .optional()
+      .describe('Profile for the door in the Visionline access system.'),
+  })
+  .describe('Visionline-specific metadata associated with the entrance.')
 
-export const acs_credential_visionline_metadata = z.object({
-  card_function_type: z.enum(['guest', 'staff']),
-  joiner_acs_credential_ids: z.array(z.string().uuid()).optional(),
-  guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
-  common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
-  is_valid: z.boolean().optional(),
-  auto_join: z.boolean().optional(),
-  card_id: z.string().optional(),
-  credential_id: z.string().optional(),
-})
+export const acs_credential_visionline_metadata = z
+  .object({
+    card_function_type: z
+      .enum(['guest', 'staff'])
+      .describe('Card function type in the Visionline access system.'),
+    joiner_acs_credential_ids: z
+      .array(z.string().uuid())
+      .optional()
+      .describe('IDs of the credentials to which you want to join.'),
+    guest_acs_entrance_ids: z
+      .array(z.string().uuid())
+      .optional()
+      .describe('Guest entrance IDs in the Visionline access system.'),
+    common_acs_entrance_ids: z
+      .array(z.string().uuid())
+      .optional()
+      .describe('Common entrance IDs in the Visionline access system.'),
+    is_valid: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether the credential is valid.'),
+    auto_join: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.',
+      ),
+    card_id: z
+      .string()
+      .optional()
+      .describe('ID of the card in the Visionline access system.'),
+    credential_id: z
+      .string()
+      .optional()
+      .describe('ID of the credential in the Visionline access system.'),
+  })
+  .describe('Visionline-specific metadata associated with the credential.')
 
 export type AcsCredentialVisionlineMetadata = z.infer<
   typeof acs_credential_visionline_metadata

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

@@ -32,6 +32,11 @@ export const action_attempt = z.union([
   ---
   route_path: /action_attempts
   ---
+  Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
+  
+  When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
+
+  See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
 `)
 
 export type ActionAttempt = z.infer<typeof action_attempt>

package/src/lib/seam/connect/models/action-attempts/activate-climate-preset.ts

@@ -6,14 +6,24 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('ACTIVATE_CLIMATE_PRESET')
+const action_type = z
+  .literal('ACTIVATE_CLIMATE_PRESET')
+  .describe(
+    'Action attempt to track the status of a climate preset activation.',
+  )
 
-const error = z.object({
-  type: z.string(),
-  message: z.string(),
-})
+const error = z
+  .object({
+    type: z.string().describe('Type of the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error associated with the action.')
 
-const result = z.object({})
+const result = z.object({}).describe('Result of the action.')
 
 export const activate_climate_preset_action_attempt = z.discriminatedUnion(
   'status',
@@ -22,15 +32,15 @@ export const activate_climate_preset_action_attempt = z.discriminatedUnion(
       .extend({
         action_type,
       })
-      .describe('Activating climate preset.'),
+      .describe('Activating a climate preset is pending.'),
     common_succeeded_action_attempt
       .extend({
         action_type,
         result,
       })
-      .describe('Activating climate preset succeeded.'),
+      .describe('Activating a climate preset succeeded.'),
     common_failed_action_attempt
       .extend({ action_type, error })
-      .describe('Activating climate preset failed.'),
+      .describe('Activating a climate preset failed.'),
   ],
 )

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

@@ -6,118 +6,188 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const error = z.object({
-  type: z.string(),
-  message: z.string(),
-})
+const error = z
+  .object({
+    type: z.string().describe('Type of the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error associated with the action.')
 
-const result = z.object({})
+const result = z.object({}).describe('Result of the action.')
 
-const sync_access_codes_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('SYNC_ACCESS_CODES'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('SYNC_ACCESS_CODES'),
-    result,
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('SYNC_ACCESS_CODES'),
-    error,
-  }),
-])
+const sync_access_codes_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('SYNC_ACCESS_CODES')
+        .describe('Syncing access codes is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('SYNC_ACCESS_CODES')
+        .describe('Syncing access codes succeeded.'),
+      result,
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('SYNC_ACCESS_CODES')
+        .describe('Syncing access codes failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of syncing access codes.')
 
-const create_access_code_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('CREATE_ACCESS_CODE'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('CREATE_ACCESS_CODE'),
-    result: z.object({
-      access_code: z.any(),
-    }),
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('CREATE_ACCESS_CODE'),
-    error,
-  }),
-])
+const create_access_code_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_ACCESS_CODE')
+        .describe('Creating an access code is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_ACCESS_CODE')
+        .describe('Creating an access code succeeded.'),
+      result: z
+        .object({
+          access_code: z.any().describe('Created access code.'),
+        })
+        .describe('Result of the action.'),
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_ACCESS_CODE')
+        .describe('Creating an access code failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of creating an access code.')
 
-const delete_access_code_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('DELETE_ACCESS_CODE'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('DELETE_ACCESS_CODE'),
-    result,
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('DELETE_ACCESS_CODE'),
-    error,
-  }),
-])
+const delete_access_code_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_ACCESS_CODE')
+        .describe('Deleting an access code is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_ACCESS_CODE')
+        .describe('Deleting an access code succeeded.'),
+      result,
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_ACCESS_CODE')
+        .describe('Deleting an access code failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of deleting an access code.')
 
-const update_access_code_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('UPDATE_ACCESS_CODE'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('UPDATE_ACCESS_CODE'),
-    result: z.object({
-      access_code: z.any(),
-    }),
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('UPDATE_ACCESS_CODE'),
-    error,
-  }),
-])
+const update_access_code_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_ACCESS_CODE')
+        .describe('Updating an access code is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_ACCESS_CODE')
+        .describe('Updating an access code succeeded.'),
+      result: z
+        .object({
+          access_code: z.any().describe('Updated access code.'),
+        })
+        .describe('Result of the action.'),
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_ACCESS_CODE')
+        .describe('Updating an access code failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of updating an access code.')
 
-const create_noise_threshold_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
-    result: z.object({
-      noise_threshold: z.any(),
-    }),
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
-    error,
-  }),
-])
+const create_noise_threshold_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_NOISE_THRESHOLD')
+        .describe('Creating a noise threshold is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_NOISE_THRESHOLD')
+        .describe('Creating a noise threshold succeeded.'),
+      result: z
+        .object({
+          noise_threshold: z.any().describe('Created noise threshold.'),
+        })
+        .describe('Result of the action.'),
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('CREATE_NOISE_THRESHOLD')
+        .describe('Creating a noise threshold failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of creating a noise threshold.')
 
-const delete_noise_threshold_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
-    result,
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
-    error,
-  }),
-])
+const delete_noise_threshold_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_NOISE_THRESHOLD')
+        .describe('Deleting a noise threshold is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_NOISE_THRESHOLD')
+        .describe('Deleting a noise threshold succeeded.'),
+      result,
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('DELETE_NOISE_THRESHOLD')
+        .describe('Deleting a noise threshold failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of deleting a noise threshold.')
 
-const update_noise_threshold_action_attempt = z.discriminatedUnion('status', [
-  common_pending_action_attempt.extend({
-    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
-  }),
-  common_succeeded_action_attempt.extend({
-    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
-    result: z.object({
-      noise_threshold: z.any(),
-    }),
-  }),
-  common_failed_action_attempt.extend({
-    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
-    error,
-  }),
-])
+const update_noise_threshold_action_attempt = z
+  .discriminatedUnion('status', [
+    common_pending_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_NOISE_THRESHOLD')
+        .describe('Updating a noise threshold is pending.'),
+    }),
+    common_succeeded_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_NOISE_THRESHOLD')
+        .describe('Updating a noise threshold succeeded.'),
+      result: z
+        .object({
+          noise_threshold: z.any().describe('Updated noise threshold.'),
+        })
+        .describe('Result of the action.'),
+    }),
+    common_failed_action_attempt.extend({
+      action_type: z
+        .literal('UPDATE_NOISE_THRESHOLD')
+        .describe('Updating a noise threshold failed.'),
+      error,
+    }),
+  ])
+  .describe('Action attempt to track the status of updating a noise threshold.')
 
 export const deprecated_action_attempts = [
   ...sync_access_codes_action_attempt.options,