import {z} from 'zod' export type ParameterLimit = number; export type ParameterOrderListTransactions = 'id' | '-id'; export type ParameterString = string; export type Junction = 'and' | 'or'; export type FilterConditionsString = {$in?: Array | undefined, $not_in?: Array | undefined, $is?: string | undefined, $is_not?: string | undefined, $has_value?: string | undefined, $is_unknown?: string | undefined, $starts_with?: string | undefined, $ends_with?: string | undefined, $contains?: string | undefined, $not_contain?: string | undefined}; export type ParametersFiltersListCampaignTransactions = {junction?: Junction | undefined, id?: ({conditions?: FilterConditionsString | undefined}) | undefined, voucher_id?: ({conditions?: FilterConditionsString | undefined}) | undefined}; export type GetApiV1CampaignsCampaignIdTransactionsArgs = {limit?: ParameterLimit | undefined, order?: ParameterOrderListTransactions | undefined, starting_after_id?: ParameterString | undefined, filters?: ParametersFiltersListCampaignTransactions | undefined}; export type GetApiV1CampaignsCampaignIdTransactionsOptions = {baseUrl?: string | undefined, XAppId?: string | undefined, XAppToken?: string | undefined, fetch?: typeof fetch | undefined}; export const voucherBalance = z.object({type: z.enum(["loyalty_card", "gift_voucher"]).optional(), total: z.number().int(), object: z.literal("balance"), amount: z.number().int().optional(), points: z.number().int().optional(), balance: z.number().int(), operation_type: z.enum(["MANUAL", "AUTOMATIC"]).optional(), related_object: z.object({id: z.string(), type: z.literal("voucher")})}); export const eventSource = z.object({channel: z.enum(["USER_PORTAL", "API", "CLIENT_API", "INTERNAL"]), user: z.object({id: z.string()}).optional(), api_key: z.object({name: z.string(), app_id: z.string()}).optional()}); export const loyaltyPendingPointsDetails = z.object({loyalty_tier: z.object({id: z.string(), name: z.string()}).optional(), holder_loyalty_tier: z.object({id: z.string(), name: z.string()}).optional(), event: z.object({id: z.string().optional(), type: z.literal("customer.order.paid").optional(), group_id: z.string().optional(), entity_id: z.string().optional(), created_at: z.string().optional(), category: z.enum(["ACTION", "EFFECT"]).optional(), event_source: eventSource.optional()}), earning_rule: z.object({id: z.string(), source: z.object({banner: z.string()})}), order: z.object({id: z.string(), source_id: z.string().nullable()})}); export const loyaltyPendingPoints = z.object({id: z.string(), voucher_id: z.string(), campaign_id: z.string(), customer_id: z.string(), order_id: z.string(), points: z.number().int(), activates_at: z.string(), details: loyaltyPendingPointsDetails, created_at: z.string(), updated_at: z.string().optional()}); export const gift = z.object({amount: z.number(), subtracted_amount: z.number().int().optional(), balance: z.number(), effect: z.enum(["APPLY_TO_ORDER", "APPLY_TO_ITEMS"]).optional()}); export const discountAmountVouchersEffectTypes = z.enum(["APPLY_TO_ORDER", "APPLY_TO_ITEMS", "APPLY_TO_ITEMS_PROPORTIONALLY", "APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY", "APPLY_TO_ITEMS_BY_QUANTITY"]); export const discountUnitVouchersEffectTypes = z.enum(["ADD_MISSING_ITEMS", "ADD_NEW_ITEMS", "ADD_MANY_ITEMS", "ADD_SAME_ITEMS"]); export const simpleProductDiscountUnit = z.object({id: z.string(), source_id: z.string().optional(), name: z.string()}); export const simpleSkuDiscountUnit = z.object({id: z.string(), source_id: z.string().optional(), name: z.string()}); export const discountUnitMultipleOneUnit = z.object({unit_off: z.number().optional(), unit_off_formula: z.string().optional(), effect: z.enum(["ADD_NEW_ITEMS", "ADD_MISSING_ITEMS"]), unit_type: z.string(), product: simpleProductDiscountUnit.optional(), sku: simpleSkuDiscountUnit.optional()}); export const discountPercentVouchersEffectTypes = z.enum(["APPLY_TO_ORDER", "APPLY_TO_ITEMS"]); export const discountFixedVouchersEffectTypes = z.enum(["APPLY_TO_ORDER", "APPLY_TO_ITEMS"]); export const discount = z.union([z.object({type: z.literal("AMOUNT"), amount_off: z.number(), amount_off_formula: z.string().optional(), aggregated_amount_limit: z.number().int().optional(), effect: discountAmountVouchersEffectTypes.optional(), is_dynamic: z.boolean().optional()}), z.object({type: z.literal("UNIT"), unit_off: z.number().int().optional(), unit_off_formula: z.string().optional(), effect: discountUnitVouchersEffectTypes.optional(), unit_type: z.string(), product: simpleProductDiscountUnit.optional(), sku: simpleSkuDiscountUnit.optional(), is_dynamic: z.boolean().optional()}), z.object({type: z.literal("UNIT"), effect: z.literal("ADD_MANY_ITEMS").optional(), units: z.array(discountUnitMultipleOneUnit)}), z.object({type: z.literal("PERCENT"), percent_off: z.number(), percent_off_formula: z.string().optional(), amount_limit: z.number().optional(), aggregated_amount_limit: z.number().int().optional(), effect: discountPercentVouchersEffectTypes.optional(), is_dynamic: z.boolean().optional()}), z.object({type: z.literal("FIXED"), fixed_amount: z.number(), fixed_amount_formula: z.string().optional(), effect: discountFixedVouchersEffectTypes.optional(), is_dynamic: z.boolean().optional()})]); export const simpleLoyaltyCard = z.object({points: z.number().int(), balance: z.number().int().optional(), next_expiration_date: z.string().optional(), next_expiration_points: z.number().int().optional(), pending_points: z.number().int().optional(), expired_points: z.number().int().optional(), subtracted_points: z.number().int().optional()}); export const category = z.object({id: z.string(), name: z.string(), hierarchy: z.number().int().gte(0), object: z.literal("category"), created_at: z.string(), updated_at: z.string().optional()}); export const simpleVoucher = z.object({id: z.string().optional(), code: z.string(), gift: gift.optional(), discount: discount.optional(), loyalty_card: simpleLoyaltyCard.optional(), type: z.enum(["DISCOUNT_VOUCHER", "LOYALTY_CARD", "GIFT_VOUCHER"]), campaign: z.string().optional(), campaign_id: z.string().optional(), is_referral_code: z.boolean().optional(), holder_id: z.string().optional(), referrer_id: z.string().optional(), category_id: z.string().nullable().optional(), categories: z.array(category).optional(), active: z.boolean().optional(), created_at: z.string(), updated_at: z.string().optional(), redemption: z.object({quantity: z.number().int().nullable(), redeemed_quantity: z.number().int(), redeemed_points: z.number().int().optional()}).optional(), start_date: z.string().optional(), expiration_date: z.string().optional(), metadata: z.object({}).optional(), object: z.literal("voucher")}); export const giftVoucherTransactionsType = z.enum(["CREDITS_REDEMPTION", "CREDITS_REFUND", "CREDITS_ADDITION", "CREDITS_REMOVAL"]); export const loyaltyCardTransactionsType = z.enum(["PENDING_POINTS_ACTIVATION", "POINTS_ACCRUAL", "POINTS_REDEMPTION", "POINTS_REFUND", "POINTS_ADDITION", "POINTS_REMOVAL", "POINTS_EXPIRATION", "POINTS_TRANSFER_IN", "POINTS_TRANSFER_OUT"]); export const voucherTransaction = z.object({id: z.string(), source_id: z.string().nullable(), voucher_id: z.string(), campaign_id: z.string(), source: z.string().nullable(), reason: z.string().nullable(), related_transaction_id: z.string().nullable(), created_at: z.string(), details: z.object({balance: voucherBalance.optional(), order: z.object({id: z.string(), source_id: z.string()}).optional(), event: z.object({id: z.string(), type: z.string()}).optional(), earning_rule: z.object({id: z.string(), source: z.object({banner: z.string()})}).optional(), segment: z.object({id: z.string(), name: z.string()}).optional(), loyalty_tier: z.object({id: z.string(), name: z.string()}).optional(), redemption: z.object({id: z.string()}).optional(), rollback: z.object({id: z.string()}).optional(), custom_event: z.object({id: z.string(), type: z.string()}).optional(), event_schema: z.object({id: z.string(), name: z.string()}).optional(), holder_loyalty_tier: z.object({id: z.string(), name: z.string()}).optional(), pending_points: loyaltyPendingPoints.optional(), reward: z.object({id: z.string(), name: z.string()}).optional(), source_voucher: simpleVoucher.optional(), destination_voucher: simpleVoucher.optional()}), type: z.union([giftVoucherTransactionsType, loyaltyCardTransactionsType])}); export const campaignsTransactionsListResponseBody = z.object({object: z.literal("list"), data_ref: z.literal("data"), data: z.array(voucherTransaction), has_more: z.boolean(), more_starting_after: z.string().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 Campaign Transactions * * GET /v1/campaigns/{campaignId}/transactions * * Also accepts auth: X-Voucherify-OAuth */ export const getApiV1CampaignsCampaignIdTransactions = async (args: GetApiV1CampaignsCampaignIdTransactionsArgs, options?: GetApiV1CampaignsCampaignIdTransactionsOptions) => { 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.order != null) query.append("order", String(args.order)) if (args.starting_after_id != null) query.append("starting_after_id", String(args.starting_after_id)) if (args.filters != null) query.append("filters", JSON.stringify(args.filters)) if (XAppId !== undefined) headers.set("X-App-Id", XAppId) if (XAppToken !== undefined) headers.set("X-App-Token", XAppToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/campaigns/${encodeURIComponent(String(args.campaignId))}/transactions${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(campaignsTransactionsListResponseBody, await res.json()) };