@internetderdinge/api 1.229.39 → 1.229.41

package/dist/src/organizations/organizations.schemas.js

@@ -1,7 +1,30 @@
-import { z } from 'zod';
+import { z } from "zod";
 export const organizationResponseSchema = z.object({
-    id: z.string(),
-    name: z.string(),
-    email: z.string().email(),
-    kind: z.string().optional(),
+    id: z
+        .string()
+        .openapi({ example: "682fd0d7d4a6325d9d45b86e" }),
+    name: z
+        .string()
+        .openapi({ example: "Acme Inc.", description: "Organization name" }),
+    email: z
+        .string()
+        .email()
+        .openapi({
+        example: "contact@acme.example",
+        description: "Primary contact email",
+    }),
+    kind: z
+        .string()
+        .optional()
+        .openapi({
+        example: "private",
+        description: "The type or category of the organization",
+    }),
+}).openapi({
+    example: {
+        id: "682fd0d7d4a6325d9d45b86e",
+        name: "Acme Inc.",
+        email: "contact@acme.example",
+        kind: "private",
+    },
 });

package/dist/src/organizations/organizations.validation.js

@@ -3,26 +3,25 @@ import { z } from "zod";
 import { zPagination, zGet, zObjectId, zUpdate, zDelete, } from "../utils/zValidations.js";
 extendZodWithOpenApi(z);
 export const createOrganizationSchema = {
-    body: z.object({
-        /*  name: z.string().openapi({
-          example: 'Acme Inc.',
-          description: 'The name of the organization',
-        }),
-        email: z.string().email().openapi({
-          example: 'contact@acme.com',
-          description: 'Contact email for the organization',
-        }), */
+    body: z
+        .object({
         kind: z.string().openapi({
             example: "private",
             description: "The type or category of the organization",
         }),
+    })
+        .openapi({
+        example: {
+            kind: "private",
+        },
     }),
 };
 export const queryOrganizationsSchema = zPagination;
 export const getOrganizationByIdSchema = zGet("organizationId");
 export const updateOrganizationSchema = {
     ...zUpdate("organizationId"),
-    body: z.object({
+    body: z
+        .object({
         name: z
             .string()
             .openapi({
@@ -41,10 +40,22 @@ export const updateOrganizationSchema = {
         meta: z
             .record(z.string(), z.any())
             .openapi({
-            example: { key: "value" },
+            example: { billingId: "cus_123", region: "eu" },
             description: "Additional metadata for the entry",
         })
             .optional(),
+    })
+        .openapi({
+        example: {
+            name: "Acme Inc.",
+            organization: process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID ||
+                "682fd0d7d4a6325d9d45b86d",
+            kind: "private",
+            meta: {
+                billingId: "cus_123",
+                region: "eu",
+            },
+        },
     }),
     //...zUpdate('organizationId'),
     /* body: z.object({

package/dist/src/tokens/tokens.schemas.js

@@ -1,14 +1,37 @@
-import { z } from 'zod';
+import { z } from "zod";
 export const tokenResponseSchema = z.object({
-    // unique identifier of the token
-    tokenId: z.string().uuid(),
-    // the owning user
-    userId: z.string().uuid(),
-    // optional name or description
-    name: z.string().optional(),
-    // the token value (never returned after creation in real-world apps)
-    token: z.string(),
-    // timestamps
-    createdAt: z.string().datetime(),
-    updatedAt: z.string().datetime(),
+    tokenId: z
+        .string()
+        .openapi({
+        example: "682fd0d7d4a6325d9d45b872",
+        description: "Token ObjectId",
+    }),
+    userId: z
+        .string()
+        .openapi({
+        example: "682fd0d7d4a6325d9d45b86d",
+        description: "Owning user ObjectId",
+    }),
+    name: z.string().optional().openapi({ example: "Admin integration token" }),
+    token: z.string().openapi({
+        example: "idt_live_1234567890abcdef",
+        description: "Token secret. Usually only returned immediately after creation.",
+    }),
+    createdAt: z
+        .string()
+        .datetime()
+        .openapi({ example: "2026-05-21T09:30:00.000Z" }),
+    updatedAt: z
+        .string()
+        .datetime()
+        .openapi({ example: "2026-05-21T10:15:00.000Z" }),
+}).openapi({
+    example: {
+        tokenId: "682fd0d7d4a6325d9d45b872",
+        userId: "682fd0d7d4a6325d9d45b86d",
+        name: "Admin integration token",
+        token: "idt_live_1234567890abcdef",
+        createdAt: "2026-05-21T09:30:00.000Z",
+        updatedAt: "2026-05-21T10:15:00.000Z",
+    },
 });

package/dist/src/tokens/tokens.validation.js

@@ -1,8 +1,14 @@
 import { z } from "zod";
 import { zGet, zDelete } from "../utils/zValidations.js";
 export const createTokenSchema = {
-    body: z.object({
-        name: z.string().openapi({ example: "my sample token" }),
+    body: z
+        .object({
+        name: z.string().openapi({ example: "Admin integration token" }),
+    })
+        .openapi({
+        example: {
+            name: "Admin integration token",
+        },
     }),
 };
 export const getTokenSchema = zGet("tokenId");

package/dist/src/users/users.schemas.js

@@ -2,24 +2,53 @@ import { z } from "zod";
 import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
 extendZodWithOpenApi(z);
 export const createUserResponseSchema = z.object({
-    id: z.string(),
-    name: z.string(),
-    email: z.string(),
+    id: z.string().openapi({ example: "682fd0d7d4a6325d9d45b86d" }),
+    name: z.string().openapi({ example: "Jane Doe" }),
+    email: z.string().email().openapi({ example: "jane.doe@example.com" }),
+}).openapi({
+    example: {
+        id: "682fd0d7d4a6325d9d45b86d",
+        name: "Jane Doe",
+        email: "jane.doe@example.com",
+    },
 });
 export const getUsersResponseSchema = z.array(z.object({
-    id: z.string(),
-    name: z.string(),
-    email: z.string(),
-}));
+    id: z.string().openapi({ example: "682fd0d7d4a6325d9d45b86d" }),
+    name: z.string().openapi({ example: "Jane Doe" }),
+    email: z.string().email().openapi({ example: "jane.doe@example.com" }),
+})).openapi({
+    example: [
+        {
+            id: "682fd0d7d4a6325d9d45b86d",
+            name: "Jane Doe",
+            email: "jane.doe@example.com",
+        },
+        {
+            id: "682fd0d7d4a6325d9d45b86f",
+            name: "John Smith",
+            email: "john.smith@example.com",
+        },
+    ],
+});
 export const updateUserSchema = z.object({
     name: z.string().optional(),
     email: z.string().email().optional(),
 });
 export const updateUserResponseSchema = z.object({
-    id: z.string(),
-    name: z.string(),
-    email: z.string(),
+    id: z.string().openapi({ example: "682fd0d7d4a6325d9d45b86d" }),
+    name: z.string().openapi({ example: "Jane Doe" }),
+    email: z.string().email().openapi({ example: "jane.doe@example.com" }),
+}).openapi({
+    example: {
+        id: "682fd0d7d4a6325d9d45b86d",
+        name: "Jane Doe",
+        email: "jane.doe@example.com",
+    },
 });
 export const deleteUserResponseSchema = z.object({
-    success: z.boolean(),
+    success: z.boolean().openapi({ example: true }),
+}).openapi({
+    example: {
+        success: true,
+    },
 });

package/dist/src/users/users.validation.js

@@ -24,6 +24,10 @@ export const createUserBodyShape = {
         example: "user@example.com",
         description: "User email address",
     }),
+    category: z.string().optional().openapi({
+        example: "random",
+        description: "LEGACY: User category",
+    }),
     timezone: z.string().optional().openapi({
         example: "Europe/Berlin",
         description: "IANA timezone string",
@@ -33,7 +37,18 @@ export const createUserBodyShape = {
     }),
 };
 export const createUserSchema = {
-    body: z.object(createUserBodyShape),
+    body: z.object(createUserBodyShape).openapi({
+        example: {
+            organization: process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID ||
+                "682fd0d7d4a6325d9d45b86e",
+            email: "user@example.com",
+            timezone: "Europe/Berlin",
+            role: "user",
+            meta: {
+                externalId: "crm-123",
+            },
+        },
+    }),
 };
 export const createCurrentUserSchema = createUserSchema;
 export const queryUsersSchema = {
@@ -49,13 +64,20 @@ export const queryUsersSchema = {
 export const getUserSchema = zGet("userId");
 export const getCurrentUserSchema = {
     query: z.object({
-        organization: zObjectId,
+        organization: zObjectId.openapi({
+            description: "Organization ObjectId",
+            param: { name: "organization", in: "query" },
+        }),
     }),
 };
 export const updateUserBodyShape = {
     name: z.string().optional().openapi({ description: "User full name" }),
     timezone: z.string().optional().openapi({ description: "IANA timezone" }),
     avatar: z.string().optional().openapi({ description: "Avatar URL" }),
+    category: z.string().optional().openapi({
+        example: "random",
+        description: "LEGACY: User category",
+    }),
     meta: z
         .object({})
         .passthrough()
@@ -83,18 +105,40 @@ export const updateUserBodyShape = {
 };
 export const updateUserSchema = {
     ...zUpdate("userId"),
-    body: zPatchBody(updateUserBodyShape),
+    body: zPatchBody(updateUserBodyShape).openapi({
+        example: {
+            name: "Jane Doe",
+            timezone: "Europe/Berlin",
+            email: "jane.doe@example.com",
+            role: "patient",
+            meta: {
+                carePlan: "standard",
+            },
+        },
+    }),
 };
 export const deleteUserSchema = zDelete("userId");
 export const organizationInviteSchema = {
-    body: z.object({
-        organizationId: zObjectId.openapi({ description: "Organization ObjectId" }),
+    body: z
+        .object({
+        organizationId: zObjectId.openapi({
+            description: "Organization ObjectId",
+        }),
         action: z.string().optional().openapi({ description: "Invite action" }),
         role: z.string().optional().openapi({ description: "Role on invite" }),
+    })
+        .openapi({
+        example: {
+            organizationId: process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID ||
+                "682fd0d7d4a6325d9d45b86e",
+            action: "accept",
+            role: "user",
+        },
     }),
 };
 export const updateInviteSchema = {
-    body: z.object({
+    body: z
+        .object({
         organization: zObjectId.openapi({ description: "Organization ObjectId" }),
         status: z.enum(["accepted"]).openapi({ description: "Invite status" }),
         inviteCode: z
@@ -102,12 +146,30 @@ export const updateInviteSchema = {
             .nullable()
             .optional()
             .openapi({ description: "Invite code" }),
+    })
+        .openapi({
+        example: {
+            organization: process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID ||
+                "682fd0d7d4a6325d9d45b86e",
+            status: "accepted",
+            inviteCode: "INVITE-123",
+        },
     }),
 };
 export const organizationRemoveSchema = {
-    body: z.object({
+    body: z
+        .object({
         userId: zObjectId.openapi({ description: "User ObjectId" }),
-        organizationId: zObjectId.openapi({ description: "Organization ObjectId" }),
+        organizationId: zObjectId.openapi({
+            description: "Organization ObjectId",
+        }),
+    })
+        .openapi({
+        example: {
+            userId: process.env.SCHEMA_EXAMPLE_USER_ID || "682fd0d7d4a6325d9d45b86d",
+            organizationId: process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID ||
+                "682fd0d7d4a6325d9d45b86e",
+        },
     }),
 };
 export const updateTimesByIdSchema = {