Files
cfw-autumn/shared/api/entities/apiEntity.ts
John Yeo dcc26b44a9 wip
2025-10-25 10:52:03 +01:00

48 lines
1.5 KiB
TypeScript

import { ApiCusFeatureV3Schema } from "@api/customers/cusFeatures/previousVersions/apiCusFeatureV3.js";
import { ApiCusPlanSchema } from "@api/customers/cusPlans/apiCusPlan.js";
import { ApiInvoiceSchema } from "@api/others/apiInvoice.js";
import { AppEnv } from "@models/genModels/genEnums.js";
import { z } from "zod/v4";
export const ApiBaseEntitySchema = z.object({
id: z.string().nullable().meta({
description: "The unique identifier of the entity",
example: "<string>",
}),
name: z.string().nullable().meta({
description: "The name of the entity",
example: "<string>",
}),
customer_id: z.string().nullish().meta({
description: "The customer ID this entity belongs to",
example: "<string>",
}),
feature_id: z.string().nullish(),
created_at: z.number().meta({
description: "Unix timestamp when the entity was created",
example: 1686168121,
}),
env: z.enum(AppEnv).meta({
description: "The environment (sandbox/live)",
example: "live",
}),
});
export const ApiEntitySchema = ApiBaseEntitySchema.extend({
plans: z.array(ApiCusPlanSchema).optional().meta({
description: "Plans associated with this entity",
example: [],
}),
features: z.record(z.string(), ApiCusFeatureV3Schema).optional().meta({
description: "Features associated with this entity",
example: {},
}),
invoices: z.array(ApiInvoiceSchema).optional().meta({
description:
"Invoices for this entity (only included when expand=invoices)",
example: [],
}),
});
export type ApiEntity = z.infer<typeof ApiEntitySchema>;