feat: Add docs for device events (#1373)

seamapi · Dec 13, 2024 · 55408dc · 55408dc
1 parent 3187774
commit 55408dc
Show file tree

Hide file tree

Showing 4 changed files with 1,476 additions and 1,483 deletions.
diff --git a/src/lib/seam/connect/models/events/common.ts b/src/lib/seam/connect/models/events/common.ts
@@ -1,28 +1,16 @@
 import { z } from 'zod'
 
 export const common_event = z.object({
-  event_id: z.string().uuid().describe(`
-    ---
-    title: Event ID
-    ---
-    The ID of the event.
-  `),
-  workspace_id: z.string().uuid().describe(`
-    ---
-    title: Workspace ID
-    ---
-    The ID of the workspace.
-  `),
-  created_at: z.string().datetime().describe(`
-    ---
-    title: Created At
-    ---
-    The time when the event was created.
-  `),
-  occurred_at: z.string().datetime().describe(`
-    ---
-    title: Occurred At
-    ---
-    The time when the event occurred.
-  `),
+  event_id: z.string().uuid().describe('ID of the event.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Time at which the event was created.'),
+  occurred_at: z.string().datetime().describe('Time when the event occurred.'),
 })