import {z} from 'zod' export type LoyaltiesCardDefinitionsListRequestQueryId = {conditions: {$is?: (string | Array) | undefined, $is_not?: (string | Array) | undefined, $in?: (string | Array) | undefined, $not_in?: (string | Array) | undefined}}; export type LoyaltiesCardDefinitionsListRequestQueryName = {conditions: {$is?: (string | Array) | undefined, $is_not?: (string | Array) | undefined, $contains?: (string | Array) | undefined, $not_contain?: (string | Array) | undefined, $starts_with?: (string | Array) | undefined, $ends_with?: (string | Array) | undefined, $in?: (string | Array) | undefined, $not_in?: (string | Array) | undefined, $has_value?: (string | Array) | undefined, $is_unknown?: (string | Array) | undefined}}; export type LoyaltiesCardDefinitionsListRequestQueryType = {conditions: {$is?: ('INDIVIDUAL' | Array<'INDIVIDUAL'>) | undefined, $is_not?: ('INDIVIDUAL' | Array<'INDIVIDUAL'>) | undefined, $in?: ('INDIVIDUAL' | Array<'INDIVIDUAL'>) | undefined, $not_in?: ('INDIVIDUAL' | Array<'INDIVIDUAL'>) | undefined}}; export type LoyaltiesCardDefinitionsListRequestQueryStatus = {conditions: {$is?: ('ACTIVE' | 'DRAFT' | Array<'ACTIVE' | 'DRAFT'>) | undefined, $is_not?: ('ACTIVE' | 'DRAFT' | Array<'ACTIVE' | 'DRAFT'>) | undefined, $in?: ('ACTIVE' | 'DRAFT' | Array<'ACTIVE' | 'DRAFT'>) | undefined, $not_in?: ('ACTIVE' | 'DRAFT' | Array<'ACTIVE' | 'DRAFT'>) | undefined}}; export type CardDefinitionDateFilter = {conditions: {$before?: (string | Array) | undefined, $after?: (string | Array) | undefined, $is?: (string | Array) | undefined, $more_than?: (string | Array) | undefined, $less_than?: (string | Array) | undefined, $has_value?: (string | Array) | undefined, $is_unknown?: (string | Array) | undefined}}; export type LoyaltiesCardDefinitionsListRequestQuery = {junction?: ('AND' | 'OR' | 'null' | null) | undefined, id?: (LoyaltiesCardDefinitionsListRequestQueryId | null) | undefined, name?: (LoyaltiesCardDefinitionsListRequestQueryName | null) | undefined, type?: (LoyaltiesCardDefinitionsListRequestQueryType | null) | undefined, status?: (LoyaltiesCardDefinitionsListRequestQueryStatus | null) | undefined, created_at?: (CardDefinitionDateFilter | null) | undefined, updated_at?: (CardDefinitionDateFilter | null) | undefined}; export type GetApiV2LoyaltiesCardDefinitionsArgs = {limit?: (number | string | null) | undefined, order?: ('-name' | 'name' | '-type' | 'type' | '-status' | 'status' | '-created_at' | 'created_at' | Array<'-name' | 'name' | '-type' | 'type' | '-status' | 'status' | '-created_at' | 'created_at'> | null) | undefined, cursor?: (string | null) | undefined, filters?: (LoyaltiesCardDefinitionsListRequestQuery | null) | undefined}; export type GetApiV2LoyaltiesCardDefinitionsOptions = {baseUrl?: string | undefined, XAppId?: string | undefined, XAppToken?: string | undefined, fetch?: typeof fetch | undefined}; export const loyaltyV2ActivityCardDefinitionCodeConfig = z.object({pattern: z.string(), length: z.number().int(), charset: z.string(), prefix: z.string(), postfix: z.string()}); export const loyaltyV2ActivityCardDefinitionPeriod = z.object({value: z.number().int(), unit: z.enum(["DAY", "MONTH", "YEAR"])}); export const loyaltyV2ActivityCardDefinitionPointsExpirationRollingExpirationRounding = z.object({type: z.enum(["END_OF_MONTH", "END_OF_QUARTER", "END_OF_HALF_YEAR", "END_OF_YEAR", "END_OF_PARTICULAR_MONTH"]), value: z.number().int().gte(1).lte(12).optional()}); export const cardDefinitionPointsExpirationRollingExpiration = z.object({period: loyaltyV2ActivityCardDefinitionPeriod, rounding: loyaltyV2ActivityCardDefinitionPointsExpirationRollingExpirationRounding.nullable().optional()}); export const loyaltyV2ActivityCardDefinitionCalendarDate = z.object({day: z.number().int().gte(1).lte(31), month: z.number().int().gte(1).lte(12)}); export const cardDefinitionPointsExpirationCalendarExpiration = z.object({expiration_dates: z.array(loyaltyV2ActivityCardDefinitionCalendarDate)}); export const cardDefinitionPointsExpirationSlidingExpiration = z.object({earning_activity: z.boolean().optional(), spending_activity: z.boolean().optional(), custom_activity: z.boolean().optional(), custom_activity_types: z.array(z.string()), period: loyaltyV2ActivityCardDefinitionPeriod}); export const cardDefinitionPointsExpiration = z.object({type: z.enum(["NO_EXPIRATION", "ROLLING_EXPIRATION", "CALENDAR_EXPIRATION", "SLIDING_EXPIRATION"]), rolling_expiration: cardDefinitionPointsExpirationRollingExpiration.optional(), calendar_expiration: cardDefinitionPointsExpirationCalendarExpiration.optional(), sliding_expiration: cardDefinitionPointsExpirationSlidingExpiration.optional()}); export const cardDefinitionPendingPointsPeriodBased = z.object({period: loyaltyV2ActivityCardDefinitionPeriod}); export const cardDefinitionPendingPointsFixedDates = z.object({dates: z.array(loyaltyV2ActivityCardDefinitionCalendarDate)}); export const cardDefinitionPendingPointsEventBased = z.object({event_types: z.array(z.string()), cancel_period: loyaltyV2ActivityCardDefinitionPeriod}); export const cardDefinitionPendingPoints = z.object({type: z.enum(["IMMEDIATE", "PERIOD_BASED", "FIXED_DATES", "EVENT_BASED"]), period_based: cardDefinitionPendingPointsPeriodBased.optional(), fixed_dates: cardDefinitionPendingPointsFixedDates.optional(), event_based: cardDefinitionPendingPointsEventBased.optional()}); export const loyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod = z.object({type: z.literal("CURRENT_PERIOD"), current_period: z.object({unit: z.enum(["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"])}).optional()}); export const loyaltyV2ActivityCardDefinitionLimitTimeBasedPoints = z.object({max: z.number().int()}); export const cardDefinitionEarningLimitsGlobalLimit = z.discriminatedUnion("type", [z.object({type: z.literal("BALANCE_BASED"), max: z.number().int()}), z.object({type: z.literal("TIME_BASED"), period: loyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod.optional(), points: loyaltyV2ActivityCardDefinitionLimitTimeBasedPoints.optional()})]); export const cardDefinitionEarningLimitsGlobal = z.object({type: z.enum(["NO_LIMIT", "LIMITED"]), limits: z.array(cardDefinitionEarningLimitsGlobalLimit)}); export const loyaltyV2ActivityCardDefinitionEarningLimitsTransactionsLimit = z.discriminatedUnion("type", [z.object({type: z.literal("POINTS"), max: z.number().int()}), z.object({type: z.literal("SPENDING"), min_amount: z.number().int()})]); export const cardDefinitionEarningLimitsTransactions = z.object({type: z.enum(["NO_LIMIT", "LIMITED"]), limits: z.array(loyaltyV2ActivityCardDefinitionEarningLimitsTransactionsLimit)}); export const cardDefinitionEarningLimits = z.object({global: cardDefinitionEarningLimitsGlobal.optional(), transactions: cardDefinitionEarningLimitsTransactions.optional()}); export const cardDefinitionSpendingLimitsGlobalLimit = z.discriminatedUnion("type", [z.object({type: z.literal("SPENDING_BASED"), max: z.number().int()}), z.object({type: z.literal("TIME_BASED"), period: loyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod.optional(), points: loyaltyV2ActivityCardDefinitionLimitTimeBasedPoints.optional()})]); export const cardDefinitionSpendingLimitsGlobal = z.object({type: z.enum(["NO_LIMIT", "LIMITED"]), limits: z.array(cardDefinitionSpendingLimitsGlobalLimit)}); export const loyaltyV2ActivityCardDefinitionSpendingLimitsTransactionsLimit = z.object({type: z.literal("POINTS"), max: z.number().int()}); export const cardDefinitionSpendingLimitsTransactions = z.object({type: z.enum(["NO_LIMIT", "LIMITED"]), limits: z.array(loyaltyV2ActivityCardDefinitionSpendingLimitsTransactionsLimit)}); export const cardDefinitionSpendingLimits = z.object({global: cardDefinitionSpendingLimitsGlobal.optional(), transactions: cardDefinitionSpendingLimitsTransactions.optional()}); export const loyaltyV2ActivityCardDefinitionRefundsSpentPointsMethod = z.object({type: z.literal("RETURN_POINTS"), mode: z.enum(["REFUND_ALL", "REFUND_ITEM", "REFUND_AMOUNT"])}); export const cardDefinitionRefundsSpentPoints = z.object({type: z.enum(["NONE", "REFUNDABLE"]), methods: z.array(loyaltyV2ActivityCardDefinitionRefundsSpentPointsMethod)}); export const loyaltyV2ActivityCardDefinitionRefundsEarnedPointsMethod = z.discriminatedUnion("type", [z.object({type: z.literal("REVOKE_FROM_PENDING")}), z.object({type: z.literal("REVOKE_FROM_BALANCE"), mode: z.enum(["REVOKE_TO_ZERO", "REVOKE_BELOW_ZERO"])})]); export const cardDefinitionRefundsEarnedPoints = z.object({type: z.enum(["NONE", "REFUNDABLE"]), methods: z.array(loyaltyV2ActivityCardDefinitionRefundsEarnedPointsMethod)}); export const cardDefinitionRefunds = z.object({spent_points: cardDefinitionRefundsSpentPoints, earned_points: cardDefinitionRefundsEarnedPoints}); export const loyaltyV2ActivityCardDefinitionBalanceSettings = z.object({allow_negative: z.boolean()}); export const loyaltyV2ActivityCardDefinitionPayWithPoints = z.object({type: z.enum(["NO_PAYMENTS", "EXCHANGE_RATIO"]), exchange_ratio: z.object({formula: z.string()}).optional()}); export const cardDefinition = z.object({id: z.string(), name: z.string(), type: z.literal("INDIVIDUAL"), status: z.enum(["DRAFT", "ACTIVE", "DELETED"]), code_config: loyaltyV2ActivityCardDefinitionCodeConfig, points_expiration: cardDefinitionPointsExpiration, pending_points: cardDefinitionPendingPoints, earning_limits: cardDefinitionEarningLimits, spending_limits: cardDefinitionSpendingLimits, refunds: cardDefinitionRefunds, balance_settings: loyaltyV2ActivityCardDefinitionBalanceSettings, pay_with_points: loyaltyV2ActivityCardDefinitionPayWithPoints, metadata: z.object({}), created_at: z.string(), updated_at: z.string().nullable(), object: z.literal("card_definition")}); export const cardDefinitionListCursor = z.object({next: z.string(), expires_at: z.string().optional()}); export const v2LoyaltiesCardDefinitionsListResponseBody = z.object({data: z.array(cardDefinition), cursor: cardDefinitionListCursor.nullable(), object: z.literal("list")}); 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 Card Definitions * * GET /v2/loyalties/card-definitions * * Also accepts auth: bearerAuth */ export const getApiV2LoyaltiesCardDefinitions = async (args: GetApiV2LoyaltiesCardDefinitionsArgs, options?: GetApiV2LoyaltiesCardDefinitionsOptions) => { 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.cursor != null) query.append("cursor", String(args.cursor)) 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(/\/+$/, '')}/v2/loyalties/card-definitions${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(v2LoyaltiesCardDefinitionsListResponseBody, await res.json()) };