import {z} from 'zod' export type ParameterLimit = number; export type ParameterPage = number; export type ParameterOrderListEarningRules = 'created_at' | '-created_at' | 'updated_at' | '-updated_at'; export type GetApiV1LoyaltiesCampaignIdEarningRulesArgs = {limit?: ParameterLimit | undefined, page?: ParameterPage | undefined, order?: ParameterOrderListEarningRules | undefined}; export type GetApiV1LoyaltiesCampaignIdEarningRulesOptions = {baseUrl?: string | undefined, XAppId?: string | undefined, XAppToken?: string | undefined, fetch?: typeof fetch | undefined}; export const earningRuleFixed = z.object({type: z.literal("FIXED"), points: z.number().int(), points_formula: z.string().optional()}); export const earningRuleProportionalOrderAmount = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_AMOUNT"), order: z.object({amount: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional()})})}); export const earningRuleProportionalOrderTotalAmount = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_TOTAL_AMOUNT"), order: z.object({total_amount: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional()})})}); export const earningRuleProportionalOrderMetadata = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_METADATA"), order: z.object({metadata: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), property: z.string()})})}); export const earningRuleProportionalOrder = z.union([earningRuleProportionalOrderAmount, earningRuleProportionalOrderTotalAmount, earningRuleProportionalOrderMetadata]); export const earningRuleProportionalOrderItemsQuantity = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_ITEMS_QUANTITY"), order_items: z.object({quantity: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional(), applicable_to: z.array(z.object({object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional()})).optional()})})}); export const earningRuleProportionalOrderItemsAmount = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_ITEMS_AMOUNT"), order_items: z.object({amount: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional(), applicable_to: z.array(z.object({object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional()})).optional()})})}); export const earningRuleProportionalOrderItemsSubtotalAmount = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("ORDER_ITEMS_SUBTOTAL_AMOUNT"), order_items: z.object({subtotal_amount: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional(), applicable_to: z.array(z.object({object: z.enum(["products_collection", "product", "sku"]).optional(), id: z.string().optional()})).optional()})})}); export const earningRuleProportionalOrderItems = z.union([earningRuleProportionalOrderItemsQuantity, earningRuleProportionalOrderItemsAmount, earningRuleProportionalOrderItemsSubtotalAmount]); export const earningRuleProportionalCustomerMetadata = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("CUSTOMER_METADATA"), customer: z.object({metadata: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), property: z.string()})})}); export const earningRuleProportionalCustomEvent = z.object({type: z.literal("PROPORTIONAL"), calculation_type: z.literal("CUSTOM_EVENT_METADATA"), custom_event: z.object({metadata: z.object({every: z.number().int(), points: z.number().int(), points_formula: z.string().optional(), property: z.string()})})}); export const earningRuleProportional = z.union([earningRuleProportionalOrder, earningRuleProportionalOrderItems, earningRuleProportionalCustomerMetadata, earningRuleProportionalCustomEvent]); export const earningRuleEvent = z.string(); export const validityTimeframe = z.object({duration: z.string().optional(), interval: z.string().optional()}); export const validityDayOfWeek = z.array(z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)])); export const validityHours = z.object({daily: z.array(z.object({start_time: z.string().optional(), days_of_week: z.array(z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)])).optional(), expiration_time: z.string().optional()})).optional()}); export const earningRuleExpirationRules = z.object({period_type: z.enum(["FIXED_DAY_OF_YEAR", "MONTH"]), period_value: z.number().int().optional(), rounding_type: z.enum(["END_OF_MONTH", "END_OF_QUARTER", "END_OF_HALF_YEAR", "END_OF_YEAR", "PARTICULAR_MONTH"]).optional(), rounding_value: z.number().int().optional(), fixed_month: z.number().int().gte(1).lte(12).optional(), fixed_day: z.number().int().gte(1).lte(31).optional()}); export const earningRule = z.object({id: z.string(), created_at: z.string(), loyalty: z.union([earningRuleFixed, earningRuleProportional]), event: earningRuleEvent.optional(), custom_event: z.object({schema_id: z.string()}).optional(), segment: z.object({id: z.string()}).optional(), loyalty_tier: z.object({id: z.string().optional()}).optional(), pending_points: z.object({period_type: z.literal("DAY").optional(), period_value: z.number().int().gte(1).lte(90).optional()}).optional(), source: z.object({banner: z.string().optional(), object_id: z.string(), object_type: z.literal("campaign")}), object: z.literal("earning_rule"), automation_id: z.string(), start_date: z.string().optional(), expiration_date: z.string().optional(), validity_timeframe: validityTimeframe.optional(), validity_day_of_week: validityDayOfWeek.optional(), validity_hours: validityHours.optional(), metadata: z.object({}), expiration_rules: earningRuleExpirationRules.optional(), validation_rule_id: z.string().nullable(), updated_at: z.string().nullable(), active: z.boolean()}); export const loyaltiesEarningRulesListResponseBody = z.object({object: z.literal("list").optional(), data_ref: z.string().optional(), data: z.array(earningRule).optional(), total: z.number().int().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List Earning Rules * * GET /v1/loyalties/{campaignId}/earning-rules * * Also accepts auth: X-Voucherify-OAuth */ export const getApiV1LoyaltiesCampaignIdEarningRules = async (args: GetApiV1LoyaltiesCampaignIdEarningRulesArgs, options?: GetApiV1LoyaltiesCampaignIdEarningRulesOptions) => { const {baseUrl = "https://api.voucherify.io", fetch: fetchFn = fetch, XAppId, XAppToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.page != null) query.append("page", String(args.page)) if (args.order != null) query.append("order", String(args.order)) if (XAppId !== undefined) headers.set("X-App-Id", XAppId) if (XAppToken !== undefined) headers.set("X-App-Token", XAppToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/loyalties/${encodeURIComponent(String(args.campaignId))}/earning-rules${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(loyaltiesEarningRulesListResponseBody, await res.json()) };