Files
cfw-autumn/shared/api/customers/previousVersions/apiCustomerV2.ts
2025-10-08 09:16:42 +01:00

63 lines
2.2 KiB
TypeScript

import { ApiCusReferralSchema } from "@api/customers/components/apiCusReferral.js";
import { ApiCusUpcomingInvoiceSchema } from "@api/customers/components/apiCusUpcomingInvoice.js";
import { ApiCusFeatureV2Schema } from "@api/customers/cusFeatures/previousVersions/apiCusFeatureV2.js";
import { ApiCusProductV2Schema } from "@api/customers/cusProducts/previousVersions/apiCusProductV2.js";
import { ApiEntitySchema } from "@api/entities/apiEntity.js";
import { ApiCusRewardsSchema } from "@api/models.js";
import { ApiInvoiceSchema } from "@api/others/apiInvoice.js";
import { AppEnv } from "@models/genModels/genEnums.js";
import { z } from "zod/v4";
export const ApiTrialsUsedV2Schema = z.object({
product_id: z.string(),
customer_id: z.string(),
fingerprint: z.string().nullish(),
});
/**
* ApiCustomerV2Schema - Customer response format for API V1.1+ (merged format)
*
*
* Key differences from V1:
* - Merged structure (everything in one object)
* - Uses "features" instead of "entitlements"
* - Features are ApiCusFeatureV2 (with usage/included_usage fields)
* - Products are ApiCusProductV2 (with items field)
* - Invoices require explicit expand parameter
*/
export const ApiCustomerV2Schema = z.object({
// Internal fields
autumn_id: z.string().nullish(),
id: z.string().nullable().meta({
description: "Your internal ID for the customer",
example: "cus_123",
}),
created_at: z.number().meta({
description:
"The date and time the customer was created in milliseconds since epoch",
example: 1717000000,
}),
name: z.string().nullable(),
email: z.string().nullable(),
fingerprint: z.string().nullable(),
stripe_id: z.string().nullable().default(null),
env: z.enum(AppEnv),
products: z.array(ApiCusProductV2Schema),
features: z.array(ApiCusFeatureV2Schema),
invoices: z.array(ApiInvoiceSchema).optional(),
trials_used: z.array(ApiTrialsUsedV2Schema).optional(),
rewards: ApiCusRewardsSchema.nullish(),
metadata: z.record(z.any(), z.any()).default({}),
entities: z.array(ApiEntitySchema).optional(),
referrals: z.array(ApiCusReferralSchema).optional(),
upcoming_invoice: ApiCusUpcomingInvoiceSchema.nullish(),
payment_method: z.any().nullish(),
});
export type ApiCustomerV2 = z.infer<typeof ApiCustomerV2Schema>;