feat: Document user_identity (#1261)

Co-authored-by: Evan Sosenko <[email protected]>

Author: seambot

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

@@ -8,14 +8,39 @@ export const acs_credential_provisioning_automation = z.object({
   workspace_id: z.string().uuid(),
 })
 
-export const enrollment_automation = acs_credential_provisioning_automation
-  .omit({
-    acs_credential_provisioning_automation_id: true,
+export const enrollment_automation = z
+  .object({
+    enrollment_automation_id: z
+      .string()
+      .uuid()
+      .describe('ID of the enrollment automation.'),
+    credential_manager_acs_system_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
+      ),
+    user_identity_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
+      ),
+    created_at: z
+      .string()
+      .datetime()
+      .describe(
+        'Date and time at which the enrollment automation was created.',
+      ),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
+      ),
   })
-  .merge(
-    z.object({
-      enrollment_automation_id: z.string().uuid(),
-    }),
+  .describe(
+    'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).',
   )
 
 export type EnrollmentAutomation = z.output<typeof enrollment_automation>

src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -2,15 +2,39 @@ import { z } from 'zod'
 
 import { phone_number } from '../phone-number.js'
 
-export const user_identity = z.object({
-  user_identity_id: z.string().uuid(),
-  user_identity_key: z.string().min(1).nullable(),
-  email_address: z.string().email().nullable(),
-  phone_number: phone_number.nullable(),
-  display_name: z.string().min(1),
-  full_name: z.string().min(1).nullable(),
-  created_at: z.string().datetime(),
-  workspace_id: z.string().uuid(),
-})
+export const user_identity = z
+  .object({
+    user_identity_id: z.string().uuid().describe('ID of the user identity.'),
+    user_identity_key: z
+      .string()
+      .min(1)
+      .nullable()
+      .describe('Unique key for the user identity.'),
+    email_address: z
+      .string()
+      .email()
+      .nullable()
+      .describe('Unique email address for the user identity.'),
+    phone_number: phone_number
+      .nullable()
+      .describe(
+        'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
+      ),
+    display_name: z.string().min(1),
+    full_name: z.string().min(1).nullable(),
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which the user identity was created.'),
+    workspace_id: z
+      .string()
+      .uuid()
+      .describe(
+        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
+      ),
+  })
+  .describe(
+    'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.',
+  )
 
 export type UserIdentity = z.output<typeof user_identity>