@compassdigital/sdk.typescript 4.598.0 → 4.600.0

package/lib/interface/loyalty.d.ts

@@ -0,0 +1,853 @@
+export interface BundleResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    realm: 'boost' | 'thrive';
+    siteId?: string | null;
+    name: string;
+    description?: string | null;
+}
+export interface BundlePaginationDto {
+    cursor?: string | null;
+    hasMore: boolean;
+    limit: number;
+}
+export interface BundleListResponseDto {
+    data: BundleResponseDto[];
+    pagination: BundlePaginationDto;
+}
+export interface ErrorDisplayMessage {
+    title: string;
+    description: string;
+}
+export interface ErrorData {
+    statusCode: number;
+    statusText: string;
+    timestamp: string;
+    displayMessage: ErrorDisplayMessage;
+}
+export interface Error {
+    code: number;
+    message: string;
+    data: ErrorData;
+}
+export interface BundleGroupDto {
+    groupName: string;
+    minimumQuantity: number;
+    itemIds: string[];
+}
+export interface BundleDetailResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    realm: 'boost' | 'thrive';
+    siteId?: string | null;
+    name: string;
+    description?: string | null;
+    groups: BundleGroupDto[];
+}
+export interface CreateBundleDto {
+    realm: 'boost' | 'thrive';
+    siteId?: string;
+    name: string;
+    description?: string;
+    groups: BundleGroupDto[];
+}
+export interface UpdateBundleDto {
+    realm?: 'boost' | 'thrive';
+    siteId?: string;
+    name?: string;
+    description?: string;
+    groups?: BundleGroupDto[];
+}
+export interface CampaignResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    updatedBy: string;
+    realm: 'boost' | 'thrive';
+    name: string;
+    description?: string | null;
+    type: 'promo_code' | 'auto_apply';
+    status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+    discountType: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+    discountScope: 'order' | 'items';
+    discountValueCents?: number | null;
+    discountPercent?: number | null;
+    appliesToCheapest: boolean;
+    maxDiscountCents?: number | null;
+    codeType: 'open' | 'personal' | 'auto_applied';
+    startDate?: string | null;
+    endDate?: string | null;
+    maxRedemptions?: number | null;
+    maxRedemptionsPerCustomer?: number | null;
+    maxRedemptionsDaily?: number | null;
+    maxRedemptionsPerCustomerDaily?: number | null;
+    minOrderValueCents?: number | null;
+    maxOrderValueCents?: number | null;
+    bundleId?: string | null;
+}
+export interface CampaignPaginationDto {
+    cursor?: string | null;
+    hasMore: boolean;
+    limit: number;
+}
+export interface CampaignListResponseDto {
+    data: CampaignResponseDto[];
+    pagination: CampaignPaginationDto;
+}
+export interface CampaignDailyScheduleResponseDto {
+    id: string;
+    campaignId: string;
+    dayOfWeek: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun';
+    active: boolean;
+    startTime: string;
+    endTime: string;
+}
+export interface CampaignEligibilityResponseDto {
+    id: string;
+    campaignId: string;
+    eligibilityType: 'everyone' | 'meal_plan' | 'badge_pay' | 'sso_group' | 'segment';
+    segmentId?: string | null;
+    maxRedemptionsPerCustomer?: number | null;
+    maxRedemptionsPerCustomerDaily?: number | null;
+}
+export interface CampaignSiteScopeResponseDto {
+    campaignId: string;
+    siteId: string;
+    excluded: boolean;
+}
+export interface CampaignStationScopeResponseDto {
+    campaignId: string;
+    siteId: string;
+    stationId: string;
+    excluded: boolean;
+}
+export interface CampaignItemTargetResponseDto {
+    id: string;
+    campaignId: string;
+    siteId?: string | null;
+    stationId?: string | null;
+    menuId?: string | null;
+    categoryId?: string | null;
+    itemId?: string | null;
+    maxDiscountCents?: number | null;
+}
+export interface CampaignDetailResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    updatedBy: string;
+    realm: 'boost' | 'thrive';
+    name: string;
+    description?: string | null;
+    type: 'promo_code' | 'auto_apply';
+    status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+    discountType: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+    discountScope: 'order' | 'items';
+    discountValueCents?: number | null;
+    discountPercent?: number | null;
+    appliesToCheapest: boolean;
+    maxDiscountCents?: number | null;
+    codeType: 'open' | 'personal' | 'auto_applied';
+    startDate?: string | null;
+    endDate?: string | null;
+    maxRedemptions?: number | null;
+    maxRedemptionsPerCustomer?: number | null;
+    maxRedemptionsDaily?: number | null;
+    maxRedemptionsPerCustomerDaily?: number | null;
+    minOrderValueCents?: number | null;
+    maxOrderValueCents?: number | null;
+    bundleId?: string | null;
+    dailySchedule: CampaignDailyScheduleResponseDto[];
+    eligibility: CampaignEligibilityResponseDto[];
+    siteScopes: CampaignSiteScopeResponseDto[];
+    stationScopes: CampaignStationScopeResponseDto[];
+    itemTargets: CampaignItemTargetResponseDto[];
+    salesChannels: ('mobile' | 'web' | 'kiosk' | 'pos')[];
+    originSystems: ('native' | 'volante' | 'nextstep' | 'agilysys')[];
+    paymentRestrictions: ('meal_plan' | 'badge_pay' | 'credit_card' | 'digital_wallet_pay')[];
+}
+export interface DailyScheduleDto {
+    dayOfWeek: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun';
+    active: boolean;
+    startTime: string;
+    endTime: string;
+}
+export interface EligibilityDto {
+    eligibilityType: 'everyone' | 'meal_plan' | 'badge_pay' | 'sso_group' | 'segment';
+    segmentId?: string;
+    maxRedemptionsPerCustomer?: number;
+    maxRedemptionsPerCustomerDaily?: number;
+}
+export interface SiteScopeDto {
+    siteId: string;
+    excluded?: boolean;
+}
+export interface StationScopeDto {
+    siteId: string;
+    stationId: string;
+    excluded?: boolean;
+}
+export interface ItemTargetDto {
+    siteId?: string;
+    stationId?: string;
+    menuId?: string;
+    categoryId?: string;
+    itemId?: string;
+    maxDiscountCents?: number;
+}
+export interface CreateCampaignDto {
+    realm: 'boost' | 'thrive';
+    name: string;
+    description?: string;
+    type: 'promo_code' | 'auto_apply';
+    discountType: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+    discountScope: 'order' | 'items';
+    discountValueCents?: number;
+    discountPercent?: number;
+    appliesToCheapest?: boolean;
+    maxDiscountCents?: number;
+    codeType: 'open' | 'personal' | 'auto_applied';
+    startDate?: string;
+    endDate?: string;
+    maxRedemptions?: number;
+    maxRedemptionsPerCustomer?: number;
+    maxRedemptionsDaily?: number;
+    maxRedemptionsPerCustomerDaily?: number;
+    minOrderValueCents?: number;
+    maxOrderValueCents?: number;
+    dailySchedule?: DailyScheduleDto[];
+    eligibility?: EligibilityDto[];
+    siteScopes?: SiteScopeDto[];
+    stationScopes?: StationScopeDto[];
+    itemTargets?: ItemTargetDto[];
+    bundleId?: string;
+    salesChannels?: ('mobile' | 'web' | 'kiosk' | 'pos')[];
+    originSystems?: ('native' | 'volante' | 'nextstep' | 'agilysys')[];
+    paymentRestrictions?: ('meal_plan' | 'badge_pay' | 'credit_card' | 'digital_wallet_pay')[];
+}
+export interface UpdateCampaignDto {
+    realm?: 'boost' | 'thrive';
+    name?: string;
+    description?: string;
+    type?: 'promo_code' | 'auto_apply';
+    discountType?: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+    discountScope?: 'order' | 'items';
+    discountValueCents?: number;
+    discountPercent?: number;
+    appliesToCheapest?: boolean;
+    maxDiscountCents?: number;
+    codeType?: 'open' | 'personal' | 'auto_applied';
+    startDate?: string;
+    endDate?: string;
+    maxRedemptions?: number;
+    maxRedemptionsPerCustomer?: number;
+    maxRedemptionsDaily?: number;
+    maxRedemptionsPerCustomerDaily?: number;
+    minOrderValueCents?: number;
+    maxOrderValueCents?: number;
+    dailySchedule?: DailyScheduleDto[];
+    eligibility?: EligibilityDto[];
+    siteScopes?: SiteScopeDto[];
+    stationScopes?: StationScopeDto[];
+    itemTargets?: ItemTargetDto[];
+    bundleId?: string;
+    salesChannels?: ('mobile' | 'web' | 'kiosk' | 'pos')[];
+    originSystems?: ('native' | 'volante' | 'nextstep' | 'agilysys')[];
+    paymentRestrictions?: ('meal_plan' | 'badge_pay' | 'credit_card' | 'digital_wallet_pay')[];
+}
+export interface UpdateCampaignStatusDto {
+    status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+    reason?: string;
+}
+export interface VoucherResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    campaignId: string;
+    realm: 'boost' | 'thrive';
+    code: string;
+    codeType: 'open' | 'personal' | 'auto_applied';
+    customerId?: string | null;
+    status: string;
+    expiresAt?: string | null;
+    issuedBy?: string | null;
+    issueReason?: string | null;
+    revokedAt?: string | null;
+    revokedBy?: string | null;
+    revokeReason?: string | null;
+    source?: string;
+    campaignName?: string;
+    campaignType?: string;
+    redemptionCount?: number;
+}
+export interface VoucherPaginationDto {
+    cursor?: string | null;
+    hasMore: boolean;
+    limit: number;
+}
+export interface VoucherListResponseDto {
+    data: VoucherResponseDto[];
+    pagination: VoucherPaginationDto;
+}
+export interface CreateVoucherDto {
+    campaignId: string;
+    code: string;
+    codeType: 'open' | 'personal' | 'auto_applied';
+    customerId?: string;
+    expiresAt?: string;
+    issueReason?: string;
+}
+export interface UpdateVoucherDto {
+    expiresAt?: string;
+    customerId?: string;
+}
+export interface RevokeVoucherDto {
+    reason: string;
+}
+export interface BatchVoucherDto {
+    campaignId: string;
+    count: number;
+    codeType: 'open' | 'personal';
+    prefix?: string;
+    expiresAt?: string;
+    customerIds?: string[];
+}
+export interface BatchVoucherResponseDto {
+    codePoolId: string;
+    count: number;
+}
+export interface RedemptionItemResponseDto {
+    id: string;
+    itemId: string;
+    itemName?: string | null;
+    originalPriceCents: number;
+    discountAmountCents: number;
+}
+export interface VoucherDiscountResponseDto {
+    type: string;
+    amount_off: number;
+    percent_off: number;
+}
+export interface VoucherRedemptionVoucherDto {
+    id: string;
+    code: string;
+    discount: VoucherDiscountResponseDto;
+}
+export interface RedemptionResponseDto {
+    id: string;
+    createdAt: string;
+    voucherId?: string | null;
+    customerId?: string | null;
+    orderId?: string | null;
+    siteId?: string | null;
+    stationId?: string | null;
+    realm?: string;
+    discountAmountCents?: number;
+    orderTotalCents?: number;
+    status?: string;
+    rolledBackAt?: string | null;
+    rollbackReason?: string | null;
+    externalRedemptionId?: string | null;
+    items?: RedemptionItemResponseDto[];
+    date?: string;
+    result?: string;
+    object?: string;
+    app?: string;
+    voucher?: VoucherRedemptionVoucherDto;
+}
+export interface RedemptionListResponseDto {
+    data: RedemptionResponseDto[];
+    pagination: VoucherPaginationDto;
+}
+export interface VoucherCustomerDto {
+    source_id?: string;
+    email?: string;
+}
+export interface VoucherOrderItemProductMetadataDto {
+    item_name?: string;
+}
+export interface VoucherOrderItemProductDto {
+    metadata?: VoucherOrderItemProductMetadataDto;
+}
+export interface VoucherOrderItemDto {
+    source_id?: string;
+    product_id?: string;
+    quantity?: number;
+    price?: number;
+    product?: VoucherOrderItemProductDto;
+}
+export interface VoucherOrderMetadataDto {
+    order_id?: string;
+    brand_id?: string;
+    site_id?: string;
+    location_group_id?: string;
+    tz?: string;
+}
+export interface VoucherOrderDto {
+    source_id?: string;
+    items?: VoucherOrderItemDto[];
+    metadata?: VoucherOrderMetadataDto;
+}
+export interface VoucherOperationDto {
+    codes: string[];
+    customer?: VoucherCustomerDto;
+    order?: VoucherOrderDto;
+}
+export interface VoucherErrorResponseDto {
+    message: string;
+}
+export interface VoucherOperationOrderResponseDto {
+    total_discount_amount: number;
+    total_applied_discount_amount: number;
+}
+export interface VoucherOperationResultResponseDto {
+    discount?: VoucherDiscountResponseDto;
+    error?: VoucherErrorResponseDto;
+}
+export interface VoucherRedeemableResponseDto {
+    status: string;
+    id: string;
+    object: string;
+    order: VoucherOperationOrderResponseDto;
+    result: VoucherOperationResultResponseDto;
+}
+export interface VoucherOperationResponseDto {
+    code?: string;
+    valid?: boolean;
+    success?: boolean;
+    app?: string;
+    discount?: VoucherDiscountResponseDto;
+    provider_data?: Record<string, any>;
+    error?: VoucherErrorResponseDto;
+    redeemables?: VoucherRedeemableResponseDto[];
+    redemptions?: RedemptionResponseDto[];
+    id?: string;
+    date?: string;
+    result?: string;
+    object?: string;
+    voucher?: VoucherRedemptionVoucherDto;
+}
+export interface SegmentRuleDto {
+    attribute: string;
+    operator: string;
+    value: string;
+}
+export interface SegmentResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    realm: 'boost' | 'thrive';
+    name: string;
+    description?: string | null;
+    type: 'static_list' | 'attribute_rule' | 'sso';
+    ownership: 'system' | 'custom';
+    editable: boolean;
+    deletable: boolean;
+    ruleJson?: SegmentRuleDto;
+    memberCount?: number;
+}
+export interface SegmentPaginationDto {
+    cursor?: string | null;
+    hasMore: boolean;
+    limit: number;
+}
+export interface SegmentListResponseDto {
+    data: SegmentResponseDto[];
+    pagination: SegmentPaginationDto;
+}
+export interface SegmentAttributeResponseDto {
+    key: string;
+    label: string;
+}
+export interface SegmentPreviewCountResponseDto {
+    count: number;
+}
+export interface CreateSegmentDto {
+    realm: 'boost' | 'thrive';
+    name: string;
+    description?: string;
+    type: 'static_list' | 'attribute_rule' | 'sso';
+    ruleJson?: SegmentRuleDto;
+    customerIds?: string[];
+}
+export interface UpdateSegmentDto {
+    name?: string;
+    description?: string;
+    ruleJson?: SegmentRuleDto;
+}
+export interface SegmentMemberResponseDto {
+    customerId: string;
+    addedAt: string;
+    addedBy: string;
+}
+export interface SegmentMembersListResponseDto {
+    data: SegmentMemberResponseDto[];
+    pagination: SegmentPaginationDto;
+}
+export interface SegmentMembersDto {
+    customerIds: string[];
+}
+export interface AddSegmentMembersResponseDto {
+    added: number;
+}
+export interface RemoveSegmentMembersResponseDto {
+    removed: number;
+}
+export interface RollbackRedemptionDto {
+    reason: string;
+}
+export interface RewardResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    realm: 'boost' | 'thrive';
+    siteId?: string | null;
+    name: string;
+    description?: string | null;
+    status: 'active' | 'paused' | 'archived';
+    earningRuleCount?: number;
+}
+export interface RewardPaginationDto {
+    cursor?: string | null;
+    hasMore: boolean;
+    limit: number;
+}
+export interface RewardListResponseDto {
+    data: RewardResponseDto[];
+    pagination: RewardPaginationDto;
+}
+export interface BrandExclusionDto {
+    siteId: string;
+    stationId: string;
+}
+export interface EarningRuleDto {
+    eventType: 'order_placed' | 'item_purchased' | 'amount_spent';
+    points: number;
+    spendThresholdCents?: number;
+    siteId?: string;
+    itemId?: string;
+    brandExclusions?: BrandExclusionDto[];
+}
+export interface MilestoneDto {
+    pointsRequired: number;
+    campaignId: string;
+    resetsAfterMilestone: boolean;
+    maxRewardCount?: number;
+}
+export interface RewardDetailResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdBy: string;
+    realm: 'boost' | 'thrive';
+    siteId?: string | null;
+    name: string;
+    description?: string | null;
+    status: 'active' | 'paused' | 'archived';
+    earningRuleCount?: number;
+    earningRules: EarningRuleDto[];
+    milestones: MilestoneDto[];
+}
+export interface CreateRewardDto {
+    realm: 'boost' | 'thrive';
+    siteId?: string;
+    name: string;
+    description?: string;
+    earningRules?: EarningRuleDto[];
+    milestones?: MilestoneDto[];
+}
+export interface UpdateRewardDto {
+    realm?: 'boost' | 'thrive';
+    siteId?: string;
+    name?: string;
+    description?: string;
+    earningRules?: EarningRuleDto[];
+    milestones?: MilestoneDto[];
+}
+export interface UpdateRewardStatusDto {
+    status: 'active' | 'paused' | 'archived';
+}
+export interface RewardCardResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    rewardId: string;
+    customerId: string;
+    pointsBalance: number;
+    lifetimePoints: number;
+    status: string;
+}
+export interface RewardCardListResponseDto {
+    data: RewardCardResponseDto[];
+    pagination: RewardPaginationDto;
+}
+export interface RewardEventResponseDto {
+    id: string;
+    createdAt: string;
+    cardId: string;
+    eventType: 'order_placed' | 'item_purchased' | 'amount_spent';
+    pointsDelta: number;
+    orderId?: string | null;
+    description?: string | null;
+    adjustedBy?: string | null;
+}
+export interface RewardCardDetailResponseDto {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    rewardId: string;
+    customerId: string;
+    pointsBalance: number;
+    lifetimePoints: number;
+    status: string;
+    events: RewardEventResponseDto[];
+}
+export interface AdjustPointsDto {
+    pointsDelta: number;
+    description: string;
+}
+export interface EarnOrderItemDto {
+    id: string;
+    quantity: number;
+    priceCents?: number;
+}
+export interface EarnOrderDto {
+    orderId: string;
+    customerId: string;
+    realm: 'boost' | 'thrive';
+    siteId: string;
+    brandId: string;
+    amountCents: number;
+    items: EarnOrderItemDto[];
+    email?: string;
+    metadata?: Record<string, any>;
+}
+export interface EarnOrderResponseDto {
+    rewardId?: string | null;
+    rewardIds?: string[];
+    alreadyProcessed: boolean;
+    pointsAwarded: number;
+    issuedVoucherCodes: string[];
+}
+export interface GetLoyaltyBundlesQuery {
+    limit?: number;
+    cursor?: string;
+    realm?: 'boost' | 'thrive';
+    siteId?: string;
+    siteIds?: string[];
+    name?: string;
+}
+export type GetLoyaltyBundlesResponse = BundleListResponseDto;
+export type PostLoyaltyBundleBody = CreateBundleDto;
+export type PostLoyaltyBundleResponse = BundleDetailResponseDto;
+export interface GetLoyaltyBundlePath {
+    id: string;
+}
+export type GetLoyaltyBundleResponse = BundleDetailResponseDto;
+export interface PatchLoyaltyBundlePath {
+    id: string;
+}
+export type PatchLoyaltyBundleBody = UpdateBundleDto;
+export type PatchLoyaltyBundleResponse = BundleDetailResponseDto;
+export interface DeleteLoyaltyBundlePath {
+    id: string;
+}
+export type DeleteLoyaltyBundleResponse = {};
+export interface GetLoyaltyCampaignsQuery {
+    limit?: number;
+    cursor?: string;
+    realm?: 'boost' | 'thrive';
+    status?: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+    type?: 'promo_code' | 'auto_apply';
+    name?: string;
+    startDateFrom?: string;
+    startDateTo?: string;
+    endDateFrom?: string;
+    endDateTo?: string;
+    sortBy?: 'name' | 'createdAt' | 'startDate' | 'status';
+    sortOrder?: 'ASC' | 'DESC';
+    hasRewards?: boolean;
+}
+export type GetLoyaltyCampaignsResponse = CampaignListResponseDto;
+export type PostLoyaltyCampaignBody = CreateCampaignDto;
+export type PostLoyaltyCampaignResponse = CampaignDetailResponseDto;
+export interface GetLoyaltyCampaignPath {
+    id: string;
+}
+export type GetLoyaltyCampaignResponse = CampaignDetailResponseDto;
+export interface PutLoyaltyCampaignPath {
+    id: string;
+}
+export type PutLoyaltyCampaignBody = UpdateCampaignDto;
+export type PutLoyaltyCampaignResponse = CampaignDetailResponseDto;
+export interface DeleteLoyaltyCampaignPath {
+    id: string;
+}
+export type DeleteLoyaltyCampaignResponse = {};
+export interface PatchLoyaltyCampaignStatusPath {
+    id: string;
+}
+export type PatchLoyaltyCampaignStatusBody = UpdateCampaignStatusDto;
+export type PatchLoyaltyCampaignStatusResponse = CampaignDetailResponseDto;
+export interface PostLoyaltyCampaignClonePath {
+    id: string;
+}
+export type PostLoyaltyCampaignCloneResponse = CampaignDetailResponseDto;
+export interface GetLoyaltyVouchersQuery {
+    limit?: number;
+    cursor?: string;
+    campaignId?: string;
+    realm?: 'boost' | 'thrive';
+    status?: 'active' | 'redeemed' | 'expired' | 'revoked';
+    code?: string;
+    codeType?: 'open' | 'personal' | 'auto_applied';
+    customerId?: string;
+}
+export type GetLoyaltyVouchersResponse = VoucherListResponseDto;
+export type PostLoyaltyVoucherBody = CreateVoucherDto;
+export type PostLoyaltyVoucherResponse = VoucherResponseDto;
+export interface GetLoyaltyVoucherPath {
+    id: string;
+}
+export type GetLoyaltyVoucherResponse = VoucherResponseDto;
+export interface PutLoyaltyVoucherPath {
+    id: string;
+}
+export type PutLoyaltyVoucherBody = UpdateVoucherDto;
+export type PutLoyaltyVoucherResponse = VoucherResponseDto;
+export interface DeleteLoyaltyVoucherPath {
+    id: string;
+}
+export type DeleteLoyaltyVoucherResponse = {};
+export interface PostLoyaltyVoucherRevokePath {
+    id: string;
+}
+export type PostLoyaltyVoucherRevokeBody = RevokeVoucherDto;
+export type PostLoyaltyVoucherRevokeResponse = VoucherResponseDto;
+export type PostLoyaltyVouchersBatchBody = BatchVoucherDto;
+export type PostLoyaltyVouchersBatchResponse = BatchVoucherResponseDto;
+export interface GetLoyaltyVoucherRedemptionsPath {
+    id: string;
+}
+export interface GetLoyaltyVoucherRedemptionsQuery {
+    limit?: number;
+    cursor?: string;
+}
+export type GetLoyaltyVoucherRedemptionsResponse = RedemptionListResponseDto;
+export type PostLoyaltyVouchersValidateBody = VoucherOperationDto;
+export type PostLoyaltyVouchersValidateResponse = VoucherOperationResponseDto;
+export type PostLoyaltyVouchersRedeemBody = VoucherOperationDto;
+export type PostLoyaltyVouchersRedeemResponse = VoucherOperationResponseDto;
+export interface GetLoyaltySegmentsQuery {
+    limit?: number;
+    cursor?: string;
+    realm?: 'boost' | 'thrive';
+    type?: 'static_list' | 'attribute_rule' | 'sso';
+    ownership?: 'system' | 'custom';
+    name?: string;
+}
+export type GetLoyaltySegmentsResponse = SegmentListResponseDto;
+export type PostLoyaltySegmentBody = CreateSegmentDto;
+export type PostLoyaltySegmentResponse = SegmentResponseDto;
+export type GetLoyaltySegmentAttributesResponse = SegmentAttributeResponseDto[];
+export type PostLoyaltySegmentPreviewCountBody = SegmentRuleDto;
+export type PostLoyaltySegmentPreviewCountResponse = SegmentPreviewCountResponseDto;
+export interface GetLoyaltySegmentPath {
+    id: string;
+}
+export type GetLoyaltySegmentResponse = SegmentResponseDto;
+export interface PatchLoyaltySegmentPath {
+    id: string;
+}
+export type PatchLoyaltySegmentBody = UpdateSegmentDto;
+export type PatchLoyaltySegmentResponse = SegmentResponseDto;
+export interface DeleteLoyaltySegmentPath {
+    id: string;
+}
+export type DeleteLoyaltySegmentResponse = {};
+export interface GetLoyaltySegmentMembersPath {
+    id: string;
+}
+export interface GetLoyaltySegmentMembersQuery {
+    limit?: number;
+    cursor?: string;
+}
+export type GetLoyaltySegmentMembersResponse = SegmentMembersListResponseDto;
+export interface PostLoyaltySegmentMembersPath {
+    id: string;
+}
+export type PostLoyaltySegmentMembersBody = SegmentMembersDto;
+export type PostLoyaltySegmentMembersResponse = AddSegmentMembersResponseDto;
+export interface DeleteLoyaltySegmentMembersPath {
+    id: string;
+}
+export type DeleteLoyaltySegmentMembersBody = SegmentMembersDto;
+export type DeleteLoyaltySegmentMembersResponse = RemoveSegmentMembersResponseDto;
+export interface PostLoyaltyRedemptionRollbackPath {
+    id: string;
+}
+export type PostLoyaltyRedemptionRollbackBody = RollbackRedemptionDto;
+export type PostLoyaltyRedemptionRollbackResponse = RedemptionResponseDto;
+export interface GetLoyaltyRewardsQuery {
+    limit?: number;
+    cursor?: string;
+    query?: string;
+    realm?: 'boost' | 'thrive';
+    siteId?: string;
+    campaignId?: string;
+    status?: 'active' | 'paused' | 'archived';
+}
+export type GetLoyaltyRewardsResponse = RewardListResponseDto;
+export type PostLoyaltyRewardBody = CreateRewardDto;
+export type PostLoyaltyRewardResponse = RewardDetailResponseDto;
+export interface GetLoyaltyRewardPath {
+    id: string;
+}
+export type GetLoyaltyRewardResponse = RewardDetailResponseDto;
+export interface PutLoyaltyRewardPath {
+    id: string;
+}
+export type PutLoyaltyRewardBody = UpdateRewardDto;
+export type PutLoyaltyRewardResponse = RewardDetailResponseDto;
+export interface PatchLoyaltyRewardStatusPath {
+    id: string;
+}
+export type PatchLoyaltyRewardStatusBody = UpdateRewardStatusDto;
+export type PatchLoyaltyRewardStatusResponse = RewardDetailResponseDto;
+export interface GetLoyaltyRewardCardsPath {
+    id: string;
+}
+export interface GetLoyaltyRewardCardsQuery {
+    limit?: number;
+    cursor?: string;
+}
+export type GetLoyaltyRewardCardsResponse = RewardCardListResponseDto;
+export interface GetLoyaltyRewardCardPath {
+    id: string;
+    customerId: string;
+}
+export type GetLoyaltyRewardCardResponse = RewardCardDetailResponseDto;
+export interface PostLoyaltyRewardCardAdjustPath {
+    cardId: string;
+}
+export type PostLoyaltyRewardCardAdjustBody = AdjustPointsDto;
+export type PostLoyaltyRewardCardAdjustResponse = RewardCardDetailResponseDto;
+export type PostLoyaltyRewardOrderEarnBody = EarnOrderDto;
+export type PostLoyaltyRewardOrderEarnResponse = EarnOrderResponseDto;
+//# sourceMappingURL=loyalty.d.ts.map