@openlup/platform 0.17.0 → 0.18.0

package/dist/promotions/adminPromotionCodesContracts.d.ts

@@ -0,0 +1,498 @@
+import { z } from "./validation.js";
+export declare const PROMOTION_CODE_STATUSES: readonly ["draft", "active", "paused", "archived"];
+export declare const PROMOTION_CODE_EFFECTIVE_STATUSES: readonly ["active", "draft", "paused", "scheduled", "expired", "archived"];
+export declare const PROMOTION_CODE_STATUS_FILTERS: readonly ["active", "draft", "paused", "scheduled", "expired", "archived", "expired_or_archived"];
+export declare const PROMOTION_CODE_SCOPES: readonly ["one_time", "subscription_initial"];
+export declare const promotionCodeBenefitSchema: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+    lane: z.ZodLiteral<"product">;
+    kind: z.ZodLiteral<"target_percentage">;
+    valueBps: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"product">;
+    kind: z.ZodLiteral<"fixed_amount">;
+    valueMinor: z.ZodNumber;
+}, z.core.$strict>]>, z.ZodUnion<readonly [z.ZodObject<{
+    lane: z.ZodLiteral<"shipping">;
+    kind: z.ZodLiteral<"percentage">;
+    valueBps: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"shipping">;
+    kind: z.ZodLiteral<"fixed_amount">;
+    valueMinor: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"shipping">;
+    kind: z.ZodLiteral<"free_shipping">;
+}, z.core.$strict>]>, z.ZodObject<{
+    lane: z.ZodLiteral<"product">;
+    kind: z.ZodLiteral<"percentage">;
+    valueBps: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"shipping">;
+    kind: z.ZodLiteral<"percentage">;
+    valueBps: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"product">;
+    kind: z.ZodLiteral<"fixed_amount">;
+    valueMinor: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodLiteral<"shipping">;
+    kind: z.ZodLiteral<"fixed_amount">;
+    valueMinor: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    lane: z.ZodEnum<{
+        product: "product";
+        shipping: "shipping";
+    }>;
+    kind: z.ZodEnum<{
+        percentage: "percentage";
+        fixed_amount: "fixed_amount";
+    }>;
+    validationState: z.ZodLiteral<"unsupported_legacy_value">;
+}, z.core.$strict>]>;
+export declare const promotionCodePreviewContextSchema: z.ZodObject<{
+    referenceProductMinor: z.ZodNumber;
+    oneTimeProductMinor: z.ZodNumber;
+    subscriptionProductMinor: z.ZodNumber;
+    shippingMinor: z.ZodNumber;
+}, z.core.$strict>;
+export declare const promotionCodePreviewRequestSchema: z.ZodObject<{
+    benefits: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"target_percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>]>, z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"free_shipping">;
+    }, z.core.$strict>]>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodEnum<{
+            product: "product";
+            shipping: "shipping";
+        }>;
+        kind: z.ZodEnum<{
+            percentage: "percentage";
+            fixed_amount: "fixed_amount";
+        }>;
+        validationState: z.ZodLiteral<"unsupported_legacy_value">;
+    }, z.core.$strict>]>>;
+    scopes: z.ZodArray<z.ZodEnum<{
+        one_time: "one_time";
+        subscription_initial: "subscription_initial";
+    }>>;
+    promotionEngineVersion: z.ZodDefault<z.ZodEnum<{
+        "promotion-engine.v2": "promotion-engine.v2";
+        "promotion-engine.v1": "promotion-engine.v1";
+    }>>;
+    minimumReferenceMinor: z.ZodDefault<z.ZodNumber>;
+    context: z.ZodObject<{
+        referenceProductMinor: z.ZodNumber;
+        oneTimeProductMinor: z.ZodNumber;
+        subscriptionProductMinor: z.ZodNumber;
+        shippingMinor: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export declare const promotionCodePreviewResultSchema: z.ZodObject<{
+    scope: z.ZodEnum<{
+        one_time: "one_time";
+        subscription_initial: "subscription_initial";
+    }>;
+    productPayableMinor: z.ZodNumber;
+    shippingPayableMinor: z.ZodNumber;
+    effectiveProductDiscountBps: z.ZodNumber;
+    winner: z.ZodEnum<{
+        code: "code";
+        automatic: "automatic";
+    }>;
+    floorApplied: z.ZodBoolean;
+    adjustments: z.ZodArray<z.ZodObject<{
+        lane: z.ZodEnum<{
+            product: "product";
+            shipping: "shipping";
+        }>;
+        kind: z.ZodEnum<{
+            target_percentage: "target_percentage";
+            percentage: "percentage";
+            fixed_amount: "fixed_amount";
+            free_shipping: "free_shipping";
+        }>;
+        amountOffMinor: z.ZodNumber;
+        beforeMinor: z.ZodNumber;
+        afterMinor: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const promotionCodePreviewResponseSchema: z.ZodObject<{
+    contractVersion: z.ZodLiteral<"commerce.v0">;
+    promotionEngineVersion: z.ZodEnum<{
+        "promotion-engine.v2": "promotion-engine.v2";
+        "promotion-engine.v1": "promotion-engine.v1";
+    }>;
+    previewProof: z.ZodString;
+    results: z.ZodArray<z.ZodObject<{
+        scope: z.ZodEnum<{
+            one_time: "one_time";
+            subscription_initial: "subscription_initial";
+        }>;
+        productPayableMinor: z.ZodNumber;
+        shippingPayableMinor: z.ZodNumber;
+        effectiveProductDiscountBps: z.ZodNumber;
+        winner: z.ZodEnum<{
+            code: "code";
+            automatic: "automatic";
+        }>;
+        floorApplied: z.ZodBoolean;
+        adjustments: z.ZodArray<z.ZodObject<{
+            lane: z.ZodEnum<{
+                product: "product";
+                shipping: "shipping";
+            }>;
+            kind: z.ZodEnum<{
+                target_percentage: "target_percentage";
+                percentage: "percentage";
+                fixed_amount: "fixed_amount";
+                free_shipping: "free_shipping";
+            }>;
+            amountOffMinor: z.ZodNumber;
+            beforeMinor: z.ZodNumber;
+            afterMinor: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const promotionCodeCreateRequestSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    code: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"automatic">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"manual">;
+        value: z.ZodString;
+    }, z.core.$strict>], "kind">;
+    benefits: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"target_percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>]>, z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"free_shipping">;
+    }, z.core.$strict>]>]>>;
+    scopes: z.ZodArray<z.ZodEnum<{
+        one_time: "one_time";
+        subscription_initial: "subscription_initial";
+    }>>;
+    validFrom: z.ZodString;
+    validTo: z.ZodNullable<z.ZodString>;
+    minimumReferenceMinor: z.ZodDefault<z.ZodNumber>;
+    redemptionLimitGlobal: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    redemptionLimitPerCustomer: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+    }>>;
+    previewContext: z.ZodOptional<z.ZodObject<{
+        referenceProductMinor: z.ZodNumber;
+        oneTimeProductMinor: z.ZodNumber;
+        subscriptionProductMinor: z.ZodNumber;
+        shippingMinor: z.ZodNumber;
+    }, z.core.$strict>>;
+    previewProof: z.ZodOptional<z.ZodString>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>;
+export declare const promotionCodeCreateResponseSchema: z.ZodObject<{
+    contractVersion: z.ZodLiteral<"commerce.v0">;
+    id: z.ZodString;
+    code: z.ZodString;
+    status: z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+        paused: "paused";
+    }>;
+    revision: z.ZodNumber;
+    idempotent: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const promotionCodeUpdateRequestSchema: z.ZodObject<{
+    id: z.ZodString;
+    expectedRevision: z.ZodNumber;
+    updates: z.ZodObject<{
+        status: z.ZodOptional<z.ZodEnum<{
+            draft: "draft";
+            active: "active";
+            archived: "archived";
+            paused: "paused";
+        }>>;
+        validFrom: z.ZodOptional<z.ZodString>;
+        validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        redemptionLimitGlobal: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        redemptionLimitPerCustomer: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strict>;
+    previewContext: z.ZodOptional<z.ZodObject<{
+        referenceProductMinor: z.ZodNumber;
+        oneTimeProductMinor: z.ZodNumber;
+        subscriptionProductMinor: z.ZodNumber;
+        shippingMinor: z.ZodNumber;
+    }, z.core.$strict>>;
+    previewProof: z.ZodOptional<z.ZodString>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>;
+export declare const promotionCodeUpdateResponseSchema: z.ZodObject<{
+    contractVersion: z.ZodLiteral<"commerce.v0">;
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+        paused: "paused";
+    }>;
+    revision: z.ZodNumber;
+    idempotent: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const promotionCodesListRequestSchema: z.ZodObject<{
+    q: z.ZodOptional<z.ZodString>;
+    status: z.ZodDefault<z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+        all: "all";
+        expired: "expired";
+        paused: "paused";
+        scheduled: "scheduled";
+        expired_or_archived: "expired_or_archived";
+    }>>;
+    scope: z.ZodDefault<z.ZodEnum<{
+        one_time: "one_time";
+        all: "all";
+        subscription_initial: "subscription_initial";
+        shipping: "shipping";
+        both: "both";
+    }>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strict>;
+export declare const promotionCodeSummarySchema: z.ZodObject<{
+    id: z.ZodString;
+    code: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    benefits: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"target_percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>]>, z.ZodUnion<readonly [z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"free_shipping">;
+    }, z.core.$strict>]>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"percentage">;
+        valueBps: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"product">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodLiteral<"shipping">;
+        kind: z.ZodLiteral<"fixed_amount">;
+        valueMinor: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        lane: z.ZodEnum<{
+            product: "product";
+            shipping: "shipping";
+        }>;
+        kind: z.ZodEnum<{
+            percentage: "percentage";
+            fixed_amount: "fixed_amount";
+        }>;
+        validationState: z.ZodLiteral<"unsupported_legacy_value">;
+    }, z.core.$strict>]>>;
+    promotionEngineVersion: z.ZodEnum<{
+        "promotion-engine.v2": "promotion-engine.v2";
+        "promotion-engine.v1": "promotion-engine.v1";
+    }>;
+    scopes: z.ZodArray<z.ZodEnum<{
+        one_time: "one_time";
+        subscription_initial: "subscription_initial";
+    }>>;
+    status: z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+        paused: "paused";
+    }>;
+    effectiveStatus: z.ZodEnum<{
+        draft: "draft";
+        active: "active";
+        archived: "archived";
+        expired: "expired";
+        paused: "paused";
+        scheduled: "scheduled";
+    }>;
+    validFrom: z.ZodString;
+    validTo: z.ZodNullable<z.ZodString>;
+    minimumReferenceMinor: z.ZodNumber;
+    redemptionLimitGlobal: z.ZodNullable<z.ZodNumber>;
+    redemptionLimitPerCustomer: z.ZodNullable<z.ZodNumber>;
+    redeemedCount: z.ZodNumber;
+    reservedCount: z.ZodNumber;
+    remainingCount: z.ZodNullable<z.ZodNumber>;
+    createdAt: z.ZodString;
+    revision: z.ZodNumber;
+}, z.core.$strip>;
+export declare const promotionCodesListResponseSchema: z.ZodObject<{
+    contractVersion: z.ZodLiteral<"commerce.v0">;
+    codes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        code: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        benefits: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+            lane: z.ZodLiteral<"product">;
+            kind: z.ZodLiteral<"target_percentage">;
+            valueBps: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"product">;
+            kind: z.ZodLiteral<"fixed_amount">;
+            valueMinor: z.ZodNumber;
+        }, z.core.$strict>]>, z.ZodUnion<readonly [z.ZodObject<{
+            lane: z.ZodLiteral<"shipping">;
+            kind: z.ZodLiteral<"percentage">;
+            valueBps: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"shipping">;
+            kind: z.ZodLiteral<"fixed_amount">;
+            valueMinor: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"shipping">;
+            kind: z.ZodLiteral<"free_shipping">;
+        }, z.core.$strict>]>, z.ZodObject<{
+            lane: z.ZodLiteral<"product">;
+            kind: z.ZodLiteral<"percentage">;
+            valueBps: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"shipping">;
+            kind: z.ZodLiteral<"percentage">;
+            valueBps: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"product">;
+            kind: z.ZodLiteral<"fixed_amount">;
+            valueMinor: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodLiteral<"shipping">;
+            kind: z.ZodLiteral<"fixed_amount">;
+            valueMinor: z.ZodNumber;
+        }, z.core.$strict>, z.ZodObject<{
+            lane: z.ZodEnum<{
+                product: "product";
+                shipping: "shipping";
+            }>;
+            kind: z.ZodEnum<{
+                percentage: "percentage";
+                fixed_amount: "fixed_amount";
+            }>;
+            validationState: z.ZodLiteral<"unsupported_legacy_value">;
+        }, z.core.$strict>]>>;
+        promotionEngineVersion: z.ZodEnum<{
+            "promotion-engine.v2": "promotion-engine.v2";
+            "promotion-engine.v1": "promotion-engine.v1";
+        }>;
+        scopes: z.ZodArray<z.ZodEnum<{
+            one_time: "one_time";
+            subscription_initial: "subscription_initial";
+        }>>;
+        status: z.ZodEnum<{
+            draft: "draft";
+            active: "active";
+            archived: "archived";
+            paused: "paused";
+        }>;
+        effectiveStatus: z.ZodEnum<{
+            draft: "draft";
+            active: "active";
+            archived: "archived";
+            expired: "expired";
+            paused: "paused";
+            scheduled: "scheduled";
+        }>;
+        validFrom: z.ZodString;
+        validTo: z.ZodNullable<z.ZodString>;
+        minimumReferenceMinor: z.ZodNumber;
+        redemptionLimitGlobal: z.ZodNullable<z.ZodNumber>;
+        redemptionLimitPerCustomer: z.ZodNullable<z.ZodNumber>;
+        redeemedCount: z.ZodNumber;
+        reservedCount: z.ZodNumber;
+        remainingCount: z.ZodNullable<z.ZodNumber>;
+        createdAt: z.ZodString;
+        revision: z.ZodNumber;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+    capabilities: z.ZodObject<{
+        mutationsEnabled: z.ZodBoolean;
+    }, z.core.$strict>;
+    legacyCompatibility: z.ZodObject<{
+        ready: z.ZodBoolean;
+        unprojectedCount: z.ZodNumber;
+        collisionGroupCount: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strip>;
+export type PromotionCodeBenefit = z.infer<typeof promotionCodeBenefitSchema>;
+export type PromotionCodePreviewRequest = z.infer<typeof promotionCodePreviewRequestSchema>;
+export type PromotionCodePreviewResponse = z.infer<typeof promotionCodePreviewResponseSchema>;
+export type PromotionCodeCreateRequest = z.infer<typeof promotionCodeCreateRequestSchema>;
+export type PromotionCodeCreateResponse = z.infer<typeof promotionCodeCreateResponseSchema>;
+export type PromotionCodeUpdateRequest = z.infer<typeof promotionCodeUpdateRequestSchema>;
+export type PromotionCodeUpdateResponse = z.infer<typeof promotionCodeUpdateResponseSchema>;
+export type PromotionCodesListRequest = z.infer<typeof promotionCodesListRequestSchema>;
+export type PromotionCodeSummary = z.infer<typeof promotionCodeSummarySchema>;
+export type PromotionCodesListResponse = z.infer<typeof promotionCodesListResponseSchema>;