Files
cfw-autumn/shared/api/customers/previousVersions/apiCustomerV1.ts
2026-01-28 10:13:01 +00:00

59 lines
2.0 KiB
TypeScript

import { ApiCusFeatureV1Schema } from "@api/customers/cusFeatures/previousVersions/apiCusFeatureV1.js";
import { ApiInvoiceV0Schema } from "@api/others/apiInvoice/prevVersions/apiInvoiceV0.js";
import { AppEnv } from "@models/genModels/genEnums.js";
import { z } from "zod/v4";
import { ApiTrialsUsedV0Schema } from "../components/apiTrialsUsed/prevVersions/apiTrialsUsedV0.js";
import { ApiCusProductV1Schema } from "../cusPlans/previousVersions/apiCusProductV1.js";
/**
* ApiCustomerV1Schema - Customer response format for API V0_2/V1_0/V1_1 (pre V1_2)
*
* Structure: Split into separate objects
* - customer: Core customer fields
* - products: Array of non-add-on products
* - add_ons: Array of add-on products
* - entitlements: Array of customer features (V1 format)
* - invoices: Array of customer invoices
*
* Key differences from V2:
* - Split structure instead of merged
* - Uses "entitlements" instead of "features"
* - Features are ApiCusFeatureV1 (with used/allowance fields)
* - Products are ApiCusProductV2 (same as V2, with items/period tracking)
* - Invoices always included (no expand parameter)
*/
// Core customer object (without products/features/invoices)
const ApiCustomerV1CoreSchema = z.object({
// Internal fields
id: z.string().nullable(),
name: z.string().nullable(),
email: z.string().nullable(),
fingerprint: z.string().nullable(),
internal_id: z.string(),
created_at: z.number(),
env: z.enum(AppEnv),
processor: z
.object({
id: z.string(),
type: z.string(),
})
.nullish(),
metadata: z.record(z.any(), z.any()).default({}),
});
// Split response structure
export const ApiCustomerV1Schema = z.object({
customer: ApiCustomerV1CoreSchema,
products: z.array(ApiCusProductV1Schema),
add_ons: z.array(ApiCusProductV1Schema),
entitlements: z.array(ApiCusFeatureV1Schema),
invoices: z.array(ApiInvoiceV0Schema),
trials_used: z.array(ApiTrialsUsedV0Schema).optional(),
});
export type ApiCustomerV1 = z.infer<typeof ApiCustomerV1Schema>;
type ApiCustomerV1Core = z.infer<typeof ApiCustomerV1CoreSchema>;