@seamapi/types 1.367.2 → 1.369.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.367.2",
+  "version": "1.369.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -89,7 +89,7 @@
     "npm": ">= 9.0.0"
   },
   "peerDependencies": {
-    "zod": "^3.21.4"
+    "zod": "^3.24.0"
   },
   "devDependencies": {
     "@seamapi/blueprint": "^0.37.1",
@@ -111,6 +111,6 @@
     "tsx": "^4.6.2",
     "typedoc": "^0.25.2",
     "typescript": "~5.3.3",
-    "zod": "^3.21.4"
+    "zod": "^3.24.0"
   }
 }

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

@@ -1,38 +1,61 @@
 import { z } from 'zod'
 
 export const common_action_attempt = z.object({
-  action_attempt_id: z.string().uuid().describe(`
-    ---
-    title: Action Attempt ID
-    ---
-    The ID of the action attempt.
-  `),
-  status: z.enum(['pending', 'success', 'error']),
+  action_attempt_id: z.string().uuid().describe('ID of the action attempt.'),
+  status: z
+    .enum(['pending', 'success', 'error'])
+    .describe('Status of the action attempt.'),
 })
 
 export const common_pending_action_attempt = common_action_attempt.extend({
   status: z.literal('pending'),
-  result: z.null(),
-  error: z.null(),
+  result: z
+    .null()
+    .describe(
+      'Result of the action attempt. Null for pending action attempts.',
+    ),
+  error: z
+    .null()
+    .describe(
+      'Errors associated with the action attempt. Null for pending action attempts.',
+    ),
 })
 
 export const common_succeeded_action_attempt = common_action_attempt.extend({
   status: z.literal('success'),
-  error: z.null(),
+  error: z
+    .null()
+    .describe(
+      'Errors associated with the action attempt. Null for successful action attempts.',
+    ),
 })
 
 export const common_failed_action_attempt = common_action_attempt.extend({
   status: z.literal('error'),
-  result: z.null(),
+  result: z
+    .null()
+    .describe('Result of the action attempt. Null for failed action attempts.'),
 })
 
 export const common_action_attempt_errors = [
-  z.object({
-    type: z.literal('uncategorized_error'),
-    message: z.string(),
-  }),
-  z.object({
-    type: z.literal('action_attempt_expired'),
-    message: z.string(),
-  }),
+  z
+    .object({
+      type: z
+        .literal('uncategorized_error')
+        .describe('Type of the error associated with the action attempt.'),
+      message: z
+        .string()
+        .describe('Message for the error associated with the action attempt.'),
+    })
+    .describe("Error that doesn't fit into other specific error categories."),
+  z
+    .object({
+      type: z
+        .literal('action_attempt_expired')
+        .describe('Type of the error associated with the action attempt.'),
+      message: z
+        .string()
+        .describe('Message for the error associated with the action attempt.'),
+    })
+    .describe('Error to indicate an expired action attempt.'),
 ] as const

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

@@ -11,7 +11,9 @@ import {
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('ENCODE_CREDENTIAL')
+const action_type = z
+  .literal('ENCODE_CREDENTIAL')
+  .describe('Type of action that the action attempt tracks.')
 
 const no_credential_on_encoder_error = z.object({
   type: z.literal('no_credential_on_encoder'),
@@ -35,23 +37,33 @@ const error = z.union([
   credential_cannot_be_reissued,
 ])
 
-const result = acs_credential.or(unmanaged_acs_credential)
+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.',
+  )
 
 export const encode_credential_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
     })
-    .describe('Encoding credential data from physical encoder.'),
+    .describe(
+      'Action attempt to track encoding credential data from the physical encoder onto a card.',
+    ),
   common_succeeded_action_attempt
     .extend({
       action_type,
       result,
     })
-    .describe('Encoding credential data from physical encoder succeeded.'),
+    .describe(
+      'Action attempt to indicate that encoding credential data from the physical encoder onto a card succeeded.',
+    ),
   common_failed_action_attempt
     .extend({ action_type, error })
-    .describe('Encoding credential data from physical encoder failed.'),
+    .describe(
+      'Action attempt to indicate that encoding credential data from the physical encoder onto a card failed.',
+    ),
 ])
 
 export type EncodeCredentialActionAttempt = z.infer<