@seamapi/types 1.416.1 → 1.417.0

package/src/lib/seam/connect/models/action-attempts/encode-access-method.ts

@@ -10,22 +10,54 @@ import {
 
 const action_type = z
   .literal('ENCODE_ACCESS_METHOD')
-  .describe('Type of action that the action attempt tracks.')
+  .describe(
+    'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
+  )
 
-const no_credential_on_encoder_error = z.object({
-  type: z.literal('no_credential_on_encoder'),
-  message: z.string(),
-})
+const no_credential_on_encoder_error = z
+  .object({
+    type: z
+      .literal('no_credential_on_encoder')
+      .describe(
+        'Error type to indicate that there is no credential on the encoder.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error to indicate that there is no credential on the encoder.')
 
-const incompatible_card_format_error = z.object({
-  type: z.literal('incompatible_card_format'),
-  message: z.string(),
-})
+const incompatible_card_format_error = z
+  .object({
+    type: z
+      .literal('incompatible_card_format')
+      .describe('Error type to indicate an incompatible card format.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error to indicate an incompatible card format.')
 
-const credential_cannot_be_reissued = z.object({
-  type: z.literal('credential_cannot_be_reissued'),
-  message: z.string(),
-})
+const credential_cannot_be_reissued = z
+  .object({
+    type: z
+      .literal('credential_cannot_be_reissued')
+      .describe(
+        'Error type to indicate that the affected credential cannot be reissued.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe(
+    'Error to indicate that the affected credential cannot be reissued.',
+  )
 
 const error = z.union([
   ...common_action_attempt_errors,
@@ -35,7 +67,7 @@ const error = z.union([
 ])
 
 const result = access_method.describe(
-  'If an encoding attempt was successful, includes the `access_method` data that was encoded onto the card.',
+  'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
 )
 
 export const encode_access_method_action_attempt = z.discriminatedUnion(
@@ -46,7 +78,7 @@ export const encode_access_method_action_attempt = z.discriminatedUnion(
         action_type,
       })
       .describe(
-        'Action attempt to track encoding credential data from the physical encoder onto a card.',
+        'Encoding access method data from the physical encoder onto a card is pending.',
       ),
     common_succeeded_action_attempt
       .extend({
@@ -54,12 +86,12 @@ export const encode_access_method_action_attempt = z.discriminatedUnion(
         result,
       })
       .describe(
-        'Action attempt to indicate that encoding access method data from the physical encoder onto a card succeeded.',
+        'Encoding access method data from the physical encoder onto a card succeeded.',
       ),
     common_failed_action_attempt
       .extend({ action_type, error })
       .describe(
-        'Action attempt to indicate that encoding access method data from the physical encoder onto a card failed.',
+        'Encoding access method data from the physical encoder onto a card failed.',
       ),
   ],
 )

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

@@ -13,22 +13,54 @@ import {
 
 const action_type = z
   .literal('ENCODE_CREDENTIAL')
-  .describe('Type of action that the action attempt tracks.')
+  .describe(
+    'Action attempt to track the status of encoding credential data from the physical encoder onto a card.',
+  )
 
-const no_credential_on_encoder_error = z.object({
-  type: z.literal('no_credential_on_encoder'),
-  message: z.string(),
-})
+const no_credential_on_encoder_error = z
+  .object({
+    type: z
+      .literal('no_credential_on_encoder')
+      .describe(
+        'Error type to indicate that there is no credential on the encoder.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error to indicate that there is no credential on the encoder.')
 
-const incompatible_card_format_error = z.object({
-  type: z.literal('incompatible_card_format'),
-  message: z.string(),
-})
+const incompatible_card_format_error = z
+  .object({
+    type: z
+      .literal('incompatible_card_format')
+      .describe('Error type to indicate an incompatible card format.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error to indicate an incompatible card format.')
 
-const credential_cannot_be_reissued = z.object({
-  type: z.literal('credential_cannot_be_reissued'),
-  message: z.string(),
-})
+const credential_cannot_be_reissued = z
+  .object({
+    type: z
+      .literal('credential_cannot_be_reissued')
+      .describe(
+        'Error type to indicate that the affected credential cannot be reissued.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe(
+    'Error to indicate that the affected credential cannot be reissued.',
+  )
 
 const error = z.union([
   ...common_action_attempt_errors,
@@ -40,16 +72,15 @@ const error = z.union([
 const result = acs_credential
   .or(unmanaged_acs_credential)
   .describe(
-    'If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.',
+    'Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card.',
   )
-
 export const encode_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
     .describe(
-      'Action attempt to track encoding credential data from the physical encoder onto a card.',
+      'Encoding credential data from the physical encoder onto a card is pending.',
     ),
   common_succeeded_action_attempt
     .extend({
@@ -57,12 +88,12 @@ export const encode_credential_action_attempt = z.discriminatedUnion('status', [
       result,
     })
     .describe(
-      'Action attempt to indicate that encoding credential data from the physical encoder onto a card succeeded.',
+      'Encoding credential data from the physical encoder onto a card succeeded.',
     ),
   common_failed_action_attempt
     .extend({ action_type, error })
     .describe(
-      'Action attempt to indicate that encoding credential data from the physical encoder onto a card failed.',
+      'Encoding credential data from the physical encoder onto a card failed.',
     ),
 ])
 

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

@@ -6,30 +6,38 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('LOCK_DOOR')
+const action_type = z
+  .literal('LOCK_DOOR')
+  .describe('Action attempt to track the status of locking a door.')
 
-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 lock_door_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Locking door.'),
+    .describe('Locking a door is pending.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Locking door succeeded.'),
+    .describe('Locking a door succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Locking door failed.'),
+    .describe('Locking a door failed.'),
 ])
 
 export type LockDoorActionAttempt = z.infer<typeof lock_door_action_attempt>

package/src/lib/seam/connect/models/action-attempts/push-thermostat-programs.ts

@@ -6,14 +6,24 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('PUSH_THERMOSTAT_PROGRAMS')
+const action_type = z
+  .literal('PUSH_THERMOSTAT_PROGRAMS')
+  .describe(
+    'Action attempt to track the status of pushing thermostat programs.',
+  )
 
-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 push_thermostat_programs_action_attempt = z.discriminatedUnion(
   'status',
@@ -22,7 +32,7 @@ export const push_thermostat_programs_action_attempt = z.discriminatedUnion(
       .extend({
         action_type,
       })
-      .describe('Pushing thermostat weekly programs.'),
+      .describe('Pushing thermostat weekly programs is pending.'),
     common_succeeded_action_attempt
       .extend({
         action_type,

package/src/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.ts

@@ -6,14 +6,24 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('RESET_SANDBOX_WORKSPACE')
+const action_type = z
+  .literal('RESET_SANDBOX_WORKSPACE')
+  .describe(
+    'Action attempt to track the status of resetting a sandbox workspace.',
+  )
 
-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 reset_sandbox_workspace_action_attempt = z.discriminatedUnion(
   'status',
@@ -22,18 +32,18 @@ export const reset_sandbox_workspace_action_attempt = z.discriminatedUnion(
       .extend({
         action_type,
       })
-      .describe('Resetting sandbox workspace.'),
+      .describe('Resetting a sandbox workspace is pending.'),
     common_succeeded_action_attempt
       .extend({
         action_type,
         result,
       })
-      .describe('Resetting sandbox workspace succeeded.'),
+      .describe('Resetting a sandbox workspace succeeded.'),
     common_failed_action_attempt
       .extend({
         action_type,
         error,
       })
-      .describe('Resetting sandbox workspace failed.'),
+      .describe('Resetting a sandbox workspace failed.'),
   ],
 )

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

@@ -12,44 +12,74 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SCAN_CREDENTIAL')
+const action_type = z
+  .literal('SCAN_CREDENTIAL')
+  .describe('Action attempt to track the status of scanning a credential.')
 
-const no_credential_on_encoder_error = z.object({
-  type: z.literal('no_credential_on_encoder'),
-  message: z.string(),
-})
+const no_credential_on_encoder_error = z
+  .object({
+    type: z
+      .literal('no_credential_on_encoder')
+      .describe(
+        'Error type to indicate that there is no credential on the encoder.',
+      ),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Error to indicate that there is no credential on the encoder.')
 
 const error = z.union([
   ...common_action_attempt_errors,
   no_credential_on_encoder_error,
 ])
 
-const warning = z.object({
-  warning_code: z.union([
-    z.literal('acs_credential_on_encoder_out_of_sync'),
-    z.literal('acs_credential_on_seam_not_found'),
-  ]),
-  warning_message: z.string(),
-})
+const warning = z
+  .object({
+    warning_code: z
+      .union([
+        z.literal('acs_credential_on_encoder_out_of_sync'),
+        z.literal('acs_credential_on_seam_not_found'),
+      ])
+      .describe('Indicates a warning related to scanning a credential.'),
+    warning_message: z
+      .string()
+      .describe(
+        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+      ),
+  })
+  .describe('Warning related to scanning a credential.')
 
 const acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential)
 
-const result = z.object({
-  acs_credential_on_encoder: acs_credential_on_encoder
-    .nullable()
-    .describe('Snapshot of credential data read from physical encoder.'),
-  acs_credential_on_seam: acs_credential_on_seam
-    .nullable()
-    .describe('Matching acs_credential currently encoded on this card.'),
-  warnings: z.array(warning),
-})
+const result = z
+  .object({
+    acs_credential_on_encoder: acs_credential_on_encoder
+      .nullable()
+      .describe('Snapshot of credential data read from the physical encoder.'),
+    acs_credential_on_seam: acs_credential_on_seam
+      .nullable()
+      .describe(
+        'Corresponding credential data as stored on Seam and the access system.',
+      ),
+    warnings: z
+      .array(warning)
+      .describe(
+        'Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system.',
+      ),
+  })
+  .describe(
+    'Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings.',
+  )
 
 export const scan_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Reading credential data from physical encoder.'),
+    .describe('Reading credential data from the physical encoder is pending.'),
   common_succeeded_action_attempt
     .extend({
       action_type,

package/src/lib/seam/connect/models/action-attempts/set-fan-mode.ts

@@ -6,28 +6,38 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SET_FAN_MODE')
+const action_type = z
+  .literal('SET_FAN_MODE')
+  .describe(
+    'Action attempt to track the status of setting the fan mode on a thermostat.',
+  )
 
-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 set_fan_mode_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Setting fan mode.'),
+    .describe('Setting the fan mode is pending.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Setting fan mode succeeded.'),
+    .describe('Setting the fan mode succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Setting fan mode failed.'),
+    .describe('Setting the fan mode failed.'),
 ])

package/src/lib/seam/connect/models/action-attempts/set-hvac-mode.ts

@@ -6,28 +6,38 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SET_HVAC_MODE')
+const action_type = z
+  .literal('SET_HVAC_MODE')
+  .describe(
+    'Action attempt to track the status of setting the HVAC mode on a thermostat.',
+  )
 
-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 set_hvac_mode_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Setting HVAC mode.'),
+    .describe('Setting the HVAC mode is pending.'),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Setting HVAC mode succeeded.'),
+    .describe('Setting the HVAC mode succeeded.'),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Setting HVAC mode failed.'),
+    .describe('Setting the HVAC mode failed.'),
 ])

package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts

@@ -6,14 +6,24 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SIMULATE_KEYPAD_CODE_ENTRY')
+const action_type = z
+  .literal('SIMULATE_KEYPAD_CODE_ENTRY')
+  .describe(
+    'Action attempt to track the status of simulating a keypad code entry.',
+  )
 
-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 simulate_keypad_code_entry_action_attempt = z.discriminatedUnion(
   'status',
@@ -22,18 +32,18 @@ export const simulate_keypad_code_entry_action_attempt = z.discriminatedUnion(
       .extend({
         action_type,
       })
-      .describe('Simulating keypad code entry.'),
+      .describe('Simulating a keypad code entry is pending.'),
     common_succeeded_action_attempt
       .extend({
         action_type,
         result,
       })
-      .describe('Simulating keypad code entry succeeded.'),
+      .describe('Simulating a keypad code entry succeeded.'),
     common_failed_action_attempt
       .extend({
         action_type,
         error,
       })
-      .describe('Simulating keypad code entry failed.'),
+      .describe('Simulating a keypad code entry failed.'),
   ],
 )

package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts

@@ -6,14 +6,24 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('SIMULATE_MANUAL_LOCK_VIA_KEYPAD')
+const action_type = z
+  .literal('SIMULATE_MANUAL_LOCK_VIA_KEYPAD')
+  .describe(
+    'Action attempt to track the status of simulating a manual lock action using a keypad.',
+  )
 
-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 simulate_manual_lock_via_keypad_action_attempt =
   z.discriminatedUnion('status', [
@@ -21,17 +31,17 @@ export const simulate_manual_lock_via_keypad_action_attempt =
       .extend({
         action_type,
       })
-      .describe('Simulating manual lock via keypad.'),
+      .describe('Simulating a manual lock action using a keypad is pending.'),
     common_succeeded_action_attempt
       .extend({
         action_type,
         result,
       })
-      .describe('Simulating manual lock via keypad succeeded.'),
+      .describe('Simulating a manual lock action using a keypad succeeded.'),
     common_failed_action_attempt
       .extend({
         action_type,
         error,
       })
-      .describe('Simulating manual lock via keypad failed.'),
+      .describe('Simulating a manual lock action using a keypad failed.'),
   ])